Subscribe Topic

In this article

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.

Prerequisites

Support for Ultra Pipelines

Works in Ultra Pipelines. 

Limitations

None.

Known Issues

None.

Snap Input and Output

Input/Output

Type of View

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input/Output

Type of View

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 0

  • Max: 1

  • Mapper

The topic Arn, attributes, protocol and endpoint details of the topic.

Output

Document

  • Min: 0

  • Max: 1

  • Copy

The endpoint details that is subscribed to the topic.

Error

Error handling is to have a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that might arise while running the Pipeline by choosing one of the options from the When errors occur section under the Views tab.

The options available are:

  • Stop Pipeline Execution: Stops the current pipeline execution when an error arises.

  • Discard Error Data and Continue: Ignores an error completely, discard that record, and continue with the rest of the records.

  • Route Error Data to Error View: Routes the data to an error view of the Snap and then decides what to do with the error.

See Error View in Pipeline in examples to understand the Snap error view settings and error output. For more information on the error view and handling error output in a Pipeline, see Error handling in Pipelines.

Snap Settings

  • Asterisk (*): Indicates a mandatory field.

  • Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.

  • Expression icon (): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

  • Add icon (): Indicates that you can add fields in the field set.

  • Remove icon (): Indicates that you can remove fields from the field set.

 

Field Name

Field Type

Description

Field Name

Field Type

Description

Label*

 

Default Value: N/A
Example: Subscribe Topic

String

The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline.

 

Region

 

Default value: None
Example: us-east-1, us-west-1

String

Specify the AWS region where the application is implemented. This is a suggestible field and suggestions will be populated based on the Account settings. If the region field is empty, then the Snap evaluates the region in the following sequence:
Topic Arn or Subscription ARN and the region of the EC2 instance.

It is a best practice to provide the value for Region field.

 

Topic Arn*

 

Default Value: N/A
Example: Topic 1

String

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

 

Protocol

 

Default Value: http
Example: https

Dropdown list

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

  • http

  • https

  • email

  • email-json

  • SQS

  • sms

Endpoint

String

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

Attributes

Select to update the topic attributes.

Attribute Name

 

Default Value: N/A
Example: Topic 1234

String

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

 

Attribute Value

 

Default Value: N/A
Example: 3456

Integer

Enter the value of the attribute in the topic.

 

Always Return Subscription ARN


Default Value: Deselected

Checkbox

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

Snap Execution

 

Default Value: Execute only
Example: Validate & Execute

Select 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.

Troubleshooting

Error

Reason

Resolution

Error

Reason

Resolution

An error occurred while updating a topic with the given topic name in AWS SNS.

 Valid information might be missing.

Please check the input data, formats and try again.

Missing Topic ARN

 Topic ARN should not be blank.

The topic ARN must be provided.

Examples

In this pipeline, Mapper Snap is used to give the details of the endpoint and topic to be subscribed, and then the Subscribe topic Snap is used to Subscribe the given endpoint to the topic.

The Mapper Snap is configured with the endpoint and topic details in Input Schema.

Snap Settings

Output View

Snap Settings

Output View

 

 

Once the topic details and endpoint are given, the Subscribe topic Snap is used to Subscribe an endpoint to the topic. As a result, the endpoint is subscribed or the Snap throws an error that the topic cannot be subscribed to.

Snap Settings

Output View

Snap Settings

Output View

 

Snap Pack History


See Also

https://docs-snaplogic.atlassian.net/wiki/spaces/SD/pages/1439233/Glossary

https://docs-snaplogic.atlassian.net/wiki/spaces/SD/pages/1438341/Getting+Started

https://docs-snaplogic.atlassian.net/wiki/spaces/SD/pages/1439233/Glossary