Skip to main content

Amazon SQS Component

Send, receive and manage messages within an Amazon (AWS) SQS queue

Component key: aws-sqs

Description#

Amazon SQS is a message queueing service from Amazon Web Services. The Amazon SQS component allows you to send and receive messages within an Amazon SQS queue.

Amazon SQS Connections#

AWS SQS Access Key and Secret#

An AWS IAM access key pair is required to interact with Amazon SQS. Make sure that the key pair you generate in AWS has proper permissions to the SQS resources you want to access. Read more about SQS IAM policies in the AWS docs.

InputNotesExample
Input
Access Key ID
string
/ Required
Notes
An AWS IAM Access Key ID
Example
AKIAIOSFODNN7EXAMPLE
Input
Secret Access Key
password
/ Required
Notes
An AWS IAM Secret Access Key
Example
wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

Actions#

Create Queue#

Create an Amazon SQS Queue | key: createQueue

InputDefaultNotesExample
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
AWS Region
string
/ Required
Default
us-east-1
Notes
AWS provides services in multiple regions, like us-west-2 or eu-east-1. AWS region indicates the region in which your bucket(s) are stored.
Example
us-east-1
Input
FIFO Queue
boolean
/ Required
Default
false
Notes
This flag enables the creation of a FIFO Queue. Once you create a FIFO queue you cannot change it to a standard queue.
Example
 
Input
Name
string
/ Required
Default
 
Notes
The name of a new queue. Can only include alphanumeric characters, hyphens, or underscores and must be 1 to 80 characters in length
Example
my-example-queue

Output Example Payload#

{  "data": {    "QueueUrl": "https://sqs.us-east-1.amazonaws.com/012345678900/my-example-queue"  }}

Delete Message#

Delete a message from an Amazon SQS Queue | key: deleteMessage

InputDefaultNotesExample
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
AWS Region
string
/ Required
Default
us-east-1
Notes
AWS provides services in multiple regions, like us-west-2 or eu-east-1. AWS region indicates the region in which your bucket(s) are stored.
Example
us-east-1
Input
Receipt Handle
string
/ Required
Default
 
Notes
Every time you receive a message from a queue, you receive a receipt handle for that message. This handle is associated with the action of receiving the message, not with the message itself.
Example
AQEBwLpNvpxWR+nqO4frM8rWABCI4dbqTwo7
Input
Queue URL
string
/ Required
Default
 
Notes
You require the queue URL to send, receive, and delete queue messages. A queue URL is constructed in the following format: https://{REGION_ENDPOINT}/queue.|api-domain|/{YOUR_ACCOUNT_NUMBER}/{YOUR_QUEUE_NAME}
Example
https://sqs.us-east-1.amazonaws.com/012345678900/my-example-queue

Delete Queue#

Delete an Amazon SQS Queue | key: deleteQueue

InputDefaultNotesExample
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
AWS Region
string
/ Required
Default
us-east-1
Notes
AWS provides services in multiple regions, like us-west-2 or eu-east-1. AWS region indicates the region in which your bucket(s) are stored.
Example
us-east-1
Input
Queue URL
string
/ Required
Default
 
Notes
You require the queue URL to send, receive, and delete queue messages. A queue URL is constructed in the following format: https://{REGION_ENDPOINT}/queue.|api-domain|/{YOUR_ACCOUNT_NUMBER}/{YOUR_QUEUE_NAME}
Example
https://sqs.us-east-1.amazonaws.com/012345678900/my-example-queue

Get a Queue's URL#

Get the URL of an Amazon SQS Queue given its name | key: getQueueUrl

InputDefaultNotesExample
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
AWS Region
string
/ Required
Default
us-east-1
Notes
AWS provides services in multiple regions, like us-west-2 or eu-east-1. AWS region indicates the region in which your bucket(s) are stored.
Example
us-east-1
Input
Name
string
/ Required
Default
 
Notes
The name of a new queue. Can only include alphanumeric characters, hyphens, or underscores and must be 1 to 80 characters in length
Example
my-example-queue

Output Example Payload#

{  "data": {    "QueueUrl": "https://sqs.us-east-1.amazonaws.com/012345678900/my-example-queue"  }}

List Queues#

Send a message to an Amazon SQS Queue | key: listQueues

InputDefaultNotesExample
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
AWS Region
string
/ Required
Default
us-east-1
Notes
AWS provides services in multiple regions, like us-west-2 or eu-east-1. AWS region indicates the region in which your bucket(s) are stored.
Example
us-east-1
Input
Queue Prefix
string
Default
 
