Skip to content

Commit 6ed6c12

Browse files
author
awstools
committed
docs(client-sqs): In-flight message typo fix from 20k to 120k.
1 parent c0288fd commit 6ed6c12

25 files changed

+316
-374
lines changed

‎clients/client-sqs/src/commands/AddPermissionCommand.ts

+9-13
Original file line numberDiff line numberDiff line change
@@ -91,10 +91,10 @@ export interface AddPermissionCommandOutput extends __MetadataBearer {}
9191
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
9292
*
9393
* @throws {@link InvalidAddress} (client fault)
94-
* <p>The <code>accountId</code> is invalid.</p>
94+
* <p>The specified ID is invalid.</p>
9595
*
9696
* @throws {@link InvalidSecurity} (client fault)
97-
* <p>When the request to a queue is not HTTPS and SigV4.</p>
97+
* <p>The request was not made over HTTPS or did not use SigV4 for signing.</p>
9898
*
9999
* @throws {@link OverLimit} (client fault)
100100
* <p>The specified action violates a limit. For example, <code>ReceiveMessage</code>
@@ -103,24 +103,20 @@ export interface AddPermissionCommandOutput extends __MetadataBearer {}
103103
* for the queue is reached.</p>
104104
*
105105
* @throws {@link QueueDoesNotExist} (client fault)
106-
* <p>The specified queue doesn't exist.</p>
106+
* <p>Ensure that the <code>QueueUrl</code> is correct and that the queue has not been
107+
* deleted.</p>
107108
*
108109
* @throws {@link RequestThrottled} (client fault)
109110
* <p>The request was denied due to request throttling.</p>
110111
* <ul>
111112
* <li>
112-
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
113-
* quota for an account and Region. </p>
113+
* <p>Exceeds the permitted request rate for the queue or for the recipient of the
114+
* request.</p>
114115
* </li>
115116
* <li>
116-
* <p>A burst or sustained high rate of requests to change the state of the same KMS
117-
* key. This condition is often known as a "hot key."</p>
118-
* </li>
119-
* <li>
120-
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
121-
* might be throttled at a lower-than-expected rate when the Amazon Web Services
122-
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
123-
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
117+
* <p>Ensure that the request rate is within the Amazon SQS limits for
118+
* 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
119+
* Developer Guide</i>.</p>
124120
* </li>
125121
* </ul>
126122
*

‎clients/client-sqs/src/commands/CancelMessageMoveTaskCommand.ts

+7-12
Original file line numberDiff line numberDiff line change
@@ -70,27 +70,22 @@ export interface CancelMessageMoveTaskCommandOutput extends CancelMessageMoveTas
7070
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
7171
*
7272
* @throws {@link InvalidAddress} (client fault)
73-
* <p>The <code>accountId</code> is invalid.</p>
73+
* <p>The specified ID is invalid.</p>
7474
*
7575
* @throws {@link InvalidSecurity} (client fault)
76-
* <p>When the request to a queue is not HTTPS and SigV4.</p>
76+
* <p>The request was not made over HTTPS or did not use SigV4 for signing.</p>
7777
*
7878
* @throws {@link RequestThrottled} (client fault)
7979
* <p>The request was denied due to request throttling.</p>
8080
* <ul>
8181
* <li>
82-
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
83-
* quota for an account and Region. </p>
82+
* <p>Exceeds the permitted request rate for the queue or for the recipient of the
83+
* request.</p>
8484
* </li>
8585
* <li>
86-
* <p>A burst or sustained high rate of requests to change the state of the same KMS
87-
* key. This condition is often known as a "hot key."</p>
88-
* </li>
89-
* <li>
90-
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
91-
* might be throttled at a lower-than-expected rate when the Amazon Web Services
92-
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
93-
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
86+
* <p>Ensure that the request rate is within the Amazon SQS limits for
87+
* 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
88+
* Developer Guide</i>.</p>
9489
* </li>
9590
* </ul>
9691
*

‎clients/client-sqs/src/commands/ChangeMessageVisibilityBatchCommand.ts

