logo
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.

For information on the permissions you need to use this API, see Identity and access management in the Amazon Simple Queue Service Developer Guide.

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

If you’re using the service, you’re probably looking for SqsClient and Sqs.

Structs

Gives a detailed description of the result of an action on each entry in the request.

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, where n is an integer value starting with 1. 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

For each message in the batch, the response contains a ChangeMessageVisibilityBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.

Returns the QueueUrl attribute of the created queue.

Encloses a receipt handle and an identifier for it.

For each message in the batch, the response contains a DeleteMessageBatchResultEntry tag if the message is deleted or a BatchResultErrorEntry tag if the message can't be deleted.

Encloses the Id of an entry in DeleteMessageBatch.

A list of returned queue attributes.

For more information, see Interpreting Responses in the Amazon Simple Queue Service Developer Guide.

A list of your dead letter source queues.

A list of your queues.

An Amazon SQS message.

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, see SendMessage.

Name, type, value and the message body must not be empty or null. All parts of the message attribute, including Name, Type, and Value, are part of the message size restriction (256 KB or 262,144 bytes).

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, see SendMessage.

Name, type, value and the message body must not be empty or null.

A list of received messages.

Contains the details of a single Amazon SQS message along with an Id.

For each message in the batch, the response contains a SendMessageBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.

Encloses a MessageId for a successfully-enqueued message in a SendMessageBatch.

The MD5OfMessageBody and MessageId elements.

A client for the Amazon SQS API.

Enums

Errors returned by AddPermission

Errors returned by ChangeMessageVisibilityBatch

Errors returned by ChangeMessageVisibility

Errors returned by CreateQueue

Errors returned by DeleteMessageBatch

Errors returned by DeleteMessage

Errors returned by DeleteQueue

Errors returned by GetQueueAttributes

Errors returned by GetQueueUrl

Errors returned by ListDeadLetterSourceQueues

Errors returned by ListQueueTags

Errors returned by ListQueues

Errors returned by PurgeQueue

Errors returned by ReceiveMessage

Errors returned by RemovePermission

Errors returned by SendMessageBatch

Errors returned by SendMessage

Errors returned by SetQueueAttributes

Errors returned by TagQueue

Errors returned by UntagQueue

Traits

Trait representing the capabilities of the Amazon SQS API. Amazon SQS clients implement this trait.