AWS SDK for PHP 3.x

Service ID: sqs

Version: 2012-11-05

This page describes the parameters and results for the operations of the Amazon Simple Queue Service (2012-11-05), and shows how to use the Aws\Sqs\SqsClient object to call the described operations. This documentation is specific to the 2012-11-05 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AddPermission ( array $params = [] )
Adds a permission to a queue for a specific principal.
ChangeMessageVisibility ( array $params = [] )
Changes the visibility timeout of a specified message in a queue to a new value.
ChangeMessageVisibilityBatch ( array $params = [] )
Changes the visibility timeout of multiple messages.
CreateQueue ( array $params = [] )
Creates a new standard or FIFO queue.
DeleteMessage ( array $params = [] )
Deletes the specified message from the specified queue.
DeleteMessageBatch ( array $params = [] )
Deletes up to ten messages from the specified queue.
DeleteQueue ( array $params = [] )
Deletes the queue specified by the QueueUrl, regardless of the queue's contents.
GetQueueAttributes ( array $params = [] )
Gets attributes for the specified queue.
GetQueueUrl ( array $params = [] )
Returns the URL of an existing Amazon SQS queue.
ListDeadLetterSourceQueues ( array $params = [] )
Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead-letter queue.
ListQueueTags ( array $params = [] )
List all cost allocation tags added to the specified Amazon SQS queue.
ListQueues ( array $params = [] )
Returns a list of your queues in the current region.
PurgeQueue ( array $params = [] )
Deletes the messages in a queue specified by the QueueURL parameter.
ReceiveMessage ( array $params = [] )
Retrieves one or more messages (up to 10), from the specified queue.
RemovePermission ( array $params = [] )
Revokes any permissions in the queue policy that matches the specified Label parameter.
SendMessage ( array $params = [] )
Delivers a message to the specified queue.
SendMessageBatch ( array $params = [] )
Delivers up to ten messages to the specified queue.
SetQueueAttributes ( array $params = [] )
Sets the value of one or more queue attributes.
TagQueue ( array $params = [] )
Add cost allocation tags to the specified Amazon SQS queue.
UntagQueue ( array $params = [] )
Remove cost allocation tags from the specified Amazon SQS queue.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListDeadLetterSourceQueues
ListQueues

Waiters

Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:

Waiter name	API Operation	Delay	Max Attempts
QueueExists	GetQueueUrl	5	40

Operations

AddPermission

$result = $client->addPermission([/* ... */]);
$promise = $client->addPermissionAsync([/* ... */]);

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 Allow Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide.

AddPermission generates a policy for you. You can use SetQueueAttributes to upload your policy. For more information, see Using Custom Policies with the Amazon SQS Access Policy Language in the Amazon SQS Developer Guide.
An Amazon SQS policy can have a maximum of 7 actions.
To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.

Some actions take lists of parameters. These lists are 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:

&AttributeName.1=first

&AttributeName.2=second

Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.

Parameter Syntax

$result = $client->addPermission([
    'AWSAccountIds' => ['<string>', ...], // REQUIRED
    'Actions' => ['<string>', ...], // REQUIRED
    'Label' => '<string>', // REQUIRED
    'QueueUrl' => '<string>', // REQUIRED
]);

Parameter Details

Members

AWSAccountIds

Required: Yes
Type: Array of strings

The Amazon Web Services account numbers of the principals who are to receive permission. For information about locating the Amazon Web Services account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer Guide.

Actions

Required: Yes
Type: Array of strings

The action the client wants to allow for the specified principal. Valid values: the name of any action or *.

For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon SQS Developer Guide.

Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.

Label

Required: Yes
Type: string

The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).

QueueUrl

Required: Yes
Type: string

The URL of the Amazon SQS queue to which permissions are added.

Queue URLs and names are case-sensitive.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

OverLimit:
The specified action violates a limit. For example, ReceiveMessage returns this error if the maximum number of inflight messages is reached and AddPermission returns this error if the maximum number of permissions for the queue is reached.

ChangeMessageVisibility

$result = $client->changeMessageVisibility([/* ... */]);
$promise = $client->changeMessageVisibilityAsync([/* ... */]);

Changes the visibility timeout of a specified message in a queue to a new value. The default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The maximum is 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.

For example, you have a message with a visibility timeout of 5 minutes. After 3 minutes, you call ChangeMessageVisibility with a timeout of 10 minutes. You can continue to call ChangeMessageVisibility to extend the visibility timeout to the maximum allowed time. If you try to extend the visibility timeout beyond the maximum, your request is rejected.

An Amazon SQS message has three basic states:

Sent to a queue by a producer.
Received from the queue by a consumer.
Deleted from the queue.

A message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages. A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of inflight messages.

Limits that apply to inflight messages are unrelated to the unlimited number of stored messages.

