@aws-sdk/client-sqs 3.445.0 → 3.447.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 +8 -7
- package/dist-cjs/commands/AddPermissionCommand.js +3 -3
- package/dist-cjs/commands/CancelMessageMoveTaskCommand.js +3 -3
- package/dist-cjs/commands/ChangeMessageVisibilityBatchCommand.js +3 -3
- package/dist-cjs/commands/ChangeMessageVisibilityCommand.js +3 -3
- package/dist-cjs/commands/CreateQueueCommand.js +3 -3
- package/dist-cjs/commands/DeleteMessageBatchCommand.js +3 -3
- package/dist-cjs/commands/DeleteMessageCommand.js +3 -3
- package/dist-cjs/commands/DeleteQueueCommand.js +3 -3
- package/dist-cjs/commands/GetQueueAttributesCommand.js +3 -3
- package/dist-cjs/commands/GetQueueUrlCommand.js +3 -3
- package/dist-cjs/commands/ListDeadLetterSourceQueuesCommand.js +3 -3
- package/dist-cjs/commands/ListMessageMoveTasksCommand.js +3 -3
- package/dist-cjs/commands/ListQueueTagsCommand.js +3 -3
- package/dist-cjs/commands/ListQueuesCommand.js +3 -3
- package/dist-cjs/commands/PurgeQueueCommand.js +3 -3
- package/dist-cjs/commands/ReceiveMessageCommand.js +3 -3
- package/dist-cjs/commands/RemovePermissionCommand.js +3 -3
- package/dist-cjs/commands/SendMessageBatchCommand.js +3 -3
- package/dist-cjs/commands/SendMessageCommand.js +3 -3
- package/dist-cjs/commands/SetQueueAttributesCommand.js +3 -3
- package/dist-cjs/commands/StartMessageMoveTaskCommand.js +3 -3
- package/dist-cjs/commands/TagQueueCommand.js +3 -3
- package/dist-cjs/commands/UntagQueueCommand.js +3 -3
- package/dist-cjs/models/models_0.js +164 -21
- package/dist-cjs/protocols/Aws_json1_0.js +2025 -0
- package/dist-es/commands/AddPermissionCommand.js +1 -1
- package/dist-es/commands/CancelMessageMoveTaskCommand.js +1 -1
- package/dist-es/commands/ChangeMessageVisibilityBatchCommand.js +1 -1
- package/dist-es/commands/ChangeMessageVisibilityCommand.js +1 -1
- package/dist-es/commands/CreateQueueCommand.js +1 -1
- package/dist-es/commands/DeleteMessageBatchCommand.js +1 -1
- package/dist-es/commands/DeleteMessageCommand.js +1 -1
- package/dist-es/commands/DeleteQueueCommand.js +1 -1
- package/dist-es/commands/GetQueueAttributesCommand.js +1 -1
- package/dist-es/commands/GetQueueUrlCommand.js +1 -1
- package/dist-es/commands/ListDeadLetterSourceQueuesCommand.js +1 -1
- package/dist-es/commands/ListMessageMoveTasksCommand.js +1 -1
- package/dist-es/commands/ListQueueTagsCommand.js +1 -1
- package/dist-es/commands/ListQueuesCommand.js +1 -1
- package/dist-es/commands/PurgeQueueCommand.js +1 -1
- package/dist-es/commands/ReceiveMessageCommand.js +1 -1
- package/dist-es/commands/RemovePermissionCommand.js +1 -1
- package/dist-es/commands/SendMessageBatchCommand.js +1 -1
- package/dist-es/commands/SendMessageCommand.js +1 -1
- package/dist-es/commands/SetQueueAttributesCommand.js +1 -1
- package/dist-es/commands/StartMessageMoveTaskCommand.js +1 -1
- package/dist-es/commands/TagQueueCommand.js +1 -1
- package/dist-es/commands/UntagQueueCommand.js +1 -1
- package/dist-es/models/models_0.js +148 -16
- package/dist-es/protocols/Aws_json1_0.js +1976 -0
- package/dist-types/SQS.d.ts +8 -7
- package/dist-types/SQSClient.d.ts +8 -7
- package/dist-types/commands/AddPermissionCommand.d.ts +46 -11
- package/dist-types/commands/CancelMessageMoveTaskCommand.d.ts +25 -0
- package/dist-types/commands/ChangeMessageVisibilityBatchCommand.d.ts +34 -1
- package/dist-types/commands/ChangeMessageVisibilityCommand.d.ts +48 -8
- package/dist-types/commands/CreateQueueCommand.d.ts +45 -10
- package/dist-types/commands/DeleteMessageBatchCommand.d.ts +34 -1
- package/dist-types/commands/DeleteMessageCommand.d.ts +37 -6
- package/dist-types/commands/DeleteQueueCommand.d.ts +34 -3
- package/dist-types/commands/GetQueueAttributesCommand.d.ts +33 -1
- package/dist-types/commands/GetQueueUrlCommand.d.ts +30 -2
- package/dist-types/commands/ListDeadLetterSourceQueuesCommand.d.ts +28 -0
- package/dist-types/commands/ListMessageMoveTasksCommand.d.ts +25 -0
- package/dist-types/commands/ListQueueTagsCommand.d.ts +38 -6
- package/dist-types/commands/ListQueuesCommand.d.ts +32 -4
- package/dist-types/commands/PurgeQueueCommand.d.ts +28 -0
- package/dist-types/commands/ReceiveMessageCommand.d.ts +73 -6
- package/dist-types/commands/RemovePermissionCommand.d.ts +37 -4
- package/dist-types/commands/SendMessageBatchCommand.d.ts +78 -9
- package/dist-types/commands/SendMessageCommand.d.ts +70 -3
- package/dist-types/commands/SetQueueAttributesCommand.d.ts +53 -9
- package/dist-types/commands/StartMessageMoveTaskCommand.d.ts +25 -0
- package/dist-types/commands/TagQueueCommand.d.ts +44 -10
- package/dist-types/commands/UntagQueueCommand.d.ts +38 -5
- package/dist-types/index.d.ts +8 -7
- package/dist-types/models/models_0.d.ts +617 -373
- package/dist-types/protocols/{Aws_query.d.ts → Aws_json1_0.d.ts} +46 -46
- package/dist-types/ts3.4/models/models_0.d.ts +78 -21
- package/package.json +1 -2
- package/dist-cjs/protocols/Aws_query.js +0 -2367
- package/dist-es/protocols/Aws_query.js +0 -2318
- /package/dist-types/ts3.4/protocols/{Aws_query.d.ts → Aws_json1_0.d.ts} +0 -0
|
@@ -21,9 +21,12 @@ export interface AddPermissionRequest {
|
|
|
21
21
|
Label: string | undefined;
|
|
22
22
|
/**
|
|
23
23
|
* @public
|
|
24
|
-
* <p>The Amazon Web
|
|
25
|
-
*
|
|
26
|
-
*
|
|
24
|
+
* <p>The Amazon Web
|
|
25
|
+
* 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
|
|
26
|
+
* permission. For information about locating the Amazon Web Services
|
|
27
|
+
* 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
|
|
28
|
+
* Services Identifiers</a> in the <i>Amazon SQS Developer
|
|
29
|
+
* Guide</i>.</p>
|
|
27
30
|
*/
|
|
28
31
|
AWSAccountIds: string[] | undefined;
|
|
29
32
|
/**
|
|
@@ -40,6 +43,30 @@ export interface AddPermissionRequest {
|
|
|
40
43
|
*/
|
|
41
44
|
Actions: string[] | undefined;
|
|
42
45
|
}
|
|
46
|
+
/**
|
|
47
|
+
* @public
|
|
48
|
+
* <p>The <code>accountId</code> is invalid.</p>
|
|
49
|
+
*/
|
|
50
|
+
export declare class InvalidAddress extends __BaseException {
|
|
51
|
+
readonly name: "InvalidAddress";
|
|
52
|
+
readonly $fault: "client";
|
|
53
|
+
/**
|
|
54
|
+
* @internal
|
|
55
|
+
*/
|
|
56
|
+
constructor(opts: __ExceptionOptionType<InvalidAddress, __BaseException>);
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* @public
|
|
60
|
+
* <p>When the request to a queue is not HTTPS and SigV4.</p>
|
|
61
|
+
*/
|
|
62
|
+
export declare class InvalidSecurity extends __BaseException {
|
|
63
|
+
readonly name: "InvalidSecurity";
|
|
64
|
+
readonly $fault: "client";
|
|
65
|
+
/**
|
|
66
|
+
* @internal
|
|
67
|
+
*/
|
|
68
|
+
constructor(opts: __ExceptionOptionType<InvalidSecurity, __BaseException>);
|
|
69
|
+
}
|
|
43
70
|
/**
|
|
44
71
|
* @public
|
|
45
72
|
* <p>The specified action violates a limit. For example, <code>ReceiveMessage</code>
|
|
@@ -55,6 +82,58 @@ export declare class OverLimit extends __BaseException {
|
|
|
55
82
|
*/
|
|
56
83
|
constructor(opts: __ExceptionOptionType<OverLimit, __BaseException>);
|
|
57
84
|
}
|
|
85
|
+
/**
|
|
86
|
+
* @public
|
|
87
|
+
* <p>The specified queue doesn't exist.</p>
|
|
88
|
+
*/
|
|
89
|
+
export declare class QueueDoesNotExist extends __BaseException {
|
|
90
|
+
readonly name: "QueueDoesNotExist";
|
|
91
|
+
readonly $fault: "client";
|
|
92
|
+
/**
|
|
93
|
+
* @internal
|
|
94
|
+
*/
|
|
95
|
+
constructor(opts: __ExceptionOptionType<QueueDoesNotExist, __BaseException>);
|
|
96
|
+
}
|
|
97
|
+
/**
|
|
98
|
+
* @public
|
|
99
|
+
* <p>The request was denied due to request throttling.</p>
|
|
100
|
+
* <ul>
|
|
101
|
+
* <li>
|
|
102
|
+
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request quota for an
|
|
103
|
+
* account and Region. </p>
|
|
104
|
+
* </li>
|
|
105
|
+
* <li>
|
|
106
|
+
* <p>A burst or sustained high rate of requests to change the state of the same KMS
|
|
107
|
+
* key. This condition is often known as a "hot key."</p>
|
|
108
|
+
* </li>
|
|
109
|
+
* <li>
|
|
110
|
+
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
111
|
+
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
112
|
+
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
113
|
+
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
114
|
+
* </li>
|
|
115
|
+
* </ul>
|
|
116
|
+
*/
|
|
117
|
+
export declare class RequestThrottled extends __BaseException {
|
|
118
|
+
readonly name: "RequestThrottled";
|
|
119
|
+
readonly $fault: "client";
|
|
120
|
+
/**
|
|
121
|
+
* @internal
|
|
122
|
+
*/
|
|
123
|
+
constructor(opts: __ExceptionOptionType<RequestThrottled, __BaseException>);
|
|
124
|
+
}
|
|
125
|
+
/**
|
|
126
|
+
* @public
|
|
127
|
+
* <p>Error code 400. Unsupported operation.</p>
|
|
128
|
+
*/
|
|
129
|
+
export declare class UnsupportedOperation extends __BaseException {
|
|
130
|
+
readonly name: "UnsupportedOperation";
|
|
131
|
+
readonly $fault: "client";
|
|
132
|
+
/**
|
|
133
|
+
* @internal
|
|
134
|
+
*/
|
|
135
|
+
constructor(opts: __ExceptionOptionType<UnsupportedOperation, __BaseException>);
|
|
136
|
+
}
|
|
58
137
|
/**
|
|
59
138
|
* @public
|
|
60
139
|
*/
|
|
@@ -87,18 +166,6 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
87
166
|
*/
|
|
88
167
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
89
168
|
}
|
|
90
|
-
/**
|
|
91
|
-
* @public
|
|
92
|
-
* <p>Error code 400. Unsupported operation.</p>
|
|
93
|
-
*/
|
|
94
|
-
export declare class UnsupportedOperation extends __BaseException {
|
|
95
|
-
readonly name: "UnsupportedOperation";
|
|
96
|
-
readonly $fault: "client";
|
|
97
|
-
/**
|
|
98
|
-
* @internal
|
|
99
|
-
*/
|
|
100
|
-
constructor(opts: __ExceptionOptionType<UnsupportedOperation, __BaseException>);
|
|
101
|
-
}
|
|
102
169
|
/**
|
|
103
170
|
* @public
|
|
104
171
|
*/
|
|
@@ -174,7 +241,8 @@ export interface ChangeMessageVisibilityBatchRequestEntry {
|
|
|
174
241
|
* result.</p>
|
|
175
242
|
* <note>
|
|
176
243
|
* <p>The <code>Id</code>s of a batch request need to be unique within a request.</p>
|
|
177
|
-
* <p>This identifier can have up to 80 characters. The following characters are
|
|
244
|
+
* <p>This identifier can have up to 80 characters. The following characters are
|
|
245
|
+
* accepted: alphanumeric characters, hyphens(-), and underscores (_).</p>
|
|
178
246
|
* </note>
|
|
179
247
|
*/
|
|
180
248
|
Id: string | undefined;
|
|
@@ -366,37 +434,6 @@ export interface CreateQueueRequest {
|
|
|
366
434
|
* <p>Queue URLs and names are case-sensitive.</p>
|
|
367
435
|
*/
|
|
368
436
|
QueueName: string | undefined;
|
|
369
|
-
/**
|
|
370
|
-
* @public
|
|
371
|
-
* <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
|
|
372
|
-
* Your Amazon SQS Queues</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
373
|
-
* <p>When you use queue tags, keep the following guidelines in mind:</p>
|
|
374
|
-
* <ul>
|
|
375
|
-
* <li>
|
|
376
|
-
* <p>Adding more than 50 tags to a queue isn't recommended.</p>
|
|
377
|
-
* </li>
|
|
378
|
-
* <li>
|
|
379
|
-
* <p>Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.</p>
|
|
380
|
-
* </li>
|
|
381
|
-
* <li>
|
|
382
|
-
* <p>Tags are case-sensitive.</p>
|
|
383
|
-
* </li>
|
|
384
|
-
* <li>
|
|
385
|
-
* <p>A new tag with a key identical to that of an existing tag overwrites the existing tag.</p>
|
|
386
|
-
* </li>
|
|
387
|
-
* </ul>
|
|
388
|
-
* <p>For a full list of tag restrictions, see
|
|
389
|
-
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues">Quotas related to queues</a>
|
|
390
|
-
* in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
391
|
-
* <note>
|
|
392
|
-
* <p>To be able to tag a queue on creation, you must have the
|
|
393
|
-
* <code>sqs:CreateQueue</code> and <code>sqs:TagQueue</code> permissions.</p>
|
|
394
|
-
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
395
|
-
* 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
|
|
396
|
-
* cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
397
|
-
* </note>
|
|
398
|
-
*/
|
|
399
|
-
tags?: Record<string, string>;
|
|
400
437
|
/**
|
|
401
438
|
* @public
|
|
402
439
|
* <p>A map of attributes with their corresponding values.</p>
|
|
@@ -411,36 +448,35 @@ export interface CreateQueueRequest {
|
|
|
411
448
|
* </li>
|
|
412
449
|
* <li>
|
|
413
450
|
* <p>
|
|
414
|
-
* <code>MaximumMessageSize</code> – The limit of how many bytes a message
|
|
415
|
-
*
|
|
451
|
+
* <code>MaximumMessageSize</code> – The limit of how many bytes a message can
|
|
452
|
+
* contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes
|
|
416
453
|
* (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). </p>
|
|
417
454
|
* </li>
|
|
418
455
|
* <li>
|
|
419
456
|
* <p>
|
|
420
|
-
* <code>MessageRetentionPeriod</code> – The length of time, in seconds, for
|
|
421
|
-
*
|
|
457
|
+
* <code>MessageRetentionPeriod</code> – The length of time, in seconds, for which
|
|
458
|
+
* Amazon SQS retains a message. Valid values: An integer from 60 seconds (1
|
|
422
459
|
* minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days). When you
|
|
423
460
|
* change a queue's attributes, the change can take up to 60 seconds for most of
|
|
424
|
-
* the attributes to propagate throughout the Amazon SQS system. Changes made to
|
|
425
|
-
*
|
|
461
|
+
* the attributes to propagate throughout the Amazon SQS system. Changes made to
|
|
462
|
+
* the <code>MessageRetentionPeriod</code> attribute can take up to 15 minutes and
|
|
426
463
|
* will impact existing messages in the queue potentially causing them to be
|
|
427
464
|
* expired and deleted if the <code>MessageRetentionPeriod</code> is reduced below
|
|
428
465
|
* the age of existing messages.</p>
|
|
429
466
|
* </li>
|
|
430
467
|
* <li>
|
|
431
468
|
* <p>
|
|
432
|
-
* <code>Policy</code> – The queue's policy. A valid Amazon Web Services
|
|
433
|
-
* information about policy structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview of Amazon Web Services IAM
|
|
434
|
-
*
|
|
469
|
+
* <code>Policy</code> – The queue's policy. A valid Amazon Web Services
|
|
470
|
+
* policy. For more information about policy structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview of Amazon Web Services IAM Policies</a> in the <i>IAM
|
|
471
|
+
* User Guide</i>. </p>
|
|
435
472
|
* </li>
|
|
436
473
|
* <li>
|
|
437
474
|
* <p>
|
|
438
|
-
* <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in
|
|
439
|
-
*
|
|
475
|
+
* <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in seconds, for
|
|
476
|
+
* which a <code>
|
|
440
477
|
* <a>ReceiveMessage</a>
|
|
441
|
-
* </code> action waits
|
|
442
|
-
*
|
|
443
|
-
* Default: 0. </p>
|
|
478
|
+
* </code> action waits for a message
|
|
479
|
+
* to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0. </p>
|
|
444
480
|
* </li>
|
|
445
481
|
* <li>
|
|
446
482
|
* <p>
|
|
@@ -455,102 +491,115 @@ export interface CreateQueueRequest {
|
|
|
455
491
|
* <ul>
|
|
456
492
|
* <li>
|
|
457
493
|
* <p>
|
|
458
|
-
* <code>RedrivePolicy</code> – The string that includes the parameters for the
|
|
459
|
-
*
|
|
494
|
+
* <code>RedrivePolicy</code> – The string that includes the parameters for the
|
|
495
|
+
* dead-letter queue functionality of the source queue as a JSON object. The
|
|
496
|
+
* parameters are as follows:</p>
|
|
460
497
|
* <ul>
|
|
461
498
|
* <li>
|
|
462
499
|
* <p>
|
|
463
|
-
* <code>deadLetterTargetArn</code> – The Amazon Resource Name (ARN) of
|
|
464
|
-
*
|
|
500
|
+
* <code>deadLetterTargetArn</code> – The Amazon Resource Name (ARN) of
|
|
501
|
+
* the dead-letter queue to which Amazon SQS moves messages after the value
|
|
502
|
+
* of <code>maxReceiveCount</code> is exceeded.</p>
|
|
465
503
|
* </li>
|
|
466
504
|
* <li>
|
|
467
505
|
* <p>
|
|
468
|
-
* <code>maxReceiveCount</code> – The number of times a message is
|
|
469
|
-
*
|
|
470
|
-
*
|
|
506
|
+
* <code>maxReceiveCount</code> – The number of times a message is
|
|
507
|
+
* delivered to the source queue before being moved to the dead-letter
|
|
508
|
+
* queue. Default: 10. When the <code>ReceiveCount</code> for a message
|
|
509
|
+
* exceeds the <code>maxReceiveCount</code> for a queue, Amazon SQS moves
|
|
510
|
+
* the message to the dead-letter-queue.</p>
|
|
471
511
|
* </li>
|
|
472
512
|
* </ul>
|
|
473
513
|
* </li>
|
|
474
514
|
* <li>
|
|
475
515
|
* <p>
|
|
476
|
-
* <code>RedriveAllowPolicy</code> – The string that includes the parameters for
|
|
477
|
-
*
|
|
516
|
+
* <code>RedriveAllowPolicy</code> – The string that includes the parameters for
|
|
517
|
+
* the permissions for the dead-letter queue redrive permission and which source
|
|
518
|
+
* queues can specify dead-letter queues as a JSON object. The parameters are as
|
|
519
|
+
* follows:</p>
|
|
478
520
|
* <ul>
|
|
479
521
|
* <li>
|
|
480
522
|
* <p>
|
|
481
|
-
* <code>redrivePermission</code> – The permission type that defines
|
|
482
|
-
*
|
|
523
|
+
* <code>redrivePermission</code> – The permission type that defines
|
|
524
|
+
* which source queues can specify the current queue as the dead-letter
|
|
525
|
+
* queue. Valid values are:</p>
|
|
483
526
|
* <ul>
|
|
484
527
|
* <li>
|
|
485
528
|
* <p>
|
|
486
|
-
* <code>allowAll</code> – (Default) Any source queues in this
|
|
487
|
-
*
|
|
529
|
+
* <code>allowAll</code> – (Default) Any source queues in this
|
|
530
|
+
* Amazon Web Services account in the same
|
|
531
|
+
* Region can specify this queue as the dead-letter queue.</p>
|
|
488
532
|
* </li>
|
|
489
533
|
* <li>
|
|
490
534
|
* <p>
|
|
491
|
-
* <code>denyAll</code> – No source queues can specify this queue
|
|
492
|
-
*
|
|
535
|
+
* <code>denyAll</code> – No source queues can specify this queue
|
|
536
|
+
* as the dead-letter queue.</p>
|
|
493
537
|
* </li>
|
|
494
538
|
* <li>
|
|
495
539
|
* <p>
|
|
496
|
-
* <code>byQueue</code> – Only queues specified by the
|
|
497
|
-
*
|
|
540
|
+
* <code>byQueue</code> – Only queues specified by the
|
|
541
|
+
* <code>sourceQueueArns</code> parameter can specify this
|
|
542
|
+
* queue as the dead-letter queue.</p>
|
|
498
543
|
* </li>
|
|
499
544
|
* </ul>
|
|
500
545
|
* </li>
|
|
501
546
|
* <li>
|
|
502
547
|
* <p>
|
|
503
|
-
* <code>sourceQueueArns</code> – The Amazon Resource Names (ARN)s of the
|
|
504
|
-
*
|
|
505
|
-
*
|
|
506
|
-
*
|
|
507
|
-
*
|
|
548
|
+
* <code>sourceQueueArns</code> – The Amazon Resource Names (ARN)s of the
|
|
549
|
+
* source queues that can specify this queue as the dead-letter queue and
|
|
550
|
+
* redrive messages. You can specify this parameter only when the
|
|
551
|
+
* <code>redrivePermission</code> parameter is set to
|
|
552
|
+
* <code>byQueue</code>. You can specify up to 10 source queue ARNs. To
|
|
553
|
+
* allow more than 10 source queues to specify dead-letter queues, set the
|
|
554
|
+
* <code>redrivePermission</code> parameter to
|
|
555
|
+
* <code>allowAll</code>.</p>
|
|
508
556
|
* </li>
|
|
509
557
|
* </ul>
|
|
510
558
|
* </li>
|
|
511
559
|
* </ul>
|
|
512
560
|
* <note>
|
|
513
|
-
* <p>The dead-letter queue of a
|
|
514
|
-
*
|
|
515
|
-
* queue of a standard queue must also be a standard queue.</p>
|
|
561
|
+
* <p>The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the
|
|
562
|
+
* dead-letter queue of a standard queue must also be a standard queue.</p>
|
|
516
563
|
* </note>
|
|
517
564
|
* <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>
|
|
518
565
|
* <ul>
|
|
519
566
|
* <li>
|
|
520
567
|
* <p>
|
|
521
|
-
* <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer
|
|
522
|
-
* key (CMK) for Amazon SQS or a custom CMK. For more information, see
|
|
523
|
-
*
|
|
524
|
-
*
|
|
525
|
-
*
|
|
526
|
-
*
|
|
568
|
+
* <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer
|
|
569
|
+
* master key (CMK) for Amazon SQS or a custom CMK. For more information, see
|
|
570
|
+
* <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
|
|
571
|
+
* managed CMK for Amazon SQS is always <code>alias/aws/sqs</code>, the alias of a
|
|
572
|
+
* custom CMK can, for example, be <code>alias/<i>MyAlias</i>
|
|
573
|
+
* </code>.
|
|
574
|
+
* 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
|
|
527
575
|
* Reference</i>. </p>
|
|
528
576
|
* </li>
|
|
529
577
|
* <li>
|
|
530
578
|
* <p>
|
|
531
|
-
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in
|
|
532
|
-
*
|
|
533
|
-
* encrypt or decrypt messages before calling KMS again. An integer
|
|
534
|
-
*
|
|
535
|
-
*
|
|
536
|
-
*
|
|
537
|
-
*
|
|
579
|
+
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in seconds, for
|
|
580
|
+
* which Amazon SQS can reuse a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data key</a> to
|
|
581
|
+
* encrypt or decrypt messages before calling KMS again. An integer representing
|
|
582
|
+
* seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default:
|
|
583
|
+
* 300 (5 minutes). A shorter time period provides better security but results in
|
|
584
|
+
* more calls to KMS which might incur charges after Free Tier. For more
|
|
585
|
+
* 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>
|
|
538
586
|
* </p>
|
|
539
587
|
* </li>
|
|
540
588
|
* <li>
|
|
541
589
|
* <p>
|
|
542
|
-
* <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption
|
|
543
|
-
*
|
|
544
|
-
*
|
|
590
|
+
* <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption using
|
|
591
|
+
* SQS owned encryption keys. Only one server-side encryption option is supported
|
|
592
|
+
* 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>
|
|
545
593
|
* </li>
|
|
546
594
|
* </ul>
|
|
547
|
-
* <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO
|
|
548
|
-
* queues</a>:</p>
|
|
595
|
+
* <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO
|
|
596
|
+
* (first-in-first-out) queues</a>:</p>
|
|
549
597
|
* <ul>
|
|
550
598
|
* <li>
|
|
551
599
|
* <p>
|
|
552
600
|
* <code>FifoQueue</code> – Designates a queue as FIFO. Valid values are
|
|
553
|
-
* <code>true</code> and <code>false</code>. If you don't specify the
|
|
601
|
+
* <code>true</code> and <code>false</code>. If you don't specify the
|
|
602
|
+
* <code>FifoQueue</code> attribute, Amazon SQS creates a standard queue. You
|
|
554
603
|
* can provide this attribute only during queue creation. You can't change it for
|
|
555
604
|
* an existing queue. When you set this attribute, you must also provide the
|
|
556
605
|
* <code>MessageGroupId</code> for your messages explicitly.</p>
|
|
@@ -559,9 +608,9 @@ export interface CreateQueueRequest {
|
|
|
559
608
|
* </li>
|
|
560
609
|
* <li>
|
|
561
610
|
* <p>
|
|
562
|
-
* <code>ContentBasedDeduplication</code> – Enables content-based
|
|
563
|
-
*
|
|
564
|
-
*
|
|
611
|
+
* <code>ContentBasedDeduplication</code> – Enables content-based deduplication.
|
|
612
|
+
* Valid values are <code>true</code> and <code>false</code>. For more information,
|
|
613
|
+
* 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
|
|
565
614
|
* Guide</i>. Note the following: </p>
|
|
566
615
|
* <ul>
|
|
567
616
|
* <li>
|
|
@@ -575,8 +624,8 @@ export interface CreateQueueRequest {
|
|
|
575
624
|
* <li>
|
|
576
625
|
* <p>If you aren't able to provide a
|
|
577
626
|
* <code>MessageDeduplicationId</code> and you enable
|
|
578
|
-
* <code>ContentBasedDeduplication</code> for your queue,
|
|
579
|
-
* uses a SHA-256 hash to generate the
|
|
627
|
+
* <code>ContentBasedDeduplication</code> for your queue,
|
|
628
|
+
* Amazon SQS uses a SHA-256 hash to generate the
|
|
580
629
|
* <code>MessageDeduplicationId</code> using the body of the
|
|
581
630
|
* message (but not the attributes of the message). </p>
|
|
582
631
|
* </li>
|
|
@@ -609,20 +658,22 @@ export interface CreateQueueRequest {
|
|
|
609
658
|
* </ul>
|
|
610
659
|
* </li>
|
|
611
660
|
* </ul>
|
|
612
|
-
* <p>The following attributes apply only to
|
|
613
|
-
*
|
|
614
|
-
* for FIFO queues</a>:</p>
|
|
661
|
+
* <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html">high
|
|
662
|
+
* throughput for FIFO queues</a>:</p>
|
|
615
663
|
* <ul>
|
|
616
664
|
* <li>
|
|
617
665
|
* <p>
|
|
618
|
-
* <code>DeduplicationScope</code> – Specifies whether message deduplication
|
|
619
|
-
*
|
|
666
|
+
* <code>DeduplicationScope</code> – Specifies whether message deduplication
|
|
667
|
+
* occurs at the message group or queue level. Valid values are
|
|
668
|
+
* <code>messageGroup</code> and <code>queue</code>.</p>
|
|
620
669
|
* </li>
|
|
621
670
|
* <li>
|
|
622
671
|
* <p>
|
|
623
672
|
* <code>FifoThroughputLimit</code> – Specifies whether the FIFO queue throughput
|
|
624
|
-
*
|
|
625
|
-
*
|
|
673
|
+
* quota applies to the entire queue or per message group. Valid values are
|
|
674
|
+
* <code>perQueue</code> and <code>perMessageGroupId</code>. The
|
|
675
|
+
* <code>perMessageGroupId</code> value is allowed only when the value for
|
|
676
|
+
* <code>DeduplicationScope</code> is <code>messageGroup</code>.</p>
|
|
626
677
|
* </li>
|
|
627
678
|
* </ul>
|
|
628
679
|
* <p>To enable high throughput for FIFO queues, do the following:</p>
|
|
@@ -635,12 +686,46 @@ export interface CreateQueueRequest {
|
|
|
635
686
|
* </li>
|
|
636
687
|
* </ul>
|
|
637
688
|
* <p>If you set these attributes to anything other than the values shown for enabling high
|
|
638
|
-
*
|
|
639
|
-
* <p>For information on throughput quotas,
|
|
640
|
-
*
|
|
641
|
-
*
|
|
689
|
+
* throughput, normal throughput is in effect and deduplication occurs as specified.</p>
|
|
690
|
+
* <p>For information on throughput quotas, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html">Quotas
|
|
691
|
+
* related to messages</a> in the <i>Amazon SQS Developer
|
|
692
|
+
* Guide</i>.</p>
|
|
642
693
|
*/
|
|
643
694
|
Attributes?: Partial<Record<QueueAttributeName, string>>;
|
|
695
|
+
/**
|
|
696
|
+
* @public
|
|
697
|
+
* <p>Add cost allocation tags to the specified Amazon SQS queue. For an overview, see
|
|
698
|
+
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html">Tagging
|
|
699
|
+
* Your Amazon SQS Queues</a> in the <i>Amazon SQS Developer
|
|
700
|
+
* Guide</i>.</p>
|
|
701
|
+
* <p>When you use queue tags, keep the following guidelines in mind:</p>
|
|
702
|
+
* <ul>
|
|
703
|
+
* <li>
|
|
704
|
+
* <p>Adding more than 50 tags to a queue isn't recommended.</p>
|
|
705
|
+
* </li>
|
|
706
|
+
* <li>
|
|
707
|
+
* <p>Tags don't have any semantic meaning. Amazon SQS interprets tags as character
|
|
708
|
+
* strings.</p>
|
|
709
|
+
* </li>
|
|
710
|
+
* <li>
|
|
711
|
+
* <p>Tags are case-sensitive.</p>
|
|
712
|
+
* </li>
|
|
713
|
+
* <li>
|
|
714
|
+
* <p>A new tag with a key identical to that of an existing tag overwrites the
|
|
715
|
+
* existing tag.</p>
|
|
716
|
+
* </li>
|
|
717
|
+
* </ul>
|
|
718
|
+
* <p>For a full list of tag restrictions, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues">Quotas related to queues</a> in the <i>Amazon SQS Developer
|
|
719
|
+
* Guide</i>.</p>
|
|
720
|
+
* <note>
|
|
721
|
+
* <p>To be able to tag a queue on creation, you must have the
|
|
722
|
+
* <code>sqs:CreateQueue</code> and <code>sqs:TagQueue</code> permissions.</p>
|
|
723
|
+
* <p>Cross-account permissions don't apply to this action. For more information, see
|
|
724
|
+
* <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 cross-account permissions to a role and a username</a> in the
|
|
725
|
+
* <i>Amazon SQS Developer Guide</i>.</p>
|
|
726
|
+
* </note>
|
|
727
|
+
*/
|
|
728
|
+
tags?: Record<string, string>;
|
|
644
729
|
}
|
|
645
730
|
/**
|
|
646
731
|
* @public
|
|
@@ -653,6 +738,30 @@ export interface CreateQueueResult {
|
|
|
653
738
|
*/
|
|
654
739
|
QueueUrl?: string;
|
|
655
740
|
}
|
|
741
|
+
/**
|
|
742
|
+
* @public
|
|
743
|
+
* <p>The specified attribute doesn't exist.</p>
|
|
744
|
+
*/
|
|
745
|
+
export declare class InvalidAttributeName extends __BaseException {
|
|
746
|
+
readonly name: "InvalidAttributeName";
|
|
747
|
+
readonly $fault: "client";
|
|
748
|
+
/**
|
|
749
|
+
* @internal
|
|
750
|
+
*/
|
|
751
|
+
constructor(opts: __ExceptionOptionType<InvalidAttributeName, __BaseException>);
|
|
752
|
+
}
|
|
753
|
+
/**
|
|
754
|
+
* @public
|
|
755
|
+
* <p>A queue attribute value is invalid.</p>
|
|
756
|
+
*/
|
|
757
|
+
export declare class InvalidAttributeValue extends __BaseException {
|
|
758
|
+
readonly name: "InvalidAttributeValue";
|
|
759
|
+
readonly $fault: "client";
|
|
760
|
+
/**
|
|
761
|
+
* @internal
|
|
762
|
+
*/
|
|
763
|
+
constructor(opts: __ExceptionOptionType<InvalidAttributeValue, __BaseException>);
|
|
764
|
+
}
|
|
656
765
|
/**
|
|
657
766
|
* @public
|
|
658
767
|
* <p>You must wait 60 seconds after deleting a queue before you can create another queue
|
|
@@ -668,8 +777,8 @@ export declare class QueueDeletedRecently extends __BaseException {
|
|
|
668
777
|
}
|
|
669
778
|
/**
|
|
670
779
|
* @public
|
|
671
|
-
* <p>A queue with this name already exists. Amazon SQS returns this error only if the
|
|
672
|
-
* includes attributes whose values differ from those of the existing queue.</p>
|
|
780
|
+
* <p>A queue with this name already exists. Amazon SQS returns this error only if the
|
|
781
|
+
* request includes attributes whose values differ from those of the existing queue.</p>
|
|
673
782
|
*/
|
|
674
783
|
export declare class QueueNameExists extends __BaseException {
|
|
675
784
|
readonly name: "QueueNameExists";
|
|
@@ -698,6 +807,8 @@ export interface DeleteMessageRequest {
|
|
|
698
807
|
}
|
|
699
808
|
/**
|
|
700
809
|
* @public
|
|
810
|
+
* @deprecated
|
|
811
|
+
*
|
|
701
812
|
* <p>The specified receipt handle isn't valid for the current version.</p>
|
|
702
813
|
*/
|
|
703
814
|
export declare class InvalidIdFormat extends __BaseException {
|
|
@@ -719,7 +830,8 @@ export interface DeleteMessageBatchRequestEntry {
|
|
|
719
830
|
* result.</p>
|
|
720
831
|
* <note>
|
|
721
832
|
* <p>The <code>Id</code>s of a batch request need to be unique within a request.</p>
|
|
722
|
-
* <p>This identifier can have up to 80 characters. The following characters are
|
|
833
|
+
* <p>This identifier can have up to 80 characters. The following characters are
|
|
834
|
+
* accepted: alphanumeric characters, hyphens(-), and underscores (_).</p>
|
|
723
835
|
* </note>
|
|
724
836
|
*/
|
|
725
837
|
Id: string | undefined;
|
|
@@ -814,7 +926,9 @@ export interface GetQueueAttributesRequest {
|
|
|
814
926
|
* <p>The <code>AttributeNames</code> parameter is optional, but if you don't specify values
|
|
815
927
|
* for this parameter, the request returns empty results.</p>
|
|
816
928
|
* <note>
|
|
817
|
-
* <p>In the future, new attributes might be added. If you write code that calls this
|
|
929
|
+
* <p>In the future, new attributes might be added. If you write code that calls this
|
|
930
|
+
* action, we recommend that you structure your code so that it can handle new
|
|
931
|
+
* attributes gracefully.</p>
|
|
818
932
|
* </note>
|
|
819
933
|
* <p>The following attributes are supported:</p>
|
|
820
934
|
* <important>
|
|
@@ -831,29 +945,29 @@ export interface GetQueueAttributesRequest {
|
|
|
831
945
|
* </li>
|
|
832
946
|
* <li>
|
|
833
947
|
* <p>
|
|
834
|
-
* <code>ApproximateNumberOfMessages</code> – Returns the approximate
|
|
835
|
-
*
|
|
948
|
+
* <code>ApproximateNumberOfMessages</code> – Returns the approximate number of
|
|
949
|
+
* messages available for retrieval from the queue.</p>
|
|
836
950
|
* </li>
|
|
837
951
|
* <li>
|
|
838
952
|
* <p>
|
|
839
|
-
* <code>ApproximateNumberOfMessagesDelayed</code> – Returns the
|
|
840
|
-
*
|
|
841
|
-
*
|
|
842
|
-
*
|
|
953
|
+
* <code>ApproximateNumberOfMessagesDelayed</code> – Returns the approximate
|
|
954
|
+
* number of messages in the queue that are delayed and not available for reading
|
|
955
|
+
* immediately. This can happen when the queue is configured as a delay queue or
|
|
956
|
+
* when a message has been sent with a delay parameter.</p>
|
|
843
957
|
* </li>
|
|
844
958
|
* <li>
|
|
845
959
|
* <p>
|
|
846
|
-
* <code>ApproximateNumberOfMessagesNotVisible</code> – Returns the
|
|
847
|
-
*
|
|
960
|
+
* <code>ApproximateNumberOfMessagesNotVisible</code> – Returns the approximate
|
|
961
|
+
* number of messages that are in flight. Messages are considered to be
|
|
848
962
|
* <i>in flight</i> if they have been sent to a client but have
|
|
849
963
|
* not yet been deleted or have not yet reached the end of their visibility window.
|
|
850
964
|
* </p>
|
|
851
965
|
* </li>
|
|
852
966
|
* <li>
|
|
853
967
|
* <p>
|
|
854
|
-
* <code>CreatedTimestamp</code> – Returns the time when the queue was
|
|
855
|
-
*
|
|
856
|
-
*
|
|
968
|
+
* <code>CreatedTimestamp</code> – Returns the time when the queue was created in
|
|
969
|
+
* seconds (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch
|
|
970
|
+
* time</a>).</p>
|
|
857
971
|
* </li>
|
|
858
972
|
* <li>
|
|
859
973
|
* <p>
|
|
@@ -862,8 +976,9 @@ export interface GetQueueAttributesRequest {
|
|
|
862
976
|
* </li>
|
|
863
977
|
* <li>
|
|
864
978
|
* <p>
|
|
865
|
-
* <code>LastModifiedTimestamp</code> – Returns the time when the queue
|
|
866
|
-
*
|
|
979
|
+
* <code>LastModifiedTimestamp</code> – Returns the time when the queue was last
|
|
980
|
+
* changed in seconds (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch
|
|
981
|
+
* time</a>).</p>
|
|
867
982
|
* </li>
|
|
868
983
|
* <li>
|
|
869
984
|
* <p>
|
|
@@ -872,10 +987,10 @@ export interface GetQueueAttributesRequest {
|
|
|
872
987
|
* </li>
|
|
873
988
|
* <li>
|
|
874
989
|
* <p>
|
|
875
|
-
* <code>MessageRetentionPeriod</code> – Returns the length of time, in
|
|
876
|
-
*
|
|
877
|
-
*
|
|
878
|
-
*
|
|
990
|
+
* <code>MessageRetentionPeriod</code> – Returns the length of time, in seconds,
|
|
991
|
+
* for which Amazon SQS retains a message. When you change a queue's attributes,
|
|
992
|
+
* the change can take up to 60 seconds for most of the attributes to propagate
|
|
993
|
+
* throughout the Amazon SQS system. Changes made to the
|
|
879
994
|
* <code>MessageRetentionPeriod</code> attribute can take up to 15 minutes and
|
|
880
995
|
* will impact existing messages in the queue potentially causing them to be
|
|
881
996
|
* expired and deleted if the <code>MessageRetentionPeriod</code> is reduced below
|
|
@@ -892,14 +1007,14 @@ export interface GetQueueAttributesRequest {
|
|
|
892
1007
|
* </li>
|
|
893
1008
|
* <li>
|
|
894
1009
|
* <p>
|
|
895
|
-
* <code>ReceiveMessageWaitTimeSeconds</code> – Returns the length of
|
|
896
|
-
*
|
|
897
|
-
*
|
|
1010
|
+
* <code>ReceiveMessageWaitTimeSeconds</code> – Returns the length of time, in
|
|
1011
|
+
* seconds, for which the <code>ReceiveMessage</code> action waits for a message to
|
|
1012
|
+
* arrive. </p>
|
|
898
1013
|
* </li>
|
|
899
1014
|
* <li>
|
|
900
1015
|
* <p>
|
|
901
|
-
* <code>VisibilityTimeout</code> – Returns the visibility timeout for the
|
|
902
|
-
*
|
|
1016
|
+
* <code>VisibilityTimeout</code> – Returns the visibility timeout for the queue.
|
|
1017
|
+
* 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
|
|
903
1018
|
* Guide</i>. </p>
|
|
904
1019
|
* </li>
|
|
905
1020
|
* </ul>
|
|
@@ -908,96 +1023,108 @@ export interface GetQueueAttributesRequest {
|
|
|
908
1023
|
* <ul>
|
|
909
1024
|
* <li>
|
|
910
1025
|
* <p>
|
|
911
|
-
* <code>RedrivePolicy</code> – The string that includes the parameters for the
|
|
912
|
-
*
|
|
1026
|
+
* <code>RedrivePolicy</code> – The string that includes the parameters for the
|
|
1027
|
+
* dead-letter queue functionality of the source queue as a JSON object. The
|
|
1028
|
+
* parameters are as follows:</p>
|
|
913
1029
|
* <ul>
|
|
914
1030
|
* <li>
|
|
915
1031
|
* <p>
|
|
916
|
-
* <code>deadLetterTargetArn</code> – The Amazon Resource Name (ARN) of
|
|
917
|
-
*
|
|
1032
|
+
* <code>deadLetterTargetArn</code> – The Amazon Resource Name (ARN) of
|
|
1033
|
+
* the dead-letter queue to which Amazon SQS moves messages after the value
|
|
1034
|
+
* of <code>maxReceiveCount</code> is exceeded.</p>
|
|
918
1035
|
* </li>
|
|
919
1036
|
* <li>
|
|
920
1037
|
* <p>
|
|
921
|
-
* <code>maxReceiveCount</code> – The number of times a message is
|
|
922
|
-
*
|
|
923
|
-
*
|
|
1038
|
+
* <code>maxReceiveCount</code> – The number of times a message is
|
|
1039
|
+
* delivered to the source queue before being moved to the dead-letter
|
|
1040
|
+
* queue. Default: 10. When the <code>ReceiveCount</code> for a message
|
|
1041
|
+
* exceeds the <code>maxReceiveCount</code> for a queue, Amazon SQS moves
|
|
1042
|
+
* the message to the dead-letter-queue.</p>
|
|
924
1043
|
* </li>
|
|
925
1044
|
* </ul>
|
|
926
1045
|
* </li>
|
|
927
1046
|
* <li>
|
|
928
1047
|
* <p>
|
|
929
|
-
* <code>RedriveAllowPolicy</code> – The string that includes the parameters for
|
|
930
|
-
*
|
|
1048
|
+
* <code>RedriveAllowPolicy</code> – The string that includes the parameters for
|
|
1049
|
+
* the permissions for the dead-letter queue redrive permission and which source
|
|
1050
|
+
* queues can specify dead-letter queues as a JSON object. The parameters are as
|
|
1051
|
+
* follows:</p>
|
|
931
1052
|
* <ul>
|
|
932
1053
|
* <li>
|
|
933
1054
|
* <p>
|
|
934
|
-
* <code>redrivePermission</code> – The permission type that defines
|
|
935
|
-
*
|
|
1055
|
+
* <code>redrivePermission</code> – The permission type that defines
|
|
1056
|
+
* which source queues can specify the current queue as the dead-letter
|
|
1057
|
+
* queue. Valid values are:</p>
|
|
936
1058
|
* <ul>
|
|
937
1059
|
* <li>
|
|
938
1060
|
* <p>
|
|
939
|
-
* <code>allowAll</code> – (Default) Any source queues in this
|
|
940
|
-
*
|
|
1061
|
+
* <code>allowAll</code> – (Default) Any source queues in this
|
|
1062
|
+
* Amazon Web Services account in the same
|
|
1063
|
+
* Region can specify this queue as the dead-letter queue.</p>
|
|
941
1064
|
* </li>
|
|
942
1065
|
* <li>
|
|
943
1066
|
* <p>
|
|
944
|
-
* <code>denyAll</code> – No source queues can specify this queue
|
|
945
|
-
*
|
|
1067
|
+
* <code>denyAll</code> – No source queues can specify this queue
|
|
1068
|
+
* as the dead-letter queue.</p>
|
|
946
1069
|
* </li>
|
|
947
1070
|
* <li>
|
|
948
1071
|
* <p>
|
|
949
|
-
* <code>byQueue</code> – Only queues specified by the
|
|
950
|
-
*
|
|
1072
|
+
* <code>byQueue</code> – Only queues specified by the
|
|
1073
|
+
* <code>sourceQueueArns</code> parameter can specify this
|
|
1074
|
+
* queue as the dead-letter queue.</p>
|
|
951
1075
|
* </li>
|
|
952
1076
|
* </ul>
|
|
953
1077
|
* </li>
|
|
954
1078
|
* <li>
|
|
955
1079
|
* <p>
|
|
956
|
-
* <code>sourceQueueArns</code> – The Amazon Resource Names (ARN)s of the
|
|
957
|
-
*
|
|
958
|
-
*
|
|
959
|
-
*
|
|
960
|
-
*
|
|
1080
|
+
* <code>sourceQueueArns</code> – The Amazon Resource Names (ARN)s of the
|
|
1081
|
+
* source queues that can specify this queue as the dead-letter queue and
|
|
1082
|
+
* redrive messages. You can specify this parameter only when the
|
|
1083
|
+
* <code>redrivePermission</code> parameter is set to
|
|
1084
|
+
* <code>byQueue</code>. You can specify up to 10 source queue ARNs. To
|
|
1085
|
+
* allow more than 10 source queues to specify dead-letter queues, set the
|
|
1086
|
+
* <code>redrivePermission</code> parameter to
|
|
1087
|
+
* <code>allowAll</code>.</p>
|
|
961
1088
|
* </li>
|
|
962
1089
|
* </ul>
|
|
963
1090
|
* </li>
|
|
964
1091
|
* </ul>
|
|
965
1092
|
* <note>
|
|
966
|
-
* <p>The dead-letter queue of a
|
|
967
|
-
*
|
|
968
|
-
* queue of a standard queue must also be a standard queue.</p>
|
|
1093
|
+
* <p>The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the
|
|
1094
|
+
* dead-letter queue of a standard queue must also be a standard queue.</p>
|
|
969
1095
|
* </note>
|
|
970
1096
|
* <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>
|
|
971
1097
|
* <ul>
|
|
972
1098
|
* <li>
|
|
973
1099
|
* <p>
|
|
974
|
-
* <code>KmsMasterKeyId</code> – Returns the ID of an Amazon Web Services
|
|
975
|
-
* master key (CMK) for Amazon SQS or a custom CMK. For more
|
|
1100
|
+
* <code>KmsMasterKeyId</code> – Returns the ID of an Amazon Web Services
|
|
1101
|
+
* managed customer master key (CMK) for Amazon SQS or a custom CMK. For more
|
|
1102
|
+
* 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>
|
|
976
1103
|
* </li>
|
|
977
1104
|
* <li>
|
|
978
1105
|
* <p>
|
|
979
|
-
* <code>KmsDataKeyReusePeriodSeconds</code> – Returns the length of time,
|
|
980
|
-
*
|
|
981
|
-
* messages before calling KMS again. For more information, see
|
|
982
|
-
* <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>
|
|
1106
|
+
* <code>KmsDataKeyReusePeriodSeconds</code> – Returns the length of time, in
|
|
1107
|
+
* seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt
|
|
1108
|
+
* messages before calling KMS again. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work">How Does the Data Key Reuse Period Work?</a>. </p>
|
|
983
1109
|
* </li>
|
|
984
1110
|
* <li>
|
|
985
1111
|
* <p>
|
|
986
|
-
* <code>SqsManagedSseEnabled</code> – Returns information about whether the
|
|
987
|
-
*
|
|
1112
|
+
* <code>SqsManagedSseEnabled</code> – Returns information about whether the queue
|
|
1113
|
+
* is using SSE-SQS encryption using SQS owned encryption keys. Only one
|
|
988
1114
|
* 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>
|
|
989
1115
|
* </li>
|
|
990
1116
|
* </ul>
|
|
991
|
-
* <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO
|
|
992
|
-
* queues</a>:</p>
|
|
1117
|
+
* <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO
|
|
1118
|
+
* (first-in-first-out) queues</a>:</p>
|
|
993
1119
|
* <ul>
|
|
994
1120
|
* <li>
|
|
995
1121
|
* <p>
|
|
996
|
-
* <code>FifoQueue</code> – Returns information about whether the queue is
|
|
997
|
-
*
|
|
1122
|
+
* <code>FifoQueue</code> – Returns information about whether the queue is FIFO.
|
|
1123
|
+
* 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
|
|
998
1124
|
* Guide</i>.</p>
|
|
999
1125
|
* <note>
|
|
1000
|
-
* <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
|
+
* <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
|
|
1127
|
+
* the <code>.fifo</code> suffix.</p>
|
|
1001
1128
|
* </note>
|
|
1002
1129
|
* </li>
|
|
1003
1130
|
* <li>
|
|
@@ -1007,20 +1134,22 @@ export interface GetQueueAttributesRequest {
|
|
|
1007
1134
|
* Guide</i>. </p>
|
|
1008
1135
|
* </li>
|
|
1009
1136
|
* </ul>
|
|
1010
|
-
* <p>The following attributes apply only to
|
|
1011
|
-
*
|
|
1012
|
-
* for FIFO queues</a>:</p>
|
|
1137
|
+
* <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html">high
|
|
1138
|
+
* throughput for FIFO queues</a>:</p>
|
|
1013
1139
|
* <ul>
|
|
1014
1140
|
* <li>
|
|
1015
1141
|
* <p>
|
|
1016
|
-
* <code>DeduplicationScope</code> – Specifies whether message deduplication
|
|
1017
|
-
*
|
|
1142
|
+
* <code>DeduplicationScope</code> – Specifies whether message deduplication
|
|
1143
|
+
* occurs at the message group or queue level. Valid values are
|
|
1144
|
+
* <code>messageGroup</code> and <code>queue</code>.</p>
|
|
1018
1145
|
* </li>
|
|
1019
1146
|
* <li>
|
|
1020
1147
|
* <p>
|
|
1021
1148
|
* <code>FifoThroughputLimit</code> – Specifies whether the FIFO queue throughput
|
|
1022
|
-
*
|
|
1023
|
-
*
|
|
1149
|
+
* quota applies to the entire queue or per message group. Valid values are
|
|
1150
|
+
* <code>perQueue</code> and <code>perMessageGroupId</code>. The
|
|
1151
|
+
* <code>perMessageGroupId</code> value is allowed only when the value for
|
|
1152
|
+
* <code>DeduplicationScope</code> is <code>messageGroup</code>.</p>
|
|
1024
1153
|
* </li>
|
|
1025
1154
|
* </ul>
|
|
1026
1155
|
* <p>To enable high throughput for FIFO queues, do the following:</p>
|
|
@@ -1033,10 +1162,10 @@ export interface GetQueueAttributesRequest {
|
|
|
1033
1162
|
* </li>
|
|
1034
1163
|
* </ul>
|
|
1035
1164
|
* <p>If you set these attributes to anything other than the values shown for enabling high
|
|
1036
|
-
*
|
|
1037
|
-
* <p>For information on throughput quotas,
|
|
1038
|
-
*
|
|
1039
|
-
*
|
|
1165
|
+
* throughput, normal throughput is in effect and deduplication occurs as specified.</p>
|
|
1166
|
+
* <p>For information on throughput quotas, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html">Quotas
|
|
1167
|
+
* related to messages</a> in the <i>Amazon SQS Developer
|
|
1168
|
+
* Guide</i>.</p>
|
|
1040
1169
|
*/
|
|
1041
1170
|
AttributeNames?: QueueAttributeName[];
|
|
1042
1171
|
}
|
|
@@ -1051,18 +1180,6 @@ export interface GetQueueAttributesResult {
|
|
|
1051
1180
|
*/
|
|
1052
1181
|
Attributes?: Partial<Record<QueueAttributeName, string>>;
|
|
1053
1182
|
}
|
|
1054
|
-
/**
|
|
1055
|
-
* @public
|
|
1056
|
-
* <p>The specified attribute doesn't exist.</p>
|
|
1057
|
-
*/
|
|
1058
|
-
export declare class InvalidAttributeName extends __BaseException {
|
|
1059
|
-
readonly name: "InvalidAttributeName";
|
|
1060
|
-
readonly $fault: "client";
|
|
1061
|
-
/**
|
|
1062
|
-
* @internal
|
|
1063
|
-
*/
|
|
1064
|
-
constructor(opts: __ExceptionOptionType<InvalidAttributeName, __BaseException>);
|
|
1065
|
-
}
|
|
1066
1183
|
/**
|
|
1067
1184
|
* @public
|
|
1068
1185
|
* <p></p>
|
|
@@ -1078,14 +1195,15 @@ export interface GetQueueUrlRequest {
|
|
|
1078
1195
|
QueueName: string | undefined;
|
|
1079
1196
|
/**
|
|
1080
1197
|
* @public
|
|
1081
|
-
* <p>The Amazon Web
|
|
1198
|
+
* <p>The Amazon Web
|
|
1199
|
+
* Services account ID of the account that created the queue.</p>
|
|
1082
1200
|
*/
|
|
1083
1201
|
QueueOwnerAWSAccountId?: string;
|
|
1084
1202
|
}
|
|
1085
1203
|
/**
|
|
1086
1204
|
* @public
|
|
1087
1205
|
* <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
|
|
1088
|
-
*
|
|
1206
|
+
* Guide</i>.</p>
|
|
1089
1207
|
*/
|
|
1090
1208
|
export interface GetQueueUrlResult {
|
|
1091
1209
|
/**
|
|
@@ -1094,18 +1212,6 @@ export interface GetQueueUrlResult {
|
|
|
1094
1212
|
*/
|
|
1095
1213
|
QueueUrl?: string;
|
|
1096
1214
|
}
|
|
1097
|
-
/**
|
|
1098
|
-
* @public
|
|
1099
|
-
* <p>The specified queue doesn't exist.</p>
|
|
1100
|
-
*/
|
|
1101
|
-
export declare class QueueDoesNotExist extends __BaseException {
|
|
1102
|
-
readonly name: "QueueDoesNotExist";
|
|
1103
|
-
readonly $fault: "client";
|
|
1104
|
-
/**
|
|
1105
|
-
* @internal
|
|
1106
|
-
*/
|
|
1107
|
-
constructor(opts: __ExceptionOptionType<QueueDoesNotExist, __BaseException>);
|
|
1108
|
-
}
|
|
1109
1215
|
/**
|
|
1110
1216
|
* @public
|
|
1111
1217
|
* <p></p>
|
|
@@ -1266,6 +1372,12 @@ export interface ListQueuesRequest {
|
|
|
1266
1372
|
* <p>A list of your queues.</p>
|
|
1267
1373
|
*/
|
|
1268
1374
|
export interface ListQueuesResult {
|
|
1375
|
+
/**
|
|
1376
|
+
* @public
|
|
1377
|
+
* <p>A list of queue URLs, up to 1,000 entries, or the value of <code>MaxResults</code>
|
|
1378
|
+
* that you sent in the request.</p>
|
|
1379
|
+
*/
|
|
1380
|
+
QueueUrls?: string[];
|
|
1269
1381
|
/**
|
|
1270
1382
|
* @public
|
|
1271
1383
|
* <p>Pagination token to include in the next request. Token value is <code>null</code> if
|
|
@@ -1273,12 +1385,6 @@ export interface ListQueuesResult {
|
|
|
1273
1385
|
* <code>MaxResults</code> in the request.</p>
|
|
1274
1386
|
*/
|
|
1275
1387
|
NextToken?: string;
|
|
1276
|
-
/**
|
|
1277
|
-
* @public
|
|
1278
|
-
* <p>A list of queue URLs, up to 1,000 entries, or the value of <code>MaxResults</code>
|
|
1279
|
-
* that you sent in the request.</p>
|
|
1280
|
-
*/
|
|
1281
|
-
QueueUrls?: string[];
|
|
1282
1388
|
}
|
|
1283
1389
|
/**
|
|
1284
1390
|
* @public
|
|
@@ -1327,6 +1433,103 @@ export interface PurgeQueueRequest {
|
|
|
1327
1433
|
*/
|
|
1328
1434
|
QueueUrl: string | undefined;
|
|
1329
1435
|
}
|
|
1436
|
+
/**
|
|
1437
|
+
* @public
|
|
1438
|
+
* <p>The caller doesn't have the required KMS access.</p>
|
|
1439
|
+
*/
|
|
1440
|
+
export declare class KmsAccessDenied extends __BaseException {
|
|
1441
|
+
readonly name: "KmsAccessDenied";
|
|
1442
|
+
readonly $fault: "client";
|
|
1443
|
+
/**
|
|
1444
|
+
* @internal
|
|
1445
|
+
*/
|
|
1446
|
+
constructor(opts: __ExceptionOptionType<KmsAccessDenied, __BaseException>);
|
|
1447
|
+
}
|
|
1448
|
+
/**
|
|
1449
|
+
* @public
|
|
1450
|
+
* <p>The request was denied due to request throttling.</p>
|
|
1451
|
+
*/
|
|
1452
|
+
export declare class KmsDisabled extends __BaseException {
|
|
1453
|
+
readonly name: "KmsDisabled";
|
|
1454
|
+
readonly $fault: "client";
|
|
1455
|
+
/**
|
|
1456
|
+
* @internal
|
|
1457
|
+
*/
|
|
1458
|
+
constructor(opts: __ExceptionOptionType<KmsDisabled, __BaseException>);
|
|
1459
|
+
}
|
|
1460
|
+
/**
|
|
1461
|
+
* @public
|
|
1462
|
+
* <p>The request was rejected for one of the following reasons:</p>
|
|
1463
|
+
* <ul>
|
|
1464
|
+
* <li>
|
|
1465
|
+
* <p>The KeyUsage value of the KMS key is incompatible with the API
|
|
1466
|
+
* operation.</p>
|
|
1467
|
+
* </li>
|
|
1468
|
+
* <li>
|
|
1469
|
+
* <p>The encryption algorithm or signing algorithm specified for the operation is
|
|
1470
|
+
* incompatible with the type of key material in the KMS key (KeySpec).</p>
|
|
1471
|
+
* </li>
|
|
1472
|
+
* </ul>
|
|
1473
|
+
*/
|
|
1474
|
+
export declare class KmsInvalidKeyUsage extends __BaseException {
|
|
1475
|
+
readonly name: "KmsInvalidKeyUsage";
|
|
1476
|
+
readonly $fault: "client";
|
|
1477
|
+
/**
|
|
1478
|
+
* @internal
|
|
1479
|
+
*/
|
|
1480
|
+
constructor(opts: __ExceptionOptionType<KmsInvalidKeyUsage, __BaseException>);
|
|
1481
|
+
}
|
|
1482
|
+
/**
|
|
1483
|
+
* @public
|
|
1484
|
+
* <p>The request was rejected because the state of the specified resource is not valid for
|
|
1485
|
+
* this request.</p>
|
|
1486
|
+
*/
|
|
1487
|
+
export declare class KmsInvalidState extends __BaseException {
|
|
1488
|
+
readonly name: "KmsInvalidState";
|
|
1489
|
+
readonly $fault: "client";
|
|
1490
|
+
/**
|
|
1491
|
+
* @internal
|
|
1492
|
+
*/
|
|
1493
|
+
constructor(opts: __ExceptionOptionType<KmsInvalidState, __BaseException>);
|
|
1494
|
+
}
|
|
1495
|
+
/**
|
|
1496
|
+
* @public
|
|
1497
|
+
* <p>The request was rejected because the specified entity or resource could not be found.
|
|
1498
|
+
* </p>
|
|
1499
|
+
*/
|
|
1500
|
+
export declare class KmsNotFound extends __BaseException {
|
|
1501
|
+
readonly name: "KmsNotFound";
|
|
1502
|
+
readonly $fault: "client";
|
|
1503
|
+
/**
|
|
1504
|
+
* @internal
|
|
1505
|
+
*/
|
|
1506
|
+
constructor(opts: __ExceptionOptionType<KmsNotFound, __BaseException>);
|
|
1507
|
+
}
|
|
1508
|
+
/**
|
|
1509
|
+
* @public
|
|
1510
|
+
* <p>The request was rejected because the specified key policy isn't syntactically or
|
|
1511
|
+
* semantically correct.</p>
|
|
1512
|
+
*/
|
|
1513
|
+
export declare class KmsOptInRequired extends __BaseException {
|
|
1514
|
+
readonly name: "KmsOptInRequired";
|
|
1515
|
+
readonly $fault: "client";
|
|
1516
|
+
/**
|
|
1517
|
+
* @internal
|
|
1518
|
+
*/
|
|
1519
|
+
constructor(opts: __ExceptionOptionType<KmsOptInRequired, __BaseException>);
|
|
1520
|
+
}
|
|
1521
|
+
/**
|
|
1522
|
+
* @public
|
|
1523
|
+
* <p>Amazon Web Services KMS throttles requests for the following conditions.</p>
|
|
1524
|
+
*/
|
|
1525
|
+
export declare class KmsThrottled extends __BaseException {
|
|
1526
|
+
readonly name: "KmsThrottled";
|
|
1527
|
+
readonly $fault: "client";
|
|
1528
|
+
/**
|
|
1529
|
+
* @internal
|
|
1530
|
+
*/
|
|
1531
|
+
constructor(opts: __ExceptionOptionType<KmsThrottled, __BaseException>);
|
|
1532
|
+
}
|
|
1330
1533
|
/**
|
|
1331
1534
|
* @public
|
|
1332
1535
|
* <p></p>
|
|
@@ -1349,19 +1552,19 @@ export interface ReceiveMessageRequest {
|
|
|
1349
1552
|
* </li>
|
|
1350
1553
|
* <li>
|
|
1351
1554
|
* <p>
|
|
1352
|
-
* <code>ApproximateFirstReceiveTimestamp</code> – Returns the time the
|
|
1353
|
-
*
|
|
1555
|
+
* <code>ApproximateFirstReceiveTimestamp</code> – Returns the time the message was
|
|
1556
|
+
* first received from the queue (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a> in
|
|
1354
1557
|
* milliseconds).</p>
|
|
1355
1558
|
* </li>
|
|
1356
1559
|
* <li>
|
|
1357
1560
|
* <p>
|
|
1358
|
-
* <code>ApproximateReceiveCount</code> – Returns the number of times a
|
|
1359
|
-
*
|
|
1561
|
+
* <code>ApproximateReceiveCount</code> – Returns the number of times a message has
|
|
1562
|
+
* been received across all queues but not deleted.</p>
|
|
1360
1563
|
* </li>
|
|
1361
1564
|
* <li>
|
|
1362
1565
|
* <p>
|
|
1363
|
-
* <code>AWSTraceHeader</code> – Returns the X-Ray trace
|
|
1364
|
-
*
|
|
1566
|
+
* <code>AWSTraceHeader</code> – Returns the X-Ray trace header
|
|
1567
|
+
* string. </p>
|
|
1365
1568
|
* </li>
|
|
1366
1569
|
* <li>
|
|
1367
1570
|
* <p>
|
|
@@ -1380,15 +1583,15 @@ export interface ReceiveMessageRequest {
|
|
|
1380
1583
|
* </li>
|
|
1381
1584
|
* <li>
|
|
1382
1585
|
* <p>
|
|
1383
|
-
* <code>SentTimestamp</code> – Returns the time the message was sent to the
|
|
1384
|
-
*
|
|
1586
|
+
* <code>SentTimestamp</code> – Returns the time the message was sent to the queue
|
|
1587
|
+
* (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a> in
|
|
1385
1588
|
* milliseconds).</p>
|
|
1386
1589
|
* </li>
|
|
1387
1590
|
* <li>
|
|
1388
1591
|
* <p>
|
|
1389
|
-
* <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption
|
|
1390
|
-
*
|
|
1391
|
-
*
|
|
1592
|
+
* <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption using
|
|
1593
|
+
* SQS owned encryption keys. Only one server-side encryption option is supported
|
|
1594
|
+
* 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>
|
|
1392
1595
|
* </li>
|
|
1393
1596
|
* <li>
|
|
1394
1597
|
* <p>
|
|
@@ -1400,17 +1603,15 @@ export interface ReceiveMessageRequest {
|
|
|
1400
1603
|
* </li>
|
|
1401
1604
|
* <li>
|
|
1402
1605
|
* <p>
|
|
1403
|
-
* <code>MessageGroupId</code> – Returns the value provided by the
|
|
1404
|
-
*
|
|
1606
|
+
* <code>MessageGroupId</code> – Returns the value provided by the producer that
|
|
1607
|
+
* calls the <code>
|
|
1405
1608
|
* <a>SendMessage</a>
|
|
1406
|
-
* </code> action.
|
|
1407
|
-
*
|
|
1408
|
-
* sequence.</p>
|
|
1609
|
+
* </code> action. Messages with the
|
|
1610
|
+
* same <code>MessageGroupId</code> are returned in sequence.</p>
|
|
1409
1611
|
* </li>
|
|
1410
1612
|
* <li>
|
|
1411
1613
|
* <p>
|
|
1412
|
-
* <code>SequenceNumber</code> – Returns the value provided by
|
|
1413
|
-
* Amazon SQS.</p>
|
|
1614
|
+
* <code>SequenceNumber</code> – Returns the value provided by Amazon SQS.</p>
|
|
1414
1615
|
* </li>
|
|
1415
1616
|
* </ul>
|
|
1416
1617
|
*/
|
|
@@ -1448,8 +1649,8 @@ export interface ReceiveMessageRequest {
|
|
|
1448
1649
|
MessageAttributeNames?: string[];
|
|
1449
1650
|
/**
|
|
1450
1651
|
* @public
|
|
1451
|
-
* <p>The maximum number of messages to return. Amazon SQS never returns more messages than
|
|
1452
|
-
* value (however, fewer messages might be returned). Valid values: 1 to 10. Default:
|
|
1652
|
+
* <p>The maximum number of messages to return. Amazon SQS never returns more messages than
|
|
1653
|
+
* this value (however, fewer messages might be returned). Valid values: 1 to 10. Default:
|
|
1453
1654
|
* 1.</p>
|
|
1454
1655
|
*/
|
|
1455
1656
|
MaxNumberOfMessages?: number;
|
|
@@ -1536,8 +1737,8 @@ export interface ReceiveMessageRequest {
|
|
|
1536
1737
|
* <code>ReceiveRequestAttemptId</code> can contain alphanumeric characters
|
|
1537
1738
|
* (<code>a-z</code>, <code>A-Z</code>, <code>0-9</code>) and punctuation
|
|
1538
1739
|
* (<code>!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~</code>).</p>
|
|
1539
|
-
* <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
|
|
1540
|
-
* Developer Guide</i>.</p>
|
|
1740
|
+
* <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
|
|
1741
|
+
* SQS Developer Guide</i>.</p>
|
|
1541
1742
|
*/
|
|
1542
1743
|
ReceiveRequestAttemptId?: string;
|
|
1543
1744
|
}
|
|
@@ -1602,7 +1803,7 @@ export interface MessageAttributeValue {
|
|
|
1602
1803
|
* <code>Number</code>, and <code>Binary</code>. For the <code>Number</code> data type,
|
|
1603
1804
|
* you must use <code>StringValue</code>.</p>
|
|
1604
1805
|
* <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
|
|
1605
|
-
*
|
|
1806
|
+
* Guide</i>.</p>
|
|
1606
1807
|
*/
|
|
1607
1808
|
DataType: string | undefined;
|
|
1608
1809
|
}
|
|
@@ -1685,15 +1886,17 @@ export interface Message {
|
|
|
1685
1886
|
Attributes?: Partial<Record<MessageSystemAttributeName, string>>;
|
|
1686
1887
|
/**
|
|
1687
1888
|
* @public
|
|
1688
|
-
* <p>An MD5 digest of the non-URL-encoded message attribute string. You can use this
|
|
1889
|
+
* <p>An MD5 digest of the non-URL-encoded message attribute string. You can use this
|
|
1890
|
+
* attribute to verify that Amazon SQS received the message correctly. Amazon SQS
|
|
1891
|
+
* URL-decodes the message before creating the MD5 digest. For information about MD5, see
|
|
1892
|
+
* <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
|
|
1689
1893
|
*/
|
|
1690
1894
|
MD5OfMessageAttributes?: string;
|
|
1691
1895
|
/**
|
|
1692
1896
|
* @public
|
|
1693
|
-
* <p>Each message attribute consists of a <code>Name</code>, <code>Type</code>,
|
|
1694
|
-
*
|
|
1695
|
-
*
|
|
1696
|
-
* message attributes</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
1897
|
+
* <p>Each message attribute consists of a <code>Name</code>, <code>Type</code>, and
|
|
1898
|
+
* <code>Value</code>. 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
|
|
1899
|
+
* Guide</i>.</p>
|
|
1697
1900
|
*/
|
|
1698
1901
|
MessageAttributes?: Record<string, MessageAttributeValue>;
|
|
1699
1902
|
}
|
|
@@ -1791,7 +1994,7 @@ export interface MessageSystemAttributeValue {
|
|
|
1791
1994
|
* <code>Number</code>, and <code>Binary</code>. For the <code>Number</code> data type,
|
|
1792
1995
|
* you must use <code>StringValue</code>.</p>
|
|
1793
1996
|
* <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
|
|
1794
|
-
*
|
|
1997
|
+
* Guide</i>.</p>
|
|
1795
1998
|
*/
|
|
1796
1999
|
DataType: string | undefined;
|
|
1797
2000
|
}
|
|
@@ -1811,11 +2014,16 @@ export interface SendMessageRequest {
|
|
|
1811
2014
|
* <p>The message to send. The minimum size is one character. The maximum size is 256
|
|
1812
2015
|
* KiB.</p>
|
|
1813
2016
|
* <important>
|
|
1814
|
-
* <p>A message can include only XML, JSON, and unformatted text. The following Unicode
|
|
2017
|
+
* <p>A message can include only XML, JSON, and unformatted text. The following Unicode
|
|
2018
|
+
* characters are allowed:</p>
|
|
1815
2019
|
* <p>
|
|
1816
|
-
* <code>#x9</code> | <code>#xA</code> | <code>#xD</code> | <code>#x20</code> to
|
|
2020
|
+
* <code>#x9</code> | <code>#xA</code> | <code>#xD</code> | <code>#x20</code> to
|
|
2021
|
+
* <code>#xD7FF</code> | <code>#xE000</code> to <code>#xFFFD</code> |
|
|
2022
|
+
* <code>#x10000</code> to <code>#x10FFFF</code>
|
|
1817
2023
|
* </p>
|
|
1818
|
-
* <p>Any characters not included in this list will be rejected. For more information,
|
|
2024
|
+
* <p>Any characters not included in this list will be rejected. For more information,
|
|
2025
|
+
* see the <a href="http://www.w3.org/TR/REC-xml/#charsets">W3C specification for
|
|
2026
|
+
* characters</a>.</p>
|
|
1819
2027
|
* </important>
|
|
1820
2028
|
*/
|
|
1821
2029
|
MessageBody: string | undefined;
|
|
@@ -1826,30 +2034,33 @@ export interface SendMessageRequest {
|
|
|
1826
2034
|
* become available for processing after the delay period is finished. If you don't specify
|
|
1827
2035
|
* a value, the default value for the queue applies. </p>
|
|
1828
2036
|
* <note>
|
|
1829
|
-
* <p>When you set <code>FifoQueue</code>, you can't set <code>DelaySeconds</code> per
|
|
2037
|
+
* <p>When you set <code>FifoQueue</code>, you can't set <code>DelaySeconds</code> per
|
|
2038
|
+
* message. You can set this parameter only on a queue level.</p>
|
|
1830
2039
|
* </note>
|
|
1831
2040
|
*/
|
|
1832
2041
|
DelaySeconds?: number;
|
|
1833
2042
|
/**
|
|
1834
2043
|
* @public
|
|
1835
|
-
* <p>Each message attribute consists of a <code>Name</code>, <code>Type</code>,
|
|
1836
|
-
*
|
|
1837
|
-
*
|
|
1838
|
-
* message attributes</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
2044
|
+
* <p>Each message attribute consists of a <code>Name</code>, <code>Type</code>, and
|
|
2045
|
+
* <code>Value</code>. 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
|
|
2046
|
+
* Guide</i>.</p>
|
|
1839
2047
|
*/
|
|
1840
2048
|
MessageAttributes?: Record<string, MessageAttributeValue>;
|
|
1841
2049
|
/**
|
|
1842
2050
|
* @public
|
|
1843
|
-
* <p>The message system attribute to send. Each message system attribute consists of a
|
|
2051
|
+
* <p>The message system attribute to send. Each message system attribute consists of a
|
|
2052
|
+
* <code>Name</code>, <code>Type</code>, and <code>Value</code>.</p>
|
|
1844
2053
|
* <important>
|
|
1845
2054
|
* <ul>
|
|
1846
2055
|
* <li>
|
|
1847
|
-
* <p>Currently, the only supported message system attribute is
|
|
1848
|
-
*
|
|
1849
|
-
*
|
|
2056
|
+
* <p>Currently, the only supported message system attribute is
|
|
2057
|
+
* <code>AWSTraceHeader</code>. Its type must be <code>String</code> and
|
|
2058
|
+
* its value must be a correctly formatted X-Ray trace
|
|
2059
|
+
* header string.</p>
|
|
1850
2060
|
* </li>
|
|
1851
2061
|
* <li>
|
|
1852
|
-
* <p>The size of a message system attribute doesn't count towards the total
|
|
2062
|
+
* <p>The size of a message system attribute doesn't count towards the total
|
|
2063
|
+
* size of a message.</p>
|
|
1853
2064
|
* </li>
|
|
1854
2065
|
* </ul>
|
|
1855
2066
|
* </important>
|
|
@@ -1862,7 +2073,7 @@ export interface SendMessageRequest {
|
|
|
1862
2073
|
* <code>MessageDeduplicationId</code> is sent successfully, any messages sent with the
|
|
1863
2074
|
* same <code>MessageDeduplicationId</code> are accepted successfully but aren't delivered
|
|
1864
2075
|
* 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
|
|
1865
|
-
*
|
|
2076
|
+
* Guide</i>.</p>
|
|
1866
2077
|
* <ul>
|
|
1867
2078
|
* <li>
|
|
1868
2079
|
* <p>Every message must have a unique <code>MessageDeduplicationId</code>,</p>
|
|
@@ -1909,24 +2120,25 @@ export interface SendMessageRequest {
|
|
|
1909
2120
|
* <p>If a message is sent successfully but the acknowledgement is lost and the message
|
|
1910
2121
|
* is resent with the same <code>MessageDeduplicationId</code> after the deduplication
|
|
1911
2122
|
* interval, Amazon SQS can't detect duplicate messages.</p>
|
|
1912
|
-
* <p>Amazon SQS continues to keep track of the message deduplication ID even after the
|
|
2123
|
+
* <p>Amazon SQS continues to keep track of the message deduplication ID even after the
|
|
2124
|
+
* message is received and deleted.</p>
|
|
1913
2125
|
* </note>
|
|
1914
2126
|
* <p>The maximum length of <code>MessageDeduplicationId</code> is 128 characters.
|
|
1915
2127
|
* <code>MessageDeduplicationId</code> can contain alphanumeric characters
|
|
1916
2128
|
* (<code>a-z</code>, <code>A-Z</code>, <code>0-9</code>) and punctuation
|
|
1917
2129
|
* (<code>!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~</code>).</p>
|
|
1918
|
-
* <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
|
|
1919
|
-
* Guide</i>.</p>
|
|
2130
|
+
* <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
|
|
2131
|
+
* Developer Guide</i>.</p>
|
|
1920
2132
|
*/
|
|
1921
2133
|
MessageDeduplicationId?: string;
|
|
1922
2134
|
/**
|
|
1923
2135
|
* @public
|
|
1924
2136
|
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
|
|
1925
2137
|
* <p>The tag that specifies that a message belongs to a specific message group. Messages
|
|
1926
|
-
* that belong to the same message group are processed in a FIFO manner (however,
|
|
1927
|
-
*
|
|
1928
|
-
*
|
|
1929
|
-
*
|
|
2138
|
+
* that belong to the same message group are processed in a FIFO manner (however, messages
|
|
2139
|
+
* in different message groups might be processed out of order). To interleave multiple
|
|
2140
|
+
* ordered streams within a single queue, use <code>MessageGroupId</code> values (for
|
|
2141
|
+
* example, session data for multiple users). In this scenario, multiple consumers can
|
|
1930
2142
|
* process the queue, but the session data of each user is processed in a FIFO
|
|
1931
2143
|
* fashion.</p>
|
|
1932
2144
|
* <ul>
|
|
@@ -1962,18 +2174,24 @@ export interface SendMessageRequest {
|
|
|
1962
2174
|
export interface SendMessageResult {
|
|
1963
2175
|
/**
|
|
1964
2176
|
* @public
|
|
1965
|
-
* <p>An MD5 digest of the non-URL-encoded message body string. You can use this attribute
|
|
2177
|
+
* <p>An MD5 digest of the non-URL-encoded message body string. You can use this attribute
|
|
2178
|
+
* to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the
|
|
2179
|
+
* message before creating the MD5 digest. For information about MD5, see <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
|
|
1966
2180
|
*/
|
|
1967
2181
|
MD5OfMessageBody?: string;
|
|
1968
2182
|
/**
|
|
1969
2183
|
* @public
|
|
1970
|
-
* <p>An MD5 digest of the non-URL-encoded message attribute string. You can use this
|
|
2184
|
+
* <p>An MD5 digest of the non-URL-encoded message attribute string. You can use this
|
|
2185
|
+
* attribute to verify that Amazon SQS received the message correctly. Amazon SQS
|
|
2186
|
+
* URL-decodes the message before creating the MD5 digest. For information about MD5, see
|
|
2187
|
+
* <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
|
|
1971
2188
|
*/
|
|
1972
2189
|
MD5OfMessageAttributes?: string;
|
|
1973
2190
|
/**
|
|
1974
2191
|
* @public
|
|
1975
2192
|
* <p>An MD5 digest of the non-URL-encoded message system attribute string. You can use this
|
|
1976
|
-
*
|
|
2193
|
+
* attribute to verify that Amazon SQS received the message correctly. Amazon SQS
|
|
2194
|
+
* URL-decodes the message before creating the MD5 digest.</p>
|
|
1977
2195
|
*/
|
|
1978
2196
|
MD5OfMessageSystemAttributes?: string;
|
|
1979
2197
|
/**
|
|
@@ -2006,7 +2224,8 @@ export declare class BatchRequestTooLong extends __BaseException {
|
|
|
2006
2224
|
}
|
|
2007
2225
|
/**
|
|
2008
2226
|
* @public
|
|
2009
|
-
* <p>Contains the details of a single Amazon SQS message along with an
|
|
2227
|
+
* <p>Contains the details of a single Amazon SQS message along with an
|
|
2228
|
+
* <code>Id</code>.</p>
|
|
2010
2229
|
*/
|
|
2011
2230
|
export interface SendMessageBatchRequestEntry {
|
|
2012
2231
|
/**
|
|
@@ -2014,7 +2233,8 @@ export interface SendMessageBatchRequestEntry {
|
|
|
2014
2233
|
* <p>An identifier for a message in this batch used to communicate the result.</p>
|
|
2015
2234
|
* <note>
|
|
2016
2235
|
* <p>The <code>Id</code>s of a batch request need to be unique within a request.</p>
|
|
2017
|
-
* <p>This identifier can have up to 80 characters. The following characters are
|
|
2236
|
+
* <p>This identifier can have up to 80 characters. The following characters are
|
|
2237
|
+
* accepted: alphanumeric characters, hyphens(-), and underscores (_).</p>
|
|
2018
2238
|
* </note>
|
|
2019
2239
|
*/
|
|
2020
2240
|
Id: string | undefined;
|
|
@@ -2030,30 +2250,33 @@ export interface SendMessageBatchRequestEntry {
|
|
|
2030
2250
|
* become available for processing after the delay period is finished. If you don't specify
|
|
2031
2251
|
* a value, the default value for the queue is applied. </p>
|
|
2032
2252
|
* <note>
|
|
2033
|
-
* <p>When you set <code>FifoQueue</code>, you can't set <code>DelaySeconds</code> per
|
|
2253
|
+
* <p>When you set <code>FifoQueue</code>, you can't set <code>DelaySeconds</code> per
|
|
2254
|
+
* message. You can set this parameter only on a queue level.</p>
|
|
2034
2255
|
* </note>
|
|
2035
2256
|
*/
|
|
2036
2257
|
DelaySeconds?: number;
|
|
2037
2258
|
/**
|
|
2038
2259
|
* @public
|
|
2039
|
-
* <p>Each message attribute consists of a <code>Name</code>, <code>Type</code>,
|
|
2040
|
-
*
|
|
2041
|
-
*
|
|
2042
|
-
* message attributes</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
2260
|
+
* <p>Each message attribute consists of a <code>Name</code>, <code>Type</code>, and
|
|
2261
|
+
* <code>Value</code>. 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
|
|
2262
|
+
* Guide</i>.</p>
|
|
2043
2263
|
*/
|
|
2044
2264
|
MessageAttributes?: Record<string, MessageAttributeValue>;
|
|
2045
2265
|
/**
|
|
2046
2266
|
* @public
|
|
2047
|
-
* <p>The message system attribute to send Each message system attribute consists of a
|
|
2267
|
+
* <p>The message system attribute to send Each message system attribute consists of a
|
|
2268
|
+
* <code>Name</code>, <code>Type</code>, and <code>Value</code>.</p>
|
|
2048
2269
|
* <important>
|
|
2049
2270
|
* <ul>
|
|
2050
2271
|
* <li>
|
|
2051
|
-
* <p>Currently, the only supported message system attribute is
|
|
2052
|
-
*
|
|
2053
|
-
*
|
|
2272
|
+
* <p>Currently, the only supported message system attribute is
|
|
2273
|
+
* <code>AWSTraceHeader</code>. Its type must be <code>String</code> and
|
|
2274
|
+
* its value must be a correctly formatted X-Ray trace
|
|
2275
|
+
* header string.</p>
|
|
2054
2276
|
* </li>
|
|
2055
2277
|
* <li>
|
|
2056
|
-
* <p>The size of a message system attribute doesn't count towards the total
|
|
2278
|
+
* <p>The size of a message system attribute doesn't count towards the total
|
|
2279
|
+
* size of a message.</p>
|
|
2057
2280
|
* </li>
|
|
2058
2281
|
* </ul>
|
|
2059
2282
|
* </important>
|
|
@@ -2066,7 +2289,7 @@ export interface SendMessageBatchRequestEntry {
|
|
|
2066
2289
|
* interval. If a message with a particular <code>MessageDeduplicationId</code> is sent
|
|
2067
2290
|
* successfully, subsequent messages with the same <code>MessageDeduplicationId</code> are
|
|
2068
2291
|
* 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
|
|
2069
|
-
*
|
|
2292
|
+
* Guide</i>.</p>
|
|
2070
2293
|
* <ul>
|
|
2071
2294
|
* <li>
|
|
2072
2295
|
* <p>Every message must have a unique <code>MessageDeduplicationId</code>,</p>
|
|
@@ -2113,24 +2336,25 @@ export interface SendMessageBatchRequestEntry {
|
|
|
2113
2336
|
* <p>If a message is sent successfully but the acknowledgement is lost and the message
|
|
2114
2337
|
* is resent with the same <code>MessageDeduplicationId</code> after the deduplication
|
|
2115
2338
|
* interval, Amazon SQS can't detect duplicate messages.</p>
|
|
2116
|
-
* <p>Amazon SQS continues to keep track of the message deduplication ID even after the
|
|
2339
|
+
* <p>Amazon SQS continues to keep track of the message deduplication ID even after the
|
|
2340
|
+
* message is received and deleted.</p>
|
|
2117
2341
|
* </note>
|
|
2118
2342
|
* <p>The length of <code>MessageDeduplicationId</code> is 128 characters.
|
|
2119
2343
|
* <code>MessageDeduplicationId</code> can contain alphanumeric characters
|
|
2120
2344
|
* (<code>a-z</code>, <code>A-Z</code>, <code>0-9</code>) and punctuation
|
|
2121
2345
|
* (<code>!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~</code>).</p>
|
|
2122
|
-
* <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
|
|
2123
|
-
* Guide</i>.</p>
|
|
2346
|
+
* <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
|
|
2347
|
+
* Developer Guide</i>.</p>
|
|
2124
2348
|
*/
|
|
2125
2349
|
MessageDeduplicationId?: string;
|
|
2126
2350
|
/**
|
|
2127
2351
|
* @public
|
|
2128
2352
|
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
|
|
2129
2353
|
* <p>The tag that specifies that a message belongs to a specific message group. Messages
|
|
2130
|
-
* that belong to the same message group are processed in a FIFO manner (however,
|
|
2131
|
-
*
|
|
2132
|
-
*
|
|
2133
|
-
*
|
|
2354
|
+
* that belong to the same message group are processed in a FIFO manner (however, messages
|
|
2355
|
+
* in different message groups might be processed out of order). To interleave multiple
|
|
2356
|
+
* ordered streams within a single queue, use <code>MessageGroupId</code> values (for
|
|
2357
|
+
* example, session data for multiple users). In this scenario, multiple consumers can
|
|
2134
2358
|
* process the queue, but the session data of each user is processed in a FIFO
|
|
2135
2359
|
* fashion.</p>
|
|
2136
2360
|
* <ul>
|
|
@@ -2197,18 +2421,25 @@ export interface SendMessageBatchResultEntry {
|
|
|
2197
2421
|
MessageId: string | undefined;
|
|
2198
2422
|
/**
|
|
2199
2423
|
* @public
|
|
2200
|
-
* <p>An MD5 digest of the non-URL-encoded message body string. You can use this attribute
|
|
2424
|
+
* <p>An MD5 digest of the non-URL-encoded message body string. You can use this attribute
|
|
2425
|
+
* to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the
|
|
2426
|
+
* message before creating the MD5 digest. For information about MD5, see <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
|
|
2201
2427
|
*/
|
|
2202
2428
|
MD5OfMessageBody: string | undefined;
|
|
2203
2429
|
/**
|
|
2204
2430
|
* @public
|
|
2205
|
-
* <p>An MD5 digest of the non-URL-encoded message attribute string. You can use this
|
|
2431
|
+
* <p>An MD5 digest of the non-URL-encoded message attribute string. You can use this
|
|
2432
|
+
* attribute to verify that Amazon SQS received the message correctly. Amazon SQS
|
|
2433
|
+
* URL-decodes the message before creating the MD5 digest. For information about MD5, see
|
|
2434
|
+
* <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
|
|
2206
2435
|
*/
|
|
2207
2436
|
MD5OfMessageAttributes?: string;
|
|
2208
2437
|
/**
|
|
2209
2438
|
* @public
|
|
2210
2439
|
* <p>An MD5 digest of the non-URL-encoded message system attribute string. You can use this
|
|
2211
|
-
*
|
|
2440
|
+
* attribute to verify that Amazon SQS received the message correctly. Amazon SQS
|
|
2441
|
+
* URL-decodes the message before creating the MD5 digest. For information about MD5, see
|
|
2442
|
+
* <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
|
|
2212
2443
|
*/
|
|
2213
2444
|
MD5OfMessageSystemAttributes?: string;
|
|
2214
2445
|
/**
|
|
@@ -2272,37 +2503,36 @@ export interface SetQueueAttributesRequest {
|
|
|
2272
2503
|
* </li>
|
|
2273
2504
|
* <li>
|
|
2274
2505
|
* <p>
|
|
2275
|
-
* <code>MaximumMessageSize</code> – The limit of how many bytes a message
|
|
2276
|
-
*
|
|
2506
|
+
* <code>MaximumMessageSize</code> – The limit of how many bytes a message can
|
|
2507
|
+
* contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes
|
|
2277
2508
|
* (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). </p>
|
|
2278
2509
|
* </li>
|
|
2279
2510
|
* <li>
|
|
2280
2511
|
* <p>
|
|
2281
|
-
* <code>MessageRetentionPeriod</code> – The length of time, in seconds, for
|
|
2282
|
-
*
|
|
2512
|
+
* <code>MessageRetentionPeriod</code> – The length of time, in seconds, for which
|
|
2513
|
+
* Amazon SQS retains a message. Valid values: An integer representing seconds,
|
|
2283
2514
|
* from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days). When you
|
|
2284
2515
|
* change a queue's attributes, the change can take up to 60 seconds for most of
|
|
2285
|
-
* the attributes to propagate throughout the Amazon SQS system. Changes made to
|
|
2286
|
-
*
|
|
2516
|
+
* the attributes to propagate throughout the Amazon SQS system. Changes made to
|
|
2517
|
+
* the <code>MessageRetentionPeriod</code> attribute can take up to 15 minutes and
|
|
2287
2518
|
* will impact existing messages in the queue potentially causing them to be
|
|
2288
2519
|
* expired and deleted if the <code>MessageRetentionPeriod</code> is reduced below
|
|
2289
2520
|
* the age of existing messages.</p>
|
|
2290
2521
|
* </li>
|
|
2291
2522
|
* <li>
|
|
2292
2523
|
* <p>
|
|
2293
|
-
* <code>Policy</code> – The queue's policy. A valid Amazon Web Services
|
|
2294
|
-
* information about policy structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview of Amazon Web Services IAM
|
|
2295
|
-
*
|
|
2296
|
-
*
|
|
2524
|
+
* <code>Policy</code> – The queue's policy. A valid Amazon Web Services
|
|
2525
|
+
* policy. For more information about policy structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview of Amazon Web Services IAM Policies</a> in the
|
|
2526
|
+
* <i>Identity and Access Management User Guide</i>.
|
|
2527
|
+
* </p>
|
|
2297
2528
|
* </li>
|
|
2298
2529
|
* <li>
|
|
2299
2530
|
* <p>
|
|
2300
|
-
* <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in
|
|
2301
|
-
*
|
|
2531
|
+
* <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in seconds, for
|
|
2532
|
+
* which a <code>
|
|
2302
2533
|
* <a>ReceiveMessage</a>
|
|
2303
|
-
* </code> action waits
|
|
2304
|
-
*
|
|
2305
|
-
* Default: 0. </p>
|
|
2534
|
+
* </code> action waits for a message
|
|
2535
|
+
* to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0. </p>
|
|
2306
2536
|
* </li>
|
|
2307
2537
|
* <li>
|
|
2308
2538
|
* <p>
|
|
@@ -2317,71 +2547,83 @@ export interface SetQueueAttributesRequest {
|
|
|
2317
2547
|
* <ul>
|
|
2318
2548
|
* <li>
|
|
2319
2549
|
* <p>
|
|
2320
|
-
* <code>RedrivePolicy</code> – The string that includes the parameters for the
|
|
2321
|
-
*
|
|
2550
|
+
* <code>RedrivePolicy</code> – The string that includes the parameters for the
|
|
2551
|
+
* dead-letter queue functionality of the source queue as a JSON object. The
|
|
2552
|
+
* parameters are as follows:</p>
|
|
2322
2553
|
* <ul>
|
|
2323
2554
|
* <li>
|
|
2324
2555
|
* <p>
|
|
2325
|
-
* <code>deadLetterTargetArn</code> – The Amazon Resource Name (ARN) of
|
|
2326
|
-
*
|
|
2556
|
+
* <code>deadLetterTargetArn</code> – The Amazon Resource Name (ARN) of
|
|
2557
|
+
* the dead-letter queue to which Amazon SQS moves messages after the value
|
|
2558
|
+
* of <code>maxReceiveCount</code> is exceeded.</p>
|
|
2327
2559
|
* </li>
|
|
2328
2560
|
* <li>
|
|
2329
2561
|
* <p>
|
|
2330
|
-
* <code>maxReceiveCount</code> – The number of times a message is
|
|
2331
|
-
*
|
|
2332
|
-
*
|
|
2562
|
+
* <code>maxReceiveCount</code> – The number of times a message is
|
|
2563
|
+
* delivered to the source queue before being moved to the dead-letter
|
|
2564
|
+
* queue. Default: 10. When the <code>ReceiveCount</code> for a message
|
|
2565
|
+
* exceeds the <code>maxReceiveCount</code> for a queue, Amazon SQS moves
|
|
2566
|
+
* the message to the dead-letter-queue.</p>
|
|
2333
2567
|
* </li>
|
|
2334
2568
|
* </ul>
|
|
2335
2569
|
* </li>
|
|
2336
2570
|
* <li>
|
|
2337
2571
|
* <p>
|
|
2338
|
-
* <code>RedriveAllowPolicy</code> – The string that includes the parameters for
|
|
2339
|
-
*
|
|
2572
|
+
* <code>RedriveAllowPolicy</code> – The string that includes the parameters for
|
|
2573
|
+
* the permissions for the dead-letter queue redrive permission and which source
|
|
2574
|
+
* queues can specify dead-letter queues as a JSON object. The parameters are as
|
|
2575
|
+
* follows:</p>
|
|
2340
2576
|
* <ul>
|
|
2341
2577
|
* <li>
|
|
2342
2578
|
* <p>
|
|
2343
|
-
* <code>redrivePermission</code> – The permission type that defines
|
|
2344
|
-
*
|
|
2579
|
+
* <code>redrivePermission</code> – The permission type that defines
|
|
2580
|
+
* which source queues can specify the current queue as the dead-letter
|
|
2581
|
+
* queue. Valid values are:</p>
|
|
2345
2582
|
* <ul>
|
|
2346
2583
|
* <li>
|
|
2347
2584
|
* <p>
|
|
2348
|
-
* <code>allowAll</code> – (Default) Any source queues in this
|
|
2349
|
-
*
|
|
2585
|
+
* <code>allowAll</code> – (Default) Any source queues in this
|
|
2586
|
+
* Amazon Web Services account in the same
|
|
2587
|
+
* Region can specify this queue as the dead-letter queue.</p>
|
|
2350
2588
|
* </li>
|
|
2351
2589
|
* <li>
|
|
2352
2590
|
* <p>
|
|
2353
|
-
* <code>denyAll</code> – No source queues can specify this queue
|
|
2354
|
-
*
|
|
2591
|
+
* <code>denyAll</code> – No source queues can specify this queue
|
|
2592
|
+
* as the dead-letter queue.</p>
|
|
2355
2593
|
* </li>
|
|
2356
2594
|
* <li>
|
|
2357
2595
|
* <p>
|
|
2358
|
-
* <code>byQueue</code> – Only queues specified by the
|
|
2359
|
-
*
|
|
2596
|
+
* <code>byQueue</code> – Only queues specified by the
|
|
2597
|
+
* <code>sourceQueueArns</code> parameter can specify this
|
|
2598
|
+
* queue as the dead-letter queue.</p>
|
|
2360
2599
|
* </li>
|
|
2361
2600
|
* </ul>
|
|
2362
2601
|
* </li>
|
|
2363
2602
|
* <li>
|
|
2364
2603
|
* <p>
|
|
2365
|
-
* <code>sourceQueueArns</code> – The Amazon Resource Names (ARN)s of the
|
|
2366
|
-
*
|
|
2367
|
-
*
|
|
2368
|
-
*
|
|
2369
|
-
*
|
|
2604
|
+
* <code>sourceQueueArns</code> – The Amazon Resource Names (ARN)s of the
|
|
2605
|
+
* source queues that can specify this queue as the dead-letter queue and
|
|
2606
|
+
* redrive messages. You can specify this parameter only when the
|
|
2607
|
+
* <code>redrivePermission</code> parameter is set to
|
|
2608
|
+
* <code>byQueue</code>. You can specify up to 10 source queue ARNs. To
|
|
2609
|
+
* allow more than 10 source queues to specify dead-letter queues, set the
|
|
2610
|
+
* <code>redrivePermission</code> parameter to
|
|
2611
|
+
* <code>allowAll</code>.</p>
|
|
2370
2612
|
* </li>
|
|
2371
2613
|
* </ul>
|
|
2372
2614
|
* </li>
|
|
2373
2615
|
* </ul>
|
|
2374
2616
|
* <note>
|
|
2375
|
-
* <p>The dead-letter queue of a
|
|
2376
|
-
*
|
|
2377
|
-
* queue of a standard queue must also be a standard queue.</p>
|
|
2617
|
+
* <p>The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the
|
|
2618
|
+
* dead-letter queue of a standard queue must also be a standard queue.</p>
|
|
2378
2619
|
* </note>
|
|
2379
2620
|
* <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>
|
|
2380
2621
|
* <ul>
|
|
2381
2622
|
* <li>
|
|
2382
2623
|
* <p>
|
|
2383
|
-
* <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer
|
|
2384
|
-
* key (CMK) for Amazon SQS or a custom CMK. For more information, see
|
|
2624
|
+
* <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer
|
|
2625
|
+
* master key (CMK) for Amazon SQS or a custom CMK. For more information, see
|
|
2626
|
+
* <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
|
|
2385
2627
|
* always <code>alias/aws/sqs</code>, the alias of a custom CMK can, for example,
|
|
2386
2628
|
* be <code>alias/<i>MyAlias</i>
|
|
2387
2629
|
* </code>. For more examples, see
|
|
@@ -2390,28 +2632,28 @@ export interface SetQueueAttributesRequest {
|
|
|
2390
2632
|
* </li>
|
|
2391
2633
|
* <li>
|
|
2392
2634
|
* <p>
|
|
2393
|
-
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in
|
|
2394
|
-
*
|
|
2395
|
-
* encrypt or decrypt messages before calling KMS again. An integer
|
|
2396
|
-
*
|
|
2397
|
-
*
|
|
2398
|
-
*
|
|
2399
|
-
*
|
|
2635
|
+
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in seconds, for
|
|
2636
|
+
* which Amazon SQS can reuse a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data key</a> to
|
|
2637
|
+
* encrypt or decrypt messages before calling KMS again. An integer representing
|
|
2638
|
+
* seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default:
|
|
2639
|
+
* 300 (5 minutes). A shorter time period provides better security but results in
|
|
2640
|
+
* more calls to KMS which might incur charges after Free Tier. For more
|
|
2641
|
+
* 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>
|
|
2400
2642
|
* </li>
|
|
2401
2643
|
* <li>
|
|
2402
2644
|
* <p>
|
|
2403
|
-
* <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption
|
|
2404
|
-
*
|
|
2405
|
-
*
|
|
2645
|
+
* <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption using
|
|
2646
|
+
* SQS owned encryption keys. Only one server-side encryption option is supported
|
|
2647
|
+
* 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>
|
|
2406
2648
|
* </li>
|
|
2407
2649
|
* </ul>
|
|
2408
|
-
* <p>The following attribute applies only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO
|
|
2409
|
-
* queues</a>:</p>
|
|
2650
|
+
* <p>The following attribute applies only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO
|
|
2651
|
+
* (first-in-first-out) queues</a>:</p>
|
|
2410
2652
|
* <ul>
|
|
2411
2653
|
* <li>
|
|
2412
2654
|
* <p>
|
|
2413
|
-
* <code>ContentBasedDeduplication</code> – Enables content-based
|
|
2414
|
-
*
|
|
2655
|
+
* <code>ContentBasedDeduplication</code> – Enables content-based deduplication.
|
|
2656
|
+
* 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
|
|
2415
2657
|
* Guide</i>. Note the following: </p>
|
|
2416
2658
|
* <ul>
|
|
2417
2659
|
* <li>
|
|
@@ -2425,8 +2667,8 @@ export interface SetQueueAttributesRequest {
|
|
|
2425
2667
|
* <li>
|
|
2426
2668
|
* <p>If you aren't able to provide a
|
|
2427
2669
|
* <code>MessageDeduplicationId</code> and you enable
|
|
2428
|
-
* <code>ContentBasedDeduplication</code> for your queue,
|
|
2429
|
-
* uses a SHA-256 hash to generate the
|
|
2670
|
+
* <code>ContentBasedDeduplication</code> for your queue,
|
|
2671
|
+
* Amazon SQS uses a SHA-256 hash to generate the
|
|
2430
2672
|
* <code>MessageDeduplicationId</code> using the body of the
|
|
2431
2673
|
* message (but not the attributes of the message). </p>
|
|
2432
2674
|
* </li>
|
|
@@ -2459,20 +2701,22 @@ export interface SetQueueAttributesRequest {
|
|
|
2459
2701
|
* </ul>
|
|
2460
2702
|
* </li>
|
|
2461
2703
|
* </ul>
|
|
2462
|
-
* <p>The following attributes apply only to
|
|
2463
|
-
*
|
|
2464
|
-
* for FIFO queues</a>:</p>
|
|
2704
|
+
* <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html">high
|
|
2705
|
+
* throughput for FIFO queues</a>:</p>
|
|
2465
2706
|
* <ul>
|
|
2466
2707
|
* <li>
|
|
2467
2708
|
* <p>
|
|
2468
|
-
* <code>DeduplicationScope</code> – Specifies whether message deduplication
|
|
2469
|
-
*
|
|
2709
|
+
* <code>DeduplicationScope</code> – Specifies whether message deduplication
|
|
2710
|
+
* occurs at the message group or queue level. Valid values are
|
|
2711
|
+
* <code>messageGroup</code> and <code>queue</code>.</p>
|
|
2470
2712
|
* </li>
|
|
2471
2713
|
* <li>
|
|
2472
2714
|
* <p>
|
|
2473
2715
|
* <code>FifoThroughputLimit</code> – Specifies whether the FIFO queue throughput
|
|
2474
|
-
*
|
|
2475
|
-
*
|
|
2716
|
+
* quota applies to the entire queue or per message group. Valid values are
|
|
2717
|
+
* <code>perQueue</code> and <code>perMessageGroupId</code>. The
|
|
2718
|
+
* <code>perMessageGroupId</code> value is allowed only when the value for
|
|
2719
|
+
* <code>DeduplicationScope</code> is <code>messageGroup</code>.</p>
|
|
2476
2720
|
* </li>
|
|
2477
2721
|
* </ul>
|
|
2478
2722
|
* <p>To enable high throughput for FIFO queues, do the following:</p>
|
|
@@ -2485,10 +2729,10 @@ export interface SetQueueAttributesRequest {
|
|
|
2485
2729
|
* </li>
|
|
2486
2730
|
* </ul>
|
|
2487
2731
|
* <p>If you set these attributes to anything other than the values shown for enabling high
|
|
2488
|
-
*
|
|
2489
|
-
* <p>For information on throughput quotas,
|
|
2490
|
-
*
|
|
2491
|
-
*
|
|
2732
|
+
* throughput, normal throughput is in effect and deduplication occurs as specified.</p>
|
|
2733
|
+
* <p>For information on throughput quotas, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html">Quotas
|
|
2734
|
+
* related to messages</a> in the <i>Amazon SQS Developer
|
|
2735
|
+
* Guide</i>.</p>
|
|
2492
2736
|
*/
|
|
2493
2737
|
Attributes: Partial<Record<QueueAttributeName, string>> | undefined;
|
|
2494
2738
|
}
|