Amazon SQS · AsyncAPI Specification
Amazon Simple Queue Service (SQS) Event Source Mapping
Version 2012-11-05
AsyncAPI specification for Amazon SQS event-driven messaging patterns. Amazon SQS provides reliable, highly-scalable hosted queues for storing messages as they travel between applications or microservices. SQS supports both standard queues (maximum throughput, best-effort ordering, at-least-once delivery) and FIFO queues (exactly-once processing, in order). This specification describes the asynchronous messaging channels and message formats used when integrating with SQS, including AWS Lambda event source mappings that automatically poll SQS queues and invoke Lambda functions with batches of messages.
View Spec
View on GitHub
AWSCloudDistributed SystemsMessagingMicroservicesQueueAsyncAPIWebhooksEvents
Channels
standardQueue
A standard Amazon SQS queue. Standard queues offer maximum throughput, best-effort ordering, and at-least-once delivery. Messages can be received out of the order in which they were sent, and a message might be delivered more than once.
fifoQueue
A FIFO (First-In-First-Out) Amazon SQS queue. FIFO queues are designed to guarantee that messages are processed exactly once, in the exact order that they are sent. FIFO queue names must end with the .fifo suffix.
deadLetterQueue
A dead-letter queue (DLQ) that receives messages that could not be processed successfully from their source queue. Messages are moved to the DLQ after the maximum number of receive attempts (maxReceiveCount) has been exceeded. DLQs help isolate and debug problematic messages.
lambdaEventSource
An AWS Lambda event source mapping for Amazon SQS. Lambda polls the SQS queue and invokes your Lambda function synchronously with an event that contains queue messages. Lambda reads messages in batches and invokes the function once for each batch. The event source mapping reads messages from the queue, constructs a batch, and invokes the function. For standard queues, Lambda uses long polling to poll the queue until it becomes active. For FIFO queues, Lambda sends messages to the function in the order that it receives them.
Messages
sqsMessage
SQS Standard Queue Message
A message in an Amazon SQS standard queue
sqsFifoMessage
SQS FIFO Queue Message
A message in an Amazon SQS FIFO queue
sqsBatchMessage
SQS Batch Message
A batch of up to 10 messages for an SQS queue
sqsDeadLetterMessage
SQS Dead-Letter Queue Message
A message in an SQS dead-letter queue
lambdaSqsEvent
Lambda SQS Event
The event payload sent to AWS Lambda from an SQS event source mapping
Servers
https
production
Amazon SQS Regional Endpoint