を使用した Amazon SNS の例 AWS CLI

トピックにアクセス許可を追加するには

次のadd-permission例では、 AWS アカウント で指定されたトピックで Publishアクションを使用する987654321098アクセス許可を AWS アカウント に追加します123456789012。

aws sns add-permission \
    --topic-arn arn:aws:sns:us-west-2:123456789012:MyTopic \
    --label Publish-Permission \
    --aws-account-id 987654321098 \
    --action-name Publish

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

電話番号のSMSメッセージのオプトアウトを確認するには

次のcheck-if-phone-number-is-opted-out例では、指定された電話番号が現在の AWS アカウントからのSMSメッセージの受信をオプトアウトされているかどうかを確認します。

aws sns check-if-phone-number-is-opted-out \
    --phone-number +1555550100

出力:

{
    "isOptedOut": false
}

サブスクリプションを確認するには

次のconfirm-subscriptionコマンドは、 という名前のSNSトピックをサブスクライブしたときに開始された確認プロセスを完了しますmy-topic。--token パラメータは、subscribe の呼び出しで指定した通知エンドポイントに送信される確認メッセージから取得されます。

aws sns confirm-subscription \
    --topic-arn arn:aws:sns:us-west-2:123456789012:my-topic \
    --token 2336412f37fb687f5d51e6e241d7700ae02f7124d8268910b858cb4db727ceeb2474bb937929d3bdd7ce5d0cce19325d036bc858d3c217426bcafa9c501a2cace93b83f1dd3797627467553dc438a8c974119496fc3eff026eaa5d14472ded6f9a5c43aec62d83ef5f49109da7176391

出力:

{
    "SubscriptionArn": "arn:aws:sns:us-west-2:123456789012:my-topic:8a21d249-4329-4871-acc6-7be709c6ea7f"
}

プラットフォームアプリケーションを作成するには

次のcreate-platform-application例では、指定されたプラットフォーム認証情報を使用して Google Firebase プラットフォームアプリケーションを作成します。

aws sns create-platform-application \
    --name MyApplication \
    --platform GCM \
    --attributes PlatformCredential=EXAMPLEabcd12345jklm67890stuv12345bcdef

出力:

{
    "PlatformApplicationArn": "arn:aws:sns:us-west-2:123456789012:app/GCM/MyApplication"
}

トピック SNS を作成するには

次のcreate-topic例では、 という名前のSNSトピックを作成しますmy-topic。

aws sns create-topic \
    --name my-topic

出力:

{
    "ResponseMetadata": {
        "RequestId": "1469e8d7-1642-564e-b85d-a19b4b341f83"
    },
    "TopicArn": "arn:aws:sns:us-west-2:123456789012:my-topic"
}

詳細については、AWS 「 コマンドラインインターフェイスユーザーガイド」の「Amazon SQSおよび Amazon でのSNSコマンドラインインターフェイスの使用」を参照してください。 AWS

プラットフォームアプリケーションエンドポイントを削除するには

次のdelete-endpoint例では、指定されたプラットフォームアプリケーションエンドポイントを削除します。

aws sns delete-endpoint \
    --endpoint-arn arn:aws:sns:us-west-2:123456789012:endpoint/GCM/MyApplication/12345678-abcd-9012-efgh-345678901234

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

プラットフォームアプリケーションを削除するには

次のdelete-platform-application例では、指定されたプラットフォームアプリケーションを削除します。

aws sns delete-platform-application \
    --platform-application-arn arn:aws:sns:us-west-2:123456789012:app/ADM/MyApplication

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

SNSトピックを削除するには

次のdelete-topic例では、指定されたSNSトピックを削除します。

aws sns delete-topic \
    --topic-arn "arn:aws:sns:us-west-2:123456789012:my-topic"

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

プラットフォームアプリケーションのエンドポイント属性を一覧表示するには

次のget-endpoint-attributes例では、指定されたプラットフォームアプリケーションエンドポイントの属性を一覧表示します。

aws sns get-endpoint-attributes \
    --endpoint-arn arn:aws:sns:us-west-2:123456789012:endpoint/GCM/MyApplication/12345678-abcd-9012-efgh-345678901234

出力:

{
    "Attributes": {
        "Enabled": "true",
        "Token": "EXAMPLE12345..."
    }
}

プラットフォームアプリケーション属性を一覧表示するには

次のget-platform-application-attributes例では、指定されたプラットフォームアプリケーションの属性を一覧表示します。

aws sns get-platform-application-attributes \
    --platform-application-arn arn:aws:sns:us-west-2:123456789012:app/MPNS/MyApplication

出力:

