# mulesoft Amazon SNS Connector - Full Documentation --- product: Amazon SNS Connector version: 4.7 --- # Amazon SNS 4.7 Additional Configuration Information > For the full documentation index, see: https://docs.mulesoft.com/llms.txt ## IAM User Permissions To use Amazon SNS Connector for an AWS Identity and Access Management (IAM) user, that user must: - Be a trusted entity for a specific role with rights to perform the Amazon Security Token Service `AssumeRole` action. - Have at least an `AmazonSNSReadOnlyAccess` policy to perform all SNS Connector read operations. - Have an `AmazonSNSFullAccess` policy to perform all SNS Connector operations. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Amazon SNS Connector version: 4.7 --- # Amazon SNS 4.7 Connector Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Common use cases for the connector include: - Sending SNS messages to Amazon SQS queues - Sending Amazon SNS messages to HTTP/HTTPS endpoints ## Send Amazon SNS Messages to Amazon SQS Queues Amazon SNS works closely with Amazon Simple Queue Service (Amazon SQS). By using Amazon SNS and Amazon SQS together, messages can be delivered to applications that: - Require immediate notification of an event. - Are persisted in an Amazon SQS queue for other applications to process later. When you subscribe an Amazon SQS queue to an Amazon SNS topic, you can publish a message to the topic. Amazon SNS then sends an Amazon SQS message to the subscribed queue. Use AWS Management Console to simplify the process of subscribing an Amazon SQS queue to an Amazon SNS topic. ## Send Amazon SNS Messages to HTTP/HTTPS Endpoints You can use Amazon SNS to send notification messages to one or more HTTP or HTTPS endpoints. When you subscribe an endpoint to am Amazon SNS topic, you can publish a notification to the topic. Amazon SNS then sends an HTTP POST request that delivers the contents of the notification to the subscribed endpoint. ## Example: Use the Connector to Send SNS Messages to Amazon SQS Queues The following diagram shows an example flow for this use case: ![Send messages to SQS](/mulesoft/current/en-us/amazon-sns-connector/4.7/_images/amazon-sns-use-case-flow.png) Before you try the example, access Anypoint Studio, and verify that the Mule Palette displays entries for **Amazon SNS** and **Amazon SQS**. If not, follow the instructions in [Install the Connector in Studio Using Exchange](https://docs.mulesoft.com/amazon-sns-connector/4.7/amazon-sns-connector-studio#install-connector) to install both connectors. To configure a Mule app that uses a connector to send Amazon SNS messages to Amazon SQS queues: 1. Create a new Mule project in Anypoint Studio. 2. In the Mule Palette, search for **HTTP**, and select the **Listener** operation: ![Select listener](/mulesoft/current/en-us/amazon-sns-connector/4.7/_images/amazon-sns-select-listener.png) 3. Drag the **Listener** operation to the canvas. 4. In the **Listener** configuration, click **+** next to the **Connector configuration** field to add a global element. 5. Accept the defaults. 6. In the **Listener** configuration **General** tab, set the **Display Name** field to `HTTP` and the **Path** field to\`/''. ![HTTP properties](/mulesoft/current/en-us/amazon-sns-connector/4.7/_images/amazon-sns-http-properties.png) 7. In the Mule Palette, search for **SNS** and select the **Publish** operation: ![Publish selection](/mulesoft/current/en-us/amazon-sns-connector/4.7/_images/amazon-sns-publish-selection.png) 8. Drag the **Publish** operation to the right of the **HTTP Listener** component. 9. In the **Publish** configuration, click **+** next to the **Connector configuration** field to add a global element. 10. Configure the global element as follows:
ParameterDescriptionValue

Name

Name used to reference the configuration

Amazon_SNS_Configuration or another name

Access Key

Alphanumeric text string that uniquely identifies the user who owns the account.

AWS Access Key

Secret Key

Key that plays the role of a password

AWS secret key

Region Endpoint

Queue region.

The queue region

The following image shows a sample global element for the Publish operation: ![SNS global configuration](/mulesoft/current/en-us/amazon-sns-connector/4.7/_images/amazon-sns-global-config.png) 11. Select the **Configuration XML** tab to view the corresponding XML: ```xml ``` 12. Select the **Global Elements** tab. 13. Select the **Amazon SNS configuration (Configuration)** and click **Edit**. 14. Click **Test Connection** to confirm that Mule can connect with the SNS instance. - If the connection is successful, click **OK** to save the configuration. - Otherwise, review or correct any incorrect parameters, and test again. 15. Go back to the flow and select **Publish**. 16. Configure parameters in General Tab:
ParameterValueDescription

Display Name

Publish

Name of the publish operation.

Basic Settings section

Connector configuration

Amazon_SNS_configuration

The reference name to the global element you created.

Target Platform section

Topic arn

arn:aws:sns:us-east-1:123456789012:TopicName

Amazon Resource Name (ARN) of the topic you want to publish to.

Target arn

Amazon Resource Name (ARN) of the platform endpoint you want to publish to.

Phone number

The phone number of the device you want to publish to.

Message Parameters

Message

`Hello World!`

Message Body

The following image shows a sample configuration for the Publish Message operation (General Tab): ![SNS publish message props](/mulesoft/current/en-us/amazon-sns-connector/4.7/_images/amazon-sns-publish-message-general.png) 17. Configure parameters in Advanced Tab:
ParameterValueDescription

Message Parameters

Subject

Testing publish to queue

Subject line when the message is delivered to email endpoints.

Message structure

JSON

Message structure that will be different for each protocol.

Message attributes

Amazon SNS message attributes, as described in the Amazon Simple Notification Service Developer Guide.

FIFO Parameters

Message Group ID

Token that specifies that a message belongs to a specific message group. Required when publishing to a FIFO topic.

Message Deduplication ID

Token used for the deduplication of messages when publishing to a FIFO topic. Allows you to overwrite the value generated by Amazon SNS. Required when content-based deduplication is disabled.

