AWS CodeStar を使用した通知の例 AWS CLI

通知ルールを作成するには

次のcreate-notification-rule例では、 という名前の JSON ファイルを使用して、指定された AWS アカウントMyDemoRepoで という名前のリポジトリMyNotificationRuleに という名前の通知ルールrule.jsonを作成します。FULL 詳細タイプの通知は、ブランチとタグの作成時に指定されたターゲット Amazon SNS トピックに送信されます。

aws codestar-notifications create-notification-rule \
    --cli-input-json file://rule.json

rule.json の内容:

{
    "Name": "MyNotificationRule",
    "EventTypeIds": [
        "codecommit-repository-branches-and-tags-created"
    ],
    "Resource": "arn:aws:codecommit:us-east-1:123456789012:MyDemoRepo",
    "Targets": [
        {
            "TargetType": "SNS",
            "TargetAddress": "arn:aws:sns:us-east-1:123456789012:MyNotificationTopic"
        }
    ],
    "Status": "ENABLED",
    "DetailType": "FULL"
}

出力:

{
    "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
}

詳細については、「 デベロッパーツールコンソールユーザーガイド」の「通知ルールの作成」を参照してください。 AWS

通知ルールを削除するには

次のdelete-notification-rule例では、指定された通知ルールを削除します。

aws codestar-notifications delete-notification-rule \
    --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE

出力:

{
    "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
}

詳細については、「 デベロッパーツールコンソールユーザーガイド」の「通知ルールの削除」を参照してください。 AWS

通知ルールターゲットを削除するには

次のdelete-target例では、指定したターゲットをターゲットとして使用するように設定されたすべての通知ルールから削除し、ターゲットを削除します。

aws codestar-notifications  delete-target \
    --target-address arn:aws:sns:us-east-1:123456789012:MyNotificationTopic \
    --force-unsubscribe-all

このコマンドでは何も出力されません。

詳細については、「 デベロッパーツールコンソールユーザーガイド」の「通知ルールターゲットの削除」を参照してください。 AWS

通知ルールの詳細を取得するには

次のdescribe-notification-rule例では、指定された通知ルールの詳細を取得します。

aws codestar-notifications describe-notification-rule \
    --arn arn:aws:codestar-notifications:us-west-2:123456789012:notificationrule/dc82df7a-EXAMPLE

出力:

{
    "LastModifiedTimestamp": 1569199844.857,
    "EventTypes": [
        {
            "ServiceName": "CodeCommit",
            "EventTypeName": "Branches and tags: Created",
            "ResourceType": "Repository",
            "EventTypeId": "codecommit-repository-branches-and-tags-created"
        }
    ],
    "Status": "ENABLED",
    "DetailType": "FULL",
    "Resource": "arn:aws:codecommit:us-west-2:123456789012:MyDemoRepo",
    "Arn": "arn:aws:codestar-notifications:us-west-w:123456789012:notificationrule/dc82df7a-EXAMPLE",
    "Targets": [
        {
            "TargetStatus": "ACTIVE",
            "TargetAddress": "arn:aws:sns:us-west-2:123456789012:MyNotificationTopic",
            "TargetType": "SNS"
        }
    ],
    "Name": "MyNotificationRule",
    "CreatedTimestamp": 1569199844.857,
    "CreatedBy": "arn:aws:iam::123456789012:user/Mary_Major"
}

詳細については、AWS 「 デベロッパーツールコンソールユーザーガイド」の通知ルールの表示を参照してください。

通知ルールのイベントタイプのリストを取得するには

次のlist-event-types例では、 CodeDeploy アプリケーションで使用できるすべての通知イベントタイプのフィルタリングされたリストを取得します。代わりにフィルターを使用しない場合、 コマンドはすべてのリソースタイプのすべての通知イベントタイプを返します。

aws codestar-notifications list-event-types \
    --filters Name=SERVICE_NAME,Value=CodeDeploy

出力:

{
    "EventTypes": [
        {
            "EventTypeId": "codedeploy-application-deployment-succeeded",
            "ServiceName": "CodeDeploy",
            "EventTypeName": "Deployment: Succeeded",
            "ResourceType": "Application"
        },
        {
            "EventTypeId": "codedeploy-application-deployment-failed",
            "ServiceName": "CodeDeploy",
            "EventTypeName": "Deployment: Failed",
            "ResourceType": "Application"
        },
        {
            "EventTypeId": "codedeploy-application-deployment-started",
            "ServiceName": "CodeDeploy",
            "EventTypeName": "Deployment: Started",
            "ResourceType": "Application"
        }
    ]
}

詳細については、「 デベロッパーツールコンソールユーザーガイド」の「通知ルールの作成」を参照してください。 AWS

通知ルールのリストを取得するには

次のlist-notification-rules例では、指定された AWS リージョン内のすべての通知ルールのリストを取得します。

