Configurations

configuration

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x 

Connection

The connection types that can be provided to this configuration.

x 

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.

 

Connection Types

Basic
Parameters
Name Type Description Default Value Required

Host

String

The optional proxy port

 

Port

Number

The optional proxy port

 

Username

String

The optional proxy username

 

Password

String

The optional proxy password

 

Domain

String

The optional proxy domain

 

Workstation

String

The optional proxy workstation

 

Connection Timeout

Number

The amount of time to wait (in milliseconds) when initially establishing a connection before giving up and timing out. A value of 0 means infinity, and is not recommended.

50000

 

Socket Timeout

Number

The amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection is timed out. A value of 0 means infinity, and is not recommended.

50000

 

Max Connections

Number

Sets the maximum number of allowed open HTTP connections.

 

Access Key

String

x 

Secret Key

String

x 

Try Default AWSCredentials Provider Chain

Boolean

false

 

Region Endpoint

Enumeration, one of:

  • USEAST1

  • USWEST1

  • USWEST2

  • EUWEST1

  • EUCENTRAL1

  • APSOUTHEAST1

  • APSOUTHEAST2

  • APNORTHEAST1

  • SAEAST1

Set the topic region endpoint

 

Topic Arn (Only to test connectivity)

String

Arn of the topic to test. This is used only to test the connectivity and validate credentials with Amazon SNS.

 

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn't pass after exhausting the associated reconnection strategy

 
Role
Parameters
Name Type Description Default Value Required

Host

String

The optional proxy port

 

Port

Number

The optional proxy port

 

Username

String

The optional proxy username

 

Password

String

The optional proxy password

 

Domain

String

The optional proxy domain

 

Workstation

String

The optional proxy workstation

 

Connection Timeout

Number

The amount of time to wait (in milliseconds) when initially establishing a connection before giving up and timing out. A value of 0 means infinity, and is not recommended.

50000

 

Socket Timeout

Number

The amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection is timed out. A value of 0 means infinity, and is not recommended.

50000

 

Max Connections

Number

Sets the maximum number of allowed open HTTP connections.

 

Access Key

String

x 

Secret Key

String

x 

Try Default AWSCredentials Provider Chain

Boolean

false

 

Region Endpoint

Enumeration, one of:

  • USEAST1

  • USWEST1

  • USWEST2

  • EUWEST1

  • EUCENTRAL1

  • APSOUTHEAST1

  • APSOUTHEAST2

  • APNORTHEAST1

  • SAEAST1

Set the topic region endpoint

 

Topic Arn (Only to test connectivity)

String

Arn of the topic to test. This is used only to test the connectivity and validate credentials with Amazon SNS.

 

Role ARN

String

x 

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn't pass after exhausting the associated reconnection strategy

 

Associated Operations

Operations

Add Permission

<sns:add-permission>

Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.

API reference

Container for the parameters to the AddPermission operation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Permission Details

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • SNS:RETRY_EXHAUSTED  

  • SNS:CONNECTIVITY  

Confirm Subscription

<sns:confirm-subscription>

The ConfirmSubscription action verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag is set to "true".

API reference

Container for the parameters to the ConfirmSubscription operation. Indicates an internal connector error.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Confirm Subscription Details

#[payload]

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

String

For Configurations.

Throws

  • SNS:RETRY_EXHAUSTED  

  • SNS:CONNECTIVITY  

Create Platform Application

<sns:create-platform-application>

Creates a platform application object for one of the supported push notification services, such as APNS and GCM, to which devices and mobile apps may register.

API reference

Container for the parameters to the CreatePlatformApplication operation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Create Platform Application Details

#[payload]

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

String

For Configurations.

Throws

  • SNS:RETRY_EXHAUSTED  

  • SNS:CONNECTIVITY  

Create Platform Endpoint

<sns:create-platform-endpoint>

Creates an endpoint for a device and mobile app on one of the supported push notification services. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication.

API reference

Container for the parameters to the CreatePlatformEndpoint operation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Create Platform Endpoint Details

#[payload]

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

String

For Configurations.

Throws

  • SNS:RETRY_EXHAUSTED  

  • SNS:CONNECTIVITY  

Create Topic

<sns:create-topic>

The CreateTopic action creates a topic to which notifications can be published. Users can create at most 100 topics

API reference

The name of the topic you want to create.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Topic Name

String

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

String

For Configurations.

