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
• Créer votre URL Apprise

Configuration du compte

Vous devrez d’abord creer un compte Amazon Web Service, AWS, pour utiliser ce service. Si vous n’en avez pas encore, une carte bancaire sera necessaire, meme si les 12 premiers mois sont gratuits. Si vous avez deja un compte, ou si vous l’utilisez via votre entreprise, vous pouvez passer a l’etape suivante.

L’etape suivante consiste a generer 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. Developpez la section Access keys (access key ID and secret access key).
3. Cliquez sur Create New Access Key.
4. Les informations s’afficheront a l’ecran et vous pourrez aussi telecharger un fichier contenant les memes donnees. Il est recommande de le faire, car il ne sera plus possible de recuperer cette cle plus tard, sauf a la supprimer puis en creer une nouvelle.

A ce stade, on suppose donc que tout est configure 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 necessaire. Vous pourrez ensuite les referencer avec ce service de notification.

Identifiants temporaires (Session Token)

Les roles d’execution AWS Lambda, les roles IAM assumes via STS (aws sts assume-role) et d’autres sources d’identifiants de courte duree fournissent un troisieme composant en plus du Access Key ID et du Secret Access Key : le Session Token (AWS_SESSION_TOKEN). Ce jeton doit etre inclus lors de la signature des requetes, sans quoi AWS les rejettera avec une erreur d’autorisation.

Apprise prend en charge les jetons de session de deux facons :

• Parametre de requete (recommande) : ajoutez ?token={SessionToken} a n’importe quelle URL SNS — le jeton est accepte exactement tel qu’AWS le fournit, sans echappement necessaire.
• Prefixe dans l’URL : placez le jeton avant le Access Key ID en les separant par @ : sns://{SessionToken}@{AccessKeyID}/... — tout caractere / dans le jeton doit etre encode en %2F.

Astuce

Les jetons de session AWS sont encodes en base64 et contiennent frequemment des caracteres /. L’utilisation de ?token= evite d’avoir a les echapper.

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 melanger numeros de telephone et topics :

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

Le fait de prefixer les topics par un hashtag, #, et les numeros de telephone par un plus, +, permet d’eviter les ambiguites, par exemple lorsqu’un topic ne contient que des chiffres. Ces caracteres 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 (defaut)	Cibles avec numeros de telephone, ou melange	Le titre est prepend au corps	160 caracteres
topic	Cibles uniquement des topics (auto-detecte), ou ?mode=topic force	Le titre est envoye comme champ SNS Subject	256 Ko

Le mode est auto-detecte a partir de votre URL : si toutes les cibles sont des topics, le mode topic est utilise ; si des numeros de telephone sont presents, le mode sms est utilise. Vous pouvez forcer le mode avec ?mode=sms ou ?mode=topic.

Note

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

Detail des Parametres

Variable	Obligatoire	Description
AccessKeyID	*Oui	Access Key ID genere depuis la AWS Management Console.
AccessKeySecret	*Oui	Access Key Secret genere depuis la AWS Management Console.
Region	*Oui	Code region, par exemple us-east-1, us-west-2, cn-north-1.
PhoneNo	Non	Le numero de telephone doit inclure le prefixe d’appel du pays. Vous pouvez facultativement le prefixer par +. Les parentheses, espaces et tirets sont acceptes.
Topic	Non	Nom d’un topic SNS. Vous pouvez facultativement le prefixer par #.
SessionToken	Non	Jeton de session AWS pour les identifiants temporaires/IAM (AWS_SESSION_TOKEN). Privilegiez ?token= — les jetons contiennent souvent des / qui doivent etre echappes en %2F dans la forme prefixe @.
mode	Non	Definissez sms ou topic pour remplacer la detection automatique. Par defaut sms si des numeros de telephone sont presents ; topic si seuls des topics sont listes.
key	Non	Alias pour AccessKeyID (?key=). Utile dans les configurations YAML.
access	Non	Alias legacy 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	Ce paramètre peut être défini sur split, truncate ou upstream. Il détermine la manière dont Apprise remet le message que vous lui transmettez. Par défaut, il vaut upstream. 👉 upstream : ne fait aucune modification et transmet le message exactement tel qu’il a été reçu au service. 👉 truncate : veille à ce que le message tienne dans la limite amont documentée par le service. Si plus d’informations sont fournies que la limite définie, l’excédent est tronqué. 👉 split : similaire à truncate, sauf que si le message dépasse la limite amont documentée par le service, il est découpé en plusieurs morceaux plus petits puis envoyés séquentiellement.
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é. L’appel global notify() retourne quand même True 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 Etats-Unis, donc avec l'indicatif pays +1
#   - corresponde au numero 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 fonctionne
# les espaces, parentheses et tirets sont acceptes dans un numero :
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 abonnes par e-mail) :

# Le mode topic est auto-detecte quand seuls des topics sont listes
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 role IAM ou Lambda :

# Recommande : ?token= accepte le jeton exactement tel qu'AWS le fournit,
# sans echappement meme si le jeton contient des caracteres /
apprise -vv -b "Alerte Lambda declenchee" \
   "sns://AHIAJGNT76XIMXDBIJYA/bu1dHSdO22pfaaVy/wmNsdljF4C07D3bndi9PQJ9/us-east-2/+18005551223?token=MonJetonDeSession"

# Alternatif : jeton en position de prefixe dans l'URL -- tout / dans le jeton
# doit etre encode en %2F
apprise -vv -b "Alerte Lambda declenchee" \
   "sns://MonJetonDeSession@AHIAJGNT76XIMXDBIJYA/bu1dHSdO22pfaaVy/wmNsdljF4C07D3bndi9PQJ9/us-east-2/+18005551223"

Exemple de configuration YAML avec des parametres nommes :

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