The following image shows a sample configuration for the Publish Message operation (Advanced Tab): ![SNS publish message props](/mulesoft/current/en-us/amazon-sns-connector/4.7/_images/amazon-sns-publish-message-advanced.png) 18. Select the **Configuration XML** tab to view the corresponding XML: ```xml ``` The `default` JSON key has a special meaning for SNS. The key’s value is sent as a message to every subscriber, regardless of the protocol used. You must specify this key for the Publish Message operation. You can optionally specify other top-level keys that define the message to send to a specific transport protocol, such as HTTP or SQS. For more information, see [Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html#API_Publish_RequestParameters) in the Amazon Simple Notification Service documentation. ### Display the Data Processed by the Publish Operation Using the same example, add a Logger component to display the data processed by the Publish operation on the Mule console. 1. In the Mule Palette, search for the **Logger** component and drag it to the right of the Amazon SNS Connector (**Publish**). 2. Configure the **Logger** component as follows:
ParameterValue

Display Name

Logger or another name

Message

Message: #[payload]

Level

INFO

![SNS logger](/mulesoft/current/en-us/amazon-sns-connector/4.7/_images/amazon-sns-logger.png) ### Receive SNS Messages Using the same example, add a second flow that enables Amazon SQS to receive messages published by Amazon SNS: 1. In the Mule Palette, search for **Flow** and drag the **Flow** component to the canvas. 2. In the Mule Palette, search for **SQS**, select the **Receive messages** operation, and drag it to the left of the **Flow** component. 3. Select the new component. 4. Click **+** next to the **Connector configuration** field to add a new Amazon SQS Connector global element. 5. Configure the global element as follows:
ParameterDescriptionValue

Name

A name by which to refer to the configuration

Amazon_SQS_Configuration or another name

Access Key

Alphanumeric text string that uniquely identifies the user who owns the account

AWS access key

Secret Key

Key that plays the role of a password.

AWS secret key

Region Endpoint

Queue region.

The queue region

Test Queue ARN

Queue ARN which will be used in the next step to test the connection

Test queue ARN in the following format - arn:aws:sqs:region:account-id:queue-name

The following image shows a sample global element for the Receive messages operation: ![SNS SQS config](/mulesoft/current/en-us/amazon-sns-connector/4.7/_images/amazon-sns-sqs-global-config.png) 6. Select the **Configuration XML** tab to view the corresponding XML: ```xml ``` 7. Click **Test Connection** to confirm that Mule can connect with the SQS instance: - If the connection is successful, click **OK** to save it. - If the connection is not successful, review or correct any incorrect parameters, and then test again. 8. In the properties editor of Amazon SQS Connector, configure the remaining parameters:
ParameterValue

Basic Settings section

Display Name

Amazon SQS (Streaming) or another name

Connector configuration*

Amazon_SQS_Configuration (the reference name to the global element you created)

Queue url

Queue URL in the following format - https://sqs.region.amazonaws.com/account-id/queue-name

Other fields in the General group

Default values

Verify that the SQS queue in the configuration is **subscribed** to the SNS topic. For example: ![SNS SQS config](/mulesoft/current/en-us/amazon-sns-connector/4.7/_images/amazon-sns-sqs-config.png) 9. Select the **Configuration XML** tab to view the corresponding XML: ```xml ``` 10. Add a **Logger** scope after Amazon SQS Connector to print the data passed by the **Receive** operation in the Mule console. Configure the **Logger** as follows:
ParameterValue

Display Name

Display Message or another name

Message

Received Message: #[payload]

Level

INFO

11. Save the project. To run the project as a Mule app: 1. Right-click the project in Package Explorer and select **Run As > Mule Application**. 2. Open a web browser, enter the URL `http://localhost:8081/`, and check the response. The logger shows the published message ID on the browser and the received message on the Mule console. ### Demo Mule Application XML Code Paste this code into your XML editor to quickly load the flow for this example use case into your Mule application. If needed, change the values to reflect your environment. ```xml ``` ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Amazon SNS Connector version: 4.7 --- # Amazon SNS 4.7 Connector Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Release Notes: [Amazon SNS Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/amazon-sns-connector-release-notes-mule-4) ## Configurations --- ### Default Configuration #### Parameters
NameTypeDescriptionDefault ValueRequired

Name

String

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
NameTypeDescriptionDefault ValueRequired

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 true to obtain credentials from the AWS environment. See Supplying and Receiving AWS Credentials.

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 http://localhost:8000/.

TLS Configuration

Reconnection

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

Host

String

Specifies the proxy host, including the protocol. Must be in the format http://<host> or https://<host> (for example, https://localhost).

Port

Number

Specifies the proxy port. This parameter is required if a proxy host is provided.

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
NameTypeDescriptionDefault ValueRequired

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. The custom STS endpoint might not work if DefaultAWSCredentialsProviderChain is used. Instead, use AWS environment variables such as AWS_STS_REGIONAL_ENDPOINTS, AWS_REGION, and AWS_ENDPOINT_URL.

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 true to obtain credentials from the AWS environment. See: Supplying and Receiving AWS Credentials.

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 http://localhost:8000/.

TLS Configuration

Reconnection

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

Host

String

Specifies the proxy host, including the protocol. Must be in the format http://<host> or https://<host> (for example, https://localhost).

Port

Number

Specifies the proxy port. This parameter is required if a proxy host is provided.

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](#addPermission) - [Confirm Subscription](#confirmSubscription) - [Create Platform Application](#createPlatformApplication) - [Create Platform Endpoint](#createPlatformEndpoint) - [Create Topic](#createTopic) - [Delete Endpoint](#deleteEndpoint) - [Delete Platform Application](#deletePlatformApplication) - [Delete Topic](#deleteTopic) - [Get Endpoint Attributes](#getEndpointAttributes) - [Get Platform Application Attributes](#getPlatformApplicationAttributes) - [Get Subscription Attributes](#getSubscriptionAttributes) - [Get Topic Attributes](#getTopicAttributes) - [List Endpoints By Platform Application](#listEndpointsByPlatformApplication) - [List Platform Applications](#listPlatformApplications) - [List Subscriptions](#listSubscriptions) - [List Subscriptions By Topic](#listSubscriptionsByTopic) - [List Topics](#listTopics) - [Publish](#publish) - [Remove Permission](#removePermission) - [Set Endpoint Attributes](#setEndpointAttributes) - [Set Platform Application Attributes](#setPlatformApplicationAttributes) - [Set Subscription Attributes](#setSubscriptionAttributes) - [Set Topic Attributes](#setTopicAttributes) - [Subscribe](#subscribe) - [Unsubscribe](#unsubscribe) ### 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](https://docs.aws.amazon.com/sns/latest/api/API_AddPermission.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Default Configuration](#config) #### 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 `` 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](https://docs.aws.amazon.com/sns/latest/api/API_ConfirmSubscription.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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 Subscribe action.

x

Authenticate On Unsubscribe

String

Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` 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](https://docs.aws.amazon.com/sns/latest/api/API_CreatePlatformApplication.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` 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](https://docs.aws.amazon.com/sns/latest/api/API_CreatePlatformEndpoint.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` 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](https://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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 .fifo.

x

Content Based Deduplication

Boolean

Enables content-based deduplication for FIFO topics. If you create a FIFO topic and set this parameter to false, you must specify a value for the Message Deduplication Id parameter for the Publish operation. When you set this parameter to true, Amazon SNS uses a SHA-256 hash to generate the message deduplication ID using the body of the message (but not the attributes of the message).

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` Deletes the endpoint for a device and mobile app from Amazon SNS. See the [Amazon SNS API Reference](https://docs.aws.amazon.com/sns/latest/api/API_DeleteEndpoint.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Default Configuration](#config) #### 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 `` 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](https://docs.aws.amazon.com/sns/latest/api/API_DeletePlatformApplication.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Default Configuration](#config) #### 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 `` 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](https://docs.aws.amazon.com/sns/latest/api/API_DeleteTopic.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Topic Arn

String

The ARN of the topic you want to delete.

x

Reconnection Strategy

A retry strategy in case of connectivity errors.

### For Configurations - [Default Configuration](#config) #### 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 `` 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](https://docs.aws.amazon.com/sns/latest/api/API_GetEndpointAttributes.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Object

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` 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](https://docs.aws.amazon.com/sns/latest/api/API_GetPlatformApplicationAttributes.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Object

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` The GetSubscriptionAttributes action returns all of the properties of a subscription. See the [Amazon SNS API Reference](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Object

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` 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](https://docs.aws.amazon.com/sns/latest/api/API_GetTopicAttributes.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Object

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` 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](https://docs.aws.amazon.com/sns/latest/api/API_ListEndpointsByPlatformApplication.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Message of [Endpoint] payload and [Request ID Attribute] attributes

### For Configurations - [Default Configuration](#config) #### Throws - SNS:INVALID\_PARAMETER\_VALUE - SNS:INVALID\_PARAMETER - SNS:UNDEFINED\_TOPIC - SNS:INTERNAL\_ERROR - SNS:NOT\_FOUND - SNS:THROTTLED - SNS:SUBSCRIPTION\_LIMIT\_EXCEEDED - SNS:TOPIC\_LIMIT\_EXCEEDED - SNS:ENDPOINT\_DISABLED - SNS:UNKNOWN - SNS:PLATFORM\_APPLICATION\_DISABLED - SNS:AUTHORIZATION\_ERROR ### 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](https://docs.aws.amazon.com/sns/latest/api/API_ListPlatformApplications.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Message of [Platform Application] payload and [Request ID Attribute] attributes

### For Configurations - [Default Configuration](#config) #### Throws - SNS:INVALID\_PARAMETER\_VALUE - SNS:INVALID\_PARAMETER - SNS:UNDEFINED\_TOPIC - SNS:INTERNAL\_ERROR - SNS:NOT\_FOUND - SNS:THROTTLED - SNS:SUBSCRIPTION\_LIMIT\_EXCEEDED - SNS:TOPIC\_LIMIT\_EXCEEDED - SNS:ENDPOINT\_DISABLED - SNS:UNKNOWN - SNS:PLATFORM\_APPLICATION\_DISABLED - SNS:AUTHORIZATION\_ERROR ### 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](https://docs.aws.amazon.com/sns/latest/api/API_ListSubscriptions.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Message of [Subscription] payload and [Request ID Attribute] attributes

### For Configurations - [Default Configuration](#config) #### Throws - SNS:INVALID\_PARAMETER\_VALUE - SNS:INVALID\_PARAMETER - SNS:UNDEFINED\_TOPIC - SNS:INTERNAL\_ERROR - SNS:NOT\_FOUND - SNS:THROTTLED - SNS:SUBSCRIPTION\_LIMIT\_EXCEEDED - SNS:TOPIC\_LIMIT\_EXCEEDED - SNS:ENDPOINT\_DISABLED - SNS:UNKNOWN - SNS:PLATFORM\_APPLICATION\_DISABLED - SNS:AUTHORIZATION\_ERROR ### 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](https://docs.aws.amazon.com/sns/latest/api/API_ListSubscriptionsByTopic.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Message of [Subscription] payload and [Request ID Attribute] attributes

### For Configurations - [Default Configuration](#config) #### Throws - SNS:INVALID\_PARAMETER\_VALUE - SNS:INVALID\_PARAMETER - SNS:UNDEFINED\_TOPIC - SNS:INTERNAL\_ERROR - SNS:NOT\_FOUND - SNS:THROTTLED - SNS:SUBSCRIPTION\_LIMIT\_EXCEEDED - SNS:TOPIC\_LIMIT\_EXCEEDED - SNS:ENDPOINT\_DISABLED - SNS:UNKNOWN - SNS:PLATFORM\_APPLICATION\_DISABLED - SNS:AUTHORIZATION\_ERROR ### 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](https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Message of [String] payload and [Request ID Attribute] attributes

### For Configurations - [Default Configuration](#config) #### Throws - SNS:INVALID\_PARAMETER\_VALUE - SNS:INVALID\_PARAMETER - SNS:UNDEFINED\_TOPIC - SNS:INTERNAL\_ERROR - SNS:NOT\_FOUND - SNS:THROTTLED - SNS:SUBSCRIPTION\_LIMIT\_EXCEEDED - SNS:TOPIC\_LIMIT\_EXCEEDED - SNS:ENDPOINT\_DISABLED - SNS:UNKNOWN - SNS:PLATFORM\_APPLICATION\_DISABLED - SNS:AUTHORIZATION\_ERROR ### 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](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

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 json if you want to send a different message for each protocol.

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` The RemovePermission action removes a statement from a topic’s access control policy. See the [Amazon SNS API Reference](https://docs.aws.amazon.com/sns/latest/api/API_RemovePermission.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Default Configuration](#config) #### 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 `` 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](https://docs.aws.amazon.com/sns/latest/api/API_SetEndpointAttributes.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Endpoint

Container for the parameters to the SetEndpointAttributes operation.

#[payload]

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Default Configuration](#config) #### 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 `` 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](https://docs.aws.amazon.com/sns/latest/api/API_SetPlatformApplicationAttributes.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Platform Application Attributes

Container for the parameters to the SetPlatformApplicationAttributes operation.

#[payload]

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Default Configuration](#config) #### 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 `` The SubscriptionAttributes action allows a subscription owner to set an attribute of the topic to a new value. See the [Amazon SNS API Reference](https://docs.aws.amazon.com/sns/latest/api/API_SetSubscriptionAttributes.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Default Configuration](#config) #### 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 `` The TopicAttributes action allows a topic owner to set an attribute of the topic to a new value. See the [Amazon SNS API Reference](https://docs.aws.amazon.com/sns/latest/api/API_SetTopicAttributes.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Default Configuration](#config) #### 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 `` 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](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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:

  • HTTP

  • HTTPS

  • EMAIL

  • EMAIL_JSON

  • SMS

  • SQS

  • APPLICATION

  • LAMBDA

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:

  • HTTP - The endpoint is an URL beginning with http://.

  • HTTPS - The endpoint is a URL beginning with https://.

  • EMAIL - The endpoint is an email address.

  • EMAIL_JSON - The endpoint is an email address.

  • SMS - The endpoint is a phone number of an SMS-enabled device.

  • SQS - The endpoint is the ARN of an Amazon SQS queue.

  • APPLICATION - The endpoint is the endpoint of a mobile app and device.

  • LAMBDA - The endpoint is the ARN of an AWS Lambda function.

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` 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](https://docs.aws.amazon.com/sns/latest/api/API_Unsubscribe.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Default Configuration](#config) #### 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
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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 true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

### Key Store
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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.

### CRL File
FieldTypeDescriptionDefault ValueRequired

Path

String

The path to the CRL file.

### Reconnection
FieldTypeDescriptionDefault ValueRequired

Fails Deployment

Boolean

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

Reconnection Strategy

The reconnection strategy to use.

### Reconnect
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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

### Request ID Attribute
FieldTypeDescriptionDefault ValueRequired

Request Id

String

### Endpoint
FieldTypeDescriptionDefault ValueRequired

Attributes

Object

Endpoint Arn

String

### Repeatable In Memory Iterable
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

### Platform Application
FieldTypeDescriptionDefault ValueRequired

Attributes

Object

Platform Application Arn

String

### Subscription
FieldTypeDescriptionDefault ValueRequired

Endpoint

String

Owner

String

Protocol

String

Subscription Arn

String

Topic Arn

String

### FIFO Parameters
FieldTypeDescriptionDefault ValueRequired

Message Group Id

String

Token that specifies where a message belongs.

x

Message Deduplication Id

String

Token for deduplicating messages. This ID is mandatory when deduplication is not set in the topic level.

## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Amazon SNS Connector version: 4.7 --- # Amazon SNS 4.7 Studio Configuration > For the full documentation index, see: https://docs.mulesoft.com/llms.txt To install and configure Anypoint Connector for Amazon SNS (Amazon SNS Connector) in Anypoint Studio: 1. Install the connector. 2. Configure an input source for the connector. 3. Configure the connector. ## Install the Connector in Studio Using Exchange 1. In Studio, create a Mule project. 2. Click the Exchange **(X)** icon in the Studio task bar. 3. In Exchange, click **Login** and supply your Anypoint Platform username and password. 4. In Exchange, search for **Amazon SNS Connector**. 5. Select **Amazon SNS Connector** and click **Add to project**. 6. Follow the prompts to install the connector. ## Install the Connector in Studio 1. In Studio, create a Mule Project. 2. In the Mule Palette, click **(X) Search in Exchange**. 3. In **Add Modules to Project**, type the name of the connector in the search field. 4. Click the connector name in **Available modules**. 5. Click **Add**. 6. Click **Finish**. ## Configure an Input Source Configure an input source for the connector, such as an **HTTP Listener** or **Scheduler**. ## Configure the Connector To use Amazon SNS Connector in your Mule app, configure a global Amazon SNS element that can be used by all Amazon SNS Connectors in the application. 1. Drag a connector operation into the Studio canvas. 2. Click the **Global Elements** tab at the base of the canvas, and then click **Create**. 3. In the **Choose Global Type** window, expand **Connector Configuration**, and click **Amazon SNS configuration**: ![Global Element Configuration Wizard](/mulesoft/current/en-us/amazon-sns-connector/4.7/_images/amazon-sns-config-global-wizard.png) 4. Click **OK**. 5. Specify the global element properties: ![Global Element Properties](/mulesoft/current/en-us/amazon-sns-connector/4.7/_images/amazon-sns-global-config.png) 6. Configure the parameters as follows:
ParameterDescription

Name

Name by which the configuration is referenced

Session Token

Session token provided by AWS Security Token Service (STS)

Test Topic

Topic used to test the connection

Access Key

Alphanumeric text string that uniquely identifies the user who owns the account

Secret Key

Key that plays the role of a password

Try Default AWS Credentials Provider Chain

Checkbox that controls whether temporary credentials should be used

Region Endpoint

Topic region endpoint

Globally Defined Default Topic Arn

Topic ARN to test the connectivity

7. Retain the default entries for the **Proxy**, **Security**, and **Advanced** tabs. 8. Click **Test Connection** to confirm that the parameters of your global configuration are accurate, and that Mule is able to successfully connect to your instance of Amazon SNS. 9. Click **OK**. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Amazon SNS Connector version: 4.7 --- # Amazon SNS 4.7 XML and Maven Support > For the full documentation index, see: https://docs.mulesoft.com/llms.txt If you manually code a Mule application in XML (either from the Studio XML editor or a text editor), you must perform the following actions to access the connector: 1. Add the namespace for the connector to your XML flow. 2. Add dependency information to your Apache Maven `pom.xml` file. In the Studio visual editor, when you drag a connector from the palette to the canvas, Studio automatically populates the XML code with the connector namespace and schema location. ## Add a Namespace for the Connector Paste the following code inside the `` tag of the header of your configuration XML: ```xml http://www.mulesoft.org/schema/mule/sns http://www.mulesoft.org/schema/mule/sns/current/mule-sns.xsd ``` This example shows how the namespace statements are placed in the `` XML block: ```xml ``` ## Add a POM File Dependency The Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app. When you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to this connector. ```xml com.mulesoft.connectors mule-amazon-sns-connector x.x.x mule-plugin ``` Replace `x.x.x` with the version that corresponds to the connector you are using. To obtain the most up-to-date `pom.xml` file information, access the connector in [Anypoint Exchange](https://www.mulesoft.com/exchange/) and click **Dependency Snippets**. ## Next Step After completing your namespace and `pom.xml` file, you can try out [Examples](https://docs.mulesoft.com/amazon-sns-connector/4.7/amazon-sns-connector-examples). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Amazon SNS Connector version: 4.8 is-latest-version: true --- # Amazon SNS 4.8 Additional Configuration Information > For the full documentation index, see: https://docs.mulesoft.com/llms.txt ## IAM User Permissions To use Amazon SNS Connector for an AWS Identity and Access Management (IAM) user, that user must: - Be a trusted entity for a specific role with rights to perform the Amazon Security Token Service `AssumeRole` action. - Have at least an `AmazonSNSReadOnlyAccess` policy to perform all SNS Connector read operations. - Have an `AmazonSNSFullAccess` policy to perform all SNS Connector operations. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Amazon SNS Connector version: 4.8 is-latest-version: true --- # Amazon SNS 4.8 Connector Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Common use cases for the connector include: - Sending SNS messages to Amazon SQS queues - Sending Amazon SNS messages to HTTP/HTTPS endpoints ## Send Amazon SNS Messages to Amazon SQS Queues Amazon SNS works closely with Amazon Simple Queue Service (Amazon SQS). By using Amazon SNS and Amazon SQS together, messages can be delivered to applications that: - Require immediate notification of an event. - Are persisted in an Amazon SQS queue for other applications to process later. When you subscribe an Amazon SQS queue to an Amazon SNS topic, you can publish a message to the topic. Amazon SNS then sends an Amazon SQS message to the subscribed queue. Use AWS Management Console to simplify the process of subscribing an Amazon SQS queue to an Amazon SNS topic. ## Send Amazon SNS Messages to HTTP/HTTPS Endpoints You can use Amazon SNS to send notification messages to one or more HTTP or HTTPS endpoints. When you subscribe an endpoint to am Amazon SNS topic, you can publish a notification to the topic. Amazon SNS then sends an HTTP POST request that delivers the contents of the notification to the subscribed endpoint. ## Example: Use the Connector to Send SNS Messages to Amazon SQS Queues The following diagram shows an example flow for this use case: ![Send messages to SQS](/mulesoft/current/en-us/amazon-sns-connector/latest/_images/amazon-sns-use-case-flow.png) Before you try the example, access Anypoint Studio, and verify that the Mule Palette displays entries for **Amazon SNS** and **Amazon SQS**. If not, follow the instructions in [Install the Connector in Studio Using Exchange](https://docs.mulesoft.com/amazon-sns-connector/latest/amazon-sns-connector-studio#install-connector) to install both connectors. To configure a Mule app that uses a connector to send Amazon SNS messages to Amazon SQS queues: 1. Create a new Mule project in Anypoint Studio. 2. In the Mule Palette, search for **HTTP**, and select the **Listener** operation: ![Select listener](/mulesoft/current/en-us/amazon-sns-connector/latest/_images/amazon-sns-select-listener.png) 3. Drag the **Listener** operation to the canvas. 4. In the **Listener** configuration, click **+** next to the **Connector configuration** field to add a global element. 5. Accept the defaults. 6. In the **Listener** configuration **General** tab, set the **Display Name** field to `HTTP` and the **Path** field to\`/''. ![HTTP properties](/mulesoft/current/en-us/amazon-sns-connector/latest/_images/amazon-sns-http-properties.png) 7. In the Mule Palette, search for **SNS** and select the **Publish** operation: ![Publish selection](/mulesoft/current/en-us/amazon-sns-connector/latest/_images/amazon-sns-publish-selection.png) 8. Drag the **Publish** operation to the right of the **HTTP Listener** component. 9. In the **Publish** configuration, click **+** next to the **Connector configuration** field to add a global element. 10. Configure the global element as follows:
ParameterDescriptionValue

Name

Name used to reference the configuration

Amazon_SNS_Configuration or another name

Access Key

Alphanumeric text string that uniquely identifies the user who owns the account.

AWS Access Key

Secret Key

Key that plays the role of a password

AWS secret key

Region Endpoint

Queue region.

The queue region

The following image shows a sample global element for the Publish operation: ![SNS global configuration](/mulesoft/current/en-us/amazon-sns-connector/latest/_images/amazon-sns-global-config.png) 11. Select the **Configuration XML** tab to view the corresponding XML: ```xml ``` 12. Select the **Global Elements** tab. 13. Select the **Amazon SNS configuration (Configuration)** and click **Edit**. 14. Click **Test Connection** to confirm that Mule can connect with the SNS instance. - If the connection is successful, click **OK** to save the configuration. - Otherwise, review or correct any incorrect parameters, and test again. 15. Go back to the flow and select **Publish**. 16. Configure parameters in General Tab:
ParameterValueDescription

Display Name

Publish

Name of the publish operation.

Basic Settings section

Connector configuration

Amazon_SNS_configuration

The reference name to the global element you created.

Target Platform section

Topic arn

arn:aws:sns:us-east-1:123456789012:TopicName

Amazon Resource Name (ARN) of the topic you want to publish to.

Target arn

Amazon Resource Name (ARN) of the platform endpoint you want to publish to.

Phone number

The phone number of the device you want to publish to.

Message Parameters

Message

`Hello World!`

Message Body

The following image shows a sample configuration for the Publish Message operation (General Tab): ![SNS publish message props](/mulesoft/current/en-us/amazon-sns-connector/latest/_images/amazon-sns-publish-message-general.png) 17. Configure parameters in Advanced Tab:
ParameterValueDescription

Message Parameters

Subject

Testing publish to queue

Subject line when the message is delivered to email endpoints.

Message structure

JSON

Message structure that will be different for each protocol.

Message attributes

Amazon SNS message attributes, as described in the Amazon Simple Notification Service Developer Guide.

FIFO Parameters

Message Group ID

Token that specifies that a message belongs to a specific message group. Required when publishing to a FIFO topic.

Message Deduplication ID

Token used for the deduplication of messages when publishing to a FIFO topic. Allows you to overwrite the value generated by Amazon SNS. Required when content-based deduplication is disabled.

The following image shows a sample configuration for the Publish Message operation (Advanced Tab): ![SNS publish message props](/mulesoft/current/en-us/amazon-sns-connector/latest/_images/amazon-sns-publish-message-advanced.png) 18. Select the **Configuration XML** tab to view the corresponding XML: ```xml ``` The `default` JSON key has a special meaning for SNS. The key’s value is sent as a message to every subscriber, regardless of the protocol used. You must specify this key for the Publish Message operation. You can optionally specify other top-level keys that define the message to send to a specific transport protocol, such as HTTP or SQS. For more information, see [Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html#API_Publish_RequestParameters) in the Amazon Simple Notification Service documentation. ### Display the Data Processed by the Publish Operation Using the same example, add a Logger component to display the data processed by the Publish operation on the Mule console. 1. In the Mule Palette, search for the **Logger** component and drag it to the right of the Amazon SNS Connector (**Publish**). 2. Configure the **Logger** component as follows:
ParameterValue

Display Name

Logger or another name

Message

Message: #[payload]

Level

INFO

![SNS logger](/mulesoft/current/en-us/amazon-sns-connector/latest/_images/amazon-sns-logger.png) ### Receive SNS Messages Using the same example, add a second flow that enables Amazon SQS to receive messages published by Amazon SNS: 1. In the Mule Palette, search for **Flow** and drag the **Flow** component to the canvas. 2. In the Mule Palette, search for **SQS**, select the **Receive messages** operation, and drag it to the left of the **Flow** component. 3. Select the new component. 4. Click **+** next to the **Connector configuration** field to add a new Amazon SQS Connector global element. 5. Configure the global element as follows:
ParameterDescriptionValue

Name

A name by which to refer to the configuration

Amazon_SQS_Configuration or another name

Access Key

Alphanumeric text string that uniquely identifies the user who owns the account

AWS access key

Secret Key

Key that plays the role of a password.

AWS secret key

Region Endpoint

Queue region.

The queue region

Test Queue ARN

Queue ARN which will be used in the next step to test the connection

Test queue ARN in the following format - arn:aws:sqs:region:account-id:queue-name

The following image shows a sample global element for the Receive messages operation: ![SNS SQS config](/mulesoft/current/en-us/amazon-sns-connector/latest/_images/amazon-sns-sqs-global-config.png) 6. Select the **Configuration XML** tab to view the corresponding XML: ```xml ``` 7. Click **Test Connection** to confirm that Mule can connect with the SQS instance: - If the connection is successful, click **OK** to save it. - If the connection is not successful, review or correct any incorrect parameters, and then test again. 8. In the properties editor of Amazon SQS Connector, configure the remaining parameters:
ParameterValue

Basic Settings section

Display Name

Amazon SQS (Streaming) or another name

Connector configuration*

Amazon_SQS_Configuration (the reference name to the global element you created)

Queue url

Queue URL in the following format - https://sqs.region.amazonaws.com/account-id/queue-name

Other fields in the General group

Default values

Verify that the SQS queue in the configuration is **subscribed** to the SNS topic. For example: ![SNS SQS config](/mulesoft/current/en-us/amazon-sns-connector/latest/_images/amazon-sns-sqs-config.png) 9. Select the **Configuration XML** tab to view the corresponding XML: ```xml ``` 10. Add a **Logger** scope after Amazon SQS Connector to print the data passed by the **Receive** operation in the Mule console. Configure the **Logger** as follows:
ParameterValue

Display Name

Display Message or another name

Message

Received Message: #[payload]

Level

INFO

11. Save the project. To run the project as a Mule app: 1. Right-click the project in Package Explorer and select **Run As > Mule Application**. 2. Open a web browser, enter the URL `http://localhost:8081/`, and check the response. The logger shows the published message ID on the browser and the received message on the Mule console. ### Demo Mule Application XML Code Paste this code into your XML editor to quickly load the flow for this example use case into your Mule application. If needed, change the values to reflect your environment. ```xml ``` ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Amazon SNS Connector version: 4.8 is-latest-version: true --- # Amazon SNS 4.8 Connector Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Release Notes: [Amazon SNS Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/amazon-sns-connector-release-notes-mule-4) ## Configurations --- ### Default Configuration #### Parameters
NameTypeDescriptionDefault ValueRequired

Name

String

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
NameTypeDescriptionDefault ValueRequired

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 true to obtain credentials from the AWS environment. See Supplying and Receiving AWS Credentials.

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 http://localhost:8000/.

TLS Configuration

Reconnection

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

Host

String

Specifies the proxy host, including the protocol. Must be in the format http://<host> or https://<host> (for example, https://localhost).

Port

Number

Specifies the proxy port. This parameter is required if a proxy host is provided.

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
NameTypeDescriptionDefault ValueRequired

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. The custom STS endpoint might not work if DefaultAWSCredentialsProviderChain is used. Instead, use AWS environment variables such as AWS_STS_REGIONAL_ENDPOINTS, AWS_REGION, and AWS_ENDPOINT_URL.

External ID

String

A unique identifier that might be required when you assume a role in another account. If the administrator of the account to which the role belongs provides an external ID, then provide that value in this field.

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 true to obtain credentials from the AWS environment. See: Supplying and Receiving AWS Credentials.

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 http://localhost:8000/.

TLS Configuration

Reconnection

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

Host

String

Specifies the proxy host, including the protocol. Must be in the format http://<host> or https://<host> (for example, https://localhost).

Port

Number

Specifies the proxy port. This parameter is required if a proxy host is provided.

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](#addPermission) - [Confirm Subscription](#confirmSubscription) - [Create Platform Application](#createPlatformApplication) - [Create Platform Endpoint](#createPlatformEndpoint) - [Create Topic](#createTopic) - [Delete Endpoint](#deleteEndpoint) - [Delete Platform Application](#deletePlatformApplication) - [Delete Topic](#deleteTopic) - [Get Endpoint Attributes](#getEndpointAttributes) - [Get Platform Application Attributes](#getPlatformApplicationAttributes) - [Get Subscription Attributes](#getSubscriptionAttributes) - [Get Topic Attributes](#getTopicAttributes) - [List Endpoints By Platform Application](#listEndpointsByPlatformApplication) - [List Platform Applications](#listPlatformApplications) - [List Subscriptions](#listSubscriptions) - [List Subscriptions By Topic](#listSubscriptionsByTopic) - [List Topics](#listTopics) - [Publish](#publish) - [Remove Permission](#removePermission) - [Set Endpoint Attributes](#setEndpointAttributes) - [Set Platform Application Attributes](#setPlatformApplicationAttributes) - [Set Subscription Attributes](#setSubscriptionAttributes) - [Set Topic Attributes](#setTopicAttributes) - [Subscribe](#subscribe) - [Unsubscribe](#unsubscribe) ### 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](https://docs.aws.amazon.com/sns/latest/api/API_AddPermission.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Default Configuration](#config) #### 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 `` 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](https://docs.aws.amazon.com/sns/latest/api/API_ConfirmSubscription.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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 Subscribe action.

x

Authenticate On Unsubscribe

String

Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` 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](https://docs.aws.amazon.com/sns/latest/api/API_CreatePlatformApplication.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` 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](https://docs.aws.amazon.com/sns/latest/api/API_CreatePlatformEndpoint.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` 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](https://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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 .fifo.

x

Content Based Deduplication

Boolean

Enables content-based deduplication for FIFO topics. If you create a FIFO topic and set this parameter to false, you must specify a value for the Message Deduplication Id parameter for the Publish operation. When you set this parameter to true, Amazon SNS uses a SHA-256 hash to generate the message deduplication ID using the body of the message (but not the attributes of the message).

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` Deletes the endpoint for a device and mobile app from Amazon SNS. See the [Amazon SNS API Reference](https://docs.aws.amazon.com/sns/latest/api/API_DeleteEndpoint.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Default Configuration](#config) #### 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 `` 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](https://docs.aws.amazon.com/sns/latest/api/API_DeletePlatformApplication.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Default Configuration](#config) #### 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 `` 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](https://docs.aws.amazon.com/sns/latest/api/API_DeleteTopic.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Topic Arn

String

The ARN of the topic you want to delete.

x

Reconnection Strategy

A retry strategy in case of connectivity errors.

### For Configurations - [Default Configuration](#config) #### 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 `` 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](https://docs.aws.amazon.com/sns/latest/api/API_GetEndpointAttributes.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Object

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` 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](https://docs.aws.amazon.com/sns/latest/api/API_GetPlatformApplicationAttributes.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Object

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` The GetSubscriptionAttributes action returns all of the properties of a subscription. See the [Amazon SNS API Reference](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Object

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` 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](https://docs.aws.amazon.com/sns/latest/api/API_GetTopicAttributes.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Object

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` 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](https://docs.aws.amazon.com/sns/latest/api/API_ListEndpointsByPlatformApplication.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Message of [Endpoint] payload and [Request ID Attribute] attributes

### For Configurations - [Default Configuration](#config) #### Throws - SNS:INVALID\_PARAMETER\_VALUE - SNS:INVALID\_PARAMETER - SNS:UNDEFINED\_TOPIC - SNS:INTERNAL\_ERROR - SNS:NOT\_FOUND - SNS:THROTTLED - SNS:SUBSCRIPTION\_LIMIT\_EXCEEDED - SNS:TOPIC\_LIMIT\_EXCEEDED - SNS:ENDPOINT\_DISABLED - SNS:UNKNOWN - SNS:PLATFORM\_APPLICATION\_DISABLED - SNS:AUTHORIZATION\_ERROR ### 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](https://docs.aws.amazon.com/sns/latest/api/API_ListPlatformApplications.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Message of [Platform Application] payload and [Request ID Attribute] attributes

### For Configurations - [Default Configuration](#config) #### Throws - SNS:INVALID\_PARAMETER\_VALUE - SNS:INVALID\_PARAMETER - SNS:UNDEFINED\_TOPIC - SNS:INTERNAL\_ERROR - SNS:NOT\_FOUND - SNS:THROTTLED - SNS:SUBSCRIPTION\_LIMIT\_EXCEEDED - SNS:TOPIC\_LIMIT\_EXCEEDED - SNS:ENDPOINT\_DISABLED - SNS:UNKNOWN - SNS:PLATFORM\_APPLICATION\_DISABLED - SNS:AUTHORIZATION\_ERROR ### 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](https://docs.aws.amazon.com/sns/latest/api/API_ListSubscriptions.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Message of [Subscription] payload and [Request ID Attribute] attributes

### For Configurations - [Default Configuration](#config) #### Throws - SNS:INVALID\_PARAMETER\_VALUE - SNS:INVALID\_PARAMETER - SNS:UNDEFINED\_TOPIC - SNS:INTERNAL\_ERROR - SNS:NOT\_FOUND - SNS:THROTTLED - SNS:SUBSCRIPTION\_LIMIT\_EXCEEDED - SNS:TOPIC\_LIMIT\_EXCEEDED - SNS:ENDPOINT\_DISABLED - SNS:UNKNOWN - SNS:PLATFORM\_APPLICATION\_DISABLED - SNS:AUTHORIZATION\_ERROR ### 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](https://docs.aws.amazon.com/sns/latest/api/API_ListSubscriptionsByTopic.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Message of [Subscription] payload and [Request ID Attribute] attributes

### For Configurations - [Default Configuration](#config) #### Throws - SNS:INVALID\_PARAMETER\_VALUE - SNS:INVALID\_PARAMETER - SNS:UNDEFINED\_TOPIC - SNS:INTERNAL\_ERROR - SNS:NOT\_FOUND - SNS:THROTTLED - SNS:SUBSCRIPTION\_LIMIT\_EXCEEDED - SNS:TOPIC\_LIMIT\_EXCEEDED - SNS:ENDPOINT\_DISABLED - SNS:UNKNOWN - SNS:PLATFORM\_APPLICATION\_DISABLED - SNS:AUTHORIZATION\_ERROR ### 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](https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Message of [String] payload and [Request ID Attribute] attributes

### For Configurations - [Default Configuration](#config) #### Throws - SNS:INVALID\_PARAMETER\_VALUE - SNS:INVALID\_PARAMETER - SNS:UNDEFINED\_TOPIC - SNS:INTERNAL\_ERROR - SNS:NOT\_FOUND - SNS:THROTTLED - SNS:SUBSCRIPTION\_LIMIT\_EXCEEDED - SNS:TOPIC\_LIMIT\_EXCEEDED - SNS:ENDPOINT\_DISABLED - SNS:UNKNOWN - SNS:PLATFORM\_APPLICATION\_DISABLED - SNS:AUTHORIZATION\_ERROR ### 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](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

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 json if you want to send a different message for each protocol.

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` The RemovePermission action removes a statement from a topic’s access control policy. See the [Amazon SNS API Reference](https://docs.aws.amazon.com/sns/latest/api/API_RemovePermission.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Default Configuration](#config) #### 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 `` 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](https://docs.aws.amazon.com/sns/latest/api/API_SetEndpointAttributes.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Endpoint

Container for the parameters to the SetEndpointAttributes operation.

#[payload]

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Default Configuration](#config) #### 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 `` 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](https://docs.aws.amazon.com/sns/latest/api/API_SetPlatformApplicationAttributes.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Platform Application Attributes

Container for the parameters to the SetPlatformApplicationAttributes operation.

#[payload]

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Default Configuration](#config) #### 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 `` The SubscriptionAttributes action allows a subscription owner to set an attribute of the topic to a new value. See the [Amazon SNS API Reference](https://docs.aws.amazon.com/sns/latest/api/API_SetSubscriptionAttributes.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Default Configuration](#config) #### 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 `` The TopicAttributes action allows a topic owner to set an attribute of the topic to a new value. See the [Amazon SNS API Reference](https://docs.aws.amazon.com/sns/latest/api/API_SetTopicAttributes.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Default Configuration](#config) #### 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 `` 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](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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:

  • HTTP

  • HTTPS

  • EMAIL

  • EMAIL_JSON

  • SMS

  • SQS

  • APPLICATION

  • LAMBDA

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:

  • HTTP - The endpoint is an URL beginning with http://.

  • HTTPS - The endpoint is a URL beginning with https://.

  • EMAIL - The endpoint is an email address.

  • EMAIL_JSON - The endpoint is an email address.

  • SMS - The endpoint is a phone number of an SMS-enabled device.

  • SQS - The endpoint is the ARN of an Amazon SQS queue.

  • APPLICATION - The endpoint is the endpoint of a mobile app and device.

  • LAMBDA - The endpoint is the ARN of an AWS Lambda function.

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` 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](https://docs.aws.amazon.com/sns/latest/api/API_Unsubscribe.html). #### Parameters
NameTypeDescriptionDefault ValueRequired

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.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Default Configuration](#config) #### 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
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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 true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

### Key Store
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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.

### CRL File
FieldTypeDescriptionDefault ValueRequired

Path

String

The path to the CRL file.

### Reconnection
FieldTypeDescriptionDefault ValueRequired

Fails Deployment

Boolean

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

Reconnection Strategy

The reconnection strategy to use.

### Reconnect
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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

### Request ID Attribute
FieldTypeDescriptionDefault ValueRequired

Request Id

String

### Endpoint
FieldTypeDescriptionDefault ValueRequired

Attributes

Object

Endpoint Arn

String

### Repeatable In Memory Iterable
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

### Platform Application
FieldTypeDescriptionDefault ValueRequired

Attributes

Object

Platform Application Arn

String

### Subscription
FieldTypeDescriptionDefault ValueRequired

Endpoint

String

Owner

String

Protocol

String

Subscription Arn

String

Topic Arn

String

### FIFO Parameters
FieldTypeDescriptionDefault ValueRequired

Message Group Id

String

Token that specifies where a message belongs.

x

Message Deduplication Id

String

Token for deduplicating messages. This ID is mandatory when deduplication is not set in the topic level.

## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Amazon SNS Connector version: 4.8 is-latest-version: true --- # Amazon SNS 4.8 Studio Configuration > For the full documentation index, see: https://docs.mulesoft.com/llms.txt To install and configure Anypoint Connector for Amazon SNS (Amazon SNS Connector) in Anypoint Studio: 1. Install the connector. 2. Configure an input source for the connector. 3. Configure the connector. ## Install the Connector in Studio Using Exchange 1. In Studio, create a Mule project. 2. Click the Exchange **(X)** icon in the Studio task bar. 3. In Exchange, click **Login** and supply your Anypoint Platform username and password. 4. In Exchange, search for **Amazon SNS Connector**. 5. Select **Amazon SNS Connector** and click **Add to project**. 6. Follow the prompts to install the connector. ## Install the Connector in Studio 1. In Studio, create a Mule Project. 2. In the Mule Palette, click **(X) Search in Exchange**. 3. In **Add Modules to Project**, type the name of the connector in the search field. 4. Click the connector name in **Available modules**. 5. Click **Add**. 6. Click **Finish**. ## Configure an Input Source Configure an input source for the connector, such as an **HTTP Listener** or **Scheduler**. ## Configure the Connector To use Amazon SNS Connector in your Mule app, configure a global Amazon SNS element that can be used by all Amazon SNS Connectors in the application. 1. Drag a connector operation into the Studio canvas. 2. Click the **Global Elements** tab at the base of the canvas, and then click **Create**. 3. In the **Choose Global Type** window, expand **Connector Configuration**, and click **Amazon SNS configuration**: ![Global Element Configuration Wizard](/mulesoft/current/en-us/amazon-sns-connector/latest/_images/amazon-sns-config-global-wizard.png) 4. Click **OK**. 5. Specify the global element properties: ![Global Element Properties](/mulesoft/current/en-us/amazon-sns-connector/latest/_images/amazon-sns-global-config.png) 6. Configure the parameters as follows:
ParameterDescription

Name

Name by which the configuration is referenced

Session Token

Session token provided by AWS Security Token Service (STS)

Test Topic

Topic used to test the connection

Access Key

Alphanumeric text string that uniquely identifies the user who owns the account

Secret Key

Key that plays the role of a password

Try Default AWS Credentials Provider Chain

Checkbox that controls whether temporary credentials should be used

Region Endpoint

Topic region endpoint

Globally Defined Default Topic Arn

Topic ARN to test the connectivity

7. Retain the default entries for the **Proxy**, **Security**, and **Advanced** tabs. 8. Click **Test Connection** to confirm that the parameters of your global configuration are accurate, and that Mule is able to successfully connect to your instance of Amazon SNS. 9. Click **OK**. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Amazon SNS Connector version: 4.8 is-latest-version: true --- # Amazon SNS 4.8 XML and Maven Support > For the full documentation index, see: https://docs.mulesoft.com/llms.txt If you manually code a Mule application in XML (either from the Studio XML editor or a text editor), you must perform the following actions to access the connector: 1. Add the namespace for the connector to your XML flow. 2. Add dependency information to your Apache Maven `pom.xml` file. In the Studio visual editor, when you drag a connector from the palette to the canvas, Studio automatically populates the XML code with the connector namespace and schema location. ## Add a Namespace for the Connector Paste the following code inside the `` tag of the header of your configuration XML: ```xml http://www.mulesoft.org/schema/mule/sns http://www.mulesoft.org/schema/mule/sns/current/mule-sns.xsd ``` This example shows how the namespace statements are placed in the `` XML block: ```xml ``` ## Add a POM File Dependency The Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app. When you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to this connector. ```xml com.mulesoft.connectors mule-amazon-sns-connector x.x.x mule-plugin ``` Replace `x.x.x` with the version that corresponds to the connector you are using. To obtain the most up-to-date `pom.xml` file information, access the connector in [Anypoint Exchange](https://www.mulesoft.com/exchange/) and click **Dependency Snippets**. ## Next Step After completing your namespace and `pom.xml` file, you can try out [Examples](https://docs.mulesoft.com/amazon-sns-connector/latest/amazon-sns-connector-examples). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Amazon SNS Connector version: 4.7 --- # Amazon SNS Connector 4.7 - Get Started > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Amazon SNS (Amazon SNS Connector) provides connectivity to the Amazon Simple Notification Service (Amazon SNS) API, enabling you to build distributed web-enabled applications. Mule apps can use Amazon SNS Connector to easily push real-time notification messages to interested subscribers over multiple delivery protocols. Release Notes: [Amazon SNS Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/amazon-sns-connector-release-notes-mule-4) Exchange: [Amazon SNS Connector in Anypoint Exchange](https://anypoint.mulesoft.com/exchange/com.mulesoft.connectors/mule-amazon-sns-connector) ## About Connectors Anypoint Connectors are Mule runtime engine extensions that enable you to connect to APIs and resources on external systems, such as Salesforce, Amazon SNS, ServiceNow, and Twitter. ## Before You Begin Before creating an app, you must: - Have access to the Amazon SNS target resource and Anypoint Platform. - Understand how to create a Mule app using Anypoint Studio. - Have AWS Identity and Access Management (IAM) credentials. ## Next Step After you have met the prerequisites, you are ready to create an app with [Anypoint Studio](https://docs.mulesoft.com/amazon-sns-connector/4.7/amazon-sns-connector-studio). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Salesforce Help](https://help.salesforce.com) --- product: Amazon SNS Connector version: 4.8 is-latest-version: true --- # Amazon SNS Connector 4.8 - Get Started > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Amazon SNS (Amazon SNS Connector) provides connectivity to the Amazon Simple Notification Service (Amazon SNS) API, enabling you to build distributed web-enabled applications. Mule apps can use Amazon SNS Connector to easily push real-time notification messages to interested subscribers over multiple delivery protocols. Release Notes: [Amazon SNS Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/amazon-sns-connector-release-notes-mule-4) Exchange: [Amazon SNS Connector in Anypoint Exchange](https://anypoint.mulesoft.com/exchange/com.mulesoft.connectors/mule-amazon-sns-connector) ## About Connectors Anypoint Connectors are Mule runtime engine extensions that enable you to connect to APIs and resources on external systems, such as Salesforce, Amazon SNS, ServiceNow, and Twitter. ## Before You Begin Before creating an app, you must: - Have access to the Amazon SNS target resource and Anypoint Platform. - Understand how to create a Mule app using Anypoint Studio. - Have AWS Identity and Access Management (IAM) credentials. ## Next Step After you have met the prerequisites, you are ready to create an app with [Anypoint Studio](https://docs.mulesoft.com/amazon-sns-connector/latest/amazon-sns-connector-studio). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Salesforce Help](https://help.salesforce.com) --- product: Amazon SNS Connector version: 4.7 --- # Upgrading and Migrating Amazon SNS Connector to Version 4.7 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt ## Supported Upgrade Paths
From VersionTo Version

4.6.x

4.7.x

## Changes ### 4.7 - Added support for FIFO topics, which provide strict message ordering and message deduplication with Amazon SQS FIFO queues. ### 4.6 - Added a new notification option. Use the **Phone number** parameter to send a text message to a specified phone number. This option is offered in addition to **Target Arn** and **Topic Arn**, which are the existing notification options. ### 4.5 - Added the ability to configure TLS and custom SNS and STS endpoints. - Upgraded `aws-java-sdk` from 1.11.611 to 1.11.969. - Upgraded `aws-connector-commons` from 2.0.0 to 2.3.0. ## Requirements Ensure your system meets the following requirements before you perform the upgrade:
Application/ServiceVersion

Mule

4.1.1 and later

Amazon Java SDK for RDS

v1.11.969

Java

1.8.0_x

Anypoint Studio

7.1 and later

See the [Amazon SNS Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/amazon-sns-connector-release-notes-mule-4) for updated compatibility information for patch updates. ## Upgrade Prerequisites Before you perform the upgrade, create a backup of your files, data, and configuration in case you need to restore to the previous version. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Amazon SNS Connector version: 4.8 is-latest-version: true --- # Upgrading and Migrating Amazon SNS Connector to Version 4.8 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt ## Supported Upgrade Paths
From VersionTo Version

4.7.x

4.8.x

## Changes ### 4.8 - Amazon SNS Connector now supports passing an external ID in Role-based authentication. - The AWS SDK version is upgraded to 2.35.3. ### 4.7 - Added support for FIFO topics, which provide strict message ordering and message deduplication with Amazon SQS FIFO queues. ### 4.6 - Added a new notification option. Use the **Phone number** parameter to send a text message to a specified phone number. This option is offered in addition to **Target Arn** and **Topic Arn**, which are the existing notification options. ### 4.5 - Added the ability to configure TLS and custom SNS and STS endpoints. - Upgraded `aws-java-sdk` from 1.11.611 to 1.11.969. - Upgraded `aws-connector-commons` from 2.0.0 to 2.3.0. ## Requirements Ensure your system meets the following requirements before you perform the upgrade:
Application/ServiceVersion

Mule

4.1.1 and later

Amazon Java SDK for RDS

v1.11.969

Java

1.8.0_x

Anypoint Studio

7.1 and later

See the [Amazon SNS Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/amazon-sns-connector-release-notes-mule-4) for updated compatibility information for patch updates. ## Upgrade Prerequisites Before you perform the upgrade, create a backup of your files, data, and configuration in case you need to restore to the previous version. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com)