AWS SNS actions

preview

We're still working on this feature, but we'd love for you to try it out!

This feature is currently provided as part of a preview program pursuant to our pre-release policies.

This page provides a comprehensive reference for aws sns actions available in the workflow automation actions catalog. These actions enable you to sns topic operations.

Prerequisites

Before using AWS actions in workflow automation, ensure you have:

An AWS account with appropriate permissions.
AWS credentials configured (IAM user credentials, IAM role ARN, or session credentials).
The necessary IAM permissions for the specific AWS services you plan to use.

See Set up AWS credentials for information on how to create IAM users and IAM roles, and set up static and session AWS credentials for integration with workflow automation AWS actions.

Sends a message to an Amazon SNS topic. All subscribers to the topic will receive the message.

Input Field	Optionality	Type	Example
awsRoleArn	Optional	String	`arn:aws:iam::123456789012:role/my-workflow-role`
awsAccessKeyId	Optional	String	`${{ :secrets:<awsAccessKeyId> }}`
awsSecretAccessKey	Optional	String	`${{ :secrets:<awsSecretAccessKey> }}`
awsSessionToken	Optional	String	`${{ :secrets:<awsSessionToken> }}`
region	Required	String	`"us-east-2"`
message	Required	String	Messages must be UTF-8 encoded strings and at most 256 KB in size `Workflow failed at step 3`
topicArn	Optional	String	If you do not specify a value for the topicArn parameter, Must specify a value for the targetArn parameters. `"arn:aws:sns:us-east-2:123456789012:my-topic"`
targetArn	Optional	String	If you do not specify a value for the topicArn parameter, Must specify a value for the targetArn parameters. `"arn:aws:sns:us-east-2:123456789012:MySNSTopic"`
subject	Optional	String	`"Workflow Update"`
MessageStructure	Optional	String	`MessageStructure`
messageAttributes	Optional	Map	`{ 'string': { 'DataType': 'string', 'StringValue': 'string', 'BinaryValue': b'bytes' } },`
messageDeduplicationId	Optional	String	`"abc123deduplicationId5678"`
messageGroupId	Optional	String	`"order-processing-group-2023_A"`

Input Field	Type	Example
PhoneNumber	String	We do not include PhoneNumber as it is considered Personally Identifiable Information (PII).

Output Field	Type	Example
response	object	`[{"success":true,"response":{"MessageId":"2333ededwedwed-52f5-a716-e10355e3e2ff"}}]` Response syntax can be referred to sns-publish- Boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sns/client/publish.html)
success	Boolean	`success: true \| false`
errorMessage	String	`[{"errorMessage":"An error occurred (InvalidParameter) when calling the Publish operation: Invalid parameter: TopicArn or TargetArn Reason: no value for required parameter","success":false,"response":null}]`

Output Field

Type

Example

response

object

[{"success":true,"response":{"MessageId":"2333ededwedwed-52f5-a716-e10355e3e2ff"}}]

Response syntax can be referred to sns-publish- Boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sns/client/publish.html)

success

Boolean

success: true | false

errorMessage

String

[{"errorMessage":"An error occurred (InvalidParameter) when calling the Publish operation: Invalid parameter: TopicArn or TargetArn Reason: no value for required parameter","success":false,"response":null}]

name: sns-publish-test
  description: Publishes a notification to an SNS topic
  workflowInputs:
    arnRole:
      type: String
  steps:
    - name: aws_sns_publish_1
      type: action
      action: aws.sns.publish
      version: '1'
      inputs:
        awsRoleArn: ${{ .workflowInputs.arnRole }}
        region: us-east-1
        topicArn: arn:aws:sns:us-east-1:123456789012:workflow-test-topic
        subject: "Workflow Update"
        message: "The data processing workflow has completed successfully."
      next: end

preview

Prerequisites.css-21sua1{background:none;border:none;width:0;padding:0;}

Publish a message to an AWS SNS topic

Prerequisites