@aws-sdk/client-sqs 3.848.0 → 3.854.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -60,8 +60,7 @@ following automatically:</p>
60
60
  </li>
61
61
  <li>
62
62
  <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>
65
64
  </p>
66
65
  </li>
67
66
  <li>
@@ -219,8 +219,7 @@ export interface SQS {
219
219
  * </li>
220
220
  * <li>
221
221
  * <p>
222
- * <a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line Interface</i>
223
- * </a>
222
+ * <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/sqs/index.html">Amazon SQS in the Command Line Interface</a>
224
223
  * </p>
225
224
  * </li>
226
225
  * <li>
@@ -252,8 +252,7 @@ export interface SQSClientResolvedConfig extends SQSClientResolvedConfigType {
252
252
  * </li>
253
253
  * <li>
254
254
  * <p>
255
- * <a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line Interface</i>
256
- * </a>
255
+ * <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/sqs/index.html">Amazon SQS in the Command Line Interface</a>
257
256
  * </p>
258
257
  * </li>
259
258
  * <li>
@@ -36,7 +36,7 @@ declare const CreateQueueCommand_base: {
36
36
  * <p>You can't change the queue type after you create it and you can't convert
37
37
  * an existing standard queue into a FIFO queue. You must either create a new
38
38
  * FIFO queue for your application or delete your existing standard queue and
39
- * 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
39
+ * 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
40
  * <i>Amazon SQS Developer Guide</i>. </p>
41
41
  * </note>
42
42
  * </li>
@@ -42,7 +42,7 @@ declare const SendMessageBatchCommand_base: {
42
42
  * <p>
43
43
  * <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>
44
44
  * </p>
45
- * <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>
45
+ * <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>
46
46
  * </important>
47
47
  * <p>If you don't specify the <code>DelaySeconds</code> parameter for an entry, Amazon SQS uses
48
48
  * the default value for the queue.</p>
@@ -33,7 +33,7 @@ declare const SendMessageCommand_base: {
33
33
  * <p>
34
34
  * <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>
35
35
  * </p>
36
- * <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>
36
+ * <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>
37
37
  * </important>
38
38
  * @example
39
39
  * Use a bare-bones client and the command you need to make an API call.
@@ -53,8 +53,7 @@
53
53
  * </li>
54
54
  * <li>
55
55
  * <p>
56
- * <a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line Interface</i>
57
- * </a>
56
+ * <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/sqs/index.html">Amazon SQS in the Command Line Interface</a>
58
57
  * </p>
59
58
  * </li>
60
59
  * <li>
@@ -1591,8 +1591,7 @@ export interface ReceiveMessageRequest {
1591
1591
  * producer that calls the <code>
1592
1592
  * <a>SendMessage</a>
1593
1593
  * </code> action.
1594
- * Messages with the same <code>MessageGroupId</code> are returned in
1595
- * sequence.</p>
1594
+ * </p>
1596
1595
  * </li>
1597
1596
  * <li>
1598
1597
  * <p>
@@ -1669,9 +1668,7 @@ export interface ReceiveMessageRequest {
1669
1668
  * <code>MessageGroupId</code> – Returns the value provided by the
1670
1669
  * producer that calls the <code>
1671
1670
  * <a>SendMessage</a>
1672
- * </code> action.
1673
- * Messages with the same <code>MessageGroupId</code> are returned in
1674
- * sequence.</p>
1671
+ * </code> action.</p>
1675
1672
  * </li>
1676
1673
  * <li>
1677
1674
  * <p>
@@ -1816,10 +1813,10 @@ export interface ReceiveMessageRequest {
1816
1813
  * </important>
1817
1814
  * </li>
1818
1815
  * <li>
1819
- * <p>While messages with a particular <code>MessageGroupId</code> are invisible, no
1820
- * more messages belonging to the same <code>MessageGroupId</code> are returned
1821
- * until the visibility timeout expires. You can still receive messages with
1822
- * another <code>MessageGroupId</code> as long as it is also visible.</p>
1816
+ * <p>While messages with a particular <code>MessageGroupId</code> are invisible,
1817
+ * no more messages belonging to the same <code>MessageGroupId</code> are returned
1818
+ * until the visibility timeout expires. You can still receive messages
1819
+ * with another <code>MessageGroupId</code> from your FIFO queue as long as they are visible.</p>
1823
1820
  * </li>
1824
1821
  * <li>
1825
1822
  * <p>If a caller of <code>ReceiveMessage</code> can't track the
@@ -2092,7 +2089,7 @@ export interface SendMessageRequest {
2092
2089
  * <p>
2093
2090
  * <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>
2094
2091
  * </p>
2095
- * <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>
2092
+ * <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>
2096
2093
  * </important>
2097
2094
  * @public
2098
2095
  */
@@ -2198,37 +2195,50 @@ export interface SendMessageRequest {
2198
2195
  */
2199
2196
  MessageDeduplicationId?: string | undefined;
2200
2197
  /**
2201
- * <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
2202
- * <p>The tag that specifies that a message belongs to a specific message group. Messages
2203
- * that belong to the same message group are processed in a FIFO manner (however,
2204
- * messages in different message groups might be processed out of order). To interleave
2205
- * multiple ordered streams within a single queue, use <code>MessageGroupId</code> values
2206
- * (for example, session data for multiple users). In this scenario, multiple consumers can
2207
- * process the queue, but the session data of each user is processed in a FIFO
2208
- * fashion.</p>
2198
+ * <p>
2199
+ * <code>MessageGroupId</code> is an attribute used in Amazon SQS FIFO (First-In-First-Out) and standard queues.
2200
+ * In FIFO queues, <code>MessageGroupId</code> organizes messages into distinct groups.
2201
+ * Messages within the same message group are always processed one at a time, in strict order,
2202
+ * ensuring that no two messages from the same group are processed simultaneously.
2203
+ * In standard queues, using <code>MessageGroupId</code> enables fair queues.
2204
+ * It is used to identify the tenant a message belongs to,
2205
+ * helping maintain consistent message dwell time across all tenants during noisy neighbor events.
2206
+ * Unlike FIFO queues, messages with the same <code>MessageGroupId</code> can be processed in parallel,
2207
+ * maintaining the high throughput of standard queues.</p>
2209
2208
  * <ul>
2210
2209
  * <li>
2211
- * <p>You must associate a non-empty <code>MessageGroupId</code> with a message. If
2212
- * you don't provide a <code>MessageGroupId</code>, the action fails.</p>
2210
+ * <p>
2211
+ * <b>FIFO queues:</b>
2212
+ * <code>MessageGroupId</code> acts as the tag
2213
+ * that specifies that a message belongs to a specific message group.
2214
+ * Messages that belong to the same message group are processed in a FIFO manner
2215
+ * (however, messages in different message groups might be processed out of order).
2216
+ * To interleave multiple ordered streams within a single queue, use <code>MessageGroupId</code> values
2217
+ * (for example, session data for multiple users).
2218
+ * In this scenario, multiple consumers can process the queue,
2219
+ * but the session data of each user is processed in a FIFO fashion.</p>
2220
+ * <p>If you do not provide a <code>MessageGroupId</code> when sending a message to a FIFO queue, the action fails.</p>
2221
+ * <p>
2222
+ * <code>ReceiveMessage</code> might return messages with multiple <code>MessageGroupId</code> values.
2223
+ * For each <code>MessageGroupId</code>, the messages are sorted by time sent.</p>
2213
2224
  * </li>
2214
2225
  * <li>
2215
2226
  * <p>
2216
- * <code>ReceiveMessage</code> might return messages with multiple
2217
- * <code>MessageGroupId</code> values. For each <code>MessageGroupId</code>,
2218
- * the messages are sorted by time sent. The caller can't specify a
2219
- * <code>MessageGroupId</code>.</p>
2227
+ * <b>Standard queues:</b>Use <code>MessageGroupId</code> in standard queues to enable fair queues.
2228
+ * The <code>MessageGroupId</code> identifies the tenant a message belongs to.
2229
+ * A tenant can be any entity that shares a queue with others, such as your customer, a client application,
2230
+ * or a request type. When one tenant sends a disproportionately large volume of messages
2231
+ * or has messages that require longer processing time, fair queues ensure other tenants'
2232
+ * messages maintain low dwell time. This preserves quality of service for all tenants while
2233
+ * maintaining the scalability and throughput of standard queues.
2234
+ * We recommend that you include a <code>MessageGroupId</code> in all messages when using fair queues.</p>
2220
2235
  * </li>
2221
2236
  * </ul>
2222
- * <p>The maximum length of <code>MessageGroupId</code> is 128 characters. Valid values:
2237
+ * <p>The length of <code>MessageGroupId</code> is 128 characters. Valid values:
2223
2238
  * alphanumeric characters and punctuation
2224
2239
  * <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~)</code>.</p>
2225
2240
  * <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
2226
2241
  * Guide</i>.</p>
2227
- * <important>
2228
- * <p>
2229
- * <code>MessageGroupId</code> is required for FIFO queues. You can't use it for
2230
- * Standard queues.</p>
2231
- * </important>
2232
2242
  * @public
2233
2243
  */
2234
2244
  MessageGroupId?: string | undefined;
@@ -2402,25 +2412,43 @@ export interface SendMessageBatchRequestEntry {
2402
2412
  */
2403
2413
  MessageDeduplicationId?: string | undefined;
2404
2414
  /**
2405
- * <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
2406
- * <p>The tag that specifies that a message belongs to a specific message group. Messages
2407
- * that belong to the same message group are processed in a FIFO manner (however,
2408
- * messages in different message groups might be processed out of order). To interleave
2409
- * multiple ordered streams within a single queue, use <code>MessageGroupId</code> values
2410
- * (for example, session data for multiple users). In this scenario, multiple consumers can
2411
- * process the queue, but the session data of each user is processed in a FIFO
2412
- * fashion.</p>
2415
+ * <p>
2416
+ * <code>MessageGroupId</code> is an attribute used in Amazon SQS FIFO (First-In-First-Out) and standard queues.
2417
+ * In FIFO queues, <code>MessageGroupId</code> organizes messages into distinct groups.
2418
+ * Messages within the same message group are always processed one at a time, in strict order,
2419
+ * ensuring that no two messages from the same group are processed simultaneously.
2420
+ * In standard queues, using <code>MessageGroupId</code> enables fair queues.
2421
+ * It is used to identify the tenant a message belongs to,
2422
+ * helping maintain consistent message dwell time across all tenants during noisy neighbor events.
2423
+ * Unlike FIFO queues, messages with the same <code>MessageGroupId</code> can be processed in parallel,
2424
+ * maintaining the high throughput of standard queues.</p>
2413
2425
  * <ul>
2414
2426
  * <li>
2415
- * <p>You must associate a non-empty <code>MessageGroupId</code> with a message. If
2416
- * you don't provide a <code>MessageGroupId</code>, the action fails.</p>
2427
+ * <p>
2428
+ * <b>FIFO queues:</b>
2429
+ * <code>MessageGroupId</code> acts as the tag
2430
+ * that specifies that a message belongs to a specific message group.
2431
+ * Messages that belong to the same message group are processed in a FIFO manner
2432
+ * (however, messages in different message groups might be processed out of order).
2433
+ * To interleave multiple ordered streams within a single queue, use <code>MessageGroupId</code> values
2434
+ * (for example, session data for multiple users).
2435
+ * In this scenario, multiple consumers can process the queue,
2436
+ * but the session data of each user is processed in a FIFO fashion.</p>
2437
+ * <p>If you do not provide a <code>MessageGroupId</code> when sending a message to a FIFO queue, the action fails.</p>
2438
+ * <p>
2439
+ * <code>ReceiveMessage</code> might return messages with multiple <code>MessageGroupId</code> values.
2440
+ * For each <code>MessageGroupId</code>, the messages are sorted by time sent.</p>
2417
2441
  * </li>
2418
2442
  * <li>
2419
2443
  * <p>
2420
- * <code>ReceiveMessage</code> might return messages with multiple
2421
- * <code>MessageGroupId</code> values. For each <code>MessageGroupId</code>,
2422
- * the messages are sorted by time sent. The caller can't specify a
2423
- * <code>MessageGroupId</code>.</p>
2444
+ * <b>Standard queues:</b>Use <code>MessageGroupId</code> in standard queues to enable fair queues.
2445
+ * The <code>MessageGroupId</code> identifies the tenant a message belongs to.
2446
+ * A tenant can be any entity that shares a queue with others, such as your customer, a client application,
2447
+ * or a request type. When one tenant sends a disproportionately large volume of messages
2448
+ * or has messages that require longer processing time, fair queues ensure other tenants'
2449
+ * messages maintain low dwell time. This preserves quality of service for all tenants while
2450
+ * maintaining the scalability and throughput of standard queues.
2451
+ * We recommend that you include a <code>MessageGroupId</code> in all messages when using fair queues.</p>
2424
2452
  * </li>
2425
2453
  * </ul>
2426
2454
  * <p>The length of <code>MessageGroupId</code> is 128 characters. Valid values:
@@ -2428,11 +2456,6 @@ export interface SendMessageBatchRequestEntry {
2428
2456
  * <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~)</code>.</p>
2429
2457
  * <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
2430
2458
  * Guide</i>.</p>
2431
- * <important>
2432
- * <p>
2433
- * <code>MessageGroupId</code> is required for FIFO queues. You can't use it for
2434
- * Standard queues.</p>
2435
- * </important>
2436
2459
  * @public
2437
2460
  */
2438
2461
  MessageGroupId?: string | undefined;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-sqs",
3
3
  "description": "AWS SDK for JavaScript Sqs Client for Node.js, Browser and React Native",
4
- "version": "3.848.0",
4
+ "version": "3.854.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-sqs",