List Subscriptions activity

An activity that retrieves a list of subscriptions in Amazon SNS.


List Subscriptions activity

Configure the List Subscriptions activity

Examples

Prerequisites

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In Process Builder, in the Activity Library, open the Amazon SNS tab.

    Open Amazon SNS tab
  3. On the Amazon SNS tab, drag the List Subscriptions activity onto your process.

    Drag List Subscriptions activity

General Configuration

Specifies the basic settings for the List Subscriptions activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

  • Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field NameDefinition

Display Name

Description:
Specifies the activity name that shows in your process.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Description:
Specifies an optional text description for your activity.
Allowed Values:
More than one line of text.
Default Value:
None
Accepts Variables:
No

List Subscriptions Configuration

Specifies the information to retrieve a list of subcriptions in Amazon SNS.

Figure: List Subscriptions Configuration screen

>List Subscriptions Configuration screen

Fields

Field NameDefinition

Amazon Web Services

Description:
Specifies the access token that connects to your Amazon Web Services.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Variables:
No

Create Add Token icon

Opens this Screen:
Access Token for Amazon Web Services
Function of this Screen:
Configure an access token to connect to Amazon Web Services.

List Subscriptions By Topic / List All Subscriptions

Description:
Specifies whether to retrieve all subscriptions from a specific topic or all topics.
Allowed Values:
  • List Subscriptions By Topic – Retrieves a list of subscriptions from a specific topic.
  • List All Subscriptions – Retrieves a list of subscriptions from all topics associated with the access token.
Default Value:
List Subscriptions By Topic
Example:
Refer to:
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Topic ARN

Description:
Specifies the Amazon Resource Name (ARN) of the topic whose subscriptions to retrieve.

The topic ARN comes from Amazon SNS.

Allowed Values:
A topic ARN from Amazon SNS.

When you select the access token from the Amazon Web Service field, this field shows the topic ARNs associated with the access token.

Default Value:
None
Accepts Variables:
Yes
Example:
Refer to:
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Map Response To App Schema

Description:
Maps information about the subscription from the Amazon SNS data model to your process schema.
Allowed Values:

Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper.

Use this screen to connect the response to the data model for your process.

Because the query can return more than one result, the parent node in the external data source must be mapped to a node in the AgilePoint NX process schema that is a repeating schema element. The child nodes in both data models must also be mapped, but child nodes in AgilePoint NX inherit the repeating behavior from their parent node.

Default Value:
None
Example:
Refer to:
Limitations:
  • (Example) Schema Mapper
  • Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?