Amazon SNS SNS-Beispiele mit AWS CLI

Um einem Thema eine Berechtigung hinzuzufügen

Im folgenden add-permission Beispiel wird dem AWS Konto die Berechtigung hinzugefügt, die Publish Aktion mit dem angegebenen Thema unter AWS Konto 987654321098 zu verwenden123456789012.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

So überprüfen Sie SMS-Nachrichten-Abmeldungen für eine Telefonnummer

Im folgenden check-if-phone-number-is-opted-out Beispiel wird geprüft, ob die angegebene Telefonnummer den Empfang von SMS-Nachrichten vom AWS Girokonto deaktiviert hat.

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

Ausgabe:

{
    "isOptedOut": false
}

So bestätigen Sie ein Abonnement

Mit dem folgenden confirm-subscription-Befehl wird der Bestätigungsvorgang abgeschlossen, der gestartet wurde, als Sie ein SNS-Thema mit dem Namen my-topic abonniert haben. Der --token-Parameter stammt aus der Bestätigungsnachricht, die an den im Abonnementaufruf angegebenen Benachrichtigungsendpunkt gesendet wurde.

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

Ausgabe:

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

Um eine Plattformanwendung zu erstellen

Im folgenden create-platform-application Beispiel wird eine Google Firebase-Plattformanwendung mit den angegebenen Plattformanmeldeinformationen erstellt.

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

Ausgabe:

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

So erstellen Sie ein SNS-Thema

Das folgende create-topic-Beispiel erstellt ein SNS-Thema namens my-topic.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Verwenden der AWS Befehlszeilenschnittstelle mit Amazon SQS und Amazon SNS im Benutzerhandbuch für die AWS Befehlszeilenschnittstelle.

Um einen Plattformanwendungsendpunkt zu löschen

Im folgenden delete-endpoint Beispiel wird der angegebene Plattformanwendungsendpunkt gelöscht.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Um eine Plattformanwendung zu löschen

Im folgenden delete-platform-application Beispiel wird die angegebene Plattformanwendung gelöscht.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

So löschen Sie das SNS-Thema

Das folgende delete-topic-Beispiel löscht die angegebene SNS-Thema.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Um die Endpunktattribute von Plattformanwendungen aufzulisten

Im folgenden get-endpoint-attributes Beispiel werden die Attribute für den angegebenen Plattformanwendungsendpunkt aufgeführt.

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

Ausgabe:

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

Um die Attribute der Plattformanwendung aufzulisten

Im folgenden get-platform-application-attributes Beispiel werden die Attribute für die angegebene Plattformanwendung aufgeführt.

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

Ausgabe:

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

So führen Sie die Standard-SMS-Nachrichtenattribute auf

Das folgende get-sms-attributes-Beispiel führt die Standardattribute für das Senden von SMS-Nachrichten auf.

aws sns get-sms-attributes

Ausgabe:

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

Um Abonnementattribute für ein Thema abzurufen

Im Folgenden get-subscription-attributes werden die Attribute des angegebenen Abonnements angezeigt. Sie können das subscription-arn aus der Ausgabe des list-subscriptions Befehls abrufen.

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

Ausgabe:

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

So rufen Sie die Attribute eines Themas ab

Im folgenden get-topic-attributes-Beispiel werden die Attribute für das angegebene Thema angezeigt.

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

Ausgabe:

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

Um die Endpunkte für eine Plattformanwendung aufzulisten

Im folgenden list-endpoints-by-platform-application Beispiel werden die Endpunkte und Endpunktattribute für die angegebene Plattformanwendung aufgeführt.

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

Ausgabe:

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

So führen Sie Abmeldungen für SMS-Nachrichten auf

Das folgende list-phone-numbers-opted-out-Beispiel listet die Telefonnummern auf, bei denen der Empfang von SMS-Nachrichten abbestellt wurde.

aws sns list-phone-numbers-opted-out

Ausgabe:

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

Um Plattformanwendungen aufzulisten

Das folgende list-platform-applications Beispiel listet die Plattformanwendungen für ADM und MPNS auf.

aws sns list-platform-applications

Ausgabe:

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

Um die Abonnements aufzulisten, die einem Thema zugeordnet sind

Im Folgenden wird eine Liste der SNS-Abonnements list-subscriptions-by-topic abgerufen, die dem angegebenen Thema zugeordnet sind.

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

Ausgabe:

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

So führen Sie Ihre SNS-Abonnements auf