aws codestar-notifications list-notification-rules --region us-east-1

出力:

{
    "NotificationRules": [
        {
            "Id": "dc82df7a-EXAMPLE",
            "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
        },
        {
            "Id": "8d1f0983-EXAMPLE",
            "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/8d1f0983-EXAMPLE"
        }
    ]
}

詳細については、AWS 「 デベロッパーツールコンソールユーザーガイド」の通知ルールの表示を参照してください。

通知ルールにアタッチされたタグのリストを取得するには

次のlist-tags-for-resource例では、指定された通知ルールにアタッチされたすべてのタグのリストを取得します。この例では、通知ルールには現在、関連付けられたタグがありません。

aws codestar-notifications list-tags-for-resource \
    --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/fe1efd35-EXAMPLE

出力:

{
    "Tags": {}
}

詳細については、「 デベロッパーツールコンソールユーザーガイド」の「通知ルールの作成」を参照してください。 AWS

通知ルールターゲットのリストを取得するには

次のlist-targets例では、指定された AWS リージョン内のすべての通知ルールターゲットのリストを取得します。

aws codestar-notifications list-targets \
    --region us-east-1

出力:

{
    "Targets": [
        {
            "TargetAddress": "arn:aws:sns:us-east-1:123456789012:MySNSTopicForNotificationRules",
            "TargetType": "SNS",
            "TargetStatus": "ACTIVE"
        },
        {
            "TargetAddress": "arn:aws:sns:us-east-1:123456789012:MySNSTopicForNotificationsAboutMyDemoRepo",
            "TargetType": "SNS",
            "TargetStatus": "ACTIVE"
        }
    ]
}

詳細については、AWS 「 デベロッパーツールコンソールユーザーガイド」の「通知ルールのターゲットを表示する」を参照してください。

通知ルールにターゲットを追加するには

次のsubscribe例では、指定された通知ルールのターゲットとして Amazon SNS トピックを追加します。

aws codestar-notifications subscribe \
    --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE \
    --target TargetType=SNS,TargetAddress=arn:aws:sns:us-east-1:123456789012:MyNotificationTopic

出力:

{
    "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
}

詳細については、「 デベロッパーツールコンソールユーザーガイド」の「通知ルールのターゲットとしての Amazon SNS トピックの追加または削除」を参照してください。 AWS

通知ルールにタグを追加するには

次のtag-resource例では、 のキー名Teamと の値を持つタグLi_Juanを指定された通知ルールに追加します。

aws codestar-notifications tag-resource \
    --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/fe1efd35-EXAMPLE \
    --tags Team=Li_Juan

出力:

{
    "Tags": {
        "Team": "Li_Juan"
    }
}

詳細については、「 デベロッパーツールコンソールユーザーガイド」の「通知ルールの作成」を参照してください。 AWS

通知ルールからターゲットを削除するには

次のunsubscribe例では、指定された通知ルールから Amazon SNS トピックをターゲットとして削除します。

aws codestar-notifications unsubscribe \
    --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE \
    --target TargetType=SNS,TargetAddress=arn:aws:sns:us-east-1:123456789012:MyNotificationTopic

出力:

{
    "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
    "TargetAddress": "arn:aws:sns:us-east-1:123456789012:MyNotificationTopic"
}

詳細については、AWS 「 デベロッパーツールコンソールユーザーガイド」の「通知ルールのターゲットとしての Amazon SNS トピックの追加または削除」を参照してください。

通知ルールからタグを削除するには

次のuntag-resource例では、指定された通知ルールTeamからキー名のタグを削除します。

aws codestar-notifications untag-resource \
    --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/fe1efd35-EXAMPLE \
    --tag-keys Team

このコマンドでは何も出力されません。

詳細については、「 デベロッパーツールコンソールユーザーガイド」の通知ルールの編集を参照してください。 AWS

通知ルールを更新するには

次のupdate-notification-rule例では、 という名前の JSON ファイル123456789012を使用して、 AWS アカウントMyNotificationRuleで という名前の通知ルールを更新しますupdate.json。

aws codestar-notifications update-notification-rule \
    --cli-input-json file://update.json

update.json の内容:

{
    "Name": "MyUpdatedNotificationRule",
    "EventTypeIds": [
        "codecommit-repository-branches-and-tags-created"
    ],
    "Resource": "arn:aws:codecommit:us-east-1:123456789012:MyDemoRepo",
    "Targets": [
        {
            "TargetType": "SNS",
            "TargetAddress": "arn:aws:sns:us-east-1:123456789012:MyNotificationTopic"
        }
    ],
    "Status": "ENABLED",
    "DetailType": "FULL"
}

出力:

{
    "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
}

詳細については、「 デベロッパーツールコンソールユーザーガイド」の通知ルールの編集を参照してください。 AWS