Notifications Amazon Web Service (AWS) - Simple Notification Service (SNS)

Aperçu

• Source: https://aws.amazon.com/sns/
• Prise en charge des images: Non
• Prise en charge des pièces jointes: Non
• Limites de caractères des messages:
  • SMS: 160
  • Topic: 256000
• Format(s) de message pris en charge:
  • ✓TEXT
• Créer votre URL Apprise

Configuration du compte

Vous devrez d’abord créer un compte Amazon Web Service (AWS) pour utiliser ce service. Si vous n’en avez pas encore, une carte bancaire sera nécessaire, même si les 12 premiers mois sont gratuits. Si vous avez déjà un compte, ou si vous l’utilisez via votre entreprise, vous pouvez passer à l’étape suivante.

L’étape suivante consiste à générer un Access Key ID et un Secret Access Key :

1. Depuis la AWS Management Console, recherchez IAM dans la section AWS services ou cliquez simplement ici.
2. Développez la section Access keys (access key ID and secret access key).
3. Cliquez sur Create New Access Key.
4. Les informations s’afficheront à l’écran et vous pourrez aussi télécharger un fichier contenant les mêmes données. Il est recommandé de le faire, car il ne sera plus possible de récupérer cette clé plus tard, sauf à la supprimer puis à en créer une nouvelle.

À ce stade, on suppose donc que tout est configuré et que vous disposez bien de votre Access Key ID et de votre Secret Access Key.

Vous avez maintenant tout ce qu’il faut pour envoyer des SMS.

Si vous souhaitez envoyer vos notifications vers des topics, recherchez Simple Notification Service dans la AWS Management Console, section AWS services, puis configurez autant de topics que nécessaire. Vous pourrez ensuite les référencer avec ce service de notification.

Identifiants temporaires (Session Token)

Les rôles d’exécution AWS Lambda, les rôles IAM assumés via STS (aws sts assume-role) et d’autres sources d’identifiants de courte durée fournissent un troisième composant en plus du Access Key ID et du Secret Access Key : le Session Token (AWS_SESSION_TOKEN). Ce jeton doit être inclus lors de la signature des requêtes, sans quoi AWS les rejettera avec une erreur d’autorisation.

Apprise prend en charge les jetons de session de deux façons :

• Paramètre de requête (recommandé) : ajoutez ?token={SessionToken} à n’importe quelle URL SNS — le jeton est accepté exactement tel qu’AWS le fournit, sans échappement nécessaire.
• Préfixe dans l’URL : placez le jeton avant le Access Key ID en les séparant par @ : sns://{SessionToken}@{AccessKeyID}/... — tout caractère / dans le jeton doit être encodé en %2F.

Astuce

Les jetons de session AWS sont encodés en base64 et contiennent fréquemment des caractères /. L’utilisation de ?token= évite d’avoir à les échapper.

Syntaxe

La syntaxe valide est la suivante :

• sns://{AccessKeyID}/{AccessKeySecret}/{Region}/+{PhoneNo}
• sns://{AccessKeyID}/{AccessKeySecret}/{Region}/+{PhoneNo1}/+{PhoneNo2}/+{PhoneNoN}
• sns://{AccessKeyID}/{AccessKeySecret}/{Region}/#{Topic}
• sns://{AccessKeyID}/{AccessKeySecret}/{Region}/#{Topic1}/#{Topic2}/#{TopicN}
• sns://{SessionToken}@{AccessKeyID}/{AccessKeySecret}/{Region}/+{PhoneNo}
• sns://{AccessKeyID}/{AccessKeySecret}/{Region}/#{Topic}?token={SessionToken}

Vous pouvez aussi mélanger numéros de téléphone et topics :

• sns://{AccessKeyID}/{AccessKeySecret}/{Region}/+{PhoneNo1}/#{Topic1}

