From 6ed6c121f9144adc71c15a17d626808396e25e00 Mon Sep 17 00:00:00 2001 From: awstools Date: Thu, 2 Jan 2025 19:15:48 +0000 Subject: [PATCH] docs(client-sqs): In-flight message typo fix from 20k to 120k. --- .../src/commands/AddPermissionCommand.ts | 22 ++--- .../commands/CancelMessageMoveTaskCommand.ts | 19 ++--- .../ChangeMessageVisibilityBatchCommand.ts | 25 +++--- .../ChangeMessageVisibilityCommand.ts | 24 +++--- .../src/commands/CreateQueueCommand.ts | 46 +++++------ .../src/commands/DeleteMessageBatchCommand.ts | 25 +++--- .../src/commands/DeleteMessageCommand.ts | 35 ++++---- .../src/commands/DeleteQueueCommand.ts | 22 ++--- .../src/commands/GetQueueAttributesCommand.ts | 22 ++--- .../src/commands/GetQueueUrlCommand.ts | 36 ++++---- .../ListDeadLetterSourceQueuesCommand.ts | 22 ++--- .../commands/ListMessageMoveTasksCommand.ts | 19 ++--- .../src/commands/ListQueueTagsCommand.ts | 22 ++--- .../src/commands/ListQueuesCommand.ts | 19 ++--- .../src/commands/PurgeQueueCommand.ts | 22 ++--- .../src/commands/ReceiveMessageCommand.ts | 40 ++++----- .../src/commands/RemovePermissionCommand.ts | 22 ++--- .../src/commands/SendMessageBatchCommand.ts | 25 +++--- .../src/commands/SendMessageCommand.ts | 22 ++--- .../src/commands/SetQueueAttributesCommand.ts | 22 ++--- .../commands/StartMessageMoveTaskCommand.ts | 19 ++--- .../src/commands/TagQueueCommand.ts | 22 ++--- .../src/commands/UntagQueueCommand.ts | 22 ++--- clients/client-sqs/src/models/models_0.ts | 82 +++++++++++++------ codegen/sdk-codegen/aws-models/sqs.json | 34 ++++---- 25 files changed, 316 insertions(+), 374 deletions(-) diff --git a/clients/client-sqs/src/commands/AddPermissionCommand.ts b/clients/client-sqs/src/commands/AddPermissionCommand.ts index 8c3dec80cdff..c9c59343a4cc 100644 --- a/clients/client-sqs/src/commands/AddPermissionCommand.ts +++ b/clients/client-sqs/src/commands/AddPermissionCommand.ts @@ -91,10 +91,10 @@ export interface AddPermissionCommandOutput extends __MetadataBearer {} * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape. * * @throws {@link InvalidAddress} (client fault) - *

The accountId is invalid.

+ *

The specified ID is invalid.

* * @throws {@link InvalidSecurity} (client fault) - *

When the request to a queue is not HTTPS and SigV4.

+ *

The request was not made over HTTPS or did not use SigV4 for signing.

* * @throws {@link OverLimit} (client fault) *

The specified action violates a limit. For example, ReceiveMessage @@ -103,24 +103,20 @@ export interface AddPermissionCommandOutput extends __MetadataBearer {} * for the queue is reached.

* * @throws {@link QueueDoesNotExist} (client fault) - *

The specified queue doesn't exist.

+ *

Ensure that the QueueUrl is correct and that the queue has not been + * deleted.

* * @throws {@link RequestThrottled} (client fault) *

The request was denied due to request throttling.

* * diff --git a/clients/client-sqs/src/commands/CancelMessageMoveTaskCommand.ts b/clients/client-sqs/src/commands/CancelMessageMoveTaskCommand.ts index 879378044312..05a05d519b72 100644 --- a/clients/client-sqs/src/commands/CancelMessageMoveTaskCommand.ts +++ b/clients/client-sqs/src/commands/CancelMessageMoveTaskCommand.ts @@ -70,27 +70,22 @@ export interface CancelMessageMoveTaskCommandOutput extends CancelMessageMoveTas * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape. * * @throws {@link InvalidAddress} (client fault) - *

The accountId is invalid.

+ *

The specified ID is invalid.

* * @throws {@link InvalidSecurity} (client fault) - *

When the request to a queue is not HTTPS and SigV4.

+ *

The request was not made over HTTPS or did not use SigV4 for signing.

* * @throws {@link RequestThrottled} (client fault) *

The request was denied due to request throttling.

* * diff --git a/clients/client-sqs/src/commands/ChangeMessageVisibilityBatchCommand.ts b/clients/client-sqs/src/commands/ChangeMessageVisibilityBatchCommand.ts index 1783b4c8d113..43b17459ded2 100644 --- a/clients/client-sqs/src/commands/ChangeMessageVisibilityBatchCommand.ts +++ b/clients/client-sqs/src/commands/ChangeMessageVisibilityBatchCommand.ts @@ -93,39 +93,36 @@ export interface ChangeMessageVisibilityBatchCommandOutput *

The batch request doesn't contain any entries.

* * @throws {@link InvalidAddress} (client fault) - *

The accountId is invalid.

+ *

The specified ID is invalid.

* * @throws {@link InvalidBatchEntryId} (client fault) *

The Id of a batch entry in a batch request doesn't abide by the * specification.

* * @throws {@link InvalidSecurity} (client fault) - *

When the request to a queue is not HTTPS and SigV4.

+ *

The request was not made over HTTPS or did not use SigV4 for signing.

* * @throws {@link QueueDoesNotExist} (client fault) - *

The specified queue doesn't exist.

+ *

Ensure that the QueueUrl is correct and that the queue has not been + * deleted.

* * @throws {@link RequestThrottled} (client fault) *

The request was denied due to request throttling.

* * * @throws {@link TooManyEntriesInBatchRequest} (client fault) - *

The batch request contains more entries than permissible.

+ *

The batch request contains more entries than permissible. For Amazon SQS, the + * maximum number of entries you can include in a single SendMessageBatch, DeleteMessageBatch, or ChangeMessageVisibilityBatch request is 10.

* * @throws {@link UnsupportedOperation} (client fault) *

Error code 400. Unsupported operation.

