[JAWS-UG CLI] SNS:#4 通知先の削除 (e-mail)

AWS CLIを利用して、SNSのトピックから通知先を削除してみます。

前提条件

SNSへの権限

SNSに対してフル権限があること。

AWS CLIのバージョン

以下のバージョンで動作確認済

• AWS CLI 1.11.76

コマンド

aws --version

結果(例):

  aws-cli/1.11.70 Python/2.7.12 Linux/4.4.11-23.53.amzn1.x86_64 botocore/1.5.33

バージョンが古い場合は最新版に更新しましょう。

コマンド

sudo -H pip install -U awscli

0. 準備

まず変数の確認をします。

変数の確認

cat << ETX

        AWS_DEFAULT_PROFILE: (0.1) ${AWS_DEFAULT_PROFILE}
        AWS_DEFAULT_REGION:  (0.2) ${AWS_DEFAULT_REGION}
        SNS_TOPIC_ARN        (0.3) ${SNS_TOPIC_ARN}
        SNS_SUBSCRIPTION_ARN (0.4) ${SNS_SUBSCRIPTION_ARN}

ETX

結果(例):

  AWS_DEFAULT_PROFILE: (0.1) <SNSにフル権限のあるプロファイル>
  AWS_DEFAULT_REGION:  (0.2) ap-northeast-1
  SNS_TOPIC_ARN        (0.3) arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:handson-20170417
  SNS_SUBSCRIPTION_ARN (0.4) arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:handson-20170417:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

変数が入っていない、適切でない場合は、それぞれの手順番号について作業を
行います。

0.1. プロファイルの指定

プロファイルの一覧を確認します。

コマンド

cat ~/.aws/credentials \
       | grep '\[' \
       | sed 's/\[//g' | sed 's/\]//g'

結果(例):

  iamFull-prjz-mbpr13
  <SNSにフル権限のあるプロファイル>

変数の設定

export AWS_DEFAULT_PROFILE='<SNSにフル権限のあるプロファイル>'

0.2. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.3. トピック名の指定

購読するトピックを指定します。

変数の設定

SNS_TOPIC_NAME='handson-20170417'

SNSでトピックを操作するときは、対象トピックのARNを特定する必要がありま
す。

変数の設定

SNS_TOPIC_ARN=$( \
        aws sns list-topics \
          --query "Topics[?contains(TopicArn, \`${SNS_TOPIC_NAME}\`)].TopicArn" \
          --output text \
) \
        && echo ${SNS_TOPIC_ARN}

結果(例):

  arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:handson-20170417

0.4. 通知先(エンドポイント)の指定

通知先となるエンドポイントとプロトコルを指定します。

今回は、プロトコルとしてEmailを利用して通知するので、メールアドレスが
エンドポイントとなります。

変数の設定

SNS_NOTIF_ENDPOINT='<通知先として登録するメールアドレス>'

SNSでサブスクリプションを操作するときは、対象サブスクリプションのARNを
特定する必要があります。

変数の設定

SNS_SUBSCRIPTION_ARN=$( \
        aws sns list-subscriptions-by-topic \
          --topic-arn ${SNS_TOPIC_ARN} \
          --query "Subscriptions[?Endpoint == \`${SNS_NOTIF_ENDPOINT}\`].SubscriptionArn" \
          --output text \
) \
        && echo ${SNS_SUBSCRIPTION_ARN}

結果(例):

  arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:handson-20170417:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

最終確認

変数の確認

cat << ETX

        AWS_DEFAULT_PROFILE: (0.1) ${AWS_DEFAULT_PROFILE}
        AWS_DEFAULT_REGION:  (0.2) ${AWS_DEFAULT_REGION}
        SNS_TOPIC_ARN        (0.3) ${SNS_TOPIC_ARN}
        SNS_SUBSCRIPTION_ARN (0.4) ${SNS_SUBSCRIPTION_ARN}

ETX

結果(例):

  AWS_DEFAULT_PROFILE: (0.1) <SNSにフル権限のあるプロファイル>
  AWS_DEFAULT_REGION:  (0.2) ap-northeast-1
  SNS_TOPIC_ARN        (0.3) arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:handson-20170417
  SNS_SUBSCRIPTION_ARN (0.4) arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:handson-20170417:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

1. 事前作業

3.1. Subscription属性の確認

削除対称のSubscriptionの属性を確認してみましょう。

コマンド

aws sns get-subscription-attributes \
        --subscription-arn ${SNS_SUBSCRIPTION_ARN}

結果(例):

  {
    "Attributes": {
      "Endpoint": "<通知先として登録するメールアドレス>",
      "Protocol": "email",
      "RawMessageDelivery": "false",
      "ConfirmationWasAuthenticated": "true",
      "Owner": "XXXXXXXXXXXX",
      "SubscriptionArn": "arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:handson-20170417:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "TopicArn": "arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:handson-20170417"
    }
  }

1.2. 購読者数の確認

削除の実施前に、トピックの購読者がどれくらいいるか確認してみましょう。

変数の設定

SNS_COUNT_CONFIRMD=$( \
        aws sns get-topic-attributes \
          --topic-arn ${SNS_TOPIC_ARN} \
          --query "Attributes.SubscriptionsConfirmed" \
          --output text \
) \
        && echo ${SNS_COUNT_CONFIRMD}

結果(例):

  1

2. トピックのアンサブスクライブ

トピックの購読停止を行います。

変数の確認

cat << ETX

        SNS_SUBSCRIPTION_ARN: ${SNS_SUBSCRIPTION_ARN}

ETX

コマンド

aws sns unsubscribe \
        --subscription-arn ${SNS_SUBSCRIPTION_ARN}

結果(例):

  (戻り値なし)

3. 事後作業

3.1. Subscriptionの確認

登録予定の通知先がトピックに登録されていないことを確認しましょう。

コマンド

aws sns list-subscriptions-by-topic \
        --topic-arn ${SNS_TOPIC_ARN} \
        --query "Subscriptions[?Endpoint == \`${SNS_NOTIF_ENDPOINT}\`]"

結果(例):

  []

3.2. 購読者数の確認

変数の設定

SNS_COUNT_CONFIRMD=$( \
        aws sns get-topic-attributes \
          --topic-arn ${SNS_TOPIC_ARN} \
          --query "Attributes.SubscriptionsConfirmed" \
          --output text \
) \
        && echo ${SNS_COUNT_CONFIRMD}

結果(例):

  0

削除前に自分しか購読者がいなければ0になっているはずです。

(topic-attributesに反映されるまでにタイムラグがあるようです。)

完了