{
    "Attributes": {
        "Enabled": "true",
        "SuccessFeedbackSampleRate": "100"
    }
}

デフォルトのSMSメッセージ属性を一覧表示するには

次のget-sms-attributes例では、SMSメッセージを送信するためのデフォルトの属性を一覧表示します。

aws sns get-sms-attributes

出力:

{
    "attributes": {
        "DefaultSenderID": "MyName"
    }
}

トピックのサブスクリプション属性を取得するには

以下に、指定されたサブスクリプションの属性get-subscription-attributesを示します。list-subscriptions コマンドの出力subscription-arnから を取得できます。

aws sns get-subscription-attributes \
    --subscription-arn "arn:aws:sns:us-west-2:123456789012:my-topic:8a21d249-4329-4871-acc6-7be709c6ea7f"

出力:

{
    "Attributes": {
        "Endpoint": "my-email@example.com",
        "Protocol": "email",
        "RawMessageDelivery": "false",
        "ConfirmationWasAuthenticated": "false",
        "Owner": "123456789012",
        "SubscriptionArn": "arn:aws:sns:us-west-2:123456789012:my-topic:8a21d249-4329-4871-acc6-7be709c6ea7f",
        "TopicArn": "arn:aws:sns:us-west-2:123456789012:my-topic"
    }
}

トピックの属性を取得するには

次の get-topic-attributes の例では、指定したトピックの属性を表示します。

aws sns get-topic-attributes \
    --topic-arn "arn:aws:sns:us-west-2:123456789012:my-topic"

出力:

{
    "Attributes": {
        "SubscriptionsConfirmed": "1",
        "DisplayName": "my-topic",
        "SubscriptionsDeleted": "0",
        "EffectiveDeliveryPolicy": "{\"http\":{\"defaultHealthyRetryPolicy\":{\"minDelayTarget\":20,\"maxDelayTarget\":20,\"numRetries\":3,\"numMaxDelayRetries\":0,\"numNoDelayRetries\":0,\"numMinDelayRetries\":0,\"backoffFunction\":\"linear\"},\"disableSubscriptionOverrides\":false}}",
        "Owner": "123456789012",
        "Policy": "{\"Version\":\"2008-10-17\",\"Id\":\"__default_policy_ID\",\"Statement\":[{\"Sid\":\"__default_statement_ID\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"*\"},\"Action\":[\"SNS:Subscribe\",\"SNS:ListSubscriptionsByTopic\",\"SNS:DeleteTopic\",\"SNS:GetTopicAttributes\",\"SNS:Publish\",\"SNS:RemovePermission\",\"SNS:AddPermission\",\"SNS:SetTopicAttributes\"],\"Resource\":\"arn:aws:sns:us-west-2:123456789012:my-topic\",\"Condition\":{\"StringEquals\":{\"AWS:SourceOwner\":\"0123456789012\"}}}]}",
        "TopicArn": "arn:aws:sns:us-west-2:123456789012:my-topic",
        "SubscriptionsPending": "0"
    }
}

プラットフォームアプリケーションのエンドポイントを一覧表示するには

次のlist-endpoints-by-platform-application例では、指定されたプラットフォームアプリケーションのエンドポイントとエンドポイント属性を一覧表示します。

aws sns list-endpoints-by-platform-application \
    --platform-application-arn arn:aws:sns:us-west-2:123456789012:app/GCM/MyApplication

出力:

{
    "Endpoints": [
        {
            "Attributes": {
                "Token": "EXAMPLE12345...,
                "Enabled": "true"
            },
            "EndpointArn": "arn:aws:sns:us-west-2:123456789012:endpoint/GCM/MyApplication/12345678-abcd-9012-efgh-345678901234"
        }
    ]
}

SMS メッセージオプトアウトを一覧表示するには

次のlist-phone-numbers-opted-out例では、SMSメッセージの受信をオプトアウトされた電話番号を一覧表示します。

aws sns list-phone-numbers-opted-out

出力:

{
    "phoneNumbers": [
        "+15555550100"
    ]
}

プラットフォームアプリケーションを一覧表示するには

次のlist-platform-applications例は、 ADMと のプラットフォームアプリケーションを示していますMPNS。

aws sns list-platform-applications

出力:

{
    "PlatformApplications": [
        {
            "PlatformApplicationArn": "arn:aws:sns:us-west-2:123456789012:app/ADM/MyApplication",
            "Attributes": {
                "SuccessFeedbackSampleRate": "100",
                "Enabled": "true"
            }
        },
        {
            "PlatformApplicationArn": "arn:aws:sns:us-west-2:123456789012:app/MPNS/MyOtherApplication",
            "Attributes": {
                "SuccessFeedbackSampleRate": "100",
                "Enabled": "true"
            }
        }
    ]
}

