📝

[小ネタ] AWS CLI から Amplify Hosting のブランチを削除する方法

に公開

delete-branch — AWS CLI 2.27.5 Command Reference
以下のコマンドで削除可能です。

$ aws amplify delete-branch \
--app-id <value> \
--branch-name <value>

やってみた

Amplify Hosting には main ブランチと dev ブランチが登録されている状態です。
コンソールから削除する場合は「アクション」からブランチの接続解除が可能です。

今回は delete-branch コマンドで削除してみます。
コマンドの必須パラメータである app-id は以下の手順で確認可能です。

  • コンソールから確認する場合
    • アプリケーションの設定 > 全般設定 > アプリ ARN
  • AWS CLI から確認する場合
    • list-apps コマンドの実行結果のうち、appArnから確認可能

Amplify アプリの ARN は以下の形式になっています。

  • arn:aws:amplify:ap-northeast-1:012345678901:apps/d8wvu8t4luqd9

上記のうち、d8wvu8t4luqd9 が app-id です。
そのため、delete-branch でも以下のように app-id を指定します。

$ aws amplify delete-branch \
--app-id d8wvu8t4luqd9 \
--branch-name dev

{
    "branch": {
        "branchArn": "arn:aws:amplify:ap-northeast-1:012345678901:apps/d8wvu8t4luqd9/branches/dev",
        "branchName": "dev",
        "stage": "NONE",
        "displayName": "dev",
        "enableNotification": false,
        "createTime": "2025-05-01T06:17:15.430000+00:00",
        "updateTime": "2025-05-01T06:24:14.332000+00:00",
        "enableAutoBuild": true,
        "activeJobId": "0000000001",
        "totalNumberOfJobs": "0",
        "enableBasicAuth": false,
        "enablePerformanceMode": false,
        "ttl": "5",
        "enablePullRequestPreview": false,
        "backend": {}
    }
}

削除できました。
コンソールからも dev ブランチが登録解除されたことを確認できます。

なお、Amplify Hosting 側でブランチを登録解除してもソースリポジトリ側ではブランチは削除されません。
delete-branch コマンドでは Amplify アプリとブランチの紐づけを削除しているという挙動です。

ソースリポジトリ側のブランチも不要な場合はソースリポジトリ側で削除してください。
CodeCommit のブランチを削除する場合には CodeCommit 側の delete-branch コマンドを実行する方法などがあります。

Delete a branch in AWS CodeCommit - AWS CodeCommit

まとめ

今回は AWS CLI から Amplify Hosting のブランチを削除する方法を紹介しました。
AWS からのヒアリングにご協力頂きありがとうございます。
ヒアリング結果については AWS にも連携し、継続調査を実施しております。

参考資料

Discussion