Skip to main content

Amazon SQS Component

Send, receive and manage messages within an Amazon 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 Methods#

Amazon SQS requires one of the following authorization methods:

Auth TypeKeyDescriptionFields
API Key / Secretapi_key_secretAPI Key / Secret Combination

API Key |  api_key

API Secret |  api_secret

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

Name

string
/ Required
nameMy Example Queue

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
receiptHandleAQEBwLpNvpxWR+nqO4frM8rWABCI4dbqTwo7

Queue URL

string
/ Required
urlMy Example Title

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
urlMy Example Title

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
nameMy Example Queue

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

Output Example Payload#

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

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
maxNumber5

Queue URL

string
/ Required
urlMy Example Title

Output Example Payload#

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

Send Message#

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

InputKeyDefaultNotesExample

Attributes

string
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
delaySeconds0

Message

string
/ Required
messageExample Message

Queue URL

string
/ Required
urlMy Example Title

Output Example Payload#

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