Throws

  • SNS:RETRY_EXHAUSTED  

  • SNS:CONNECTIVITY  

Delete Endpoint

<sns:delete-endpoint>

Deletes the endpoint for a device and mobile app from Amazon SNS.

API reference

EndpointArn of endpoint to delete.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Endpoint Arn

String

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • SNS:RETRY_EXHAUSTED  

  • SNS:CONNECTIVITY  

Delete Platform Application

<sns:delete-platform-application>

Deletes a platform application object for one of the supported push notification services, such as APNS and GCM.

API reference

PlatformApplicationArn of platform application object to delete.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Platform Application Arn

String

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • SNS:RETRY_EXHAUSTED  

  • SNS:CONNECTIVITY  

Delete Topic

<sns:delete-topic>

The DeleteTopic action deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.

API reference

The ARN of the topic you want to delete.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Topic Arn

String

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • SNS:RETRY_EXHAUSTED  

  • SNS:CONNECTIVITY  

Get Endpoint Attributes

<sns:get-endpoint-attributes>

Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS.

API reference

EndpointArn for GetEndpointAttributes input.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Endpoint Arn

String

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Object

For Configurations.

Throws

  • SNS:RETRY_EXHAUSTED  

  • SNS:CONNECTIVITY  

Get Platform Application Attributes

<sns:get-platform-application-attributes>

Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM.

API reference

PlatformApplicationArn for GetPlatformApplicationAttributesInput.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Platform Application Arn

String

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Object

For Configurations.

Throws

  • SNS:RETRY_EXHAUSTED  

  • SNS:CONNECTIVITY  

Get Subscription Attributes

<sns:get-subscription-attributes>

The GetSubscriptionAttributes action returns all of the properties of a subscription.

API reference

The ARN of the subscription whose properties you want to get

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Subscription Arn

String

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Object

For Configurations.

Throws

  • SNS:RETRY_EXHAUSTED  

  • SNS:CONNECTIVITY  

Get Topic Attributes

<sns:get-topic-attributes>

The GetTopicAttributes action returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.

API reference

The ARN of the topic whose properties you want to get.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Topic Arn

String

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Object

For Configurations.

Throws

  • SNS:RETRY_EXHAUSTED  

  • SNS:CONNECTIVITY  

List Endpoints By Platform Application

<sns:list-endpoints-by-platform-application>

Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS.

API reference

Container for the parameters to the ListEndpointsByPlatformApplication operation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Endpoints By Platform

#[payload]

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • SNS:RETRY_EXHAUSTED  

  • SNS:CONNECTIVITY  

List Platform Applications

<sns:list-platform-applications>

Lists the platform application objects for the supported push notification services, such as APNS and GCM.

API reference

NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Next Token

String

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • SNS:RETRY_EXHAUSTED  

  • SNS:CONNECTIVITY  

List Subscriptions

<sns:list-subscriptions>

The ListSubscriptions action returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptions call to get further results.

API reference

Token returned by the previous ListSubscriptions request Indicates an internal connector error.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Next Token

String

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • SNS:RETRY_EXHAUSTED  

  • SNS:CONNECTIVITY  

List Subscriptions By Topic

<sns:list-subscriptions-by-topic>

The SubscriptionsByTopic action returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new SubscriptionsByTopic call to get further results.

API reference

Container for the parameters to the ListSubscriptionsByTopic operation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Subscriptions By Topic

#[payload]

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • SNS:RETRY_EXHAUSTED  

  • SNS:CONNECTIVITY  

List Topics

<sns:list-topics>

The ListTopics action returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a NextToken is also returned. Use the NextToken parameter in a new ListTopics call to get further results.

API reference

Token returned by the previous ListTopics request.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Next Topic

String

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • SNS:RETRY_EXHAUSTED  

  • SNS:CONNECTIVITY  

Publish

<sns:publish>

The Publish action sends a message to all of a topic's subscribed endpoints. When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol selected.

API reference

Container for the parameters to the publish operation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Publish Details

#[payload]

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

String

For Configurations.

Throws

  • SNS:RETRY_EXHAUSTED  

  • SNS:CONNECTIVITY  

Remove Permission

<sns:remove-permission>

The RemovePermission action removes a statement from a topic's access control policy.

API reference

Container for the parameters to the RemovePermission operation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Remove Permission Details

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • SNS:RETRY_EXHAUSTED  

  • SNS:CONNECTIVITY  

