AWS SQS actions

This page provides a comprehensive reference for aws sqs actions available in the workflow automation actions catalog. These actions enable you to sqs queue 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 a specified Amazon SQS queue.

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"`
queueUrl	Required	String	"`https://sqs.us-east-2.amazonaws.com/123456789012/my-queue`"
messageBody	Required	String	`"This is a test message"`
messageDeduplicationId	Optional	String	`"abc123deduplicationId5678"`
messageGroupId	Optional	String	`"group1"`
messageAttributes	Optional	Map	`{ "my_attribute_name_1": { "DataType": "String", "StringValue":"my_attribute_value_1"}, "my_attribute_name_2": { "DataType": "String", "StringValue":"my_attribute_value_2"}}`
delaySeconds	Optional	Int	`123`

Output Field	Type	Example
response	object	`{"statusCode":200, "payload":{"status":"success","data":{"MessageId":"e9b73a52-d018-4a73-9fcd-8efb682fba43","MD5OfMessageBody":"fae535c7f7c5687a1c3d8bc52288e33a","MD5OfMessageAttributes":"3ae3c4f59958e031d0d53af2d157e834", }, "message":"Message sent successfully to the SQS queue." }}` Response syntax can be referred to SQS send_message - Boto3 documentation
success	Boolean	`success: true \| false`
errorMessage	String	`"errorMessage": "SQS.Client.exceptions.QueueDoesNotExist: "The specified queue does not exist.""`

Output Field

Type

Example

response

object

{"statusCode":200, "payload":{"status":"success","data":{"MessageId":"e9b73a52-d018-4a73-9fcd-8efb682fba43","MD5OfMessageBody":"fae535c7f7c5687a1c3d8bc52288e33a","MD5OfMessageAttributes":"3ae3c4f59958e031d0d53af2d157e834", }, "message":"Message sent successfully to the SQS queue." }}

Response syntax can be referred to SQS send_message - Boto3 documentation

success

Boolean

success: true | false

errorMessage

String

"errorMessage": "SQS.Client.exceptions.QueueDoesNotExist: "The specified queue does not exist.""

Workflow example
name: sqs-send-message-test description: Sends a message to an SQS queue workflowInputs: arnRole: type: String steps: - name: aws_sqs_sendMessage_1 type: action action: aws.sqs.sendMessage version: '1' inputs: awsRoleArn: ${{ .workflowInputs.arnRole }} region: us-east-2 queueUrl: https://sqs.us-east-2.amazonaws.com/123456789012/workflow-test-queue messageBody: "This is a test message" messageAttributes: my_attribute_name_1: DataType: "String" StringValue: "my_attribute_value_1" my_attribute_name_2: DataType: "String" StringValue: "my_attribute_value_2" next: end

Workflow example

name: sqs-send-message-test
description: Sends a message to an SQS queue
workflowInputs:
  arnRole:
    type: String
steps:
  - name: aws_sqs_sendMessage_1
    type: action
    action: aws.sqs.sendMessage
    version: '1'
    inputs:
      awsRoleArn: ${{ .workflowInputs.arnRole }}
      region: us-east-2
      queueUrl: https://sqs.us-east-2.amazonaws.com/123456789012/workflow-test-queue
      messageBody: "This is a test message"
      messageAttributes:
        my_attribute_name_1:
          DataType: "String"
          StringValue: "my_attribute_value_1"
        my_attribute_name_2:
          DataType: "String"
          StringValue: "my_attribute_value_2"
    next: end

Retrieves one or more messages, from the specified queue

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"`
queueUrl	Required	String	"`https://sqs.us-east-2.amazonaws.com/123456789012/my-queue`"
maxNumberOfMessages	Optional	Int	`10`
waitTimeSeconds	Optional	Int	`5`
VisibilityTimeout	Optional	Int	`123`
AttributeNames	Optional	List	`[ 'All'\|'Policy'\|'VisibilityTimeout'\|'MaximumMessageSize'\|'MessageRetentionPeriod'\|'ApproximateNumberOfMessages'\|'ApproximateNumberOfMessagesNotVisible'\|'CreatedTimestamp'\|'LastModifiedTimestamp'\|'QueueArn'\|'ApproximateNumberOfMessagesDelayed'\|'DelaySeconds'\|'ReceiveMessageWaitTimeSeconds'\|'RedrivePolicy'\|'FifoQueue'\|'ContentBasedDeduplication'\|'KmsMasterKeyId'\|'KmsDataKeyReusePeriodSeconds'\|'DeduplicationScope'\|'FifoThroughputLimit'\|'RedriveAllowPolicy'\|'SqsManagedSseEnabled', ]`
messageAttributeNames	Optional	List	`[ 'message_attribute_name', ],`
messageSystemAttributeNames	Optional	List	`['SenderId', 'SentTimestamp']`
receiveRequestAttemptId	Optional	String	`"req-1234abcd"`

Output Field	Type	Example
response	object	`{"response":<aws api response> }` Response syntax can be referred to receive_message - Boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sqs/client/receive_message.html)
success	Boolean	`success: true \| false`
errorMessage	String	`"errorMessage": "SQS.Client.exceptions.QueueDoesNotExist: "The specified queue does not exist.""`

Output Field

Type

Example

response

object

{"response":<aws api response> }

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

success

Boolean

success: true | false

errorMessage

String

"errorMessage": "SQS.Client.exceptions.QueueDoesNotExist: "The specified queue does not exist.""

name: sqs-receive-message-test
description: 'Receives a message from an SQS queue'
steps:
  - name: aws_sqs_receiveMessage_1
    type: action
    action: aws.sqs.receiveMessage
    version: '1'
    inputs:
      awsRoleArn: ${{ :secrets:awsRoleArn }}
      region: us-east-1
      queueUrl: https://sqs.us-east-1.amazonaws.com/123456789012/workflow-test-queue
      waitTimeSeconds: 5
      maxNumberOfMessages: 10
      messageAttributeNames: ['message_attribute_name'],

Prerequisites

Send a message to an AWS SQS queue

Receives a message from an AWS SQS queue

AWS SQS actions

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

Receives a message from an AWS SQS queue

Prerequisites