+11-14
Original file line numberDiff line numberDiff line change
@@ -93,39 +93,36 @@ export interface ChangeMessageVisibilityBatchCommandOutput
9393
* <p>The batch request doesn't contain any entries.</p>
9494
*
9595
* @throws {@link InvalidAddress} (client fault)
96-
* <p>The <code>accountId</code> is invalid.</p>
96+
* <p>The specified ID is invalid.</p>
9797
*
9898
* @throws {@link InvalidBatchEntryId} (client fault)
9999
* <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the
100100
* specification.</p>
101101
*
102102
* @throws {@link InvalidSecurity} (client fault)
103-
* <p>When the request to a queue is not HTTPS and SigV4.</p>
103+
* <p>The request was not made over HTTPS or did not use SigV4 for signing.</p>
104104
*
105105
* @throws {@link QueueDoesNotExist} (client fault)
106-
* <p>The specified queue doesn't exist.</p>
106+
* <p>Ensure that the <code>QueueUrl</code> is correct and that the queue has not been
107+
* deleted.</p>
107108
*
108109
* @throws {@link RequestThrottled} (client fault)
109110
* <p>The request was denied due to request throttling.</p>
110111
* <ul>
111112
* <li>
112-
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
113-
* quota for an account and Region. </p>
113+
* <p>Exceeds the permitted request rate for the queue or for the recipient of the
114+
* request.</p>
114115
* </li>
115116
* <li>
116-
* <p>A burst or sustained high rate of requests to change the state of the same KMS
117-
* key. This condition is often known as a "hot key."</p>
118-
* </li>
119-
* <li>
120-
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
121-
* might be throttled at a lower-than-expected rate when the Amazon Web Services
122-
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
123-
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
117+
* <p>Ensure that the request rate is within the Amazon SQS limits for
118+
* 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
119+
* Developer Guide</i>.</p>
124120
* </li>
125121
* </ul>
126122
*
127123
* @throws {@link TooManyEntriesInBatchRequest} (client fault)
128-
* <p>The batch request contains more entries than permissible.</p>
124+
* <p>The batch request contains more entries than permissible. For Amazon SQS, the
125+
* 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>
129126
*
130127
* @throws {@link UnsupportedOperation} (client fault)
131128
* <p>Error code 400. Unsupported operation.</p>

‎clients/client-sqs/src/commands/ChangeMessageVisibilityCommand.ts

