Skip to content

Commit

Permalink
docs(client-sqs): Doc only updates for SQS. These updates include cus…
Browse files Browse the repository at this point in the history
…tomer-reported issues and TCX3 modifications.
  • Loading branch information
awstools committed Jun 6, 2024
1 parent 7c01057 commit 6772052
Show file tree
Hide file tree
Showing 25 changed files with 73 additions and 73 deletions.
4 changes: 2 additions & 2 deletions clients/client-sqs/src/commands/AddPermissionCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,8 @@ export interface AddPermissionCommandOutput 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>The rate of requests per second exceeds the Amazon Web Services KMS request
* quota for an account and Region. </p>
* </li>
* <li>
* <p>A burst or sustained high rate of requests to change the state of the same KMS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,8 @@ export interface CancelMessageMoveTaskCommandOutput extends CancelMessageMoveTas
* <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>The rate of requests per second exceeds the Amazon Web Services KMS request
* quota for an account and Region. </p>
* </li>
* <li>
* <p>A burst or sustained high rate of requests to change the state of the same KMS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,8 @@ export interface ChangeMessageVisibilityBatchCommandOutput
* <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>The rate of requests per second exceeds the Amazon Web Services KMS request
* quota for an account and Region. </p>
* </li>
* <li>
* <p>A burst or sustained high rate of requests to change the state of the same KMS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,8 @@ 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>The rate of requests per second exceeds the Amazon Web Services KMS request
* quota for an account and Region. </p>
* </li>
* <li>
* <p>A burst or sustained high rate of requests to change the state of the same KMS
Expand Down
4 changes: 2 additions & 2 deletions clients/client-sqs/src/commands/CreateQueueCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -133,8 +133,8 @@ 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>The rate of requests per second exceeds the Amazon Web Services KMS request
* quota for an account and Region. </p>
* </li>
* <li>
* <p>A burst or sustained high rate of requests to change the state of the same KMS
Expand Down
4 changes: 2 additions & 2 deletions clients/client-sqs/src/commands/DeleteMessageBatchCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,8 @@ export interface DeleteMessageBatchCommandOutput extends DeleteMessageBatchResul
* <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>The rate of requests per second exceeds the Amazon Web Services KMS request
* quota for an account and Region. </p>
* </li>
* <li>
* <p>A burst or sustained high rate of requests to change the state of the same KMS
Expand Down
4 changes: 2 additions & 2 deletions clients/client-sqs/src/commands/DeleteMessageCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,8 @@ export interface DeleteMessageCommandOutput 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>The rate of requests per second exceeds the Amazon Web Services KMS request
* quota for an account and Region. </p>
* </li>
* <li>
* <p>A burst or sustained high rate of requests to change the state of the same KMS
Expand Down
4 changes: 2 additions & 2 deletions clients/client-sqs/src/commands/DeleteQueueCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,8 @@ export interface DeleteQueueCommandOutput 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>The rate of requests per second exceeds the Amazon Web Services KMS request
* quota for an account and Region. </p>
* </li>
* <li>
* <p>A burst or sustained high rate of requests to change the state of the same KMS
Expand Down
4 changes: 2 additions & 2 deletions clients/client-sqs/src/commands/GetQueueAttributesCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,8 @@ export interface GetQueueAttributesCommandOutput extends GetQueueAttributesResul
* <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>The rate of requests per second exceeds the Amazon Web Services KMS request
* quota for an account and Region. </p>
* </li>
* <li>
* <p>A burst or sustained high rate of requests to change the state of the same KMS
Expand Down
4 changes: 2 additions & 2 deletions clients/client-sqs/src/commands/GetQueueUrlCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@ export interface GetQueueUrlCommandOutput extends GetQueueUrlResult, __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>The rate of requests per second exceeds the Amazon Web Services KMS request
* quota for an account and Region. </p>
* </li>
* <li>
* <p>A burst or sustained high rate of requests to change the state of the same KMS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ export interface ListDeadLetterSourceQueuesCommandOutput extends ListDeadLetterS
* <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>The rate of requests per second exceeds the Amazon Web Services KMS request
* quota for an account and Region. </p>
* </li>
* <li>
* <p>A burst or sustained high rate of requests to change the state of the same KMS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,8 @@ export interface ListMessageMoveTasksCommandOutput extends ListMessageMoveTasksR
* <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>The rate of requests per second exceeds the Amazon Web Services KMS request
* quota for an account and Region. </p>
* </li>
* <li>
* <p>A burst or sustained high rate of requests to change the state of the same KMS
Expand Down
4 changes: 2 additions & 2 deletions clients/client-sqs/src/commands/ListQueueTagsCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@ export interface ListQueueTagsCommandOutput extends ListQueueTagsResult, __Metad
* <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>The rate of requests per second exceeds the Amazon Web Services KMS request
* quota for an account and Region. </p>
* </li>
* <li>
* <p>A burst or sustained high rate of requests to change the state of the same KMS
Expand Down
4 changes: 2 additions & 2 deletions clients/client-sqs/src/commands/ListQueuesCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,8 @@ export interface ListQueuesCommandOutput extends ListQueuesResult, __MetadataBea
* <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>The rate of requests per second exceeds the Amazon Web Services KMS request
* quota for an account and Region. </p>
* </li>
* <li>
* <p>A burst or sustained high rate of requests to change the state of the same KMS
Expand Down
4 changes: 2 additions & 2 deletions clients/client-sqs/src/commands/PurgeQueueCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ export interface PurgeQueueCommandOutput 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>The rate of requests per second exceeds the Amazon Web Services KMS request
* quota for an account and Region. </p>
* </li>
* <li>
* <p>A burst or sustained high rate of requests to change the state of the same KMS
Expand Down
4 changes: 2 additions & 2 deletions clients/client-sqs/src/commands/ReceiveMessageCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -189,8 +189,8 @@ export interface ReceiveMessageCommandOutput extends ReceiveMessageResult, __Met
* <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>The rate of requests per second exceeds the Amazon Web Services KMS request
* quota for an account and Region. </p>
* </li>
* <li>
* <p>A burst or sustained high rate of requests to change the state of the same KMS
Expand Down
4 changes: 2 additions & 2 deletions clients/client-sqs/src/commands/RemovePermissionCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ export interface RemovePermissionCommandOutput 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>The rate of requests per second exceeds the Amazon Web Services KMS request
* quota for an account and Region. </p>
* </li>
* <li>
* <p>A burst or sustained high rate of requests to change the state of the same KMS
Expand Down
8 changes: 4 additions & 4 deletions clients/client-sqs/src/commands/SendMessageBatchCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,11 @@ export interface SendMessageBatchCommandOutput extends SendMessageBatchResult, _
* sum of the individual lengths of all of the batched messages) are both 256 KiB (262,144
* bytes).</p>
* <important>
* <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:</p>
* <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>
* <p>
* <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>
* </p>
* <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>
* <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>
* </important>
* <p>If you don't specify the <code>DelaySeconds</code> parameter for an entry, Amazon SQS uses
* the default value for the queue.</p>
Expand Down Expand Up @@ -183,8 +183,8 @@ export interface SendMessageBatchCommandOutput extends SendMessageBatchResult, _
* <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>The rate of requests per second exceeds the Amazon Web Services KMS request
* quota for an account and Region. </p>
* </li>
* <li>
* <p>A burst or sustained high rate of requests to change the state of the same KMS
Expand Down
8 changes: 4 additions & 4 deletions clients/client-sqs/src/commands/SendMessageCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ export interface SendMessageCommandOutput extends SendMessageResult, __MetadataB
/**
* <p>Delivers a message to the specified queue.</p>
* <important>
* <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:</p>
* <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>
* <p>
* <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>
* </p>
* <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>
* <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>
* </important>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down Expand Up @@ -144,8 +144,8 @@ export interface SendMessageCommandOutput extends SendMessageResult, __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>The rate of requests per second exceeds the Amazon Web Services KMS request
* quota for an account and Region. </p>
* </li>
* <li>
* <p>A burst or sustained high rate of requests to change the state of the same KMS
Expand Down
17 changes: 9 additions & 8 deletions clients/client-sqs/src/commands/SetQueueAttributesCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,13 @@ export interface SetQueueAttributesCommandInput extends SetQueueAttributesReques
export interface SetQueueAttributesCommandOutput extends __MetadataBearer {}

/**
* <p>Sets the value of one or more queue attributes, like a policy. When you change a queue's attributes,
* the change can take up to 60 seconds for most of the attributes to propagate throughout
* the Amazon SQS system. Changes made to the <code>MessageRetentionPeriod</code> attribute can
* take up to 15 minutes and will impact existing messages in the queue potentially causing
* them to be expired and deleted if the <code>MessageRetentionPeriod</code> is reduced
* below the age of existing messages.</p>
* <p>Sets the value of one or more queue attributes, like a policy. When you change a
* queue's attributes, the change can take up to 60 seconds for most of the attributes to
* propagate throughout the Amazon SQS system. Changes made to the
* <code>MessageRetentionPeriod</code> attribute can take up to 15 minutes and will
* impact existing messages in the queue potentially causing them to be expired and deleted
* if the <code>MessageRetentionPeriod</code> is reduced below the age of existing
* messages.</p>
* <note>
* <ul>
* <li>
Expand Down Expand Up @@ -98,8 +99,8 @@ export interface SetQueueAttributesCommandOutput 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>The rate of requests per second exceeds the Amazon Web Services KMS request
* quota for an account and Region. </p>
* </li>
* <li>
* <p>A burst or sustained high rate of requests to change the state of the same KMS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,8 @@ export interface StartMessageMoveTaskCommandOutput extends StartMessageMoveTaskR
* <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>The rate of requests per second exceeds the Amazon Web Services KMS request
* quota for an account and Region. </p>
* </li>
* <li>
* <p>A burst or sustained high rate of requests to change the state of the same KMS
Expand Down
4 changes: 2 additions & 2 deletions clients/client-sqs/src/commands/TagQueueCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,8 @@ export interface TagQueueCommandOutput 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>The rate of requests per second exceeds the Amazon Web Services KMS request
* quota for an account and Region. </p>
* </li>
* <li>
* <p>A burst or sustained high rate of requests to change the state of the same KMS
Expand Down
4 changes: 2 additions & 2 deletions clients/client-sqs/src/commands/UntagQueueCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,8 @@ export interface UntagQueueCommandOutput 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>The rate of requests per second exceeds the Amazon Web Services KMS request
* quota for an account and Region. </p>
* </li>
* <li>
* <p>A burst or sustained high rate of requests to change the state of the same KMS
Expand Down
Loading

0 comments on commit 6772052

Please sign in to comment.