トピックに関連付けられたサブスクリプションを一覧表示するには

以下は、指定されたトピックに関連付けられたSNSサブスクリプションのリストlist-subscriptions-by-topicを取得します。

aws sns list-subscriptions-by-topic \
    --topic-arn "arn:aws:sns:us-west-2:123456789012:my-topic"

出力:

{
    "Subscriptions": [
        {
            "Owner": "123456789012",
            "Endpoint": "my-email@example.com",
            "Protocol": "email",
            "TopicArn": "arn:aws:sns:us-west-2:123456789012:my-topic",
            "SubscriptionArn": "arn:aws:sns:us-west-2:123456789012:my-topic:8a21d249-4329-4871-acc6-7be709c6ea7f"
        }
    ]
}

SNSサブスクリプションを一覧表示するには

次のlist-subscriptions例では、 AWS アカウントのSNSサブスクリプションのリストを表示します。

aws sns list-subscriptions

出力:

{
    "Subscriptions": [
        {
            "Owner": "123456789012",
            "Endpoint": "my-email@example.com",
            "Protocol": "email",
            "TopicArn": "arn:aws:sns:us-west-2:123456789012:my-topic",
            "SubscriptionArn": "arn:aws:sns:us-west-2:123456789012:my-topic:8a21d249-4329-4871-acc6-7be709c6ea7f"
        }
    ]
}

トピックのタグを一覧表示するには

次のlist-tags-for-resource例では、指定された Amazon SNSトピックのタグを一覧表示します。

aws sns list-tags-for-resource \
    --resource-arn arn:aws:sns:us-west-2:123456789012:MyTopic

出力:

{
    "Tags": [
        {
            "Key": "Team",
            "Value": "Alpha"
        }
    ]
}

SNSトピックを一覧表示するには

次のlist-topics例では、 AWS アカウント内のすべてのSNSトピックを一覧表示します。

aws sns list-topics

出力:

{
    "Topics": [
        {
            "TopicArn": "arn:aws:sns:us-west-2:123456789012:my-topic"
        }
    ]
}

SMS メッセージにオプトインするには

次のopt-in-phone-number例では、指定された電話番号をSMSメッセージの受信にオプトします。

aws sns opt-in-phone-number \
    --phone-number +15555550100

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

例 1: トピックにメッセージを発行するには

次のpublish例では、指定されたメッセージを指定されたSNSトピックに発行します。メッセージはテキストファイルから取得されたもので、改行を含めることができます。

aws sns publish \
    --topic-arn "arn:aws:sns:us-west-2:123456789012:my-topic" \
    --message file://message.txt

message.txt の内容:

Hello World
Second Line

出力:

{
    "MessageId": "123a45b6-7890-12c3-45d6-111122223333"
}

例 2: メッセージを電話番号SMSに発行するには

次の publish の例では、Hello world! メッセージを電話番号 +1-555-555-0100 に公開します。

aws sns publish \
    --message "Hello world!" \
    --phone-number +1-555-555-0100

出力:

{
    "MessageId": "123a45b6-7890-12c3-45d6-333322221111"
}

データ保護ポリシーを設定するには

例 1: パブリッシャーが を使用してメッセージを発行することを拒否するには CreditCardNumber

次のput-data-protection-policy例では、パブリッシャーが を使用してメッセージを公開することを拒否しています CreditCardNumber。

aws sns put-data-protection-policy \
    --resource-arn arn:aws:sns:us-east-1:123456789012:mytopic \
    --data-protection-policy "{\"Name\":\"data_protection_policy\",\"Description\":\"Example data protection policy\",\"Version\":\"2021-06-01\",\"Statement\":[{\"DataDirection\":\"Inbound\",\"Principal\":[\"*\"],\"DataIdentifier\":[\"arn:aws:dataprotection::aws:data-identifier/CreditCardNumber\"],\"Operation\":{\"Deny\":{}}}]}"

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

例 2: ファイルからパラメータをロードするには

次の は、ファイルからパラメータをput-data-protection-policyロードします。

aws sns put-data-protection-policy \
    --resource-arn arn:aws:sns:us-west-2:123456789012:MyTopic \
    --data-protection-policy file://policy.json

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

トピックからアクセス許可を削除するには

次のremove-permission例では、指定されたトピックPublish-Permissionから アクセス許可を削除します。

aws sns remove-permission \
    --topic-arn arn:aws:sns:us-west-2:123456789012:MyTopic \
    --label Publish-Permission

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

