baiji v0.6.11 Baiji.SQS
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.
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
- [Amazon SQS Product Page](http://aws.amazon.com/sqs/)
- *Amazon SQS Developer Guide*
- [Making API Requests](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/MakingRequestsArticle.html)
- [Using Amazon SQS Message Attributes](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html)
- [Using Amazon SQS Dead Letter Queues](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html)
- *Amazon Web Services General Reference*
- [Regions and Endpoints](http://docs.aws.amazon.com/general/latest/gr/rande.html#sqs_region)
Link to this section Summary
Functions
Returns a map containing the input/output shapes for this endpoint
Outputs values common to all actions
Adds a permission to a queue for a specific principal. This allows sharing access to the queue
Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value is 12 hours. Thus, you can’t extend the timeout of a message in an existing queue to more than a total visibility timeout of 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer Guide
Changes the visibility timeout of multiple messages. This is a batch
version of ChangeMessageVisibility
.
The result of the action on each
message is reported individually in the response. You can send up to 10 ChangeMessageVisibility
requests with each
ChangeMessageVisibilityBatch
action
Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following caveats in mind
Deletes the specified message from the specified queue. You specify the message by using the message’s receipt handle and not the MessageId you receive when you send the message. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue. If you leave a message in the queue for longer than the queue’s configured retention period, Amazon SQS automatically deletes the message
Deletes up to ten messages from the specified queue. This is a batch
version of DeleteMessage
.
The result of the action on each message is
reported individually in the response
Deletes the queue specified by the QueueUrl
, even if the queue is empty.
If the specified queue doesn’t exist, Amazon SQS returns a successful
response
Gets attributes for the specified queue
Returns the URL of an existing queue. This action provides a simple way to retrieve the URL of an Amazon SQS queue
Returns a list of your queues that have the RedrivePolicy
queue attribute
configured with a dead letter queue
Returns a list of your queues. The maximum number of queues that can be
returned is 1,000. If you specify a value for the optional
QueueNamePrefix
parameter, only queues with a name that begins with the
specified value are returned
Deletes the messages in a queue specified by the QueueURL
parameter
Retrieves one or more messages (up to 10), from the specified queue. Using
the WaitTimeSeconds
parameter enables long-poll support. For more
information, see Amazon SQS Long
Polling
in the Amazon SQS Developer Guide
Revokes any permissions in the queue policy that matches the specified
Label
parameter. Only the owner of the queue can remove permissions
Delivers a message to the specified queue
Delivers up to ten messages to the specified queue. This is a batch version
of SendMessage
.
For a FIFO queue, multiple messages within a single
batch are enqueued in the order they are sent
Sets the value of one or more queue attributes. When you change a queue’s
attributes, the change can take up to 60 seconds for most of the attributes
to propagate throughout the Amazon SQS system. Changes made to the
MessageRetentionPeriod
attribute can take up to 15 minutes
Link to this section Functions
Returns a map containing the input/output shapes for this endpoint
Outputs values common to all actions
Adds a permission to a queue for a specific principal. This allows sharing access to the queue.
When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can grant or deny permissions to the queue. For more information about these permissions, see Shared Queues in the Amazon SQS Developer Guide.
Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value is 12 hours. Thus, you can’t extend the timeout of a message in an existing queue to more than a total visibility timeout of 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.
For example, you have a message and with the default visibility timeout of
5 minutes. After 3 minutes, you call ChangeMessageVisiblity
with a
timeout of 10 minutes. At that time, the timeout for the message is
extended by 10 minutes beyond the time of the ChangeMessageVisibility
action. This results in a total visibility timeout of 13 minutes. You can
continue to call the ChangeMessageVisibility
to extend the visibility
timeout to a maximum of 12 hours. If you try to extend the visibility
timeout beyond 12 hours, your request is rejected.
A message is considered to be in flight after it’s received from a queue by a consumer, but not yet deleted from the queue.
For standard queues, there can be a maximum of 120,000 inflight messages
per queue. If you reach this limit, Amazon SQS returns the OverLimit
error message. To avoid reaching the limit, you should delete messages from
the queue after they’re processed. You can also increase the number of
queues you use to process your messages.
For FIFO queues, there can be a maximum of 20,000 inflight messages per queue. If you reach this limit, Amazon SQS returns no error messages.
Changes the visibility timeout of multiple messages. This is a batch
version of ChangeMessageVisibility
.
The result of the action on each
message is reported individually in the response. You can send up to 10 ChangeMessageVisibility
requests with each
ChangeMessageVisibilityBatch
action.
specified using the param.n
notation. Values of n
are integers starting
from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=this
&Attribute.2=that
Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following caveats in mind:
- If you don't specify the `FifoQueue` attribute, Amazon SQS
creates a standard queue.
You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see [ Moving From a Standard Queue to a FIFO Queue](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-moving) in the *Amazon SQS Developer Guide*. - If you don't provide a value for an attribute, the queue is created with the default value for the attribute.
- If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
- If you provide the name of an existing queue along with the exact names and values of all the queue's attributes, `CreateQueue` returns the queue URL for the existing queue.
- If the queue name, attribute names, or attribute values don't match an existing queue, `CreateQueue` returns an error.
Deletes the specified message from the specified queue. You specify the message by using the message’s receipt handle and not the MessageId you receive when you send the message. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue. If you leave a message in the queue for longer than the queue’s configured retention period, Amazon SQS automatically deletes the message.
Deletes up to ten messages from the specified queue. This is a batch
version of DeleteMessage
.
The result of the action on each message is
reported individually in the response.
specified using the param.n
notation. Values of n
are integers starting
from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=this
&Attribute.2=that
Deletes the queue specified by the QueueUrl
, even if the queue is empty.
If the specified queue doesn’t exist, Amazon SQS returns a successful
response.
seconds. Requests you send involving that queue during the 60 seconds might
succeed. For example, a SendMessage
request might succeed, but after
60 seconds the queue and the message you sent no longer exist.
When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
Gets attributes for the specified queue.
specified using the param.n
notation. Values of n
are integers starting
from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=this
&Attribute.2=that
Returns the URL of an existing queue. This action provides a simple way to retrieve the URL of an Amazon SQS queue.
To access a queue that belongs to another AWS account, use the
QueueOwnerAWSAccountId
parameter to specify the account ID of the queue’s
owner. The queue’s owner must grant you permission to access the queue. For
more information about shared queue access, see AddPermission
or see
Shared
Queues
in the Amazon SQS Developer Guide.
Returns a list of your queues that have the RedrivePolicy
queue attribute
configured with a dead letter queue.
For more information about using dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.
Returns a list of your queues. The maximum number of queues that can be
returned is 1,000. If you specify a value for the optional
QueueNamePrefix
parameter, only queues with a name that begins with the
specified value are returned.
Deletes the messages in a queue specified by the QueueURL
parameter.
to 60 seconds. All messages sent to the queue before calling the
PurgeQueue
action are deleted. Messages sent to the queue while it is
being purged might be deleted. While the queue is being purged, messages
sent to the queue before PurgeQueue
is called might be received, but are
deleted within the next minute.
Retrieves one or more messages (up to 10), from the specified queue. Using
the WaitTimeSeconds
parameter enables long-poll support. For more
information, see Amazon SQS Long
Polling
in the Amazon SQS Developer Guide.
Short poll is the default behavior where a weighted random set of machines
is sampled on a ReceiveMessage
call. Thus, only the messages on the
sampled machines are returned. If the number of messages in the queue is
small (fewer than 1,000), you most likely get fewer messages than you
requested per ReceiveMessage
call. If the number of messages in the queue
is extremely small, you might not receive any messages in a particular
ReceiveMessage
response. If this happens, repeat the request.
For each message returned, the response includes the following:
- The message body.
- An MD5 digest of the message body. For information about MD5, see [RFC1321](https://www.ietf.org/rfc/rfc1321.txt).
- The `MessageId` you received when you sent the message to the queue.
- The receipt handle.
- The message attributes.
- An MD5 digest of the message attributes.
Revokes any permissions in the queue policy that matches the specified
Label
parameter. Only the owner of the queue can remove permissions.
Delivers a message to the specified queue.
Delivers up to ten messages to the specified queue. This is a batch version
of SendMessage
.
For a FIFO queue, multiple messages within a single
batch are enqueued in the order they are sent.
The result of sending each message is reported individually in the
response. Because the batch request can result in a combination of
successful and unsuccessful actions, you should check for batch errors even
when the call returns an HTTP status code of 200
.
The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).
entry, Amazon SQS uses the default value for the queue.
Sets the value of one or more queue attributes. When you change a queue’s
attributes, the change can take up to 60 seconds for most of the attributes
to propagate throughout the Amazon SQS system. Changes made to the
MessageRetentionPeriod
attribute can take up to 15 minutes.