Amazon SNS - Manage Topic

Overview

Use this Snap to update and remove attributes and tags in a topic in Amazon SNS. Provide details of the attributes and tag attributes that you want to update or remove from the topic.


Amazon SNS - Manage Topic Snap

Supported Accounts

Prerequisites

  • Valid AWS Account and SNS access.
  • Authentication such as IAM Role access, Access key, and Security Access key.
  • A topic created with the Amazon SNS - Create Topic Snap to manage.

Known Issues

The Snap does not generate errors when a non-existing tag is removed.

Snap views

Type Description Examples of upstream and downstream Snaps
Input

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

Topic ARN, region, attributes, and tag 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 is displayed.
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: Manage Topic

Example: Manage Orders Topic
Region

String/Expression/ Suggestion

Specify the AWS region where the application is implemented. This is a suggestible field and suggestions are populated based on the Account settings. If the region field is empty, then the Snap evaluates the region in the following sequence:

  • The Topic ARN or Subscription ARN
  • The region of the EC2 instance.
Note: It is a best practice to provide value for the Region field.

Default value: None

Example: us-east-1, us-west-1
Topic ARN

String/Expression/ Suggestion

Required. 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: Topic 1
Operation

Dropdown list

Select one of the following options for which you want the Snap to manage attributes or tags:

  • Update topic attribute
  • Update tag attributes
  • Remove tag attributes

Default value: Update topic attribute

Example: Update tag attributes
Update topic attribute

Select to update the topic attributes. This field set consists of the Attribute Name and Attribute Value fields.
Attribute Name

String/Expression/ Suggestion

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

Default value: N/A

Example: Topic 1234
Attribute Value

Integer/Expression

Enter the value of the attribute in the topic.

Default value: N/A

Example: 3456
Update tag attributes

Select to update the tag attributes. This field set consists of the Tag Name and Value fields.
Tag Name

String/Expression

Specify a name for the tag attribute.

Default value: N/A

Example: tag1
Value

String/Expression

Specify a name for the tag value.

Default value: N/A

Example: tag_Name1
Remove tag attributes

Select to remove the tag attributes. This field set consists of the Remove Tag Names field.
Remove Tag Names

String/Expression

Enter the names of the tag to remove from the topic. You can add any number of tag names by clicking the Add icon on the field set.

Default value: N/A

Example: tag1

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 Topic ARN Topic ARN should not be blank. The topic ARN must be provided.