Amazon SNS

Le composant Amazon SNS (aws.greengrass.SNS) publie des messages dans une rubrique Amazon Simple Notification Service (Amazon SNS). Vous pouvez utiliser ce composant pour envoyer des événements depuis les appareils principaux de Greengrass vers des serveurs Web, des adresses e-mail et d'autres abonnés aux messages. Pour plus d'informations, consultez Qu'est-ce qu'Amazon SNS ? dans le guide du développeur Amazon Simple Notification Service.

Pour publier dans une rubrique Amazon SNS contenant ce composant, publiez un message dans la rubrique à laquelle ce composant est abonné. Par défaut, ce composant s'abonne à la publish/subscribe rubrique sns/message locale. Vous pouvez spécifier d'autres sujets, notamment des sujets AWS IoT Core MQTT, lorsque vous déployez ce composant.

Dans votre composant personnalisé, vous souhaiterez peut-être implémenter une logique de filtrage ou de formatage pour traiter les messages provenant d'autres sources avant de les publier dans ce composant. Cela vous permet de centraliser votre logique de traitement des messages sur un seul composant.

Versions

Les versions de ce composant sont les suivantes :

Type

Ce composant est un composant Lambda (aws.greengrass.lambda). Le noyau Greengrass exécute la fonction Lambda de ce composant à l'aide du composant Lambda launcher.

Pour de plus amples informations, veuillez consulter Types de composant.

Système d’exploitation

Ce composant ne peut être installé que sur les appareils principaux de Linux.

Exigences

Ce composant répond aux exigences suivantes :

Points de terminaison et ports

Ce composant doit être capable d'effectuer des requêtes sortantes vers les terminaux et les ports suivants, en plus des points de terminaison et des ports requis pour le fonctionnement de base. Pour de plus amples informations, veuillez consulter Autoriser le trafic des appareils via un proxy ou un pare-feu.

Dépendances

Lorsque vous déployez un composant, déploie AWS IoT Greengrass également des versions compatibles de ses dépendances. Cela signifie que vous devez répondre aux exigences relatives au composant et à toutes ses dépendances pour pouvoir le déployer avec succès. Cette section répertorie les dépendances pour les versions publiées de ce composant et les contraintes de version sémantiques qui définissent les versions des composants pour chaque dépendance. Vous pouvez également consulter les dépendances pour chaque version du composant dans la AWS IoT Greengrass console. Sur la page des détails des composants, recherchez la liste des dépendances.

Pour plus d'informations sur les dépendances des composants, consultez la référence des recettes des composants.

Configuration

Ce composant fournit les paramètres de configuration suivants que vous pouvez personnaliser lorsque vous déployez le composant.

{
  "lambdaExecutionParameters": {
    "EnvironmentVariables": {
      "DEFAULT_SNS_ARN": "arn:aws:sns:us-west-2:123456789012:mytopic"
    }
  },
  "containerMode": "GreengrassContainer"
}

{
  "lambdaExecutionParameters": {
    "EnvironmentVariables": {
      "DEFAULT_SNS_ARN": "arn:aws:sns:us-west-2:123456789012:mytopic"
    }
  },
  "containerMode": "NoContainer"
}

Données d’entrée

Ce composant accepte les messages relatifs au sujet suivant et publie le message tel quel dans la rubrique Amazon SNS cible. Par défaut, ce composant s'abonne aux publish/subscribe messages locaux. Pour plus d'informations sur la façon de publier des messages sur ce composant à partir de vos composants personnalisés, consultezPublier/souscrire des messages locaux.

Rubrique par défaut (locale publish/subscribe) : sns/message

Le message accepte les propriétés suivantes. Les messages d'entrée doivent être au format JSON.

{
  "request": {
    "subject": "Message subject",
    "message": "Message data",
    "sns_topic_arn": "arn:aws:sns:region:account-id:topic2-name"
  },
  "id": "request123"
}

{
  "request": {
    "subject": "Message subject",
    "message": "{ \"default\": \"Message data\" }",
    "message_structure": "json"
  },
  "id": "request123"
}

Données de sortie

Ce composant publie les réponses sous forme de données de sortie sur la rubrique MQTT suivante par défaut. Vous devez spécifier cette rubrique subject dans la configuration de l'ancien composant de routeur d'abonnement. Pour plus d'informations sur la façon de s'abonner à des messages sur ce sujet dans vos composants personnalisés, consultezPublish/subscribe AWS IoT Core Messages MQTT.

Rubrique par défaut (AWS IoT Core MQTT) : sns/message/status

{
  "response": {
    "sns_message_id": "f80a81bc-f44c-56f2-a0f0-d5af6a727c8a",
    "status": "success"
  },
  "id": "request123"
}

{
  "response" : {
    "error": "InvalidInputException",
    "error_message": "SNS Topic Arn is invalid",
    "status": "fail"
  },
  "id": "request123"
}

Fichier journal local

Ce composant utilise le fichier journal suivant.

/greengrass/v2/logs/aws.greengrass.SNS.log

Licences

Ce composant inclut le tiers suivant software/licensing :

Ce composant est publié dans le cadre du contrat de licence du logiciel Greengrass Core.

Journal des modifications

Le tableau suivant décrit les modifications apportées à chaque version du composant.