エンドポイント属性を設定するには

次のset-endpoint-attributes例では、指定されたプラットフォームアプリケーションエンドポイントを無効にします。

aws sns set-endpoint-attributes \
    --endpoint-arn arn:aws:sns:us-west-2:123456789012:endpoint/GCM/MyApplication/12345678-abcd-9012-efgh-345678901234 \
    --attributes Enabled=false

出力:

{
    "Attributes": {
        "Enabled": "false",
        "Token": "EXAMPLE12345..."
    }
}

プラットフォームアプリケーション属性を設定するには

次のset-platform-application-attributes例では、指定されたプラットフォームアプリケーションの EventDeliveryFailure 属性を、指定された Amazon SNSトピックARNの に設定します。

aws sns set-platform-application-attributes \
    --platform-application-arn arn:aws:sns:us-west-2:123456789012:app/GCM/MyApplication \
    --attributes EventDeliveryFailure=arn:aws:sns:us-west-2:123456789012:AnotherTopic

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

SMS メッセージ属性を設定するには

次のset-sms-attributes例では、SMSメッセージのデフォルトの送信者 ID を に設定しますMyName。

aws sns set-sms-attributes \
    --attributes DefaultSenderID=MyName

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

サブスクリプション属性を設定するには

次のset-subscription-attributes例では、 RawMessageDelivery 属性をSQSサブスクリプションに設定します。

aws sns set-subscription-attributes \
    --subscription-arn arn:aws:sns:us-east-1:123456789012:mytopic:f248de18-2cf6-578c-8592-b6f1eaa877dc \
    --attribute-name RawMessageDelivery \
    --attribute-value true

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

次のset-subscription-attributes例では、 FilterPolicy 属性をSQSサブスクリプションに設定します。

aws sns set-subscription-attributes \
    --subscription-arn arn:aws:sns:us-east-1:123456789012:mytopic:f248de18-2cf6-578c-8592-b6f1eaa877dc \
    --attribute-name FilterPolicy \
    --attribute-value "{ \"anyMandatoryKey\": [\"any\", \"of\", \"these\"] }"

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

次のset-subscription-attributes例では、SQSサブスクリプションから FilterPolicy 属性を削除します。

aws sns set-subscription-attributes \
    --subscription-arn arn:aws:sns:us-east-1:123456789012:mytopic:f248de18-2cf6-578c-8592-b6f1eaa877dc \
    --attribute-name FilterPolicy \
    --attribute-value "{}"

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

トピックの属性を設定するには

次の set-topic-attributes の例では、指定したトピックの DisplayName 属性を設定します。

aws sns set-topic-attributes \
    --topic-arn arn:aws:sns:us-west-2:123456789012:MyTopic \
    --attribute-name DisplayName \
    --attribute-value MyTopicDisplayName

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

トピックにサブスクライブするには

次の subscribe コマンドは、指定したトピックに E メールアドレスをサブスクライブします。

aws sns subscribe \
    --topic-arn arn:aws:sns:us-west-2:123456789012:my-topic \
    --protocol email \
    --notification-endpoint my-email@example.com

出力:

{
    "SubscriptionArn": "pending confirmation"
}

トピックにタグを追加するには

次のtag-resource例では、指定された Amazon SNSトピックにメタデータタグを追加します。

aws sns tag-resource \
    --resource-arn arn:aws:sns:us-west-2:123456789012:MyTopic \
    --tags Key=Team,Value=Alpha

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

トピックからサブスクライブを解除するには

次の unsubscribe の例では、指定したサブスクリプションをトピックから削除します。

aws sns unsubscribe \
    --subscription-arn arn:aws:sns:us-west-2:0123456789012:my-topic:8a21d249-4329-4871-acc6-7be709c6ea7f

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

トピックからタグを削除するには

次のuntag-resource例では、指定された Amazon SNSトピックから指定されたキーを持つタグを削除します。

aws sns untag-resource \
    --resource-arn arn:aws:sns:us-west-2:123456789012:MyTopic \
    --tag-keys Team

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

プラットフォームアプリケーションのエンドポイントを作成するには

次の create-platform-endpoint の例では、指定したトークンを使用して、指定したプラットフォームアプリケーションのエンドポイントを作成します。

aws sns create-platform-endpoint \
    --platform-application-arn arn:aws:sns:us-west-2:123456789012:app/GCM/MyApplication \
    --token EXAMPLE12345...

出力:

{
      "EndpointArn": "arn:aws:sns:us-west-2:1234567890:endpoint/GCM/MyApplication/12345678-abcd-9012-efgh-345678901234"
}