Amazon SNS - Subscribe Topic

Overview

You can use this Snap to subscribe to a topic on Amazon SNS. To receive messages published to a topic, you must subscribe an endpoint (for example, HTTP/HTTPS) to the topic. When you subscribe an endpoint to a topic, the endpoint receives messages published to the associated topic.


Amazon SNS - Subscribe Topic Snap

Supported Accounts

Prerequisites

  • For an Amazon SNS topic to be able to send messages to a queue, you should set a policy on the queue that allows the Amazon SNS topic to perform the SQS:SendMessage action before subscribing a queue to a topic. See Subscribing an Amazon SQS queue to an Amazon SNS topic for further information.
  • Create an endpoint and topic and configure before you subscribe to a topic.

Snap views

Type Description Examples of upstream and downstream Snaps
Input

Document. This Snap has at most one document input view.

The topic ARN, attributes, protocol, and endpoint details of the topic.
Output

Document. This Snap has at most one document output view.

The endpoint details that is subscribed to the topic.
Learn more about Error handling.

Snap settings

Note: Learn about the common controls in the Snap settings dialog.
Field/Field set Description

Label

String

 Required.Specify a unique name for the Snap. Modify this to be more appropriate, especially if there are more than one of the same Snap in the pipeline.

Default value: Subscribe Topic

Example: Subscribe Orders Topic
Region

String/Expression/ Suggestion

Specify the AWS region where the application is implemented. This is a suggestible field and suggestions are populated based on the Account settings. If the region field is empty, then the Snap evaluates the region in the following sequence:

  • The Topic ARN or Subscription ARN
  • The region of the EC2 instance.
Note: It is a best practice to provide value for the Region field.

Default value: None

Example: us-east-1, us-west-1
Topic ARN

String/Expression/ Suggestion

Required. Specify the Amazon Resource Name of the topic. This is a suggestible field and suggestions are populated based on the Account settings.

Default value: N/A

Example: Topic 1
Protocol

Dropdown list

Choose the Internet protocol to connect to the Amazon server. Options available include:

  • http
  • https
  • email
  • email-json
  • SQS
  • sms

Default value: http

Example: https
Endpoint

String/Expression

Enter the endpoint value, such as an email address or the ARN of an Amazon SQS queue.

Default value: N/A

Example: [email protected]
Attributes

Use this field set to specify the topic attributes.
Attribute Name

String/Expression/ Suggestion

Enter the name of the attribute in the topic. This is a suggestible field and suggestions are populated based on the Account settings.

Default value: N/A

Example: Topic 1234
Attribute Value

Integer/Expression

Enter the value of the attribute in the topic.

Default value: N/A

Example: 3456
Always Return Subscription ARN

Checkbox

Select this checkbox if you want to return the subscription ARN even if it is not yet confirmed. Otherwise, the pending subscription is returned for an unconfirmed subscription.

Default status: Deselected

Example: Selected

Snap execution

Dropdown list
Choose one of the three modes in which the Snap executes. Available options are:
  • Validate & Execute: Performs limited execution of the Snap and generates a data preview during pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during pipeline runtime.
  • Execute only: Performs full execution of the Snap during pipeline execution without generating preview data.
  • Disabled: Disables the Snap and all Snaps that are downstream from it.

Default value: Execute only

Troubleshooting

Error Cause Resolution
An error occurred while updating a topic with the given topic name in AWS SNS. Valid information might be missing. Check the input data, formats and try again.
Missing Topic ARN Topic ARN should not be blank. The topic ARN must be provided.