Confirm Subscription
In this article
Overview
You can use this Snap to confirm an endpoint subscription to a topic in Amazon SNS. It verifies an endpoint owner's intent to receive messages by validating the subscription token sent to the endpoint while subscribing to a topic. After you subscribe your endpoint, Amazon SNS will send a subscription confirmation message to the endpoint. Amazon SNS will not send messages to the endpoint until the subscription has been confirmed.
Prerequisites
Endpoint subscription to a topic. See, Subscribe Topic
Subscription Token
Support for Ultra Pipelines
Works in Ultra Pipelines.
Limitations
None.
Known Issues
None.
Views
View Type | View Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| The topic Arn, region and subscription token of the topic. |
Output | Document |
|
| The ARN of the subscription and the Subscription ID. |
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:
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 | Field Dependency | Description |
---|---|---|---|
Label* Default Value: N/A | String | N/A | Specify the name of 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
| 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 you do not provide a value in this field, the Snap evaluates the region in the following sequence: |
Topic Arn* Default Value: N/A | 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. |
Subscription Token* Default Value: N/A | String | N/A | Enter the valid subscription token sent to the endpoint while subscribing to a topic.
|
Authentication Required on Unsubscription | Checkbox | N/A | Select this checkbox if you want the Snap to verify the authentication of the user before unsubscribing an endpoint subscription to a topic. If this field is set to true, only topic owner and subscription owner can unsubscribe the endpoint. |
Snap Execution
Default value: Execute only | Select one of the three modes in which the Snap executes. Available options are:
|
Troubleshooting
Error | Reason | 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 | ARN must be provided. | The topic ARN must be provided. |
Example
In the following example, to confirm the subscription, the Subscription Arn is read from the endpoint (Email) created. To complete this task:
The Email Reader Snap is used to reading the email
The email from the AWS SNS is filtered and the latest email is read by the Filter and Head Snaps.
Mapper Snap is used to parse the Subscription Arn received in the text to JSON.
The subscription is confirmed with the Subscription Arn.
The Create Topic Snap is configured with the following attributes and tag attributes. The Snap Settings and output view of the Snap are displayed as follows:
An endpoint is subscribed to a topic. Here we are using the email-JSON protocol and giving the email ID as an endpoint. The Snap Settings and output view of the Snap are displayed as follows:
The Email Reader Snap is used to read the email. The email from the AWS SNS is filtered and the latest email is read by the Filter and Head Snaps. The Snap Settings and output view of the Snap are displayed as follows:
The Mapper Snap is used to parse the Subscription Arn received in the text to JSON. The Snap Settings and output view of the Snap are displayed as follows:
The subscription is confirmed with the Subscription Arn.
The Subscribed topic is deleted.
Snap Pack History
Related Content
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
Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2024 SnapLogic, Inc.