Skip to content

Commit 6772052

Browse files
author
awstools
committed
docs(client-sqs): Doc only updates for SQS. These updates include customer-reported issues and TCX3 modifications.
1 parent 7c01057 commit 6772052

25 files changed

+73
-73
lines changed

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -109,8 +109,8 @@ export interface AddPermissionCommandOutput extends __MetadataBearer {}
109109
* <p>The request was denied due to request throttling.</p>
110110
* <ul>
111111
* <li>
112-
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request quota for an
113-
* account and Region. </p>
112+
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
113+
* quota for an account and Region. </p>
114114
* </li>
115115
* <li>
116116
* <p>A burst or sustained high rate of requests to change the state of the same KMS

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,8 @@ export interface CancelMessageMoveTaskCommandOutput extends CancelMessageMoveTas
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 quota for an
83-
* account and Region. </p>
82+
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
83+
* quota for an account and Region. </p>
8484
* </li>
8585
* <li>
8686
* <p>A burst or sustained high rate of requests to change the state of the same KMS

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -109,8 +109,8 @@ export interface ChangeMessageVisibilityBatchCommandOutput
109109
* <p>The request was denied due to request throttling.</p>
110110
* <ul>
111111
* <li>
112-
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request quota for an
113-
* account and Region. </p>
112+
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
113+
* quota for an account and Region. </p>
114114
* </li>
115115
* <li>
116116
* <p>A burst or sustained high rate of requests to change the state of the same KMS

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,8 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer {
112112
* <p>The request was denied due to request throttling.</p>
113113
* <ul>
114114
* <li>
115-
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request quota for an
116-
* account and Region. </p>
115+
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
116+
* quota for an account and Region. </p>
117117
* </li>
118118
* <li>
119119
* <p>A burst or sustained high rate of requests to change the state of the same KMS

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -133,8 +133,8 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB
133133
* <p>The request was denied due to request throttling.</p>
134134
* <ul>
135135
* <li>
136-
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request quota for an
137-
* account and Region. </p>
136+
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
137+
* quota for an account and Region. </p>
138138
* </li>
139139
* <li>
140140
* <p>A burst or sustained high rate of requests to change the state of the same KMS

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,8 @@ export interface DeleteMessageBatchCommandOutput extends DeleteMessageBatchResul
9999
* <p>The request was denied due to request throttling.</p>
100100
* <ul>
101101
* <li>
102-
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request quota for an
103-
* account and Region. </p>
102+
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
103+
* quota for an account and Region. </p>
104104
* </li>
105105
* <li>
106106
* <p>A burst or sustained high rate of requests to change the state of the same KMS

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,8 @@ export interface DeleteMessageCommandOutput extends __MetadataBearer {}
8989
* <p>The request was denied due to request throttling.</p>
9090
* <ul>
9191
* <li>
92-
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request quota for an
93-
* account and Region. </p>
92+
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
93+
* quota for an account and Region. </p>
9494
* </li>
9595
* <li>
9696
* <p>A burst or sustained high rate of requests to change the state of the same KMS

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@ export interface DeleteQueueCommandOutput extends __MetadataBearer {}
8282
* <p>The request was denied due to request throttling.</p>
8383
* <ul>
8484
* <li>
85-
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request quota for an
86-
* account and Region. </p>
85+
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
86+
* quota for an account and Region. </p>
8787
* </li>
8888
* <li>
8989
* <p>A burst or sustained high rate of requests to change the state of the same KMS

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,8 @@ export interface GetQueueAttributesCommandOutput extends GetQueueAttributesResul
7676
* <p>The request was denied due to request throttling.</p>
7777
* <ul>
7878
* <li>
79-
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request quota for an
80-
* account and Region. </p>
79+
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
80+
* quota for an account and Region. </p>
8181
* </li>
8282
* <li>
8383
* <p>A burst or sustained high rate of requests to change the state of the same KMS

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,8 @@ export interface GetQueueUrlCommandOutput extends GetQueueUrlResult, __MetadataB
7474
* <p>The request was denied due to request throttling.</p>
7575
* <ul>
7676
* <li>
77-
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request quota for an
78-
* account and Region. </p>
77+
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
78+
* quota for an account and Region. </p>
7979
* </li>
8080
* <li>
8181
* <p>A burst or sustained high rate of requests to change the state of the same KMS

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,8 @@ export interface ListDeadLetterSourceQueuesCommandOutput extends ListDeadLetterS
8080
* <p>The request was denied due to request throttling.</p>
8181
* <ul>
8282
* <li>
83-
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request quota for an
84-
* account and Region. </p>
83+
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
84+
* quota for an account and Region. </p>
8585
* </li>
8686
* <li>
8787
* <p>A burst or sustained high rate of requests to change the state of the same KMS

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,8 @@ export interface ListMessageMoveTasksCommandOutput extends ListMessageMoveTasksR
9090
* <p>The request was denied due to request throttling.</p>
9191
* <ul>
9292
* <li>
93-
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request quota for an
94-
* account and Region. </p>
93+
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
94+
* quota for an account and Region. </p>
9595
* </li>
9696
* <li>
9797
* <p>A burst or sustained high rate of requests to change the state of the same KMS

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,8 @@ export interface ListQueueTagsCommandOutput extends ListQueueTagsResult, __Metad
7474
* <p>The request was denied due to request throttling.</p>
7575
* <ul>
7676
* <li>
77-
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request quota for an
78-
* account and Region. </p>
77+
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
78+
* quota for an account and Region. </p>
7979
* </li>
8080
* <li>
8181
* <p>A burst or sustained high rate of requests to change the state of the same KMS

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@ export interface ListQueuesCommandOutput extends ListQueuesResult, __MetadataBea
8282
* <p>The request was denied due to request throttling.</p>
8383
* <ul>
8484
* <li>
85-
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request quota for an
86-
* account and Region. </p>
85+
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
86+
* quota for an account and Region. </p>
8787
* </li>
8888
* <li>
8989
* <p>A burst or sustained high rate of requests to change the state of the same KMS

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,8 @@ export interface PurgeQueueCommandOutput extends __MetadataBearer {}
8080
* <p>The request was denied due to request throttling.</p>
8181
* <ul>
8282
* <li>
83-
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request quota for an
84-
* account and Region. </p>
83+
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
84+
* quota for an account and Region. </p>
8585
* </li>
8686
* <li>
8787
* <p>A burst or sustained high rate of requests to change the state of the same KMS

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -189,8 +189,8 @@ export interface ReceiveMessageCommandOutput extends ReceiveMessageResult, __Met
189189
* <p>The request was denied due to request throttling.</p>
190190
* <ul>
191191
* <li>
192-
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request quota for an
193-
* account and Region. </p>
192+
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
193+
* quota for an account and Region. </p>
194194
* </li>
195195
* <li>
196196
* <p>A burst or sustained high rate of requests to change the state of the same KMS

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,8 @@ export interface RemovePermissionCommandOutput extends __MetadataBearer {}
8080
* <p>The request was denied due to request throttling.</p>
8181
* <ul>
8282
* <li>
83-
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request quota for an
84-
* account and Region. </p>
83+
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
84+
* quota for an account and Region. </p>
8585
* </li>
8686
* <li>
8787
* <p>A burst or sustained high rate of requests to change the state of the same KMS

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

+4-4
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@ export interface SendMessageBatchCommandOutput extends SendMessageBatchResult, _
4040
* sum of the individual lengths of all of the batched messages) are both 256 KiB (262,144
4141
* bytes).</p>
4242
* <important>
43-
* <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:</p>
43+
* <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the <a href="http://www.w3.org/TR/REC-xml/#charsets">W3C specification for characters</a>.</p>
4444
* <p>
4545
* <code>#x9</code> | <code>#xA</code> | <code>#xD</code> | <code>#x20</code> to <code>#xD7FF</code> | <code>#xE000</code> to <code>#xFFFD</code> | <code>#x10000</code> to <code>#x10FFFF</code>
4646
* </p>
47-
* <p>Any characters not included in this list will be rejected. For more information, see the <a href="http://www.w3.org/TR/REC-xml/#charsets">W3C specification for characters</a>.</p>
47+
* <p>Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with <code>U+FFFD</code> before storing the message in the queue, as long as the message body contains at least one valid character.</p>
4848
* </important>
4949
* <p>If you don't specify the <code>DelaySeconds</code> parameter for an entry, Amazon SQS uses
5050
* the default value for the queue.</p>
@@ -183,8 +183,8 @@ export interface SendMessageBatchCommandOutput extends SendMessageBatchResult, _
183183
* <p>The request was denied due to request throttling.</p>
184184
* <ul>
185185
* <li>
186-
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request quota for an
187-
* account and Region. </p>
186+
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
187+
* quota for an account and Region. </p>
188188
* </li>
189189
* <li>
190190
* <p>A burst or sustained high rate of requests to change the state of the same KMS

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

