Exemples d'utilisation d'Amazon SNS AWS CLI

Pour ajouter une autorisation à un sujet

L'add-permissionexemple suivant ajoute l'autorisation 987654321098 au AWS compte d'utiliser l'Publishaction avec le sujet spécifié sous AWS compte123456789012.

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

Cette commande ne produit aucun résultat.

Pour vérifier la désactivation d'un numéro de téléphone aux SMS

L'check-if-phone-number-is-opted-outexemple suivant vérifie si le numéro de téléphone spécifié est désactivé pour ne pas recevoir de SMS en provenance du AWS compte courant.

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

Sortie :

{
    "isOptedOut": false
}

Pour confirmer un abonnement

La commande confirm-subscription suivante termine le processus de confirmation lancé lorsque vous vous êtes abonné à une rubrique SNS nommée my-topic. Le paramètre --token provient du message de confirmation envoyé au point de terminaison de notification spécifié dans l'appel d'abonnement.

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

Sortie :

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

Pour créer une application de plateforme

L'create-platform-applicationexemple suivant crée une application de plate-forme Google Firebase à l'aide des informations d'identification de plate-forme spécifiées.

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

Sortie :

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

Pour créer une rubrique SNS

L'exemple create-topic suivant crée une rubrique SNS nommée my-topic.

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

Sortie :

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

Pour plus d'informations, consultez la section Utilisation de l'interface de ligne de AWS commande avec Amazon SQS et Amazon SNS dans le Guide de l'utilisateur de AWS l'interface de ligne de commande.

Pour supprimer un point de terminaison d'une application de plateforme

L'delete-endpointexemple suivant supprime le point de terminaison de l'application de plate-forme spécifié.

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

Cette commande ne produit aucun résultat.

Pour supprimer une application de plateforme

L'delete-platform-applicationexemple suivant supprime l'application de plate-forme spécifiée.

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

Cette commande ne produit aucun résultat.

Pour supprimer une rubrique SNS

L'exemple delete-topic suivant supprime la rubrique SNS spécifiée.

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

Cette commande ne produit aucun résultat.

Pour répertorier les attributs des points de terminaison d'une application

L'get-endpoint-attributesexemple suivant répertorie les attributs du point de terminaison de l'application de plate-forme spécifié.

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

Sortie :

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

Pour répertorier les attributs de l'application de plate-forme

L'get-platform-application-attributesexemple suivant répertorie les attributs de l'application de plate-forme spécifiée.

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

Sortie :

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

Pour répertorier les attributs des SMS par défaut

L'exemple get-sms-attributes suivant répertorie les attributs par défaut pour l'envoi de SMS.

aws sns get-sms-attributes

Sortie :

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

Pour récupérer les attributs d'abonnement pour une rubrique

Les attributs de l'abonnement spécifié sont get-subscription-attributes affichés ci-dessous. Vous pouvez l'obtenir subscription-arn à partir de la sortie de la list-subscriptions commande.

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

Sortie :

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

Pour récupérer les attributs d'une rubrique

L'exemple get-topic-attributes suivant affiche les attributs de la rubrique spécifiée.

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

Sortie :

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

Pour répertorier les points de terminaison d'une application de plateforme

L'list-endpoints-by-platform-applicationexemple suivant répertorie les points de terminaison et les attributs de point de terminaison pour l'application de plate-forme spécifiée.

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

Sortie :

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

Pour répertorier les désactivations des SMS

L'exemple list-phone-numbers-opted-out suivant répertorie les numéros de téléphone qui ont désactivé la réception de SMS.

aws sns list-phone-numbers-opted-out

Sortie :

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

Pour répertorier les applications de la plateforme

L'list-platform-applicationsexemple suivant répertorie les applications de plate-forme pour ADM et MPNS.

aws sns list-platform-applications

Sortie :

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

Pour répertorier les abonnements associés à un sujet

Ce qui suit list-subscriptions-by-topic permet de récupérer la liste des abonnements SNS associés à la rubrique spécifiée.

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

Sortie :

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

Pour répertorier vos abonnements SNS

L'list-subscriptionsexemple suivant affiche la liste des abonnements SNS de votre AWS compte.

aws sns list-subscriptions

