使用的 Amazon SNS範例 AWS CLI

下列程式碼範例示範如何搭配 AWS Command Line Interface Amazon 使用來執行動作和實作常見案例SNS。

Actions 是大型程式的程式碼摘錄，必須在內容中執行。雖然動作會示範如何呼叫個別服務函數，但您可以在相關案例中查看內容中的動作。

案例是程式碼範例，示範如何透過呼叫服務內的多個函數或與其他結合來完成特定任務 AWS 服務。

每個範例都包含完整原始程式碼的連結，您可以在其中找到如何在內容中設定和執行程式碼的指示。

主題

動作
案例

動作

下列程式碼範例示範如何使用 add-permission。

AWS CLI

將許可新增至主題

下列add-permission範例會新增帳戶的許可987654321098，以將 Publish動作與 AWS 帳戶 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

此命令不會產生輸出。

如需API詳細資訊，請參閱命令參考 AddPermission中的。 AWS CLI

下列程式碼範例示範如何使用 check-if-phone-number-is-opted-out。

AWS CLI

若要檢查SMS訊息是否選擇退出電話號碼

下列check-if-phone-number-is-opted-out範例會檢查指定的電話號碼是否選擇不接收來自目前 AWS 帳戶SMS的訊息。


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

輸出：


{
    "isOptedOut": false
}

如需API詳細資訊，請參閱命令參考 CheckIfPhoneNumberIsOptedOut中的。 AWS CLI

下列程式碼範例示範如何使用 confirm-subscription。

AWS CLI

確認訂閱

當您訂閱名為 SNS的主題時，下列confirm-subscription命令會完成開始的確認程序my-topic。-token 參數來自傳送到訂閱呼叫中所指定通知端點的確認訊息。


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"
}

如需API詳細資訊，請參閱命令參考 ConfirmSubscription中的。 AWS CLI

下列程式碼範例示範如何使用 create-platform-application。

AWS CLI

建立平台應用程式

下列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"
}

如需API詳細資訊，請參閱命令參考 CreatePlatformApplication中的。 AWS CLI

下列程式碼範例示範如何使用 create-topic。

AWS CLI

建立 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

如需API詳細資訊，請參閱命令參考 CreateTopic中的。 AWS CLI

下列程式碼範例示範如何使用 delete-endpoint。

AWS CLI

若要刪除平台應用程式端點

下列delete-endpoint範例會刪除指定的平台應用程式端點。


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

此命令不會產生輸出。

如需API詳細資訊，請參閱命令參考 DeleteEndpoint中的。 AWS CLI

下列程式碼範例示範如何使用 delete-platform-application。

AWS CLI

刪除平台應用程式

下列delete-platform-application範例會刪除指定的平台應用程式。


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

此命令不會產生輸出。

如需API詳細資訊，請參閱命令參考 DeletePlatformApplication中的。 AWS CLI

下列程式碼範例示範如何使用 delete-topic。

AWS CLI

若要刪除SNS主題

下列delete-topic範例會刪除指定的SNS主題。


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

此命令不會產生輸出。

如需API詳細資訊，請參閱命令參考 DeleteTopic中的。 AWS CLI

下列程式碼範例示範如何使用 get-endpoint-attributes。

AWS CLI

列出平台應用程式端點屬性

下列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..."
    }
}

如需API詳細資訊，請參閱命令參考 GetEndpointAttributes中的。 AWS CLI

下列程式碼範例示範如何使用 get-platform-application-attributes。

AWS CLI

列出平台應用程式屬性

下列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"
    }
}

如需API詳細資訊，請參閱命令參考 GetPlatformApplicationAttributes中的。 AWS CLI

下列程式碼範例示範如何使用 get-sms-attributes。

AWS CLI

列出預設SMS訊息屬性

下列get-sms-attributes範例列出傳送訊息的預設屬性SMS。


aws sns get-sms-attributes

輸出：


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

如需API詳細資訊，請參閱 AWS CLI 命令參考 中的 GetSMSAttributes。

下列程式碼範例示範如何使用 get-subscription-attributes。

AWS CLI

擷取主題的訂閱屬性

下列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"
    }
}

如需API詳細資訊，請參閱命令參考 GetSubscriptionAttributes中的。 AWS CLI

下列程式碼範例示範如何使用 get-topic-attributes。

AWS CLI

擷取主題的屬性

下列 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"
    }
}

如需API詳細資訊，請參閱命令參考 GetTopicAttributes中的。 AWS CLI

下列程式碼範例示範如何使用 list-endpoints-by-platform-application。

AWS CLI

列出平台應用程式的端點

下列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"
        }
    ]
}

如需API詳細資訊，請參閱命令參考 ListEndpointsByPlatformApplication中的。 AWS CLI

下列程式碼範例示範如何使用 list-phone-numbers-opted-out。

AWS CLI

列出SMS訊息選擇退出

下列list-phone-numbers-opted-out範例列出選擇不接收SMS訊息的電話號碼。


aws sns list-phone-numbers-opted-out

輸出：


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

如需API詳細資訊，請參閱命令參考 ListPhoneNumbersOptedOut中的。 AWS CLI

下列程式碼範例示範如何使用 list-platform-applications。

AWS CLI

列出平台應用程式

