Skip to content

Commit

Permalink
docs(client-sqs): In-flight message typo fix from 20k to 120k.
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Jan 2, 2025
1 parent c0288fd commit 6ed6c12
Show file tree
Hide file tree
Showing 25 changed files with 316 additions and 374 deletions.
22 changes: 9 additions & 13 deletions clients/client-sqs/src/commands/AddPermissionCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,10 +91,10 @@ export interface AddPermissionCommandOutput extends __MetadataBearer {}
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
*
* @throws {@link InvalidAddress} (client fault)
* <p>The <code>accountId</code> is invalid.</p>
* <p>The specified ID is invalid.</p>
*
* @throws {@link InvalidSecurity} (client fault)
* <p>When the request to a queue is not HTTPS and SigV4.</p>
* <p>The request was not made over HTTPS or did not use SigV4 for signing.</p>
*
* @throws {@link OverLimit} (client fault)
* <p>The specified action violates a limit. For example, <code>ReceiveMessage</code>
Expand All @@ -103,24 +103,20 @@ export interface AddPermissionCommandOutput extends __MetadataBearer {}
* for the queue is reached.</p>
*
* @throws {@link QueueDoesNotExist} (client fault)
* <p>The specified queue doesn't exist.</p>
* <p>Ensure that the <code>QueueUrl</code> is correct and that the queue has not been
* deleted.</p>
*
* @throws {@link RequestThrottled} (client fault)
* <p>The request was denied due to request throttling.</p>
* <ul>
* <li>
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
* quota for an account and Region. </p>
* <p>Exceeds the permitted request rate for the queue or for the recipient of the
* request.</p>
* </li>
* <li>
* <p>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."</p>
* </li>
* <li>
* <p>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.</p>
* <p>Ensure that the request rate is within the Amazon SQS limits for
* sending messages. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-quotas.html#quotas-requests">Amazon SQS quotas</a> in the <i>Amazon SQS
* Developer Guide</i>.</p>
* </li>
* </ul>
*
Expand Down
19 changes: 7 additions & 12 deletions clients/client-sqs/src/commands/CancelMessageMoveTaskCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,27 +70,22 @@ export interface CancelMessageMoveTaskCommandOutput extends CancelMessageMoveTas
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
*
* @throws {@link InvalidAddress} (client fault)
* <p>The <code>accountId</code> is invalid.</p>
* <p>The specified ID is invalid.</p>
*
* @throws {@link InvalidSecurity} (client fault)
* <p>When the request to a queue is not HTTPS and SigV4.</p>
* <p>The request was not made over HTTPS or did not use SigV4 for signing.</p>
*
* @throws {@link RequestThrottled} (client fault)
* <p>The request was denied due to request throttling.</p>
* <ul>
* <li>
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
* quota for an account and Region. </p>
* <p>Exceeds the permitted request rate for the queue or for the recipient of the
* request.</p>
* </li>
* <li>
* <p>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."</p>
* </li>
* <li>
* <p>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.</p>
* <p>Ensure that the request rate is within the Amazon SQS limits for
* sending messages. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-quotas.html#quotas-requests">Amazon SQS quotas</a> in the <i>Amazon SQS
* Developer Guide</i>.</p>
* </li>
* </ul>
*
Expand Down
25 changes: 11 additions & 14 deletions clients/client-sqs/src/commands/ChangeMessageVisibilityBatchCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,39 +93,36 @@ export interface ChangeMessageVisibilityBatchCommandOutput
* <p>The batch request doesn't contain any entries.</p>
*
* @throws {@link InvalidAddress} (client fault)
* <p>The <code>accountId</code> is invalid.</p>
* <p>The specified ID is invalid.</p>
*
* @throws {@link InvalidBatchEntryId} (client fault)
* <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the
* specification.</p>
*
* @throws {@link InvalidSecurity} (client fault)
* <p>When the request to a queue is not HTTPS and SigV4.</p>
* <p>The request was not made over HTTPS or did not use SigV4 for signing.</p>
*
* @throws {@link QueueDoesNotExist} (client fault)
* <p>The specified queue doesn't exist.</p>
* <p>Ensure that the <code>QueueUrl</code> is correct and that the queue has not been
* deleted.</p>
*
* @throws {@link RequestThrottled} (client fault)
* <p>The request was denied due to request throttling.</p>
* <ul>
* <li>
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
* quota for an account and Region. </p>
* <p>Exceeds the permitted request rate for the queue or for the recipient of the
* request.</p>
* </li>
* <li>
* <p>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."</p>
* </li>
* <li>
* <p>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.</p>
* <p>Ensure that the request rate is within the Amazon SQS limits for
* sending messages. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-quotas.html#quotas-requests">Amazon SQS quotas</a> in the <i>Amazon SQS
* Developer Guide</i>.</p>
* </li>
* </ul>
*
* @throws {@link TooManyEntriesInBatchRequest} (client fault)
* <p>The batch request contains more entries than permissible.</p>
* <p>The batch request contains more entries than permissible. For Amazon SQS, the
* maximum number of entries you can include in a single <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessageBatch.html">SendMessageBatch</a>, <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_DeleteMessageBatch.html">DeleteMessageBatch</a>, or <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ChangeMessageVisibilityBatch.html">ChangeMessageVisibilityBatch</a> request is 10.</p>
*
* @throws {@link UnsupportedOperation} (client fault)
* <p>Error code 400. Unsupported operation.</p>
Expand Down
24 changes: 10 additions & 14 deletions clients/client-sqs/src/commands/ChangeMessageVisibilityCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer {
* If you reach this limit, Amazon SQS returns the <code>OverLimit</code> 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, <a href="https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-sqs">file a support request</a>.</p>
* <p>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.</p>
* <p>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.</p>
* <important>
* <p>If you attempt to set the <code>VisibilityTimeout</code> to a value greater than
* the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically
Expand Down Expand Up @@ -94,16 +94,17 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer {
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
*
* @throws {@link InvalidAddress} (client fault)
* <p>The <code>accountId</code> is invalid.</p>
* <p>The specified ID is invalid.</p>
*
* @throws {@link InvalidSecurity} (client fault)
* <p>When the request to a queue is not HTTPS and SigV4.</p>
* <p>The request was not made over HTTPS or did not use SigV4 for signing.</p>
*
* @throws {@link MessageNotInflight} (client fault)
* <p>The specified message isn't in flight.</p>
*
* @throws {@link QueueDoesNotExist} (client fault)
* <p>The specified queue doesn't exist.</p>
* <p>Ensure that the <code>QueueUrl</code> is correct and that the queue has not been
* deleted.</p>
*
* @throws {@link ReceiptHandleIsInvalid} (client fault)
* <p>The specified receipt handle isn't valid.</p>
Expand All @@ -112,18 +113,13 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer {
* <p>The request was denied due to request throttling.</p>
* <ul>
* <li>
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
* quota for an account and Region. </p>
* <p>Exceeds the permitted request rate for the queue or for the recipient of the
* request.</p>
* </li>
* <li>
* <p>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."</p>
* </li>
* <li>
* <p>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.</p>
* <p>Ensure that the request rate is within the Amazon SQS limits for
* sending messages. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-quotas.html#quotas-requests">Amazon SQS quotas</a> in the <i>Amazon SQS
* Developer Guide</i>.</p>
* </li>
* </ul>
*
Expand Down
46 changes: 22 additions & 24 deletions clients/client-sqs/src/commands/CreateQueueCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,22 +57,25 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB
* <p>After you create a queue, you must wait at least one second after the queue is
* created to be able to use the queue.</p>
* </note>
* <p>To get the queue URL, use the <code>
* <a>GetQueueUrl</a>
* </code> action.
* <code>
* <a>GetQueueUrl</a>
* </code> requires only the
* <code>QueueName</code> parameter. be aware of existing queue names:</p>
* <p>To retrieve the URL of a queue, use the <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_GetQueueUrl.html">
* <code>GetQueueUrl</code>
* </a> action. This action only requires the <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html#API_CreateQueue_RequestSyntax">
* <code>QueueName</code>
* </a> parameter.</p>
* <p>When creating queues, keep the following points in mind:</p>
* <ul>
* <li>
* <p>If you provide the name of an existing queue along with the exact names and
* values of all the queue's attributes, <code>CreateQueue</code> returns the queue
* URL for the existing queue.</p>
* <p>If you specify the name of an existing queue and provide the exact same names
* and values for all its attributes, the <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html">
* <code>CreateQueue</code>
* </a> action will return the URL of the
* existing queue instead of creating a new one.</p>
* </li>
* <li>
* <p>If the queue name, attribute names, or attribute values don't match an
* existing queue, <code>CreateQueue</code> returns an error.</p>
* <p>If you attempt to create a queue with a name that already exists but with
* different attribute names or values, the <code>CreateQueue</code> action will
* return an error. This ensures that existing queues are not inadvertently
* altered.</p>
* </li>
* </ul>
* <note>
Expand Down Expand Up @@ -110,7 +113,7 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
*
* @throws {@link InvalidAddress} (client fault)
* <p>The <code>accountId</code> is invalid.</p>
* <p>The specified ID is invalid.</p>
*
* @throws {@link InvalidAttributeName} (client fault)
* <p>The specified attribute doesn't exist.</p>
Expand All @@ -119,7 +122,7 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB
* <p>A queue attribute value is invalid.</p>
*
* @throws {@link InvalidSecurity} (client fault)
* <p>When the request to a queue is not HTTPS and SigV4.</p>
* <p>The request was not made over HTTPS or did not use SigV4 for signing.</p>
*
* @throws {@link QueueDeletedRecently} (client fault)
* <p>You must wait 60 seconds after deleting a queue before you can create another queue
Expand All @@ -133,18 +136,13 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB
* <p>The request was denied due to request throttling.</p>
* <ul>
* <li>
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
* quota for an account and Region. </p>
* <p>Exceeds the permitted request rate for the queue or for the recipient of the
* request.</p>
* </li>
* <li>
* <p>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."</p>
* </li>
* <li>
* <p>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.</p>
* <p>Ensure that the request rate is within the Amazon SQS limits for
* sending messages. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-quotas.html#quotas-requests">Amazon SQS quotas</a> in the <i>Amazon SQS
* Developer Guide</i>.</p>
* </li>
* </ul>
*
Expand Down
25 changes: 11 additions & 14 deletions clients/client-sqs/src/commands/DeleteMessageBatchCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,39 +83,36 @@ export interface DeleteMessageBatchCommandOutput extends DeleteMessageBatchResul
* <p>The batch request doesn't contain any entries.</p>
*
* @throws {@link InvalidAddress} (client fault)
* <p>The <code>accountId</code> is invalid.</p>
* <p>The specified ID is invalid.</p>
*
* @throws {@link InvalidBatchEntryId} (client fault)
* <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the
* specification.</p>
*
* @throws {@link InvalidSecurity} (client fault)
* <p>When the request to a queue is not HTTPS and SigV4.</p>
* <p>The request was not made over HTTPS or did not use SigV4 for signing.</p>
*
* @throws {@link QueueDoesNotExist} (client fault)
* <p>The specified queue doesn't exist.</p>
* <p>Ensure that the <code>QueueUrl</code> is correct and that the queue has not been
* deleted.</p>
*
* @throws {@link RequestThrottled} (client fault)
* <p>The request was denied due to request throttling.</p>
* <ul>
* <li>
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
* quota for an account and Region. </p>
* <p>Exceeds the permitted request rate for the queue or for the recipient of the
* request.</p>
* </li>
* <li>
* <p>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."</p>
* </li>
* <li>
* <p>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.</p>
* <p>Ensure that the request rate is within the Amazon SQS limits for
* sending messages. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-quotas.html#quotas-requests">Amazon SQS quotas</a> in the <i>Amazon SQS
* Developer Guide</i>.</p>
* </li>
* </ul>
*
* @throws {@link TooManyEntriesInBatchRequest} (client fault)
* <p>The batch request contains more entries than permissible.</p>
* <p>The batch request contains more entries than permissible. For Amazon SQS, the
* maximum number of entries you can include in a single <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessageBatch.html">SendMessageBatch</a>, <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_DeleteMessageBatch.html">DeleteMessageBatch</a>, or <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ChangeMessageVisibilityBatch.html">ChangeMessageVisibilityBatch</a> request is 10.</p>
*
* @throws {@link UnsupportedOperation} (client fault)
* <p>Error code 400. Unsupported operation.</p>
Expand Down
Loading

0 comments on commit 6ed6c12

Please sign in to comment.