@aws-sdk/client-sqs 3.569.0 → 3.572.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 +7 -8
- package/dist-cjs/index.js +7 -0
- package/dist-es/models/models_0.js +1 -0
- package/dist-es/protocols/Aws_json1_0.js +8 -0
- package/dist-types/SQS.d.ts +7 -8
- package/dist-types/SQSClient.d.ts +7 -8
- package/dist-types/commands/AddPermissionCommand.d.ts +11 -15
- package/dist-types/commands/CancelMessageMoveTaskCommand.d.ts +0 -3
- package/dist-types/commands/ChangeMessageVisibilityBatchCommand.d.ts +1 -3
- package/dist-types/commands/ChangeMessageVisibilityCommand.d.ts +8 -17
- package/dist-types/commands/CreateQueueCommand.d.ts +8 -9
- package/dist-types/commands/DeleteMessageBatchCommand.d.ts +1 -3
- package/dist-types/commands/DeleteMessageCommand.d.ts +6 -6
- package/dist-types/commands/DeleteQueueCommand.d.ts +3 -3
- package/dist-types/commands/GetQueueAttributesCommand.d.ts +1 -2
- package/dist-types/commands/GetQueueUrlCommand.d.ts +2 -2
- package/dist-types/commands/ListMessageMoveTasksCommand.d.ts +0 -3
- package/dist-types/commands/ListQueueTagsCommand.d.ts +6 -7
- package/dist-types/commands/ListQueuesCommand.d.ts +3 -3
- package/dist-types/commands/ReceiveMessageCommand.d.ts +9 -8
- package/dist-types/commands/RemovePermissionCommand.d.ts +4 -6
- package/dist-types/commands/SendMessageBatchCommand.d.ts +9 -16
- package/dist-types/commands/SendMessageCommand.d.ts +3 -8
- package/dist-types/commands/SetQueueAttributesCommand.d.ts +10 -14
- package/dist-types/commands/StartMessageMoveTaskCommand.d.ts +0 -4
- package/dist-types/commands/TagQueueCommand.d.ts +10 -13
- package/dist-types/commands/UntagQueueCommand.d.ts +5 -7
- package/dist-types/index.d.ts +7 -8
- package/dist-types/models/models_0.d.ts +420 -419
- package/dist-types/ts3.4/models/models_0.d.ts +11 -9
- package/package.json +8 -8
|
@@ -20,12 +20,9 @@ export interface AddPermissionRequest {
|
|
|
20
20
|
*/
|
|
21
21
|
Label: string | undefined;
|
|
22
22
|
/**
|
|
23
|
-
* <p>The Amazon Web
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
* account identification, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-making-api-requests.html#sqs-api-request-authentication">Your Amazon Web
|
|
27
|
-
* Services Identifiers</a> in the <i>Amazon SQS Developer
|
|
28
|
-
* Guide</i>.</p>
|
|
23
|
+
* <p>The Amazon Web Services account numbers of the <a href="https://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P">principals</a> who are to receive
|
|
24
|
+
* permission. For information about locating the Amazon Web Services account identification, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-making-api-requests.html#sqs-api-request-authentication">Your Amazon Web Services Identifiers</a> in the <i>Amazon SQS Developer
|
|
25
|
+
* Guide</i>.</p>
|
|
29
26
|
* @public
|
|
30
27
|
*/
|
|
31
28
|
AWSAccountIds: string[] | undefined;
|
|
@@ -240,8 +237,7 @@ export interface ChangeMessageVisibilityBatchRequestEntry {
|
|
|
240
237
|
* result.</p>
|
|
241
238
|
* <note>
|
|
242
239
|
* <p>The <code>Id</code>s of a batch request need to be unique within a request.</p>
|
|
243
|
-
* <p>This identifier can have up to 80 characters. The following characters are
|
|
244
|
-
* accepted: alphanumeric characters, hyphens(-), and underscores (_).</p>
|
|
240
|
+
* <p>This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).</p>
|
|
245
241
|
* </note>
|
|
246
242
|
* @public
|
|
247
243
|
*/
|
|
@@ -447,35 +443,36 @@ export interface CreateQueueRequest {
|
|
|
447
443
|
* </li>
|
|
448
444
|
* <li>
|
|
449
445
|
* <p>
|
|
450
|
-
* <code>MaximumMessageSize</code> – The limit of how many bytes a message
|
|
451
|
-
* contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes
|
|
446
|
+
* <code>MaximumMessageSize</code> – The limit of how many bytes a message
|
|
447
|
+
* can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes
|
|
452
448
|
* (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). </p>
|
|
453
449
|
* </li>
|
|
454
450
|
* <li>
|
|
455
451
|
* <p>
|
|
456
|
-
* <code>MessageRetentionPeriod</code> – The length of time, in seconds, for
|
|
457
|
-
* Amazon SQS retains a message. Valid values: An integer from 60 seconds (1
|
|
452
|
+
* <code>MessageRetentionPeriod</code> – The length of time, in seconds, for
|
|
453
|
+
* which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1
|
|
458
454
|
* minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days). When you
|
|
459
455
|
* change a queue's attributes, the change can take up to 60 seconds for most of
|
|
460
|
-
* the attributes to propagate throughout the Amazon SQS system. Changes made to
|
|
461
|
-
*
|
|
456
|
+
* the attributes to propagate throughout the Amazon SQS system. Changes made to the
|
|
457
|
+
* <code>MessageRetentionPeriod</code> attribute can take up to 15 minutes and
|
|
462
458
|
* will impact existing messages in the queue potentially causing them to be
|
|
463
459
|
* expired and deleted if the <code>MessageRetentionPeriod</code> is reduced below
|
|
464
460
|
* the age of existing messages.</p>
|
|
465
461
|
* </li>
|
|
466
462
|
* <li>
|
|
467
463
|
* <p>
|
|
468
|
-
* <code>Policy</code> – The queue's policy. A valid Amazon Web Services
|
|
469
|
-
*
|
|
470
|
-
* User Guide</i>. </p>
|
|
464
|
+
* <code>Policy</code> – The queue's policy. A valid Amazon Web Services policy. For more
|
|
465
|
+
* information about policy structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview of Amazon Web Services IAM
|
|
466
|
+
* Policies</a> in the <i>IAM User Guide</i>. </p>
|
|
471
467
|
* </li>
|
|
472
468
|
* <li>
|
|
473
469
|
* <p>
|
|
474
|
-
* <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in
|
|
475
|
-
* which a <code>
|
|
470
|
+
* <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in
|
|
471
|
+
* seconds, for which a <code>
|
|
476
472
|
* <a>ReceiveMessage</a>
|
|
477
|
-
* </code> action waits
|
|
478
|
-
* to arrive. Valid values: An integer from 0 to 20 (seconds).
|
|
473
|
+
* </code> action waits
|
|
474
|
+
* for a message to arrive. Valid values: An integer from 0 to 20 (seconds).
|
|
475
|
+
* Default: 0. </p>
|
|
479
476
|
* </li>
|
|
480
477
|
* <li>
|
|
481
478
|
* <p>
|
|
@@ -490,115 +487,102 @@ export interface CreateQueueRequest {
|
|
|
490
487
|
* <ul>
|
|
491
488
|
* <li>
|
|
492
489
|
* <p>
|
|
493
|
-
* <code>RedrivePolicy</code> – The string that includes the parameters for the
|
|
494
|
-
*
|
|
495
|
-
* parameters are as follows:</p>
|
|
490
|
+
* <code>RedrivePolicy</code> – The string that includes the parameters for the dead-letter queue functionality
|
|
491
|
+
* of the source queue as a JSON object. The parameters are as follows:</p>
|
|
496
492
|
* <ul>
|
|
497
493
|
* <li>
|
|
498
494
|
* <p>
|
|
499
|
-
* <code>deadLetterTargetArn</code> – The Amazon Resource Name (ARN) of
|
|
500
|
-
*
|
|
501
|
-
* of <code>maxReceiveCount</code> is exceeded.</p>
|
|
495
|
+
* <code>deadLetterTargetArn</code> – The Amazon Resource Name (ARN) of the dead-letter queue to
|
|
496
|
+
* which Amazon SQS moves messages after the value of <code>maxReceiveCount</code> is exceeded.</p>
|
|
502
497
|
* </li>
|
|
503
498
|
* <li>
|
|
504
499
|
* <p>
|
|
505
|
-
* <code>maxReceiveCount</code> – The number of times a message is
|
|
506
|
-
*
|
|
507
|
-
*
|
|
508
|
-
* exceeds the <code>maxReceiveCount</code> for a queue, Amazon SQS moves
|
|
509
|
-
* the message to the dead-letter-queue.</p>
|
|
500
|
+
* <code>maxReceiveCount</code> – The number of times a message is delivered to the source queue before being
|
|
501
|
+
* moved to the dead-letter queue. Default: 10. When the <code>ReceiveCount</code> for a message exceeds the <code>maxReceiveCount</code>
|
|
502
|
+
* for a queue, Amazon SQS moves the message to the dead-letter-queue.</p>
|
|
510
503
|
* </li>
|
|
511
504
|
* </ul>
|
|
512
505
|
* </li>
|
|
513
506
|
* <li>
|
|
514
507
|
* <p>
|
|
515
|
-
* <code>RedriveAllowPolicy</code> – The string that includes the parameters for
|
|
516
|
-
*
|
|
517
|
-
* queues can specify dead-letter queues as a JSON object. The parameters are as
|
|
518
|
-
* follows:</p>
|
|
508
|
+
* <code>RedriveAllowPolicy</code> – The string that includes the parameters for the permissions for the dead-letter
|
|
509
|
+
* queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:</p>
|
|
519
510
|
* <ul>
|
|
520
511
|
* <li>
|
|
521
512
|
* <p>
|
|
522
|
-
* <code>redrivePermission</code> – The permission type that defines
|
|
523
|
-
*
|
|
524
|
-
* queue. Valid values are:</p>
|
|
513
|
+
* <code>redrivePermission</code> – The permission type that defines which source queues can
|
|
514
|
+
* specify the current queue as the dead-letter queue. Valid values are:</p>
|
|
525
515
|
* <ul>
|
|
526
516
|
* <li>
|
|
527
517
|
* <p>
|
|
528
|
-
* <code>allowAll</code> – (Default) Any source queues in this
|
|
529
|
-
*
|
|
530
|
-
* Region can specify this queue as the dead-letter queue.</p>
|
|
518
|
+
* <code>allowAll</code> – (Default) Any source queues in this Amazon Web Services account in the same Region can
|
|
519
|
+
* specify this queue as the dead-letter queue.</p>
|
|
531
520
|
* </li>
|
|
532
521
|
* <li>
|
|
533
522
|
* <p>
|
|
534
|
-
* <code>denyAll</code> – No source queues can specify this queue
|
|
535
|
-
*
|
|
523
|
+
* <code>denyAll</code> – No source queues can specify this queue as the dead-letter
|
|
524
|
+
* queue.</p>
|
|
536
525
|
* </li>
|
|
537
526
|
* <li>
|
|
538
527
|
* <p>
|
|
539
|
-
* <code>byQueue</code> – Only queues specified by the
|
|
540
|
-
*
|
|
541
|
-
* queue as the dead-letter queue.</p>
|
|
528
|
+
* <code>byQueue</code> – Only queues specified by the <code>sourceQueueArns</code> parameter can specify
|
|
529
|
+
* this queue as the dead-letter queue.</p>
|
|
542
530
|
* </li>
|
|
543
531
|
* </ul>
|
|
544
532
|
* </li>
|
|
545
533
|
* <li>
|
|
546
534
|
* <p>
|
|
547
|
-
* <code>sourceQueueArns</code> – The Amazon Resource Names (ARN)s of the
|
|
548
|
-
*
|
|
549
|
-
*
|
|
550
|
-
*
|
|
551
|
-
*
|
|
552
|
-
* allow more than 10 source queues to specify dead-letter queues, set the
|
|
553
|
-
* <code>redrivePermission</code> parameter to
|
|
554
|
-
* <code>allowAll</code>.</p>
|
|
535
|
+
* <code>sourceQueueArns</code> – The Amazon Resource Names (ARN)s of the source queues that can specify
|
|
536
|
+
* this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the
|
|
537
|
+
* <code>redrivePermission</code> parameter is set to <code>byQueue</code>. You can specify up to 10 source queue ARNs.
|
|
538
|
+
* To allow more than 10 source queues to specify dead-letter queues, set the <code>redrivePermission</code> parameter
|
|
539
|
+
* to <code>allowAll</code>.</p>
|
|
555
540
|
* </li>
|
|
556
541
|
* </ul>
|
|
557
542
|
* </li>
|
|
558
543
|
* </ul>
|
|
559
544
|
* <note>
|
|
560
|
-
* <p>The dead-letter queue of a
|
|
561
|
-
*
|
|
545
|
+
* <p>The dead-letter queue of a
|
|
546
|
+
* FIFO queue must also be a FIFO queue. Similarly, the dead-letter
|
|
547
|
+
* queue of a standard queue must also be a standard queue.</p>
|
|
562
548
|
* </note>
|
|
563
549
|
* <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>
|
|
564
550
|
* <ul>
|
|
565
551
|
* <li>
|
|
566
552
|
* <p>
|
|
567
|
-
* <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer
|
|
568
|
-
*
|
|
569
|
-
*
|
|
570
|
-
*
|
|
571
|
-
*
|
|
572
|
-
*
|
|
573
|
-
* For more examples, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a> in the <i>Key Management Service API
|
|
553
|
+
* <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer master
|
|
554
|
+
* 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>. While the alias of the Amazon Web Services managed CMK for Amazon SQS is
|
|
555
|
+
* always <code>alias/aws/sqs</code>, the alias of a custom CMK can, for example,
|
|
556
|
+
* be <code>alias/<i>MyAlias</i>
|
|
557
|
+
* </code>. For more examples, see
|
|
558
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a> in the <i>Key Management Service API
|
|
574
559
|
* Reference</i>. </p>
|
|
575
560
|
* </li>
|
|
576
561
|
* <li>
|
|
577
562
|
* <p>
|
|
578
|
-
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in
|
|
579
|
-
* which Amazon SQS can reuse a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data key</a> to
|
|
580
|
-
* encrypt or decrypt messages before calling KMS again. An integer
|
|
581
|
-
* seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
|
582
|
-
* 300 (5 minutes). A shorter time period provides better security
|
|
583
|
-
* more calls to KMS which might incur charges after Free Tier. For
|
|
584
|
-
* 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>
|
|
563
|
+
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in
|
|
564
|
+
* 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
|
|
565
|
+
* encrypt or decrypt messages before calling KMS again. An integer
|
|
566
|
+
* representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
|
567
|
+
* hours). Default: 300 (5 minutes). A shorter time period provides better security
|
|
568
|
+
* but results in more calls to KMS which might incur charges after Free Tier. For
|
|
569
|
+
* 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>
|
|
585
570
|
* </p>
|
|
586
571
|
* </li>
|
|
587
572
|
* <li>
|
|
588
573
|
* <p>
|
|
589
|
-
* <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption
|
|
590
|
-
* SQS owned encryption keys. Only one server-side encryption option is
|
|
591
|
-
* per queue (for example, <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>
|
|
574
|
+
* <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption
|
|
575
|
+
* using SQS owned encryption keys. Only one server-side encryption option is
|
|
576
|
+
* supported per queue (for example, <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>
|
|
592
577
|
* </li>
|
|
593
578
|
* </ul>
|
|
594
|
-
* <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO
|
|
595
|
-
*
|
|
579
|
+
* <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)
|
|
580
|
+
* queues</a>:</p>
|
|
596
581
|
* <ul>
|
|
597
582
|
* <li>
|
|
598
583
|
* <p>
|
|
599
584
|
* <code>FifoQueue</code> – Designates a queue as FIFO. Valid values are
|
|
600
|
-
* <code>true</code> and <code>false</code>. If you don't specify the
|
|
601
|
-
* <code>FifoQueue</code> attribute, Amazon SQS creates a standard queue. You
|
|
585
|
+
* <code>true</code> and <code>false</code>. If you don't specify the <code>FifoQueue</code> attribute, Amazon SQS creates a standard queue. You
|
|
602
586
|
* can provide this attribute only during queue creation. You can't change it for
|
|
603
587
|
* an existing queue. When you set this attribute, you must also provide the
|
|
604
588
|
* <code>MessageGroupId</code> for your messages explicitly.</p>
|
|
@@ -607,9 +591,9 @@ export interface CreateQueueRequest {
|
|
|
607
591
|
* </li>
|
|
608
592
|
* <li>
|
|
609
593
|
* <p>
|
|
610
|
-
* <code>ContentBasedDeduplication</code> – Enables content-based
|
|
611
|
-
* Valid values are <code>true</code> and <code>false</code>. For
|
|
612
|
-
* 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
|
|
594
|
+
* <code>ContentBasedDeduplication</code> – Enables content-based
|
|
595
|
+
* deduplication. Valid values are <code>true</code> and <code>false</code>. For
|
|
596
|
+
* 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
|
|
613
597
|
* Guide</i>. Note the following: </p>
|
|
614
598
|
* <ul>
|
|
615
599
|
* <li>
|
|
@@ -623,8 +607,8 @@ export interface CreateQueueRequest {
|
|
|
623
607
|
* <li>
|
|
624
608
|
* <p>If you aren't able to provide a
|
|
625
609
|
* <code>MessageDeduplicationId</code> and you enable
|
|
626
|
-
* <code>ContentBasedDeduplication</code> for your queue,
|
|
627
|
-
*
|
|
610
|
+
* <code>ContentBasedDeduplication</code> for your queue, Amazon SQS
|
|
611
|
+
* uses a SHA-256 hash to generate the
|
|
628
612
|
* <code>MessageDeduplicationId</code> using the body of the
|
|
629
613
|
* message (but not the attributes of the message). </p>
|
|
630
614
|
* </li>
|
|
@@ -657,22 +641,20 @@ export interface CreateQueueRequest {
|
|
|
657
641
|
* </ul>
|
|
658
642
|
* </li>
|
|
659
643
|
* </ul>
|
|
660
|
-
* <p>The following attributes apply only to
|
|
661
|
-
*
|
|
644
|
+
* <p>The following attributes apply only to
|
|
645
|
+
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html">high throughput
|
|
646
|
+
* for FIFO queues</a>:</p>
|
|
662
647
|
* <ul>
|
|
663
648
|
* <li>
|
|
664
649
|
* <p>
|
|
665
|
-
* <code>DeduplicationScope</code> – Specifies whether message deduplication
|
|
666
|
-
*
|
|
667
|
-
* <code>messageGroup</code> and <code>queue</code>.</p>
|
|
650
|
+
* <code>DeduplicationScope</code> – Specifies whether message deduplication occurs at the
|
|
651
|
+
* message group or queue level. Valid values are <code>messageGroup</code> and <code>queue</code>.</p>
|
|
668
652
|
* </li>
|
|
669
653
|
* <li>
|
|
670
654
|
* <p>
|
|
671
655
|
* <code>FifoThroughputLimit</code> – Specifies whether the FIFO queue throughput
|
|
672
|
-
*
|
|
673
|
-
*
|
|
674
|
-
* <code>perMessageGroupId</code> value is allowed only when the value for
|
|
675
|
-
* <code>DeduplicationScope</code> is <code>messageGroup</code>.</p>
|
|
656
|
+
* quota applies to the entire queue or per message group. Valid values are <code>perQueue</code> and <code>perMessageGroupId</code>.
|
|
657
|
+
* The <code>perMessageGroupId</code> value is allowed only when the value for <code>DeduplicationScope</code> is <code>messageGroup</code>.</p>
|
|
676
658
|
* </li>
|
|
677
659
|
* </ul>
|
|
678
660
|
* <p>To enable high throughput for FIFO queues, do the following:</p>
|
|
@@ -685,43 +667,40 @@ export interface CreateQueueRequest {
|
|
|
685
667
|
* </li>
|
|
686
668
|
* </ul>
|
|
687
669
|
* <p>If you set these attributes to anything other than the values shown for enabling high
|
|
688
|
-
*
|
|
689
|
-
* <p>For information on throughput quotas,
|
|
690
|
-
*
|
|
691
|
-
*
|
|
670
|
+
* throughput, normal throughput is in effect and deduplication occurs as specified.</p>
|
|
671
|
+
* <p>For information on throughput quotas,
|
|
672
|
+
* see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html">Quotas related to messages</a>
|
|
673
|
+
* in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
692
674
|
* @public
|
|
693
675
|
*/
|
|
694
676
|
Attributes?: Partial<Record<QueueAttributeName, string>>;
|
|
695
677
|
/**
|
|
696
|
-
* <p>Add cost allocation tags to the specified Amazon SQS queue. For an overview, see
|
|
697
|
-
*
|
|
698
|
-
* Your Amazon SQS Queues</a> in the <i>Amazon SQS Developer
|
|
699
|
-
* Guide</i>.</p>
|
|
678
|
+
* <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
|
|
679
|
+
* Your Amazon SQS Queues</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
700
680
|
* <p>When you use queue tags, keep the following guidelines in mind:</p>
|
|
701
681
|
* <ul>
|
|
702
682
|
* <li>
|
|
703
683
|
* <p>Adding more than 50 tags to a queue isn't recommended.</p>
|
|
704
684
|
* </li>
|
|
705
685
|
* <li>
|
|
706
|
-
* <p>Tags don't have any semantic meaning. Amazon SQS interprets tags as character
|
|
707
|
-
* strings.</p>
|
|
686
|
+
* <p>Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.</p>
|
|
708
687
|
* </li>
|
|
709
688
|
* <li>
|
|
710
689
|
* <p>Tags are case-sensitive.</p>
|
|
711
690
|
* </li>
|
|
712
691
|
* <li>
|
|
713
|
-
* <p>A new tag with a key identical to that of an existing tag overwrites the
|
|
714
|
-
* existing tag.</p>
|
|
692
|
+
* <p>A new tag with a key identical to that of an existing tag overwrites the existing tag.</p>
|
|
715
693
|
* </li>
|
|
716
694
|
* </ul>
|
|
717
|
-
* <p>For a full list of tag restrictions, see
|
|
718
|
-
*
|
|
695
|
+
* <p>For a full list of tag restrictions, see
|
|
696
|
+
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues">Quotas related to queues</a>
|
|
697
|
+
* in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
719
698
|
* <note>
|
|
720
699
|
* <p>To be able to tag a queue on creation, you must have the
|
|
721
700
|
* <code>sqs:CreateQueue</code> and <code>sqs:TagQueue</code> permissions.</p>
|
|
722
|
-
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
723
|
-
*
|
|
724
|
-
*
|
|
701
|
+
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
702
|
+
* see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name">Grant
|
|
703
|
+
* cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
725
704
|
* </note>
|
|
726
705
|
* @public
|
|
727
706
|
*/
|
|
@@ -776,8 +755,8 @@ export declare class QueueDeletedRecently extends __BaseException {
|
|
|
776
755
|
constructor(opts: __ExceptionOptionType<QueueDeletedRecently, __BaseException>);
|
|
777
756
|
}
|
|
778
757
|
/**
|
|
779
|
-
* <p>A queue with this name already exists. Amazon SQS returns this error only if the
|
|
780
|
-
*
|
|
758
|
+
* <p>A queue with this name already exists. Amazon SQS returns this error only if the request
|
|
759
|
+
* includes attributes whose values differ from those of the existing queue.</p>
|
|
781
760
|
* @public
|
|
782
761
|
*/
|
|
783
762
|
export declare class QueueNameExists extends __BaseException {
|
|
@@ -829,8 +808,7 @@ export interface DeleteMessageBatchRequestEntry {
|
|
|
829
808
|
* result.</p>
|
|
830
809
|
* <note>
|
|
831
810
|
* <p>The <code>Id</code>s of a batch request need to be unique within a request.</p>
|
|
832
|
-
* <p>This identifier can have up to 80 characters. The following characters are
|
|
833
|
-
* accepted: alphanumeric characters, hyphens(-), and underscores (_).</p>
|
|
811
|
+
* <p>This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).</p>
|
|
834
812
|
* </note>
|
|
835
813
|
* @public
|
|
836
814
|
*/
|
|
@@ -925,9 +903,7 @@ export interface GetQueueAttributesRequest {
|
|
|
925
903
|
* <p>The <code>AttributeNames</code> parameter is optional, but if you don't specify values
|
|
926
904
|
* for this parameter, the request returns empty results.</p>
|
|
927
905
|
* <note>
|
|
928
|
-
* <p>In the future, new attributes might be added. If you write code that calls this
|
|
929
|
-
* action, we recommend that you structure your code so that it can handle new
|
|
930
|
-
* attributes gracefully.</p>
|
|
906
|
+
* <p>In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.</p>
|
|
931
907
|
* </note>
|
|
932
908
|
* <p>The following attributes are supported:</p>
|
|
933
909
|
* <important>
|
|
@@ -944,29 +920,29 @@ export interface GetQueueAttributesRequest {
|
|
|
944
920
|
* </li>
|
|
945
921
|
* <li>
|
|
946
922
|
* <p>
|
|
947
|
-
* <code>ApproximateNumberOfMessages</code> – Returns the approximate
|
|
948
|
-
* messages available for retrieval from the queue.</p>
|
|
923
|
+
* <code>ApproximateNumberOfMessages</code> – Returns the approximate
|
|
924
|
+
* number of messages available for retrieval from the queue.</p>
|
|
949
925
|
* </li>
|
|
950
926
|
* <li>
|
|
951
927
|
* <p>
|
|
952
|
-
* <code>ApproximateNumberOfMessagesDelayed</code> – Returns the
|
|
953
|
-
* number of messages in the queue that are delayed and not available
|
|
954
|
-
* immediately. This can happen when the queue is configured as a delay
|
|
955
|
-
* when a message has been sent with a delay parameter.</p>
|
|
928
|
+
* <code>ApproximateNumberOfMessagesDelayed</code> – Returns the
|
|
929
|
+
* approximate number of messages in the queue that are delayed and not available
|
|
930
|
+
* for reading immediately. This can happen when the queue is configured as a delay
|
|
931
|
+
* queue or when a message has been sent with a delay parameter.</p>
|
|
956
932
|
* </li>
|
|
957
933
|
* <li>
|
|
958
934
|
* <p>
|
|
959
|
-
* <code>ApproximateNumberOfMessagesNotVisible</code> – Returns the
|
|
960
|
-
* number of messages that are in flight. Messages are considered to be
|
|
935
|
+
* <code>ApproximateNumberOfMessagesNotVisible</code> – Returns the
|
|
936
|
+
* approximate number of messages that are in flight. Messages are considered to be
|
|
961
937
|
* <i>in flight</i> if they have been sent to a client but have
|
|
962
938
|
* not yet been deleted or have not yet reached the end of their visibility window.
|
|
963
939
|
* </p>
|
|
964
940
|
* </li>
|
|
965
941
|
* <li>
|
|
966
942
|
* <p>
|
|
967
|
-
* <code>CreatedTimestamp</code> – Returns the time when the queue was
|
|
968
|
-
* seconds (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch
|
|
969
|
-
*
|
|
943
|
+
* <code>CreatedTimestamp</code> – Returns the time when the queue was
|
|
944
|
+
* created in seconds (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch
|
|
945
|
+
* time</a>).</p>
|
|
970
946
|
* </li>
|
|
971
947
|
* <li>
|
|
972
948
|
* <p>
|
|
@@ -975,9 +951,8 @@ export interface GetQueueAttributesRequest {
|
|
|
975
951
|
* </li>
|
|
976
952
|
* <li>
|
|
977
953
|
* <p>
|
|
978
|
-
* <code>LastModifiedTimestamp</code> – Returns the time when the queue
|
|
979
|
-
* changed in seconds (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch
|
|
980
|
-
* time</a>).</p>
|
|
954
|
+
* <code>LastModifiedTimestamp</code> – Returns the time when the queue
|
|
955
|
+
* was last changed in seconds (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a>).</p>
|
|
981
956
|
* </li>
|
|
982
957
|
* <li>
|
|
983
958
|
* <p>
|
|
@@ -986,10 +961,10 @@ export interface GetQueueAttributesRequest {
|
|
|
986
961
|
* </li>
|
|
987
962
|
* <li>
|
|
988
963
|
* <p>
|
|
989
|
-
* <code>MessageRetentionPeriod</code> – Returns the length of time, in
|
|
990
|
-
* for which Amazon SQS retains a message. When you change a queue's
|
|
991
|
-
* the change can take up to 60 seconds for most of the attributes to
|
|
992
|
-
* throughout the Amazon SQS system. Changes made to the
|
|
964
|
+
* <code>MessageRetentionPeriod</code> – Returns the length of time, in
|
|
965
|
+
* seconds, for which Amazon SQS retains a message. When you change a queue's
|
|
966
|
+
* attributes, the change can take up to 60 seconds for most of the attributes to
|
|
967
|
+
* propagate throughout the Amazon SQS system. Changes made to the
|
|
993
968
|
* <code>MessageRetentionPeriod</code> attribute can take up to 15 minutes and
|
|
994
969
|
* will impact existing messages in the queue potentially causing them to be
|
|
995
970
|
* expired and deleted if the <code>MessageRetentionPeriod</code> is reduced below
|
|
@@ -1006,14 +981,14 @@ export interface GetQueueAttributesRequest {
|
|
|
1006
981
|
* </li>
|
|
1007
982
|
* <li>
|
|
1008
983
|
* <p>
|
|
1009
|
-
* <code>ReceiveMessageWaitTimeSeconds</code> – Returns the length of
|
|
1010
|
-
* seconds, for which the <code>ReceiveMessage</code> action waits for a
|
|
1011
|
-
* arrive. </p>
|
|
984
|
+
* <code>ReceiveMessageWaitTimeSeconds</code> – Returns the length of
|
|
985
|
+
* time, in seconds, for which the <code>ReceiveMessage</code> action waits for a
|
|
986
|
+
* message to arrive. </p>
|
|
1012
987
|
* </li>
|
|
1013
988
|
* <li>
|
|
1014
989
|
* <p>
|
|
1015
|
-
* <code>VisibilityTimeout</code> – Returns the visibility timeout for the
|
|
1016
|
-
* For more information about the visibility timeout, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility Timeout</a> in the <i>Amazon SQS Developer
|
|
990
|
+
* <code>VisibilityTimeout</code> – Returns the visibility timeout for the
|
|
991
|
+
* queue. For more information about the visibility timeout, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility Timeout</a> in the <i>Amazon SQS Developer
|
|
1017
992
|
* Guide</i>. </p>
|
|
1018
993
|
* </li>
|
|
1019
994
|
* </ul>
|
|
@@ -1022,108 +997,96 @@ export interface GetQueueAttributesRequest {
|
|
|
1022
997
|
* <ul>
|
|
1023
998
|
* <li>
|
|
1024
999
|
* <p>
|
|
1025
|
-
* <code>RedrivePolicy</code> – The string that includes the parameters for the
|
|
1026
|
-
*
|
|
1027
|
-
* parameters are as follows:</p>
|
|
1000
|
+
* <code>RedrivePolicy</code> – The string that includes the parameters for the dead-letter queue functionality
|
|
1001
|
+
* of the source queue as a JSON object. The parameters are as follows:</p>
|
|
1028
1002
|
* <ul>
|
|
1029
1003
|
* <li>
|
|
1030
1004
|
* <p>
|
|
1031
|
-
* <code>deadLetterTargetArn</code> – The Amazon Resource Name (ARN) of
|
|
1032
|
-
*
|
|
1033
|
-
* of <code>maxReceiveCount</code> is exceeded.</p>
|
|
1005
|
+
* <code>deadLetterTargetArn</code> – The Amazon Resource Name (ARN) of the dead-letter queue to
|
|
1006
|
+
* which Amazon SQS moves messages after the value of <code>maxReceiveCount</code> is exceeded.</p>
|
|
1034
1007
|
* </li>
|
|
1035
1008
|
* <li>
|
|
1036
1009
|
* <p>
|
|
1037
|
-
* <code>maxReceiveCount</code> – The number of times a message is
|
|
1038
|
-
*
|
|
1039
|
-
*
|
|
1040
|
-
* exceeds the <code>maxReceiveCount</code> for a queue, Amazon SQS moves
|
|
1041
|
-
* the message to the dead-letter-queue.</p>
|
|
1010
|
+
* <code>maxReceiveCount</code> – The number of times a message is delivered to the source queue before being
|
|
1011
|
+
* moved to the dead-letter queue. Default: 10. When the <code>ReceiveCount</code> for a message exceeds the <code>maxReceiveCount</code>
|
|
1012
|
+
* for a queue, Amazon SQS moves the message to the dead-letter-queue.</p>
|
|
1042
1013
|
* </li>
|
|
1043
1014
|
* </ul>
|
|
1044
1015
|
* </li>
|
|
1045
1016
|
* <li>
|
|
1046
1017
|
* <p>
|
|
1047
|
-
* <code>RedriveAllowPolicy</code> – The string that includes the parameters for
|
|
1048
|
-
*
|
|
1049
|
-
* queues can specify dead-letter queues as a JSON object. The parameters are as
|
|
1050
|
-
* follows:</p>
|
|
1018
|
+
* <code>RedriveAllowPolicy</code> – The string that includes the parameters for the permissions for the dead-letter
|
|
1019
|
+
* queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:</p>
|
|
1051
1020
|
* <ul>
|
|
1052
1021
|
* <li>
|
|
1053
1022
|
* <p>
|
|
1054
|
-
* <code>redrivePermission</code> – The permission type that defines
|
|
1055
|
-
*
|
|
1056
|
-
* queue. Valid values are:</p>
|
|
1023
|
+
* <code>redrivePermission</code> – The permission type that defines which source queues can
|
|
1024
|
+
* specify the current queue as the dead-letter queue. Valid values are:</p>
|
|
1057
1025
|
* <ul>
|
|
1058
1026
|
* <li>
|
|
1059
1027
|
* <p>
|
|
1060
|
-
* <code>allowAll</code> – (Default) Any source queues in this
|
|
1061
|
-
*
|
|
1062
|
-
* Region can specify this queue as the dead-letter queue.</p>
|
|
1028
|
+
* <code>allowAll</code> – (Default) Any source queues in this Amazon Web Services account in the same Region can
|
|
1029
|
+
* specify this queue as the dead-letter queue.</p>
|
|
1063
1030
|
* </li>
|
|
1064
1031
|
* <li>
|
|
1065
1032
|
* <p>
|
|
1066
|
-
* <code>denyAll</code> – No source queues can specify this queue
|
|
1067
|
-
*
|
|
1033
|
+
* <code>denyAll</code> – No source queues can specify this queue as the dead-letter
|
|
1034
|
+
* queue.</p>
|
|
1068
1035
|
* </li>
|
|
1069
1036
|
* <li>
|
|
1070
1037
|
* <p>
|
|
1071
|
-
* <code>byQueue</code> – Only queues specified by the
|
|
1072
|
-
*
|
|
1073
|
-
* queue as the dead-letter queue.</p>
|
|
1038
|
+
* <code>byQueue</code> – Only queues specified by the <code>sourceQueueArns</code> parameter can specify
|
|
1039
|
+
* this queue as the dead-letter queue.</p>
|
|
1074
1040
|
* </li>
|
|
1075
1041
|
* </ul>
|
|
1076
1042
|
* </li>
|
|
1077
1043
|
* <li>
|
|
1078
1044
|
* <p>
|
|
1079
|
-
* <code>sourceQueueArns</code> – The Amazon Resource Names (ARN)s of the
|
|
1080
|
-
*
|
|
1081
|
-
*
|
|
1082
|
-
*
|
|
1083
|
-
*
|
|
1084
|
-
* allow more than 10 source queues to specify dead-letter queues, set the
|
|
1085
|
-
* <code>redrivePermission</code> parameter to
|
|
1086
|
-
* <code>allowAll</code>.</p>
|
|
1045
|
+
* <code>sourceQueueArns</code> – The Amazon Resource Names (ARN)s of the source queues that can specify
|
|
1046
|
+
* this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the
|
|
1047
|
+
* <code>redrivePermission</code> parameter is set to <code>byQueue</code>. You can specify up to 10 source queue ARNs.
|
|
1048
|
+
* To allow more than 10 source queues to specify dead-letter queues, set the <code>redrivePermission</code> parameter
|
|
1049
|
+
* to <code>allowAll</code>.</p>
|
|
1087
1050
|
* </li>
|
|
1088
1051
|
* </ul>
|
|
1089
1052
|
* </li>
|
|
1090
1053
|
* </ul>
|
|
1091
1054
|
* <note>
|
|
1092
|
-
* <p>The dead-letter queue of a
|
|
1093
|
-
*
|
|
1055
|
+
* <p>The dead-letter queue of a
|
|
1056
|
+
* FIFO queue must also be a FIFO queue. Similarly, the dead-letter
|
|
1057
|
+
* queue of a standard queue must also be a standard queue.</p>
|
|
1094
1058
|
* </note>
|
|
1095
1059
|
* <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>
|
|
1096
1060
|
* <ul>
|
|
1097
1061
|
* <li>
|
|
1098
1062
|
* <p>
|
|
1099
|
-
* <code>KmsMasterKeyId</code> – Returns the ID of an Amazon Web Services
|
|
1100
|
-
*
|
|
1101
|
-
* information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key Terms</a>. </p>
|
|
1063
|
+
* <code>KmsMasterKeyId</code> – Returns the ID of an Amazon Web Services managed customer
|
|
1064
|
+
* 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>. </p>
|
|
1102
1065
|
* </li>
|
|
1103
1066
|
* <li>
|
|
1104
1067
|
* <p>
|
|
1105
|
-
* <code>KmsDataKeyReusePeriodSeconds</code> – Returns the length of time,
|
|
1106
|
-
* seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt
|
|
1107
|
-
* messages before calling KMS again. For more information, see
|
|
1068
|
+
* <code>KmsDataKeyReusePeriodSeconds</code> – Returns the length of time,
|
|
1069
|
+
* in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt
|
|
1070
|
+
* messages before calling KMS again. For more information, see
|
|
1071
|
+
* <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>. </p>
|
|
1108
1072
|
* </li>
|
|
1109
1073
|
* <li>
|
|
1110
1074
|
* <p>
|
|
1111
|
-
* <code>SqsManagedSseEnabled</code> – Returns information about whether the
|
|
1112
|
-
* is using SSE-SQS encryption using SQS owned encryption keys. Only one
|
|
1075
|
+
* <code>SqsManagedSseEnabled</code> – Returns information about whether the
|
|
1076
|
+
* queue is using SSE-SQS encryption using SQS owned encryption keys. Only one
|
|
1113
1077
|
* server-side encryption option is supported per queue (for example, <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>
|
|
1114
1078
|
* </li>
|
|
1115
1079
|
* </ul>
|
|
1116
|
-
* <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO
|
|
1117
|
-
*
|
|
1080
|
+
* <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)
|
|
1081
|
+
* queues</a>:</p>
|
|
1118
1082
|
* <ul>
|
|
1119
1083
|
* <li>
|
|
1120
1084
|
* <p>
|
|
1121
|
-
* <code>FifoQueue</code> – Returns information about whether the queue is
|
|
1122
|
-
* 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
|
|
1085
|
+
* <code>FifoQueue</code> – Returns information about whether the queue is
|
|
1086
|
+
* 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
|
|
1123
1087
|
* Guide</i>.</p>
|
|
1124
1088
|
* <note>
|
|
1125
|
-
* <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
|
|
1126
|
-
* the <code>.fifo</code> suffix.</p>
|
|
1089
|
+
* <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>
|
|
1127
1090
|
* </note>
|
|
1128
1091
|
* </li>
|
|
1129
1092
|
* <li>
|
|
@@ -1133,22 +1096,20 @@ export interface GetQueueAttributesRequest {
|
|
|
1133
1096
|
* Guide</i>. </p>
|
|
1134
1097
|
* </li>
|
|
1135
1098
|
* </ul>
|
|
1136
|
-
* <p>The following attributes apply only to
|
|
1137
|
-
*
|
|
1099
|
+
* <p>The following attributes apply only to
|
|
1100
|
+
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html">high throughput
|
|
1101
|
+
* for FIFO queues</a>:</p>
|
|
1138
1102
|
* <ul>
|
|
1139
1103
|
* <li>
|
|
1140
1104
|
* <p>
|
|
1141
|
-
* <code>DeduplicationScope</code> – Specifies whether message deduplication
|
|
1142
|
-
*
|
|
1143
|
-
* <code>messageGroup</code> and <code>queue</code>.</p>
|
|
1105
|
+
* <code>DeduplicationScope</code> – Specifies whether message deduplication occurs at the
|
|
1106
|
+
* message group or queue level. Valid values are <code>messageGroup</code> and <code>queue</code>.</p>
|
|
1144
1107
|
* </li>
|
|
1145
1108
|
* <li>
|
|
1146
1109
|
* <p>
|
|
1147
1110
|
* <code>FifoThroughputLimit</code> – Specifies whether the FIFO queue throughput
|
|
1148
|
-
*
|
|
1149
|
-
*
|
|
1150
|
-
* <code>perMessageGroupId</code> value is allowed only when the value for
|
|
1151
|
-
* <code>DeduplicationScope</code> is <code>messageGroup</code>.</p>
|
|
1111
|
+
* quota applies to the entire queue or per message group. Valid values are <code>perQueue</code> and <code>perMessageGroupId</code>.
|
|
1112
|
+
* The <code>perMessageGroupId</code> value is allowed only when the value for <code>DeduplicationScope</code> is <code>messageGroup</code>.</p>
|
|
1152
1113
|
* </li>
|
|
1153
1114
|
* </ul>
|
|
1154
1115
|
* <p>To enable high throughput for FIFO queues, do the following:</p>
|
|
@@ -1161,10 +1122,10 @@ export interface GetQueueAttributesRequest {
|
|
|
1161
1122
|
* </li>
|
|
1162
1123
|
* </ul>
|
|
1163
1124
|
* <p>If you set these attributes to anything other than the values shown for enabling high
|
|
1164
|
-
*
|
|
1165
|
-
* <p>For information on throughput quotas,
|
|
1166
|
-
*
|
|
1167
|
-
*
|
|
1125
|
+
* throughput, normal throughput is in effect and deduplication occurs as specified.</p>
|
|
1126
|
+
* <p>For information on throughput quotas,
|
|
1127
|
+
* see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html">Quotas related to messages</a>
|
|
1128
|
+
* in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
1168
1129
|
* @public
|
|
1169
1130
|
*/
|
|
1170
1131
|
AttributeNames?: QueueAttributeName[];
|
|
@@ -1194,15 +1155,14 @@ export interface GetQueueUrlRequest {
|
|
|
1194
1155
|
*/
|
|
1195
1156
|
QueueName: string | undefined;
|
|
1196
1157
|
/**
|
|
1197
|
-
* <p>The Amazon Web
|
|
1198
|
-
* Services account ID of the account that created the queue.</p>
|
|
1158
|
+
* <p>The Amazon Web Services account ID of the account that created the queue.</p>
|
|
1199
1159
|
* @public
|
|
1200
1160
|
*/
|
|
1201
1161
|
QueueOwnerAWSAccountId?: string;
|
|
1202
1162
|
}
|
|
1203
1163
|
/**
|
|
1204
1164
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-api-responses.html">Interpreting Responses</a> in the <i>Amazon SQS Developer
|
|
1205
|
-
*
|
|
1165
|
+
* Guide</i>.</p>
|
|
1206
1166
|
* @public
|
|
1207
1167
|
*/
|
|
1208
1168
|
export interface GetQueueUrlResult {
|
|
@@ -1317,7 +1277,8 @@ export interface ListMessageMoveTasksResultEntry {
|
|
|
1317
1277
|
ApproximateNumberOfMessagesMoved?: number;
|
|
1318
1278
|
/**
|
|
1319
1279
|
* <p>The number of messages to be moved from the source queue. This number is obtained at
|
|
1320
|
-
* the time of starting the message movement task
|
|
1280
|
+
* the time of starting the message movement task and is only included after the message
|
|
1281
|
+
* movement task is selected to start.</p>
|
|
1321
1282
|
* @public
|
|
1322
1283
|
*/
|
|
1323
1284
|
ApproximateNumberOfMessagesToMove?: number;
|
|
@@ -1530,6 +1491,26 @@ export declare class KmsThrottled extends __BaseException {
|
|
|
1530
1491
|
*/
|
|
1531
1492
|
constructor(opts: __ExceptionOptionType<KmsThrottled, __BaseException>);
|
|
1532
1493
|
}
|
|
1494
|
+
/**
|
|
1495
|
+
* @public
|
|
1496
|
+
* @enum
|
|
1497
|
+
*/
|
|
1498
|
+
export declare const MessageSystemAttributeName: {
|
|
1499
|
+
readonly AWSTraceHeader: "AWSTraceHeader";
|
|
1500
|
+
readonly All: "All";
|
|
1501
|
+
readonly ApproximateFirstReceiveTimestamp: "ApproximateFirstReceiveTimestamp";
|
|
1502
|
+
readonly ApproximateReceiveCount: "ApproximateReceiveCount";
|
|
1503
|
+
readonly DeadLetterQueueSourceArn: "DeadLetterQueueSourceArn";
|
|
1504
|
+
readonly MessageDeduplicationId: "MessageDeduplicationId";
|
|
1505
|
+
readonly MessageGroupId: "MessageGroupId";
|
|
1506
|
+
readonly SenderId: "SenderId";
|
|
1507
|
+
readonly SentTimestamp: "SentTimestamp";
|
|
1508
|
+
readonly SequenceNumber: "SequenceNumber";
|
|
1509
|
+
};
|
|
1510
|
+
/**
|
|
1511
|
+
* @public
|
|
1512
|
+
*/
|
|
1513
|
+
export type MessageSystemAttributeName = (typeof MessageSystemAttributeName)[keyof typeof MessageSystemAttributeName];
|
|
1533
1514
|
/**
|
|
1534
1515
|
* <p></p>
|
|
1535
1516
|
* @public
|
|
@@ -1542,7 +1523,15 @@ export interface ReceiveMessageRequest {
|
|
|
1542
1523
|
*/
|
|
1543
1524
|
QueueUrl: string | undefined;
|
|
1544
1525
|
/**
|
|
1545
|
-
*
|
|
1526
|
+
* @deprecated
|
|
1527
|
+
*
|
|
1528
|
+
* <important>
|
|
1529
|
+
* <p>
|
|
1530
|
+
* This parameter has been deprecated but will be supported for backward compatibility.
|
|
1531
|
+
* To provide attribute names, you are encouraged to use <code>MessageSystemAttributeNames</code>.
|
|
1532
|
+
* </p>
|
|
1533
|
+
* </important>
|
|
1534
|
+
* <p>A list of attributes that need to be returned along with each message. These
|
|
1546
1535
|
* attributes include:</p>
|
|
1547
1536
|
* <ul>
|
|
1548
1537
|
* <li>
|
|
@@ -1551,19 +1540,19 @@ export interface ReceiveMessageRequest {
|
|
|
1551
1540
|
* </li>
|
|
1552
1541
|
* <li>
|
|
1553
1542
|
* <p>
|
|
1554
|
-
* <code>ApproximateFirstReceiveTimestamp</code> – Returns the time the
|
|
1555
|
-
* first received from the queue (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a> in
|
|
1543
|
+
* <code>ApproximateFirstReceiveTimestamp</code> – Returns the time the
|
|
1544
|
+
* message was first received from the queue (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a> in
|
|
1556
1545
|
* milliseconds).</p>
|
|
1557
1546
|
* </li>
|
|
1558
1547
|
* <li>
|
|
1559
1548
|
* <p>
|
|
1560
|
-
* <code>ApproximateReceiveCount</code> – Returns the number of times a
|
|
1561
|
-
* been received across all queues but not deleted.</p>
|
|
1549
|
+
* <code>ApproximateReceiveCount</code> – Returns the number of times a
|
|
1550
|
+
* message has been received across all queues but not deleted.</p>
|
|
1562
1551
|
* </li>
|
|
1563
1552
|
* <li>
|
|
1564
1553
|
* <p>
|
|
1565
|
-
* <code>AWSTraceHeader</code> – Returns the X-Ray trace
|
|
1566
|
-
* string. </p>
|
|
1554
|
+
* <code>AWSTraceHeader</code> – Returns the X-Ray trace
|
|
1555
|
+
* header string. </p>
|
|
1567
1556
|
* </li>
|
|
1568
1557
|
* <li>
|
|
1569
1558
|
* <p>
|
|
@@ -1582,15 +1571,15 @@ export interface ReceiveMessageRequest {
|
|
|
1582
1571
|
* </li>
|
|
1583
1572
|
* <li>
|
|
1584
1573
|
* <p>
|
|
1585
|
-
* <code>SentTimestamp</code> – Returns the time the message was sent to the
|
|
1586
|
-
*
|
|
1574
|
+
* <code>SentTimestamp</code> – Returns the time the message was sent to the
|
|
1575
|
+
* queue (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a> in
|
|
1587
1576
|
* milliseconds).</p>
|
|
1588
1577
|
* </li>
|
|
1589
1578
|
* <li>
|
|
1590
1579
|
* <p>
|
|
1591
|
-
* <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption
|
|
1592
|
-
* SQS owned encryption keys. Only one server-side encryption option is
|
|
1593
|
-
* per queue (for example, <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>
|
|
1580
|
+
* <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption
|
|
1581
|
+
* using SQS owned encryption keys. Only one server-side encryption option is
|
|
1582
|
+
* supported per queue (for example, <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>
|
|
1594
1583
|
* </li>
|
|
1595
1584
|
* <li>
|
|
1596
1585
|
* <p>
|
|
@@ -1602,20 +1591,99 @@ export interface ReceiveMessageRequest {
|
|
|
1602
1591
|
* </li>
|
|
1603
1592
|
* <li>
|
|
1604
1593
|
* <p>
|
|
1605
|
-
* <code>MessageGroupId</code> – Returns the value provided by the
|
|
1606
|
-
* calls the <code>
|
|
1594
|
+
* <code>MessageGroupId</code> – Returns the value provided by the
|
|
1595
|
+
* producer that calls the <code>
|
|
1607
1596
|
* <a>SendMessage</a>
|
|
1608
|
-
* </code> action.
|
|
1609
|
-
* same <code>MessageGroupId</code> are returned in
|
|
1597
|
+
* </code> action.
|
|
1598
|
+
* Messages with the same <code>MessageGroupId</code> are returned in
|
|
1599
|
+
* sequence.</p>
|
|
1610
1600
|
* </li>
|
|
1611
1601
|
* <li>
|
|
1612
1602
|
* <p>
|
|
1613
|
-
* <code>SequenceNumber</code> – Returns the value provided by
|
|
1603
|
+
* <code>SequenceNumber</code> – Returns the value provided by
|
|
1604
|
+
* Amazon SQS.</p>
|
|
1614
1605
|
* </li>
|
|
1615
1606
|
* </ul>
|
|
1616
1607
|
* @public
|
|
1617
1608
|
*/
|
|
1618
1609
|
AttributeNames?: QueueAttributeName[];
|
|
1610
|
+
/**
|
|
1611
|
+
* <p>A list of attributes that need to be returned along with each message. These
|
|
1612
|
+
* attributes include:</p>
|
|
1613
|
+
* <ul>
|
|
1614
|
+
* <li>
|
|
1615
|
+
* <p>
|
|
1616
|
+
* <code>All</code> – Returns all values.</p>
|
|
1617
|
+
* </li>
|
|
1618
|
+
* <li>
|
|
1619
|
+
* <p>
|
|
1620
|
+
* <code>ApproximateFirstReceiveTimestamp</code> – Returns the time the
|
|
1621
|
+
* message was first received from the queue (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a> in
|
|
1622
|
+
* milliseconds).</p>
|
|
1623
|
+
* </li>
|
|
1624
|
+
* <li>
|
|
1625
|
+
* <p>
|
|
1626
|
+
* <code>ApproximateReceiveCount</code> – Returns the number of times a
|
|
1627
|
+
* message has been received across all queues but not deleted.</p>
|
|
1628
|
+
* </li>
|
|
1629
|
+
* <li>
|
|
1630
|
+
* <p>
|
|
1631
|
+
* <code>AWSTraceHeader</code> – Returns the X-Ray trace
|
|
1632
|
+
* header string. </p>
|
|
1633
|
+
* </li>
|
|
1634
|
+
* <li>
|
|
1635
|
+
* <p>
|
|
1636
|
+
* <code>SenderId</code>
|
|
1637
|
+
* </p>
|
|
1638
|
+
* <ul>
|
|
1639
|
+
* <li>
|
|
1640
|
+
* <p>For a user, returns the user ID, for example
|
|
1641
|
+
* <code>ABCDEFGHI1JKLMNOPQ23R</code>.</p>
|
|
1642
|
+
* </li>
|
|
1643
|
+
* <li>
|
|
1644
|
+
* <p>For an IAM role, returns the IAM role ID, for example
|
|
1645
|
+
* <code>ABCDE1F2GH3I4JK5LMNOP:i-a123b456</code>.</p>
|
|
1646
|
+
* </li>
|
|
1647
|
+
* </ul>
|
|
1648
|
+
* </li>
|
|
1649
|
+
* <li>
|
|
1650
|
+
* <p>
|
|
1651
|
+
* <code>SentTimestamp</code> – Returns the time the message was sent to the
|
|
1652
|
+
* queue (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a> in
|
|
1653
|
+
* milliseconds).</p>
|
|
1654
|
+
* </li>
|
|
1655
|
+
* <li>
|
|
1656
|
+
* <p>
|
|
1657
|
+
* <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption
|
|
1658
|
+
* using SQS owned encryption keys. Only one server-side encryption option is
|
|
1659
|
+
* supported per queue (for example, <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>
|
|
1660
|
+
* </li>
|
|
1661
|
+
* <li>
|
|
1662
|
+
* <p>
|
|
1663
|
+
* <code>MessageDeduplicationId</code> – Returns the value provided by the
|
|
1664
|
+
* producer that calls the <code>
|
|
1665
|
+
* <a>SendMessage</a>
|
|
1666
|
+
* </code>
|
|
1667
|
+
* action.</p>
|
|
1668
|
+
* </li>
|
|
1669
|
+
* <li>
|
|
1670
|
+
* <p>
|
|
1671
|
+
* <code>MessageGroupId</code> – Returns the value provided by the
|
|
1672
|
+
* producer that calls the <code>
|
|
1673
|
+
* <a>SendMessage</a>
|
|
1674
|
+
* </code> action.
|
|
1675
|
+
* Messages with the same <code>MessageGroupId</code> are returned in
|
|
1676
|
+
* sequence.</p>
|
|
1677
|
+
* </li>
|
|
1678
|
+
* <li>
|
|
1679
|
+
* <p>
|
|
1680
|
+
* <code>SequenceNumber</code> – Returns the value provided by
|
|
1681
|
+
* Amazon SQS.</p>
|
|
1682
|
+
* </li>
|
|
1683
|
+
* </ul>
|
|
1684
|
+
* @public
|
|
1685
|
+
*/
|
|
1686
|
+
MessageSystemAttributeNames?: MessageSystemAttributeName[];
|
|
1619
1687
|
/**
|
|
1620
1688
|
* <p>The name of the message attribute, where <i>N</i> is the index.</p>
|
|
1621
1689
|
* <ul>
|
|
@@ -1648,8 +1716,8 @@ export interface ReceiveMessageRequest {
|
|
|
1648
1716
|
*/
|
|
1649
1717
|
MessageAttributeNames?: string[];
|
|
1650
1718
|
/**
|
|
1651
|
-
* <p>The maximum number of messages to return. Amazon SQS never returns more messages than
|
|
1652
|
-
*
|
|
1719
|
+
* <p>The maximum number of messages to return. Amazon SQS never returns more messages than this
|
|
1720
|
+
* value (however, fewer messages might be returned). Valid values: 1 to 10. Default:
|
|
1653
1721
|
* 1.</p>
|
|
1654
1722
|
* @public
|
|
1655
1723
|
*/
|
|
@@ -1664,7 +1732,7 @@ export interface ReceiveMessageRequest {
|
|
|
1664
1732
|
* <p>The duration (in seconds) for which the call waits for a message to arrive in the
|
|
1665
1733
|
* queue before returning. If a message is available, the call returns sooner than
|
|
1666
1734
|
* <code>WaitTimeSeconds</code>. If no messages are available and the wait time
|
|
1667
|
-
* expires, the call
|
|
1735
|
+
* expires, the call does not return a message list.</p>
|
|
1668
1736
|
* <important>
|
|
1669
1737
|
* <p>To avoid HTTP errors, ensure that the HTTP response timeout for
|
|
1670
1738
|
* <code>ReceiveMessage</code> requests is longer than the
|
|
@@ -1692,11 +1760,6 @@ export interface ReceiveMessageRequest {
|
|
|
1692
1760
|
* <code>ReceiveRequestAttemptId</code> explicitly.</p>
|
|
1693
1761
|
* </li>
|
|
1694
1762
|
* <li>
|
|
1695
|
-
* <p>If a caller of the <code>ReceiveMessage</code> action doesn't provide a
|
|
1696
|
-
* <code>ReceiveRequestAttemptId</code>, Amazon SQS generates a
|
|
1697
|
-
* <code>ReceiveRequestAttemptId</code>.</p>
|
|
1698
|
-
* </li>
|
|
1699
|
-
* <li>
|
|
1700
1763
|
* <p>It is possible to retry the <code>ReceiveMessage</code> action with the same
|
|
1701
1764
|
* <code>ReceiveRequestAttemptId</code> if none of the messages have been
|
|
1702
1765
|
* modified (deleted or had their visibility changes).</p>
|
|
@@ -1736,31 +1799,12 @@ export interface ReceiveMessageRequest {
|
|
|
1736
1799
|
* <code>ReceiveRequestAttemptId</code> can contain alphanumeric characters
|
|
1737
1800
|
* (<code>a-z</code>, <code>A-Z</code>, <code>0-9</code>) and punctuation
|
|
1738
1801
|
* (<code>!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~</code>).</p>
|
|
1739
|
-
* <p>For best practices of using <code>ReceiveRequestAttemptId</code>, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-receiverequestattemptid-request-parameter.html">Using the ReceiveRequestAttemptId Request Parameter</a> in the <i>Amazon
|
|
1740
|
-
*
|
|
1802
|
+
* <p>For best practices of using <code>ReceiveRequestAttemptId</code>, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-receiverequestattemptid-request-parameter.html">Using the ReceiveRequestAttemptId Request Parameter</a> in the <i>Amazon SQS
|
|
1803
|
+
* Developer Guide</i>.</p>
|
|
1741
1804
|
* @public
|
|
1742
1805
|
*/
|
|
1743
1806
|
ReceiveRequestAttemptId?: string;
|
|
1744
1807
|
}
|
|
1745
|
-
/**
|
|
1746
|
-
* @public
|
|
1747
|
-
* @enum
|
|
1748
|
-
*/
|
|
1749
|
-
export declare const MessageSystemAttributeName: {
|
|
1750
|
-
readonly AWSTraceHeader: "AWSTraceHeader";
|
|
1751
|
-
readonly ApproximateFirstReceiveTimestamp: "ApproximateFirstReceiveTimestamp";
|
|
1752
|
-
readonly ApproximateReceiveCount: "ApproximateReceiveCount";
|
|
1753
|
-
readonly DeadLetterQueueSourceArn: "DeadLetterQueueSourceArn";
|
|
1754
|
-
readonly MessageDeduplicationId: "MessageDeduplicationId";
|
|
1755
|
-
readonly MessageGroupId: "MessageGroupId";
|
|
1756
|
-
readonly SenderId: "SenderId";
|
|
1757
|
-
readonly SentTimestamp: "SentTimestamp";
|
|
1758
|
-
readonly SequenceNumber: "SequenceNumber";
|
|
1759
|
-
};
|
|
1760
|
-
/**
|
|
1761
|
-
* @public
|
|
1762
|
-
*/
|
|
1763
|
-
export type MessageSystemAttributeName = (typeof MessageSystemAttributeName)[keyof typeof MessageSystemAttributeName];
|
|
1764
1808
|
/**
|
|
1765
1809
|
* <p>The user-specified message attribute value. For string data types, the
|
|
1766
1810
|
* <code>Value</code> attribute has the same restrictions on the content as the message
|
|
@@ -1802,7 +1846,7 @@ export interface MessageAttributeValue {
|
|
|
1802
1846
|
* <code>Number</code>, and <code>Binary</code>. For the <code>Number</code> data type,
|
|
1803
1847
|
* you must use <code>StringValue</code>.</p>
|
|
1804
1848
|
* <p>You can also append custom labels. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes">Amazon SQS Message Attributes</a> in the <i>Amazon SQS Developer
|
|
1805
|
-
*
|
|
1849
|
+
* Guide</i>.</p>
|
|
1806
1850
|
* @public
|
|
1807
1851
|
*/
|
|
1808
1852
|
DataType: string | undefined;
|
|
@@ -1885,17 +1929,15 @@ export interface Message {
|
|
|
1885
1929
|
*/
|
|
1886
1930
|
Attributes?: Partial<Record<MessageSystemAttributeName, string>>;
|
|
1887
1931
|
/**
|
|
1888
|
-
* <p>An MD5 digest of the non-URL-encoded message attribute string. You can use this
|
|
1889
|
-
* attribute to verify that Amazon SQS received the message correctly. Amazon SQS
|
|
1890
|
-
* URL-decodes the message before creating the MD5 digest. For information about MD5, see
|
|
1891
|
-
* <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
|
|
1932
|
+
* <p>An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
|
|
1892
1933
|
* @public
|
|
1893
1934
|
*/
|
|
1894
1935
|
MD5OfMessageAttributes?: string;
|
|
1895
1936
|
/**
|
|
1896
|
-
* <p>Each message attribute consists of a <code>Name</code>, <code>Type</code>,
|
|
1897
|
-
*
|
|
1898
|
-
*
|
|
1937
|
+
* <p>Each message attribute consists of a <code>Name</code>, <code>Type</code>,
|
|
1938
|
+
* and <code>Value</code>. For more information, see
|
|
1939
|
+
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes">Amazon SQS
|
|
1940
|
+
* message attributes</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
1899
1941
|
* @public
|
|
1900
1942
|
*/
|
|
1901
1943
|
MessageAttributes?: Record<string, MessageAttributeValue>;
|
|
@@ -1993,7 +2035,7 @@ export interface MessageSystemAttributeValue {
|
|
|
1993
2035
|
* <code>Number</code>, and <code>Binary</code>. For the <code>Number</code> data type,
|
|
1994
2036
|
* you must use <code>StringValue</code>.</p>
|
|
1995
2037
|
* <p>You can also append custom labels. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes">Amazon SQS Message Attributes</a> in the <i>Amazon SQS Developer
|
|
1996
|
-
*
|
|
2038
|
+
* Guide</i>.</p>
|
|
1997
2039
|
* @public
|
|
1998
2040
|
*/
|
|
1999
2041
|
DataType: string | undefined;
|
|
@@ -2013,16 +2055,11 @@ export interface SendMessageRequest {
|
|
|
2013
2055
|
* <p>The message to send. The minimum size is one character. The maximum size is 256
|
|
2014
2056
|
* KiB.</p>
|
|
2015
2057
|
* <important>
|
|
2016
|
-
* <p>A message can include only XML, JSON, and unformatted text. The following Unicode
|
|
2017
|
-
* characters are allowed:</p>
|
|
2058
|
+
* <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:</p>
|
|
2018
2059
|
* <p>
|
|
2019
|
-
* <code>#x9</code> | <code>#xA</code> | <code>#xD</code> | <code>#x20</code> to
|
|
2020
|
-
* <code>#xD7FF</code> | <code>#xE000</code> to <code>#xFFFD</code> |
|
|
2021
|
-
* <code>#x10000</code> to <code>#x10FFFF</code>
|
|
2060
|
+
* <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>
|
|
2022
2061
|
* </p>
|
|
2023
|
-
* <p>Any characters not included in this list will be rejected. For more information,
|
|
2024
|
-
* see the <a href="http://www.w3.org/TR/REC-xml/#charsets">W3C specification for
|
|
2025
|
-
* characters</a>.</p>
|
|
2062
|
+
* <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>
|
|
2026
2063
|
* </important>
|
|
2027
2064
|
* @public
|
|
2028
2065
|
*/
|
|
@@ -2033,33 +2070,30 @@ export interface SendMessageRequest {
|
|
|
2033
2070
|
* become available for processing after the delay period is finished. If you don't specify
|
|
2034
2071
|
* a value, the default value for the queue applies. </p>
|
|
2035
2072
|
* <note>
|
|
2036
|
-
* <p>When you set <code>FifoQueue</code>, you can't set <code>DelaySeconds</code> per
|
|
2037
|
-
* message. You can set this parameter only on a queue level.</p>
|
|
2073
|
+
* <p>When you set <code>FifoQueue</code>, you can't set <code>DelaySeconds</code> per message. You can set this parameter only on a queue level.</p>
|
|
2038
2074
|
* </note>
|
|
2039
2075
|
* @public
|
|
2040
2076
|
*/
|
|
2041
2077
|
DelaySeconds?: number;
|
|
2042
2078
|
/**
|
|
2043
|
-
* <p>Each message attribute consists of a <code>Name</code>, <code>Type</code>,
|
|
2044
|
-
*
|
|
2045
|
-
*
|
|
2079
|
+
* <p>Each message attribute consists of a <code>Name</code>, <code>Type</code>,
|
|
2080
|
+
* and <code>Value</code>. For more information, see
|
|
2081
|
+
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes">Amazon SQS
|
|
2082
|
+
* message attributes</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
2046
2083
|
* @public
|
|
2047
2084
|
*/
|
|
2048
2085
|
MessageAttributes?: Record<string, MessageAttributeValue>;
|
|
2049
2086
|
/**
|
|
2050
|
-
* <p>The message system attribute to send. Each message system attribute consists of a
|
|
2051
|
-
* <code>Name</code>, <code>Type</code>, and <code>Value</code>.</p>
|
|
2087
|
+
* <p>The message system attribute to send. Each message system attribute consists of a <code>Name</code>, <code>Type</code>, and <code>Value</code>.</p>
|
|
2052
2088
|
* <important>
|
|
2053
2089
|
* <ul>
|
|
2054
2090
|
* <li>
|
|
2055
|
-
* <p>Currently, the only supported message system attribute is
|
|
2056
|
-
*
|
|
2057
|
-
*
|
|
2058
|
-
* header string.</p>
|
|
2091
|
+
* <p>Currently, the only supported message system attribute is <code>AWSTraceHeader</code>.
|
|
2092
|
+
* Its type must be <code>String</code> and its value must be a correctly formatted
|
|
2093
|
+
* X-Ray trace header string.</p>
|
|
2059
2094
|
* </li>
|
|
2060
2095
|
* <li>
|
|
2061
|
-
* <p>The size of a message system attribute doesn't count towards the total
|
|
2062
|
-
* size of a message.</p>
|
|
2096
|
+
* <p>The size of a message system attribute doesn't count towards the total size of a message.</p>
|
|
2063
2097
|
* </li>
|
|
2064
2098
|
* </ul>
|
|
2065
2099
|
* </important>
|
|
@@ -2072,7 +2106,7 @@ export interface SendMessageRequest {
|
|
|
2072
2106
|
* <code>MessageDeduplicationId</code> is sent successfully, any messages sent with the
|
|
2073
2107
|
* same <code>MessageDeduplicationId</code> are accepted successfully but aren't delivered
|
|
2074
2108
|
* during the 5-minute deduplication interval. 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
|
|
2075
|
-
*
|
|
2109
|
+
* Guide</i>.</p>
|
|
2076
2110
|
* <ul>
|
|
2077
2111
|
* <li>
|
|
2078
2112
|
* <p>Every message must have a unique <code>MessageDeduplicationId</code>,</p>
|
|
@@ -2119,25 +2153,24 @@ export interface SendMessageRequest {
|
|
|
2119
2153
|
* <p>If a message is sent successfully but the acknowledgement is lost and the message
|
|
2120
2154
|
* is resent with the same <code>MessageDeduplicationId</code> after the deduplication
|
|
2121
2155
|
* interval, Amazon SQS can't detect duplicate messages.</p>
|
|
2122
|
-
* <p>Amazon SQS continues to keep track of the message deduplication ID even after the
|
|
2123
|
-
* message is received and deleted.</p>
|
|
2156
|
+
* <p>Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.</p>
|
|
2124
2157
|
* </note>
|
|
2125
2158
|
* <p>The maximum length of <code>MessageDeduplicationId</code> is 128 characters.
|
|
2126
2159
|
* <code>MessageDeduplicationId</code> can contain alphanumeric characters
|
|
2127
2160
|
* (<code>a-z</code>, <code>A-Z</code>, <code>0-9</code>) and punctuation
|
|
2128
2161
|
* (<code>!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~</code>).</p>
|
|
2129
|
-
* <p>For best practices of using <code>MessageDeduplicationId</code>, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html">Using the MessageDeduplicationId Property</a> in the <i>Amazon SQS
|
|
2130
|
-
*
|
|
2162
|
+
* <p>For best practices of using <code>MessageDeduplicationId</code>, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html">Using the MessageDeduplicationId Property</a> in the <i>Amazon SQS Developer
|
|
2163
|
+
* Guide</i>.</p>
|
|
2131
2164
|
* @public
|
|
2132
2165
|
*/
|
|
2133
2166
|
MessageDeduplicationId?: string;
|
|
2134
2167
|
/**
|
|
2135
2168
|
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
|
|
2136
2169
|
* <p>The tag that specifies that a message belongs to a specific message group. Messages
|
|
2137
|
-
* that belong to the same message group are processed in a FIFO manner (however,
|
|
2138
|
-
* in different message groups might be processed out of order). To interleave
|
|
2139
|
-
* ordered streams within a single queue, use <code>MessageGroupId</code> values
|
|
2140
|
-
* example, session data for multiple users). In this scenario, multiple consumers can
|
|
2170
|
+
* that belong to the same message group are processed in a FIFO manner (however,
|
|
2171
|
+
* messages in different message groups might be processed out of order). To interleave
|
|
2172
|
+
* multiple ordered streams within a single queue, use <code>MessageGroupId</code> values
|
|
2173
|
+
* (for example, session data for multiple users). In this scenario, multiple consumers can
|
|
2141
2174
|
* process the queue, but the session data of each user is processed in a FIFO
|
|
2142
2175
|
* fashion.</p>
|
|
2143
2176
|
* <ul>
|
|
@@ -2153,7 +2186,7 @@ export interface SendMessageRequest {
|
|
|
2153
2186
|
* <code>MessageGroupId</code>.</p>
|
|
2154
2187
|
* </li>
|
|
2155
2188
|
* </ul>
|
|
2156
|
-
* <p>The length of <code>MessageGroupId</code> is 128 characters. Valid values:
|
|
2189
|
+
* <p>The maximum length of <code>MessageGroupId</code> is 128 characters. Valid values:
|
|
2157
2190
|
* alphanumeric characters and punctuation
|
|
2158
2191
|
* <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~)</code>.</p>
|
|
2159
2192
|
* <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
|
|
@@ -2173,24 +2206,18 @@ export interface SendMessageRequest {
|
|
|
2173
2206
|
*/
|
|
2174
2207
|
export interface SendMessageResult {
|
|
2175
2208
|
/**
|
|
2176
|
-
* <p>An MD5 digest of the non-URL-encoded message body string. You can use this attribute
|
|
2177
|
-
* to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the
|
|
2178
|
-
* message before creating the MD5 digest. For information about MD5, see <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
|
|
2209
|
+
* <p>An MD5 digest of the non-URL-encoded message body string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
|
|
2179
2210
|
* @public
|
|
2180
2211
|
*/
|
|
2181
2212
|
MD5OfMessageBody?: string;
|
|
2182
2213
|
/**
|
|
2183
|
-
* <p>An MD5 digest of the non-URL-encoded message attribute string. You can use this
|
|
2184
|
-
* attribute to verify that Amazon SQS received the message correctly. Amazon SQS
|
|
2185
|
-
* URL-decodes the message before creating the MD5 digest. For information about MD5, see
|
|
2186
|
-
* <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
|
|
2214
|
+
* <p>An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
|
|
2187
2215
|
* @public
|
|
2188
2216
|
*/
|
|
2189
2217
|
MD5OfMessageAttributes?: string;
|
|
2190
2218
|
/**
|
|
2191
2219
|
* <p>An MD5 digest of the non-URL-encoded message system attribute string. You can use this
|
|
2192
|
-
*
|
|
2193
|
-
* URL-decodes the message before creating the MD5 digest.</p>
|
|
2220
|
+
* attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest.</p>
|
|
2194
2221
|
* @public
|
|
2195
2222
|
*/
|
|
2196
2223
|
MD5OfMessageSystemAttributes?: string;
|
|
@@ -2223,8 +2250,7 @@ export declare class BatchRequestTooLong extends __BaseException {
|
|
|
2223
2250
|
constructor(opts: __ExceptionOptionType<BatchRequestTooLong, __BaseException>);
|
|
2224
2251
|
}
|
|
2225
2252
|
/**
|
|
2226
|
-
* <p>Contains the details of a single Amazon SQS message along with an
|
|
2227
|
-
* <code>Id</code>.</p>
|
|
2253
|
+
* <p>Contains the details of a single Amazon SQS message along with an <code>Id</code>.</p>
|
|
2228
2254
|
* @public
|
|
2229
2255
|
*/
|
|
2230
2256
|
export interface SendMessageBatchRequestEntry {
|
|
@@ -2232,8 +2258,7 @@ export interface SendMessageBatchRequestEntry {
|
|
|
2232
2258
|
* <p>An identifier for a message in this batch used to communicate the result.</p>
|
|
2233
2259
|
* <note>
|
|
2234
2260
|
* <p>The <code>Id</code>s of a batch request need to be unique within a request.</p>
|
|
2235
|
-
* <p>This identifier can have up to 80 characters. The following characters are
|
|
2236
|
-
* accepted: alphanumeric characters, hyphens(-), and underscores (_).</p>
|
|
2261
|
+
* <p>This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).</p>
|
|
2237
2262
|
* </note>
|
|
2238
2263
|
* @public
|
|
2239
2264
|
*/
|
|
@@ -2249,33 +2274,30 @@ export interface SendMessageBatchRequestEntry {
|
|
|
2249
2274
|
* become available for processing after the delay period is finished. If you don't specify
|
|
2250
2275
|
* a value, the default value for the queue is applied. </p>
|
|
2251
2276
|
* <note>
|
|
2252
|
-
* <p>When you set <code>FifoQueue</code>, you can't set <code>DelaySeconds</code> per
|
|
2253
|
-
* message. You can set this parameter only on a queue level.</p>
|
|
2277
|
+
* <p>When you set <code>FifoQueue</code>, you can't set <code>DelaySeconds</code> per message. You can set this parameter only on a queue level.</p>
|
|
2254
2278
|
* </note>
|
|
2255
2279
|
* @public
|
|
2256
2280
|
*/
|
|
2257
2281
|
DelaySeconds?: number;
|
|
2258
2282
|
/**
|
|
2259
|
-
* <p>Each message attribute consists of a <code>Name</code>, <code>Type</code>,
|
|
2260
|
-
*
|
|
2261
|
-
*
|
|
2283
|
+
* <p>Each message attribute consists of a <code>Name</code>, <code>Type</code>,
|
|
2284
|
+
* and <code>Value</code>. For more information, see
|
|
2285
|
+
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes">Amazon SQS
|
|
2286
|
+
* message attributes</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
2262
2287
|
* @public
|
|
2263
2288
|
*/
|
|
2264
2289
|
MessageAttributes?: Record<string, MessageAttributeValue>;
|
|
2265
2290
|
/**
|
|
2266
|
-
* <p>The message system attribute to send Each message system attribute consists of a
|
|
2267
|
-
* <code>Name</code>, <code>Type</code>, and <code>Value</code>.</p>
|
|
2291
|
+
* <p>The message system attribute to send Each message system attribute consists of a <code>Name</code>, <code>Type</code>, and <code>Value</code>.</p>
|
|
2268
2292
|
* <important>
|
|
2269
2293
|
* <ul>
|
|
2270
2294
|
* <li>
|
|
2271
|
-
* <p>Currently, the only supported message system attribute is
|
|
2272
|
-
*
|
|
2273
|
-
*
|
|
2274
|
-
* header string.</p>
|
|
2295
|
+
* <p>Currently, the only supported message system attribute is <code>AWSTraceHeader</code>.
|
|
2296
|
+
* Its type must be <code>String</code> and its value must be a correctly formatted
|
|
2297
|
+
* X-Ray trace header string.</p>
|
|
2275
2298
|
* </li>
|
|
2276
2299
|
* <li>
|
|
2277
|
-
* <p>The size of a message system attribute doesn't count towards the total
|
|
2278
|
-
* size of a message.</p>
|
|
2300
|
+
* <p>The size of a message system attribute doesn't count towards the total size of a message.</p>
|
|
2279
2301
|
* </li>
|
|
2280
2302
|
* </ul>
|
|
2281
2303
|
* </important>
|
|
@@ -2288,7 +2310,7 @@ export interface SendMessageBatchRequestEntry {
|
|
|
2288
2310
|
* interval. If a message with a particular <code>MessageDeduplicationId</code> is sent
|
|
2289
2311
|
* successfully, subsequent messages with the same <code>MessageDeduplicationId</code> are
|
|
2290
2312
|
* accepted successfully but aren't delivered. 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
|
|
2291
|
-
*
|
|
2313
|
+
* Guide</i>.</p>
|
|
2292
2314
|
* <ul>
|
|
2293
2315
|
* <li>
|
|
2294
2316
|
* <p>Every message must have a unique <code>MessageDeduplicationId</code>,</p>
|
|
@@ -2335,25 +2357,24 @@ export interface SendMessageBatchRequestEntry {
|
|
|
2335
2357
|
* <p>If a message is sent successfully but the acknowledgement is lost and the message
|
|
2336
2358
|
* is resent with the same <code>MessageDeduplicationId</code> after the deduplication
|
|
2337
2359
|
* interval, Amazon SQS can't detect duplicate messages.</p>
|
|
2338
|
-
* <p>Amazon SQS continues to keep track of the message deduplication ID even after the
|
|
2339
|
-
* message is received and deleted.</p>
|
|
2360
|
+
* <p>Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.</p>
|
|
2340
2361
|
* </note>
|
|
2341
2362
|
* <p>The length of <code>MessageDeduplicationId</code> is 128 characters.
|
|
2342
2363
|
* <code>MessageDeduplicationId</code> can contain alphanumeric characters
|
|
2343
2364
|
* (<code>a-z</code>, <code>A-Z</code>, <code>0-9</code>) and punctuation
|
|
2344
2365
|
* (<code>!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~</code>).</p>
|
|
2345
|
-
* <p>For best practices of using <code>MessageDeduplicationId</code>, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html">Using the MessageDeduplicationId Property</a> in the <i>Amazon SQS
|
|
2346
|
-
*
|
|
2366
|
+
* <p>For best practices of using <code>MessageDeduplicationId</code>, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html">Using the MessageDeduplicationId Property</a> in the <i>Amazon SQS Developer
|
|
2367
|
+
* Guide</i>.</p>
|
|
2347
2368
|
* @public
|
|
2348
2369
|
*/
|
|
2349
2370
|
MessageDeduplicationId?: string;
|
|
2350
2371
|
/**
|
|
2351
2372
|
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
|
|
2352
2373
|
* <p>The tag that specifies that a message belongs to a specific message group. Messages
|
|
2353
|
-
* that belong to the same message group are processed in a FIFO manner (however,
|
|
2354
|
-
* in different message groups might be processed out of order). To interleave
|
|
2355
|
-
* ordered streams within a single queue, use <code>MessageGroupId</code> values
|
|
2356
|
-
* example, session data for multiple users). In this scenario, multiple consumers can
|
|
2374
|
+
* that belong to the same message group are processed in a FIFO manner (however,
|
|
2375
|
+
* messages in different message groups might be processed out of order). To interleave
|
|
2376
|
+
* multiple ordered streams within a single queue, use <code>MessageGroupId</code> values
|
|
2377
|
+
* (for example, session data for multiple users). In this scenario, multiple consumers can
|
|
2357
2378
|
* process the queue, but the session data of each user is processed in a FIFO
|
|
2358
2379
|
* fashion.</p>
|
|
2359
2380
|
* <ul>
|
|
@@ -2420,25 +2441,18 @@ export interface SendMessageBatchResultEntry {
|
|
|
2420
2441
|
*/
|
|
2421
2442
|
MessageId: string | undefined;
|
|
2422
2443
|
/**
|
|
2423
|
-
* <p>An MD5 digest of the non-URL-encoded message body string. You can use this attribute
|
|
2424
|
-
* to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the
|
|
2425
|
-
* message before creating the MD5 digest. For information about MD5, see <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
|
|
2444
|
+
* <p>An MD5 digest of the non-URL-encoded message body string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
|
|
2426
2445
|
* @public
|
|
2427
2446
|
*/
|
|
2428
2447
|
MD5OfMessageBody: string | undefined;
|
|
2429
2448
|
/**
|
|
2430
|
-
* <p>An MD5 digest of the non-URL-encoded message attribute string. You can use this
|
|
2431
|
-
* attribute to verify that Amazon SQS received the message correctly. Amazon SQS
|
|
2432
|
-
* URL-decodes the message before creating the MD5 digest. For information about MD5, see
|
|
2433
|
-
* <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
|
|
2449
|
+
* <p>An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
|
|
2434
2450
|
* @public
|
|
2435
2451
|
*/
|
|
2436
2452
|
MD5OfMessageAttributes?: string;
|
|
2437
2453
|
/**
|
|
2438
2454
|
* <p>An MD5 digest of the non-URL-encoded message system attribute string. You can use this
|
|
2439
|
-
*
|
|
2440
|
-
* URL-decodes the message before creating the MD5 digest. For information about MD5, see
|
|
2441
|
-
* <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
|
|
2455
|
+
* attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
|
|
2442
2456
|
* @public
|
|
2443
2457
|
*/
|
|
2444
2458
|
MD5OfMessageSystemAttributes?: string;
|
|
@@ -2502,36 +2516,37 @@ export interface SetQueueAttributesRequest {
|
|
|
2502
2516
|
* </li>
|
|
2503
2517
|
* <li>
|
|
2504
2518
|
* <p>
|
|
2505
|
-
* <code>MaximumMessageSize</code> – The limit of how many bytes a message
|
|
2506
|
-
* contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes
|
|
2519
|
+
* <code>MaximumMessageSize</code> – The limit of how many bytes a message
|
|
2520
|
+
* can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes
|
|
2507
2521
|
* (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). </p>
|
|
2508
2522
|
* </li>
|
|
2509
2523
|
* <li>
|
|
2510
2524
|
* <p>
|
|
2511
|
-
* <code>MessageRetentionPeriod</code> – The length of time, in seconds, for
|
|
2512
|
-
* Amazon SQS retains a message. Valid values: An integer representing seconds,
|
|
2525
|
+
* <code>MessageRetentionPeriod</code> – The length of time, in seconds, for
|
|
2526
|
+
* which Amazon SQS retains a message. Valid values: An integer representing seconds,
|
|
2513
2527
|
* from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days). When you
|
|
2514
2528
|
* change a queue's attributes, the change can take up to 60 seconds for most of
|
|
2515
|
-
* the attributes to propagate throughout the Amazon SQS system. Changes made to
|
|
2516
|
-
*
|
|
2529
|
+
* the attributes to propagate throughout the Amazon SQS system. Changes made to the
|
|
2530
|
+
* <code>MessageRetentionPeriod</code> attribute can take up to 15 minutes and
|
|
2517
2531
|
* will impact existing messages in the queue potentially causing them to be
|
|
2518
2532
|
* expired and deleted if the <code>MessageRetentionPeriod</code> is reduced below
|
|
2519
2533
|
* the age of existing messages.</p>
|
|
2520
2534
|
* </li>
|
|
2521
2535
|
* <li>
|
|
2522
2536
|
* <p>
|
|
2523
|
-
* <code>Policy</code> – The queue's policy. A valid Amazon Web Services
|
|
2524
|
-
*
|
|
2525
|
-
*
|
|
2526
|
-
*
|
|
2537
|
+
* <code>Policy</code> – The queue's policy. A valid Amazon Web Services policy. For more
|
|
2538
|
+
* information about policy structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview of Amazon Web Services IAM
|
|
2539
|
+
* Policies</a> in the <i>Identity and Access Management User
|
|
2540
|
+
* Guide</i>. </p>
|
|
2527
2541
|
* </li>
|
|
2528
2542
|
* <li>
|
|
2529
2543
|
* <p>
|
|
2530
|
-
* <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in
|
|
2531
|
-
* which a <code>
|
|
2544
|
+
* <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in
|
|
2545
|
+
* seconds, for which a <code>
|
|
2532
2546
|
* <a>ReceiveMessage</a>
|
|
2533
|
-
* </code> action waits
|
|
2534
|
-
* to arrive. Valid values: An integer from 0 to 20 (seconds).
|
|
2547
|
+
* </code> action waits
|
|
2548
|
+
* for a message to arrive. Valid values: An integer from 0 to 20 (seconds).
|
|
2549
|
+
* Default: 0. </p>
|
|
2535
2550
|
* </li>
|
|
2536
2551
|
* <li>
|
|
2537
2552
|
* <p>
|
|
@@ -2546,83 +2561,71 @@ export interface SetQueueAttributesRequest {
|
|
|
2546
2561
|
* <ul>
|
|
2547
2562
|
* <li>
|
|
2548
2563
|
* <p>
|
|
2549
|
-
* <code>RedrivePolicy</code> – The string that includes the parameters for the
|
|
2550
|
-
*
|
|
2551
|
-
* parameters are as follows:</p>
|
|
2564
|
+
* <code>RedrivePolicy</code> – The string that includes the parameters for the dead-letter queue functionality
|
|
2565
|
+
* of the source queue as a JSON object. The parameters are as follows:</p>
|
|
2552
2566
|
* <ul>
|
|
2553
2567
|
* <li>
|
|
2554
2568
|
* <p>
|
|
2555
|
-
* <code>deadLetterTargetArn</code> – The Amazon Resource Name (ARN) of
|
|
2556
|
-
*
|
|
2557
|
-
* of <code>maxReceiveCount</code> is exceeded.</p>
|
|
2569
|
+
* <code>deadLetterTargetArn</code> – The Amazon Resource Name (ARN) of the dead-letter queue to
|
|
2570
|
+
* which Amazon SQS moves messages after the value of <code>maxReceiveCount</code> is exceeded.</p>
|
|
2558
2571
|
* </li>
|
|
2559
2572
|
* <li>
|
|
2560
2573
|
* <p>
|
|
2561
|
-
* <code>maxReceiveCount</code> – The number of times a message is
|
|
2562
|
-
*
|
|
2563
|
-
*
|
|
2564
|
-
* exceeds the <code>maxReceiveCount</code> for a queue, Amazon SQS moves
|
|
2565
|
-
* the message to the dead-letter-queue.</p>
|
|
2574
|
+
* <code>maxReceiveCount</code> – The number of times a message is delivered to the source queue before being
|
|
2575
|
+
* moved to the dead-letter queue. Default: 10. When the <code>ReceiveCount</code> for a message exceeds the <code>maxReceiveCount</code>
|
|
2576
|
+
* for a queue, Amazon SQS moves the message to the dead-letter-queue.</p>
|
|
2566
2577
|
* </li>
|
|
2567
2578
|
* </ul>
|
|
2568
2579
|
* </li>
|
|
2569
2580
|
* <li>
|
|
2570
2581
|
* <p>
|
|
2571
|
-
* <code>RedriveAllowPolicy</code> – The string that includes the parameters for
|
|
2572
|
-
*
|
|
2573
|
-
* queues can specify dead-letter queues as a JSON object. The parameters are as
|
|
2574
|
-
* follows:</p>
|
|
2582
|
+
* <code>RedriveAllowPolicy</code> – The string that includes the parameters for the permissions for the dead-letter
|
|
2583
|
+
* queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:</p>
|
|
2575
2584
|
* <ul>
|
|
2576
2585
|
* <li>
|
|
2577
2586
|
* <p>
|
|
2578
|
-
* <code>redrivePermission</code> – The permission type that defines
|
|
2579
|
-
*
|
|
2580
|
-
* queue. Valid values are:</p>
|
|
2587
|
+
* <code>redrivePermission</code> – The permission type that defines which source queues can
|
|
2588
|
+
* specify the current queue as the dead-letter queue. Valid values are:</p>
|
|
2581
2589
|
* <ul>
|
|
2582
2590
|
* <li>
|
|
2583
2591
|
* <p>
|
|
2584
|
-
* <code>allowAll</code> – (Default) Any source queues in this
|
|
2585
|
-
*
|
|
2586
|
-
* Region can specify this queue as the dead-letter queue.</p>
|
|
2592
|
+
* <code>allowAll</code> – (Default) Any source queues in this Amazon Web Services account in the same Region can
|
|
2593
|
+
* specify this queue as the dead-letter queue.</p>
|
|
2587
2594
|
* </li>
|
|
2588
2595
|
* <li>
|
|
2589
2596
|
* <p>
|
|
2590
|
-
* <code>denyAll</code> – No source queues can specify this queue
|
|
2591
|
-
*
|
|
2597
|
+
* <code>denyAll</code> – No source queues can specify this queue as the dead-letter
|
|
2598
|
+
* queue.</p>
|
|
2592
2599
|
* </li>
|
|
2593
2600
|
* <li>
|
|
2594
2601
|
* <p>
|
|
2595
|
-
* <code>byQueue</code> – Only queues specified by the
|
|
2596
|
-
*
|
|
2597
|
-
* queue as the dead-letter queue.</p>
|
|
2602
|
+
* <code>byQueue</code> – Only queues specified by the <code>sourceQueueArns</code> parameter can specify
|
|
2603
|
+
* this queue as the dead-letter queue.</p>
|
|
2598
2604
|
* </li>
|
|
2599
2605
|
* </ul>
|
|
2600
2606
|
* </li>
|
|
2601
2607
|
* <li>
|
|
2602
2608
|
* <p>
|
|
2603
|
-
* <code>sourceQueueArns</code> – The Amazon Resource Names (ARN)s of the
|
|
2604
|
-
*
|
|
2605
|
-
*
|
|
2606
|
-
*
|
|
2607
|
-
*
|
|
2608
|
-
* allow more than 10 source queues to specify dead-letter queues, set the
|
|
2609
|
-
* <code>redrivePermission</code> parameter to
|
|
2610
|
-
* <code>allowAll</code>.</p>
|
|
2609
|
+
* <code>sourceQueueArns</code> – The Amazon Resource Names (ARN)s of the source queues that can specify
|
|
2610
|
+
* this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the
|
|
2611
|
+
* <code>redrivePermission</code> parameter is set to <code>byQueue</code>. You can specify up to 10 source queue ARNs.
|
|
2612
|
+
* To allow more than 10 source queues to specify dead-letter queues, set the <code>redrivePermission</code> parameter
|
|
2613
|
+
* to <code>allowAll</code>.</p>
|
|
2611
2614
|
* </li>
|
|
2612
2615
|
* </ul>
|
|
2613
2616
|
* </li>
|
|
2614
2617
|
* </ul>
|
|
2615
2618
|
* <note>
|
|
2616
|
-
* <p>The dead-letter queue of a
|
|
2617
|
-
*
|
|
2619
|
+
* <p>The dead-letter queue of a
|
|
2620
|
+
* FIFO queue must also be a FIFO queue. Similarly, the dead-letter
|
|
2621
|
+
* queue of a standard queue must also be a standard queue.</p>
|
|
2618
2622
|
* </note>
|
|
2619
2623
|
* <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>
|
|
2620
2624
|
* <ul>
|
|
2621
2625
|
* <li>
|
|
2622
2626
|
* <p>
|
|
2623
|
-
* <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer
|
|
2624
|
-
*
|
|
2625
|
-
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key Terms</a>. While the alias of the AWS-managed CMK for Amazon SQS is
|
|
2627
|
+
* <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer master
|
|
2628
|
+
* 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>. While the alias of the AWS-managed CMK for Amazon SQS is
|
|
2626
2629
|
* always <code>alias/aws/sqs</code>, the alias of a custom CMK can, for example,
|
|
2627
2630
|
* be <code>alias/<i>MyAlias</i>
|
|
2628
2631
|
* </code>. For more examples, see
|
|
@@ -2631,28 +2634,28 @@ export interface SetQueueAttributesRequest {
|
|
|
2631
2634
|
* </li>
|
|
2632
2635
|
* <li>
|
|
2633
2636
|
* <p>
|
|
2634
|
-
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in
|
|
2635
|
-
* which Amazon SQS can reuse a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data key</a> to
|
|
2636
|
-
* encrypt or decrypt messages before calling KMS again. An integer
|
|
2637
|
-
* seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
|
2638
|
-
* 300 (5 minutes). A shorter time period provides better security
|
|
2639
|
-
* more calls to KMS which might incur charges after Free Tier. For
|
|
2640
|
-
* 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>. </p>
|
|
2637
|
+
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in
|
|
2638
|
+
* 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
|
|
2639
|
+
* encrypt or decrypt messages before calling KMS again. An integer
|
|
2640
|
+
* representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
|
2641
|
+
* hours). Default: 300 (5 minutes). A shorter time period provides better security
|
|
2642
|
+
* but results in more calls to KMS which might incur charges after Free Tier. For
|
|
2643
|
+
* 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>. </p>
|
|
2641
2644
|
* </li>
|
|
2642
2645
|
* <li>
|
|
2643
2646
|
* <p>
|
|
2644
|
-
* <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption
|
|
2645
|
-
* SQS owned encryption keys. Only one server-side encryption option is
|
|
2646
|
-
* per queue (for example, <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>
|
|
2647
|
+
* <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption
|
|
2648
|
+
* using SQS owned encryption keys. Only one server-side encryption option is
|
|
2649
|
+
* supported per queue (for example, <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>
|
|
2647
2650
|
* </li>
|
|
2648
2651
|
* </ul>
|
|
2649
|
-
* <p>The following attribute applies only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO
|
|
2650
|
-
*
|
|
2652
|
+
* <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)
|
|
2653
|
+
* queues</a>:</p>
|
|
2651
2654
|
* <ul>
|
|
2652
2655
|
* <li>
|
|
2653
2656
|
* <p>
|
|
2654
|
-
* <code>ContentBasedDeduplication</code> – Enables content-based
|
|
2655
|
-
* 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
|
|
2657
|
+
* <code>ContentBasedDeduplication</code> – Enables content-based
|
|
2658
|
+
* 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 <i>Amazon SQS Developer
|
|
2656
2659
|
* Guide</i>. Note the following: </p>
|
|
2657
2660
|
* <ul>
|
|
2658
2661
|
* <li>
|
|
@@ -2666,8 +2669,8 @@ export interface SetQueueAttributesRequest {
|
|
|
2666
2669
|
* <li>
|
|
2667
2670
|
* <p>If you aren't able to provide a
|
|
2668
2671
|
* <code>MessageDeduplicationId</code> and you enable
|
|
2669
|
-
* <code>ContentBasedDeduplication</code> for your queue,
|
|
2670
|
-
*
|
|
2672
|
+
* <code>ContentBasedDeduplication</code> for your queue, Amazon SQS
|
|
2673
|
+
* uses a SHA-256 hash to generate the
|
|
2671
2674
|
* <code>MessageDeduplicationId</code> using the body of the
|
|
2672
2675
|
* message (but not the attributes of the message). </p>
|
|
2673
2676
|
* </li>
|
|
@@ -2700,22 +2703,20 @@ export interface SetQueueAttributesRequest {
|
|
|
2700
2703
|
* </ul>
|
|
2701
2704
|
* </li>
|
|
2702
2705
|
* </ul>
|
|
2703
|
-
* <p>The following attributes apply only to
|
|
2704
|
-
*
|
|
2706
|
+
* <p>The following attributes apply only to
|
|
2707
|
+
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html">high throughput
|
|
2708
|
+
* for FIFO queues</a>:</p>
|
|
2705
2709
|
* <ul>
|
|
2706
2710
|
* <li>
|
|
2707
2711
|
* <p>
|
|
2708
|
-
* <code>DeduplicationScope</code> – Specifies whether message deduplication
|
|
2709
|
-
*
|
|
2710
|
-
* <code>messageGroup</code> and <code>queue</code>.</p>
|
|
2712
|
+
* <code>DeduplicationScope</code> – Specifies whether message deduplication occurs at the
|
|
2713
|
+
* message group or queue level. Valid values are <code>messageGroup</code> and <code>queue</code>.</p>
|
|
2711
2714
|
* </li>
|
|
2712
2715
|
* <li>
|
|
2713
2716
|
* <p>
|
|
2714
2717
|
* <code>FifoThroughputLimit</code> – Specifies whether the FIFO queue throughput
|
|
2715
|
-
*
|
|
2716
|
-
*
|
|
2717
|
-
* <code>perMessageGroupId</code> value is allowed only when the value for
|
|
2718
|
-
* <code>DeduplicationScope</code> is <code>messageGroup</code>.</p>
|
|
2718
|
+
* quota applies to the entire queue or per message group. Valid values are <code>perQueue</code> and <code>perMessageGroupId</code>.
|
|
2719
|
+
* The <code>perMessageGroupId</code> value is allowed only when the value for <code>DeduplicationScope</code> is <code>messageGroup</code>.</p>
|
|
2719
2720
|
* </li>
|
|
2720
2721
|
* </ul>
|
|
2721
2722
|
* <p>To enable high throughput for FIFO queues, do the following:</p>
|
|
@@ -2728,10 +2729,10 @@ export interface SetQueueAttributesRequest {
|
|
|
2728
2729
|
* </li>
|
|
2729
2730
|
* </ul>
|
|
2730
2731
|
* <p>If you set these attributes to anything other than the values shown for enabling high
|
|
2731
|
-
*
|
|
2732
|
-
* <p>For information on throughput quotas,
|
|
2733
|
-
*
|
|
2734
|
-
*
|
|
2732
|
+
* throughput, normal throughput is in effect and deduplication occurs as specified.</p>
|
|
2733
|
+
* <p>For information on throughput quotas,
|
|
2734
|
+
* see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html">Quotas related to messages</a>
|
|
2735
|
+
* in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
2735
2736
|
* @public
|
|
2736
2737
|
*/
|
|
2737
2738
|
Attributes: Partial<Record<QueueAttributeName, string>> | undefined;
|