This page provides a reference for AWS SQS actions available in the workflow automation actions catalog. Use these actions to manage Amazon SQS queues and messages.
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 SQS. At minimum, the IAM role or user needs
sqs:*on the target queues.
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.
Send a message to an SQS queue
The action identifier is aws.sqs.sendMessage.
Sends a message to a specified Amazon SQS queue.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the queue is located. |
|
| String | Required. URL of the target SQS queue. |
|
| String | Required. Message body to send to the queue. |
|
| String | Optional. Token used for deduplication in FIFO queues. |
|
| String | Optional. Message group ID for FIFO queues. |
|
| Map | Optional. Message attributes as key-value pairs. |
|
| Int | Optional. Number of seconds to delay message delivery. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object |
|
| Boolean |
|
| String |
|
Receive a message from an SQS queue
The action identifier is aws.sqs.receiveMessage.
Retrieves one or more messages from the specified queue.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the queue is located. |
|
| String | Required. URL of the target SQS queue. |
|
| Int | Optional. Maximum number of messages to retrieve (1–10). |
|
| Int | Optional. Duration in seconds for long-polling. |
|
| Int | Optional. Duration in seconds that received messages are hidden from other consumers. |
|
| List | Optional. Queue attribute names to include in the response. |
|
| List | Optional. Message attribute names to retrieve. |
|
| List | Optional. System message attributes to retrieve. |
|
| String | Optional. Deduplication token for FIFO queue receive requests. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object |
|
| Boolean |
|
| String |
|
Create an SQS queue
The action identifier is aws.sqs.createQueue.
Creates a new Amazon SQS queue with specified configuration.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the queue will be created. |
|
| String | Required. Name for the new queue (1–80 characters). Must be unique within your account and region. For FIFO queues, the name must end with |
|
| Map | Optional. Queue attributes as key-value pairs. Common attributes: |
|
| Map | Optional. Tags to assign to the queue as key-value pairs. Maximum 50 tags. The |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object |
|
| Boolean |
|
| String | Error message on failure. |
Delete an SQS queue
The action identifier is aws.sqs.deleteQueue.
Deletes an Amazon SQS queue. All messages in the queue are permanently deleted and this operation cannot be undone. There is a 60-second delay before you can recreate a queue with the same name.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the queue is located. |
|
| String | Required. URL of the queue to delete. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object |
|
| Boolean |
|
| String | Error message on failure. |
Get SQS queue attributes
The action identifier is aws.sqs.getQueueAttributes.
Retrieves attributes for an Amazon SQS queue, including message counts, ARN, visibility timeout, and other configuration. Attribute names are case-sensitive.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the queue is located. |
|
| String | Required. URL of the queue. |
|
| List | Optional. Attribute names to retrieve. Use |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object |
|
| Boolean |
|
| String | Error message on failure. |
Set SQS queue attributes
The action identifier is aws.sqs.setQueueAttributes.
Updates one or more attributes of an Amazon SQS queue. All attribute values must be strings, including numeric values.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the queue is located. |
|
| String | Required. URL of the queue to update. |
|
| Map | Required. Queue attributes to set as key-value pairs. Common attributes: |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object |
|
| Boolean |
|
| String | Error message on failure. |
Purge an SQS queue
The action identifier is aws.sqs.purgeQueue.
Deletes all messages in an Amazon SQS queue without deleting the queue itself. This operation is irreversible. The purge can take up to 60 seconds to complete, and messages sent during this window may also be deleted.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the queue is located. |
|
| String | Required. URL of the queue to purge. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object |
|
| Boolean |
|
| String | Error message on failure. |
List SQS queues
The action identifier is aws.sqs.listQueues.
Lists SQS queues in your AWS account, optionally filtered by queue name prefix. Queue name matching is case-sensitive. Returns up to 1,000 results per request by default.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region to list queues from. |
|
| String | Optional. Filter queues by name prefix. |
|
| Number | Optional. Maximum number of results to return (1–1000). Defaults to 1000. |
|
| String | Optional. Pagination token from a previous response to retrieve the next page of results. | |
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object |
|
| Boolean |
|
| String | Error message on failure. |
Delete a message from an SQS queue
The action identifier is aws.sqs.deleteMessage.
Deletes a specific message from an Amazon SQS queue using its receipt handle. Obtain the receipt handle from aws.sqs.receiveMessage. Receipt handles expire after the queue's visibility timeout. If the timeout expires, receive the message again to get a new handle.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the queue is located. |
|
| String | Required. URL of the queue containing the message. |
|
| String | Required. Receipt handle of the message to delete. Obtained from | |
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object |
|
| Boolean |
|
| String | Error message on failure. |
Tag an SQS queue
The action identifier is aws.sqs.tagQueue.
Adds or updates tags on an Amazon SQS queue. This operation adds or updates only the specified tags without removing existing tags. Maximum 50 tags per queue. Tag keys and values are case-sensitive. The aws: prefix is reserved and cannot be used.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the queue is located. |
|
| String | Required. URL of the queue to tag. |
|
| Map | Required. Tags to add or update as key-value pairs. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object |
|
| Boolean |
|
| String | Error message on failure. |
Remove tags from an SQS queue
The action identifier is aws.sqs.untagQueue.
Removes specified tags from an Amazon SQS queue. Tag keys are case-sensitive. Specifying keys that don't exist does not cause an error.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the queue is located. |
|
| String | Required. URL of the queue to untag. |
|
| List | Required. Tag keys to remove from the queue. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object |
|
| Boolean |
|
| String | Error message on failure. |
List SQS queue tags
The action identifier is aws.sqs.listQueueTags.
Lists all tags associated with an Amazon SQS queue.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the queue is located. |
|
| String | Required. URL of the queue. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object |
|
| Boolean |
|
| String | Error message on failure. |
Start a message move task
The action identifier is aws.sqs.startMessageMoveTask.
Starts a task to move messages from one queue to another. The primary use case is recovering messages from a dead-letter queue (DLQ) back to the source queue. Only one active message move task is allowed per source queue at a time.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the queues are located. |
|
| String | Required. ARN of the source queue (typically a DLQ) from which to move messages. |
|
| String | Optional. ARN of the destination queue. If not specified, messages move back to their original source queue. |
|
| Number | Optional. Maximum messages to move per second (1–500). Use lower values to avoid overwhelming the destination queue. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object |
|
| Boolean |
|
| String | Error message on failure. |
List message move tasks
The action identifier is aws.sqs.listMessageMoveTasks.
Lists message move tasks for a source queue and checks their status. Use this action to monitor the progress of DLQ recovery operations.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the source queue is located. |
|
| String | Required. ARN of the source queue for which to list tasks. |
|
| Number | Optional. Maximum number of results to return (1–10). Defaults to 10. |
|
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object |
|
| Boolean |
|
| String | Error message on failure. |
Cancel a message move task
The action identifier is aws.sqs.cancelMessageMoveTask.
Cancels a running message move task. Cancellation is not immediate—the task status transitions through CANCELLING before reaching CANCELLED. Messages already moved are not rolled back.
The following table describes the input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Optional. IAM role ARN to assume for AWS API calls. |
|
| String | Optional. AWS access key ID. Pass as a secret. |
|
| String | Optional. AWS secret access key. Pass as a secret. |
|
| String | Optional. Temporary session token for STS authentication. Pass as a secret. |
|
| String | Required. AWS region where the queues are located. |
|
| String | Required. Task identifier returned by | |
| List | Optional. JQ selectors to extract specific fields from the action output. |
|
The following table describes the output fields for this action.
Output | Type | Example |
|---|---|---|
| Object |
|
| Boolean |
|
| String | Error message on failure. |