Skip to end of banner
Go to start of banner

Manage Topic

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 19 Next »

In this article

Overview

You can use this Snap to update and remove attributes and tags that are given while creating the 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.

  • You have to 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

Snap Input and Output

Input/Output

Type of View

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.

Snap Settings

Field names marked with an asterisk ( * ) are mandatory.

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: Manage Topic

Region

String

N/A

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

N/A

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

Yes

Select one of the three option in 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

N/A

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

N/A

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

N/A

Specify a name for the tag attribute.

Value

String

N/A

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

N/A

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

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

An error occurred while updating a topic with the given topic name in AWS SNS.

 

Please check the input data, formats and try again.

Missing Topic ARN

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

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 Pack History

Error rendering macro 'excerpt-include' : No location was provided.


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

  • No labels