Delete Subscription

In this article

Overview

You can use this Snap to delete the subscription of an endpoint to a topic in AWS. You can only delete confirmed subscriptions. When you delete the subscription of an endpoint to a topic, the endpoint begins to receive messages published to the associated topic.

Prerequisites

  • Valid AWS Account and SNS access.

  • Authentication such as IAM Role access, Access key, and Security Access key.

  • A confirmed subscription

Support for Ultra Pipelines

Limitations

None.

Known Issues

None.

Snap Input and Output

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 0

  • Max: 1

  • Mapper

Region and ARN of the topic and subscription that you want to delete.

Output

Document

  • Min: 0

  • Max: 1

  • Copy

Unsubscribed 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

Field Dependency

Description

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: DeleteTopic

Region

String

N/A

Specify the AWS region where the application is implemented. Alternatively, click the Suggestion icon to fetch a list of Region. If the region field is empty, then the Snap evaluates the region in the following sequence:
Topic Arn or Subscription ARN > the region of the EC2 instance.

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

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

Topic Arn

String

N/A

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

Default Value: N/A
Example: Topic 1

Subscribe Arn*

String

N/A

Specify the ARN of the subscription you want to delete.

Default Value: N/A
Example: Subscription 1

Snap Execution

 

Dropdown list

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 is missing.

Check the input data, formats and try again.

Missing Topic ARN

 Topic ARN is mandatory.

Provide the Topic ARN.

Example

See Confirm Subscription | Examples to understand the Delete Subscription functionality.

Snap Pack History


See Also

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

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