Set Subscription Attribute

In this article

Overview

You can use this Snap to allow a subscription owner to set an attribute of the subscription to a new value.

Prerequisites

  • Valid AWS Account and SNS access.

  • Create Topic and Subscribe Topic to an endpoint (SQS/Email/Email-JSON etc) before performing the Set Subscription action.

Support for Ultra Pipelines

Works in 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

Subscribe Arn, region and attributes that you want to update or modify in the topic.

Output

Document

  • Min: 0

  • Max: 1

  • Copy

The updated 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*

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.

Default Value: N/A
Example: Set Topic

Region

String

Specify the AWS region where the application is implemented. If the region field is not present, then the region will be evaluated in the following sequence by the Snap:

  • The Topic Arn or Subscription ARN

  • The region of the EC2 instance

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

Topic Arn

String

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
Example: arn:aws:sns:us-west-2:740934760981:SNS_427_SNPQA_Create_Topic_PublishMessage_ManageSubscription_Scenario_8b_String_anythingButMatching

Subscribe Arn*

String

Specify the ARN of the subscription you want to delete.

Default Value: N/A
Example: arn:aws:sns:us-west-2:740934760981:SNS_427_SNPQA_Create_Topic_PublishMessage_ManageSubscription_Scenario_8b_String_anythingButMatching:08765416e-6671-49d9-884e-3d438959f80c

Attribute Name

String

Enter the name of the attribute in the topic. Following attributes are available:

  • DeliveryPolicy: The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

  • FilterPolicy: The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.

  • RawMessageDelivery:  Enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is created for Amazon SNS metadata.

  • RedrivePolicy: Sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that cannot be delivered due to client errors or server errors are held in the dead-letter queue for further analysis or reprocessing.

  • SubscriptionRoleArn: The attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions. The ARN of the IAM role that has the following:

    • Permission to write to the Kinesis Data Firehose delivery stream

    • Amazon SNS listed as a trusted entity

Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.

Default Value: N/A
Example: RedrivePolicy

Attribute Value

Integer

Enter the value of the attribute in the topic.

Default Value: N/A
Example: 3456

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 might be missing.

Please check the input data, formats and try again.

Missing Subscribe ARN

 Subscribe ARN is missing

The Subscribe ARN must be provide

Examples

This example demonstrates how to set subscription attributes, once you create the topic and subscribe the endpoint to a topic.

For creating a topic and confirming an endpoint subscription to a topic, see Confirm Subscription | Examples. Once the subscription is confirmed, the attributes in the subscription are managed with the help of Set Subscription attributes Snap.

After subscribing to the topic, the subscription attributes are managed with the Set Subscription Attributes Snap by providing the Subscription Arn. The Snap Settings and output view of the Snap are displayed as follows:

Downloads

  File Modified

File AWS-SNS_set_subscription_attributes.slp

Nov 12, 2021 by Shilpa

Snap Pack History

 


See Also

Amazon SNS Snap Pack

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