下列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"
            }
        }
    ]
}

如需API詳細資訊，請參閱命令參考 ListPlatformApplications中的。 AWS CLI

下列程式碼範例示範如何使用 list-subscriptions-by-topic。

AWS CLI

列出與主題相關聯的訂閱

以下內容會list-subscriptions-by-topic擷取與指定主題相關聯的SNS訂閱清單。


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"
        }
    ]
}

如需API詳細資訊，請參閱命令參考 ListSubscriptionsByTopic中的。 AWS CLI

下列程式碼範例示範如何使用 list-subscriptions。

AWS CLI

若要列出您的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"
        }
    ]
}

如需API詳細資訊，請參閱命令參考 ListSubscriptions中的。 AWS CLI

下列程式碼範例示範如何使用 list-tags-for-resource。

AWS CLI

列出主題的標籤

下列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"
        }
    ]
}

如需API詳細資訊，請參閱命令參考 ListTagsForResource中的。 AWS CLI

下列程式碼範例示範如何使用 list-topics。

AWS CLI

若要列出您的SNS主題

下列list-topics範例會列出您 AWS 帳戶中的所有SNS主題。


aws sns list-topics

輸出：


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

如需API詳細資訊，請參閱命令參考 ListTopics中的。 AWS CLI

下列程式碼範例示範如何使用 opt-in-phone-number。

AWS CLI

選擇加入SMS訊息

下列opt-in-phone-number範例會選擇指定的電話號碼來接收SMS訊息。


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

此命令不會產生輸出。

如需API詳細資訊，請參閱命令參考 OptInPhoneNumber中的。 AWS CLI

下列程式碼範例示範如何使用 publish。

AWS CLI

範例 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"
}

如需API詳細資訊，請參閱在AWS CLI 命令參考 中發佈。

下列程式碼範例示範如何使用 put-data-protection-policy。

AWS CLI

設定資料保護政策

範例 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

此命令不會產生輸出。

如需API詳細資訊，請參閱命令參考 PutDataProtectionPolicy中的。 AWS CLI

下列程式碼範例示範如何使用 remove-permission。

AWS CLI

從主題中移除許可

下列remove-permission範例會從Publish-Permission指定的主題移除許可。


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

此命令不會產生輸出。

如需API詳細資訊，請參閱命令參考 RemovePermission中的。 AWS CLI

下列程式碼範例示範如何使用 set-endpoint-attributes。

AWS CLI

設定端點屬性

下列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..."
    }
}

如需API詳細資訊，請參閱命令參考 SetEndpointAttributes中的。 AWS CLI

下列程式碼範例示範如何使用 set-platform-application-attributes。

AWS CLI

設定平台應用程式屬性

下列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

此命令不會產生輸出。

如需API詳細資訊，請參閱命令參考 SetPlatformApplicationAttributes中的。 AWS CLI

下列程式碼範例示範如何使用 set-sms-attributes。

AWS CLI

設定SMS訊息屬性

下列set-sms-attributes範例會將SMS訊息的預設寄件者 ID 設定為 MyName。


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

此命令不會產生輸出。

如需API詳細資訊，請參閱 AWS CLI 命令參考 中的 SetSMSAttributes。

下列程式碼範例示範如何使用 set-subscription-attributes。

AWS CLI

設定訂閱屬性

下列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 "{}"

此命令不會產生輸出。

如需API詳細資訊，請參閱命令參考 SetSubscriptionAttributes中的。 AWS CLI

下列程式碼範例示範如何使用 set-topic-attributes。

AWS CLI

設定主題的屬性

下列 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

此命令不會產生輸出。

如需API詳細資訊，請參閱命令參考 SetTopicAttributes中的。 AWS CLI

下列程式碼範例示範如何使用 subscribe。

AWS CLI

訂閱主題

下列 subscribe 命令會將電子郵件地址訂閱至指定的主題。


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"
}

如需API詳細資訊，請參閱 AWS CLI 命令參考 中的訂閱。

下列程式碼範例示範如何使用 tag-resource。

AWS CLI

將標籤新增至主題

下列tag-resource範例會將中繼資料標籤新增至指定的 Amazon SNS主題。


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

此命令不會產生輸出。

如需API詳細資訊，請參閱命令參考 TagResource中的。 AWS CLI

下列程式碼範例示範如何使用 unsubscribe。

AWS CLI

取消訂閱主題

下列 unsubscribe 範例會從主題中刪除指定的訂閱。


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

此命令不會產生輸出。

如需API詳細資訊，請參閱 AWS CLI 命令參考 中的取消訂閱。

下列程式碼範例示範如何使用 untag-resource。

AWS CLI

從主題中移除標籤

下列untag-resource範例會從指定的 Amazon SNS主題中移除具有指定金鑰的任何標籤。


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

此命令不會產生輸出。

如需API詳細資訊，請參閱命令參考 UntagResource中的。 AWS CLI

案例

下列程式碼範例示範如何為 Amazon SNS推播通知建立平台端點。

AWS CLI

建立平台應用程式端點

下列 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"
}

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

Snowball

Amazon SQS

使用 的 Amazon SNS範例 AWS CLI

主題

動作

案例

使用的 Amazon SNS範例 AWS CLI