Amazon SNS

The Amazon SNS component (aws.greengrass.SNS) publishes messages to an Amazon Simple Notification Service (Amazon SNS) topic. You can use this component to send events from Greengrass core devices to web servers, email addresses, and other message subscribers. For more information, see What is Amazon SNS? in the Amazon Simple Notification Service Developer Guide.

To publish to an Amazon SNS topic with this component, publish a message to the topic where this component subscribes. By default, this component subscribes to the sns/message local publish/subscribe topic. You can specify other topics, including Amazon IoT Core MQTT topics, when you deploy this component.

In your custom component, you might want to implement filtering or formatting logic to process messages from other sources before you publish them to this component. This enables you to centralize your message processing logic on a single component.

Versions

This component has the following versions:

Type

This component is a Lambda component (aws.greengrass.lambda). The Greengrass nucleus runs this component's Lambda function using the Lambda launcher component.

For more information, see Component types.

Operating system

This component can be installed on Linux core devices only.

Requirements

This component has the following requirements:

Endpoints and ports

This component must be able to perform outbound requests to the following endpoints and ports, in addition to endpoints and ports required for basic operation. For more information, see Allow device traffic through a proxy or firewall.

Dependencies

When you deploy a component, Amazon IoT Greengrass also deploys compatible versions of its dependencies. This means that you must meet the requirements for the component and all of its dependencies to successfully deploy the component. This section lists the dependencies for the released versions of this component and the semantic version constraints that define the component versions for each dependency. You can also view the dependencies for each version of the component in the Amazon IoT Greengrass console. On the component details page, look for the Dependencies list.

For more information about component dependencies, see the component recipe reference.

Configuration

This component provides the following configuration parameters that you can customize when you deploy the component.

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

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

Input data

This component accepts messages on the following topic and publishes the message as is to the target Amazon SNS topic. By default, this component subscribes to local publish/subscribe messages. For more information about how to publish messages to this component from your custom components, see Publish/subscribe local messages.

Default topic (local publish/subscribe): sns/message

The message accepts the following properties. Input messages must be in JSON format.

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

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

Output data

This component publishes responses as output data on the following MQTT topic by default. You must specify this topic as the subject in the configuration for the legacy subscription router component. For more information about how to subscribe to messages on this topic in your custom components, see Publish/subscribe Amazon IoT Core MQTT messages.

Default topic (Amazon 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"
}

Local log file

This component uses the following log file.

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

Licenses

This component includes the following third-party software/licensing:

This component is released under the Greengrass Core Software License Agreement.

Changelog

The following table describes the changes in each version of the component.