String
Amazon SNS 4.7 Connector Reference
Release Notes: Amazon SNS Connector Release Notes
Configurations
Default Configuration
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Name |
The name for this configuration. Connectors reference the configuration with this name. |
x |
||
Connection |
The connection types to provide to this configuration. |
x |
||
Globally Defined Default Topic ARN. |
String |
|||
Expiration Policy |
Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances as appropriate. |
Connection Types
Basic
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Session Token |
String |
The session token provided by AWS Security Token Service (STS). |
||
Test Topic |
String |
The topic used to test the connection. |
||
Connection Timeout |
Number |
The amount of time to wait (in milliseconds) when initially establishing a connection before the connector gives up and times out. A value of 0 means infinity and is not recommended. |
50000 |
|
Max Connections |
Number |
Sets the maximum number of allowed open HTTP connections. |
||
Socket Timeout |
Number |
The amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection times out. A value of 0 means infinity and is not recommended. |
50000 |
|
Access Key |
String |
The access key provided by Amazon. |
x |
|
Secret Key |
String |
The secret key provided by Amazon. |
x |
|
Try Default AWSCredentials Provider Chain |
Boolean |
Set this field to |
false |
|
Region Endpoint |
String |
Set the topic region endpoint. |
US_EAST_1 |
|
Custom Service Endpoint |
String |
Set a custom service endpoint. Useful when a non-standard service endpoint is required, such as a VPC endpoint. For local connections, set this field to |
||
TLS Configuration |
||||
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to |
|||
Host |
String |
The optional proxy host. |
||
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. |
Role
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Role ARN |
String |
The Role ARN uniquely identifies role to assume to gain cross account access. |
x |
|
Custom STS Endpoint |
String |
Set a custom STS endpoint. Useful when a non-standard service endpoint is required, such as a VPC endpoint. |
||
Test Topic ARN |
String |
The topic used to test the connection. |
||
Connection Timeout |
Number |
The amount of time to wait (in milliseconds) when initially establishing a connection before the connector gives up and times out. A value of 0 means infinity and is not recommended. |
50000 |
|
Max Connections |
Number |
Sets the maximum number of allowed open HTTP connections. |
||
Socket Timeout |
Number |
The amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection times out. A value of 0 means infinity and is not recommended. |
50000 |
|
Access Key |
String |
The access key provided by Amazon. |
x |
|
Secret Key |
String |
The secret key provided by Amazon. |
x |
|
Try Default AWSCredentials Provider Chain |
Boolean |
Set this field to |
false |
|
Region Endpoint |
String |
Set the topic region endpoint. |
US_EAST_1 |
|
Custom Service Endpoint |
String |
Set a custom service endpoint. Useful when a non-standard service endpoint is required, such as a VPC endpoint. For local connections, set this field to |
||
TLS Configuration |
||||
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to |
|||
Host |
String |
The optional proxy host. |
||
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. |
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. See the Amazon SNS API Reference.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Topic Arn |
String |
The ARN of the topic whose access control policy you wish to modify. |
x |
|
Label |
String |
A unique identifier for the new policy statement. |
x |
|
Account Ids |
Array of String |
The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service. |
x |
|
Action Names |
Array of String |
The action you want to allow for the specified principals. |
x |
|
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
For Configurations
Throws
-
SNS:INVALID_PARAMETER_VALUE
-
SNS:INVALID_PARAMETER
-
SNS:INTERNAL_ERROR
-
SNS:CONNECTIVITY
-
SNS:THROTTLED
-
SNS:TOPIC_LIMIT_EXCEEDED
-
SNS:AUTHORIZATION_ERROR
-
SNS:UNDEFINED_TOPIC
-
SNS:NOT_FOUND
-
SNS:SUBSCRIPTION_LIMIT_EXCEEDED
-
SNS:ENDPOINT_DISABLED
-
SNS:UNKNOWN
-
SNS:RETRY_EXHAUSTED
-
SNS:PLATFORM_APPLICATION_DISABLED
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
. See the Amazon SNS API Reference.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Topic Arn |
String |
The ARN of the topic for which you wish to confirm a subscription. |
x |
|
Token |
String |
Short-lived token sent to an endpoint during the |
x |
|
Authenticate On Unsubscribe |
String |
Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
For Configurations
Throws
-
SNS:INVALID_PARAMETER_VALUE
-
SNS:INVALID_PARAMETER
-
SNS:INTERNAL_ERROR
-
SNS:CONNECTIVITY
-
SNS:THROTTLED
-
SNS:TOPIC_LIMIT_EXCEEDED
-
SNS:AUTHORIZATION_ERROR
-
SNS:UNDEFINED_TOPIC
-
SNS:NOT_FOUND
-
SNS:SUBSCRIPTION_LIMIT_EXCEEDED
-
SNS:ENDPOINT_DISABLED
-
SNS:UNKNOWN
-
SNS:RETRY_EXHAUSTED
-
SNS:PLATFORM_APPLICATION_DISABLED
Create Platform Application
<sns:create-platform-application>
Creates a platform application object for one of the supported push notification services, such as APNs (Apple Push Notification service) and GCM (Google Cloud Messaging), to which devices and mobile apps may register. See the Amazon SNS API Reference.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Name |
String |
Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long. |
x |
|
Platform |
String |
The following platforms are supported: ADM (Amazon Device Messaging), APNs (Apple Push Notification service), APNS_SANDBOX, and GCM (Google Cloud Messaging). |
x |
|
Attributes |
Object |
The list of attributes. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
For Configurations
Throws
-
SNS:INVALID_PARAMETER_VALUE
-
SNS:INVALID_PARAMETER
-
SNS:INTERNAL_ERROR
-
SNS:CONNECTIVITY
-
SNS:THROTTLED
-
SNS:TOPIC_LIMIT_EXCEEDED
-
SNS:AUTHORIZATION_ERROR
-
SNS:UNDEFINED_TOPIC
-
SNS:NOT_FOUND
-
SNS:SUBSCRIPTION_LIMIT_EXCEEDED
-
SNS:ENDPOINT_DISABLED
-
SNS:UNKNOWN
-
SNS:RETRY_EXHAUSTED
-
SNS:PLATFORM_APPLICATION_DISABLED
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. See the Amazon SNS API Reference.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Platform Application Arn |
String |
PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint. |
x |
|
Token |
String |
Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNs (Apple Push Notification service) as the notification service, you need the device token. Alternatively, when using GCM (Google Cloud Messaging) or ADM (Amazon Device Messaging), the device token equivalent is called the registration ID. |
x |
|
Custom User Data |
String |
Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB. |
x |
|
Attributes |
Object |
The list of attributes. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
For Configurations
Throws
-
SNS:INVALID_PARAMETER_VALUE
-
SNS:INVALID_PARAMETER
-
SNS:INTERNAL_ERROR
-
SNS:CONNECTIVITY
-
SNS:THROTTLED
-
SNS:TOPIC_LIMIT_EXCEEDED
-
SNS:AUTHORIZATION_ERROR
-
SNS:UNDEFINED_TOPIC
-
SNS:NOT_FOUND
-
SNS:SUBSCRIPTION_LIMIT_EXCEEDED
-
SNS:ENDPOINT_DISABLED
-
SNS:UNKNOWN
-
SNS:RETRY_EXHAUSTED
-
SNS:PLATFORM_APPLICATION_DISABLED
Create Topic
<sns:create-topic>
The CreateTopic action creates a topic to which notifications can be published. Users can create at most 100 topics. See the Amazon SNS API Reference.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Topic Name |
String |
The name of the topic. Maximum 256 characters. Can include alphanumeric characters, hyphens, and underscores. FIFO topic names must end with |
x |
|
Content Based Deduplication |
Boolean |
Enables content-based deduplication for FIFO topics. If you create a FIFO topic and set this parameter to |
true |
|
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
For Configurations
Throws
-
SNS:INVALID_PARAMETER_VALUE
-
SNS:INVALID_PARAMETER
-
SNS:INTERNAL_ERROR
-
SNS:CONNECTIVITY
-
SNS:THROTTLED
-
SNS:TOPIC_LIMIT_EXCEEDED
-
SNS:AUTHORIZATION_ERROR
-
SNS:UNDEFINED_TOPIC
-
SNS:NOT_FOUND
-
SNS:SUBSCRIPTION_LIMIT_EXCEEDED
-
SNS:ENDPOINT_DISABLED
-
SNS:UNKNOWN
-
SNS:RETRY_EXHAUSTED
-
SNS:PLATFORM_APPLICATION_DISABLED
Delete Endpoint
<sns:delete-endpoint>
Deletes the endpoint for a device and mobile app from Amazon SNS. See the Amazon SNS API Reference.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Endpoint Arn |
String |
EndpointArn of endpoint to delete. |
x |
|
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
For Configurations
Throws
-
SNS:INVALID_PARAMETER_VALUE
-
SNS:INVALID_PARAMETER
-
SNS:INTERNAL_ERROR
-
SNS:CONNECTIVITY
-
SNS:THROTTLED
-
SNS:TOPIC_LIMIT_EXCEEDED
-
SNS:AUTHORIZATION_ERROR
-
SNS:UNDEFINED_TOPIC
-
SNS:NOT_FOUND
-
SNS:SUBSCRIPTION_LIMIT_EXCEEDED
-
SNS:ENDPOINT_DISABLED
-
SNS:UNKNOWN
-
SNS:RETRY_EXHAUSTED
-
SNS:PLATFORM_APPLICATION_DISABLED
Delete Platform Application
<sns:delete-platform-application>
Deletes a platform application object for one of the supported push notification services, such as APNs (Apple Push Notification service) and GCM (Google Cloud Messaging). See the Amazon SNS API Reference.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Platform Application Arn |
String |
PlatformApplicationArn of platform application object to delete. |
x |
|
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
For Configurations
Throws
-
SNS:INVALID_PARAMETER_VALUE
-
SNS:INVALID_PARAMETER
-
SNS:INTERNAL_ERROR
-
SNS:CONNECTIVITY
-
SNS:THROTTLED
-
SNS:TOPIC_LIMIT_EXCEEDED
-
SNS:AUTHORIZATION_ERROR
-
SNS:UNDEFINED_TOPIC
-
SNS:NOT_FOUND
-
SNS:SUBSCRIPTION_LIMIT_EXCEEDED
-
SNS:ENDPOINT_DISABLED
-
SNS:UNKNOWN
-
SNS:RETRY_EXHAUSTED
-
SNS:PLATFORM_APPLICATION_DISABLED
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. See the Amazon SNS API Reference.
For Configurations
Throws
-
SNS:INVALID_PARAMETER_VALUE
-
SNS:INVALID_PARAMETER
-
SNS:INTERNAL_ERROR
-
SNS:CONNECTIVITY
-
SNS:THROTTLED
-
SNS:TOPIC_LIMIT_EXCEEDED
-
SNS:AUTHORIZATION_ERROR
-
SNS:UNDEFINED_TOPIC
-
SNS:NOT_FOUND
-
SNS:SUBSCRIPTION_LIMIT_EXCEEDED
-
SNS:ENDPOINT_DISABLED
-
SNS:UNKNOWN
-
SNS:RETRY_EXHAUSTED
-
SNS:PLATFORM_APPLICATION_DISABLED
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 (Google Cloud Messaging) and APNs (Apple Push Notification service). See the Amazon SNS API Reference.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Endpoint Arn |
String |
EndpointArn for GetEndpointAttributes input. |
x |
|
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
For Configurations
Throws
-
SNS:INVALID_PARAMETER_VALUE
-
SNS:INVALID_PARAMETER
-
SNS:INTERNAL_ERROR
-
SNS:CONNECTIVITY
-
SNS:THROTTLED
-
SNS:TOPIC_LIMIT_EXCEEDED
-
SNS:AUTHORIZATION_ERROR
-
SNS:UNDEFINED_TOPIC
-
SNS:NOT_FOUND
-
SNS:SUBSCRIPTION_LIMIT_EXCEEDED
-
SNS:ENDPOINT_DISABLED
-
SNS:UNKNOWN
-
SNS:RETRY_EXHAUSTED
-
SNS:PLATFORM_APPLICATION_DISABLED
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 (Apple Push Notification service)and GCM (Google Cloud Messaging). See the Amazon SNS API Reference.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Platform Application Arn |
String |
PlatformApplicationArn for GetPlatformApplicationAttributesInput. |
x |
|
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
For Configurations
Throws
-
SNS:INVALID_PARAMETER_VALUE
-
SNS:INVALID_PARAMETER
-
SNS:INTERNAL_ERROR
-
SNS:CONNECTIVITY
-
SNS:THROTTLED
-
SNS:TOPIC_LIMIT_EXCEEDED
-
SNS:AUTHORIZATION_ERROR
-
SNS:UNDEFINED_TOPIC
-
SNS:NOT_FOUND
-
SNS:SUBSCRIPTION_LIMIT_EXCEEDED
-
SNS:ENDPOINT_DISABLED
-
SNS:UNKNOWN
-
SNS:RETRY_EXHAUSTED
-
SNS:PLATFORM_APPLICATION_DISABLED
Get Subscription Attributes
<sns:get-subscription-attributes>
The GetSubscriptionAttributes action returns all of the properties of a subscription. See the Amazon SNS API Reference.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Subscription Arn |
String |
The ARN of the subscription whose properties you want to get |
x |
|
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
For Configurations
Throws
-
SNS:INVALID_PARAMETER_VALUE
-
SNS:INVALID_PARAMETER
-
SNS:INTERNAL_ERROR
-
SNS:CONNECTIVITY
-
SNS:THROTTLED
-
SNS:TOPIC_LIMIT_EXCEEDED
-
SNS:AUTHORIZATION_ERROR
-
SNS:UNDEFINED_TOPIC
-
SNS:NOT_FOUND
-
SNS:SUBSCRIPTION_LIMIT_EXCEEDED
-
SNS:ENDPOINT_DISABLED
-
SNS:UNKNOWN
-
SNS:RETRY_EXHAUSTED
-
SNS:PLATFORM_APPLICATION_DISABLED
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. See the Amazon SNS API Reference.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Topic Arn |
String |
The ARN of the topic whose properties you want to get. |
x |
|
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
For Configurations
Throws
-
SNS:INVALID_PARAMETER_VALUE
-
SNS:INVALID_PARAMETER
-
SNS:INTERNAL_ERROR
-
SNS:CONNECTIVITY
-
SNS:THROTTLED
-
SNS:TOPIC_LIMIT_EXCEEDED
-
SNS:AUTHORIZATION_ERROR
-
SNS:UNDEFINED_TOPIC
-
SNS:NOT_FOUND
-
SNS:SUBSCRIPTION_LIMIT_EXCEEDED
-
SNS:ENDPOINT_DISABLED
-
SNS:UNKNOWN
-
SNS:RETRY_EXHAUSTED
-
SNS:PLATFORM_APPLICATION_DISABLED
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 (Google Cloud Messaging) and APNs (Apple Push Notification service). See the Amazon SNS API Reference.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Arn |
String |
The ARN of the platform application. |
x |
|
Streaming Strategy |
|
Configure to use repeatable streams. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Output
Type |
Array of Message of [Endpoint] payload and [Request ID Attribute] attributes |
List Platform Applications
<sns:list-platform-applications>
Lists the platform application objects for the supported push notification services, such as APNs (Apple Push Notification service)and GCM (Google Cloud Messaging). See the Amazon SNS API Reference.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Streaming Strategy |
|
Configure to use repeatable streams. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Output
Type |
Array of Message of [Platform Application] payload and [Request ID Attribute] attributes |
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. See the Amazon SNS API Reference.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Streaming Strategy |
|
Configure to use repeatable streams. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Output
Type |
Array of Message of [Subscription] payload and [Request ID Attribute] attributes |
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. See the Amazon SNS API Reference.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Arn |
String |
The ARN of the topic. |
x |
|
Streaming Strategy |
|
Configure to use repeatable streams. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Output
Type |
Array of Message of [Subscription] payload and [Request ID Attribute] attributes |
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. See the Amazon SNS API Reference.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Streaming Strategy |
|
Configure to use repeatable streams. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Output
Type |
Array of Message of [String] payload and [Request ID Attribute] attributes |
Publish
<sns:publish>
The Publish action sends a message to all of a topic’s subscribed endpoints. A returned messageId indicates that the message was 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. See the Amazon SNS API Reference.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
FIFO Parameters |
Parameters related to the FIFO topic. |
|||
Message |
String |
The message you want to send to the topic. |
|
|
Subject |
String |
Optional parameter to use as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints. |
||
Message Structure |
String |
Set MessageStructure to |
||
Message Attributes |
Object |
The Amazon SNS message attributes, as described in the Amazon Simple Notification Service Developer Guide. |
||
Topic Arn |
String |
Amazon Resource Name (ARN) of the topic you want to publish to. This field and the Target Arn field are mutually exclusive. |
||
Target Arn |
String |
Amazon Resource Name (ARN) of the platform endpoint you want to publish to. This field and the Topic Arn field are mutually exclusive. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
For Configurations
Throws
-
SNS:INVALID_PARAMETER_VALUE
-
SNS:INVALID_PARAMETER
-
SNS:INTERNAL_ERROR
-
SNS:CONNECTIVITY
-
SNS:THROTTLED
-
SNS:TOPIC_LIMIT_EXCEEDED
-
SNS:AUTHORIZATION_ERROR
-
SNS:UNDEFINED_TOPIC
-
SNS:NOT_FOUND
-
SNS:SUBSCRIPTION_LIMIT_EXCEEDED
-
SNS:ENDPOINT_DISABLED
-
SNS:UNKNOWN
-
SNS:RETRY_EXHAUSTED
-
SNS:PLATFORM_APPLICATION_DISABLED
Remove Permission
<sns:remove-permission>
The RemovePermission action removes a statement from a topic’s access control policy. See the Amazon SNS API Reference.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Topic Arn |
String |
The ARN of the topic whose access control policy you wish to modify. |
x |
|
Label |
String |
The unique label of the statement you want to remove. |
x |
|
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
For Configurations
Throws
-
SNS:INVALID_PARAMETER_VALUE
-
SNS:INVALID_PARAMETER
-
SNS:INTERNAL_ERROR
-
SNS:CONNECTIVITY
-
SNS:THROTTLED
-
SNS:TOPIC_LIMIT_EXCEEDED
-
SNS:AUTHORIZATION_ERROR
-
SNS:UNDEFINED_TOPIC
-
SNS:NOT_FOUND
-
SNS:SUBSCRIPTION_LIMIT_EXCEEDED
-
SNS:ENDPOINT_DISABLED
-
SNS:UNKNOWN
-
SNS:RETRY_EXHAUSTED
-
SNS:PLATFORM_APPLICATION_DISABLED
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 (Google Cloud Messaging) and APNs (Apple Push Notification service). See the Amazon SNS API Reference.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Endpoint |
Container for the parameters to the SetEndpointAttributes operation. |
|
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
For Configurations
Throws
-
SNS:INVALID_PARAMETER_VALUE
-
SNS:INVALID_PARAMETER
-
SNS:INTERNAL_ERROR
-
SNS:CONNECTIVITY
-
SNS:THROTTLED
-
SNS:TOPIC_LIMIT_EXCEEDED
-
SNS:AUTHORIZATION_ERROR
-
SNS:UNDEFINED_TOPIC
-
SNS:NOT_FOUND
-
SNS:SUBSCRIPTION_LIMIT_EXCEEDED
-
SNS:ENDPOINT_DISABLED
-
SNS:UNKNOWN
-
SNS:RETRY_EXHAUSTED
-
SNS:PLATFORM_APPLICATION_DISABLED
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 (Apple Push Notification service) and GCM (Google Cloud Messaging). See the Amazon SNS API Reference.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Platform Application Attributes |
Container for the parameters to the SetPlatformApplicationAttributes operation. |
|
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
For Configurations
Throws
-
SNS:INVALID_PARAMETER_VALUE
-
SNS:INVALID_PARAMETER
-
SNS:INTERNAL_ERROR
-
SNS:CONNECTIVITY
-
SNS:THROTTLED
-
SNS:TOPIC_LIMIT_EXCEEDED
-
SNS:AUTHORIZATION_ERROR
-
SNS:UNDEFINED_TOPIC
-
SNS:NOT_FOUND
-
SNS:SUBSCRIPTION_LIMIT_EXCEEDED
-
SNS:ENDPOINT_DISABLED
-
SNS:UNKNOWN
-
SNS:RETRY_EXHAUSTED
-
SNS:PLATFORM_APPLICATION_DISABLED
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. See the Amazon SNS API Reference.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Subscription Arn |
String |
The ARN of the subscription. |
x |
|
Attribute Name |
String |
The name of the attribute. |
x |
|
Attribute Value |
String |
The value of the attribute. |
x |
|
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
For Configurations
Throws
-
SNS:INVALID_PARAMETER_VALUE
-
SNS:INVALID_PARAMETER
-
SNS:INTERNAL_ERROR
-
SNS:CONNECTIVITY
-
SNS:THROTTLED
-
SNS:TOPIC_LIMIT_EXCEEDED
-
SNS:AUTHORIZATION_ERROR
-
SNS:UNDEFINED_TOPIC
-
SNS:NOT_FOUND
-
SNS:SUBSCRIPTION_LIMIT_EXCEEDED
-
SNS:ENDPOINT_DISABLED
-
SNS:UNKNOWN
-
SNS:RETRY_EXHAUSTED
-
SNS:PLATFORM_APPLICATION_DISABLED
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. See the Amazon SNS API Reference.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Topic Arn |
String |
The ARN of the topic. |
x |
|
Attribute Name |
String |
The name of the attribute. |
x |
|
Attribute Value |
String |
The value of the attribute. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
For Configurations
Throws
-
SNS:INVALID_PARAMETER_VALUE
-
SNS:INVALID_PARAMETER
-
SNS:INTERNAL_ERROR
-
SNS:CONNECTIVITY
-
SNS:THROTTLED
-
SNS:TOPIC_LIMIT_EXCEEDED
-
SNS:AUTHORIZATION_ERROR
-
SNS:UNDEFINED_TOPIC
-
SNS:NOT_FOUND
-
SNS:SUBSCRIPTION_LIMIT_EXCEEDED
-
SNS:ENDPOINT_DISABLED
-
SNS:UNKNOWN
-
SNS:RETRY_EXHAUSTED
-
SNS:PLATFORM_APPLICATION_DISABLED
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. See the Amazon SNS API Reference.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Topic Arn |
String |
The ARN of the topic you want to subscribe to. |
x |
|
Protocol |
Enumeration, one of:
|
The protocol you want to use. If it is a FIFO topic, then only Amazon SQS FIFO queues can be subscribers. |
x |
|
Endpoint |
String |
The endpoint that you want to receive notifications. Endpoints vary by protocol:
|
x |
|
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
For Configurations
Throws
-
SNS:INVALID_PARAMETER_VALUE
-
SNS:INVALID_PARAMETER
-
SNS:INTERNAL_ERROR
-
SNS:CONNECTIVITY
-
SNS:THROTTLED
-
SNS:TOPIC_LIMIT_EXCEEDED
-
SNS:AUTHORIZATION_ERROR
-
SNS:UNDEFINED_TOPIC
-
SNS:NOT_FOUND
-
SNS:SUBSCRIPTION_LIMIT_EXCEEDED
-
SNS:ENDPOINT_DISABLED
-
SNS:UNKNOWN
-
SNS:RETRY_EXHAUSTED
-
SNS:PLATFORM_APPLICATION_DISABLED
Unsubscribe
<sns:unsubscribe>
The Unsubscribe action deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic 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. See the Amazon SNS API Reference.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Subscription Arn |
String |
The ARN of the subscription to be deleted. |
x |
|
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
For Configurations
Throws
-
SNS:INVALID_PARAMETER_VALUE
-
SNS:INVALID_PARAMETER
-
SNS:INTERNAL_ERROR
-
SNS:CONNECTIVITY
-
SNS:THROTTLED
-
SNS:TOPIC_LIMIT_EXCEEDED
-
SNS:AUTHORIZATION_ERROR
-
SNS:UNDEFINED_TOPIC
-
SNS:NOT_FOUND
-
SNS:SUBSCRIPTION_LIMIT_EXCEEDED
-
SNS:ENDPOINT_DISABLED
-
SNS:UNKNOWN
-
SNS:RETRY_EXHAUSTED
-
SNS:PLATFORM_APPLICATION_DISABLED
Types
TLS
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Enabled Protocols |
String |
A comma-separated list of protocols enabled for this context. |
||
Enabled Cipher Suites |
String |
A comma-separated list of cipher suites enabled for this context. |
||
Trust Store |
For servers, a trust store contains certificates of the trusted clients. For clients, a trust store contains certificates of the trusted servers. |
|||
Key Store |
For servers, a key store contains the private and public key of the server. For clients, a key store contains the private and public key of the client. |
|||
Revocation Check |
Validates that a certificate was revoked. |
Trust Store
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
The location of the trust store. The path is resolved relative to the current classpath and file system, if possible. |
||
Password |
String |
The password used to protect the trust store. |
||
Type |
String |
The type of store used. |
||
Algorithm |
String |
The algorithm used by the trust store. |
||
Insecure |
Boolean |
If |
Key Store
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
The location of the key store. The path is resolved relative to the current classpath and file system, if possible. |
||
Type |
String |
The type of store used. |
||
Alias |
String |
When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file is used by default. |
||
Key Password |
String |
The password used to protect the private key. |
||
Password |
String |
The password used to protect the key store. |
||
Algorithm |
String |
The algorithm used by the key store. |
Standard Revocation Check
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Only End Entities |
Boolean |
Only verify the last element of the certificate chain. |
||
Prefer Crls |
Boolean |
Try CRL instead of OCSP first. |
||
No Fallback |
Boolean |
Do not use the secondary checking method (the one not selected before). |
||
Soft Fail |
Boolean |
Avoid verification failure when the revocation server can not be reached or is busy. |
Custom OCSP Responder
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Url |
String |
The URL of the OCSP responder. |
||
Cert Alias |
String |
Alias of the signing certificate for the OCSP response (must be in the trust store), if present. |
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 |
||
Reconnection Strategy |
The reconnection strategy to use. |
Reconnect
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency |
Number |
How often in milliseconds to reconnect. |
||
Count |
Number |
How many reconnection attempts to make.. |
||
blocking |
Boolean |
If false, the reconnection strategy runs in a separate, non-blocking thread. |
true |
Reconnect Forever
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency |
Number |
How often in milliseconds to reconnect. |
||
blocking |
Boolean |
If false, the reconnection strategy runs in a separate, non-blocking thread. |
unsubscribe |
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:
|
A time unit that qualifies the maxIdleTime attribute |
Repeatable In Memory Iterable
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Initial Buffer Size |
Number |
The amount of instances that is initially be allowed to be kept in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances. |
||
Buffer Size Increment |
Number |
This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances. |
||
Max Buffer Size |
Number |
The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit. |
Repeatable File Store Iterable
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Max In Memory Size |
Number |
The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which maxInMemorySize is expressed |
Platform Application
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Attributes |
Object |
|||
Platform Application Arn |
String |