Expand description
Welcome to the Amazon Simple Queue Service API Reference.
Amazon Simple Queue Service (Amazon SQS) is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.
You can use AWS SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:
-
Cryptographically sign your service requests
-
Retry requests
-
Handle error responses
Additional Information
-
Amazon Simple Queue Service Developer Guide
-
Amazon Web Services General Reference
If you’re using the service, you’re probably looking for SqsClient and Sqs.
Structs§
- AddPermission
Request - Batch
Result Error Entry Gives a detailed description of the result of an action on each entry in the request.
- Change
Message Visibility Batch Request - Change
Message Visibility Batch Request Entry Encloses a receipt handle and an entry id for each message in
ChangeMessageVisibilityBatch.
All of the following list parameters must be prefixed with
ChangeMessageVisibilityBatchRequestEntry.n
, wheren
is an integer value starting with1
. For example, a parameter list for this action might look like this:&ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2
&ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=your_receipt_handle
&ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45
- Change
Message Visibility Batch Result For each message in the batch, the response contains a
ChangeMessageVisibilityBatchResultEntry
tag if the message succeeds or aBatchResultErrorEntry
tag if the message fails.- Change
Message Visibility Batch Result Entry Encloses the
Id
of an entry inChangeMessageVisibilityBatch.
- Change
Message Visibility Request - Create
Queue Request - Create
Queue Result Returns the
QueueUrl
attribute of the created queue.- Delete
Message Batch Request - Delete
Message Batch Request Entry Encloses a receipt handle and an identifier for it.
- Delete
Message Batch Result For each message in the batch, the response contains a
DeleteMessageBatchResultEntry
tag if the message is deleted or aBatchResultErrorEntry
tag if the message can't be deleted.- Delete
Message Batch Result Entry Encloses the
Id
of an entry inDeleteMessageBatch.
- Delete
Message Request - Delete
Queue Request - GetQueue
Attributes Request - GetQueue
Attributes Result A list of returned queue attributes.
- GetQueue
UrlRequest - GetQueue
UrlResult For more information, see Interpreting Responses in the Amazon Simple Queue Service Developer Guide.
- List
Dead Letter Source Queues Request - List
Dead Letter Source Queues Result A list of your dead letter source queues.
- List
Queue Tags Request - List
Queue Tags Result - List
Queues Request - List
Queues Result A list of your queues.
- Message
An Amazon SQS message.
- Message
Attribute Value The user-specified message attribute value. For string data types, the
Value
attribute has the same restrictions on the content as the message body. For more information, seeSendMessage.
Name
,type
,value
and the message body must not be empty or null. All parts of the message attribute, includingName
,Type
, andValue
, are part of the message size restriction (256 KB or 262,144 bytes).- Message
System Attribute Value The user-specified message system attribute value. For string data types, the
Value
attribute has the same restrictions on the content as the message body. For more information, seeSendMessage.
Name
,type
,value
and the message body must not be empty or null.- Purge
Queue Request - Receive
Message Request - Receive
Message Result A list of received messages.
- Remove
Permission Request - Send
Message Batch Request - Send
Message Batch Request Entry Contains the details of a single Amazon SQS message along with an
Id
.- Send
Message Batch Result For each message in the batch, the response contains a
SendMessageBatchResultEntry
tag if the message succeeds or aBatchResultErrorEntry
tag if the message fails.- Send
Message Batch Result Entry Encloses a
MessageId
for a successfully-enqueued message in aSendMessageBatch.
- Send
Message Request - Send
Message Result The
MD5OfMessageBody
andMessageId
elements.- SetQueue
Attributes Request - SqsClient
- A client for the Amazon SQS API.
- TagQueue
Request - Untag
Queue Request
Enums§
- AddPermission
Error - Errors returned by AddPermission
- Change
Message Visibility Batch Error - Errors returned by ChangeMessageVisibilityBatch
- Change
Message Visibility Error - Errors returned by ChangeMessageVisibility
- Create
Queue Error - Errors returned by CreateQueue
- Delete
Message Batch Error - Errors returned by DeleteMessageBatch
- Delete
Message Error - Errors returned by DeleteMessage
- Delete
Queue Error - Errors returned by DeleteQueue
- GetQueue
Attributes Error - Errors returned by GetQueueAttributes
- GetQueue
UrlError - Errors returned by GetQueueUrl
- List
Dead Letter Source Queues Error - Errors returned by ListDeadLetterSourceQueues
- List
Queue Tags Error - Errors returned by ListQueueTags
- List
Queues Error - Errors returned by ListQueues
- Purge
Queue Error - Errors returned by PurgeQueue
- Receive
Message Error - Errors returned by ReceiveMessage
- Remove
Permission Error - Errors returned by RemovePermission
- Send
Message Batch Error - Errors returned by SendMessageBatch
- Send
Message Error - Errors returned by SendMessage
- SetQueue
Attributes Error - Errors returned by SetQueueAttributes
- TagQueue
Error - Errors returned by TagQueue
- Untag
Queue Error - Errors returned by UntagQueue
Traits§
- Sqs
- Trait representing the capabilities of the Amazon SQS API. Amazon SQS clients implement this trait.