AWS IoT Greengrass Version 1 entró en la fase de vida útil prolongada el 30 de junio de 2023. Para obtener más información, consulte la política de mantenimiento de AWS IoT Greengrass V1 Después de esta fecha, AWS IoT Greengrass V1 no se publicarán actualizaciones que proporcionen funciones, mejoras, correcciones de errores o parches de seguridad. Los dispositivos que se ejecuten AWS IoT Greengrass V1 no se verán afectados y seguirán funcionando y conectándose a la nube. Le recomendamos encarecidamente que migre a AWS IoT Greengrass Version 2, ya que añade importantes funciones nuevas y es compatible con plataformas adicionales.
Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
Conector SNS
El conector SNS publica mensajes en un tema de Amazon SNS. Esto permite a los servidores web, direcciones de correo electrónico y otros suscriptores de mensajes responder a los eventos del grupo de Greengrass.
Este conector recibe información de mensaje de SNS sobre un tema de MQTT y, a continuación, envía el mensaje a un tema de SNS especificado. Si lo desea, puede utilizar las funciones de Lambda personalizadas para implementar los filtros o la lógica de formato en los mensajes antes de que se publiquen en este conector.
Este conector tiene las siguientes versiones.
Versión |
ARN |
---|---|
4 |
|
3 |
|
2. |
|
1 |
|
Para obtener información sobre los cambios de versión, consulte el Registro de cambios.
Requisitos
Este conector exige los siguientes requisitos:
Parámetros de conector
Este conector proporciona los siguientes parámetros:
Ejemplo de creación de conector (AWS CLI)
El siguiente comando de la CLI crea una ConnectorDefinition
con una versión inicial que contiene el conector de SNS.
aws greengrass create-connector-definition --name MyGreengrassConnectors --initial-version '{ "Connectors": [ { "Id": "MySNSConnector", "ConnectorArn": "arn:aws:greengrass:
region
::/connectors/SNS/versions/4", "Parameters": { "DefaultSNSArn": "arn:aws:sns:region
:account-id
:topic-name", "IsolationMode" : "GreengrassContainer" } } ] }'
En la consola de AWS IoT Greengrass, puede añadir un conector desde la página de Conectores del grupo. Para obtener más información, consulte Introducción a los conectores de Greengrass (consola).
Datos de entrada
Este conector acepta la información de mensaje de SNS sobre un tema de MQTT y, a continuación, publica el mensaje tal cual en el tema de SNS de destino. Los mensajes de entrada deben tener un formato JSON válido.
- Filtro de temas en la suscripción
-
sns/message
- Propiedades de mensajes
-
request
-
Información sobre los mensajes que se envían al tema de SNS.
Obligatorio:
true
Escriba:
object
que incluye las siguientes propiedades:message
-
El contenido del mensaje como cadena o en formato JSON. Para ver ejemplos, consulte Ejemplo de entrada.
Para enviar JSON, la propiedad
message_structure
debe establecerse enjson
y el mensaje debe ser un objeto JSON codificado como cadena que contenga una clavedefault
.Obligatorio:
true
Tipo:
string
Patrón válido:
.*
subject
-
El asunto del mensaje.
Obligatorio:
false
Escriba: texto ASCII, de hasta 100 caracteres. Este debe empezar por una letra, un número o un signo de puntuación. Este no debe incluir saltos de línea ni caracteres de control.
Patrón válido:
.*
sns_topic_arn
-
El ARN del tema de SNS en el que publicar mensajes. Si se especifica, el conector publica en este tema en lugar del tema predeterminado.
nota
El rol de grupo debe permitir el permiso
sns:Publish
en cualquier tema de destino. Para obtener más información, consulte Requisitos.Obligatorio:
false
Tipo:
string
Patrón válido:
arn:aws:sns:([a-z]{2}-[a-z]+-\d{1}):(\d{12}):([a-zA-Z0-9-_]+)$
message_structure
-
La estructura del mensaje.
Obligatorio:
false
. Se debe especificar para enviar un mensaje JSON.Tipo:
string
Valores válidos:
json
id
-
Un ID arbitrario para la solicitud. Esta propiedad se usa para asignar una solicitud de entrada a una respuesta de salida. Si se especifica, la propiedad
id
en el objeto de respuesta se establece en este valor. Si no utiliza esta característica, puede omitir esta propiedad o especificar una cadena vacía.Obligatorio:
false
Tipo:
string
Patrón válido:
.*
- Límites
-
El tamaño del mensaje está limitado a un tamaño de mensaje de SNS máximo de 256 KB.
- Ejemplo de entrada: mensaje en cadena
-
Este ejemplo envía un mensaje en cadena. Especifica la propiedad
sns_topic_arn
opcional, que anula el tema de destino predeterminado.{ "request": { "subject": "Message subject", "message": "Message data", "sns_topic_arn": "arn:aws:sns:
region
:account-id
:topic2-name" }, "id": "request123" } - Ejemplo de entrada: mensaje JSON
-
Este ejemplo envía un mensaje como objeto JSON codificado en cadena que incluye la clave
default
.{ "request": { "subject": "Message subject", "message": "{ \"default\": \"Message data\" }", "message_structure": "json" }, "id": "request123" }
Datos de salida
Este conector publica información de estado como datos de salida en un tema MQTT.
- Filtro de temas en la suscripción
-
sns/message/status
- Ejemplo de salida: Correcto
-
{ "response": { "sns_message_id": "f80a81bc-f44c-56f2-a0f0-d5af6a727c8a", "status": "success" }, "id": "request123" }
- Ejemplo de salida: Error
-
{ "response" : { "error": "InvalidInputException", "error_message": "SNS Topic Arn is invalid", "status": "fail" }, "id": "request123" }
Ejemplo de uso
Utilice los siguientes pasos de alto nivel para configurar una función de Lambda de Python 3.7 de ejemplo que puede utilizar para probar el conector.
nota
-
Si usa otros tiempos de ejecución de Python, puede crear un enlace simbólico de Python3.x a Python 3.7.
-
Los temas Introducción a los conectores (consola) y Introducción a los conectores (CLI) contienen pasos detallados que muestran cómo configurar e implementar un conector de notificaciones Twilio de ejemplo.
Asegúrese de cumplir los requisitos para el conector.
Para el requisito de rol de grupo, debe configurar el rol para conceder los permisos necesarios y asegurarse de que el rol se ha añadido al grupo. Para obtener más información, consulte Administración del rol de grupo de Greengrass (consola) o Administración del rol de grupo de Greengrass (CLI).
-
Cree y publique una función de Lambda que envíe datos de entrada al conector.
Guarde el código de ejemplo como un archivo PY. Descargue y descomprima el SDK de AWS IoT Greengrass Core para Python. A continuación, cree un paquete zip que contenga el archivo PY y la carpeta
greengrasssdk
en el nivel raíz. Este paquete zip es el paquete de implementación que se carga en AWS Lambda.Después de crear la función de Lambda de Python 3.7, publique una versión de característica y cree un alias.
-
Configuración del grupo de Greengrass.
-
Agregue la función de Lambda por su alias (recomendado). Configure el ciclo de vida de Lambda como de larga duración (o
"Pinned": true
en la CLI). -
Agregue el conector y configure sus parámetros.
-
Agregue suscripciones que permitan al conector recibir datos de entrada y enviar datos de salida en filtros de tema compatibles.
Establezca la función de Lambda como fuente, el conector como destino y utilice un filtro de tema de entrada compatible.
Establezca el conector como origen, AWS IoT Core como destino y utilice un filtro de tema de salida compatible. Utilice esta suscripción para ver los mensajes de estado en la consola de AWS IoT.
-
-
Implemente el grupo.
-
En la consola de AWS IoT, en la página Prueba suscríbase al tema de datos de salida para ver los mensajes de estado del conector. La función de Lambda de ejemplo es de larga duración y comienza a enviar mensajes inmediatamente después de implementar el grupo.
Cuando haya terminado de probar, puede establecer el ciclo de vida de Lambda en Bajo demanda (o
"Pinned": false
en la CLI) e implementar el grupo. Esto impide que la característica envíe mensajes.
Ejemplo
El siguiente ejemplo de función de Lambda envía un mensaje de entrada al conector.
import greengrasssdk import time import json iot_client = greengrasssdk.client('iot-data') send_topic = 'sns/message' def create_request_with_all_fields(): return { "request": { "message": "Message from SNS Connector Test" }, "id" : "req_123" } def publish_basic_message(): messageToPublish = create_request_with_all_fields() print("Message To Publish: ", messageToPublish) iot_client.publish(topic=send_topic, payload=json.dumps(messageToPublish)) publish_basic_message() def lambda_handler(event, context): return
Licencias
El conector de SNS incluye las siguientes licencias y software de terceros:
-
AWS SDK for Python (Boto3)
/Apache License 2.0 -
botocore
/Apache License 2.0 -
dateutil
/PSF License -
docutils
/BSD License, GNU General Public License (GPL), Python Software Foundation License, Public Domain -
jmespath
/MIT License -
s3transfer
/Apache License 2.0 -
urllib3
/MIT License
Este conector se publica bajo el contrato de licencia de software de Greengrass Core
Registros de cambios
La siguiente tabla describe los cambios en cada versión del conector.
Versión |
Cambios |
---|---|
4 |
Se ha agregado el parámetro |
3 |
Se actualizó el tiempo de ejecución de Lambda a Python 3.7, lo que cambia el requisito de tiempo de ejecución. |
2 |
Se ha introducido una corrección para reducir el registro excesivo. |
1 |
Versión inicial. |
Un grupo de Greengrass solo puede contener una versión del conector a la vez. Para obtener información sobre cómo actualizar una versión de conector, consulte Actualización de versiones de los conectores.
Véase también
-
Integración con servicios y protocolos mediante conectores de Greengrass
-
Publicar acción
en la documentación de Boto 3 -
¿Qué es Amazon Simple Notification Service? en la Guía para desarrolladores de Amazon Simple Notification Service