Set Endpoint Attributes

<sns:set-endpoint-attributes>

Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS.

API reference

Container for the parameters to the SetEndpointAttributes operation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Endpoint Attributes

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • SNS:RETRY_EXHAUSTED  

  • SNS:CONNECTIVITY  

Set Platform Application Attributes

<sns:set-platform-application-attributes>

Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM.

API reference

Container for the parameters to the SetPlatformApplicationAttributes operation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Platform Application Attributes

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • SNS:RETRY_EXHAUSTED  

  • SNS:CONNECTIVITY  

Set Subscription Attributes

<sns:set-subscription-attributes>

The SubscriptionAttributes action allows a subscription owner to set an attribute of the topic to a new value.

API reference

Container for the parameters to the SetSubscriptionAttributes operation. Indicates an internal connector error.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Subscription Attributes

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • SNS:RETRY_EXHAUSTED  

  • SNS:CONNECTIVITY  

Set Topic Attributes

<sns:set-topic-attributes>

The TopicAttributes action allows a topic owner to set an attribute of the topic to a new value.

API reference

Container for the parameters to the SetTopicAttributes operation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Topic Attributes

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • SNS:RETRY_EXHAUSTED  

  • SNS:CONNECTIVITY  

Subscribe

<sns:subscribe>

The Subscribe action prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the ConfirmSubscription action with the token from the confirmation message. Confirmation tokens are valid for three days.

API reference

Container for the parameters to the Subscribe operation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Subscription Details

#[payload]

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

String

For Configurations.

Throws

  • SNS:RETRY_EXHAUSTED  

  • SNS:CONNECTIVITY  

Unsubscribe

<sns:unsubscribe>

The Unsubscribe action deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the its topic's owner can unsubscribe, and an AWS signature is required. If the Unsubscribe call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the Unsubscribe request was unintended.

API reference

The ARN of the subscription to be deleted.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Subscription Arn

String

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • SNS:RETRY_EXHAUSTED  

  • SNS:CONNECTIVITY  

Types

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Reconnection Strategy

The reconnection strategy to use

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often (in ms) to reconnect

Count

Number

How many reconnection attempts to make

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often (in ms) to reconnect

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

Add Permission

Field Type Description Default Value Required

A WS Account Ids

Array of String

Action Names

Array of String

Label

String

Topic Arn

String

Confirm Subscription

Field Type Description Default Value Required

Authenticate On Unsubscribe

String

Token

String

Topic Arn

String

Create Platform Application

Field Type Description Default Value Required

Attributes

Object

Name

String

Platform

String

Create Platform Endpoint

Field Type Description Default Value Required

Attributes

Object

Custom User Data

String

Platform Application Arn

String

Token

String

List Endpoints By Platform

Field Type Description Default Value Required

Endpoints

Array of Endpoint

Next Token

String

Endpoint

Field Type Description Default Value Required

Attributes

Object

Endpoint Arn

String

Endpoints By Platform

Field Type Description Default Value Required

Next Token

String

Platform Application Arn

String

List Platform Applications

Field Type Description Default Value Required

Next Token

String

Platform Applications

Platform Application

Field Type Description Default Value Required

Attributes

Object

Platform Application Arn

String

List Subscriptions

Field Type Description Default Value Required

Next Token

String

Subscriptions

Array of Subscription

Subscription

Field Type Description Default Value Required

Endpoint

String

Owner

String

Protocol

String

Subscription Arn

String

Topic Arn

String

List Subscriptions By Topic

Field Type Description Default Value Required

Next Token

String

Subscriptions

Array of Subscription

Subscriptions By Topic

Field Type Description Default Value Required

Next Token

String

Topic Arn

String

List Topics

Field Type Description Default Value Required

Next Token

String

Topics

Array of Topic

Topic

Field Type Description Default Value Required

Topic Arn

String

Publish

Field Type Description Default Value Required

Message

String

Message Attributes

Object

Message Structure

String

Subject

String

Target Arn

String

Topic Arn

String

Remove Permission

Field Type Description Default Value Required

Label

String

Topic Arn

String

Subscription Attributes

Field Type Description Default Value Required

Attribute Name

String

Attribute Value

String

Subscription Arn

String

Topic Attributes

Field Type Description Default Value Required

Attribute Name

String

Attribute Value

String

Topic Arn

String

Subscribe

Field Type Description Default Value Required

Endpoint

String

Protocol

String

Topic Arn

String