@aws-sdk/client-sqs 3.326.0 → 3.328.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.
@@ -110,13 +110,13 @@ export declare class BatchEntryIdsNotDistinct extends __BaseException {
110
110
  * </important>
111
111
  * <p>
112
112
  * <code>&ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2</code>
113
- * </p>
113
+ * </p>
114
114
  * <p>
115
115
  * <code>&ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=your_receipt_handle</code>
116
- * </p>
116
+ * </p>
117
117
  * <p>
118
118
  * <code>&ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45</code>
119
- * </p>
119
+ * </p>
120
120
  */
121
121
  export interface ChangeMessageVisibilityBatchRequestEntry {
122
122
  /**
@@ -244,10 +244,38 @@ export declare class TooManyEntriesInBatchRequest extends __BaseException {
244
244
  */
245
245
  constructor(opts: __ExceptionOptionType<TooManyEntriesInBatchRequest, __BaseException>);
246
246
  }
247
+ /**
248
+ * @public
249
+ * @enum
250
+ */
251
+ export declare const QueueAttributeName: {
252
+ readonly All: "All";
253
+ readonly ApproximateNumberOfMessages: "ApproximateNumberOfMessages";
254
+ readonly ApproximateNumberOfMessagesDelayed: "ApproximateNumberOfMessagesDelayed";
255
+ readonly ApproximateNumberOfMessagesNotVisible: "ApproximateNumberOfMessagesNotVisible";
256
+ readonly ContentBasedDeduplication: "ContentBasedDeduplication";
257
+ readonly CreatedTimestamp: "CreatedTimestamp";
258
+ readonly DeduplicationScope: "DeduplicationScope";
259
+ readonly DelaySeconds: "DelaySeconds";
260
+ readonly FifoQueue: "FifoQueue";
261
+ readonly FifoThroughputLimit: "FifoThroughputLimit";
262
+ readonly KmsDataKeyReusePeriodSeconds: "KmsDataKeyReusePeriodSeconds";
263
+ readonly KmsMasterKeyId: "KmsMasterKeyId";
264
+ readonly LastModifiedTimestamp: "LastModifiedTimestamp";
265
+ readonly MaximumMessageSize: "MaximumMessageSize";
266
+ readonly MessageRetentionPeriod: "MessageRetentionPeriod";
267
+ readonly Policy: "Policy";
268
+ readonly QueueArn: "QueueArn";
269
+ readonly ReceiveMessageWaitTimeSeconds: "ReceiveMessageWaitTimeSeconds";
270
+ readonly RedriveAllowPolicy: "RedriveAllowPolicy";
271
+ readonly RedrivePolicy: "RedrivePolicy";
272
+ readonly SqsManagedSseEnabled: "SqsManagedSseEnabled";
273
+ readonly VisibilityTimeout: "VisibilityTimeout";
274
+ };
247
275
  /**
248
276
  * @public
249
277
  */
250
- export type QueueAttributeName = "All" | "ApproximateNumberOfMessages" | "ApproximateNumberOfMessagesDelayed" | "ApproximateNumberOfMessagesNotVisible" | "ContentBasedDeduplication" | "CreatedTimestamp" | "DeduplicationScope" | "DelaySeconds" | "FifoQueue" | "FifoThroughputLimit" | "KmsDataKeyReusePeriodSeconds" | "KmsMasterKeyId" | "LastModifiedTimestamp" | "MaximumMessageSize" | "MessageRetentionPeriod" | "Policy" | "QueueArn" | "ReceiveMessageWaitTimeSeconds" | "RedriveAllowPolicy" | "RedrivePolicy" | "SqsManagedSseEnabled" | "VisibilityTimeout";
278
+ export type QueueAttributeName = (typeof QueueAttributeName)[keyof typeof QueueAttributeName];
251
279
  /**
252
280
  * @public
253
281
  * <p></p>
@@ -257,13 +285,13 @@ export interface CreateQueueRequest {
257
285
  * <p>The name of the new queue. The following limits apply to this name:</p>
258
286
  * <ul>
259
287
  * <li>
260
- * <p>A queue name can have up to 80 characters.</p>
288
+ * <p>A queue name can have up to 80 characters.</p>
261
289
  * </li>
262
290
  * <li>
263
- * <p>Valid values: alphanumeric characters, hyphens (<code>-</code>), and underscores (<code>_</code>).</p>
291
+ * <p>Valid values: alphanumeric characters, hyphens (<code>-</code>), and underscores (<code>_</code>).</p>
264
292
  * </li>
265
293
  * <li>
266
- * <p>A FIFO queue name must end with the <code>.fifo</code> suffix.</p>
294
+ * <p>A FIFO queue name must end with the <code>.fifo</code> suffix.</p>
267
295
  * </li>
268
296
  * </ul>
269
297
  * <p>Queue URLs and names are case-sensitive.</p>
@@ -272,7 +300,6 @@ export interface CreateQueueRequest {
272
300
  /**
273
301
  * <p>Add cost allocation tags to the specified Amazon SQS queue. For an overview, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html">Tagging
274
302
  * Your Amazon SQS Queues</a> in the <i>Amazon SQS Developer Guide</i>.</p>
275
- *
276
303
  * <p>When you use queue tags, keep the following guidelines in mind:</p>
277
304
  * <ul>
278
305
  * <li>
@@ -336,13 +363,13 @@ export interface CreateQueueRequest {
336
363
  * <code>RedrivePolicy</code> – The string that includes the parameters for the dead-letter queue functionality
337
364
  * of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">Using Amazon SQS Dead-Letter Queues</a>
338
365
  * in the <i>Amazon SQS Developer Guide</i>.</p>
339
- * <ul>
366
+ * <ul>
340
367
  * <li>
341
- * <p>
368
+ * <p>
342
369
  * <code>deadLetterTargetArn</code> – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of <code>maxReceiveCount</code> is exceeded.</p>
343
370
  * </li>
344
371
  * <li>
345
- * <p>
372
+ * <p>
346
373
  * <code>maxReceiveCount</code> – The number of times a message is delivered to the source queue before being moved to the dead-letter queue.
347
374
  * When the <code>ReceiveCount</code> for a message exceeds the <code>maxReceiveCount</code> for a queue, Amazon SQS moves the message to the dead-letter-queue.</p>
348
375
  * </li>
@@ -357,11 +384,10 @@ export interface CreateQueueRequest {
357
384
  * <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>.</p>
358
385
  * </li>
359
386
  * </ul>
360
- *
361
387
  * <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html">server-side-encryption</a>:</p>
362
388
  * <ul>
363
389
  * <li>
364
- * <p>
390
+ * <p>
365
391
  * <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key Terms</a>.
366
392
  * While the alias of the Amazon Web Services managed CMK for Amazon SQS is always <code>alias/aws/sqs</code>, the alias of a custom CMK can, for example, be <code>alias/<i>MyAlias</i>
367
393
  * </code>.
@@ -369,7 +395,7 @@ export interface CreateQueueRequest {
369
395
  * </p>
370
396
  * </li>
371
397
  * <li>
372
- * <p>
398
+ * <p>
373
399
  * <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in seconds, for which Amazon SQS can reuse a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data key</a> to encrypt
374
400
  * or decrypt messages before calling KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security
375
401
  * but results in more calls to KMS which might incur charges after Free Tier. For more information, see
@@ -377,16 +403,14 @@ export interface CreateQueueRequest {
377
403
  * </p>
378
404
  * </li>
379
405
  * <li>
380
- * <p>
406
+ * <p>
381
407
  * <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html">SSE-KMS</a> or <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html">SSE-SQS</a>).</p>
382
408
  * </li>
383
409
  * </ul>
384
- *
385
- *
386
410
  * <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO (first-in-first-out) queues</a>:</p>
387
411
  * <ul>
388
412
  * <li>
389
- * <p>
413
+ * <p>
390
414
  * <code>FifoQueue</code> – Designates a queue as FIFO. Valid values are <code>true</code> and <code>false</code>. If you don't specify the <code>FifoQueue</code> attribute, Amazon SQS creates a standard queue.
391
415
  * You can provide this attribute only during queue creation. You can't change it for an existing queue.
392
416
  * When you set this attribute, you must also provide the <code>MessageGroupId</code> for your messages explicitly.</p>
@@ -395,45 +419,43 @@ export interface CreateQueueRequest {
395
419
  * in the <i>Amazon SQS Developer Guide</i>.</p>
396
420
  * </li>
397
421
  * <li>
398
- * <p>
422
+ * <p>
399
423
  * <code>ContentBasedDeduplication</code> – Enables content-based deduplication. Valid values are <code>true</code> and <code>false</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html">Exactly-once processing</a> in the
400
424
  * <i>Amazon SQS Developer Guide</i>. Note the following:
401
425
  * </p>
402
- * <ul>
426
+ * <ul>
403
427
  * <li>
404
- * <p>Every message must have a unique <code>MessageDeduplicationId</code>.</p>
405
- * <ul>
428
+ * <p>Every message must have a unique <code>MessageDeduplicationId</code>.</p>
429
+ * <ul>
406
430
  * <li>
407
- * <p>You may provide a <code>MessageDeduplicationId</code> explicitly.</p>
408
- * </li>
431
+ * <p>You may provide a <code>MessageDeduplicationId</code> explicitly.</p>
432
+ * </li>
409
433
  * <li>
410
- * <p>If you aren't able to provide a <code>MessageDeduplicationId</code> and you enable <code>ContentBasedDeduplication</code> for your queue,
434
+ * <p>If you aren't able to provide a <code>MessageDeduplicationId</code> and you enable <code>ContentBasedDeduplication</code> for your queue,
411
435
  * Amazon SQS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using the body of the message (but not the attributes of the message).
412
436
  * </p>
413
- * </li>
437
+ * </li>
414
438
  * <li>
415
- * <p>If you don't provide a <code>MessageDeduplicationId</code> and the queue doesn't have <code>ContentBasedDeduplication</code> set,
439
+ * <p>If you don't provide a <code>MessageDeduplicationId</code> and the queue doesn't have <code>ContentBasedDeduplication</code> set,
416
440
  * the action fails with an error.</p>
417
- * </li>
441
+ * </li>
418
442
  * <li>
419
- * <p>If the queue has <code>ContentBasedDeduplication</code> set, your <code>MessageDeduplicationId</code> overrides the generated one.</p>
420
- * </li>
443
+ * <p>If the queue has <code>ContentBasedDeduplication</code> set, your <code>MessageDeduplicationId</code> overrides the generated one.</p>
444
+ * </li>
421
445
  * </ul>
422
446
  * </li>
423
447
  * <li>
424
- * <p>When <code>ContentBasedDeduplication</code> is in effect, messages with identical content sent within the deduplication interval are treated as duplicates
448
+ * <p>When <code>ContentBasedDeduplication</code> is in effect, messages with identical content sent within the deduplication interval are treated as duplicates
425
449
  * and only one copy of the message is delivered.</p>
426
450
  * </li>
427
451
  * <li>
428
- * <p>If you send one message with <code>ContentBasedDeduplication</code> enabled and then another message with a <code>MessageDeduplicationId</code> that is the same
452
+ * <p>If you send one message with <code>ContentBasedDeduplication</code> enabled and then another message with a <code>MessageDeduplicationId</code> that is the same
429
453
  * as the one generated for the first <code>MessageDeduplicationId</code>, the two messages are treated as duplicates and only one copy of the message is delivered.
430
454
  * </p>
431
455
  * </li>
432
456
  * </ul>
433
457
  * </li>
434
458
  * </ul>
435
- *
436
- *
437
459
  * <p>The following attributes apply only to
438
460
  * <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html">high throughput
439
461
  * for FIFO queues</a>:</p>
@@ -703,13 +725,13 @@ export interface GetQueueAttributesRequest {
703
725
  * <code>RedrivePolicy</code> – The string that includes the parameters for the dead-letter queue functionality
704
726
  * of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">Using Amazon SQS Dead-Letter Queues</a>
705
727
  * in the <i>Amazon SQS Developer Guide</i>.</p>
706
- * <ul>
728
+ * <ul>
707
729
  * <li>
708
- * <p>
730
+ * <p>
709
731
  * <code>deadLetterTargetArn</code> – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of <code>maxReceiveCount</code> is exceeded.</p>
710
732
  * </li>
711
733
  * <li>
712
- * <p>
734
+ * <p>
713
735
  * <code>maxReceiveCount</code> – The number of times a message is delivered to the source queue before being moved to the dead-letter queue.
714
736
  * When the <code>ReceiveCount</code> for a message exceeds the <code>maxReceiveCount</code> for a queue, Amazon SQS moves the message to the dead-letter-queue.</p>
715
737
  * </li>
@@ -721,44 +743,39 @@ export interface GetQueueAttributesRequest {
721
743
  * </p>
722
744
  * </li>
723
745
  * </ul>
724
- *
725
746
  * <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html">server-side-encryption</a>:</p>
726
747
  * <ul>
727
748
  * <li>
728
- * <p>
749
+ * <p>
729
750
  * <code>KmsMasterKeyId</code> – Returns the ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key Terms</a>.
730
751
  * </p>
731
752
  * </li>
732
753
  * <li>
733
- * <p>
754
+ * <p>
734
755
  * <code>KmsDataKeyReusePeriodSeconds</code> – Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling KMS again.
735
756
  * For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work">How Does the Data Key Reuse Period Work?</a>.
736
757
  * </p>
737
758
  * </li>
738
759
  * <li>
739
- * <p>
760
+ * <p>
740
761
  * <code>SqsManagedSseEnabled</code> – Returns information about whether the queue is using SSE-SQS encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html">SSE-KMS</a> or <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html">SSE-SQS</a>).</p>
741
762
  * </li>
742
763
  * </ul>
743
- *
744
- *
745
764
  * <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO (first-in-first-out) queues</a>:</p>
746
765
  * <ul>
747
766
  * <li>
748
- * <p>
767
+ * <p>
749
768
  * <code>FifoQueue</code> – Returns information about whether the queue is FIFO. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html">FIFO queue logic</a> in the <i>Amazon SQS Developer Guide</i>.</p>
750
- * <note>
769
+ * <note>
751
770
  * <p>To determine whether a queue is <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO</a>, you can check whether <code>QueueName</code> ends with the <code>.fifo</code> suffix.</p>
752
771
  * </note>
753
772
  * </li>
754
773
  * <li>
755
- * <p>
774
+ * <p>
756
775
  * <code>ContentBasedDeduplication</code> – Returns whether content-based deduplication is enabled for the queue. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html">Exactly-once processing</a> in the <i>Amazon SQS Developer Guide</i>.
757
776
  * </p>
758
777
  * </li>
759
778
  * </ul>
760
- *
761
- *
762
779
  * <p>The following attributes apply only to
763
780
  * <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html">high throughput
764
781
  * for FIFO queues</a>:</p>
@@ -999,11 +1016,11 @@ export interface ReceiveMessageRequest {
999
1016
  * </p>
1000
1017
  * <ul>
1001
1018
  * <li>
1002
- * <p>For an IAM user, returns the IAM user ID, for example <code>ABCDEFGHI1JKLMNOPQ23R</code>.</p>
1003
- * </li>
1019
+ * <p>For an IAM user, returns the IAM user ID, for example <code>ABCDEFGHI1JKLMNOPQ23R</code>.</p>
1020
+ * </li>
1004
1021
  * <li>
1005
- * <p>For an IAM role, returns the IAM role ID, for example <code>ABCDE1F2GH3I4JK5LMNOP:i-a123b456</code>.</p>
1006
- * </li>
1022
+ * <p>For an IAM role, returns the IAM role ID, for example <code>ABCDE1F2GH3I4JK5LMNOP:i-a123b456</code>.</p>
1023
+ * </li>
1007
1024
  * </ul>
1008
1025
  * </li>
1009
1026
  * <li>
@@ -1011,7 +1028,7 @@ export interface ReceiveMessageRequest {
1011
1028
  * <code>SentTimestamp</code> – Returns the time the message was sent to the queue (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a> in milliseconds).</p>
1012
1029
  * </li>
1013
1030
  * <li>
1014
- * <p>
1031
+ * <p>
1015
1032
  * <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html">SSE-KMS</a> or <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html">SSE-SQS</a>).</p>
1016
1033
  * </li>
1017
1034
  * <li>
@@ -1056,7 +1073,6 @@ export interface ReceiveMessageRequest {
1056
1073
  * <p>The name can be up to 256 characters long.</p>
1057
1074
  * </li>
1058
1075
  * </ul>
1059
- *
1060
1076
  * <p>When using <code>ReceiveMessage</code>, you can send a list of attribute names to receive, or you can return all of the attributes by specifying <code>All</code> or <code>.*</code> in your request.
1061
1077
  * You can also use all message attributes starting with a prefix, for example <code>bar.*</code>.</p>
1062
1078
  */
@@ -1101,7 +1117,7 @@ export interface ReceiveMessageRequest {
1101
1117
  * it resets the visibility timeout. For more information, see
1102
1118
  * <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility Timeout</a>
1103
1119
  * in the <i>Amazon SQS Developer Guide</i>.</p>
1104
- * <important>
1120
+ * <important>
1105
1121
  * <p>If a caller of the <code>ReceiveMessage</code> action still processes
1106
1122
  * messages when the visibility timeout expires and messages become visible,
1107
1123
  * another worker consuming from the same queue can receive the same messages
@@ -1109,7 +1125,7 @@ export interface ReceiveMessageRequest {
1109
1125
  * processing time is longer than the visibility timeout tries to delete the
1110
1126
  * processed messages, the action fails with an error.</p>
1111
1127
  * <p>To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary.</p>
1112
- * </important>
1128
+ * </important>
1113
1129
  * </li>
1114
1130
  * <li>
1115
1131
  * <p>While messages with a particular <code>MessageGroupId</code> are invisible, no more messages belonging to the same <code>MessageGroupId</code> are returned until the visibility timeout expires. You can still receive
@@ -1130,8 +1146,22 @@ export interface ReceiveMessageRequest {
1130
1146
  }
1131
1147
  /**
1132
1148
  * @public
1149
+ * @enum
1133
1150
  */
1134
- export type MessageSystemAttributeName = "AWSTraceHeader" | "ApproximateFirstReceiveTimestamp" | "ApproximateReceiveCount" | "MessageDeduplicationId" | "MessageGroupId" | "SenderId" | "SentTimestamp" | "SequenceNumber";
1151
+ export declare const MessageSystemAttributeName: {
1152
+ readonly AWSTraceHeader: "AWSTraceHeader";
1153
+ readonly ApproximateFirstReceiveTimestamp: "ApproximateFirstReceiveTimestamp";
1154
+ readonly ApproximateReceiveCount: "ApproximateReceiveCount";
1155
+ readonly MessageDeduplicationId: "MessageDeduplicationId";
1156
+ readonly MessageGroupId: "MessageGroupId";
1157
+ readonly SenderId: "SenderId";
1158
+ readonly SentTimestamp: "SentTimestamp";
1159
+ readonly SequenceNumber: "SequenceNumber";
1160
+ };
1161
+ /**
1162
+ * @public
1163
+ */
1164
+ export type MessageSystemAttributeName = (typeof MessageSystemAttributeName)[keyof typeof MessageSystemAttributeName];
1135
1165
  /**
1136
1166
  * @public
1137
1167
  * <p>The user-specified message attribute value. For string data types, the <code>Value</code> attribute has the same restrictions on the content as the message body. For more information, see <code>
@@ -1282,10 +1312,17 @@ export declare class InvalidMessageContents extends __BaseException {
1282
1312
  */
1283
1313
  constructor(opts: __ExceptionOptionType<InvalidMessageContents, __BaseException>);
1284
1314
  }
1315
+ /**
1316
+ * @public
1317
+ * @enum
1318
+ */
1319
+ export declare const MessageSystemAttributeNameForSends: {
1320
+ readonly AWSTraceHeader: "AWSTraceHeader";
1321
+ };
1285
1322
  /**
1286
1323
  * @public
1287
1324
  */
1288
- export type MessageSystemAttributeNameForSends = "AWSTraceHeader";
1325
+ export type MessageSystemAttributeNameForSends = (typeof MessageSystemAttributeNameForSends)[keyof typeof MessageSystemAttributeNameForSends];
1289
1326
  /**
1290
1327
  * @public
1291
1328
  * <p>The user-specified message system attribute value. For string data types, the <code>Value</code> attribute has the same restrictions on the content as the message body. For more information, see <code>
@@ -1330,11 +1367,11 @@ export interface SendMessageRequest {
1330
1367
  /**
1331
1368
  * <p>The message to send. The minimum size is one character. The maximum size is 256 KB.</p>
1332
1369
  * <important>
1333
- * <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:</p>
1334
- * <p>
1370
+ * <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:</p>
1371
+ * <p>
1335
1372
  * <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>
1336
1373
  * </p>
1337
- * <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>
1374
+ * <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>
1338
1375
  * </important>
1339
1376
  */
1340
1377
  MessageBody: string | undefined;
@@ -1363,10 +1400,10 @@ export interface SendMessageRequest {
1363
1400
  * <p>Currently, the only supported message system attribute is <code>AWSTraceHeader</code>.
1364
1401
  * Its type must be <code>String</code> and its value must be a correctly formatted
1365
1402
  * X-Ray trace header string.</p>
1366
- * </li>
1403
+ * </li>
1367
1404
  * <li>
1368
1405
  * <p>The size of a message system attribute doesn't count towards the total size of a message.</p>
1369
- * </li>
1406
+ * </li>
1370
1407
  * </ul>
1371
1408
  * </important>
1372
1409
  */
@@ -1378,31 +1415,31 @@ export interface SendMessageRequest {
1378
1415
  * Exactly-once processing</a> in the <i>Amazon SQS Developer Guide</i>.</p>
1379
1416
  * <ul>
1380
1417
  * <li>
1381
- * <p>Every message must have a unique <code>MessageDeduplicationId</code>,</p>
1382
- * <ul>
1418
+ * <p>Every message must have a unique <code>MessageDeduplicationId</code>,</p>
1419
+ * <ul>
1383
1420
  * <li>
1384
- * <p>You may provide a <code>MessageDeduplicationId</code> explicitly.</p>
1421
+ * <p>You may provide a <code>MessageDeduplicationId</code> explicitly.</p>
1385
1422
  * </li>
1386
1423
  * <li>
1387
- * <p>If you aren't able to provide a <code>MessageDeduplicationId</code> and you enable <code>ContentBasedDeduplication</code> for your queue,
1424
+ * <p>If you aren't able to provide a <code>MessageDeduplicationId</code> and you enable <code>ContentBasedDeduplication</code> for your queue,
1388
1425
  * Amazon SQS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using the body of the message (but not the attributes of the message).
1389
1426
  * </p>
1390
1427
  * </li>
1391
1428
  * <li>
1392
- * <p>If you don't provide a <code>MessageDeduplicationId</code> and the queue doesn't have <code>ContentBasedDeduplication</code> set,
1429
+ * <p>If you don't provide a <code>MessageDeduplicationId</code> and the queue doesn't have <code>ContentBasedDeduplication</code> set,
1393
1430
  * the action fails with an error.</p>
1394
1431
  * </li>
1395
1432
  * <li>
1396
- * <p>If the queue has <code>ContentBasedDeduplication</code> set, your <code>MessageDeduplicationId</code> overrides the generated one.</p>
1433
+ * <p>If the queue has <code>ContentBasedDeduplication</code> set, your <code>MessageDeduplicationId</code> overrides the generated one.</p>
1397
1434
  * </li>
1398
1435
  * </ul>
1399
1436
  * </li>
1400
1437
  * <li>
1401
- * <p>When <code>ContentBasedDeduplication</code> is in effect, messages with identical content sent within the deduplication interval are treated as duplicates
1438
+ * <p>When <code>ContentBasedDeduplication</code> is in effect, messages with identical content sent within the deduplication interval are treated as duplicates
1402
1439
  * and only one copy of the message is delivered.</p>
1403
1440
  * </li>
1404
1441
  * <li>
1405
- * <p>If you send one message with <code>ContentBasedDeduplication</code> enabled and then another message with a <code>MessageDeduplicationId</code> that is the same
1442
+ * <p>If you send one message with <code>ContentBasedDeduplication</code> enabled and then another message with a <code>MessageDeduplicationId</code> that is the same
1406
1443
  * as the one generated for the first <code>MessageDeduplicationId</code>, the two messages are treated as duplicates and only one copy of the message is delivered.
1407
1444
  * </p>
1408
1445
  * </li>
@@ -1547,10 +1584,10 @@ export interface SendMessageBatchRequestEntry {
1547
1584
  * <p>Currently, the only supported message system attribute is <code>AWSTraceHeader</code>.
1548
1585
  * Its type must be <code>String</code> and its value must be a correctly formatted
1549
1586
  * X-Ray trace header string.</p>
1550
- * </li>
1587
+ * </li>
1551
1588
  * <li>
1552
1589
  * <p>The size of a message system attribute doesn't count towards the total size of a message.</p>
1553
- * </li>
1590
+ * </li>
1554
1591
  * </ul>
1555
1592
  * </important>
1556
1593
  */
@@ -1563,31 +1600,31 @@ export interface SendMessageBatchRequestEntry {
1563
1600
  * Exactly-once processing</a> in the <i>Amazon SQS Developer Guide</i>.</p>
1564
1601
  * <ul>
1565
1602
  * <li>
1566
- * <p>Every message must have a unique <code>MessageDeduplicationId</code>,</p>
1567
- * <ul>
1603
+ * <p>Every message must have a unique <code>MessageDeduplicationId</code>,</p>
1604
+ * <ul>
1568
1605
  * <li>
1569
- * <p>You may provide a <code>MessageDeduplicationId</code> explicitly.</p>
1606
+ * <p>You may provide a <code>MessageDeduplicationId</code> explicitly.</p>
1570
1607
  * </li>
1571
1608
  * <li>
1572
- * <p>If you aren't able to provide a <code>MessageDeduplicationId</code> and you enable <code>ContentBasedDeduplication</code> for your queue,
1609
+ * <p>If you aren't able to provide a <code>MessageDeduplicationId</code> and you enable <code>ContentBasedDeduplication</code> for your queue,
1573
1610
  * Amazon SQS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using the body of the message (but not the attributes of the message).
1574
1611
  * </p>
1575
1612
  * </li>
1576
1613
  * <li>
1577
- * <p>If you don't provide a <code>MessageDeduplicationId</code> and the queue doesn't have <code>ContentBasedDeduplication</code> set,
1614
+ * <p>If you don't provide a <code>MessageDeduplicationId</code> and the queue doesn't have <code>ContentBasedDeduplication</code> set,
1578
1615
  * the action fails with an error.</p>
1579
1616
  * </li>
1580
1617
  * <li>
1581
- * <p>If the queue has <code>ContentBasedDeduplication</code> set, your <code>MessageDeduplicationId</code> overrides the generated one.</p>
1618
+ * <p>If the queue has <code>ContentBasedDeduplication</code> set, your <code>MessageDeduplicationId</code> overrides the generated one.</p>
1582
1619
  * </li>
1583
1620
  * </ul>
1584
1621
  * </li>
1585
1622
  * <li>
1586
- * <p>When <code>ContentBasedDeduplication</code> is in effect, messages with identical content sent within the deduplication interval are treated as duplicates
1623
+ * <p>When <code>ContentBasedDeduplication</code> is in effect, messages with identical content sent within the deduplication interval are treated as duplicates
1587
1624
  * and only one copy of the message is delivered.</p>
1588
1625
  * </li>
1589
1626
  * <li>
1590
- * <p>If you send one message with <code>ContentBasedDeduplication</code> enabled and then another message with a <code>MessageDeduplicationId</code> that is the same
1627
+ * <p>If you send one message with <code>ContentBasedDeduplication</code> enabled and then another message with a <code>MessageDeduplicationId</code> that is the same
1591
1628
  * as the one generated for the first <code>MessageDeduplicationId</code>, the two messages are treated as duplicates and only one copy of the message is delivered.
1592
1629
  * </p>
1593
1630
  * </li>
@@ -1725,64 +1762,63 @@ export interface SetQueueAttributesRequest {
1725
1762
  * <p>The following lists the names, descriptions, and values of the special request parameters that the <code>SetQueueAttributes</code> action uses:</p>
1726
1763
  * <ul>
1727
1764
  * <li>
1728
- * <p>
1765
+ * <p>
1729
1766
  * <code>DelaySeconds</code> – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 (15 minutes). Default: 0.
1730
1767
  * </p>
1731
1768
  * </li>
1732
1769
  * <li>
1733
- * <p>
1770
+ * <p>
1734
1771
  * <code>MaximumMessageSize</code> – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
1735
1772
  * </p>
1736
1773
  * </li>
1737
1774
  * <li>
1738
- * <p>
1775
+ * <p>
1739
1776
  * <code>MessageRetentionPeriod</code> – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer representing seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days).
1740
1777
  * </p>
1741
1778
  * </li>
1742
1779
  * <li>
1743
- * <p>
1780
+ * <p>
1744
1781
  * <code>Policy</code> – The queue's policy. A valid Amazon Web Services policy. For more information about policy structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview of Amazon Web Services IAM Policies</a>
1745
1782
  * in the <i>Identity and Access Management User Guide</i>.
1746
1783
  * </p>
1747
1784
  * </li>
1748
1785
  * <li>
1749
- * <p>
1786
+ * <p>
1750
1787
  * <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in seconds, for which a <code>
1751
1788
  * <a>ReceiveMessage</a>
1752
1789
  * </code> action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.
1753
1790
  * </p>
1754
1791
  * </li>
1755
1792
  * <li>
1756
- * <p>
1793
+ * <p>
1757
1794
  * <code>RedrivePolicy</code> – The string that includes the parameters for the dead-letter queue functionality
1758
1795
  * of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">Using Amazon SQS Dead-Letter Queues</a>
1759
1796
  * in the <i>Amazon SQS Developer Guide</i>.</p>
1760
- * <ul>
1797
+ * <ul>
1761
1798
  * <li>
1762
- * <p>
1799
+ * <p>
1763
1800
  * <code>deadLetterTargetArn</code> – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of <code>maxReceiveCount</code> is exceeded.</p>
1764
1801
  * </li>
1765
1802
  * <li>
1766
- * <p>
1803
+ * <p>
1767
1804
  * <code>maxReceiveCount</code> – The number of times a message is delivered to the source queue before being moved to the dead-letter queue.
1768
1805
  * When the <code>ReceiveCount</code> for a message exceeds the <code>maxReceiveCount</code> for a queue, Amazon SQS moves the message to the dead-letter-queue.</p>
1769
1806
  * </li>
1770
1807
  * </ul>
1771
- * <note>
1808
+ * <note>
1772
1809
  * <p>The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.</p>
1773
- * </note>
1810
+ * </note>
1774
1811
  * </li>
1775
1812
  * <li>
1776
- * <p>
1813
+ * <p>
1777
1814
  * <code>VisibilityTimeout</code> – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout,
1778
1815
  * see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>.</p>
1779
1816
  * </li>
1780
1817
  * </ul>
1781
- *
1782
1818
  * <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html">server-side-encryption</a>:</p>
1783
1819
  * <ul>
1784
1820
  * <li>
1785
- * <p>
1821
+ * <p>
1786
1822
  * <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key Terms</a>.
1787
1823
  * While the alias of the AWS-managed CMK for Amazon SQS is always <code>alias/aws/sqs</code>, the alias of a custom CMK can, for example, be <code>alias/<i>MyAlias</i>
1788
1824
  * </code>.
@@ -1790,7 +1826,7 @@ export interface SetQueueAttributesRequest {
1790
1826
  * </p>
1791
1827
  * </li>
1792
1828
  * <li>
1793
- * <p>
1829
+ * <p>
1794
1830
  * <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in seconds, for which Amazon SQS can reuse a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data key</a> to encrypt
1795
1831
  * or decrypt messages before calling KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security
1796
1832
  * but results in more calls to KMS which might incur charges after Free Tier. For more information, see
@@ -1798,54 +1834,50 @@ export interface SetQueueAttributesRequest {
1798
1834
  * </p>
1799
1835
  * </li>
1800
1836
  * <li>
1801
- * <p>
1837
+ * <p>
1802
1838
  * <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html">SSE-KMS</a> or <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html">SSE-SQS</a>).</p>
1803
1839
  * </li>
1804
1840
  * </ul>
1805
- *
1806
- *
1807
1841
  * <p>The following attribute applies only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO (first-in-first-out) queues</a>:</p>
1808
1842
  * <ul>
1809
1843
  * <li>
1810
- * <p>
1844
+ * <p>
1811
1845
  * <code>ContentBasedDeduplication</code> – Enables content-based deduplication. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html">Exactly-once processing</a> in the
1812
1846
  * <i>Amazon SQS Developer Guide</i>. Note the following:
1813
1847
  * </p>
1814
- * <ul>
1848
+ * <ul>
1815
1849
  * <li>
1816
- * <p>Every message must have a unique <code>MessageDeduplicationId</code>.</p>
1817
- * <ul>
1850
+ * <p>Every message must have a unique <code>MessageDeduplicationId</code>.</p>
1851
+ * <ul>
1818
1852
  * <li>
1819
- * <p>You may provide a <code>MessageDeduplicationId</code> explicitly.</p>
1820
- * </li>
1853
+ * <p>You may provide a <code>MessageDeduplicationId</code> explicitly.</p>
1854
+ * </li>
1821
1855
  * <li>
1822
- * <p>If you aren't able to provide a <code>MessageDeduplicationId</code> and you enable <code>ContentBasedDeduplication</code> for your queue,
1856
+ * <p>If you aren't able to provide a <code>MessageDeduplicationId</code> and you enable <code>ContentBasedDeduplication</code> for your queue,
1823
1857
  * Amazon SQS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using the body of the message (but not the attributes of the message).
1824
1858
  * </p>
1825
- * </li>
1859
+ * </li>
1826
1860
  * <li>
1827
- * <p>If you don't provide a <code>MessageDeduplicationId</code> and the queue doesn't have <code>ContentBasedDeduplication</code> set,
1861
+ * <p>If you don't provide a <code>MessageDeduplicationId</code> and the queue doesn't have <code>ContentBasedDeduplication</code> set,
1828
1862
  * the action fails with an error.</p>
1829
- * </li>
1863
+ * </li>
1830
1864
  * <li>
1831
- * <p>If the queue has <code>ContentBasedDeduplication</code> set, your <code>MessageDeduplicationId</code> overrides the generated one.</p>
1832
- * </li>
1865
+ * <p>If the queue has <code>ContentBasedDeduplication</code> set, your <code>MessageDeduplicationId</code> overrides the generated one.</p>
1866
+ * </li>
1833
1867
  * </ul>
1834
1868
  * </li>
1835
1869
  * <li>
1836
- * <p>When <code>ContentBasedDeduplication</code> is in effect, messages with identical content sent within the deduplication interval are treated as duplicates
1870
+ * <p>When <code>ContentBasedDeduplication</code> is in effect, messages with identical content sent within the deduplication interval are treated as duplicates
1837
1871
  * and only one copy of the message is delivered.</p>
1838
1872
  * </li>
1839
1873
  * <li>
1840
- * <p>If you send one message with <code>ContentBasedDeduplication</code> enabled and then another message with a <code>MessageDeduplicationId</code> that is the same
1874
+ * <p>If you send one message with <code>ContentBasedDeduplication</code> enabled and then another message with a <code>MessageDeduplicationId</code> that is the same
1841
1875
  * as the one generated for the first <code>MessageDeduplicationId</code>, the two messages are treated as duplicates and only one copy of the message is delivered.
1842
1876
  * </p>
1843
1877
  * </li>
1844
1878
  * </ul>
1845
1879
  * </li>
1846
1880
  * </ul>
1847
- *
1848
- *
1849
1881
  * <p>The following attributes apply only to
1850
1882
  * <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html">high throughput
1851
1883
  * for FIFO queues</a>:</p>