Notes
Provide an integer value for the maximum amount of items that will be returned. Provide a value from 1 to 50.
Example
20

Output Example Payload#

{  "data": {    "QueueUrls": [      "https://sqs.us-east-1.amazonaws.com/012345678900/my-example-queue",      "https://sqs.us-east-1.amazonaws.com/012345678900/my-second-queue"    ]  }}

Receive Messages#

Receive messages from an Amazon SQS Queue | key: receiveMessages

InputDefaultNotesExample
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
AWS Region
string
/ Required
Default
us-east-1
Notes
AWS provides services in multiple regions, like us-west-2 or eu-east-1. AWS region indicates the region in which your bucket(s) are stored.
Example
us-east-1
Input
Max Messages
string
Default
 
Notes
Provide a number for the max amount of values to be returned.
Example
5
Input
Queue URL
string
/ Required
Default
 
Notes
You require the queue URL to send, receive, and delete queue messages. A queue URL is constructed in the following format: https://{REGION_ENDPOINT}/queue.|api-domain|/{YOUR_ACCOUNT_NUMBER}/{YOUR_QUEUE_NAME}
Example
https://sqs.us-east-1.amazonaws.com/012345678900/my-example-queue
Input
Wait Time (seconds)
string
Default
 
Notes
The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list of messages.
Example
10
note

Receive Messages can behave differently depending on what kind of queue you are trying to poll. If you are using a non-FIFO queue, this action may return false blank responses. SNS FIFO is intended for customer use cases where it is critical to maintain the consistency in processing messages across multiple independent services in a strictly ordered manner. If you are polling a FIFO queue you are guaranteed to receive the maximum amount of messages you specify (up to 10) per request. Refer to the AWS docs for information on migrating to a FIFO queue

Output Example Payload#

{  "data": {    "Messages": [      {        "MessageId": "00000000-00000000-00000000-00000000",        "ReceiptHandle": "Example Receipt Handle",        "MD5OfBody": "e909509655c5154f008e0ee43ed655b2",        "Body": "My Test Message",        "Attributes": {          "SenderId": "EXAMPLE5OBBA2B7URDN4G",          "ApproximateFirstReceiveTimestamp": "1646857534190",          "ApproximateReceiveCount": "3",          "SentTimestamp": "1646857528982"        },        "MessageAttributes": {          "exampleKey1": {            "StringValue": "exampleValue",            "DataType": "String"          },          "exampleKey2": {            "StringValue": "exampleValue2",            "DataType": "String"          }        }      }    ]  }}

Send Message#

Send a message to an Amazon SQS Queue | key: sendMessage

InputDefaultNotesExample
Input
Attributes
string
Key Value List
Default
 
Notes
Amazon SQS lets you include structured metadata (such as timestamps, geospatial data, signatures, and identifiers) with messages using message attributes. Each message can have up to 10 attributes.
Example
 
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
AWS Region
string
/ Required
Default
us-east-1
Notes
AWS provides services in multiple regions, like us-west-2 or eu-east-1. AWS region indicates the region in which your bucket(s) are stored.
Example
us-east-1
Input
Delay Seconds
data
Default
 
Notes
Provide a number of optional seconds to delay sending a message.
Example
0
Input
Message
string
/ Required
Default
 
Notes
Provide a string containing the message you would like to send.
Example
Example Message
Input
Message deduplication ID
string
Default
 
Notes
The message deduplication ID is the token used for deduplication of sent messages. If a message with a particular message deduplication ID is sent successfully, any messages sent with the same message deduplication ID are accepted successfully but aren't delivered during the 5-minute deduplication interval.
Example
myExampleDeduplicationId
Input
Message Group Id
string
Default
 
Notes
The message group ID is the tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are always processed one by one, in a strict order relative to the message group (however, messages that belong to different message groups might be processed out of order).
Example
myExampleMessageGroup
Input
Queue URL
string
/ Required
Default
 
Notes
You require the queue URL to send, receive, and delete queue messages. A queue URL is constructed in the following format: https://{REGION_ENDPOINT}/queue.|api-domain|/{YOUR_ACCOUNT_NUMBER}/{YOUR_QUEUE_NAME}
Example
https://sqs.us-east-1.amazonaws.com/012345678900/my-example-queue

Output Example Payload#

{  "data": {    "MD5OfMessageBody": "05e891701cde4c383b66f46a7b9a808c",    "MD5OfMessageAttributes": "23adb2d3b76c04a687f9a5fcfb6086bb",    "MessageId": "00000000-00000000-00000000-00000000"  }}