Sortie :

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

Pour répertorier les tags d'un sujet

L'list-tags-for-resourceexemple suivant répertorie les balises pour la rubrique Amazon SNS spécifiée.

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

Sortie :

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

Pour répertorier vos rubriques SNS

L'list-topicsexemple suivant répertorie toutes les rubriques SNS de votre AWS compte.

aws sns list-topics

Sortie :

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

Pour vous inscrire aux messages SMS

L'opt-in-phone-numberexemple suivant permet de choisir le numéro de téléphone spécifié pour recevoir des SMS.

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

Cette commande ne produit aucun résultat.

Exemple 1 : pour publier un message dans une rubrique

L'exemple publish suivant publie le message spécifié sur la rubrique SNS spécifiée. Le message provient d'un fichier texte qui vous permet d'inclure des sauts de ligne.

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

Contenu de message.txt :

Hello World
Second Line

Sortie :

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

Exemple 2 : pour publier un SMS sur un numéro de téléphone

L'exemple publish suivant publie le message Hello world! sur le numéro de téléphone +1-555-555-0100.

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

Sortie :

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

Pour définir la politique de protection des données

Exemple 1 : pour empêcher les éditeurs de publier des messages avec CreditCardNumber

L'put-data-protection-policyexemple suivant interdit aux éditeurs de publier des messages avec 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\":{}}}]}"

Cette commande ne produit aucun résultat.

Exemple 2 : pour charger des paramètres depuis un fichier

Ce qui suit put-data-protection-policy charge les paramètres à partir d'un fichier.

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

Cette commande ne produit aucun résultat.

Pour supprimer une autorisation d'un sujet

L'remove-permissionexemple suivant supprime l'autorisation Publish-Permission du sujet spécifié.

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

Cette commande ne produit aucun résultat.

Pour définir les attributs du point de terminaison

L'set-endpoint-attributesexemple suivant désactive le point de terminaison de l'application de plate-forme spécifié.

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

Sortie :

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

Pour définir les attributs de l'application de plate-forme

L'set-platform-application-attributesexemple suivant définit l'EventDeliveryFailureattribut de l'application de plate-forme spécifiée sur l'ARN de la rubrique Amazon SNS spécifiée.

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

Cette commande ne produit aucun résultat.

Pour définir les attributs des SMS

L'exemple set-sms-attributes suivant définit l'ID d'expéditeur par défaut des SMS sur MyName.

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

Cette commande ne produit aucun résultat.

Pour définir des attributs d'abonnement

L'exemple set-subscription-attributes suivant définit l'attribut RawMessageDelivery sur un abonnement 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

Cette commande ne produit aucun résultat.

L'exemple set-subscription-attributes suivant définit un attribut FilterPolicy sur un abonnement 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\"] }"

Cette commande ne produit aucun résultat.

L'exemple set-subscription-attributes suivant supprime l'attribut FilterPolicy d'un abonnement 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 "{}"

Cette commande ne produit aucun résultat.

Pour définir un attribut pour une rubrique

L'exemple set-topic-attributes suivant définit l'attribut DisplayName pour la rubrique spécifiée.

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

Cette commande ne produit aucun résultat.

Pour s'abonner à une rubrique

La commande subscribe suivante abonne une adresse e-mail à la rubrique spécifiée.

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

Sortie :

{
    "SubscriptionArn": "pending confirmation"
}

Pour ajouter une balise à une rubrique

L'exemple tag-resource suivant ajoute une balise de métadonnées à la rubrique Amazon SNS spécifiée.

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

Cette commande ne produit aucun résultat.

Pour se désabonner d'une rubrique

L'exemple unsubscribe suivant supprime l'abonnement spécifié d'une rubrique.

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

Cette commande ne produit aucun résultat.

Pour supprimer un tag d'un sujet

L'untag-resourceexemple suivant supprime toutes les balises contenant les clés spécifiées de la rubrique Amazon SNS spécifiée.

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

Cette commande ne produit aucun résultat.

Pour créer un point de terminaison d'application de plateforme

L'exemple create-platform-endpoint suivant crée un point de terminaison pour l'application de plateforme spécifiée à l'aide du jeton spécifié.

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

Sortie :

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