Amazon SNS - Set Subscription Attribute

Overview

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


Amazon SNS - Set Subscription Attribute Snap

Supported Accounts

Prerequisites

  • Valid AWS Account and SNS access.
  • Create a topic and subscribe to a topic for an endpoint (SQS/Email/Email-JSON, and so on) before performing the Set Subscription action.

Snap views

Type Description Examples of upstream and downstream Snaps
Input

Document. This Snap has at most one document input view.

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

Document. This Snap has at most one document output view.

The updated topic.
Learn more about Error handling.

Snap settings

Note: Learn about the common controls in the Snap settings dialog.
Field/Field set Description

Label

String

 Required.Specify a unique name for the Snap. Modify this to be more appropriate, especially if there are more than one of the same Snap in the pipeline.

Default value: Set Subscription Attribute

Example: Set Orders Subscription Attribute
Region

String/Expression/ Suggestion

Specify the AWS region where the application is implemented. If the region field is not present, then the region is 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/Expression/ Suggestion

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

Default value: N/A

Example: arn:aws:sns:us-west-2:740934760981:SNS_Topic
Subscribe ARN

String/Expression

Required. Specify the ARN of the subscription you want to update.

Default value: N/A

Example: arn:aws:sns:us-west-2:740934760981:SNS_Topic:08765416e-6671-49d9-884e-3d438959f80c
Attribute Name

String/Expression

Enter the name of the attribute in the topic. The 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 permission to write to the Kinesis Data Firehose delivery stream and Amazon SNS listed as a trusted entity. Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions.

Default value: N/A

Example: RedrivePolicy
Attribute Value

Integer/Expression

Enter the value of the attribute in the topic.

Default value: N/A

Example: 3456

Snap execution

Dropdown list
Choose 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 value: Execute only

Troubleshooting

Error Cause 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 Subscribe ARN Subscribe ARN is missing. The Subscribe ARN must be provided.