For most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 inflight messages (received from a queue by a consumer, but not yet deleted from the 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. To request a limit increase, file a support request.

For FIFO queues, there can be a maximum of 20,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.

If you attempt to set the VisibilityTimeout to a value greater than the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically recalculate and increase the timeout to the maximum remaining time.

Unlike with a queue, when you change the visibility timeout for a specific message the timeout value is applied immediately but isn't saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message reverts to the original timeout value (not to the value you set using the ChangeMessageVisibility action) the next time the message is received.

Parameter Syntax

$result = $client->changeMessageVisibility([
    'QueueUrl' => '<string>', // REQUIRED
    'ReceiptHandle' => '<string>', // REQUIRED
    'VisibilityTimeout' => <integer>, // REQUIRED
]);

Parameter Details

Members

QueueUrl

Required: Yes
Type: string

The URL of the Amazon SQS queue whose message's visibility is changed.

Queue URLs and names are case-sensitive.

ReceiptHandle

Required: Yes
Type: string

The receipt handle associated with the message whose visibility timeout is changed. This parameter is returned by the ReceiveMessage action.

VisibilityTimeout

Required: Yes
Type: int

The new value for the message's visibility timeout (in seconds). Values range: 0 to 43200. Maximum: 12 hours.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

MessageNotInflight:
The specified message isn't in flight.
ReceiptHandleIsInvalid:
The specified receipt handle isn't valid.

ChangeMessageVisibilityBatch

$result = $client->changeMessageVisibilityBatch([/* ... */]);
$promise = $client->changeMessageVisibilityBatchAsync([/* ... */]);

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.

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.

&AttributeName.1=first

&AttributeName.2=second

Parameter Syntax

$result = $client->changeMessageVisibilityBatch([
    'Entries' => [ // REQUIRED
        [
            'Id' => '<string>', // REQUIRED
            'ReceiptHandle' => '<string>', // REQUIRED
            'VisibilityTimeout' => <integer>,
        ],
        // ...
    ],
    'QueueUrl' => '<string>', // REQUIRED
]);

Parameter Details

Members

Entries

Required: Yes
Type: Array of ChangeMessageVisibilityBatchRequestEntry structures

A list of receipt handles of the messages for which the visibility timeout must be changed.

QueueUrl

Required: Yes
Type: string

The URL of the Amazon SQS queue whose messages' visibility is changed.

Queue URLs and names are case-sensitive.

Result Syntax

[
    'Failed' => [
        [
            'Code' => '<string>',
            'Id' => '<string>',
            'Message' => '<string>',
            'SenderFault' => true || false,
        ],
        // ...
    ],
    'Successful' => [
        [
            'Id' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

Failed

Required: Yes
Type: Array of BatchResultErrorEntry structures

A list of BatchResultErrorEntry items.

Successful

Required: Yes
Type: Array of ChangeMessageVisibilityBatchResultEntry structures

A list of ChangeMessageVisibilityBatchResultEntry items.

Errors

TooManyEntriesInBatchRequest:
The batch request contains more entries than permissible.
EmptyBatchRequest:
The batch request doesn't contain any entries.
BatchEntryIdsNotDistinct:
Two or more batch entries in the request have the same Id.
InvalidBatchEntryId:
The Id of a batch entry in a batch request doesn't abide by the specification.

CreateQueue

$result = $client->createQueue([/* ... */]);
$promise = $client->createQueueAsync([/* ... */]);

Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following 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 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.

To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues.

After you create a queue, you must wait at least one second after the queue is created to be able to use the queue.

To get the queue URL, use the GetQueueUrl action. GetQueueUrl requires only the QueueName parameter. be aware of existing queue names:

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.

&AttributeName.1=first

&AttributeName.2=second

Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.

Parameter Syntax

$result = $client->createQueue([
    'Attributes' => ['<string>', ...],
    'QueueName' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members

Attributes

Type: Associative array of custom strings keys (QueueAttributeName) to strings

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the CreateQueue action uses:

DelaySeconds – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0.
MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
MessageRetentionPeriod – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days).
Policy – The queue's policy. A valid Amazon Web Services policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies in the Amazon IAM User Guide.
ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.
RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS Developer Guide.
- deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
- maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

The following attributes apply only to server-side-encryption:

KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the Amazon Web Services managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the Key Management Service API Reference.
KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which might incur charges after Free Tier. For more information, see How Does the Data Key Reuse Period Work?.
SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).

The following attributes apply only to FIFO (first-in-first-out) queues:

FifoQueue – Designates a queue as FIFO. Valid values are true and false. If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue. You can provide this attribute only during queue creation. You can't change it for an existing queue. When you set this attribute, you must also provide the MessageGroupId for your messages explicitly.

For more information, see FIFO queue logic in the Amazon SQS Developer Guide.
ContentBasedDeduplication – Enables content-based deduplication. Valid values are true and false. For more information, see Exactly-once processing in the Amazon SQS Developer Guide. Note the following:
- Every message must have a unique MessageDeduplicationId.
  - You may provide a MessageDeduplicationId explicitly.
  - If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
  - If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.
  - If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
- When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.
- If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

The following attributes apply only to high throughput for FIFO queues:

DeduplicationScope – Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue.
FifoThroughputLimit – Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.

To enable high throughput for FIFO queues, do the following:

Set DeduplicationScope to messageGroup.
Set FifoThroughputLimit to perMessageGroupId.

If you set these attributes to anything other than the values shown for enabling high throughput, normal throughput is in effect and deduplication occurs as specified.

For information on throughput quotas, see Quotas related to messages in the Amazon SQS Developer Guide.

QueueName

Required: Yes
Type: string

The name of the new queue. The following limits apply to this name:

A queue name can have up to 80 characters.
Valid values: alphanumeric characters, hyphens (-), and underscores (_).
A FIFO queue name must end with the .fifo suffix.

Queue URLs and names are case-sensitive.

tags

Type: Associative array of custom strings keys (TagKey) to strings

Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide.

When you use queue tags, keep the following guidelines in mind:

Adding more than 50 tags to a queue isn't recommended.
Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
Tags are case-sensitive.
A new tag with a key identical to that of an existing tag overwrites the existing tag.

For a full list of tag restrictions, see Quotas related to queues in the Amazon SQS Developer Guide.

To be able to tag a queue on creation, you must have the sqs:CreateQueue and sqs:TagQueue permissions.

Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.

Result Syntax

[
    'QueueUrl' => '<string>',
]

Result Details

Members

QueueUrl

Type: string

The URL of the created Amazon SQS queue.

Errors

QueueDeletedRecently:
You must wait 60 seconds after deleting a queue before you can create another queue with the same name.
QueueNameExists:
A queue with this name already exists. Amazon SQS returns this error only if the request includes attributes whose values differ from those of the existing queue.

DeleteMessage

$result = $client->deleteMessage([/* ... */]);
$promise = $client->deleteMessageAsync([/* ... */]);

Deletes the specified message from the specified queue. To select the message to delete, use the ReceiptHandle of the message (not the MessageId which you receive when you send the message). Amazon SQS can delete a message from a queue even if a visibility timeout setting causes the message to be locked by another consumer. Amazon SQS automatically deletes messages left in a queue longer than the retention period configured for the queue.

The ReceiptHandle is associated with a specific instance of receiving a message. If you receive a message more than once, the ReceiptHandle is different each time you receive a message. When you use the DeleteMessage action, you must provide the most recently received ReceiptHandle for the message (otherwise, the request succeeds, but the message might not be deleted).

For standard queues, it is possible to receive a message even after you delete it. This might happen on rare occasions if one of the servers which stores a copy of the message is unavailable when you send the request to delete the message. The copy remains on the server and might be returned to you during a subsequent receive request. You should ensure that your application is idempotent, so that receiving a message more than once does not cause issues.

Parameter Syntax

$result = $client->deleteMessage([
    'QueueUrl' => '<string>', // REQUIRED
    'ReceiptHandle' => '<string>', // REQUIRED
]);

Parameter Details

Members

QueueUrl

Required: Yes
Type: string

The URL of the Amazon SQS queue from which messages are deleted.

Queue URLs and names are case-sensitive.

ReceiptHandle

Required: Yes
Type: string

The receipt handle associated with the message to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidIdFormat:
The specified receipt handle isn't valid for the current version.
ReceiptHandleIsInvalid:
The specified receipt handle isn't valid.

DeleteMessageBatch

$result = $client->deleteMessageBatch([/* ... */]);
$promise = $client->deleteMessageBatchAsync([/* ... */]);

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.

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.

&AttributeName.1=first

&AttributeName.2=second

Parameter Syntax

$result = $client->deleteMessageBatch([
    'Entries' => [ // REQUIRED
        [
            'Id' => '<string>', // REQUIRED
            'ReceiptHandle' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'QueueUrl' => '<string>', // REQUIRED
]);

Parameter Details

Members

Entries

Required: Yes
Type: Array of DeleteMessageBatchRequestEntry structures

A list of receipt handles for the messages to be deleted.

QueueUrl

Required: Yes
Type: string

The URL of the Amazon SQS queue from which messages are deleted.

Queue URLs and names are case-sensitive.

Result Syntax

[
    'Failed' => [
        [
            'Code' => '<string>',
            'Id' => '<string>',
            'Message' => '<string>',
            'SenderFault' => true || false,
        ],
        // ...
    ],
    'Successful' => [
        [
            'Id' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

Failed

Required: Yes
Type: Array of BatchResultErrorEntry structures

A list of BatchResultErrorEntry items.

Successful

Required: Yes
Type: Array of DeleteMessageBatchResultEntry structures

A list of DeleteMessageBatchResultEntry items.

Errors

TooManyEntriesInBatchRequest:
The batch request contains more entries than permissible.
EmptyBatchRequest:
The batch request doesn't contain any entries.
BatchEntryIdsNotDistinct:
Two or more batch entries in the request have the same Id.
InvalidBatchEntryId:
The Id of a batch entry in a batch request doesn't abide by the specification.

DeleteQueue

$result = $client->deleteQueue([/* ... */]);
$promise = $client->deleteQueueAsync([/* ... */]);

Deletes the queue specified by the QueueUrl, regardless of the queue's contents.

Be careful with the DeleteQueue action: When you delete a queue, any messages in the queue are no longer available.

When you delete a queue, the deletion process takes up to 60 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.

Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.

Parameter Syntax

$result = $client->deleteQueue([
    'QueueUrl' => '<string>', // REQUIRED
]);

Parameter Details

Members

QueueUrl

Required: Yes
Type: string

The URL of the Amazon SQS queue to delete.

Queue URLs and names are case-sensitive.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

GetQueueAttributes

$result = $client->getQueueAttributes([/* ... */]);
$promise = $client->getQueueAttributesAsync([/* ... */]);

Gets attributes for the specified queue.

To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.

Parameter Syntax

$result = $client->getQueueAttributes([
    'AttributeNames' => ['<string>', ...],
    'QueueUrl' => '<string>', // REQUIRED
]);

Parameter Details

Members

AttributeNames

Type: Array of strings

A list of attributes for which to retrieve information.

The AttributeName.N parameter is optional, but if you don't specify values for this parameter, the request returns empty results.

In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

The following attributes are supported:

The ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, and ApproximateNumberOfMessagesVisible metrics may not achieve consistency until at least 1 minute after the producers stop sending messages. This period is required for the queue metadata to reach eventual consistency.

All – Returns all values.
ApproximateNumberOfMessages – Returns the approximate number of messages available for retrieval from the queue.
ApproximateNumberOfMessagesDelayed – Returns the approximate number of messages in the queue that are delayed and not available for reading immediately. This can happen when the queue is configured as a delay queue or when a message has been sent with a delay parameter.
ApproximateNumberOfMessagesNotVisible – Returns the approximate number of messages that are in flight. Messages are considered to be in flight if they have been sent to a client but have not yet been deleted or have not yet reached the end of their visibility window.
CreatedTimestamp – Returns the time when the queue was created in seconds (epoch time).
DelaySeconds – Returns the default delay on the queue in seconds.
LastModifiedTimestamp – Returns the time when the queue was last changed in seconds (epoch time).
MaximumMessageSize – Returns the limit of how many bytes a message can contain before Amazon SQS rejects it.
MessageRetentionPeriod – Returns the length of time, in seconds, for which Amazon SQS retains a message.
Policy – Returns the policy of the queue.
QueueArn – Returns the Amazon resource name (ARN) of the queue.
ReceiveMessageWaitTimeSeconds – Returns the length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive.
RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS Developer Guide.
- deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
- maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
VisibilityTimeout – Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

The following attributes apply only to server-side-encryption:

KmsMasterKeyId – Returns the ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
KmsDataKeyReusePeriodSeconds – Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. For more information, see How Does the Data Key Reuse Period Work?.
SqsManagedSseEnabled – Returns information about whether the queue is using SSE-SQS encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).

The following attributes apply only to FIFO (first-in-first-out) queues:

FifoQueue – Returns information about whether the queue is FIFO. For more information, see FIFO queue logic in the Amazon SQS Developer Guide.

To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.
ContentBasedDeduplication – Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-once processing in the Amazon SQS Developer Guide.

The following attributes apply only to high throughput for FIFO queues:

DeduplicationScope – Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue.
FifoThroughputLimit – Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.

To enable high throughput for FIFO queues, do the following:

Set DeduplicationScope to messageGroup.
Set FifoThroughputLimit to perMessageGroupId.

If you set these attributes to anything other than the values shown for enabling high throughput, normal throughput is in effect and deduplication occurs as specified.

For information on throughput quotas, see Quotas related to messages in the Amazon SQS Developer Guide.

QueueUrl

Required: Yes
Type: string

The URL of the Amazon SQS queue whose attribute information is retrieved.

Queue URLs and names are case-sensitive.

Result Syntax

[
    'Attributes' => ['<string>', ...],
]

Result Details

Members

Attributes

Type: Associative array of custom strings keys (QueueAttributeName) to strings

A map of attributes to their respective values.

Errors

InvalidAttributeName:
The specified attribute doesn't exist.

GetQueueUrl

$result = $client->getQueueUrl([/* ... */]);
$promise = $client->getQueueUrlAsync([/* ... */]);

Returns the URL of an existing 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 Allow Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide.

Parameter Syntax

$result = $client->getQueueUrl([
    'QueueName' => '<string>', // REQUIRED
    'QueueOwnerAWSAccountId' => '<string>',
]);

Parameter Details

Members

QueueName

Required: Yes
Type: string

The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values: alphanumeric characters, hyphens (-), and underscores (_).

Queue URLs and names are case-sensitive.

QueueOwnerAWSAccountId

Type: string

The Amazon Web Services account ID of the account that created the queue.

Result Syntax

[
    'QueueUrl' => '<string>',
]

Result Details

Members

QueueUrl

Type: string

The URL of the queue.

Errors

QueueDoesNotExist:
The specified queue doesn't exist.

ListDeadLetterSourceQueues

$result = $client->listDeadLetterSourceQueues([/* ... */]);
$promise = $client->listDeadLetterSourceQueuesAsync([/* ... */]);

Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead-letter queue.

The ListDeadLetterSourceQueues methods supports pagination. Set parameter MaxResults in the request to specify the maximum number of results to be returned in the response. If you do not set MaxResults, the response includes a maximum of 1,000 results. If you set MaxResults and there are additional results to display, the response includes a value for NextToken. Use NextToken as a parameter in your next request to ListDeadLetterSourceQueues to receive the next page of results.

For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS Developer Guide.

Parameter Syntax

$result = $client->listDeadLetterSourceQueues([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'QueueUrl' => '<string>', // REQUIRED
]);

Parameter Details

Members

MaxResults

Type: int

Maximum number of results to include in the response. Value range is 1 to 1000. You must set MaxResults to receive a value for NextToken in the response.

NextToken

Type: string

Pagination token to request the next set of results.

QueueUrl

Required: Yes
Type: string

The URL of a dead-letter queue.

Queue URLs and names are case-sensitive.

Result Syntax

[
    'NextToken' => '<string>',
    'queueUrls' => ['<string>', ...],
]

Result Details

Members

NextToken

Type: string

Pagination token to include in the next request. Token value is null if there are no additional results to request, or if you did not set MaxResults in the request.

queueUrls

Required: Yes
Type: Array of strings

A list of source queue URLs that have the RedrivePolicy queue attribute configured with a dead-letter queue.

Errors

QueueDoesNotExist:
The specified queue doesn't exist.

ListQueueTags

$result = $client->listQueueTags([/* ... */]);
$promise = $client->listQueueTagsAsync([/* ... */]);

List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide.

Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.

Parameter Syntax

$result = $client->listQueueTags([
    'QueueUrl' => '<string>', // REQUIRED
]);

Parameter Details

Members

QueueUrl

Required: Yes
Type: string

The URL of the queue.

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Members

Tags

Type: Associative array of custom strings keys (TagKey) to strings

The list of all tags added to the specified queue.

Errors

There are no errors described for this operation.

ListQueues

$result = $client->listQueues([/* ... */]);
$promise = $client->listQueuesAsync([/* ... */]);

Returns a list of your queues in the current region. The response includes a maximum of 1,000 results. If you specify a value for the optional QueueNamePrefix parameter, only queues with a name that begins with the specified value are returned.

The listQueues methods supports pagination. Set parameter MaxResults in the request to specify the maximum number of results to be returned in the response. If you do not set MaxResults, the response includes a maximum of 1,000 results. If you set MaxResults and there are additional results to display, the response includes a value for NextToken. Use NextToken as a parameter in your next request to listQueues to receive the next page of results.

Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.

Parameter Syntax

$result = $client->listQueues([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'QueueNamePrefix' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

Maximum number of results to include in the response. Value range is 1 to 1000. You must set MaxResults to receive a value for NextToken in the response.

NextToken

Type: string

Pagination token to request the next set of results.

QueueNamePrefix

Type: string

A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.

Queue URLs and names are case-sensitive.

Result Syntax

[
    'NextToken' => '<string>',
    'QueueUrls' => ['<string>', ...],
]

Result Details

Members

NextToken

Type: string

Pagination token to include in the next request. Token value is null if there are no additional results to request, or if you did not set MaxResults in the request.

QueueUrls

Type: Array of strings

A list of queue URLs, up to 1,000 entries, or the value of MaxResults that you sent in the request.

Errors

There are no errors described for this operation.

PurgeQueue

$result = $client->purgeQueue([/* ... */]);
$promise = $client->purgeQueueAsync([/* ... */]);

Deletes the messages in a queue specified by the QueueURL parameter.

When you use the PurgeQueue action, you can't retrieve any messages deleted from a queue.

The message deletion process takes up to 60 seconds. We recommend waiting for 60 seconds regardless of your queue's size.

Messages sent to the queue before you call PurgeQueue might be received but are deleted within the next minute.

Messages sent to the queue after you call PurgeQueue might be deleted while the queue is being purged.

Parameter Syntax

$result = $client->purgeQueue([
    'QueueUrl' => '<string>', // REQUIRED
]);

Parameter Details

Members

QueueUrl

Required: Yes
Type: string

The URL of the queue from which the PurgeQueue action deletes messages.

Queue URLs and names are case-sensitive.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

QueueDoesNotExist:
The specified queue doesn't exist.
PurgeQueueInProgress:
Indicates that the specified queue previously received a PurgeQueue request within the last 60 seconds (the time it can take to delete the messages in the queue).

ReceiveMessage

$result = $client->receiveMessage([/* ... */]);
$promise = $client->receiveMessageAsync([/* ... */]);

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

The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide.

You can provide the VisibilityTimeout parameter in your request. The parameter is applied to the messages that Amazon SQS returns in the response. If you don't include the parameter, the overall visibility timeout for the queue is used for the returned messages. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.

A message that isn't deleted or a message whose visibility isn't extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead-letter queue.

In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

Parameter Syntax

$result = $client->receiveMessage([
    'AttributeNames' => ['<string>', ...],
    'MaxNumberOfMessages' => <integer>,
    'MessageAttributeNames' => ['<string>', ...],
    'QueueUrl' => '<string>', // REQUIRED
    'ReceiveRequestAttemptId' => '<string>',
    'VisibilityTimeout' => <integer>,
    'WaitTimeSeconds' => <integer>,
]);

Parameter Details

Members

AttributeNames

Type: Array of strings

A list of attributes that need to be returned along with each message. These attributes include:

All – Returns all values.
ApproximateFirstReceiveTimestamp – Returns the time the message was first received from the queue (epoch time in milliseconds).
ApproximateReceiveCount – Returns the number of times a message has been received across all queues but not deleted.
AWSTraceHeader – Returns the X-Ray trace header string.
SenderId
- For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R.
- For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
SentTimestamp – Returns the time the message was sent to the queue (epoch time in milliseconds).
SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).
MessageDeduplicationId – Returns the value provided by the producer that calls the SendMessage action.
MessageGroupId – Returns the value provided by the producer that calls the SendMessage action. Messages with the same MessageGroupId are returned in sequence.
SequenceNumber – Returns the value provided by Amazon SQS.

MaxNumberOfMessages

Type: int

The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values: 1 to 10. Default: 1.

MessageAttributeNames

Type: Array of strings

The name of the message attribute, where N is the index.

The name can contain alphanumeric characters and the underscore (_), hyphen (-), and period (.).
The name is case-sensitive and must be unique among all attribute names for the message.
The name must not start with AWS-reserved prefixes such as AWS. or Amazon. (or any casing variants).
The name must not start or end with a period (.), and it should not have periods in succession (..).
The name can be up to 256 characters long.

When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying All or .* in your request. You can also use all message attributes starting with a prefix, for example bar.*.

QueueUrl

Required: Yes
Type: string

The URL of the Amazon SQS queue from which messages are received.

Queue URLs and names are case-sensitive.

ReceiveRequestAttemptId

Type: string

This parameter applies only to FIFO (first-in-first-out) queues.

The token used for deduplication of ReceiveMessage calls. If a networking issue occurs after a ReceiveMessage action, and instead of a response you receive a generic error, it is possible to retry the same action with an identical ReceiveRequestAttemptId to retrieve the same set of messages, even if their visibility timeout has not yet expired.

You can use ReceiveRequestAttemptId only for 5 minutes after a ReceiveMessage action.
When you set FifoQueue, a caller of the ReceiveMessage action can provide a ReceiveRequestAttemptId explicitly.
If a caller of the ReceiveMessage action doesn't provide a ReceiveRequestAttemptId, Amazon SQS generates a ReceiveRequestAttemptId.
It is possible to retry the ReceiveMessage action with the same ReceiveRequestAttemptId if none of the messages have been modified (deleted or had their visibility changes).
During a visibility timeout, subsequent calls with the same ReceiveRequestAttemptId return the same messages and receipt handles. If a retry occurs within the deduplication interval, it resets the visibility timeout. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.

If a caller of the ReceiveMessage action still processes messages when the visibility timeout expires and messages become visible, another worker consuming from the same queue can receive the same messages and therefore process duplicates. Also, if a consumer whose message processing time is longer than the visibility timeout tries to delete the processed messages, the action fails with an error.

To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary.
While messages with a particular MessageGroupId are invisible, no more messages belonging to the same MessageGroupId are returned until the visibility timeout expires. You can still receive messages with another MessageGroupId as long as it is also visible.
If a caller of ReceiveMessage can't track the ReceiveRequestAttemptId, no retries work until the original visibility timeout expires. As a result, delays might occur but the messages in the queue remain in a strict order.

The maximum length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).

For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon SQS Developer Guide.

VisibilityTimeout

Type: int

The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.

WaitTimeSeconds

Type: int

The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list of messages.

To avoid HTTP errors, ensure that the HTTP response timeout for ReceiveMessage requests is longer than the WaitTimeSeconds parameter. For example, with the Java SDK, you can set HTTP transport settings using the NettyNioAsyncHttpClient for asynchronous clients, or the ApacheHttpClient for synchronous clients.

Result Syntax

[
    'Messages' => [
        [
            'Attributes' => ['<string>', ...],
            'Body' => '<string>',
            'MD5OfBody' => '<string>',
            'MD5OfMessageAttributes' => '<string>',
            'MessageAttributes' => [
                '<String>' => [
                    'BinaryListValues' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
                    'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'DataType' => '<string>',
                    'StringListValues' => ['<string>', ...],
                    'StringValue' => '<string>',
                ],
                // ...
            ],
            'MessageId' => '<string>',
            'ReceiptHandle' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

Messages

Type: Array of Message structures

A list of messages.

Errors

OverLimit:
The specified action violates a limit. For example, ReceiveMessage returns this error if the maximum number of inflight messages is reached and AddPermission returns this error if the maximum number of permissions for the queue is reached.

RemovePermission

$result = $client->removePermission([/* ... */]);
$promise = $client->removePermissionAsync([/* ... */]);

Revokes any permissions in the queue policy that matches the specified Label parameter.

Only the owner of a queue can remove permissions from it.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.

Parameter Syntax

$result = $client->removePermission([
    'Label' => '<string>', // REQUIRED
    'QueueUrl' => '<string>', // REQUIRED
]);

Parameter Details

Members

Label

Required: Yes
Type: string

The identification of the permission to remove. This is the label added using the AddPermission action.

QueueUrl

Required: Yes
Type: string

The URL of the Amazon SQS queue from which permissions are removed.

Queue URLs and names are case-sensitive.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

SendMessage

$result = $client->sendMessage([/* ... */]);
$promise = $client->sendMessageAsync([/* ... */]);

Delivers a message to the specified queue.

A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:

#x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF

Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.

Parameter Syntax

$result = $client->sendMessage([
    'DelaySeconds' => <integer>,
    'MessageAttributes' => [
        '<String>' => [
            'BinaryListValues' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
            'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
            'DataType' => '<string>', // REQUIRED
            'StringListValues' => ['<string>', ...],
            'StringValue' => '<string>',
        ],
        // ...
    ],
    'MessageBody' => '<string>', // REQUIRED
    'MessageDeduplicationId' => '<string>',
    'MessageGroupId' => '<string>',
    'MessageSystemAttributes' => [
        '<MessageSystemAttributeNameForSends>' => [
            'BinaryListValues' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
            'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
            'DataType' => '<string>', // REQUIRED
            'StringListValues' => ['<string>', ...],
            'StringValue' => '<string>',
        ],
        // ...
    ],
    'QueueUrl' => '<string>', // REQUIRED
]);

Parameter Details

Members

DelaySeconds

Type: int

The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue applies.

When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.

MessageAttributes

Type: Associative array of custom strings keys (String) to MessageAttributeValue structures

Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.

MessageBody

Required: Yes
Type: string

The message to send. The minimum size is one character. The maximum size is 256 KB.

A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:

#x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF

Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.

MessageDeduplicationId

Type: string

This parameter applies only to FIFO (first-in-first-out) queues.

The token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see Exactly-once processing in the Amazon SQS Developer Guide.

Every message must have a unique MessageDeduplicationId,
- You may provide a MessageDeduplicationId explicitly.
- If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
- If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.
- If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

The MessageDeduplicationId is available to the consumer of the message (this can be useful for troubleshooting delivery issues).

If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.

Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.

The maximum length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).

For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon SQS Developer Guide.

MessageGroupId

Type: string

This parameter applies only to FIFO (first-in-first-out) queues.

The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple consumers can process the queue, but the session data of each user is processed in a FIFO fashion.

You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.
ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't specify a MessageGroupId.

The length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).

For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer Guide.

MessageGroupId is required for FIFO queues. You can't use it for Standard queues.

MessageSystemAttributes

Type: Associative array of custom strings keys (MessageSystemAttributeNameForSends) to MessageSystemAttributeValue structures

The message system attribute to send. Each message system attribute consists of a Name, Type, and Value.

Currently, the only supported message system attribute is AWSTraceHeader. Its type must be String and its value must be a correctly formatted X-Ray trace header string.
The size of a message system attribute doesn't count towards the total size of a message.

QueueUrl

Required: Yes
Type: string

The URL of the Amazon SQS queue to which a message is sent.

Queue URLs and names are case-sensitive.

Result Syntax

[
    'MD5OfMessageAttributes' => '<string>',
    'MD5OfMessageBody' => '<string>',
    'MD5OfMessageSystemAttributes' => '<string>',
    'MessageId' => '<string>',
    'SequenceNumber' => '<string>',
]

Result Details

Members

MD5OfMessageAttributes

Type: string

An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

MD5OfMessageBody

Type: string

An MD5 digest of the non-URL-encoded message body string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

MD5OfMessageSystemAttributes

Type: string

An MD5 digest of the non-URL-encoded message system attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest.

MessageId

Type: string

An attribute containing the MessageId of the message sent to the queue. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide.

SequenceNumber

Type: string

This parameter applies only to FIFO (first-in-first-out) queues.

The large, non-consecutive number that Amazon SQS assigns to each message.

The length of SequenceNumber is 128 bits. SequenceNumber continues to increase for a particular MessageGroupId.

Errors

InvalidMessageContents:
The message contains characters outside the allowed set.
UnsupportedOperation:
Error code 400. Unsupported operation.

SendMessageBatch

$result = $client->sendMessageBatch([/* ... */]);
$promise = $client->sendMessageBatchAsync([/* ... */]);

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

A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:

#x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF

Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.

If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses the default value for the queue.

&AttributeName.1=first

&AttributeName.2=second

Parameter Syntax

$result = $client->sendMessageBatch([
    'Entries' => [ // REQUIRED
        [
            'DelaySeconds' => <integer>,
            'Id' => '<string>', // REQUIRED
            'MessageAttributes' => [
                '<String>' => [
                    'BinaryListValues' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
                    'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'DataType' => '<string>', // REQUIRED
                    'StringListValues' => ['<string>', ...],
                    'StringValue' => '<string>',
                ],
                // ...
            ],
            'MessageBody' => '<string>', // REQUIRED
            'MessageDeduplicationId' => '<string>',
            'MessageGroupId' => '<string>',
            'MessageSystemAttributes' => [
                '<MessageSystemAttributeNameForSends>' => [
                    'BinaryListValues' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
                    'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'DataType' => '<string>', // REQUIRED
                    'StringListValues' => ['<string>', ...],
                    'StringValue' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'QueueUrl' => '<string>', // REQUIRED
]);

Parameter Details

Members

Entries

Required: Yes
Type: Array of SendMessageBatchRequestEntry structures

A list of SendMessageBatchRequestEntry items.

QueueUrl

Required: Yes
Type: string

The URL of the Amazon SQS queue to which batched messages are sent.

Queue URLs and names are case-sensitive.

Result Syntax

[
    'Failed' => [
        [
            'Code' => '<string>',
            'Id' => '<string>',
            'Message' => '<string>',
            'SenderFault' => true || false,
        ],
        // ...
    ],
    'Successful' => [
        [
            'Id' => '<string>',
            'MD5OfMessageAttributes' => '<string>',
            'MD5OfMessageBody' => '<string>',
            'MD5OfMessageSystemAttributes' => '<string>',
            'MessageId' => '<string>',
            'SequenceNumber' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

Failed

Required: Yes
Type: Array of BatchResultErrorEntry structures

A list of BatchResultErrorEntry items with error details about each message that can't be enqueued.

Successful

Required: Yes
Type: Array of SendMessageBatchResultEntry structures

A list of SendMessageBatchResultEntry items.

Errors

TooManyEntriesInBatchRequest:
The batch request contains more entries than permissible.
EmptyBatchRequest:
The batch request doesn't contain any entries.
BatchEntryIdsNotDistinct:
Two or more batch entries in the request have the same Id.
BatchRequestTooLong:
The length of all the messages put together is more than the limit.
InvalidBatchEntryId:
The Id of a batch entry in a batch request doesn't abide by the specification.
UnsupportedOperation:
Error code 400. Unsupported operation.

SetQueueAttributes

$result = $client->setQueueAttributes([/* ... */]);
$promise = $client->setQueueAttributesAsync([/* ... */]);

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.

In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.

Parameter Syntax

$result = $client->setQueueAttributes([
    'Attributes' => ['<string>', ...], // REQUIRED
    'QueueUrl' => '<string>', // REQUIRED
]);

Parameter Details

Members

Attributes

Required: Yes
Type: Associative array of custom strings keys (QueueAttributeName) to strings

A map of attributes to set.

The following lists the names, descriptions, and values of the special request parameters that the SetQueueAttributes action uses:

DelaySeconds – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 (15 minutes). Default: 0.
MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
MessageRetentionPeriod – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer representing seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days).
Policy – The queue's policy. A valid Amazon Web Services policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies in the Identity and Access Management User Guide.
ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.
RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS Developer Guide.
- deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
- maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

The following attributes apply only to server-side-encryption:

KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the Key Management Service API Reference.
KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which might incur charges after Free Tier. For more information, see How Does the Data Key Reuse Period Work?.
SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).

The following attribute applies only to FIFO (first-in-first-out) queues:

ContentBasedDeduplication – Enables content-based deduplication. For more information, see Exactly-once processing in the Amazon SQS Developer Guide. Note the following:
- Every message must have a unique MessageDeduplicationId.
  - You may provide a MessageDeduplicationId explicitly.
  - If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
  - If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.
  - If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
- When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.
- If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

The following attributes apply only to high throughput for FIFO queues:

DeduplicationScope – Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue.
FifoThroughputLimit – Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.

To enable high throughput for FIFO queues, do the following:

Set DeduplicationScope to messageGroup.
Set FifoThroughputLimit to perMessageGroupId.

If you set these attributes to anything other than the values shown for enabling high throughput, normal throughput is in effect and deduplication occurs as specified.

For information on throughput quotas, see Quotas related to messages in the Amazon SQS Developer Guide.

QueueUrl

Required: Yes
Type: string

The URL of the Amazon SQS queue whose attributes are set.

Queue URLs and names are case-sensitive.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidAttributeName:
The specified attribute doesn't exist.

TagQueue

$result = $client->tagQueue([/* ... */]);
$promise = $client->tagQueueAsync([/* ... */]);

Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide.

When you use queue tags, keep the following guidelines in mind:

Adding more than 50 tags to a queue isn't recommended.
Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
Tags are case-sensitive.
A new tag with a key identical to that of an existing tag overwrites the existing tag.

For a full list of tag restrictions, see Quotas related to queues in the Amazon SQS Developer Guide.

Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.

Parameter Syntax

$result = $client->tagQueue([
    'QueueUrl' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

QueueUrl

Required: Yes
Type: string

The URL of the queue.

Tags

Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

The list of tags to be added to the specified queue.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

UntagQueue

$result = $client->untagQueue([/* ... */]);
$promise = $client->untagQueueAsync([/* ... */]);

Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide.

Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.

Parameter Syntax

$result = $client->untagQueue([
    'QueueUrl' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

QueueUrl

Required: Yes
Type: string

The URL of the queue.

TagKeys

Required: Yes
Type: Array of strings

The list of tags to be removed from the specified queue.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Shapes

BatchEntryIdsNotDistinct

Description

Two or more batch entries in the request have the same Id.

Members

BatchRequestTooLong

Description

The length of all the messages put together is more than the limit.

Members

BatchResultErrorEntry

Description

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

Members

Code

Required: Yes
Type: string

An error code representing why the action failed on this entry.

Id

Required: Yes
Type: string

The Id of an entry in a batch request.

Message

Type: string

A message explaining why the action failed on this entry.

SenderFault

Required: Yes
Type: boolean

Specifies whether the error happened due to the caller of the batch API action.

ChangeMessageVisibilityBatchRequestEntry

Description

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

Members

Id

Required: Yes
Type: string

An identifier for this particular receipt handle used to communicate the result.

The Ids of a batch request need to be unique within a request.

This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

ReceiptHandle

Required: Yes
Type: string

A receipt handle.

VisibilityTimeout

Type: int

The new value (in seconds) for the message's visibility timeout.

ChangeMessageVisibilityBatchResult

Description

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

Members

Failed

Required: Yes
Type: Array of BatchResultErrorEntry structures

A list of BatchResultErrorEntry items.

Successful

Required: Yes
Type: Array of ChangeMessageVisibilityBatchResultEntry structures

A list of ChangeMessageVisibilityBatchResultEntry items.

ChangeMessageVisibilityBatchResultEntry

Description

Encloses the Id of an entry in ChangeMessageVisibilityBatch.

Members

Id

Required: Yes
Type: string

Represents a message whose visibility timeout has been changed successfully.

CreateQueueResult

Description

Returns the QueueUrl attribute of the created queue.

Members

QueueUrl

Type: string

The URL of the created Amazon SQS queue.

DeleteMessageBatchRequestEntry

Description

Encloses a receipt handle and an identifier for it.

Members

Id

Required: Yes
Type: string

An identifier for this particular receipt handle. This is used to communicate the result.

The Ids of a batch request need to be unique within a request.

This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

ReceiptHandle

Required: Yes
Type: string

A receipt handle.

DeleteMessageBatchResult

Description

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.

Members

Failed

Required: Yes
Type: Array of BatchResultErrorEntry structures

A list of BatchResultErrorEntry items.

Successful

Required: Yes
Type: Array of DeleteMessageBatchResultEntry structures

A list of DeleteMessageBatchResultEntry items.

DeleteMessageBatchResultEntry

Description

Encloses the Id of an entry in DeleteMessageBatch.

Members

Id

Required: Yes
Type: string

Represents a successfully deleted message.

EmptyBatchRequest

Description

The batch request doesn't contain any entries.

Members

GetQueueAttributesResult

Description

A list of returned queue attributes.

Members

Attributes

Type: Associative array of custom strings keys (QueueAttributeName) to strings

A map of attributes to their respective values.

GetQueueUrlResult

Description

For more information, see Interpreting Responses in the Amazon SQS Developer Guide.

Members

QueueUrl

Type: string

Members

NextToken

Type: string

Pagination token to include in the next request. Token value is null if there are no additional results to request, or if you did not set MaxResults in the request.

queueUrls

Required: Yes
Type: Array of strings

A list of source queue URLs that have the RedrivePolicy queue attribute configured with a dead-letter queue.

ListQueueTagsResult

Members

Tags

Type: Associative array of custom strings keys (TagKey) to strings

The list of all tags added to the specified queue.

ListQueuesResult

Description

A list of your queues.

Members

NextToken

Type: string

Pagination token to include in the next request. Token value is null if there are no additional results to request, or if you did not set MaxResults in the request.

QueueUrls

Type: Array of strings

A list of queue URLs, up to 1,000 entries, or the value of MaxResults that you sent in the request.

Message

Description

An Amazon SQS message.

Members

Attributes

Type: Associative array of custom strings keys (MessageSystemAttributeName) to strings

A map of the attributes requested in ReceiveMessage to their respective values. Supported attributes:

ApproximateReceiveCount
ApproximateFirstReceiveTimestamp
MessageDeduplicationId
MessageGroupId
SenderId
SentTimestamp
SequenceNumber

ApproximateFirstReceiveTimestamp and SentTimestamp are each returned as an integer representing the epoch time in milliseconds.

Body

Type: string

The message's contents (not URL-encoded).

MD5OfBody

Type: string

An MD5 digest of the non-URL-encoded message body string.

MD5OfMessageAttributes

Type: string

MessageAttributes

Type: Associative array of custom strings keys (String) to MessageAttributeValue structures

Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.

MessageId

Type: string

A unique identifier for the message. A MessageIdis considered unique across all Amazon Web Services accounts for an extended period of time.

ReceiptHandle

Type: string

An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.

MessageAttributeValue

Description

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

Members

BinaryListValues

Type: Array of blob (string|resource|Psr\Http\Message\StreamInterface)s

Not implemented. Reserved for future use.

BinaryValue

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.

DataType

Required: Yes
Type: string

Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.

You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide.

StringListValues

Type: Array of strings

Not implemented. Reserved for future use.

StringValue

Type: string

Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.

MessageNotInflight

Description

The specified message isn't in flight.

Members

MessageSystemAttributeValue

Description

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.

Members

BinaryListValues

Type: Array of blob (string|resource|Psr\Http\Message\StreamInterface)s

Not implemented. Reserved for future use.

BinaryValue

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.

DataType

Required: Yes
Type: string

Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.

You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide.

StringListValues

Type: Array of strings

Not implemented. Reserved for future use.

StringValue

Type: string

Members

Messages

Type: Array of Message structures

A list of messages.

SendMessageBatchRequestEntry

Description

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

Members

DelaySeconds

Type: int

The length of time, in seconds, for which a specific message is delayed. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue is applied.

When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.

Id

Required: Yes
Type: string

An identifier for a message in this batch used to communicate the result.

The Ids of a batch request need to be unique within a request.

This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

MessageAttributes

Type: Associative array of custom strings keys (String) to MessageAttributeValue structures

Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.

MessageBody

Required: Yes
Type: string

The body of the message.

MessageDeduplicationId

Type: string

This parameter applies only to FIFO (first-in-first-out) queues.

The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are accepted successfully but aren't delivered. For more information, see Exactly-once processing in the Amazon SQS Developer Guide.

Every message must have a unique MessageDeduplicationId,
- You may provide a MessageDeduplicationId explicitly.
- If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
- If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.
- If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

The MessageDeduplicationId is available to the consumer of the message (this can be useful for troubleshooting delivery issues).

Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.

The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).

For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon SQS Developer Guide.

MessageGroupId

Type: string

This parameter applies only to FIFO (first-in-first-out) queues.

You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.
ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't specify a MessageGroupId.

The length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).

For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer Guide.

MessageGroupId is required for FIFO queues. You can't use it for Standard queues.

MessageSystemAttributes

Type: Associative array of custom strings keys (MessageSystemAttributeNameForSends) to MessageSystemAttributeValue structures

The message system attribute to send Each message system attribute consists of a Name, Type, and Value.

Currently, the only supported message system attribute is AWSTraceHeader. Its type must be String and its value must be a correctly formatted X-Ray trace header string.
The size of a message system attribute doesn't count towards the total size of a message.

SendMessageBatchResult

Description

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

Members

Failed

Required: Yes
Type: Array of BatchResultErrorEntry structures

A list of BatchResultErrorEntry items with error details about each message that can't be enqueued.

Successful

Required: Yes
Type: Array of SendMessageBatchResultEntry structures

A list of SendMessageBatchResultEntry items.

SendMessageBatchResultEntry

Description

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

Members

Id

Required: Yes
Type: string

An identifier for the message in this batch.

MD5OfMessageAttributes

Type: string

MD5OfMessageBody

Required: Yes
Type: string

MD5OfMessageSystemAttributes

Type: string

MessageId

Required: Yes
Type: string

An identifier for the message.

SequenceNumber

Type: string

This parameter applies only to FIFO (first-in-first-out) queues.

The large, non-consecutive number that Amazon SQS assigns to each message.

The length of SequenceNumber is 128 bits. As SequenceNumber continues to increase for a particular MessageGroupId.

SendMessageResult

Description

The MD5OfMessageBody and MessageId elements.

Members

MD5OfMessageAttributes

Type: string

MD5OfMessageBody

Type: string

MD5OfMessageSystemAttributes

Type: string

MessageId

Type: string

An attribute containing the MessageId of the message sent to the queue. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide.

SequenceNumber

Type: string

This parameter applies only to FIFO (first-in-first-out) queues.

The large, non-consecutive number that Amazon SQS assigns to each message.

The length of SequenceNumber is 128 bits. SequenceNumber continues to increase for a particular MessageGroupId.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon Simple Queue Service 2012-11-05

Operation Summary

Paginators

Waiters

Operations

AddPermission

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

ChangeMessageVisibility

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

ChangeMessageVisibilityBatch

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateQueue

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteMessage

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteMessageBatch

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteQueue

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

GetQueueAttributes

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetQueueUrl

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListDeadLetterSourceQueues