Manage Topic

In this article

Overview

You can 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.

Prerequisites

  • Valid AWS Account and SNS access.

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

  • Create Topic to manage a topic.

Support for Ultra Pipelines

Works in Ultra Pipelines

Limitations

None.

Known Issues

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

Views

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

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

Output

Document

  • Min: 0

  • Max: 1

  • Copy

The updated topic is displayed.

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

Specify a unique 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: Manage Topic

Region

String

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 the region field is empty, then the Snap evaluates the region in the following sequence:
Topic Arn or Subscription ARN and the region of the EC2 instance.

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

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
ExampleTopic 1

Operation

Dropdown list

Select one of the three options for which you want the Snap to manage attributes or tags. Available options are:

  • Update topic attribute

  • Update tag attributes

  • Remove tag attributes

Update topic attribute

Select to update the topic attributes. This field set consists of the following fields:

  • Attribute Name

  • Attribute Value

Attribute Name

String

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

Default Value: N/A
ExampleTopic 1234

Attribute Value

Integer

Enter the value of the attribute in the topic.

Default Value: N/A
Example3456

Update tag attributes

Select to update the tag attributes. This field set consists of the following fields:

  • Tag Name

  • Value

Tag Name

String

Specify a name for the tag attribute.

Value

String

Specify a name for the tag value.

Remove tag attributes

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

Remove Tag Names

String

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

Snap Execution

Dropdown

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 Topic ARN

Topic ARN should not be blank

The topic ARN must be provided.

Examples

In the following example, a topic is created with all the input details and it is updated or managed by adding or removing attributes.

First, a topic is created with the attribute and tag attributes:

Snap Settings

Input View

Snap Settings

Input View

 

The Manage Topic Snap is used to perform certain operations like removing attributes and updating tags. Following are the Snap Settings:

Snap Settings

Input View

Snap Settings

Input View

 

 

 

 

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