Le fait de préfixer les topics par un hashtag (#) et les numéros de téléphone par un signe plus (+) permet d’éviter les ambiguïtés, par exemple lorsqu’un topic ne contient que des chiffres. Ces caractères restent purement facultatifs.

Modes de fonctionnement

Le comportement de SNS varie selon le type de cibles :

Mode	Quand il s’applique	Gestion du titre	Limite du corps
sms (défaut)	Numéros de téléphone présents, ou mélange numéros + topics	Le titre est ajouté au début du corps	160 caractères
topic	Cibles uniquement des topics (auto-détecté), ou ?mode=topic forcé	Le titre est envoyé comme champ SNS Subject	256 Ko

Le mode est auto-détecté à partir de votre URL : si toutes les cibles sont des topics, le mode topic est utilisé ; si des numéros de téléphone sont présents, le mode sms est utilisé. Vous pouvez forcer le mode avec ?mode=sms ou ?mode=topic.

Note

En mode topic, le titre devient le champ SNS Subject. Les abonnés par e-mail au topic recevront une ligne d’objet appropriée. Les points de terminaison SMS abonnés au topic ne reçoivent pas de champ Subject — il s’agit d’une contrainte de l’API AWS.

AWS n’accepte qu’un objet sur une seule ligne et de moins de 100 caractères : Apprise remplace donc les retours à la ligne de votre titre par des espaces et le raccourcit à 99 caractères si nécessaire.

Détail des Paramètres

Variable	Obligatoire	Description
AccessKeyID	*Oui	Access Key ID généré depuis la AWS Management Console.
AccessKeySecret	*Oui	Access Key Secret généré depuis la AWS Management Console.
Region	*Oui	Code de région, par exemple us-east-1, us-west-2, cn-north-1.
PhoneNo	Non	Le numéro de téléphone doit inclure l’indicatif du pays. Vous pouvez facultativement le préfixer par +. Les parenthèses, espaces et tirets sont acceptés.
Topic	Non	Nom d’un topic SNS. Vous pouvez facultativement le préfixer par #.
SessionToken	Non	Jeton de session AWS pour les identifiants temporaires/IAM (AWS_SESSION_TOKEN). Privilégiez ?token= — les jetons contiennent souvent des / qui doivent être échappés en %2F dans la forme préfixe @.
mode	Non	Définissez sms ou topic pour remplacer la détection automatique. Par défaut sms si des numéros de téléphone sont présents ; topic si seuls des topics sont listés.
key	Non	Alias pour AccessKeyID (?key=). Utile dans les configurations YAML.
access	Non	Ancien alias pour AccessKeyID (?access=).
secret	Non	Alias pour AccessKeySecret (?secret=).
token	Non	Alias pour SessionToken (?token=). Utile dans les configurations YAML.

Paramètres Globaux

Variable	Description
overflow	Gère les messages qui dépassent la limite documentée d’un service. La valeur par défaut est upstream. 👉 upstream : envoie un seul message sans le découper ni le tronquer selon cette limite. 👉 truncate : conserve la partie qui tient dans la limite et supprime le reste. 👉 split : privilégie une coupure lisible, utilise une coupure stricte si nécessaire, puis envoie toutes les parties dans l’ordre. Le découpage d’un contenu non déclaré ou structuré reste une solution au mieux. Utilisez upstream si le corps doit rester intact.
format	Ce paramètre peut être défini sur text, html ou markdown. Certains services prennent en charge plusieurs formats de publication du contenu. La valeur par défaut varie selon le service choisi et peut correspondre à l’un de ces trois formats. Vous pouvez facultativement forcer cette option pour vous écarter du comportement par défaut. Si le service ne prend pas en charge plusieurs formats de transmission, ce champ est ignoré.
verify	Les requêtes externes vers des emplacements sécurisés, par exemple via https, utilisent des certificats. Par défaut, Apprise vérifie la validité de ces certificats ; si ce n’est pas le cas, aucune notification n’est envoyée à la source. Dans certains cas, un utilisateur ne dispose pas d’une autorité de certification pour valider la clé ou fait simplement confiance à la source ; dans ce cas, vous pouvez définir ce drapeau sur no. Par défaut, il vaut yes.
redirect	Par défaut, Apprise suit les redirections HTTP (réponses 3xx) émises par le serveur distant, conformément au comportement de la bibliothèque requests sous-jacente. Si vous souhaitez empêcher la transmission des en-têtes personnalisés et des identifiants vers des destinations différentes de l’URL d’origine, définissez cette option sur no. Par défaut, elle vaut yes.
cto	Signifie Socket Connect Timeout. Il s’agit du nombre de secondes pendant lesquelles Requests attend que votre client établisse une connexion avec une machine distante, ce qui correspond à l’appel connect() sur la socket. La valeur par défaut est de 4.0 secondes.
rto	Signifie Socket Read Timeout. Il s’agit du nombre de secondes pendant lesquelles le client attend que le serveur envoie une réponse. La valeur par défaut est de 4.0 secondes.
emojis	Active la prise en charge des emojis, par exemple :+1: qui sera traduit en 👍. Par défaut, cette option vaut no. Remarque : selon la configuration côté serveur, l’administrateur peut désactiver globalement la prise en charge des emojis ; mais par défaut, ce n’est pas le cas.
tz	Identifie le fuseau horaire de la base IANA que vous souhaitez utiliser. Par défaut, celui-ci est détecté à partir de la configuration du serveur qui exécute Apprise. Vous pouvez le définir sur des valeurs comme America/Toronto, ou sur tout autre fuseau correctement formaté correspondant à votre région.
retry	Nombre de tentatives de remise supplémentaires après le premier échec, avant d’abandonner. Accepte un entier compris entre 0 et 10. La valeur par défaut est 0 (aucune nouvelle tentative — une seule tentative est effectuée). Lorsqu’il est combiné avec wait, Apprise marque une pause du nombre de secondes spécifié entre chaque tentative.
wait	Nombre de secondes à attendre entre les nouvelles tentatives. Accepte une valeur décimale comprise entre 0.0 et 20.0 ; les entiers sont automatiquement convertis en virgule flottante. La valeur par défaut est 0.5. Ce paramètre n’est utile que si retry est supérieur à zéro — un service avec retry=0 effectue exactement une tentative, quelle que soit la valeur de wait.
optional	Lorsqu’il est défini sur yes, un échec de remise pour ce service est silencieusement absorbé. Le résultat global de notify() est quand même considéré comme réussi même si ce point de terminaison était injoignable, à condition que tous les services requis (non optionnels) du même lot aient réussi. Ce drapeau ne saute pas la remise ni ne contourne la logique de nouvelles tentatives — toutes les tentatives configurées sont effectuées avant que l’échec soit absorbé. Par défaut, il vaut no, ce qui signifie que chaque échec est propagé à l’appelant.

Exemples

Envoyer un message SMS :

# Supposons que notre {AccessKeyID} soit AHIAJGNT76XIMXDBIJYA
# Supposons que notre {AccessKeySecret} soit bu1dHSdO22pfaaVy/wmNsdljF4C07D3bndi9PQJ9
# Supposons que notre {Region} soit us-east-2
# Supposons que notre {PhoneNo}
#   - se trouve aux États-Unis, donc avec l'indicatif pays +1
#   - corresponde au numéro 800-555-1223
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   sns://AHIAJGNT76XIMXDBIJYA/bu1dHSdO22pfaaVy/wmNsdljF4C07D3bndi9PQJ9/us-east-2/+18005551223

# la variante suivante aurait aussi fonctionné
# les espaces, parenthèses et tirets sont acceptés dans un numéro :
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   sns://AHIAJGNT76XIMXDBIJYA/bu1dHSdO22pfaaVy/wmNsdljF4C07D3bndi9PQJ9/us-east-2/+1(800)555-1223

Envoyer vers un topic SNS (le titre devient le champ Subject pour les abonnés par e-mail) :

# Le mode topic est auto-détecté quand seuls des topics sont listés
apprise -vv -t "Sujet de l'Alerte" -b "Corps de l'Alerte" \
   sns://AHIAJGNT76XIMXDBIJYA/bu1dHSdO22pfaaVy/wmNsdljF4C07D3bndi9PQJ9/us-east-2/#MonTopicAlertes

# Forcer explicitement le mode topic
apprise -vv -t "Sujet de l'Alerte" -b "Corps de l'Alerte" \
   "sns://AHIAJGNT76XIMXDBIJYA/bu1dHSdO22pfaaVy/wmNsdljF4C07D3bndi9PQJ9/us-east-2/#MonTopicAlertes?mode=topic"

Envoyer avec des identifiants temporaires depuis un rôle IAM ou Lambda :

# Recommandé : ?token= accepte le jeton exactement tel qu'AWS le fournit,
# sans échappement même si le jeton contient des caractères /
apprise -vv -b "Alerte Lambda déclenchée" \
   "sns://AHIAJGNT76XIMXDBIJYA/bu1dHSdO22pfaaVy/wmNsdljF4C07D3bndi9PQJ9/us-east-2/+18005551223?token=MonJetonDeSession"

# Alternative : jeton en position de préfixe dans l'URL -- tout / dans le jeton
# doit être encodé en %2F
apprise -vv -b "Alerte Lambda déclenchée" \
   "sns://MonJetonDeSession@AHIAJGNT76XIMXDBIJYA/bu1dHSdO22pfaaVy/wmNsdljF4C07D3bndi9PQJ9/us-east-2/+18005551223"

Exemple de configuration YAML avec des paramètres nommés :

urls:
  - sns://:
      - access_key_id: AHIAJGNT76XIMXDBIJYA
        secret_access_key: bu1dHSdO22pfaaVy/wmNsdljF4C07D3bndi9PQJ9
        region: us-east-2
        to: "+18005551223,#MonTopicAlertes"
        token: MonJetonDeSession
        mode: topic