+4-4
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@ export interface SendMessageCommandOutput extends SendMessageResult, __MetadataB
3131
/**
3232
* <p>Delivers a message to the specified queue.</p>
3333
* <important>
34-
* <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:</p>
34+
* <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the <a href="http://www.w3.org/TR/REC-xml/#charsets">W3C specification for characters</a>.</p>
3535
* <p>
3636
* <code>#x9</code> | <code>#xA</code> | <code>#xD</code> | <code>#x20</code> to <code>#xD7FF</code> | <code>#xE000</code> to <code>#xFFFD</code> | <code>#x10000</code> to <code>#x10FFFF</code>
3737
* </p>
38-
* <p>Any characters not included in this list will be rejected. For more information, see the <a href="http://www.w3.org/TR/REC-xml/#charsets">W3C specification for characters</a>.</p>
38+
* <p>Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with <code>U+FFFD</code> before storing the message in the queue, as long as the message body contains at least one valid character.</p>
3939
* </important>
4040
* @example
4141
* Use a bare-bones client and the command you need to make an API call.
@@ -144,8 +144,8 @@ export interface SendMessageCommandOutput extends SendMessageResult, __MetadataB
144144
* <p>The request was denied due to request throttling.</p>
145145
* <ul>
146146
* <li>
147-
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request quota for an
148-
* account and Region. </p>
147+
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
148+
* quota for an account and Region. </p>
149149
* </li>
150150
* <li>
151151
* <p>A burst or sustained high rate of requests to change the state of the same KMS

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

+9-8
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,13 @@ export interface SetQueueAttributesCommandInput extends SetQueueAttributesReques
2828
export interface SetQueueAttributesCommandOutput extends __MetadataBearer {}
2929

3030
/**
31-
* <p>Sets the value of one or more queue attributes, like a policy. When you change a queue's attributes,
32-
* the change can take up to 60 seconds for most of the attributes to propagate throughout
33-
* the Amazon SQS system. Changes made to the <code>MessageRetentionPeriod</code> attribute can
34-
* take up to 15 minutes and will impact existing messages in the queue potentially causing
35-
* them to be expired and deleted if the <code>MessageRetentionPeriod</code> is reduced
36-
* below the age of existing messages.</p>
31+
* <p>Sets the value of one or more queue attributes, like a policy. When you change a
32+
* queue's attributes, the change can take up to 60 seconds for most of the attributes to
33+
* propagate throughout the Amazon SQS system. Changes made to the
34+
* <code>MessageRetentionPeriod</code> attribute can take up to 15 minutes and will
35+
* impact existing messages in the queue potentially causing them to be expired and deleted
36+
* if the <code>MessageRetentionPeriod</code> is reduced below the age of existing
37+
* messages.</p>
3738
* <note>
3839
* <ul>
3940
* <li>
@@ -98,8 +99,8 @@ export interface SetQueueAttributesCommandOutput extends __MetadataBearer {}
9899
* <p>The request was denied due to request throttling.</p>
99100
* <ul>
100101
* <li>
101-
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request quota for an
102-
* account and Region. </p>
102+
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
103+
* quota for an account and Region. </p>
103104
* </li>
104105
* <li>
105106
* <p>A burst or sustained high rate of requests to change the state of the same KMS

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,8 @@ export interface StartMessageMoveTaskCommandOutput extends StartMessageMoveTaskR
8585
* <p>The request was denied due to request throttling.</p>
8686
* <ul>
8787
* <li>
88-
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request quota for an
89-
* account and Region. </p>
88+
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
89+
* quota for an account and Region. </p>
9090
* </li>
9191
* <li>
9292
* <p>A burst or sustained high rate of requests to change the state of the same KMS

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,8 @@ export interface TagQueueCommandOutput extends __MetadataBearer {}
9090
* <p>The request was denied due to request throttling.</p>
9191
* <ul>
9292
* <li>
93-
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request quota for an
94-
* account and Region. </p>
93+
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
94+
* quota for an account and Region. </p>
9595
* </li>
9696
* <li>
9797
* <p>A burst or sustained high rate of requests to change the state of the same KMS

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,8 @@ export interface UntagQueueCommandOutput extends __MetadataBearer {}
7272
* <p>The request was denied due to request throttling.</p>
7373
* <ul>
7474
* <li>
75-
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request quota for an
76-
* account and Region. </p>
75+
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request
76+
* quota for an account and Region. </p>
7777
* </li>
7878
* <li>
7979
* <p>A burst or sustained high rate of requests to change the state of the same KMS

0 commit comments

Comments
 (0)