+10-14
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer {
5858
* If you reach this limit, Amazon SQS returns the <code>OverLimit</code> error message.
5959
* 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.
6060
* 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>
61-
* <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>
61+
* <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>
6262
* <important>
6363
* <p>If you attempt to set the <code>VisibilityTimeout</code> to a value greater than
6464
* the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically
@@ -94,16 +94,17 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer {
9494
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
9595
*
9696
* @throws {@link InvalidAddress} (client fault)
97-
* <p>The <code>accountId</code> is invalid.</p>
97+
* <p>The specified ID is invalid.</p>
9898
*
9999
* @throws {@link InvalidSecurity} (client fault)
100-
* <p>When the request to a queue is not HTTPS and SigV4.</p>
100+
* <p>The request was not made over HTTPS or did not use SigV4 for signing.</p>
101101
*
102102
* @throws {@link MessageNotInflight} (client fault)
103103
* <p>The specified message isn't in flight.</p>
104104
*
105105
* @throws {@link QueueDoesNotExist} (client fault)
106-
* <p>The specified queue doesn't exist.</p>
106+
* <p>Ensure that the <code>QueueUrl</code> is correct and that the queue has not been
107+
* deleted.</p>
107108
*
108109
* @throws {@link ReceiptHandleIsInvalid} (client fault)
109110
* <p>The specified receipt handle isn't valid.</p>
@@ -112,18 +113,13 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer {
112113
* <p>The request was denied due to request throttling.</p>
113114
* <ul>
114115
* <li>
115-
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
116-
* quota for an account and Region. </p>
116+
* <p>Exceeds the permitted request rate for the queue or for the recipient of the
117+
* request.</p>
117118
* </li>
118119
* <li>
119-
* <p>A burst or sustained high rate of requests to change the state of the same KMS
120-
* key. This condition is often known as a "hot key."</p>
121-
* </li>
122-
* <li>
123-
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
124-
* might be throttled at a lower-than-expected rate when the Amazon Web Services
125-
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
126-
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
120+
* <p>Ensure that the request rate is within the Amazon SQS limits for
121+
* 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
122+
* Developer Guide</i>.</p>
127123
* </li>
128124
* </ul>
129125
*

‎clients/client-sqs/src/commands/CreateQueueCommand.ts

+22-24
Original file line numberDiff line numberDiff line change
@@ -57,22 +57,25 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB
5757
* <p>After you create a queue, you must wait at least one second after the queue is
5858
* created to be able to use the queue.</p>
5959
* </note>
60-
* <p>To get the queue URL, use the <code>
61-
* <a>GetQueueUrl</a>
62-
* </code> action.
63-
* <code>
64-
* <a>GetQueueUrl</a>
65-
* </code> requires only the
66-
* <code>QueueName</code> parameter. be aware of existing queue names:</p>
60+
* <p>To retrieve the URL of a queue, use the <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_GetQueueUrl.html">
61+
* <code>GetQueueUrl</code>
62+
* </a> action. This action only requires the <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html#API_CreateQueue_RequestSyntax">
63+
* <code>QueueName</code>
64+
* </a> parameter.</p>
65+
* <p>When creating queues, keep the following points in mind:</p>
6766
* <ul>
6867
* <li>
69-
* <p>If you provide the name of an existing queue along with the exact names and
70-
* values of all the queue's attributes, <code>CreateQueue</code> returns the queue
71-
* URL for the existing queue.</p>
68+
* <p>If you specify the name of an existing queue and provide the exact same names
69+
* and values for all its attributes, the <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html">
70+
* <code>CreateQueue</code>
71+
* </a> action will return the URL of the
72+
* existing queue instead of creating a new one.</p>
7273
* </li>
7374
* <li>
74-
* <p>If the queue name, attribute names, or attribute values don't match an
75-
* existing queue, <code>CreateQueue</code> returns an error.</p>
75+
* <p>If you attempt to create a queue with a name that already exists but with
76+
* different attribute names or values, the <code>CreateQueue</code> action will
77+
* return an error. This ensures that existing queues are not inadvertently
78+
* altered.</p>
7679
* </li>
7780
* </ul>
7881
* <note>
@@ -110,7 +113,7 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB
110113
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
111114
*
112115
* @throws {@link InvalidAddress} (client fault)
113-
* <p>The <code>accountId</code> is invalid.</p>
116+
* <p>The specified ID is invalid.</p>
114117
*
115118
* @throws {@link InvalidAttributeName} (client fault)
116119
* <p>The specified attribute doesn't exist.</p>
@@ -119,7 +122,7 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB
119122
* <p>A queue attribute value is invalid.</p>
120123
*
121124
* @throws {@link InvalidSecurity} (client fault)
122-
* <p>When the request to a queue is not HTTPS and SigV4.</p>
125+
* <p>The request was not made over HTTPS or did not use SigV4 for signing.</p>
123126
*
124127
* @throws {@link QueueDeletedRecently} (client fault)
125128
* <p>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
133136
* <p>The request was denied due to request throttling.</p>
134137
* <ul>
135138
* <li>
136-
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
137-
* quota for an account and Region. </p>
139+
* <p>Exceeds the permitted request rate for the queue or for the recipient of the
140+
* request.</p>
138141
* </li>
139142
* <li>
140-
* <p>A burst or sustained high rate of requests to change the state of the same KMS
141-
* key. This condition is often known as a "hot key."</p>
142-
* </li>
143-
* <li>
144-
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
145-
* might be throttled at a lower-than-expected rate when the Amazon Web Services
146-
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
147-
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
143+
* <p>Ensure that the request rate is within the Amazon SQS limits for
144+
* 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
145+
* Developer Guide</i>.</p>
148146
* </li>
149147
* </ul>
150148
*

‎clients/client-sqs/src/commands/DeleteMessageBatchCommand.ts

+11-14
Original file line numberDiff line numberDiff line change
@@ -83,39 +83,36 @@ export interface DeleteMessageBatchCommandOutput extends DeleteMessageBatchResul
8383
* <p>The batch request doesn't contain any entries.</p>
8484
*
8585
* @throws {@link InvalidAddress} (client fault)
86-
* <p>The <code>accountId</code> is invalid.</p>
86+
* <p>The specified ID is invalid.</p>
8787
*
8888
* @throws {@link InvalidBatchEntryId} (client fault)
8989
* <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the
9090
* specification.</p>
9191
*
9292
* @throws {@link InvalidSecurity} (client fault)
93-
* <p>When the request to a queue is not HTTPS and SigV4.</p>
93+
* <p>The request was not made over HTTPS or did not use SigV4 for signing.</p>
9494
*
9595
* @throws {@link QueueDoesNotExist} (client fault)
96-
* <p>The specified queue doesn't exist.</p>
96+
* <p>Ensure that the <code>QueueUrl</code> is correct and that the queue has not been
97+
* deleted.</p>
9798
*
9899
* @throws {@link RequestThrottled} (client fault)
99100
* <p>The request was denied due to request throttling.</p>
100101
* <ul>
101102
* <li>
102-
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
103-
* quota for an account and Region. </p>
103+
* <p>Exceeds the permitted request rate for the queue or for the recipient of the
104+
* request.</p>
104105
* </li>
105106
* <li>
106-
* <p>A burst or sustained high rate of requests to change the state of the same KMS
107-
* key. This condition is often known as a "hot key."</p>
108-
* </li>
109-
* <li>
110-
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
111-
* might be throttled at a lower-than-expected rate when the Amazon Web Services
112-
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
113-
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
107+
* <p>Ensure that the request rate is within the Amazon SQS limits for
108+
* 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
109+
* Developer Guide</i>.</p>
114110
* </li>
115111
* </ul>
116112
*
117113
* @throws {@link TooManyEntriesInBatchRequest} (client fault)
118-
* <p>The batch request contains more entries than permissible.</p>
114+
* <p>The batch request contains more entries than permissible. For Amazon SQS, the
115+
* 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>
119116
*
120117
* @throws {@link UnsupportedOperation} (client fault)
121118
* <p>Error code 400. Unsupported operation.</p>

0 commit comments

Comments
 (0)