$customHeader
Skip to end of banner
Go to start of banner

Subscribe Topic

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 16 Next »

In this article

Overview

You can use this Snap to subscribe to a topic in the 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 begins to receive 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 

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

Icons used in the interface

  • Asterisk (*) - Mandatory fields.

  • Suggestion icon (blue star) - Suggestible fields and suggestions will be populated based on the account settings.

  • Expression icon (blue star) - Enable when you want to use expressions as field values.

Field Name

Field Type

Field Dependency

Description

Label*

String

N/A

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.

Default Value: N/A
Example: Subscribe Topic

Region

String

N/A

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.

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

Topic Arn*

String

N/A

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

Default Value: N/A
ExampleTopic 1

Protocol

N/A

The internet protocol to connect to Amazon server. Options available include:

  • http

  • https

  • email

  • email-json

  • SQS

  • sms

Endpoint

String

N/A

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

Attributes

Select to update the topic attributes. This field set consists of the following fields:

  • Attribute Name

  • Attribute Value

Attribute Name

String

N/A

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

Default Value: N/A
ExampleTopic 1234

Attribute Value

Integer

N/A

Enter the value of the attribute in the topic.

Default Value: N/A
Example3456

Always Return Subscription ARN

Checkbox

N/A

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

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.

Default valueExecute only
ExampleValidate & Execute

Troubleshooting

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

Once the details of the topic 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 Pack History

Release

Snap Pack Version

Date

Type

Updates

May 2024

main26341

Stable

Updated and certified against the current SnapLogic Platform release.

February 2024

main25112

Stable

Updated and certified against the current SnapLogic Platform release.

November 2023

main23721

Stable

Updated and certified against the current SnapLogic Platform release.

August 2023

main22460

Stable

Updated and certified against the current SnapLogic Platform release.

May 2023

main21015

Stable

Upgraded with the latest SnapLogic Platform release.

February 2023

432patches20327

Latest

The Amazon SNS account is enhanced with the Enable large message support checkbox to support publishing messages larger than 256KB. When you select this checkbox, the Snap displays S3 related properties that enables you to store the messages in the S3 bucket.

February 2023

main19844

Stable

Upgraded with the latest SnapLogic Platform release.

November 2022

main18944

10 Nov 2022 

Stable

Upgraded with the latest SnapLogic Platform release.

August 2022

main17386

11 Aug 2022 

Stable

Upgraded with the latest SnapLogic Platform release.

4.29

main15993

14 May 2022 

Stable

Upgraded with the latest SnapLogic Platform release.

4.28

main14627

12 Feb 2022 

Stable

Upgraded with the latest SnapLogic Platform release.

4.27

main12833

Stable

Amazon Simple Notification Service (Amazon SNS) is a managed service that provides message delivery from publishers to subscribers. Amazon SNS Snap Pack has the following Snaps:


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

  • No labels