Skip to content

Commit eaee979

Browse files
author
awstools
committed
docs(client-sqs): Documentation updates for Amazon SQS fair queues feature.
1 parent 2c4726a commit eaee979

File tree

9 files changed

+89
-70
lines changed

9 files changed

+89
-70
lines changed

‎clients/client-sqs/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,7 @@ following automatically:</p>
6060
</li>
6161
<li>
6262
<p>
63-
<a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line Interface</i>
64-
</a>
63+
<a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/sqs/index.html">Amazon SQS in the Command Line Interface</a>
6564
</p>
6665
</li>
6766
<li>

‎clients/client-sqs/src/SQS.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -493,8 +493,7 @@ export interface SQS {
493493
* </li>
494494
* <li>
495495
* <p>
496-
* <a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line Interface</i>
497-
* </a>
496+
* <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/sqs/index.html">Amazon SQS in the Command Line Interface</a>
498497
* </p>
499498
* </li>
500499
* <li>

‎clients/client-sqs/src/SQSClient.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -422,8 +422,7 @@ export interface SQSClientResolvedConfig extends SQSClientResolvedConfigType {}
422422
* </li>
423423
* <li>
424424
* <p>
425-
* <a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line Interface</i>
426-
* </a>
425+
* <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/sqs/index.html">Amazon SQS in the Command Line Interface</a>
427426
* </p>
428427
* </li>
429428
* <li>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB
3737
* <p>You can't change the queue type after you create it and you can't convert
3838
* an existing standard queue into a FIFO queue. You must either create a new
3939
* FIFO queue for your application or delete your existing standard queue and
40-
* recreate it as a FIFO queue. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-moving">Moving From a Standard Queue to a FIFO Queue</a> in the
40+
* recreate it as a FIFO queue. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-moving">Moving From a standard queue to a FIFO queue</a> in the
4141
* <i>Amazon SQS Developer Guide</i>. </p>
4242
* </note>
4343
* </li>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export interface SendMessageBatchCommandOutput extends SendMessageBatchResult, _
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>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>
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 U+FFFD 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>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ export interface SendMessageCommandOutput extends SendMessageResult, __MetadataB
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>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>
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 U+FFFD 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.

‎clients/client-sqs/src/index.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,7 @@
5555
* </li>
5656
* <li>
5757
* <p>
58-
* <a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line Interface</i>
59-
* </a>
58+
* <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/sqs/index.html">Amazon SQS in the Command Line Interface</a>
6059
* </p>
6160
* </li>
6261
* <li>

‎clients/client-sqs/src/models/models_0.ts

Lines changed: 72 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1873,8 +1873,7 @@ export interface ReceiveMessageRequest {
18731873
* producer that calls the <code>
18741874
* <a>SendMessage</a>
18751875
* </code> action.
1876-
* Messages with the same <code>MessageGroupId</code> are returned in
1877-
* sequence.</p>
1876+
* </p>
18781877
* </li>
18791878
* <li>
18801879
* <p>
@@ -1952,9 +1951,7 @@ export interface ReceiveMessageRequest {
19521951
* <code>MessageGroupId</code> – Returns the value provided by the
19531952
* producer that calls the <code>
19541953
* <a>SendMessage</a>
1955-
* </code> action.
1956-
* Messages with the same <code>MessageGroupId</code> are returned in
1957-
* sequence.</p>
1954+
* </code> action.</p>
19581955
* </li>
19591956
* <li>
19601957
* <p>
@@ -2104,10 +2101,10 @@ export interface ReceiveMessageRequest {
21042101
* </important>
21052102
* </li>
21062103
* <li>
2107-
* <p>While messages with a particular <code>MessageGroupId</code> are invisible, no
2108-
* more messages belonging to the same <code>MessageGroupId</code> are returned
2109-
* until the visibility timeout expires. You can still receive messages with
2110-
* another <code>MessageGroupId</code> as long as it is also visible.</p>
2104+
* <p>While messages with a particular <code>MessageGroupId</code> are invisible,
2105+
* no more messages belonging to the same <code>MessageGroupId</code> are returned
2106+
* until the visibility timeout expires. You can still receive messages
2107+
* with another <code>MessageGroupId</code> from your FIFO queue as long as they are visible.</p>
21112108
* </li>
21122109
* <li>
21132110
* <p>If a caller of <code>ReceiveMessage</code> can't track the
@@ -2413,7 +2410,7 @@ export interface SendMessageRequest {
24132410
* <p>
24142411
* <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>
24152412
* </p>
2416-
* <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>
2413+
* <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 U+FFFD before storing the message in the queue, as long as the message body contains at least one valid character.</p>
24172414
* </important>
24182415
* @public
24192416
*/
@@ -2526,37 +2523,50 @@ export interface SendMessageRequest {
25262523
MessageDeduplicationId?: string | undefined;
25272524

25282525
/**
2529-
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
2530-
* <p>The tag that specifies that a message belongs to a specific message group. Messages
2531-
* that belong to the same message group are processed in a FIFO manner (however,
2532-
* messages in different message groups might be processed out of order). To interleave
2533-
* multiple ordered streams within a single queue, use <code>MessageGroupId</code> values
2534-
* (for example, session data for multiple users). In this scenario, multiple consumers can
2535-
* process the queue, but the session data of each user is processed in a FIFO
2536-
* fashion.</p>
2526+
* <p>
2527+
* <code>MessageGroupId</code> is an attribute used in Amazon SQS FIFO (First-In-First-Out) and standard queues.
2528+
* In FIFO queues, <code>MessageGroupId</code> organizes messages into distinct groups.
2529+
* Messages within the same message group are always processed one at a time, in strict order,
2530+
* ensuring that no two messages from the same group are processed simultaneously.
2531+
* In standard queues, using <code>MessageGroupId</code> enables fair queues.
2532+
* It is used to identify the tenant a message belongs to,
2533+
* helping maintain consistent message dwell time across all tenants during noisy neighbor events.
2534+
* Unlike FIFO queues, messages with the same <code>MessageGroupId</code> can be processed in parallel,
2535+
* maintaining the high throughput of standard queues.</p>
25372536
* <ul>
25382537
* <li>
2539-
* <p>You must associate a non-empty <code>MessageGroupId</code> with a message. If
2540-
* you don't provide a <code>MessageGroupId</code>, the action fails.</p>
2538+
* <p>
2539+
* <b>FIFO queues:</b>
2540+
* <code>MessageGroupId</code> acts as the tag
2541+
* that specifies that a message belongs to a specific message group.
2542+
* Messages that belong to the same message group are processed in a FIFO manner
2543+
* (however, messages in different message groups might be processed out of order).
2544+
* To interleave multiple ordered streams within a single queue, use <code>MessageGroupId</code> values
2545+
* (for example, session data for multiple users).
2546+
* In this scenario, multiple consumers can process the queue,
2547+
* but the session data of each user is processed in a FIFO fashion.</p>
2548+
* <p>If you do not provide a <code>MessageGroupId</code> when sending a message to a FIFO queue, the action fails.</p>
2549+
* <p>
2550+
* <code>ReceiveMessage</code> might return messages with multiple <code>MessageGroupId</code> values.
2551+
* For each <code>MessageGroupId</code>, the messages are sorted by time sent.</p>
25412552
* </li>
25422553
* <li>
25432554
* <p>
2544-
* <code>ReceiveMessage</code> might return messages with multiple
2545-
* <code>MessageGroupId</code> values. For each <code>MessageGroupId</code>,
2546-
* the messages are sorted by time sent. The caller can't specify a
2547-
* <code>MessageGroupId</code>.</p>
2555+
* <b>Standard queues:</b>Use <code>MessageGroupId</code> in standard queues to enable fair queues.
2556+
* The <code>MessageGroupId</code> identifies the tenant a message belongs to.
2557+
* A tenant can be any entity that shares a queue with others, such as your customer, a client application,
2558+
* or a request type. When one tenant sends a disproportionately large volume of messages
2559+
* or has messages that require longer processing time, fair queues ensure other tenants'
2560+
* messages maintain low dwell time. This preserves quality of service for all tenants while
2561+
* maintaining the scalability and throughput of standard queues.
2562+
* We recommend that you include a <code>MessageGroupId</code> in all messages when using fair queues.</p>
25482563
* </li>
25492564
* </ul>
2550-
* <p>The maximum length of <code>MessageGroupId</code> is 128 characters. Valid values:
2565+
* <p>The length of <code>MessageGroupId</code> is 128 characters. Valid values:
25512566
* alphanumeric characters and punctuation
25522567
* <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~)</code>.</p>
25532568
* <p>For best practices of using <code>MessageGroupId</code>, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html">Using the MessageGroupId Property</a> in the <i>Amazon SQS Developer
25542569
* Guide</i>.</p>
2555-
* <important>
2556-
* <p>
2557-
* <code>MessageGroupId</code> is required for FIFO queues. You can't use it for
2558-
* Standard queues.</p>
2559-
* </important>
25602570
* @public
25612571
*/
25622572
MessageGroupId?: string | undefined;
@@ -2752,37 +2762,50 @@ export interface SendMessageBatchRequestEntry {
27522762
MessageDeduplicationId?: string | undefined;
27532763

27542764
/**
2755-
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
2756-
* <p>The tag that specifies that a message belongs to a specific message group. Messages
2757-
* that belong to the same message group are processed in a FIFO manner (however,
2758-
* messages in different message groups might be processed out of order). To interleave
2759-
* multiple ordered streams within a single queue, use <code>MessageGroupId</code> values
2760-
* (for example, session data for multiple users). In this scenario, multiple consumers can
2761-
* process the queue, but the session data of each user is processed in a FIFO
2762-
* fashion.</p>
2765+
* <p>
2766+
* <code>MessageGroupId</code> is an attribute used in Amazon SQS FIFO (First-In-First-Out) and standard queues.
2767+
* In FIFO queues, <code>MessageGroupId</code> organizes messages into distinct groups.
2768+
* Messages within the same message group are always processed one at a time, in strict order,
2769+
* ensuring that no two messages from the same group are processed simultaneously.
2770+
* In standard queues, using <code>MessageGroupId</code> enables fair queues.
2771+
* It is used to identify the tenant a message belongs to,
2772+
* helping maintain consistent message dwell time across all tenants during noisy neighbor events.
2773+
* Unlike FIFO queues, messages with the same <code>MessageGroupId</code> can be processed in parallel,
2774+
* maintaining the high throughput of standard queues.</p>
27632775
* <ul>
27642776
* <li>
2765-
* <p>You must associate a non-empty <code>MessageGroupId</code> with a message. If
2766-
* you don't provide a <code>MessageGroupId</code>, the action fails.</p>
2777+
* <p>
2778+
* <b>FIFO queues:</b>
2779+
* <code>MessageGroupId</code> acts as the tag
2780+
* that specifies that a message belongs to a specific message group.
2781+
* Messages that belong to the same message group are processed in a FIFO manner
2782+
* (however, messages in different message groups might be processed out of order).
2783+
* To interleave multiple ordered streams within a single queue, use <code>MessageGroupId</code> values
2784+
* (for example, session data for multiple users).
2785+
* In this scenario, multiple consumers can process the queue,
2786+
* but the session data of each user is processed in a FIFO fashion.</p>
2787+
* <p>If you do not provide a <code>MessageGroupId</code> when sending a message to a FIFO queue, the action fails.</p>
2788+
* <p>
2789+
* <code>ReceiveMessage</code> might return messages with multiple <code>MessageGroupId</code> values.
2790+
* For each <code>MessageGroupId</code>, the messages are sorted by time sent.</p>
27672791
* </li>
27682792
* <li>
27692793
* <p>
2770-
* <code>ReceiveMessage</code> might return messages with multiple
2771-
* <code>MessageGroupId</code> values. For each <code>MessageGroupId</code>,
2772-
* the messages are sorted by time sent. The caller can't specify a
2773-
* <code>MessageGroupId</code>.</p>
2794+
* <b>Standard queues:</b>Use <code>MessageGroupId</code> in standard queues to enable fair queues.
2795+
* The <code>MessageGroupId</code> identifies the tenant a message belongs to.
2796+
* A tenant can be any entity that shares a queue with others, such as your customer, a client application,
2797+
* or a request type. When one tenant sends a disproportionately large volume of messages
2798+
* or has messages that require longer processing time, fair queues ensure other tenants'
2799+
* messages maintain low dwell time. This preserves quality of service for all tenants while
2800+
* maintaining the scalability and throughput of standard queues.
2801+
* We recommend that you include a <code>MessageGroupId</code> in all messages when using fair queues.</p>
27742802
* </li>
27752803
* </ul>
27762804
* <p>The length of <code>MessageGroupId</code> is 128 characters. Valid values:
27772805
* alphanumeric characters and punctuation
27782806
* <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~)</code>.</p>
27792807
* <p>For best practices of using <code>MessageGroupId</code>, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html">Using the MessageGroupId Property</a> in the <i>Amazon SQS Developer
27802808
* Guide</i>.</p>
2781-
* <important>
2782-
* <p>
2783-
* <code>MessageGroupId</code> is required for FIFO queues. You can't use it for
2784-
* Standard queues.</p>
2785-
* </important>
27862809
* @public
27872810
*/
27882811
MessageGroupId?: string | undefined;

0 commit comments

Comments
 (0)