diff --git a/clients/client-sqs/src/commands/ChangeMessageVisibilityCommand.ts b/clients/client-sqs/src/commands/ChangeMessageVisibilityCommand.ts index fdb70000bf68..bb37318c68e2 100644 --- a/clients/client-sqs/src/commands/ChangeMessageVisibilityCommand.ts +++ b/clients/client-sqs/src/commands/ChangeMessageVisibilityCommand.ts @@ -58,7 +58,7 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer { * 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 in flight 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.

+ *

For FIFO queues, there can be a maximum of 120,000 in flight 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 @@ -94,16 +94,17 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer { * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape. * * @throws {@link InvalidAddress} (client fault) - *

The accountId is invalid.

+ *

The specified ID is invalid.

* * @throws {@link InvalidSecurity} (client fault) - *

When the request to a queue is not HTTPS and SigV4.

+ *

The request was not made over HTTPS or did not use SigV4 for signing.

* * @throws {@link MessageNotInflight} (client fault) *

The specified message isn't in flight.

* * @throws {@link QueueDoesNotExist} (client fault) - *

The specified queue doesn't exist.

+ *

Ensure that the QueueUrl is correct and that the queue has not been + * deleted.

* * @throws {@link ReceiptHandleIsInvalid} (client fault) *

The specified receipt handle isn't valid.

@@ -112,18 +113,13 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer { *

The request was denied due to request throttling.

* * diff --git a/clients/client-sqs/src/commands/CreateQueueCommand.ts b/clients/client-sqs/src/commands/CreateQueueCommand.ts index 2a000a83188d..a1e7353b6d82 100644 --- a/clients/client-sqs/src/commands/CreateQueueCommand.ts +++ b/clients/client-sqs/src/commands/CreateQueueCommand.ts @@ -57,22 +57,25 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB *

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:

+ *

To retrieve the URL of a queue, use the + * GetQueueUrl + * action. This action only requires the + * QueueName + * parameter.

+ *

When creating queues, keep the following points in mind:

* * @@ -110,7 +113,7 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape. * * @throws {@link InvalidAddress} (client fault) - *

The accountId is invalid.

+ *

The specified ID is invalid.

* * @throws {@link InvalidAttributeName} (client fault) *

The specified attribute doesn't exist.

@@ -119,7 +122,7 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB *

A queue attribute value is invalid.

* * @throws {@link InvalidSecurity} (client fault) - *

When the request to a queue is not HTTPS and SigV4.

+ *

The request was not made over HTTPS or did not use SigV4 for signing.

* * @throws {@link QueueDeletedRecently} (client fault) *

You must wait 60 seconds after deleting a queue before you can create another queue @@ -133,18 +136,13 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB *

The request was denied due to request throttling.

*
    *
  • - *

    The rate of requests per second exceeds the Amazon Web Services KMS request - * quota for an account and Region.

    + *

    Exceeds the permitted request rate for the queue or for the recipient of the + * request.

    *
    • *
  • - *

    A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."

    - *
    • - *
  • - *

    Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.

    + *

    Ensure that the request rate is within the Amazon SQS limits for + * sending messages. For more information, see Amazon SQS quotas in the Amazon SQS + * Developer Guide.

    *
    • *
* diff --git a/clients/client-sqs/src/commands/DeleteMessageBatchCommand.ts b/clients/client-sqs/src/commands/DeleteMessageBatchCommand.ts index 13ace363122e..9e09b3769fc1 100644 --- a/clients/client-sqs/src/commands/DeleteMessageBatchCommand.ts +++ b/clients/client-sqs/src/commands/DeleteMessageBatchCommand.ts @@ -83,39 +83,36 @@ export interface DeleteMessageBatchCommandOutput extends DeleteMessageBatchResul *

The batch request doesn't contain any entries.

* * @throws {@link InvalidAddress} (client fault) - *

The accountId is invalid.

+ *

The specified ID is invalid.

* * @throws {@link InvalidBatchEntryId} (client fault) *

The Id of a batch entry in a batch request doesn't abide by the * specification.

* * @throws {@link InvalidSecurity} (client fault) - *

When the request to a queue is not HTTPS and SigV4.

+ *

The request was not made over HTTPS or did not use SigV4 for signing.

* * @throws {@link QueueDoesNotExist} (client fault) - *

The specified queue doesn't exist.

+ *

Ensure that the QueueUrl is correct and that the queue has not been + * deleted.

* * @throws {@link RequestThrottled} (client fault) *

The request was denied due to request throttling.

*
    *
  • - *

    The rate of requests per second exceeds the Amazon Web Services KMS request - * quota for an account and Region.

    + *

    Exceeds the permitted request rate for the queue or for the recipient of the + * request.

    *
    • *
  • - *

    A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."

    - *
    • - *
  • - *

    Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.

    + *

    Ensure that the request rate is within the Amazon SQS limits for + * sending messages. For more information, see Amazon SQS quotas in the Amazon SQS + * Developer Guide.

    *
    • *
* * @throws {@link TooManyEntriesInBatchRequest} (client fault) - *

The batch request contains more entries than permissible.

+ *

The batch request contains more entries than permissible. For Amazon SQS, the + * maximum number of entries you can include in a single SendMessageBatch, DeleteMessageBatch, or ChangeMessageVisibilityBatch request is 10.

* * @throws {@link UnsupportedOperation} (client fault) *

Error code 400. Unsupported operation.

diff --git a/clients/client-sqs/src/commands/DeleteMessageCommand.ts b/clients/client-sqs/src/commands/DeleteMessageCommand.ts index 450801618d0c..40b432286046 100644 --- a/clients/client-sqs/src/commands/DeleteMessageCommand.ts +++ b/clients/client-sqs/src/commands/DeleteMessageCommand.ts @@ -35,12 +35,13 @@ export interface DeleteMessageCommandOutput extends __MetadataBearer {} * 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 will not be deleted).

+ *

Each time you receive a message, meaning when a consumer retrieves a message from + * the queue, it comes with a unique ReceiptHandle. If you receive the + * same message more than once, you will get a different ReceiptHandle + * each time. When you want to delete a message using the DeleteMessage + * action, you must use the ReceiptHandle from the most recent time you + * received the message. If you use an old ReceiptHandle, the request will + * succeed, 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. @@ -71,16 +72,17 @@ export interface DeleteMessageCommandOutput extends __MetadataBearer {} * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape. * * @throws {@link InvalidAddress} (client fault) - *

The accountId is invalid.

+ *

The specified ID is invalid.

* * @throws {@link InvalidIdFormat} (client fault) *

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

* * @throws {@link InvalidSecurity} (client fault) - *

When the request to a queue is not HTTPS and SigV4.

+ *

The request was not made over HTTPS or did not use SigV4 for signing.

* * @throws {@link QueueDoesNotExist} (client fault) - *

The specified queue doesn't exist.

+ *

Ensure that the QueueUrl is correct and that the queue has not been + * deleted.

* * @throws {@link ReceiptHandleIsInvalid} (client fault) *

The specified receipt handle isn't valid.

@@ -89,18 +91,13 @@ export interface DeleteMessageCommandOutput extends __MetadataBearer {} *

The request was denied due to request throttling.

*
    *
  • - *

    The rate of requests per second exceeds the Amazon Web Services KMS request - * quota for an account and Region.

    + *

    Exceeds the permitted request rate for the queue or for the recipient of the + * request.

    *
    • *
  • - *

    A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."

    - *
    • - *
  • - *

    Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.

    + *

    Ensure that the request rate is within the Amazon SQS limits for + * sending messages. For more information, see Amazon SQS quotas in the Amazon SQS + * Developer Guide.

    *
    • *
* diff --git a/clients/client-sqs/src/commands/DeleteQueueCommand.ts b/clients/client-sqs/src/commands/DeleteQueueCommand.ts index 29bf00ffd0a1..ff6eabcc75cb 100644 --- a/clients/client-sqs/src/commands/DeleteQueueCommand.ts +++ b/clients/client-sqs/src/commands/DeleteQueueCommand.ts @@ -70,30 +70,26 @@ export interface DeleteQueueCommandOutput extends __MetadataBearer {} * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape. * * @throws {@link InvalidAddress} (client fault) - *

The accountId is invalid.

+ *

The specified ID is invalid.

* * @throws {@link InvalidSecurity} (client fault) - *

When the request to a queue is not HTTPS and SigV4.

+ *

The request was not made over HTTPS or did not use SigV4 for signing.

* * @throws {@link QueueDoesNotExist} (client fault) - *

The specified queue doesn't exist.

+ *

Ensure that the QueueUrl is correct and that the queue has not been + * deleted.

* * @throws {@link RequestThrottled} (client fault) *

The request was denied due to request throttling.

*
    *
  • - *

    The rate of requests per second exceeds the Amazon Web Services KMS request - * quota for an account and Region.

    + *

    Exceeds the permitted request rate for the queue or for the recipient of the + * request.

    *
    • *
  • - *

    A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."

    - *
    • - *
  • - *

    Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.

    + *

    Ensure that the request rate is within the Amazon SQS limits for + * sending messages. For more information, see Amazon SQS quotas in the Amazon SQS + * Developer Guide.

    *
    • *
* diff --git a/clients/client-sqs/src/commands/GetQueueAttributesCommand.ts b/clients/client-sqs/src/commands/GetQueueAttributesCommand.ts index 747d2efa8963..9cf27604e23f 100644 --- a/clients/client-sqs/src/commands/GetQueueAttributesCommand.ts +++ b/clients/client-sqs/src/commands/GetQueueAttributesCommand.ts @@ -61,33 +61,29 @@ export interface GetQueueAttributesCommandOutput extends GetQueueAttributesResul * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape. * * @throws {@link InvalidAddress} (client fault) - *

The accountId is invalid.

+ *

The specified ID is invalid.

* * @throws {@link InvalidAttributeName} (client fault) *

The specified attribute doesn't exist.

* * @throws {@link InvalidSecurity} (client fault) - *

When the request to a queue is not HTTPS and SigV4.

+ *

The request was not made over HTTPS or did not use SigV4 for signing.

* * @throws {@link QueueDoesNotExist} (client fault) - *

The specified queue doesn't exist.

+ *

Ensure that the QueueUrl is correct and that the queue has not been + * deleted.

* * @throws {@link RequestThrottled} (client fault) *

The request was denied due to request throttling.

*
    *
  • - *

    The rate of requests per second exceeds the Amazon Web Services KMS request - * quota for an account and Region.

    + *

    Exceeds the permitted request rate for the queue or for the recipient of the + * request.

    *
    • *
  • - *

    A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."

    - *
    • - *
  • - *

    Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.

    + *

    Ensure that the request rate is within the Amazon SQS limits for + * sending messages. For more information, see Amazon SQS quotas in the Amazon SQS + * Developer Guide.

    *
    • *
* diff --git a/clients/client-sqs/src/commands/GetQueueUrlCommand.ts b/clients/client-sqs/src/commands/GetQueueUrlCommand.ts index 277c768de557..402095fe2ff9 100644 --- a/clients/client-sqs/src/commands/GetQueueUrlCommand.ts +++ b/clients/client-sqs/src/commands/GetQueueUrlCommand.ts @@ -28,14 +28,16 @@ export interface GetQueueUrlCommandInput extends GetQueueUrlRequest {} export interface GetQueueUrlCommandOutput extends GetQueueUrlResult, __MetadataBearer {} /** - *

Returns the URL of an existing Amazon SQS queue.

- *

To access a queue that belongs to another AWS account, use the + *

The GetQueueUrl API returns the URL of an existing Amazon SQS queue. This is + * useful when you know the queue's name but need to retrieve its URL for further + * operations.

+ *

To access a queue owned by another Amazon Web Services 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 + * queue's owner. Note that the queue owner must grant you the necessary permissions to + * access the queue. For more information about accessing shared queues, see the + * * AddPermission - * - * or see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS + * API or Allow developers to write messages to a shared queue in the Amazon SQS * Developer Guide.

* @example * Use a bare-bones client and the command you need to make an API call. @@ -62,30 +64,26 @@ export interface GetQueueUrlCommandOutput extends GetQueueUrlResult, __MetadataB * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape. * * @throws {@link InvalidAddress} (client fault) - *

The accountId is invalid.

+ *

The specified ID is invalid.

* * @throws {@link InvalidSecurity} (client fault) - *

When the request to a queue is not HTTPS and SigV4.

+ *

The request was not made over HTTPS or did not use SigV4 for signing.

* * @throws {@link QueueDoesNotExist} (client fault) - *

The specified queue doesn't exist.

+ *

Ensure that the QueueUrl is correct and that the queue has not been + * deleted.

* * @throws {@link RequestThrottled} (client fault) *

The request was denied due to request throttling.

*
    *
  • - *

    The rate of requests per second exceeds the Amazon Web Services KMS request - * quota for an account and Region.

    + *

    Exceeds the permitted request rate for the queue or for the recipient of the + * request.

    *
    • *
  • - *

    A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."

    - *
    • - *
  • - *

    Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.

    + *

    Ensure that the request rate is within the Amazon SQS limits for + * sending messages. For more information, see Amazon SQS quotas in the Amazon SQS + * Developer Guide.

    *
    • *
* diff --git a/clients/client-sqs/src/commands/ListDeadLetterSourceQueuesCommand.ts b/clients/client-sqs/src/commands/ListDeadLetterSourceQueuesCommand.ts index 9ef138cef353..7723a9018897 100644 --- a/clients/client-sqs/src/commands/ListDeadLetterSourceQueuesCommand.ts +++ b/clients/client-sqs/src/commands/ListDeadLetterSourceQueuesCommand.ts @@ -68,30 +68,26 @@ export interface ListDeadLetterSourceQueuesCommandOutput extends ListDeadLetterS * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape. * * @throws {@link InvalidAddress} (client fault) - *

The accountId is invalid.

+ *

The specified ID is invalid.

* * @throws {@link InvalidSecurity} (client fault) - *

When the request to a queue is not HTTPS and SigV4.

+ *

The request was not made over HTTPS or did not use SigV4 for signing.

* * @throws {@link QueueDoesNotExist} (client fault) - *

The specified queue doesn't exist.

+ *

Ensure that the QueueUrl is correct and that the queue has not been + * deleted.

* * @throws {@link RequestThrottled} (client fault) *

The request was denied due to request throttling.

*
    *
  • - *

    The rate of requests per second exceeds the Amazon Web Services KMS request - * quota for an account and Region.

    + *

    Exceeds the permitted request rate for the queue or for the recipient of the + * request.

    *
    • *
  • - *

    A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."

    - *
    • - *
  • - *

    Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.

    + *

    Ensure that the request rate is within the Amazon SQS limits for + * sending messages. For more information, see Amazon SQS quotas in the Amazon SQS + * Developer Guide.

    *
    • *
* diff --git a/clients/client-sqs/src/commands/ListMessageMoveTasksCommand.ts b/clients/client-sqs/src/commands/ListMessageMoveTasksCommand.ts index 8a717c08dcd1..fb0c2a35d41e 100644 --- a/clients/client-sqs/src/commands/ListMessageMoveTasksCommand.ts +++ b/clients/client-sqs/src/commands/ListMessageMoveTasksCommand.ts @@ -81,27 +81,22 @@ export interface ListMessageMoveTasksCommandOutput extends ListMessageMoveTasksR * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape. * * @throws {@link InvalidAddress} (client fault) - *

The accountId is invalid.

+ *

The specified ID is invalid.

* * @throws {@link InvalidSecurity} (client fault) - *

When the request to a queue is not HTTPS and SigV4.

+ *

The request was not made over HTTPS or did not use SigV4 for signing.

* * @throws {@link RequestThrottled} (client fault) *

The request was denied due to request throttling.

*
    *
  • - *

    The rate of requests per second exceeds the Amazon Web Services KMS request - * quota for an account and Region.

    + *

    Exceeds the permitted request rate for the queue or for the recipient of the + * request.

    *
    • *
  • - *

    A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."

    - *
    • - *
  • - *

    Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.

    + *

    Ensure that the request rate is within the Amazon SQS limits for + * sending messages. For more information, see Amazon SQS quotas in the Amazon SQS + * Developer Guide.

    *
    • *
* diff --git a/clients/client-sqs/src/commands/ListQueueTagsCommand.ts b/clients/client-sqs/src/commands/ListQueueTagsCommand.ts index b0c3b2c0de6a..b2b189f10c96 100644 --- a/clients/client-sqs/src/commands/ListQueueTagsCommand.ts +++ b/clients/client-sqs/src/commands/ListQueueTagsCommand.ts @@ -62,30 +62,26 @@ export interface ListQueueTagsCommandOutput extends ListQueueTagsResult, __Metad * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape. * * @throws {@link InvalidAddress} (client fault) - *

The accountId is invalid.

+ *

The specified ID is invalid.

* * @throws {@link InvalidSecurity} (client fault) - *

When the request to a queue is not HTTPS and SigV4.

+ *

The request was not made over HTTPS or did not use SigV4 for signing.

* * @throws {@link QueueDoesNotExist} (client fault) - *

The specified queue doesn't exist.

+ *

Ensure that the QueueUrl is correct and that the queue has not been + * deleted.

* * @throws {@link RequestThrottled} (client fault) *

The request was denied due to request throttling.

*
    *
  • - *

    The rate of requests per second exceeds the Amazon Web Services KMS request - * quota for an account and Region.

    + *

    Exceeds the permitted request rate for the queue or for the recipient of the + * request.

    *
    • *
  • - *

    A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."

    - *
    • - *
  • - *

    Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.

    + *

    Ensure that the request rate is within the Amazon SQS limits for + * sending messages. For more information, see Amazon SQS quotas in the Amazon SQS + * Developer Guide.

    *
    • *
* diff --git a/clients/client-sqs/src/commands/ListQueuesCommand.ts b/clients/client-sqs/src/commands/ListQueuesCommand.ts index 369547e4cdb2..3ef2b7c82de3 100644 --- a/clients/client-sqs/src/commands/ListQueuesCommand.ts +++ b/clients/client-sqs/src/commands/ListQueuesCommand.ts @@ -73,27 +73,22 @@ export interface ListQueuesCommandOutput extends ListQueuesResult, __MetadataBea * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape. * * @throws {@link InvalidAddress} (client fault) - *

The accountId is invalid.

+ *

The specified ID is invalid.

* * @throws {@link InvalidSecurity} (client fault) - *

When the request to a queue is not HTTPS and SigV4.

+ *

The request was not made over HTTPS or did not use SigV4 for signing.

* * @throws {@link RequestThrottled} (client fault) *

The request was denied due to request throttling.

*
    *
  • - *

    The rate of requests per second exceeds the Amazon Web Services KMS request - * quota for an account and Region.

    + *

    Exceeds the permitted request rate for the queue or for the recipient of the + * request.

    *
    • *
  • - *

    A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."

    - *
    • - *
  • - *

    Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.

    + *

    Ensure that the request rate is within the Amazon SQS limits for + * sending messages. For more information, see Amazon SQS quotas in the Amazon SQS + * Developer Guide.

    *
    • *
* diff --git a/clients/client-sqs/src/commands/PurgeQueueCommand.ts b/clients/client-sqs/src/commands/PurgeQueueCommand.ts index 5b3a78d5026a..2c6e59ce7b44 100644 --- a/clients/client-sqs/src/commands/PurgeQueueCommand.ts +++ b/clients/client-sqs/src/commands/PurgeQueueCommand.ts @@ -63,10 +63,10 @@ export interface PurgeQueueCommandOutput extends __MetadataBearer {} * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape. * * @throws {@link InvalidAddress} (client fault) - *

The accountId is invalid.

+ *

The specified ID is invalid.

* * @throws {@link InvalidSecurity} (client fault) - *

When the request to a queue is not HTTPS and SigV4.

+ *

The request was not made over HTTPS or did not use SigV4 for signing.

* * @throws {@link PurgeQueueInProgress} (client fault) *

Indicates that the specified queue previously received a PurgeQueue @@ -74,24 +74,20 @@ export interface PurgeQueueCommandOutput extends __MetadataBearer {} * queue).

* * @throws {@link QueueDoesNotExist} (client fault) - *

The specified queue doesn't exist.

+ *

Ensure that the QueueUrl is correct and that the queue has not been + * deleted.

* * @throws {@link RequestThrottled} (client fault) *

The request was denied due to request throttling.

*
    *
  • - *

    The rate of requests per second exceeds the Amazon Web Services KMS request - * quota for an account and Region.

    + *

    Exceeds the permitted request rate for the queue or for the recipient of the + * request.

    *
    • *
  • - *

    A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."

    - *
    • - *
  • - *

    Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.

    + *

    Ensure that the request rate is within the Amazon SQS limits for + * sending messages. For more information, see Amazon SQS quotas in the Amazon SQS + * Developer Guide.

    *
    • *
* diff --git a/clients/client-sqs/src/commands/ReceiveMessageCommand.ts b/clients/client-sqs/src/commands/ReceiveMessageCommand.ts index b33a8fbbae94..c74a83ec4502 100644 --- a/clients/client-sqs/src/commands/ReceiveMessageCommand.ts +++ b/clients/client-sqs/src/commands/ReceiveMessageCommand.ts @@ -34,12 +34,12 @@ export interface ReceiveMessageCommandOutput extends ReceiveMessageResult, __Met * 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.

+ * on a ReceiveMessage call. Therefore, 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:

*
    *
  • @@ -68,11 +68,7 @@ export interface ReceiveMessageCommandOutput extends ReceiveMessageResult, __Met *

    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.

    + * returned messages. The default visibility timeout for a queue is 30 seconds.

    * *

    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.

    *     @@ -137,10 +133,10 @@ export interface ReceiveMessageCommandOutput extends ReceiveMessageResult, __Met * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape. * * @throws {@link InvalidAddress} (client fault) - *

    The accountId is invalid.

    + *

    The specified ID is invalid.

    * * @throws {@link InvalidSecurity} (client fault) - *

    When the request to a queue is not HTTPS and SigV4.

    + *

    The request was not made over HTTPS or did not use SigV4 for signing.

    * * @throws {@link KmsAccessDenied} (client fault) *

    The caller doesn't have the required KMS access.

    @@ -183,24 +179,20 @@ export interface ReceiveMessageCommandOutput extends ReceiveMessageResult, __Met * for the queue is reached.

    * * @throws {@link QueueDoesNotExist} (client fault) - *

    The specified queue doesn't exist.

    + *

    Ensure that the QueueUrl is correct and that the queue has not been + * deleted.

    * * @throws {@link RequestThrottled} (client fault) *

    The request was denied due to request throttling.

    *
      *
    • - *

      The rate of requests per second exceeds the Amazon Web Services KMS request - * quota for an account and Region.

      + *

      Exceeds the permitted request rate for the queue or for the recipient of the + * request.

      *
      • *
    • - *

      A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."

      - *
      • - *
    • - *

      Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.

      + *

      Ensure that the request rate is within the Amazon SQS limits for + * sending messages. For more information, see Amazon SQS quotas in the Amazon SQS + * Developer Guide.

      *
      • *
    * diff --git a/clients/client-sqs/src/commands/RemovePermissionCommand.ts b/clients/client-sqs/src/commands/RemovePermissionCommand.ts index 4bec714d40bb..29b722d12447 100644 --- a/clients/client-sqs/src/commands/RemovePermissionCommand.ts +++ b/clients/client-sqs/src/commands/RemovePermissionCommand.ts @@ -68,30 +68,26 @@ export interface RemovePermissionCommandOutput extends __MetadataBearer {} * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape. * * @throws {@link InvalidAddress} (client fault) - *

    The accountId is invalid.

    + *

    The specified ID is invalid.

    * * @throws {@link InvalidSecurity} (client fault) - *

    When the request to a queue is not HTTPS and SigV4.

    + *

    The request was not made over HTTPS or did not use SigV4 for signing.

    * * @throws {@link QueueDoesNotExist} (client fault) - *

    The specified queue doesn't exist.

    + *

    Ensure that the QueueUrl is correct and that the queue has not been + * deleted.

    * * @throws {@link RequestThrottled} (client fault) *

    The request was denied due to request throttling.

    *
      *
    • - *

      The rate of requests per second exceeds the Amazon Web Services KMS request - * quota for an account and Region.

      + *

      Exceeds the permitted request rate for the queue or for the recipient of the + * request.

      *
      • *
    • - *

      A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."

      - *
      • - *
    • - *

      Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.

      + *

      Ensure that the request rate is within the Amazon SQS limits for + * sending messages. For more information, see Amazon SQS quotas in the Amazon SQS + * Developer Guide.

      *
      • *
    * diff --git a/clients/client-sqs/src/commands/SendMessageBatchCommand.ts b/clients/client-sqs/src/commands/SendMessageBatchCommand.ts index 7e05cd500348..30160f788bcd 100644 --- a/clients/client-sqs/src/commands/SendMessageBatchCommand.ts +++ b/clients/client-sqs/src/commands/SendMessageBatchCommand.ts @@ -133,14 +133,14 @@ export interface SendMessageBatchCommandOutput extends SendMessageBatchResult, _ *

    The batch request doesn't contain any entries.

    * * @throws {@link InvalidAddress} (client fault) - *

    The accountId is invalid.

    + *

    The specified ID is invalid.

    * * @throws {@link InvalidBatchEntryId} (client fault) *

    The Id of a batch entry in a batch request doesn't abide by the * specification.

    * * @throws {@link InvalidSecurity} (client fault) - *

    When the request to a queue is not HTTPS and SigV4.

    + *

    The request was not made over HTTPS or did not use SigV4 for signing.

    * * @throws {@link KmsAccessDenied} (client fault) *

    The caller doesn't have the required KMS access.

    @@ -177,29 +177,26 @@ export interface SendMessageBatchCommandOutput extends SendMessageBatchResult, _ *

    Amazon Web Services KMS throttles requests for the following conditions.

    * * @throws {@link QueueDoesNotExist} (client fault) - *

    The specified queue doesn't exist.

    + *

    Ensure that the QueueUrl is correct and that the queue has not been + * deleted.

    * * @throws {@link RequestThrottled} (client fault) *

    The request was denied due to request throttling.

    *
      *
    • - *

      The rate of requests per second exceeds the Amazon Web Services KMS request - * quota for an account and Region.

      + *

      Exceeds the permitted request rate for the queue or for the recipient of the + * request.

      *
      • *
    • - *

      A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."

      - *
      • - *
    • - *

      Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.

      + *

      Ensure that the request rate is within the Amazon SQS limits for + * sending messages. For more information, see Amazon SQS quotas in the Amazon SQS + * Developer Guide.

      *
      • *
    * * @throws {@link TooManyEntriesInBatchRequest} (client fault) - *

    The batch request contains more entries than permissible.

    + *

    The batch request contains more entries than permissible. For Amazon SQS, the + * maximum number of entries you can include in a single SendMessageBatch, DeleteMessageBatch, or ChangeMessageVisibilityBatch request is 10.

    * * @throws {@link UnsupportedOperation} (client fault) *

    Error code 400. Unsupported operation.

    diff --git a/clients/client-sqs/src/commands/SendMessageCommand.ts b/clients/client-sqs/src/commands/SendMessageCommand.ts index 29cd7626efa7..17a33f6a7029 100644 --- a/clients/client-sqs/src/commands/SendMessageCommand.ts +++ b/clients/client-sqs/src/commands/SendMessageCommand.ts @@ -95,13 +95,13 @@ export interface SendMessageCommandOutput extends SendMessageResult, __MetadataB * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape. * * @throws {@link InvalidAddress} (client fault) - *

    The accountId is invalid.

    + *

    The specified ID is invalid.

    * * @throws {@link InvalidMessageContents} (client fault) *

    The message contains characters outside the allowed set.

    * * @throws {@link InvalidSecurity} (client fault) - *

    When the request to a queue is not HTTPS and SigV4.

    + *

    The request was not made over HTTPS or did not use SigV4 for signing.

    * * @throws {@link KmsAccessDenied} (client fault) *

    The caller doesn't have the required KMS access.

    @@ -138,24 +138,20 @@ export interface SendMessageCommandOutput extends SendMessageResult, __MetadataB *

    Amazon Web Services KMS throttles requests for the following conditions.

    * * @throws {@link QueueDoesNotExist} (client fault) - *

    The specified queue doesn't exist.

    + *

    Ensure that the QueueUrl is correct and that the queue has not been + * deleted.

    * * @throws {@link RequestThrottled} (client fault) *

    The request was denied due to request throttling.

    *
      *
    • - *

      The rate of requests per second exceeds the Amazon Web Services KMS request - * quota for an account and Region.

      + *

      Exceeds the permitted request rate for the queue or for the recipient of the + * request.

      *
      • *
    • - *

      A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."

      - *
      • - *
    • - *

      Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.

      + *

      Ensure that the request rate is within the Amazon SQS limits for + * sending messages. For more information, see Amazon SQS quotas in the Amazon SQS + * Developer Guide.

      *
      • *
    * diff --git a/clients/client-sqs/src/commands/SetQueueAttributesCommand.ts b/clients/client-sqs/src/commands/SetQueueAttributesCommand.ts index 2d61d2492f3e..7c20eea33ad2 100644 --- a/clients/client-sqs/src/commands/SetQueueAttributesCommand.ts +++ b/clients/client-sqs/src/commands/SetQueueAttributesCommand.ts @@ -75,7 +75,7 @@ export interface SetQueueAttributesCommandOutput extends __MetadataBearer {} * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape. * * @throws {@link InvalidAddress} (client fault) - *

    The accountId is invalid.

    + *

    The specified ID is invalid.

    * * @throws {@link InvalidAttributeName} (client fault) *

    The specified attribute doesn't exist.

    @@ -84,7 +84,7 @@ export interface SetQueueAttributesCommandOutput extends __MetadataBearer {} *

    A queue attribute value is invalid.

    * * @throws {@link InvalidSecurity} (client fault) - *

    When the request to a queue is not HTTPS and SigV4.

    + *

    The request was not made over HTTPS or did not use SigV4 for signing.

    * * @throws {@link OverLimit} (client fault) *

    The specified action violates a limit. For example, ReceiveMessage @@ -93,24 +93,20 @@ export interface SetQueueAttributesCommandOutput extends __MetadataBearer {} * for the queue is reached.

    * * @throws {@link QueueDoesNotExist} (client fault) - *

    The specified queue doesn't exist.

    + *

    Ensure that the QueueUrl is correct and that the queue has not been + * deleted.

    * * @throws {@link RequestThrottled} (client fault) *

    The request was denied due to request throttling.

    *
      *
    • - *

      The rate of requests per second exceeds the Amazon Web Services KMS request - * quota for an account and Region.

      + *

      Exceeds the permitted request rate for the queue or for the recipient of the + * request.

      *
      • *
    • - *

      A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."

      - *
      • - *
    • - *

      Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.

      + *

      Ensure that the request rate is within the Amazon SQS limits for + * sending messages. For more information, see Amazon SQS quotas in the Amazon SQS + * Developer Guide.

      *
      • *
    * diff --git a/clients/client-sqs/src/commands/StartMessageMoveTaskCommand.ts b/clients/client-sqs/src/commands/StartMessageMoveTaskCommand.ts index f6eaa4efed42..6125377b1a07 100644 --- a/clients/client-sqs/src/commands/StartMessageMoveTaskCommand.ts +++ b/clients/client-sqs/src/commands/StartMessageMoveTaskCommand.ts @@ -76,27 +76,22 @@ export interface StartMessageMoveTaskCommandOutput extends StartMessageMoveTaskR * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape. * * @throws {@link InvalidAddress} (client fault) - *

    The accountId is invalid.

    + *

    The specified ID is invalid.

    * * @throws {@link InvalidSecurity} (client fault) - *

    When the request to a queue is not HTTPS and SigV4.

    + *

    The request was not made over HTTPS or did not use SigV4 for signing.

    * * @throws {@link RequestThrottled} (client fault) *

    The request was denied due to request throttling.

    *
      *
    • - *

      The rate of requests per second exceeds the Amazon Web Services KMS request - * quota for an account and Region.

      + *

      Exceeds the permitted request rate for the queue or for the recipient of the + * request.

      *
      • *
    • - *

      A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."

      - *
      • - *
    • - *

      Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.

      + *

      Ensure that the request rate is within the Amazon SQS limits for + * sending messages. For more information, see Amazon SQS quotas in the Amazon SQS + * Developer Guide.

      *
      • *
    * diff --git a/clients/client-sqs/src/commands/TagQueueCommand.ts b/clients/client-sqs/src/commands/TagQueueCommand.ts index c0c26415ee3b..9cbc18964f74 100644 --- a/clients/client-sqs/src/commands/TagQueueCommand.ts +++ b/clients/client-sqs/src/commands/TagQueueCommand.ts @@ -78,30 +78,26 @@ export interface TagQueueCommandOutput extends __MetadataBearer {} * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape. * * @throws {@link InvalidAddress} (client fault) - *

    The accountId is invalid.

    + *

    The specified ID is invalid.

    * * @throws {@link InvalidSecurity} (client fault) - *

    When the request to a queue is not HTTPS and SigV4.

    + *

    The request was not made over HTTPS or did not use SigV4 for signing.

    * * @throws {@link QueueDoesNotExist} (client fault) - *

    The specified queue doesn't exist.

    + *

    Ensure that the QueueUrl is correct and that the queue has not been + * deleted.

    * * @throws {@link RequestThrottled} (client fault) *

    The request was denied due to request throttling.

    *
      *
    • - *

      The rate of requests per second exceeds the Amazon Web Services KMS request - * quota for an account and Region.

      + *

      Exceeds the permitted request rate for the queue or for the recipient of the + * request.

      *
      • *
    • - *

      A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."

      - *
      • - *
    • - *

      Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.

      + *

      Ensure that the request rate is within the Amazon SQS limits for + * sending messages. For more information, see Amazon SQS quotas in the Amazon SQS + * Developer Guide.

      *
      • *
    * diff --git a/clients/client-sqs/src/commands/UntagQueueCommand.ts b/clients/client-sqs/src/commands/UntagQueueCommand.ts index d5badae2577e..c87ca70700c4 100644 --- a/clients/client-sqs/src/commands/UntagQueueCommand.ts +++ b/clients/client-sqs/src/commands/UntagQueueCommand.ts @@ -60,30 +60,26 @@ export interface UntagQueueCommandOutput extends __MetadataBearer {} * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape. * * @throws {@link InvalidAddress} (client fault) - *

    The accountId is invalid.

    + *

    The specified ID is invalid.

    * * @throws {@link InvalidSecurity} (client fault) - *

    When the request to a queue is not HTTPS and SigV4.

    + *

    The request was not made over HTTPS or did not use SigV4 for signing.

    * * @throws {@link QueueDoesNotExist} (client fault) - *

    The specified queue doesn't exist.

    + *

    Ensure that the QueueUrl is correct and that the queue has not been + * deleted.

    * * @throws {@link RequestThrottled} (client fault) *

    The request was denied due to request throttling.

    *
      *
    • - *

      The rate of requests per second exceeds the Amazon Web Services KMS request - * quota for an account and Region.

      + *

      Exceeds the permitted request rate for the queue or for the recipient of the + * request.

      *
      • *
    • - *

      A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."

      - *
      • - *
    • - *

      Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.

      + *

      Ensure that the request rate is within the Amazon SQS limits for + * sending messages. For more information, see Amazon SQS quotas in the Amazon SQS + * Developer Guide.

      *
      • *
    * diff --git a/clients/client-sqs/src/models/models_0.ts b/clients/client-sqs/src/models/models_0.ts index 38a63f24ce73..41a9c1f53983 100644 --- a/clients/client-sqs/src/models/models_0.ts +++ b/clients/client-sqs/src/models/models_0.ts @@ -48,7 +48,7 @@ export interface AddPermissionRequest { } /** - *

    The accountId is invalid.

    + *

    The specified ID is invalid.

    * @public */ export class InvalidAddress extends __BaseException { @@ -68,7 +68,7 @@ export class InvalidAddress extends __BaseException { } /** - *

    When the request to a queue is not HTTPS and SigV4.

    + *

    The request was not made over HTTPS or did not use SigV4 for signing.

    * @public */ export class InvalidSecurity extends __BaseException { @@ -111,7 +111,8 @@ export class OverLimit extends __BaseException { } /** - *

    The specified queue doesn't exist.

    + *

    Ensure that the QueueUrl is correct and that the queue has not been + * deleted.

    * @public */ export class QueueDoesNotExist extends __BaseException { @@ -134,18 +135,13 @@ export class QueueDoesNotExist extends __BaseException { *

    The request was denied due to request throttling.

    *
      *
    • - *

      The rate of requests per second exceeds the Amazon Web Services KMS request - * quota for an account and Region.

      - *
      • - *
    • - *

      A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."

      + *

      Exceeds the permitted request rate for the queue or for the recipient of the + * request.

      *
      • *
    • - *

      Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.

      + *

      Ensure that the request rate is within the Amazon SQS limits for + * sending messages. For more information, see Amazon SQS quotas in the Amazon SQS + * Developer Guide.

      *
      • *
    * @public @@ -484,7 +480,8 @@ export class InvalidBatchEntryId extends __BaseException { } /** - *

    The batch request contains more entries than permissible.

    + *

    The batch request contains more entries than permissible. For Amazon SQS, the + * maximum number of entries you can include in a single SendMessageBatch, DeleteMessageBatch, or ChangeMessageVisibilityBatch request is 10.

    * @public */ export class TooManyEntriesInBatchRequest extends __BaseException { @@ -1329,21 +1326,23 @@ export interface GetQueueAttributesResult { } /** - *

    + *

    Retrieves the URL of an existing queue based on its name and, optionally, the Amazon Web Services + * account ID.

    * @public */ export interface GetQueueUrlRequest { /** - *

    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.

    + *

    (Required) The name of the queue for which you want to fetch the URL. The name can be + * up to 80 characters long and can include alphanumeric characters, hyphens (-), and + * underscores (_). Queue URLs and names are case-sensitive.

    * @public */ QueueName: string | undefined; /** - *

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

    + *

    (Optional) The Amazon Web Services account ID of the account that created the queue. This is only + * required when you are attempting to access a queue owned by another + * Amazon Web Services account.

    * @public */ QueueOwnerAWSAccountId?: string | undefined; @@ -1793,7 +1792,7 @@ export const MessageSystemAttributeName = { export type MessageSystemAttributeName = (typeof MessageSystemAttributeName)[keyof typeof MessageSystemAttributeName]; /** - *

    + *

    Retrieves one or more messages from a specified queue.

    * @public */ export interface ReceiveMessageRequest { @@ -1808,7 +1807,7 @@ export interface ReceiveMessageRequest { * @deprecated * * - *

    This parameter has been deprecated but will be supported for backward + *

    This parameter has been discontinued but will be supported for backward * compatibility. To provide attribute names, you are encouraged to use * MessageSystemAttributeNames.

    *     @@ -2009,7 +2008,40 @@ export interface ReceiveMessageRequest { /** *

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

    + * retrieve requests after being retrieved by a ReceiveMessage request. If not + * specified, the default visibility timeout for the queue is used, which is 30 + * seconds.

    + *

    Understanding VisibilityTimeout:

    + *
      + *
    • + *

      When a message is received from a queue, it becomes temporarily invisible to + * other consumers for the duration of the visibility timeout. This prevents + * multiple consumers from processing the same message simultaneously. If the + * message is not deleted or its visibility timeout is not extended before the + * timeout expires, it becomes visible again and can be retrieved by other + * consumers.

      + *
      • + *
    • + *

      Setting an appropriate visibility timeout is crucial. If it's too short, the + * message might become visible again before processing is complete, leading to + * duplicate processing. If it's too long, it delays the reprocessing of messages + * if the initial processing fails.

      + *
      • + *
    • + *

      You can adjust the visibility timeout using the + * --visibility-timeout parameter in the + * receive-message command to match the processing time required + * by your application.

      + *
      • + *
    • + *

      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.

      + *
      • + *
    + *

    For more information, see Visibility Timeout in the Amazon SQS Developer + * Guide.

    * @public */ VisibilityTimeout?: number | undefined; @@ -2018,7 +2050,9 @@ export interface ReceiveMessageRequest { *

    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 does not return a message list.

    + * expires, the call does not return a message list. If you are using the Java SDK, it + * returns a ReceiveMessageResponse object, which has a empty list instead of + * a Null object.

    * *

    To avoid HTTP errors, ensure that the HTTP response timeout for * ReceiveMessage requests is longer than the diff --git a/codegen/sdk-codegen/aws-models/sqs.json b/codegen/sdk-codegen/aws-models/sqs.json index 3053c3b7aa01..f4e467ab92b0 100644 --- a/codegen/sdk-codegen/aws-models/sqs.json +++ b/codegen/sdk-codegen/aws-models/sqs.json @@ -1403,7 +1403,7 @@ } ], "traits": { - "smithy.api#documentation": "

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

    \n

    For example, if the default timeout for a queue is 60 seconds, 15 seconds have elapsed\n since you received the message, and you send a ChangeMessageVisibility call with\n VisibilityTimeout set to 10 seconds, the 10 seconds begin to count from\n the time that you make the ChangeMessageVisibility call. Thus, any attempt\n to change the visibility timeout or to delete that message 10 seconds after you\n initially change the visibility timeout (a total of 25 seconds) might result in an\n error.

    \n

    An Amazon SQS message has three basic states:

    \n
      \n
    1. \n

      Sent to a queue by a producer.

      \n
      2. \n
    2. \n

      Received from the queue by a consumer.

      \n
      3. \n
    3. \n

      Deleted from the queue.

      \n
      4. \n
    \n

    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.\n 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 in flight messages.

    \n

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

    \n

    For most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue). \n If you reach this limit, Amazon SQS returns the OverLimit error message.\n 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.\n To request a limit increase, file a support request.

    \n

    For FIFO queues, there can be a maximum of 20,000 in flight 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.

    \n \n

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

    \n

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

    \n     " + "smithy.api#documentation": "

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

    \n

    For example, if the default timeout for a queue is 60 seconds, 15 seconds have elapsed\n since you received the message, and you send a ChangeMessageVisibility call with\n VisibilityTimeout set to 10 seconds, the 10 seconds begin to count from\n the time that you make the ChangeMessageVisibility call. Thus, any attempt\n to change the visibility timeout or to delete that message 10 seconds after you\n initially change the visibility timeout (a total of 25 seconds) might result in an\n error.

    \n

    An Amazon SQS message has three basic states:

    \n
      \n
    1. \n

      Sent to a queue by a producer.

      \n
      2. \n
    2. \n

      Received from the queue by a consumer.

      \n
      3. \n
    3. \n

      Deleted from the queue.

      \n
      4. \n
    \n

    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.\n 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 in flight messages.

    \n

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

    \n

    For most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue). \n If you reach this limit, Amazon SQS returns the OverLimit error message.\n 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.\n To request a limit increase, file a support request.

    \n

    For FIFO queues, there can be a maximum of 120,000 in flight 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.

    \n \n

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

    \n

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

    \n     " } }, "com.amazonaws.sqs#ChangeMessageVisibilityBatch": { @@ -1618,7 +1618,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a new standard or FIFO queue. You can pass one or more attributes in\n the request. Keep the following in mind:

    \n
      \n
    • \n

      If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue.

      \n \n

      You can't change the queue type after you create it and you can't convert\n an existing standard queue into a FIFO queue. You must either create a new\n FIFO queue for your application or delete your existing standard queue and\n recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the\n Amazon SQS Developer Guide.

      \n       \n
      • \n
    • \n

      If you don't provide a value for an attribute, the queue is created with the\n default value for the attribute.

      \n
      • \n
    • \n

      If you delete a queue, you must wait at least 60 seconds before creating a\n queue with the same name.

      \n
      • \n
    \n

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

    \n \n

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

    \n     \n

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

    \n
      \n
    • \n

      If you provide the name of an existing queue along with the exact names and\n values of all the queue's attributes, CreateQueue returns the queue\n URL for the existing queue.

      \n
      • \n
    • \n

      If the queue name, attribute names, or attribute values don't match an\n existing queue, CreateQueue returns an error.

      \n
      • \n
    \n \n

    Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.

    \n     " + "smithy.api#documentation": "

    Creates a new standard or FIFO queue. You can pass one or more attributes in\n the request. Keep the following in mind:

    \n
      \n
    • \n

      If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue.

      \n \n

      You can't change the queue type after you create it and you can't convert\n an existing standard queue into a FIFO queue. You must either create a new\n FIFO queue for your application or delete your existing standard queue and\n recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the\n Amazon SQS Developer Guide.

      \n       \n
      • \n
    • \n

      If you don't provide a value for an attribute, the queue is created with the\n default value for the attribute.

      \n
      • \n
    • \n

      If you delete a queue, you must wait at least 60 seconds before creating a\n queue with the same name.

      \n
      • \n
    \n

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

    \n \n

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

    \n     \n

    To retrieve the URL of a queue, use the \n GetQueueUrl\n action. This action only requires the \n QueueName\n parameter.

    \n

    When creating queues, keep the following points in mind:

    \n
      \n
    • \n

      If you specify the name of an existing queue and provide the exact same names\n and values for all its attributes, the \n CreateQueue\n action will return the URL of the\n existing queue instead of creating a new one.

      \n
      • \n
    • \n

      If you attempt to create a queue with a name that already exists but with\n different attribute names or values, the CreateQueue action will\n return an error. This ensures that existing queues are not inadvertently\n altered.

      \n
      • \n
    \n \n

    Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.

    \n     " } }, "com.amazonaws.sqs#CreateQueueRequest": { @@ -1700,7 +1700,7 @@ } ], "traits": { - "smithy.api#documentation": "

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

    \n \n

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

    \n

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

    \n     " + "smithy.api#documentation": "

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

    \n \n

    Each time you receive a message, meaning when a consumer retrieves a message from\n the queue, it comes with a unique ReceiptHandle. If you receive the\n same message more than once, you will get a different ReceiptHandle\n each time. When you want to delete a message using the DeleteMessage\n action, you must use the ReceiptHandle from the most recent time you\n received the message. If you use an old ReceiptHandle, the request will\n succeed, but the message might not be deleted.

    \n

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

    \n     " } }, "com.amazonaws.sqs#DeleteMessageBatch": { @@ -2032,7 +2032,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Returns the URL of an existing Amazon SQS queue.

    \n

    To access a queue that belongs to another AWS account, use the\n QueueOwnerAWSAccountId parameter to specify the account ID of the\n queue's owner. The queue's owner must grant you permission to access the queue. For more\n information about shared queue access, see \n AddPermission\n \n or see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS\n Developer Guide.

    " + "smithy.api#documentation": "

    The GetQueueUrl API returns the URL of an existing Amazon SQS queue. This is\n useful when you know the queue's name but need to retrieve its URL for further\n operations.

    \n

    To access a queue owned by another Amazon Web Services account, use the\n QueueOwnerAWSAccountId parameter to specify the account ID of the\n queue's owner. Note that the queue owner must grant you the necessary permissions to\n access the queue. For more information about accessing shared queues, see the\n \n AddPermission\n API or Allow developers to write messages to a shared queue in the Amazon SQS\n Developer Guide.

    " } }, "com.amazonaws.sqs#GetQueueUrlRequest": { @@ -2041,19 +2041,19 @@ "QueueName": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

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

    \n

    Queue URLs and names are case-sensitive.

    ", + "smithy.api#documentation": "

    (Required) The name of the queue for which you want to fetch the URL. The name can be\n up to 80 characters long and can include alphanumeric characters, hyphens (-), and\n underscores (_). Queue URLs and names are case-sensitive.

    ", "smithy.api#required": {} } }, "QueueOwnerAWSAccountId": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

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

    " + "smithy.api#documentation": "

    (Optional) The Amazon Web Services account ID of the account that created the queue. This is only\n required when you are attempting to access a queue owned by another\n Amazon Web Services account.

    " } } }, "traits": { - "smithy.api#documentation": "

    ", + "smithy.api#documentation": "

    Retrieves the URL of an existing queue based on its name and, optionally, the Amazon Web Services\n account ID.

    ", "smithy.api#input": {} } }, @@ -2084,7 +2084,7 @@ "code": "InvalidAddress", "httpResponseCode": 404 }, - "smithy.api#documentation": "

    The accountId is invalid.

    ", + "smithy.api#documentation": "

    The specified ID is invalid.

    ", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -2165,7 +2165,7 @@ "code": "InvalidSecurity", "httpResponseCode": 403 }, - "smithy.api#documentation": "

    When the request to a queue is not HTTPS and SigV4.

    ", + "smithy.api#documentation": "

    The request was not made over HTTPS or did not use SigV4 for signing.

    ", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -3225,7 +3225,7 @@ "code": "AWS.SimpleQueueService.NonExistentQueue", "httpResponseCode": 400 }, - "smithy.api#documentation": "

    The specified queue doesn't exist.

    ", + "smithy.api#documentation": "

    Ensure that the QueueUrl is correct and that the queue has not been\n deleted.

    ", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3320,7 +3320,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Retrieves one or more messages (up to 10), from the specified queue. Using the\n WaitTimeSeconds parameter enables long-poll support. For more\n information, see Amazon SQS\n Long Polling in the Amazon SQS Developer Guide.

    \n

    Short poll is the default behavior where a weighted random set of machines is sampled\n on a ReceiveMessage call. Thus, only the messages on the sampled machines\n are returned. If the number of messages in the queue is small (fewer than 1,000), you\n most likely get fewer messages than you requested per ReceiveMessage call.\n If the number of messages in the queue is extremely small, you might not receive any\n messages in a particular ReceiveMessage response. If this happens, repeat\n the request.

    \n

    For each message returned, the response includes the following:

    \n
      \n
    • \n

      The message body.

      \n
      • \n
    • \n

      An MD5 digest of the message body. For information about MD5, see RFC1321.

      \n
      • \n
    • \n

      The MessageId you received when you sent the message to the\n queue.

      \n
      • \n
    • \n

      The receipt handle.

      \n
      • \n
    • \n

      The message attributes.

      \n
      • \n
    • \n

      An MD5 digest of the message attributes.

      \n
      • \n
    \n

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

    \n

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

    \n

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

    \n \n

    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.

    \n     " + "smithy.api#documentation": "

    Retrieves one or more messages (up to 10), from the specified queue. Using the\n WaitTimeSeconds parameter enables long-poll support. For more\n information, see Amazon SQS\n Long Polling in the Amazon SQS Developer Guide.

    \n

    Short poll is the default behavior where a weighted random set of machines is sampled\n on a ReceiveMessage call. Therefore, only the messages on the sampled\n machines are returned. If the number of messages in the queue is small (fewer than\n 1,000), you most likely get fewer messages than you requested per\n ReceiveMessage call. If the number of messages in the queue is\n extremely small, you might not receive any messages in a particular\n ReceiveMessage response. If this happens, repeat the request.

    \n

    For each message returned, the response includes the following:

    \n
      \n
    • \n

      The message body.

      \n
      • \n
    • \n

      An MD5 digest of the message body. For information about MD5, see RFC1321.

      \n
      • \n
    • \n

      The MessageId you received when you sent the message to the\n queue.

      \n
      • \n
    • \n

      The receipt handle.

      \n
      • \n
    • \n

      The message attributes.

      \n
      • \n
    • \n

      An MD5 digest of the message attributes.

      \n
      • \n
    \n

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

    \n

    You can provide the VisibilityTimeout parameter in your request. The\n parameter is applied to the messages that Amazon SQS returns in the response. If you don't\n include the parameter, the overall visibility timeout for the queue is used for the\n returned messages. The default visibility timeout for a queue is 30 seconds.

    \n \n

    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.

    \n     " } }, "com.amazonaws.sqs#ReceiveMessageRequest": { @@ -3339,7 +3339,7 @@ "smithy.api#deprecated": { "message": "AttributeNames has been replaced by MessageSystemAttributeNames" }, - "smithy.api#documentation": "\n

    This parameter has been deprecated but will be supported for backward\n compatibility. To provide attribute names, you are encouraged to use\n MessageSystemAttributeNames.

    \n     \n

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

    \n
      \n
    • \n

      \n All – Returns all values.

      \n
      • \n
    • \n

      \n ApproximateFirstReceiveTimestamp – Returns the time the\n message was first received from the queue (epoch time in\n milliseconds).

      \n
      • \n
    • \n

      \n ApproximateReceiveCount – Returns the number of times a\n message has been received across all queues but not deleted.

      \n
      • \n
    • \n

      \n AWSTraceHeader – Returns the X-Ray trace\n header string.

      \n
      • \n
    • \n

      \n SenderId\n

      \n
        \n
      • \n

        For a user, returns the user ID, for example\n ABCDEFGHI1JKLMNOPQ23R.

        \n
        • \n
      • \n

        For an IAM role, returns the IAM role ID, for example\n ABCDE1F2GH3I4JK5LMNOP:i-a123b456.

        \n
        • \n
      \n
      • \n
    • \n

      \n SentTimestamp – Returns the time the message was sent to the\n queue (epoch time in\n milliseconds).

      \n
      • \n
    • \n

      \n SqsManagedSseEnabled – Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).

      \n
      • \n
    • \n

      \n MessageDeduplicationId – Returns the value provided by the\n producer that calls the \n SendMessage\n \n action.

      \n
      • \n
    • \n

      \n MessageGroupId – Returns the value provided by the\n producer that calls the \n SendMessage\n action.\n Messages with the same MessageGroupId are returned in\n sequence.

      \n
      • \n
    • \n

      \n SequenceNumber – Returns the value provided by\n Amazon SQS.

      \n
      • \n
    ", + "smithy.api#documentation": "\n

    This parameter has been discontinued but will be supported for backward\n compatibility. To provide attribute names, you are encouraged to use\n MessageSystemAttributeNames.

    \n     \n

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

    \n
      \n
    • \n

      \n All – Returns all values.

      \n
      • \n
    • \n

      \n ApproximateFirstReceiveTimestamp – Returns the time the\n message was first received from the queue (epoch time in\n milliseconds).

      \n
      • \n
    • \n

      \n ApproximateReceiveCount – Returns the number of times a\n message has been received across all queues but not deleted.

      \n
      • \n
    • \n

      \n AWSTraceHeader – Returns the X-Ray trace\n header string.

      \n
      • \n
    • \n

      \n SenderId\n

      \n
        \n
      • \n

        For a user, returns the user ID, for example\n ABCDEFGHI1JKLMNOPQ23R.

        \n
        • \n
      • \n

        For an IAM role, returns the IAM role ID, for example\n ABCDE1F2GH3I4JK5LMNOP:i-a123b456.

        \n
        • \n
      \n
      • \n
    • \n

      \n SentTimestamp – Returns the time the message was sent to the\n queue (epoch time in\n milliseconds).

      \n
      • \n
    • \n

      \n SqsManagedSseEnabled – Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).

      \n
      • \n
    • \n

      \n MessageDeduplicationId – Returns the value provided by the\n producer that calls the \n SendMessage\n \n action.

      \n
      • \n
    • \n

      \n MessageGroupId – Returns the value provided by the\n producer that calls the \n SendMessage\n action.\n Messages with the same MessageGroupId are returned in\n sequence.

      \n
      • \n
    • \n

      \n SequenceNumber – Returns the value provided by\n Amazon SQS.

      \n
      • \n
    ", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "AttributeName" } @@ -3369,13 +3369,13 @@ "VisibilityTimeout": { "target": "com.amazonaws.sqs#NullableInteger", "traits": { - "smithy.api#documentation": "

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

    " + "smithy.api#documentation": "

    The duration (in seconds) that the received messages are hidden from subsequent\n retrieve requests after being retrieved by a ReceiveMessage request. If not\n specified, the default visibility timeout for the queue is used, which is 30\n seconds.

    \n

    Understanding VisibilityTimeout:

    \n
      \n
    • \n

      When a message is received from a queue, it becomes temporarily invisible to\n other consumers for the duration of the visibility timeout. This prevents\n multiple consumers from processing the same message simultaneously. If the\n message is not deleted or its visibility timeout is not extended before the\n timeout expires, it becomes visible again and can be retrieved by other\n consumers.

      \n
      • \n
    • \n

      Setting an appropriate visibility timeout is crucial. If it's too short, the\n message might become visible again before processing is complete, leading to\n duplicate processing. If it's too long, it delays the reprocessing of messages\n if the initial processing fails.

      \n
      • \n
    • \n

      You can adjust the visibility timeout using the\n --visibility-timeout parameter in the\n receive-message command to match the processing time required\n by your application.

      \n
      • \n
    • \n

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

      \n
      • \n
    \n

    For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.

    " } }, "WaitTimeSeconds": { "target": "com.amazonaws.sqs#NullableInteger", "traits": { - "smithy.api#documentation": "

    The duration (in seconds) for which the call waits for a message to arrive in the\n queue before returning. If a message is available, the call returns sooner than\n WaitTimeSeconds. If no messages are available and the wait time\n expires, the call does not return a message list.

    \n \n

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

    \n     " + "smithy.api#documentation": "

    The duration (in seconds) for which the call waits for a message to arrive in the\n queue before returning. If a message is available, the call returns sooner than\n WaitTimeSeconds. If no messages are available and the wait time\n expires, the call does not return a message list. If you are using the Java SDK, it\n returns a ReceiveMessageResponse object, which has a empty list instead of\n a Null object.

    \n \n

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

    \n     " } }, "ReceiveRequestAttemptId": { @@ -3386,7 +3386,7 @@ } }, "traits": { - "smithy.api#documentation": "

    ", + "smithy.api#documentation": "

    Retrieves one or more messages from a specified queue.

    ", "smithy.api#input": {} } }, @@ -3471,7 +3471,7 @@ "code": "RequestThrottled", "httpResponseCode": 403 }, - "smithy.api#documentation": "

    The request was denied due to request throttling.

    \n
      \n
    • \n

      The rate of requests per second exceeds the Amazon Web Services KMS request\n quota for an account and Region.

      \n
      • \n
    • \n

      A burst or sustained high rate of requests to change the state of the same KMS\n key. This condition is often known as a \"hot key.\"

      \n
      • \n
    • \n

      Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store\n might be throttled at a lower-than-expected rate when the Amazon Web Services\n CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is\n processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.

      \n
      • \n
    ", + "smithy.api#documentation": "

    The request was denied due to request throttling.

    \n
      \n
    • \n

      Exceeds the permitted request rate for the queue or for the recipient of the\n request.

      \n
      • \n
    • \n

      Ensure that the request rate is within the Amazon SQS limits for\n sending messages. For more information, see Amazon SQS quotas in the Amazon SQS\n Developer Guide.

      \n
      • \n
    ", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -4114,7 +4114,7 @@ "code": "AWS.SimpleQueueService.TooManyEntriesInBatchRequest", "httpResponseCode": 400 }, - "smithy.api#documentation": "

    The batch request contains more entries than permissible.

    ", + "smithy.api#documentation": "

    The batch request contains more entries than permissible. For Amazon SQS, the\n maximum number of entries you can include in a single SendMessageBatch, DeleteMessageBatch, or ChangeMessageVisibilityBatch request is 10.

    ", "smithy.api#error": "client", "smithy.api#httpError": 400 }