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.

Authorization Notes#

An AWS IAM access key pair is required to interact with Amazon SQS. The AWS access_key_id serves as the API Key, and the secret_access_key serves as the API Secret. 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 & authentication in the AWS docs.

Actions#

Create Queue#

Create an Amazon SQS Queue | key: createQueue

InputKeyDefaultNotesExample

AWS Region

string
/ Required
awsRegionus-east-1AWS 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.us-east-1

FIFO Queue

boolean
/ Required
isFifofalseThis flag enables the creation of a FIFO Queue. Once you create a FIFO queue you cannot change it to a standard queue.

Name

string
/ Required
nameProvide a string for the name of the new Queue.My Example Queue

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Key / Secretapi_key_secretAPI Key / Secret Combination

API Key |  api_key

API Secret |  api_secret

Output Example Payload#

{  "data": {    "QueueUrl": "http://www.example.com/queue"  }}

Delete Message#

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

InputKeyDefaultNotesExample

AWS Region

string
/ Required
awsRegionus-east-1AWS 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.us-east-1

Receipt Handle

string
/ Required
receiptHandleEvery 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. AQEBwLpNvpxWR+nqO4frM8rWABCI4dbqTwo7

Queue URL

string
/ Required
urlYou 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} My Example Title

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Key / Secretapi_key_secretAPI Key / Secret Combination

API Key |  api_key

API Secret |  api_secret


Delete Queue#

Delete an Amazon SQS Queue | key: deleteQueue

InputKeyDefaultNotesExample

AWS Region

string
/ Required
awsRegionus-east-1AWS 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.us-east-1

Queue URL

string
/ Required
urlYou 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} My Example Title

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Key / Secretapi_key_secretAPI Key / Secret Combination

API Key |  api_key

API Secret |  api_secret


Get Queue URL#

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

InputKeyDefaultNotesExample

AWS Region

string
/ Required
awsRegionus-east-1AWS 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.us-east-1

Name

string
/ Required
nameProvide a string for the name of the new Queue.My Example Queue

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Key / Secretapi_key_secretAPI Key / Secret Combination

API Key |  api_key

API Secret |  api_secret

Output Example Payload#

{  "data": {    "QueueUrl": "http://www.example.com/query"  }}

List Queues#

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

InputKeyDefaultNotesExample

AWS Region

string
/ Required
awsRegionus-east-1AWS 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.us-east-1

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Key / Secretapi_key_secretAPI Key / Secret Combination

API Key |  api_key

API Secret |  api_secret

Output Example Payload#

{  "data": {    "$response": {      "data": {        "QueueUrls": [          "http://www.exampleQueueUrl.com"        ]      },      "requestId": "MyRequestId",      "redirectCount": 5,      "retryCount": 3    }  }}

Receive Messages#

Receive messages from an Amazon SQS Queue | key: receiveMessages

InputKeyDefaultNotesExample

AWS Region

string
/ Required
awsRegionus-east-1AWS 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.us-east-1

Max Messages

string
maxNumberProvide a number for the max amount of values to be returned.5

Queue URL

string
/ Required
urlYou 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} My Example Title

Wait Time (seconds)

string
waitTimeThe 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.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

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Key / Secretapi_key_secretAPI Key / Secret Combination

API Key |  api_key

API Secret |  api_secret

Output Example Payload#

{  "data": {    "Messages": [      {        "MessageId": "Example message Id",        "ReceiptHandle": "Example Receipt Handle",        "MD5OfBody": "Example hash of the message that was received",        "MessageAttributes": {}      }    ]  }}

Send Message#

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

InputKeyDefaultNotesExample

Attributes

string
attributesAmazon 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.

AWS Region

string
/ Required
awsRegionus-east-1AWS 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.us-east-1

Delay Seconds

data
delaySecondsProvide a number of optional seconds to delay sending a message.0

Message

string
/ Required
messageProvide a string containing the message you would like to send.Example Message

Message deduplication ID

string
messageDeduplicationIdThe 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.myExampleDeduplicationId

Message Group Id

string
messageGroupIdThe 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).myExampleMessageGroup

Queue URL

string
/ Required
urlYou 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} My Example Title

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Key / Secretapi_key_secretAPI Key / Secret Combination

API Key |  api_key

API Secret |  api_secret

Output Example Payload#

{  "data": {    "MD5OfMessageAttributes": "Example hash of message that was sent",    "MessageId": "Example message Id"  }}