Im folgenden list-subscriptions Beispiel wird eine Liste der SNS-Abonnements in Ihrem AWS Konto angezeigt.

aws sns list-subscriptions

Ausgabe:

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

Um Tags für ein Thema aufzulisten

Das folgende list-tags-for-resource Beispiel listet die Tags für das angegebene Amazon SNS SNS-Thema auf.

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

Ausgabe:

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

So führen Sie Ihre SNS-Themen auf

Das folgende list-topics Beispiel listet alle SNS-Themen in Ihrem AWS Konto auf.

aws sns list-topics

Ausgabe:

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

Um sich für SMS-Nachrichten anzumelden

Im folgenden opt-in-phone-number Beispiel wird die angegebene Telefonnummer für den Empfang von SMS-Nachrichten aktiviert.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Beispiel 1: So veröffentlichen Sie eine Nachricht für ein Thema

Das folgende publish-Beispiel veröffentlicht die angegebene Nachricht im angegebenen SNS-Thema. Die Nachricht stammt aus einer Textdatei, in der Sie Zeilenumbrüche einfügen können.

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

Inhalt von message.txt:

Hello World
Second Line

Ausgabe:

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

Beispiel 2: So veröffentlichen Sie eine SMS-Nachricht an eine Telefonnummer

Im folgenden publish-Beispiel wird Nachricht Hello world! an Telefonnummer +1-555-555-0100 veröffentlicht.

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

Ausgabe:

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

Um eine Datenschutzrichtlinie festzulegen

Beispiel 1: Um Publishern die Veröffentlichung von Nachrichten mit zu verbieten CreditCardNumber

Im folgenden put-data-protection-policy Beispiel wird Verlegern das Veröffentlichen von Nachrichten mit CreditCardNumber verweigert.

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\":{}}}]}"

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Beispiel 2: Um Parameter aus einer Datei zu laden

Im Folgenden werden Parameter aus einer Datei put-data-protection-policy geladen.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Um eine Berechtigung aus einem Thema zu entfernen

Im folgenden remove-permission Beispiel wird die Berechtigung Publish-Permission für das angegebene Thema entfernt.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Um Endpunktattribute festzulegen

Im folgenden set-endpoint-attributes Beispiel wird der angegebene Plattformanwendungsendpunkt deaktiviert.

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

Ausgabe:

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

So legen Sie Plattformanwendungsattribute fest

Im folgenden set-platform-application-attributes Beispiel wird das EventDeliveryFailure Attribut für die angegebene Plattformanwendung auf den ARN des angegebenen Amazon SNS SNS-Themas gesetzt.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

So legen Sie SMS-Nachrichtenattribute fest

Im folgenden set-sms-attributes-Beispiel wird die standardmäßige Absender-ID für SMS-Nachrichten auf MyName festgelegt.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

So legen Sie Abonnementattribute fest

Im folgenden set-subscription-attributes-Beispiel wird das RawMessageDelivery-Attribut auf ein SQS-Abonnement festgelegt.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Im folgenden set-subscription-attributes-Beispiel wird ein FilterPolicy-Attribut auf ein SQS-Abonnement festgelegt.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Im folgenden set-subscription-attributes-Beispiel wird das FilterPolicy-Attribut von einem SQS-Abonnement entfernt.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

So legen Sie ein Attribut für ein Thema fest

Im folgenden set-topic-attributes-Beispiel wird das DisplayName-Attribute für das angegebene Thema festgelegt.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

So abonnieren Sie ein Thema

Der folgende subscribe-Befehl abonniert das angegebene Thema mit eine E-Mail-Adresse.

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

Ausgabe:

{
    "SubscriptionArn": "pending confirmation"
}

So fügen Sie einem Thema ein Tag hinzu

Das folgende tag-resource-Beispiel fügt dem angegebenen Amazon-SNS-Thema ein Metadaten-Tag hinzu.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

So melden Sie sich von einem Thema ab

Im folgenden unsubscribe-Beispiel wird das angegebene Abonnement aus einem Thema gelöscht.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Um ein Tag aus einem Thema zu entfernen

Im folgenden untag-resource Beispiel werden alle Tags mit den angegebenen Schlüsseln aus dem angegebenen Amazon SNS SNS-Thema entfernt.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

So erstellen Sie ein Plattformanwendungsendpunkt

Im folgenden create-platform-endpoint-Beispiel wird mithilfe des angegebenen Tokens ein Endpunkt für die angegebene Plattformanwendung erstellt.

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

Ausgabe:

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