@aws-sdk/client-sqs 3.345.0 → 3.347.1
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 +34 -6
- package/dist-cjs/SQS.js +6 -0
- package/dist-cjs/commands/CancelMessageMoveTaskCommand.js +46 -0
- package/dist-cjs/commands/ListMessageMoveTasksCommand.js +46 -0
- package/dist-cjs/commands/StartMessageMoveTaskCommand.js +46 -0
- package/dist-cjs/commands/index.js +3 -0
- package/dist-cjs/models/models_0.js +28 -14
- package/dist-cjs/protocols/Aws_query.js +247 -1
- package/dist-es/SQS.js +6 -0
- package/dist-es/commands/CancelMessageMoveTaskCommand.js +42 -0
- package/dist-es/commands/ListMessageMoveTasksCommand.js +42 -0
- package/dist-es/commands/StartMessageMoveTaskCommand.js +42 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/models/models_0.js +25 -12
- package/dist-es/protocols/Aws_query.js +242 -2
- package/dist-types/SQS.d.ts +31 -6
- package/dist-types/SQSClient.d.ts +15 -8
- package/dist-types/commands/AddPermissionCommand.d.ts +17 -23
- package/dist-types/commands/CancelMessageMoveTaskCommand.d.ts +92 -0
- package/dist-types/commands/ChangeMessageVisibilityBatchCommand.d.ts +9 -12
- package/dist-types/commands/ChangeMessageVisibilityCommand.d.ts +22 -13
- package/dist-types/commands/CreateQueueCommand.d.ts +17 -16
- package/dist-types/commands/DeleteMessageBatchCommand.d.ts +6 -10
- package/dist-types/commands/DeleteMessageCommand.d.ts +1 -1
- package/dist-types/commands/DeleteQueueCommand.d.ts +13 -8
- package/dist-types/commands/GetQueueUrlCommand.d.ts +7 -4
- package/dist-types/commands/ListDeadLetterSourceQueuesCommand.d.ts +11 -10
- package/dist-types/commands/ListMessageMoveTasksCommand.d.ts +93 -0
- package/dist-types/commands/ListQueueTagsCommand.d.ts +3 -2
- package/dist-types/commands/ListQueuesCommand.d.ts +12 -10
- package/dist-types/commands/PurgeQueueCommand.d.ts +7 -5
- package/dist-types/commands/ReceiveMessageCommand.d.ts +25 -14
- package/dist-types/commands/RemovePermissionCommand.d.ts +3 -2
- package/dist-types/commands/SendMessageBatchCommand.d.ts +14 -13
- package/dist-types/commands/SetQueueAttributesCommand.d.ts +7 -3
- package/dist-types/commands/StartMessageMoveTaskCommand.d.ts +100 -0
- package/dist-types/commands/TagQueueCommand.d.ts +1 -1
- package/dist-types/commands/UntagQueueCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/index.d.ts +10 -6
- package/dist-types/models/models_0.d.ts +852 -359
- package/dist-types/protocols/Aws_query.d.ts +27 -0
- package/dist-types/ts3.4/SQS.d.ts +51 -0
- package/dist-types/ts3.4/SQSClient.d.ts +18 -0
- package/dist-types/ts3.4/commands/CancelMessageMoveTaskCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListMessageMoveTasksCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/StartMessageMoveTaskCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/models_0.d.ts +47 -7
- package/dist-types/ts3.4/protocols/Aws_query.d.ts +36 -0
- package/package.json +31 -31
|
@@ -11,7 +11,10 @@ export interface AddPermissionRequest {
|
|
|
11
11
|
*/
|
|
12
12
|
QueueUrl: string | undefined;
|
|
13
13
|
/**
|
|
14
|
-
* <p>The unique identification of the permission you're setting (for example,
|
|
14
|
+
* <p>The unique identification of the permission you're setting (for example,
|
|
15
|
+
* <code>AliceSendMessage</code>). Maximum 80 characters. Allowed characters include
|
|
16
|
+
* alphanumeric characters, hyphens (<code>-</code>), and underscores
|
|
17
|
+
* (<code>_</code>).</p>
|
|
15
18
|
*/
|
|
16
19
|
Label: string | undefined;
|
|
17
20
|
/**
|
|
@@ -21,18 +24,22 @@ export interface AddPermissionRequest {
|
|
|
21
24
|
*/
|
|
22
25
|
AWSAccountIds: string[] | undefined;
|
|
23
26
|
/**
|
|
24
|
-
* <p>The action the client wants to allow for the specified principal. Valid values: the
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
27
|
+
* <p>The action the client wants to allow for the specified principal. Valid values: the
|
|
28
|
+
* name of any action or <code>*</code>.</p>
|
|
29
|
+
* <p>For more information about these actions, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-overview-of-managing-access.html">Overview of Managing Access Permissions to Your Amazon Simple Queue Service
|
|
30
|
+
* Resource</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
31
|
+
* <p>Specifying <code>SendMessage</code>, <code>DeleteMessage</code>, or
|
|
32
|
+
* <code>ChangeMessageVisibility</code> for <code>ActionName.n</code> also grants
|
|
33
|
+
* permissions for the corresponding batch versions of those actions:
|
|
34
|
+
* <code>SendMessageBatch</code>, <code>DeleteMessageBatch</code>, and
|
|
35
|
+
* <code>ChangeMessageVisibilityBatch</code>.</p>
|
|
29
36
|
*/
|
|
30
37
|
Actions: string[] | undefined;
|
|
31
38
|
}
|
|
32
39
|
/**
|
|
33
40
|
* @public
|
|
34
41
|
* <p>The specified action violates a limit. For example, <code>ReceiveMessage</code>
|
|
35
|
-
* returns this error if the maximum number of
|
|
42
|
+
* returns this error if the maximum number of in flight messages is reached and
|
|
36
43
|
* <code>AddPermission</code> returns this error if the maximum number of permissions
|
|
37
44
|
* for the queue is reached.</p>
|
|
38
45
|
*/
|
|
@@ -44,6 +51,48 @@ export declare class OverLimit extends __BaseException {
|
|
|
44
51
|
*/
|
|
45
52
|
constructor(opts: __ExceptionOptionType<OverLimit, __BaseException>);
|
|
46
53
|
}
|
|
54
|
+
/**
|
|
55
|
+
* @public
|
|
56
|
+
*/
|
|
57
|
+
export interface CancelMessageMoveTaskRequest {
|
|
58
|
+
/**
|
|
59
|
+
* <p>An identifier associated with a message movement task.</p>
|
|
60
|
+
*/
|
|
61
|
+
TaskHandle: string | undefined;
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* @public
|
|
65
|
+
*/
|
|
66
|
+
export interface CancelMessageMoveTaskResult {
|
|
67
|
+
/**
|
|
68
|
+
* <p>The approximate number of messages already moved to the destination queue.</p>
|
|
69
|
+
*/
|
|
70
|
+
ApproximateNumberOfMessagesMoved?: number;
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* @public
|
|
74
|
+
* <p>One or more specified resources don't exist.</p>
|
|
75
|
+
*/
|
|
76
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
77
|
+
readonly name: "ResourceNotFoundException";
|
|
78
|
+
readonly $fault: "client";
|
|
79
|
+
/**
|
|
80
|
+
* @internal
|
|
81
|
+
*/
|
|
82
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
83
|
+
}
|
|
84
|
+
/**
|
|
85
|
+
* @public
|
|
86
|
+
* <p>Error code 400. Unsupported operation.</p>
|
|
87
|
+
*/
|
|
88
|
+
export declare class UnsupportedOperation extends __BaseException {
|
|
89
|
+
readonly name: "UnsupportedOperation";
|
|
90
|
+
readonly $fault: "client";
|
|
91
|
+
/**
|
|
92
|
+
* @internal
|
|
93
|
+
*/
|
|
94
|
+
constructor(opts: __ExceptionOptionType<UnsupportedOperation, __BaseException>);
|
|
95
|
+
}
|
|
47
96
|
/**
|
|
48
97
|
* @public
|
|
49
98
|
*/
|
|
@@ -54,13 +103,16 @@ export interface ChangeMessageVisibilityRequest {
|
|
|
54
103
|
*/
|
|
55
104
|
QueueUrl: string | undefined;
|
|
56
105
|
/**
|
|
57
|
-
* <p>The receipt handle associated with the message whose visibility timeout is changed.
|
|
106
|
+
* <p>The receipt handle associated with the message, whose visibility timeout is changed.
|
|
107
|
+
* This parameter is returned by the <code>
|
|
58
108
|
* <a>ReceiveMessage</a>
|
|
59
|
-
* </code>
|
|
109
|
+
* </code>
|
|
110
|
+
* action.</p>
|
|
60
111
|
*/
|
|
61
112
|
ReceiptHandle: string | undefined;
|
|
62
113
|
/**
|
|
63
|
-
* <p>The new value for the message's visibility timeout (in seconds). Values range:
|
|
114
|
+
* <p>The new value for the message's visibility timeout (in seconds). Values range:
|
|
115
|
+
* <code>0</code> to <code>43200</code>. Maximum: 12 hours.</p>
|
|
64
116
|
*/
|
|
65
117
|
VisibilityTimeout: number | undefined;
|
|
66
118
|
}
|
|
@@ -102,25 +154,14 @@ export declare class BatchEntryIdsNotDistinct extends __BaseException {
|
|
|
102
154
|
}
|
|
103
155
|
/**
|
|
104
156
|
* @public
|
|
105
|
-
* <p>Encloses a receipt handle and an entry
|
|
157
|
+
* <p>Encloses a receipt handle and an entry ID for each message in <code>
|
|
106
158
|
* <a>ChangeMessageVisibilityBatch</a>.</code>
|
|
107
159
|
* </p>
|
|
108
|
-
* <important>
|
|
109
|
-
* <p>All of the following list parameters must be prefixed with <code>ChangeMessageVisibilityBatchRequestEntry.n</code>, where <code>n</code> is an integer value starting with <code>1</code>. For example, a parameter list for this action might look like this:</p>
|
|
110
|
-
* </important>
|
|
111
|
-
* <p>
|
|
112
|
-
* <code>&ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2</code>
|
|
113
|
-
* </p>
|
|
114
|
-
* <p>
|
|
115
|
-
* <code>&ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=your_receipt_handle</code>
|
|
116
|
-
* </p>
|
|
117
|
-
* <p>
|
|
118
|
-
* <code>&ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45</code>
|
|
119
|
-
* </p>
|
|
120
160
|
*/
|
|
121
161
|
export interface ChangeMessageVisibilityBatchRequestEntry {
|
|
122
162
|
/**
|
|
123
|
-
* <p>An identifier for this particular receipt handle used to communicate the
|
|
163
|
+
* <p>An identifier for this particular receipt handle used to communicate the
|
|
164
|
+
* result.</p>
|
|
124
165
|
* <note>
|
|
125
166
|
* <p>The <code>Id</code>s of a batch request need to be unique within a request.</p>
|
|
126
167
|
* <p>This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).</p>
|
|
@@ -147,7 +188,8 @@ export interface ChangeMessageVisibilityBatchRequest {
|
|
|
147
188
|
*/
|
|
148
189
|
QueueUrl: string | undefined;
|
|
149
190
|
/**
|
|
150
|
-
* <p>
|
|
191
|
+
* <p>Lists the receipt handles of the messages for which the visibility timeout must be
|
|
192
|
+
* changed.</p>
|
|
151
193
|
*/
|
|
152
194
|
Entries: ChangeMessageVisibilityBatchRequestEntry[] | undefined;
|
|
153
195
|
}
|
|
@@ -190,15 +232,18 @@ export interface ChangeMessageVisibilityBatchResultEntry {
|
|
|
190
232
|
* @public
|
|
191
233
|
* <p>For each message in the batch, the response contains a <code>
|
|
192
234
|
* <a>ChangeMessageVisibilityBatchResultEntry</a>
|
|
193
|
-
* </code> tag if the message
|
|
235
|
+
* </code> tag if the message
|
|
236
|
+
* succeeds or a <code>
|
|
194
237
|
* <a>BatchResultErrorEntry</a>
|
|
195
|
-
* </code> tag if the message
|
|
238
|
+
* </code> tag if the message
|
|
239
|
+
* fails.</p>
|
|
196
240
|
*/
|
|
197
241
|
export interface ChangeMessageVisibilityBatchResult {
|
|
198
242
|
/**
|
|
199
243
|
* <p>A list of <code>
|
|
200
244
|
* <a>ChangeMessageVisibilityBatchResultEntry</a>
|
|
201
|
-
* </code>
|
|
245
|
+
* </code>
|
|
246
|
+
* items.</p>
|
|
202
247
|
*/
|
|
203
248
|
Successful: ChangeMessageVisibilityBatchResultEntry[] | undefined;
|
|
204
249
|
/**
|
|
@@ -222,7 +267,8 @@ export declare class EmptyBatchRequest extends __BaseException {
|
|
|
222
267
|
}
|
|
223
268
|
/**
|
|
224
269
|
* @public
|
|
225
|
-
* <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the
|
|
270
|
+
* <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the
|
|
271
|
+
* specification.</p>
|
|
226
272
|
*/
|
|
227
273
|
export declare class InvalidBatchEntryId extends __BaseException {
|
|
228
274
|
readonly name: "InvalidBatchEntryId";
|
|
@@ -288,7 +334,8 @@ export interface CreateQueueRequest {
|
|
|
288
334
|
* <p>A queue name can have up to 80 characters.</p>
|
|
289
335
|
* </li>
|
|
290
336
|
* <li>
|
|
291
|
-
* <p>Valid values: alphanumeric characters, hyphens (<code>-</code>), and
|
|
337
|
+
* <p>Valid values: alphanumeric characters, hyphens (<code>-</code>), and
|
|
338
|
+
* underscores (<code>_</code>).</p>
|
|
292
339
|
* </li>
|
|
293
340
|
* <li>
|
|
294
341
|
* <p>A FIFO queue name must end with the <code>.fifo</code> suffix.</p>
|
|
@@ -323,135 +370,217 @@ export interface CreateQueueRequest {
|
|
|
323
370
|
* <code>sqs:CreateQueue</code> and <code>sqs:TagQueue</code> permissions.</p>
|
|
324
371
|
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
325
372
|
* 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
|
|
326
|
-
* cross-account permissions to a role and a
|
|
373
|
+
* cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
327
374
|
* </note>
|
|
328
375
|
*/
|
|
329
376
|
tags?: Record<string, string>;
|
|
330
377
|
/**
|
|
331
378
|
* <p>A map of attributes with their corresponding values.</p>
|
|
332
|
-
* <p>The following lists the names, descriptions, and values of the special request
|
|
379
|
+
* <p>The following lists the names, descriptions, and values of the special request
|
|
380
|
+
* parameters that the <code>CreateQueue</code> action uses:</p>
|
|
333
381
|
* <ul>
|
|
334
382
|
* <li>
|
|
335
383
|
* <p>
|
|
336
|
-
* <code>DelaySeconds</code> – The length of time, in seconds, for which the
|
|
337
|
-
*
|
|
384
|
+
* <code>DelaySeconds</code> – The length of time, in seconds, for which the
|
|
385
|
+
* delivery of all messages in the queue is delayed. Valid values: An integer from
|
|
386
|
+
* 0 to 900 seconds (15 minutes). Default: 0. </p>
|
|
338
387
|
* </li>
|
|
339
388
|
* <li>
|
|
340
389
|
* <p>
|
|
341
|
-
* <code>MaximumMessageSize</code> – The limit of how many bytes a message
|
|
342
|
-
*
|
|
390
|
+
* <code>MaximumMessageSize</code> – The limit of how many bytes a message
|
|
391
|
+
* can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes
|
|
392
|
+
* (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). </p>
|
|
343
393
|
* </li>
|
|
344
394
|
* <li>
|
|
345
395
|
* <p>
|
|
346
|
-
* <code>MessageRetentionPeriod</code> – The length of time, in seconds, for
|
|
347
|
-
*
|
|
396
|
+
* <code>MessageRetentionPeriod</code> – The length of time, in seconds, for
|
|
397
|
+
* which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1
|
|
398
|
+
* minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days). When you
|
|
399
|
+
* change a queue's attributes, the change can take up to 60 seconds for most of
|
|
400
|
+
* the attributes to propagate throughout the Amazon SQS system. Changes made to the
|
|
401
|
+
* <code>MessageRetentionPeriod</code> attribute can take up to 15 minutes and
|
|
402
|
+
* will impact existing messages in the queue potentially causing them to be
|
|
403
|
+
* expired and deleted if the <code>MessageRetentionPeriod</code> is reduced below
|
|
404
|
+
* the age of existing messages.</p>
|
|
348
405
|
* </li>
|
|
349
406
|
* <li>
|
|
350
407
|
* <p>
|
|
351
|
-
* <code>Policy</code> – The queue's policy. A valid Amazon Web Services policy. For more
|
|
352
|
-
*
|
|
408
|
+
* <code>Policy</code> – The queue's policy. A valid Amazon Web Services policy. For more
|
|
409
|
+
* information about policy structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview of Amazon Web Services IAM
|
|
410
|
+
* Policies</a> in the <i>IAM User Guide</i>. </p>
|
|
353
411
|
* </li>
|
|
354
412
|
* <li>
|
|
355
413
|
* <p>
|
|
356
|
-
* <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in
|
|
414
|
+
* <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in
|
|
415
|
+
* seconds, for which a <code>
|
|
357
416
|
* <a>ReceiveMessage</a>
|
|
358
|
-
* </code> action waits
|
|
359
|
-
*
|
|
417
|
+
* </code> action waits
|
|
418
|
+
* for a message to arrive. Valid values: An integer from 0 to 20 (seconds).
|
|
419
|
+
* Default: 0. </p>
|
|
360
420
|
* </li>
|
|
361
421
|
* <li>
|
|
362
422
|
* <p>
|
|
423
|
+
* <code>VisibilityTimeout</code> – The visibility timeout for the queue, in
|
|
424
|
+
* seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For
|
|
425
|
+
* 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
|
|
426
|
+
* Guide</i>.</p>
|
|
427
|
+
* </li>
|
|
428
|
+
* </ul>
|
|
429
|
+
* <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">dead-letter queues:</a>
|
|
430
|
+
* </p>
|
|
431
|
+
* <ul>
|
|
432
|
+
* <li>
|
|
433
|
+
* <p>
|
|
363
434
|
* <code>RedrivePolicy</code> – The string that includes the parameters for the dead-letter queue functionality
|
|
364
|
-
*
|
|
365
|
-
* in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
435
|
+
* of the source queue as a JSON object. The parameters are as follows:</p>
|
|
366
436
|
* <ul>
|
|
367
437
|
* <li>
|
|
368
438
|
* <p>
|
|
369
|
-
* <code>deadLetterTargetArn</code> – The Amazon Resource Name (ARN) of the dead-letter queue to
|
|
439
|
+
* <code>deadLetterTargetArn</code> – The Amazon Resource Name (ARN) of the dead-letter queue to
|
|
440
|
+
* which Amazon SQS moves messages after the value of <code>maxReceiveCount</code> is exceeded.</p>
|
|
370
441
|
* </li>
|
|
371
442
|
* <li>
|
|
372
443
|
* <p>
|
|
373
|
-
* <code>maxReceiveCount</code> – The number of times a message is delivered to the source queue before being
|
|
374
|
-
*
|
|
444
|
+
* <code>maxReceiveCount</code> – The number of times a message is delivered to the source queue before being
|
|
445
|
+
* moved to the dead-letter queue. Default: 10. When the <code>ReceiveCount</code> for a message exceeds the <code>maxReceiveCount</code>
|
|
446
|
+
* for a queue, Amazon SQS moves the message to the dead-letter-queue.</p>
|
|
375
447
|
* </li>
|
|
376
448
|
* </ul>
|
|
377
|
-
* <note>
|
|
378
|
-
* <p>The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.</p>
|
|
379
|
-
* </note>
|
|
380
449
|
* </li>
|
|
381
450
|
* <li>
|
|
382
451
|
* <p>
|
|
383
|
-
* <code>
|
|
384
|
-
*
|
|
452
|
+
* <code>RedriveAllowPolicy</code> – The string that includes the parameters for the permissions for the dead-letter
|
|
453
|
+
* queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:</p>
|
|
454
|
+
* <ul>
|
|
455
|
+
* <li>
|
|
456
|
+
* <p>
|
|
457
|
+
* <code>redrivePermission</code> – The permission type that defines which source queues can
|
|
458
|
+
* specify the current queue as the dead-letter queue. Valid values are:</p>
|
|
459
|
+
* <ul>
|
|
460
|
+
* <li>
|
|
461
|
+
* <p>
|
|
462
|
+
* <code>allowAll</code> – (Default) Any source queues in this Amazon Web Services account in the same Region can
|
|
463
|
+
* specify this queue as the dead-letter queue.</p>
|
|
464
|
+
* </li>
|
|
465
|
+
* <li>
|
|
466
|
+
* <p>
|
|
467
|
+
* <code>denyAll</code> – No source queues can specify this queue as the dead-letter
|
|
468
|
+
* queue.</p>
|
|
469
|
+
* </li>
|
|
470
|
+
* <li>
|
|
471
|
+
* <p>
|
|
472
|
+
* <code>byQueue</code> – Only queues specified by the <code>sourceQueueArns</code> parameter can specify
|
|
473
|
+
* this queue as the dead-letter queue.</p>
|
|
474
|
+
* </li>
|
|
475
|
+
* </ul>
|
|
476
|
+
* </li>
|
|
477
|
+
* <li>
|
|
478
|
+
* <p>
|
|
479
|
+
* <code>sourceQueueArns</code> – The Amazon Resource Names (ARN)s of the source queues that can specify
|
|
480
|
+
* this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the
|
|
481
|
+
* <code>redrivePermission</code> parameter is set to <code>byQueue</code>. You can specify up to 10 source queue ARNs.
|
|
482
|
+
* To allow more than 10 source queues to specify dead-letter queues, set the <code>redrivePermission</code> parameter
|
|
483
|
+
* to <code>allowAll</code>.</p>
|
|
484
|
+
* </li>
|
|
485
|
+
* </ul>
|
|
385
486
|
* </li>
|
|
386
487
|
* </ul>
|
|
488
|
+
* <note>
|
|
489
|
+
* <p>The dead-letter queue of a
|
|
490
|
+
* FIFO queue must also be a FIFO queue. Similarly, the dead-letter
|
|
491
|
+
* queue of a standard queue must also be a standard queue.</p>
|
|
492
|
+
* </note>
|
|
387
493
|
* <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>
|
|
388
494
|
* <ul>
|
|
389
495
|
* <li>
|
|
390
496
|
* <p>
|
|
391
|
-
* <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer master
|
|
392
|
-
*
|
|
393
|
-
*
|
|
394
|
-
*
|
|
395
|
-
*
|
|
497
|
+
* <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer master
|
|
498
|
+
* key (CMK) for Amazon SQS or a custom CMK. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key Terms</a>. While the alias of the Amazon Web Services managed CMK for Amazon SQS is
|
|
499
|
+
* always <code>alias/aws/sqs</code>, the alias of a custom CMK can, for example,
|
|
500
|
+
* be <code>alias/<i>MyAlias</i>
|
|
501
|
+
* </code>. For more examples, see
|
|
502
|
+
* <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
|
|
503
|
+
* Reference</i>. </p>
|
|
396
504
|
* </li>
|
|
397
505
|
* <li>
|
|
398
506
|
* <p>
|
|
399
|
-
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in
|
|
400
|
-
*
|
|
401
|
-
*
|
|
402
|
-
*
|
|
403
|
-
*
|
|
507
|
+
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in
|
|
508
|
+
* seconds, for which Amazon SQS can reuse a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data key</a> to
|
|
509
|
+
* encrypt or decrypt messages before calling KMS again. An integer
|
|
510
|
+
* representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
|
511
|
+
* hours). Default: 300 (5 minutes). A shorter time period provides better security
|
|
512
|
+
* but results in more calls to KMS which might incur charges after Free Tier. For
|
|
513
|
+
* 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>
|
|
514
|
+
* </p>
|
|
404
515
|
* </li>
|
|
405
516
|
* <li>
|
|
406
517
|
* <p>
|
|
407
|
-
* <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption
|
|
518
|
+
* <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption
|
|
519
|
+
* using SQS owned encryption keys. Only one server-side encryption option is
|
|
520
|
+
* 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>
|
|
408
521
|
* </li>
|
|
409
522
|
* </ul>
|
|
410
|
-
* <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO (first-in-first-out)
|
|
523
|
+
* <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO (first-in-first-out)
|
|
524
|
+
* queues</a>:</p>
|
|
411
525
|
* <ul>
|
|
412
526
|
* <li>
|
|
413
527
|
* <p>
|
|
414
|
-
* <code>FifoQueue</code> – Designates a queue as FIFO. Valid values are
|
|
415
|
-
*
|
|
416
|
-
*
|
|
417
|
-
*
|
|
418
|
-
*
|
|
419
|
-
*
|
|
528
|
+
* <code>FifoQueue</code> – Designates a queue as FIFO. Valid values are
|
|
529
|
+
* <code>true</code> and <code>false</code>. If you don't specify the <code>FifoQueue</code> attribute, Amazon SQS creates a standard queue. You
|
|
530
|
+
* can provide this attribute only during queue creation. You can't change it for
|
|
531
|
+
* an existing queue. When you set this attribute, you must also provide the
|
|
532
|
+
* <code>MessageGroupId</code> for your messages explicitly.</p>
|
|
533
|
+
* <p>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
|
|
534
|
+
* Guide</i>.</p>
|
|
420
535
|
* </li>
|
|
421
536
|
* <li>
|
|
422
537
|
* <p>
|
|
423
|
-
* <code>ContentBasedDeduplication</code> – Enables content-based
|
|
424
|
-
*
|
|
425
|
-
*
|
|
538
|
+
* <code>ContentBasedDeduplication</code> – Enables content-based
|
|
539
|
+
* deduplication. Valid values are <code>true</code> and <code>false</code>. For
|
|
540
|
+
* 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
|
|
541
|
+
* Guide</i>. Note the following: </p>
|
|
426
542
|
* <ul>
|
|
427
543
|
* <li>
|
|
428
|
-
* <p>Every message must have a unique
|
|
544
|
+
* <p>Every message must have a unique
|
|
545
|
+
* <code>MessageDeduplicationId</code>.</p>
|
|
429
546
|
* <ul>
|
|
430
547
|
* <li>
|
|
431
|
-
* <p>You may provide a <code>MessageDeduplicationId</code>
|
|
548
|
+
* <p>You may provide a <code>MessageDeduplicationId</code>
|
|
549
|
+
* explicitly.</p>
|
|
432
550
|
* </li>
|
|
433
551
|
* <li>
|
|
434
|
-
* <p>If you aren't able to provide a
|
|
435
|
-
*
|
|
436
|
-
*
|
|
552
|
+
* <p>If you aren't able to provide a
|
|
553
|
+
* <code>MessageDeduplicationId</code> and you enable
|
|
554
|
+
* <code>ContentBasedDeduplication</code> for your queue, Amazon SQS
|
|
555
|
+
* uses a SHA-256 hash to generate the
|
|
556
|
+
* <code>MessageDeduplicationId</code> using the body of the
|
|
557
|
+
* message (but not the attributes of the message). </p>
|
|
437
558
|
* </li>
|
|
438
559
|
* <li>
|
|
439
|
-
* <p>If you don't provide a <code>MessageDeduplicationId</code> and
|
|
440
|
-
*
|
|
560
|
+
* <p>If you don't provide a <code>MessageDeduplicationId</code> and
|
|
561
|
+
* the queue doesn't have <code>ContentBasedDeduplication</code>
|
|
562
|
+
* set, the action fails with an error.</p>
|
|
441
563
|
* </li>
|
|
442
564
|
* <li>
|
|
443
|
-
* <p>If the queue has <code>ContentBasedDeduplication</code> set,
|
|
565
|
+
* <p>If the queue has <code>ContentBasedDeduplication</code> set,
|
|
566
|
+
* your <code>MessageDeduplicationId</code> overrides the generated
|
|
567
|
+
* one.</p>
|
|
444
568
|
* </li>
|
|
445
569
|
* </ul>
|
|
446
570
|
* </li>
|
|
447
571
|
* <li>
|
|
448
|
-
* <p>When <code>ContentBasedDeduplication</code> is in effect, messages
|
|
449
|
-
*
|
|
572
|
+
* <p>When <code>ContentBasedDeduplication</code> is in effect, messages
|
|
573
|
+
* with identical content sent within the deduplication interval are
|
|
574
|
+
* treated as duplicates and only one copy of the message is
|
|
575
|
+
* delivered.</p>
|
|
450
576
|
* </li>
|
|
451
577
|
* <li>
|
|
452
|
-
* <p>If you send one message with <code>ContentBasedDeduplication</code>
|
|
453
|
-
*
|
|
454
|
-
*
|
|
578
|
+
* <p>If you send one message with <code>ContentBasedDeduplication</code>
|
|
579
|
+
* enabled and then another message with a
|
|
580
|
+
* <code>MessageDeduplicationId</code> that is the same as the one
|
|
581
|
+
* generated for the first <code>MessageDeduplicationId</code>, the two
|
|
582
|
+
* messages are treated as duplicates and only one copy of the message is
|
|
583
|
+
* delivered. </p>
|
|
455
584
|
* </li>
|
|
456
585
|
* </ul>
|
|
457
586
|
* </li>
|
|
@@ -558,7 +687,8 @@ export declare class InvalidIdFormat extends __BaseException {
|
|
|
558
687
|
*/
|
|
559
688
|
export interface DeleteMessageBatchRequestEntry {
|
|
560
689
|
/**
|
|
561
|
-
* <p>
|
|
690
|
+
* <p>The identifier for this particular receipt handle. This is used to communicate the
|
|
691
|
+
* result.</p>
|
|
562
692
|
* <note>
|
|
563
693
|
* <p>The <code>Id</code>s of a batch request need to be unique within a request.</p>
|
|
564
694
|
* <p>This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).</p>
|
|
@@ -581,7 +711,7 @@ export interface DeleteMessageBatchRequest {
|
|
|
581
711
|
*/
|
|
582
712
|
QueueUrl: string | undefined;
|
|
583
713
|
/**
|
|
584
|
-
* <p>
|
|
714
|
+
* <p>Lists the receipt handles for the messages to be deleted.</p>
|
|
585
715
|
*/
|
|
586
716
|
Entries: DeleteMessageBatchRequestEntry[] | undefined;
|
|
587
717
|
}
|
|
@@ -599,11 +729,13 @@ export interface DeleteMessageBatchResultEntry {
|
|
|
599
729
|
}
|
|
600
730
|
/**
|
|
601
731
|
* @public
|
|
602
|
-
* <p>For each message in the batch, the response contains a
|
|
732
|
+
* <p>For each message in the batch, the response contains a <code>
|
|
603
733
|
* <a>DeleteMessageBatchResultEntry</a>
|
|
604
|
-
* </code> tag if the message is deleted
|
|
734
|
+
* </code> tag if the message is deleted
|
|
735
|
+
* or a <code>
|
|
605
736
|
* <a>BatchResultErrorEntry</a>
|
|
606
|
-
* </code> tag if the message can't be
|
|
737
|
+
* </code> tag if the message can't be
|
|
738
|
+
* deleted.</p>
|
|
607
739
|
*/
|
|
608
740
|
export interface DeleteMessageBatchResult {
|
|
609
741
|
/**
|
|
@@ -642,17 +774,18 @@ export interface GetQueueAttributesRequest {
|
|
|
642
774
|
QueueUrl: string | undefined;
|
|
643
775
|
/**
|
|
644
776
|
* <p>A list of attributes for which to retrieve information.</p>
|
|
645
|
-
* <p>The <code>
|
|
646
|
-
*
|
|
777
|
+
* <p>The <code>AttributeNames</code> parameter is optional, but if you don't specify values
|
|
778
|
+
* for this parameter, the request returns empty results.</p>
|
|
647
779
|
* <note>
|
|
648
780
|
* <p>In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.</p>
|
|
649
781
|
* </note>
|
|
650
782
|
* <p>The following attributes are supported:</p>
|
|
651
783
|
* <important>
|
|
652
|
-
* <p>The <code>ApproximateNumberOfMessagesDelayed</code>,
|
|
653
|
-
*
|
|
654
|
-
*
|
|
655
|
-
*
|
|
784
|
+
* <p>The <code>ApproximateNumberOfMessagesDelayed</code>,
|
|
785
|
+
* <code>ApproximateNumberOfMessagesNotVisible</code>, and
|
|
786
|
+
* <code>ApproximateNumberOfMessages</code> metrics may not achieve consistency
|
|
787
|
+
* until at least 1 minute after the producers stop sending messages. This period is
|
|
788
|
+
* required for the queue metadata to reach eventual consistency. </p>
|
|
656
789
|
* </important>
|
|
657
790
|
* <ul>
|
|
658
791
|
* <li>
|
|
@@ -661,28 +794,29 @@ export interface GetQueueAttributesRequest {
|
|
|
661
794
|
* </li>
|
|
662
795
|
* <li>
|
|
663
796
|
* <p>
|
|
664
|
-
* <code>ApproximateNumberOfMessages</code> – Returns the approximate
|
|
665
|
-
* messages available for retrieval from the queue.</p>
|
|
797
|
+
* <code>ApproximateNumberOfMessages</code> – Returns the approximate
|
|
798
|
+
* number of messages available for retrieval from the queue.</p>
|
|
666
799
|
* </li>
|
|
667
800
|
* <li>
|
|
668
801
|
* <p>
|
|
669
|
-
* <code>ApproximateNumberOfMessagesDelayed</code> – Returns the
|
|
670
|
-
* of messages in the queue that are delayed and not available
|
|
671
|
-
* immediately. This can happen when the queue is configured as a delay
|
|
672
|
-
* when a message has been sent with a delay parameter.</p>
|
|
802
|
+
* <code>ApproximateNumberOfMessagesDelayed</code> – Returns the
|
|
803
|
+
* approximate number of messages in the queue that are delayed and not available
|
|
804
|
+
* for reading immediately. This can happen when the queue is configured as a delay
|
|
805
|
+
* queue or when a message has been sent with a delay parameter.</p>
|
|
673
806
|
* </li>
|
|
674
807
|
* <li>
|
|
675
808
|
* <p>
|
|
676
|
-
* <code>ApproximateNumberOfMessagesNotVisible</code> – Returns the
|
|
677
|
-
* number of messages that are in flight. Messages are considered to be
|
|
809
|
+
* <code>ApproximateNumberOfMessagesNotVisible</code> – Returns the
|
|
810
|
+
* approximate number of messages that are in flight. Messages are considered to be
|
|
678
811
|
* <i>in flight</i> if they have been sent to a client but have
|
|
679
|
-
* not yet been deleted or have not yet reached the end of their visibility window.
|
|
812
|
+
* not yet been deleted or have not yet reached the end of their visibility window.
|
|
813
|
+
* </p>
|
|
680
814
|
* </li>
|
|
681
815
|
* <li>
|
|
682
816
|
* <p>
|
|
683
|
-
* <code>CreatedTimestamp</code> – Returns the time when the queue was
|
|
684
|
-
* seconds (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch
|
|
685
|
-
*
|
|
817
|
+
* <code>CreatedTimestamp</code> – Returns the time when the queue was
|
|
818
|
+
* created in seconds (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch
|
|
819
|
+
* time</a>).</p>
|
|
686
820
|
* </li>
|
|
687
821
|
* <li>
|
|
688
822
|
* <p>
|
|
@@ -691,19 +825,24 @@ export interface GetQueueAttributesRequest {
|
|
|
691
825
|
* </li>
|
|
692
826
|
* <li>
|
|
693
827
|
* <p>
|
|
694
|
-
* <code>LastModifiedTimestamp</code> – Returns the time when the queue
|
|
695
|
-
* changed in seconds (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch
|
|
696
|
-
* time</a>).</p>
|
|
828
|
+
* <code>LastModifiedTimestamp</code> – Returns the time when the queue
|
|
829
|
+
* was last changed in seconds (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a>).</p>
|
|
697
830
|
* </li>
|
|
698
831
|
* <li>
|
|
699
832
|
* <p>
|
|
700
|
-
* <code>MaximumMessageSize</code> – Returns the limit of how many bytes a
|
|
701
|
-
* can contain before Amazon SQS rejects it.</p>
|
|
833
|
+
* <code>MaximumMessageSize</code> – Returns the limit of how many bytes a
|
|
834
|
+
* message can contain before Amazon SQS rejects it.</p>
|
|
702
835
|
* </li>
|
|
703
836
|
* <li>
|
|
704
837
|
* <p>
|
|
705
|
-
* <code>MessageRetentionPeriod</code> – Returns the length of time, in
|
|
706
|
-
* for which Amazon SQS retains a message
|
|
838
|
+
* <code>MessageRetentionPeriod</code> – Returns the length of time, in
|
|
839
|
+
* seconds, for which Amazon SQS retains a message. When you change a queue's
|
|
840
|
+
* attributes, the change can take up to 60 seconds for most of the attributes to
|
|
841
|
+
* propagate throughout the Amazon SQS system. Changes made to the
|
|
842
|
+
* <code>MessageRetentionPeriod</code> attribute can take up to 15 minutes and
|
|
843
|
+
* will impact existing messages in the queue potentially causing them to be
|
|
844
|
+
* expired and deleted if the <code>MessageRetentionPeriod</code> is reduced below
|
|
845
|
+
* the age of existing messages.</p>
|
|
707
846
|
* </li>
|
|
708
847
|
* <li>
|
|
709
848
|
* <p>
|
|
@@ -716,64 +855,119 @@ export interface GetQueueAttributesRequest {
|
|
|
716
855
|
* </li>
|
|
717
856
|
* <li>
|
|
718
857
|
* <p>
|
|
719
|
-
* <code>ReceiveMessageWaitTimeSeconds</code> – Returns the length of
|
|
720
|
-
* seconds, for which the <code>ReceiveMessage</code> action waits for a
|
|
721
|
-
* arrive. </p>
|
|
858
|
+
* <code>ReceiveMessageWaitTimeSeconds</code> – Returns the length of
|
|
859
|
+
* time, in seconds, for which the <code>ReceiveMessage</code> action waits for a
|
|
860
|
+
* message to arrive. </p>
|
|
861
|
+
* </li>
|
|
862
|
+
* <li>
|
|
863
|
+
* <p>
|
|
864
|
+
* <code>VisibilityTimeout</code> – Returns the visibility timeout for the
|
|
865
|
+
* queue. For more information about the visibility timeout, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility Timeout</a> in the <i>Amazon SQS Developer
|
|
866
|
+
* Guide</i>. </p>
|
|
722
867
|
* </li>
|
|
868
|
+
* </ul>
|
|
869
|
+
* <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">dead-letter queues:</a>
|
|
870
|
+
* </p>
|
|
871
|
+
* <ul>
|
|
723
872
|
* <li>
|
|
724
873
|
* <p>
|
|
725
874
|
* <code>RedrivePolicy</code> – The string that includes the parameters for the dead-letter queue functionality
|
|
726
|
-
*
|
|
727
|
-
* in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
875
|
+
* of the source queue as a JSON object. The parameters are as follows:</p>
|
|
728
876
|
* <ul>
|
|
729
877
|
* <li>
|
|
730
878
|
* <p>
|
|
731
|
-
* <code>deadLetterTargetArn</code> – The Amazon Resource Name (ARN) of the dead-letter queue to
|
|
879
|
+
* <code>deadLetterTargetArn</code> – The Amazon Resource Name (ARN) of the dead-letter queue to
|
|
880
|
+
* which Amazon SQS moves messages after the value of <code>maxReceiveCount</code> is exceeded.</p>
|
|
732
881
|
* </li>
|
|
733
882
|
* <li>
|
|
734
883
|
* <p>
|
|
735
|
-
* <code>maxReceiveCount</code> – The number of times a message is delivered to the source queue before being
|
|
736
|
-
*
|
|
884
|
+
* <code>maxReceiveCount</code> – The number of times a message is delivered to the source queue before being
|
|
885
|
+
* moved to the dead-letter queue. Default: 10. When the <code>ReceiveCount</code> for a message exceeds the <code>maxReceiveCount</code>
|
|
886
|
+
* for a queue, Amazon SQS moves the message to the dead-letter-queue.</p>
|
|
737
887
|
* </li>
|
|
738
888
|
* </ul>
|
|
739
889
|
* </li>
|
|
740
890
|
* <li>
|
|
741
891
|
* <p>
|
|
742
|
-
* <code>
|
|
743
|
-
*
|
|
892
|
+
* <code>RedriveAllowPolicy</code> – The string that includes the parameters for the permissions for the dead-letter
|
|
893
|
+
* queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:</p>
|
|
894
|
+
* <ul>
|
|
895
|
+
* <li>
|
|
896
|
+
* <p>
|
|
897
|
+
* <code>redrivePermission</code> – The permission type that defines which source queues can
|
|
898
|
+
* specify the current queue as the dead-letter queue. Valid values are:</p>
|
|
899
|
+
* <ul>
|
|
900
|
+
* <li>
|
|
901
|
+
* <p>
|
|
902
|
+
* <code>allowAll</code> – (Default) Any source queues in this Amazon Web Services account in the same Region can
|
|
903
|
+
* specify this queue as the dead-letter queue.</p>
|
|
904
|
+
* </li>
|
|
905
|
+
* <li>
|
|
906
|
+
* <p>
|
|
907
|
+
* <code>denyAll</code> – No source queues can specify this queue as the dead-letter
|
|
908
|
+
* queue.</p>
|
|
909
|
+
* </li>
|
|
910
|
+
* <li>
|
|
911
|
+
* <p>
|
|
912
|
+
* <code>byQueue</code> – Only queues specified by the <code>sourceQueueArns</code> parameter can specify
|
|
913
|
+
* this queue as the dead-letter queue.</p>
|
|
914
|
+
* </li>
|
|
915
|
+
* </ul>
|
|
916
|
+
* </li>
|
|
917
|
+
* <li>
|
|
918
|
+
* <p>
|
|
919
|
+
* <code>sourceQueueArns</code> – The Amazon Resource Names (ARN)s of the source queues that can specify
|
|
920
|
+
* this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the
|
|
921
|
+
* <code>redrivePermission</code> parameter is set to <code>byQueue</code>. You can specify up to 10 source queue ARNs.
|
|
922
|
+
* To allow more than 10 source queues to specify dead-letter queues, set the <code>redrivePermission</code> parameter
|
|
923
|
+
* to <code>allowAll</code>.</p>
|
|
924
|
+
* </li>
|
|
925
|
+
* </ul>
|
|
744
926
|
* </li>
|
|
745
927
|
* </ul>
|
|
928
|
+
* <note>
|
|
929
|
+
* <p>The dead-letter queue of a
|
|
930
|
+
* FIFO queue must also be a FIFO queue. Similarly, the dead-letter
|
|
931
|
+
* queue of a standard queue must also be a standard queue.</p>
|
|
932
|
+
* </note>
|
|
746
933
|
* <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>
|
|
747
934
|
* <ul>
|
|
748
935
|
* <li>
|
|
749
936
|
* <p>
|
|
750
|
-
* <code>KmsMasterKeyId</code> – Returns the ID of an Amazon Web Services managed customer
|
|
751
|
-
*
|
|
937
|
+
* <code>KmsMasterKeyId</code> – Returns the ID of an Amazon Web Services managed customer
|
|
938
|
+
* master key (CMK) for Amazon SQS or a custom CMK. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key Terms</a>. </p>
|
|
752
939
|
* </li>
|
|
753
940
|
* <li>
|
|
754
941
|
* <p>
|
|
755
|
-
* <code>KmsDataKeyReusePeriodSeconds</code> – Returns the length of time,
|
|
756
|
-
*
|
|
757
|
-
*
|
|
942
|
+
* <code>KmsDataKeyReusePeriodSeconds</code> – Returns the length of time,
|
|
943
|
+
* in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt
|
|
944
|
+
* messages before calling KMS again. For more information, see
|
|
945
|
+
* <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>
|
|
758
946
|
* </li>
|
|
759
947
|
* <li>
|
|
760
948
|
* <p>
|
|
761
|
-
* <code>SqsManagedSseEnabled</code> – Returns information about whether the
|
|
949
|
+
* <code>SqsManagedSseEnabled</code> – Returns information about whether the
|
|
950
|
+
* queue is using SSE-SQS encryption using SQS owned encryption keys. Only one
|
|
951
|
+
* 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>
|
|
762
952
|
* </li>
|
|
763
953
|
* </ul>
|
|
764
|
-
* <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO (first-in-first-out)
|
|
954
|
+
* <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO (first-in-first-out)
|
|
955
|
+
* queues</a>:</p>
|
|
765
956
|
* <ul>
|
|
766
957
|
* <li>
|
|
767
958
|
* <p>
|
|
768
|
-
* <code>FifoQueue</code> – Returns information about whether the queue is
|
|
959
|
+
* <code>FifoQueue</code> – Returns information about whether the queue is
|
|
960
|
+
* FIFO. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html">FIFO queue logic</a> in the <i>Amazon SQS Developer
|
|
961
|
+
* Guide</i>.</p>
|
|
769
962
|
* <note>
|
|
770
963
|
* <p>To determine whether a queue is <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO</a>, you can check whether <code>QueueName</code> ends with the <code>.fifo</code> suffix.</p>
|
|
771
964
|
* </note>
|
|
772
965
|
* </li>
|
|
773
966
|
* <li>
|
|
774
967
|
* <p>
|
|
775
|
-
* <code>ContentBasedDeduplication</code> – Returns whether content-based
|
|
776
|
-
*
|
|
968
|
+
* <code>ContentBasedDeduplication</code> – Returns whether content-based
|
|
969
|
+
* deduplication is enabled for the queue. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html">Exactly-once processing</a> in the <i>Amazon SQS Developer
|
|
970
|
+
* Guide</i>. </p>
|
|
777
971
|
* </li>
|
|
778
972
|
* </ul>
|
|
779
973
|
* <p>The following attributes apply only to
|
|
@@ -837,7 +1031,9 @@ export declare class InvalidAttributeName extends __BaseException {
|
|
|
837
1031
|
*/
|
|
838
1032
|
export interface GetQueueUrlRequest {
|
|
839
1033
|
/**
|
|
840
|
-
* <p>The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values:
|
|
1034
|
+
* <p>The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values:
|
|
1035
|
+
* alphanumeric characters, hyphens (<code>-</code>), and underscores
|
|
1036
|
+
* (<code>_</code>).</p>
|
|
841
1037
|
* <p>Queue URLs and names are case-sensitive.</p>
|
|
842
1038
|
*/
|
|
843
1039
|
QueueName: string | undefined;
|
|
@@ -848,7 +1044,8 @@ export interface GetQueueUrlRequest {
|
|
|
848
1044
|
}
|
|
849
1045
|
/**
|
|
850
1046
|
* @public
|
|
851
|
-
* <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
|
|
1047
|
+
* <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
|
|
1048
|
+
* Guide</i>.</p>
|
|
852
1049
|
*/
|
|
853
1050
|
export interface GetQueueUrlResult {
|
|
854
1051
|
/**
|
|
@@ -883,8 +1080,9 @@ export interface ListDeadLetterSourceQueuesRequest {
|
|
|
883
1080
|
*/
|
|
884
1081
|
NextToken?: string;
|
|
885
1082
|
/**
|
|
886
|
-
* <p>Maximum number of results to include in the response. Value range is 1 to 1000.
|
|
887
|
-
*
|
|
1083
|
+
* <p>Maximum number of results to include in the response. Value range is 1 to 1000. You
|
|
1084
|
+
* must set <code>MaxResults</code> to receive a value for <code>NextToken</code> in the
|
|
1085
|
+
* response.</p>
|
|
888
1086
|
*/
|
|
889
1087
|
MaxResults?: number;
|
|
890
1088
|
}
|
|
@@ -894,22 +1092,100 @@ export interface ListDeadLetterSourceQueuesRequest {
|
|
|
894
1092
|
*/
|
|
895
1093
|
export interface ListDeadLetterSourceQueuesResult {
|
|
896
1094
|
/**
|
|
897
|
-
* <p>A list of source queue URLs that have the <code>RedrivePolicy</code> queue attribute
|
|
1095
|
+
* <p>A list of source queue URLs that have the <code>RedrivePolicy</code> queue attribute
|
|
1096
|
+
* configured with a dead-letter queue.</p>
|
|
898
1097
|
*/
|
|
899
1098
|
queueUrls: string[] | undefined;
|
|
900
1099
|
/**
|
|
901
|
-
* <p>Pagination token to include in the next request. Token value is <code>null</code> if
|
|
902
|
-
*
|
|
1100
|
+
* <p>Pagination token to include in the next request. Token value is <code>null</code> if
|
|
1101
|
+
* there are no additional results to request, or if you did not set
|
|
1102
|
+
* <code>MaxResults</code> in the request.</p>
|
|
903
1103
|
*/
|
|
904
1104
|
NextToken?: string;
|
|
905
1105
|
}
|
|
1106
|
+
/**
|
|
1107
|
+
* @public
|
|
1108
|
+
*/
|
|
1109
|
+
export interface ListMessageMoveTasksRequest {
|
|
1110
|
+
/**
|
|
1111
|
+
* <p>The ARN of the queue whose message movement tasks are to be listed.</p>
|
|
1112
|
+
*/
|
|
1113
|
+
SourceArn: string | undefined;
|
|
1114
|
+
/**
|
|
1115
|
+
* <p>The maximum number of results to include in the response. The default is 1, which
|
|
1116
|
+
* provides the most recent message movement task. The upper limit is 10.</p>
|
|
1117
|
+
*/
|
|
1118
|
+
MaxResults?: number;
|
|
1119
|
+
}
|
|
1120
|
+
/**
|
|
1121
|
+
* @public
|
|
1122
|
+
* <p>Contains the details of a message movement task. </p>
|
|
1123
|
+
*/
|
|
1124
|
+
export interface ListMessageMoveTasksResultEntry {
|
|
1125
|
+
/**
|
|
1126
|
+
* <p>An identifier associated with a message movement task. When this field is returned in
|
|
1127
|
+
* the response of the <code>ListMessageMoveTasks</code> action, it is only populated for
|
|
1128
|
+
* tasks that are in RUNNING status.</p>
|
|
1129
|
+
*/
|
|
1130
|
+
TaskHandle?: string;
|
|
1131
|
+
/**
|
|
1132
|
+
* <p>The status of the message movement task. Possible values are: RUNNING, COMPLETED,
|
|
1133
|
+
* CANCELLING, CANCELLED, and FAILED.</p>
|
|
1134
|
+
*/
|
|
1135
|
+
Status?: string;
|
|
1136
|
+
/**
|
|
1137
|
+
* <p>The ARN of the queue that contains the messages to be moved to another queue.</p>
|
|
1138
|
+
*/
|
|
1139
|
+
SourceArn?: string;
|
|
1140
|
+
/**
|
|
1141
|
+
* <p>The ARN of the destination queue if it has been specified in the
|
|
1142
|
+
* <code>StartMessageMoveTask</code> request. If a <code>DestinationArn</code> has not
|
|
1143
|
+
* been specified in the <code>StartMessageMoveTask</code> request, this field value will
|
|
1144
|
+
* be NULL.</p>
|
|
1145
|
+
*/
|
|
1146
|
+
DestinationArn?: string;
|
|
1147
|
+
/**
|
|
1148
|
+
* <p>The number of messages to be moved per second (the message movement rate), if it has
|
|
1149
|
+
* been specified in the <code>StartMessageMoveTask</code> request. If a
|
|
1150
|
+
* <code>MaxNumberOfMessagesPerSecond</code> has not been specified in the
|
|
1151
|
+
* <code>StartMessageMoveTask</code> request, this field value will be NULL.</p>
|
|
1152
|
+
*/
|
|
1153
|
+
MaxNumberOfMessagesPerSecond?: number;
|
|
1154
|
+
/**
|
|
1155
|
+
* <p>The approximate number of messages already moved to the destination queue.</p>
|
|
1156
|
+
*/
|
|
1157
|
+
ApproximateNumberOfMessagesMoved?: number;
|
|
1158
|
+
/**
|
|
1159
|
+
* <p>The number of messages to be moved from the source queue. This number is obtained at
|
|
1160
|
+
* the time of starting the message movement task.</p>
|
|
1161
|
+
*/
|
|
1162
|
+
ApproximateNumberOfMessagesToMove?: number;
|
|
1163
|
+
/**
|
|
1164
|
+
* <p>The task failure reason (only included if the task status is FAILED).</p>
|
|
1165
|
+
*/
|
|
1166
|
+
FailureReason?: string;
|
|
1167
|
+
/**
|
|
1168
|
+
* <p>The timestamp of starting the message movement task.</p>
|
|
1169
|
+
*/
|
|
1170
|
+
StartedTimestamp?: number;
|
|
1171
|
+
}
|
|
1172
|
+
/**
|
|
1173
|
+
* @public
|
|
1174
|
+
*/
|
|
1175
|
+
export interface ListMessageMoveTasksResult {
|
|
1176
|
+
/**
|
|
1177
|
+
* <p>A list of message movement tasks and their attributes.</p>
|
|
1178
|
+
*/
|
|
1179
|
+
Results?: ListMessageMoveTasksResultEntry[];
|
|
1180
|
+
}
|
|
906
1181
|
/**
|
|
907
1182
|
* @public
|
|
908
1183
|
* <p></p>
|
|
909
1184
|
*/
|
|
910
1185
|
export interface ListQueuesRequest {
|
|
911
1186
|
/**
|
|
912
|
-
* <p>A string to use for filtering the list results. Only those queues whose name begins
|
|
1187
|
+
* <p>A string to use for filtering the list results. Only those queues whose name begins
|
|
1188
|
+
* with the specified string are returned.</p>
|
|
913
1189
|
* <p>Queue URLs and names are case-sensitive.</p>
|
|
914
1190
|
*/
|
|
915
1191
|
QueueNamePrefix?: string;
|
|
@@ -918,8 +1194,9 @@ export interface ListQueuesRequest {
|
|
|
918
1194
|
*/
|
|
919
1195
|
NextToken?: string;
|
|
920
1196
|
/**
|
|
921
|
-
* <p>Maximum number of results to include in the response. Value range is 1 to 1000.
|
|
922
|
-
*
|
|
1197
|
+
* <p>Maximum number of results to include in the response. Value range is 1 to 1000. You
|
|
1198
|
+
* must set <code>MaxResults</code> to receive a value for <code>NextToken</code> in the
|
|
1199
|
+
* response.</p>
|
|
923
1200
|
*/
|
|
924
1201
|
MaxResults?: number;
|
|
925
1202
|
}
|
|
@@ -929,12 +1206,14 @@ export interface ListQueuesRequest {
|
|
|
929
1206
|
*/
|
|
930
1207
|
export interface ListQueuesResult {
|
|
931
1208
|
/**
|
|
932
|
-
* <p>Pagination token to include in the next request. Token value is <code>null</code> if
|
|
933
|
-
*
|
|
1209
|
+
* <p>Pagination token to include in the next request. Token value is <code>null</code> if
|
|
1210
|
+
* there are no additional results to request, or if you did not set
|
|
1211
|
+
* <code>MaxResults</code> in the request.</p>
|
|
934
1212
|
*/
|
|
935
1213
|
NextToken?: string;
|
|
936
1214
|
/**
|
|
937
|
-
* <p>A list of queue URLs, up to 1,000 entries, or the value of MaxResults that you sent in
|
|
1215
|
+
* <p>A list of queue URLs, up to 1,000 entries, or the value of <code>MaxResults</code> that you sent in
|
|
1216
|
+
* the request.</p>
|
|
938
1217
|
*/
|
|
939
1218
|
QueueUrls?: string[];
|
|
940
1219
|
}
|
|
@@ -958,7 +1237,9 @@ export interface ListQueueTagsResult {
|
|
|
958
1237
|
}
|
|
959
1238
|
/**
|
|
960
1239
|
* @public
|
|
961
|
-
* <p>Indicates that the specified queue previously received a <code>PurgeQueue</code>
|
|
1240
|
+
* <p>Indicates that the specified queue previously received a <code>PurgeQueue</code>
|
|
1241
|
+
* request within the last 60 seconds (the time it can take to delete the messages in the
|
|
1242
|
+
* queue).</p>
|
|
962
1243
|
*/
|
|
963
1244
|
export declare class PurgeQueueInProgress extends __BaseException {
|
|
964
1245
|
readonly name: "PurgeQueueInProgress";
|
|
@@ -974,7 +1255,8 @@ export declare class PurgeQueueInProgress extends __BaseException {
|
|
|
974
1255
|
*/
|
|
975
1256
|
export interface PurgeQueueRequest {
|
|
976
1257
|
/**
|
|
977
|
-
* <p>The URL of the queue from which the <code>PurgeQueue</code> action deletes
|
|
1258
|
+
* <p>The URL of the queue from which the <code>PurgeQueue</code> action deletes
|
|
1259
|
+
* messages.</p>
|
|
978
1260
|
* <p>Queue URLs and names are case-sensitive.</p>
|
|
979
1261
|
*/
|
|
980
1262
|
QueueUrl: string | undefined;
|
|
@@ -990,8 +1272,8 @@ export interface ReceiveMessageRequest {
|
|
|
990
1272
|
*/
|
|
991
1273
|
QueueUrl: string | undefined;
|
|
992
1274
|
/**
|
|
993
|
-
* <p>A list of attributes that need to be returned along with each message. These
|
|
994
|
-
* include:</p>
|
|
1275
|
+
* <p>A list of attributes that need to be returned along with each message. These
|
|
1276
|
+
* attributes include:</p>
|
|
995
1277
|
* <ul>
|
|
996
1278
|
* <li>
|
|
997
1279
|
* <p>
|
|
@@ -999,16 +1281,19 @@ export interface ReceiveMessageRequest {
|
|
|
999
1281
|
* </li>
|
|
1000
1282
|
* <li>
|
|
1001
1283
|
* <p>
|
|
1002
|
-
* <code>ApproximateFirstReceiveTimestamp</code> – Returns the time the
|
|
1284
|
+
* <code>ApproximateFirstReceiveTimestamp</code> – Returns the time the
|
|
1285
|
+
* message was first received from the queue (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a> in
|
|
1286
|
+
* milliseconds).</p>
|
|
1003
1287
|
* </li>
|
|
1004
1288
|
* <li>
|
|
1005
1289
|
* <p>
|
|
1006
|
-
* <code>ApproximateReceiveCount</code> – Returns the number of times a
|
|
1290
|
+
* <code>ApproximateReceiveCount</code> – Returns the number of times a
|
|
1291
|
+
* message has been received across all queues but not deleted.</p>
|
|
1007
1292
|
* </li>
|
|
1008
1293
|
* <li>
|
|
1009
1294
|
* <p>
|
|
1010
|
-
* <code>AWSTraceHeader</code> – Returns the X-Ray trace
|
|
1011
|
-
*
|
|
1295
|
+
* <code>AWSTraceHeader</code> – Returns the X-Ray trace
|
|
1296
|
+
* header string. </p>
|
|
1012
1297
|
* </li>
|
|
1013
1298
|
* <li>
|
|
1014
1299
|
* <p>
|
|
@@ -1016,20 +1301,26 @@ export interface ReceiveMessageRequest {
|
|
|
1016
1301
|
* </p>
|
|
1017
1302
|
* <ul>
|
|
1018
1303
|
* <li>
|
|
1019
|
-
* <p>For
|
|
1304
|
+
* <p>For a user, returns the user ID, for example
|
|
1305
|
+
* <code>ABCDEFGHI1JKLMNOPQ23R</code>.</p>
|
|
1020
1306
|
* </li>
|
|
1021
1307
|
* <li>
|
|
1022
|
-
* <p>For an IAM role, returns the IAM role ID, for example
|
|
1308
|
+
* <p>For an IAM role, returns the IAM role ID, for example
|
|
1309
|
+
* <code>ABCDE1F2GH3I4JK5LMNOP:i-a123b456</code>.</p>
|
|
1023
1310
|
* </li>
|
|
1024
1311
|
* </ul>
|
|
1025
1312
|
* </li>
|
|
1026
1313
|
* <li>
|
|
1027
1314
|
* <p>
|
|
1028
|
-
* <code>SentTimestamp</code> – Returns the time the message was sent to the
|
|
1315
|
+
* <code>SentTimestamp</code> – Returns the time the message was sent to the
|
|
1316
|
+
* queue (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a> in
|
|
1317
|
+
* milliseconds).</p>
|
|
1029
1318
|
* </li>
|
|
1030
1319
|
* <li>
|
|
1031
1320
|
* <p>
|
|
1032
|
-
* <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption
|
|
1321
|
+
* <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption
|
|
1322
|
+
* using SQS owned encryption keys. Only one server-side encryption option is
|
|
1323
|
+
* 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>
|
|
1033
1324
|
* </li>
|
|
1034
1325
|
* <li>
|
|
1035
1326
|
* <p>
|
|
@@ -1041,15 +1332,17 @@ export interface ReceiveMessageRequest {
|
|
|
1041
1332
|
* </li>
|
|
1042
1333
|
* <li>
|
|
1043
1334
|
* <p>
|
|
1044
|
-
* <code>MessageGroupId</code> – Returns the value provided by the
|
|
1045
|
-
* calls the <code>
|
|
1335
|
+
* <code>MessageGroupId</code> – Returns the value provided by the
|
|
1336
|
+
* producer that calls the <code>
|
|
1046
1337
|
* <a>SendMessage</a>
|
|
1047
|
-
* </code> action.
|
|
1048
|
-
* same <code>MessageGroupId</code> are returned in
|
|
1338
|
+
* </code> action.
|
|
1339
|
+
* Messages with the same <code>MessageGroupId</code> are returned in
|
|
1340
|
+
* sequence.</p>
|
|
1049
1341
|
* </li>
|
|
1050
1342
|
* <li>
|
|
1051
1343
|
* <p>
|
|
1052
|
-
* <code>SequenceNumber</code> – Returns the value provided by
|
|
1344
|
+
* <code>SequenceNumber</code> – Returns the value provided by
|
|
1345
|
+
* Amazon SQS.</p>
|
|
1053
1346
|
* </li>
|
|
1054
1347
|
* </ul>
|
|
1055
1348
|
*/
|
|
@@ -1058,65 +1351,89 @@ export interface ReceiveMessageRequest {
|
|
|
1058
1351
|
* <p>The name of the message attribute, where <i>N</i> is the index.</p>
|
|
1059
1352
|
* <ul>
|
|
1060
1353
|
* <li>
|
|
1061
|
-
* <p>The name can contain alphanumeric characters and the underscore
|
|
1354
|
+
* <p>The name can contain alphanumeric characters and the underscore
|
|
1355
|
+
* (<code>_</code>), hyphen (<code>-</code>), and period
|
|
1356
|
+
* (<code>.</code>).</p>
|
|
1062
1357
|
* </li>
|
|
1063
1358
|
* <li>
|
|
1064
|
-
* <p>The name is case-sensitive and must be unique among all attribute names for
|
|
1359
|
+
* <p>The name is case-sensitive and must be unique among all attribute names for
|
|
1360
|
+
* the message.</p>
|
|
1065
1361
|
* </li>
|
|
1066
1362
|
* <li>
|
|
1067
|
-
* <p>The name must not start with AWS-reserved prefixes such as <code>AWS.</code>
|
|
1363
|
+
* <p>The name must not start with AWS-reserved prefixes such as <code>AWS.</code>
|
|
1364
|
+
* or <code>Amazon.</code> (or any casing variants).</p>
|
|
1068
1365
|
* </li>
|
|
1069
1366
|
* <li>
|
|
1070
|
-
* <p>The name must not start or end with a period (<code>.</code>), and it should
|
|
1367
|
+
* <p>The name must not start or end with a period (<code>.</code>), and it should
|
|
1368
|
+
* not have periods in succession (<code>..</code>).</p>
|
|
1071
1369
|
* </li>
|
|
1072
1370
|
* <li>
|
|
1073
1371
|
* <p>The name can be up to 256 characters long.</p>
|
|
1074
1372
|
* </li>
|
|
1075
1373
|
* </ul>
|
|
1076
|
-
* <p>When using <code>ReceiveMessage</code>, you can send a list of attribute names to
|
|
1077
|
-
*
|
|
1374
|
+
* <p>When using <code>ReceiveMessage</code>, you can send a list of attribute names to
|
|
1375
|
+
* receive, or you can return all of the attributes by specifying <code>All</code> or
|
|
1376
|
+
* <code>.*</code> in your request. You can also use all message attributes starting
|
|
1377
|
+
* with a prefix, for example <code>bar.*</code>.</p>
|
|
1078
1378
|
*/
|
|
1079
1379
|
MessageAttributeNames?: string[];
|
|
1080
1380
|
/**
|
|
1081
|
-
* <p>The maximum number of messages to return. Amazon SQS never returns more messages than this
|
|
1381
|
+
* <p>The maximum number of messages to return. Amazon SQS never returns more messages than this
|
|
1382
|
+
* value (however, fewer messages might be returned). Valid values: 1 to 10. Default:
|
|
1383
|
+
* 1.</p>
|
|
1082
1384
|
*/
|
|
1083
1385
|
MaxNumberOfMessages?: number;
|
|
1084
1386
|
/**
|
|
1085
|
-
* <p>The duration (in seconds) that the received messages are hidden from subsequent
|
|
1387
|
+
* <p>The duration (in seconds) that the received messages are hidden from subsequent
|
|
1388
|
+
* retrieve requests after being retrieved by a <code>ReceiveMessage</code> request.</p>
|
|
1086
1389
|
*/
|
|
1087
1390
|
VisibilityTimeout?: number;
|
|
1088
1391
|
/**
|
|
1089
|
-
* <p>The duration (in seconds) for which the call waits for a message to arrive in the
|
|
1090
|
-
*
|
|
1392
|
+
* <p>The duration (in seconds) for which the call waits for a message to arrive in the
|
|
1393
|
+
* queue before returning. If a message is available, the call returns sooner than
|
|
1394
|
+
* <code>WaitTimeSeconds</code>. If no messages are available and the wait time
|
|
1395
|
+
* expires, the call returns successfully with an empty list of messages.</p>
|
|
1091
1396
|
* <important>
|
|
1092
|
-
* <p>To avoid HTTP errors, ensure that the HTTP response timeout for
|
|
1093
|
-
*
|
|
1094
|
-
*
|
|
1397
|
+
* <p>To avoid HTTP errors, ensure that the HTTP response timeout for
|
|
1398
|
+
* <code>ReceiveMessage</code> requests is longer than the
|
|
1399
|
+
* <code>WaitTimeSeconds</code> parameter. For example, with the Java SDK, you can
|
|
1400
|
+
* set HTTP transport settings using the <a href="https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/nio/netty/NettyNioAsyncHttpClient.html"> NettyNioAsyncHttpClient</a> for asynchronous clients, or the <a href="https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.html"> ApacheHttpClient</a> for synchronous clients. </p>
|
|
1095
1401
|
* </important>
|
|
1096
1402
|
*/
|
|
1097
1403
|
WaitTimeSeconds?: number;
|
|
1098
1404
|
/**
|
|
1099
1405
|
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
|
|
1100
|
-
* <p>The token used for deduplication of <code>ReceiveMessage</code> calls. If a networking
|
|
1101
|
-
*
|
|
1406
|
+
* <p>The token used for deduplication of <code>ReceiveMessage</code> calls. If a networking
|
|
1407
|
+
* issue occurs after a <code>ReceiveMessage</code> action, and instead of a response you
|
|
1408
|
+
* receive a generic error, it is possible to retry the same action with an identical
|
|
1409
|
+
* <code>ReceiveRequestAttemptId</code> to retrieve the same set of messages, even if
|
|
1410
|
+
* their visibility timeout has not yet expired.</p>
|
|
1102
1411
|
* <ul>
|
|
1103
1412
|
* <li>
|
|
1104
|
-
* <p>You can use <code>ReceiveRequestAttemptId</code> only for 5 minutes after a
|
|
1413
|
+
* <p>You can use <code>ReceiveRequestAttemptId</code> only for 5 minutes after a
|
|
1414
|
+
* <code>ReceiveMessage</code> action.</p>
|
|
1105
1415
|
* </li>
|
|
1106
1416
|
* <li>
|
|
1107
|
-
* <p>When you set <code>FifoQueue</code>, a caller of the
|
|
1417
|
+
* <p>When you set <code>FifoQueue</code>, a caller of the
|
|
1418
|
+
* <code>ReceiveMessage</code> action can provide a
|
|
1419
|
+
* <code>ReceiveRequestAttemptId</code> explicitly.</p>
|
|
1108
1420
|
* </li>
|
|
1109
1421
|
* <li>
|
|
1110
|
-
* <p>If a caller of the <code>ReceiveMessage</code> action doesn't provide a
|
|
1422
|
+
* <p>If a caller of the <code>ReceiveMessage</code> action doesn't provide a
|
|
1423
|
+
* <code>ReceiveRequestAttemptId</code>, Amazon SQS generates a
|
|
1424
|
+
* <code>ReceiveRequestAttemptId</code>.</p>
|
|
1111
1425
|
* </li>
|
|
1112
1426
|
* <li>
|
|
1113
|
-
* <p>It is possible to retry the <code>ReceiveMessage</code> action with the same
|
|
1427
|
+
* <p>It is possible to retry the <code>ReceiveMessage</code> action with the same
|
|
1428
|
+
* <code>ReceiveRequestAttemptId</code> if none of the messages have been
|
|
1429
|
+
* modified (deleted or had their visibility changes).</p>
|
|
1114
1430
|
* </li>
|
|
1115
1431
|
* <li>
|
|
1116
|
-
* <p>During a visibility timeout, subsequent calls with the same
|
|
1117
|
-
*
|
|
1118
|
-
*
|
|
1119
|
-
*
|
|
1432
|
+
* <p>During a visibility timeout, subsequent calls with the same
|
|
1433
|
+
* <code>ReceiveRequestAttemptId</code> return the same messages and receipt
|
|
1434
|
+
* handles. If a retry occurs within the deduplication interval, it resets the
|
|
1435
|
+
* visibility timeout. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility Timeout</a> in the <i>Amazon SQS Developer
|
|
1436
|
+
* Guide</i>.</p>
|
|
1120
1437
|
* <important>
|
|
1121
1438
|
* <p>If a caller of the <code>ReceiveMessage</code> action still processes
|
|
1122
1439
|
* messages when the visibility timeout expires and messages become visible,
|
|
@@ -1124,23 +1441,30 @@ export interface ReceiveMessageRequest {
|
|
|
1124
1441
|
* and therefore process duplicates. Also, if a consumer whose message
|
|
1125
1442
|
* processing time is longer than the visibility timeout tries to delete the
|
|
1126
1443
|
* processed messages, the action fails with an error.</p>
|
|
1127
|
-
* <p>To mitigate this effect, ensure that your application observes a safe
|
|
1444
|
+
* <p>To mitigate this effect, ensure that your application observes a safe
|
|
1445
|
+
* threshold before the visibility timeout expires and extend the visibility
|
|
1446
|
+
* timeout as necessary.</p>
|
|
1128
1447
|
* </important>
|
|
1129
1448
|
* </li>
|
|
1130
1449
|
* <li>
|
|
1131
|
-
* <p>While messages with a particular <code>MessageGroupId</code> are invisible, no
|
|
1132
|
-
*
|
|
1450
|
+
* <p>While messages with a particular <code>MessageGroupId</code> are invisible, no
|
|
1451
|
+
* more messages belonging to the same <code>MessageGroupId</code> are returned
|
|
1452
|
+
* until the visibility timeout expires. You can still receive messages with
|
|
1453
|
+
* another <code>MessageGroupId</code> as long as it is also visible.</p>
|
|
1133
1454
|
* </li>
|
|
1134
1455
|
* <li>
|
|
1135
|
-
* <p>If a caller of <code>ReceiveMessage</code> can't track the
|
|
1136
|
-
*
|
|
1456
|
+
* <p>If a caller of <code>ReceiveMessage</code> can't track the
|
|
1457
|
+
* <code>ReceiveRequestAttemptId</code>, no retries work until the original
|
|
1458
|
+
* visibility timeout expires. As a result, delays might occur but the messages in
|
|
1459
|
+
* the queue remain in a strict order.</p>
|
|
1137
1460
|
* </li>
|
|
1138
1461
|
* </ul>
|
|
1139
|
-
* <p>The maximum length of <code>ReceiveRequestAttemptId</code> is 128 characters.
|
|
1140
|
-
*
|
|
1141
|
-
*
|
|
1142
|
-
*
|
|
1143
|
-
*
|
|
1462
|
+
* <p>The maximum length of <code>ReceiveRequestAttemptId</code> is 128 characters.
|
|
1463
|
+
* <code>ReceiveRequestAttemptId</code> can contain alphanumeric characters
|
|
1464
|
+
* (<code>a-z</code>, <code>A-Z</code>, <code>0-9</code>) and punctuation
|
|
1465
|
+
* (<code>!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~</code>).</p>
|
|
1466
|
+
* <p>For best practices of using <code>ReceiveRequestAttemptId</code>, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-receiverequestattemptid-request-parameter.html">Using the ReceiveRequestAttemptId Request Parameter</a> in the <i>Amazon SQS
|
|
1467
|
+
* Developer Guide</i>.</p>
|
|
1144
1468
|
*/
|
|
1145
1469
|
ReceiveRequestAttemptId?: string;
|
|
1146
1470
|
}
|
|
@@ -1152,6 +1476,7 @@ export declare const MessageSystemAttributeName: {
|
|
|
1152
1476
|
readonly AWSTraceHeader: "AWSTraceHeader";
|
|
1153
1477
|
readonly ApproximateFirstReceiveTimestamp: "ApproximateFirstReceiveTimestamp";
|
|
1154
1478
|
readonly ApproximateReceiveCount: "ApproximateReceiveCount";
|
|
1479
|
+
readonly DeadLetterQueueSourceArn: "DeadLetterQueueSourceArn";
|
|
1155
1480
|
readonly MessageDeduplicationId: "MessageDeduplicationId";
|
|
1156
1481
|
readonly MessageGroupId: "MessageGroupId";
|
|
1157
1482
|
readonly SenderId: "SenderId";
|
|
@@ -1164,19 +1489,26 @@ export declare const MessageSystemAttributeName: {
|
|
|
1164
1489
|
export type MessageSystemAttributeName = (typeof MessageSystemAttributeName)[keyof typeof MessageSystemAttributeName];
|
|
1165
1490
|
/**
|
|
1166
1491
|
* @public
|
|
1167
|
-
* <p>The user-specified message attribute value. For string data types, the
|
|
1492
|
+
* <p>The user-specified message attribute value. For string data types, the
|
|
1493
|
+
* <code>Value</code> attribute has the same restrictions on the content as the message
|
|
1494
|
+
* body. For more information, see <code>
|
|
1168
1495
|
* <a>SendMessage</a>.</code>
|
|
1169
1496
|
* </p>
|
|
1170
1497
|
* <p>
|
|
1171
|
-
* <code>Name</code>, <code>type</code>, <code>value</code> and the message body must not
|
|
1498
|
+
* <code>Name</code>, <code>type</code>, <code>value</code> and the message body must not
|
|
1499
|
+
* be empty or null. All parts of the message attribute, including <code>Name</code>,
|
|
1500
|
+
* <code>Type</code>, and <code>Value</code>, are part of the message size restriction
|
|
1501
|
+
* (256 KiB or 262,144 bytes).</p>
|
|
1172
1502
|
*/
|
|
1173
1503
|
export interface MessageAttributeValue {
|
|
1174
1504
|
/**
|
|
1175
|
-
* <p>Strings are Unicode with UTF-8 binary encoding. For a list of code values, see <a href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters">ASCII Printable
|
|
1505
|
+
* <p>Strings are Unicode with UTF-8 binary encoding. For a list of code values, see <a href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters">ASCII Printable
|
|
1506
|
+
* Characters</a>.</p>
|
|
1176
1507
|
*/
|
|
1177
1508
|
StringValue?: string;
|
|
1178
1509
|
/**
|
|
1179
|
-
* <p>Binary type attributes can store any binary data, such as compressed data, encrypted
|
|
1510
|
+
* <p>Binary type attributes can store any binary data, such as compressed data, encrypted
|
|
1511
|
+
* data, or images.</p>
|
|
1180
1512
|
*/
|
|
1181
1513
|
BinaryValue?: Uint8Array;
|
|
1182
1514
|
/**
|
|
@@ -1188,8 +1520,11 @@ export interface MessageAttributeValue {
|
|
|
1188
1520
|
*/
|
|
1189
1521
|
BinaryListValues?: Uint8Array[];
|
|
1190
1522
|
/**
|
|
1191
|
-
* <p>Amazon SQS supports the following logical data types: <code>String</code>,
|
|
1192
|
-
*
|
|
1523
|
+
* <p>Amazon SQS supports the following logical data types: <code>String</code>,
|
|
1524
|
+
* <code>Number</code>, and <code>Binary</code>. For the <code>Number</code> data type,
|
|
1525
|
+
* you must use <code>StringValue</code>.</p>
|
|
1526
|
+
* <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
|
|
1527
|
+
* Guide</i>.</p>
|
|
1193
1528
|
*/
|
|
1194
1529
|
DataType: string | undefined;
|
|
1195
1530
|
}
|
|
@@ -1199,11 +1534,14 @@ export interface MessageAttributeValue {
|
|
|
1199
1534
|
*/
|
|
1200
1535
|
export interface Message {
|
|
1201
1536
|
/**
|
|
1202
|
-
* <p>A unique identifier for the message. A <code>MessageId</code>is considered unique
|
|
1537
|
+
* <p>A unique identifier for the message. A <code>MessageId</code>is considered unique
|
|
1538
|
+
* across all Amazon Web Services accounts for an extended period of time.</p>
|
|
1203
1539
|
*/
|
|
1204
1540
|
MessageId?: string;
|
|
1205
1541
|
/**
|
|
1206
|
-
* <p>An identifier associated with the act of receiving the message. A new receipt handle
|
|
1542
|
+
* <p>An identifier associated with the act of receiving the message. A new receipt handle
|
|
1543
|
+
* is returned every time you receive a message. When deleting a message, you provide the
|
|
1544
|
+
* last received receipt handle to delete the message.</p>
|
|
1207
1545
|
*/
|
|
1208
1546
|
ReceiptHandle?: string;
|
|
1209
1547
|
/**
|
|
@@ -1217,8 +1555,8 @@ export interface Message {
|
|
|
1217
1555
|
/**
|
|
1218
1556
|
* <p>A map of the attributes requested in <code>
|
|
1219
1557
|
* <a>ReceiveMessage</a>
|
|
1220
|
-
* </code> to
|
|
1221
|
-
*
|
|
1558
|
+
* </code> to
|
|
1559
|
+
* their respective values. Supported attributes:</p>
|
|
1222
1560
|
* <ul>
|
|
1223
1561
|
* <li>
|
|
1224
1562
|
* <p>
|
|
@@ -1257,8 +1595,9 @@ export interface Message {
|
|
|
1257
1595
|
* </li>
|
|
1258
1596
|
* </ul>
|
|
1259
1597
|
* <p>
|
|
1260
|
-
* <code>ApproximateFirstReceiveTimestamp</code> and <code>SentTimestamp</code> are each
|
|
1261
|
-
*
|
|
1598
|
+
* <code>ApproximateFirstReceiveTimestamp</code> and <code>SentTimestamp</code> are each
|
|
1599
|
+
* returned as an integer representing the <a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a> in
|
|
1600
|
+
* milliseconds.</p>
|
|
1262
1601
|
*/
|
|
1263
1602
|
Attributes?: Record<string, string>;
|
|
1264
1603
|
/**
|
|
@@ -1294,7 +1633,8 @@ export interface RemovePermissionRequest {
|
|
|
1294
1633
|
*/
|
|
1295
1634
|
QueueUrl: string | undefined;
|
|
1296
1635
|
/**
|
|
1297
|
-
* <p>The identification of the permission to remove. This is the label added using the
|
|
1636
|
+
* <p>The identification of the permission to remove. This is the label added using the
|
|
1637
|
+
* <code>
|
|
1298
1638
|
* <a>AddPermission</a>
|
|
1299
1639
|
* </code> action.</p>
|
|
1300
1640
|
*/
|
|
@@ -1325,19 +1665,24 @@ export declare const MessageSystemAttributeNameForSends: {
|
|
|
1325
1665
|
export type MessageSystemAttributeNameForSends = (typeof MessageSystemAttributeNameForSends)[keyof typeof MessageSystemAttributeNameForSends];
|
|
1326
1666
|
/**
|
|
1327
1667
|
* @public
|
|
1328
|
-
* <p>The user-specified message system attribute value. For string data types, the
|
|
1668
|
+
* <p>The user-specified message system attribute value. For string data types, the
|
|
1669
|
+
* <code>Value</code> attribute has the same restrictions on the content as the message
|
|
1670
|
+
* body. For more information, see <code>
|
|
1329
1671
|
* <a>SendMessage</a>.</code>
|
|
1330
1672
|
* </p>
|
|
1331
1673
|
* <p>
|
|
1332
|
-
* <code>Name</code>, <code>type</code>, <code>value</code> and the message body must not
|
|
1674
|
+
* <code>Name</code>, <code>type</code>, <code>value</code> and the message body must not
|
|
1675
|
+
* be empty or null.</p>
|
|
1333
1676
|
*/
|
|
1334
1677
|
export interface MessageSystemAttributeValue {
|
|
1335
1678
|
/**
|
|
1336
|
-
* <p>Strings are Unicode with UTF-8 binary encoding. For a list of code values, see <a href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters">ASCII Printable
|
|
1679
|
+
* <p>Strings are Unicode with UTF-8 binary encoding. For a list of code values, see <a href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters">ASCII Printable
|
|
1680
|
+
* Characters</a>.</p>
|
|
1337
1681
|
*/
|
|
1338
1682
|
StringValue?: string;
|
|
1339
1683
|
/**
|
|
1340
|
-
* <p>Binary type attributes can store any binary data, such as compressed data, encrypted
|
|
1684
|
+
* <p>Binary type attributes can store any binary data, such as compressed data, encrypted
|
|
1685
|
+
* data, or images.</p>
|
|
1341
1686
|
*/
|
|
1342
1687
|
BinaryValue?: Uint8Array;
|
|
1343
1688
|
/**
|
|
@@ -1349,8 +1694,11 @@ export interface MessageSystemAttributeValue {
|
|
|
1349
1694
|
*/
|
|
1350
1695
|
BinaryListValues?: Uint8Array[];
|
|
1351
1696
|
/**
|
|
1352
|
-
* <p>Amazon SQS supports the following logical data types: <code>String</code>,
|
|
1353
|
-
*
|
|
1697
|
+
* <p>Amazon SQS supports the following logical data types: <code>String</code>,
|
|
1698
|
+
* <code>Number</code>, and <code>Binary</code>. For the <code>Number</code> data type,
|
|
1699
|
+
* you must use <code>StringValue</code>.</p>
|
|
1700
|
+
* <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
|
|
1701
|
+
* Guide</i>.</p>
|
|
1354
1702
|
*/
|
|
1355
1703
|
DataType: string | undefined;
|
|
1356
1704
|
}
|
|
@@ -1365,7 +1713,8 @@ export interface SendMessageRequest {
|
|
|
1365
1713
|
*/
|
|
1366
1714
|
QueueUrl: string | undefined;
|
|
1367
1715
|
/**
|
|
1368
|
-
* <p>The message to send. The minimum size is one character. The maximum size is 256
|
|
1716
|
+
* <p>The message to send. The minimum size is one character. The maximum size is 256
|
|
1717
|
+
* KiB.</p>
|
|
1369
1718
|
* <important>
|
|
1370
1719
|
* <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:</p>
|
|
1371
1720
|
* <p>
|
|
@@ -1376,10 +1725,10 @@ export interface SendMessageRequest {
|
|
|
1376
1725
|
*/
|
|
1377
1726
|
MessageBody: string | undefined;
|
|
1378
1727
|
/**
|
|
1379
|
-
* <p>
|
|
1380
|
-
*
|
|
1381
|
-
*
|
|
1382
|
-
*
|
|
1728
|
+
* <p> The length of time, in seconds, for which to delay a specific message. Valid values:
|
|
1729
|
+
* 0 to 900. Maximum: 15 minutes. Messages with a positive <code>DelaySeconds</code> value
|
|
1730
|
+
* become available for processing after the delay period is finished. If you don't specify
|
|
1731
|
+
* a value, the default value for the queue applies. </p>
|
|
1383
1732
|
* <note>
|
|
1384
1733
|
* <p>When you set <code>FifoQueue</code>, you can't set <code>DelaySeconds</code> per message. You can set this parameter only on a queue level.</p>
|
|
1385
1734
|
* </note>
|
|
@@ -1410,52 +1759,65 @@ export interface SendMessageRequest {
|
|
|
1410
1759
|
MessageSystemAttributes?: Record<string, MessageSystemAttributeValue>;
|
|
1411
1760
|
/**
|
|
1412
1761
|
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
|
|
1413
|
-
* <p>The token used for deduplication of sent messages. If a message with a particular
|
|
1414
|
-
*
|
|
1415
|
-
*
|
|
1762
|
+
* <p>The token used for deduplication of sent messages. If a message with a particular
|
|
1763
|
+
* <code>MessageDeduplicationId</code> is sent successfully, any messages sent with the
|
|
1764
|
+
* same <code>MessageDeduplicationId</code> are accepted successfully but aren't delivered
|
|
1765
|
+
* 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
|
|
1766
|
+
* Guide</i>.</p>
|
|
1416
1767
|
* <ul>
|
|
1417
1768
|
* <li>
|
|
1418
1769
|
* <p>Every message must have a unique <code>MessageDeduplicationId</code>,</p>
|
|
1419
1770
|
* <ul>
|
|
1420
1771
|
* <li>
|
|
1421
|
-
* <p>You may provide a <code>MessageDeduplicationId</code>
|
|
1772
|
+
* <p>You may provide a <code>MessageDeduplicationId</code>
|
|
1773
|
+
* explicitly.</p>
|
|
1422
1774
|
* </li>
|
|
1423
1775
|
* <li>
|
|
1424
|
-
* <p>If you aren't able to provide a <code>MessageDeduplicationId</code>
|
|
1425
|
-
*
|
|
1426
|
-
*
|
|
1776
|
+
* <p>If you aren't able to provide a <code>MessageDeduplicationId</code>
|
|
1777
|
+
* and you enable <code>ContentBasedDeduplication</code> for your queue,
|
|
1778
|
+
* Amazon SQS uses a SHA-256 hash to generate the
|
|
1779
|
+
* <code>MessageDeduplicationId</code> using the body of the message
|
|
1780
|
+
* (but not the attributes of the message). </p>
|
|
1427
1781
|
* </li>
|
|
1428
1782
|
* <li>
|
|
1429
|
-
* <p>If you don't provide a <code>MessageDeduplicationId</code> and the
|
|
1430
|
-
*
|
|
1783
|
+
* <p>If you don't provide a <code>MessageDeduplicationId</code> and the
|
|
1784
|
+
* queue doesn't have <code>ContentBasedDeduplication</code> set, the
|
|
1785
|
+
* action fails with an error.</p>
|
|
1431
1786
|
* </li>
|
|
1432
1787
|
* <li>
|
|
1433
|
-
* <p>If the queue has <code>ContentBasedDeduplication</code> set, your
|
|
1788
|
+
* <p>If the queue has <code>ContentBasedDeduplication</code> set, your
|
|
1789
|
+
* <code>MessageDeduplicationId</code> overrides the generated
|
|
1790
|
+
* one.</p>
|
|
1434
1791
|
* </li>
|
|
1435
1792
|
* </ul>
|
|
1436
1793
|
* </li>
|
|
1437
1794
|
* <li>
|
|
1438
|
-
* <p>When <code>ContentBasedDeduplication</code> is in effect, messages with
|
|
1439
|
-
*
|
|
1795
|
+
* <p>When <code>ContentBasedDeduplication</code> is in effect, messages with
|
|
1796
|
+
* identical content sent within the deduplication interval are treated as
|
|
1797
|
+
* duplicates and only one copy of the message is delivered.</p>
|
|
1440
1798
|
* </li>
|
|
1441
1799
|
* <li>
|
|
1442
|
-
* <p>If you send one message with <code>ContentBasedDeduplication</code> enabled
|
|
1443
|
-
*
|
|
1444
|
-
*
|
|
1800
|
+
* <p>If you send one message with <code>ContentBasedDeduplication</code> enabled
|
|
1801
|
+
* and then another message with a <code>MessageDeduplicationId</code> that is the
|
|
1802
|
+
* same as the one generated for the first <code>MessageDeduplicationId</code>, the
|
|
1803
|
+
* two messages are treated as duplicates and only one copy of the message is
|
|
1804
|
+
* delivered. </p>
|
|
1445
1805
|
* </li>
|
|
1446
1806
|
* </ul>
|
|
1447
1807
|
* <note>
|
|
1448
1808
|
* <p>The <code>MessageDeduplicationId</code> is available to the consumer of the
|
|
1449
1809
|
* message (this can be useful for troubleshooting delivery issues).</p>
|
|
1450
|
-
* <p>If a message is sent successfully but the acknowledgement is lost and the message
|
|
1451
|
-
*
|
|
1810
|
+
* <p>If a message is sent successfully but the acknowledgement is lost and the message
|
|
1811
|
+
* is resent with the same <code>MessageDeduplicationId</code> after the deduplication
|
|
1812
|
+
* interval, Amazon SQS can't detect duplicate messages.</p>
|
|
1452
1813
|
* <p>Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.</p>
|
|
1453
1814
|
* </note>
|
|
1454
|
-
* <p>The maximum length of <code>MessageDeduplicationId</code> is 128 characters.
|
|
1455
|
-
*
|
|
1456
|
-
*
|
|
1457
|
-
*
|
|
1458
|
-
*
|
|
1815
|
+
* <p>The maximum length of <code>MessageDeduplicationId</code> is 128 characters.
|
|
1816
|
+
* <code>MessageDeduplicationId</code> can contain alphanumeric characters
|
|
1817
|
+
* (<code>a-z</code>, <code>A-Z</code>, <code>0-9</code>) and punctuation
|
|
1818
|
+
* (<code>!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~</code>).</p>
|
|
1819
|
+
* <p>For best practices of using <code>MessageDeduplicationId</code>, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html">Using the MessageDeduplicationId Property</a> in the <i>Amazon SQS Developer
|
|
1820
|
+
* Guide</i>.</p>
|
|
1459
1821
|
*/
|
|
1460
1822
|
MessageDeduplicationId?: string;
|
|
1461
1823
|
/**
|
|
@@ -1469,21 +1831,26 @@ export interface SendMessageRequest {
|
|
|
1469
1831
|
* fashion.</p>
|
|
1470
1832
|
* <ul>
|
|
1471
1833
|
* <li>
|
|
1472
|
-
* <p>You must associate a non-empty <code>MessageGroupId</code> with a message. If
|
|
1834
|
+
* <p>You must associate a non-empty <code>MessageGroupId</code> with a message. If
|
|
1835
|
+
* you don't provide a <code>MessageGroupId</code>, the action fails.</p>
|
|
1473
1836
|
* </li>
|
|
1474
1837
|
* <li>
|
|
1475
1838
|
* <p>
|
|
1476
|
-
* <code>ReceiveMessage</code> might return messages with multiple
|
|
1477
|
-
*
|
|
1839
|
+
* <code>ReceiveMessage</code> might return messages with multiple
|
|
1840
|
+
* <code>MessageGroupId</code> values. For each <code>MessageGroupId</code>,
|
|
1841
|
+
* the messages are sorted by time sent. The caller can't specify a
|
|
1842
|
+
* <code>MessageGroupId</code>.</p>
|
|
1478
1843
|
* </li>
|
|
1479
1844
|
* </ul>
|
|
1480
|
-
* <p>The length of <code>MessageGroupId</code> is 128 characters. Valid values:
|
|
1481
|
-
*
|
|
1482
|
-
*
|
|
1483
|
-
*
|
|
1845
|
+
* <p>The length of <code>MessageGroupId</code> is 128 characters. Valid values:
|
|
1846
|
+
* alphanumeric characters and punctuation
|
|
1847
|
+
* <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~)</code>.</p>
|
|
1848
|
+
* <p>For best practices of using <code>MessageGroupId</code>, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html">Using the MessageGroupId Property</a> in the <i>Amazon SQS Developer
|
|
1849
|
+
* Guide</i>.</p>
|
|
1484
1850
|
* <important>
|
|
1485
1851
|
* <p>
|
|
1486
|
-
* <code>MessageGroupId</code> is required for FIFO queues. You can't use it for
|
|
1852
|
+
* <code>MessageGroupId</code> is required for FIFO queues. You can't use it for
|
|
1853
|
+
* Standard queues.</p>
|
|
1487
1854
|
* </important>
|
|
1488
1855
|
*/
|
|
1489
1856
|
MessageGroupId?: string;
|
|
@@ -1507,30 +1874,19 @@ export interface SendMessageResult {
|
|
|
1507
1874
|
*/
|
|
1508
1875
|
MD5OfMessageSystemAttributes?: string;
|
|
1509
1876
|
/**
|
|
1510
|
-
* <p>An attribute containing the <code>MessageId</code> of the message sent to the queue.
|
|
1511
|
-
* in the <i>Amazon SQS Developer
|
|
1512
|
-
*
|
|
1877
|
+
* <p>An attribute containing the <code>MessageId</code> of the message sent to the queue.
|
|
1878
|
+
* For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html">Queue and Message Identifiers</a> in the <i>Amazon SQS Developer
|
|
1879
|
+
* Guide</i>. </p>
|
|
1513
1880
|
*/
|
|
1514
1881
|
MessageId?: string;
|
|
1515
1882
|
/**
|
|
1516
1883
|
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
|
|
1517
1884
|
* <p>The large, non-consecutive number that Amazon SQS assigns to each message.</p>
|
|
1518
|
-
* <p>The length of <code>SequenceNumber</code> is 128 bits. <code>SequenceNumber</code>
|
|
1885
|
+
* <p>The length of <code>SequenceNumber</code> is 128 bits. <code>SequenceNumber</code>
|
|
1886
|
+
* continues to increase for a particular <code>MessageGroupId</code>.</p>
|
|
1519
1887
|
*/
|
|
1520
1888
|
SequenceNumber?: string;
|
|
1521
1889
|
}
|
|
1522
|
-
/**
|
|
1523
|
-
* @public
|
|
1524
|
-
* <p>Error code 400. Unsupported operation.</p>
|
|
1525
|
-
*/
|
|
1526
|
-
export declare class UnsupportedOperation extends __BaseException {
|
|
1527
|
-
readonly name: "UnsupportedOperation";
|
|
1528
|
-
readonly $fault: "client";
|
|
1529
|
-
/**
|
|
1530
|
-
* @internal
|
|
1531
|
-
*/
|
|
1532
|
-
constructor(opts: __ExceptionOptionType<UnsupportedOperation, __BaseException>);
|
|
1533
|
-
}
|
|
1534
1890
|
/**
|
|
1535
1891
|
* @public
|
|
1536
1892
|
* <p>The length of all the messages put together is more than the limit.</p>
|
|
@@ -1561,9 +1917,10 @@ export interface SendMessageBatchRequestEntry {
|
|
|
1561
1917
|
*/
|
|
1562
1918
|
MessageBody: string | undefined;
|
|
1563
1919
|
/**
|
|
1564
|
-
* <p>The length of time, in seconds, for which a specific message is delayed. Valid values:
|
|
1565
|
-
*
|
|
1566
|
-
*
|
|
1920
|
+
* <p>The length of time, in seconds, for which a specific message is delayed. Valid values:
|
|
1921
|
+
* 0 to 900. Maximum: 15 minutes. Messages with a positive <code>DelaySeconds</code> value
|
|
1922
|
+
* become available for processing after the delay period is finished. If you don't specify
|
|
1923
|
+
* a value, the default value for the queue is applied. </p>
|
|
1567
1924
|
* <note>
|
|
1568
1925
|
* <p>When you set <code>FifoQueue</code>, you can't set <code>DelaySeconds</code> per message. You can set this parameter only on a queue level.</p>
|
|
1569
1926
|
* </note>
|
|
@@ -1594,53 +1951,65 @@ export interface SendMessageBatchRequestEntry {
|
|
|
1594
1951
|
MessageSystemAttributes?: Record<string, MessageSystemAttributeValue>;
|
|
1595
1952
|
/**
|
|
1596
1953
|
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
|
|
1597
|
-
* <p>The token used for deduplication of messages within a 5-minute minimum deduplication
|
|
1598
|
-
*
|
|
1599
|
-
*
|
|
1600
|
-
*
|
|
1954
|
+
* <p>The token used for deduplication of messages within a 5-minute minimum deduplication
|
|
1955
|
+
* interval. If a message with a particular <code>MessageDeduplicationId</code> is sent
|
|
1956
|
+
* successfully, subsequent messages with the same <code>MessageDeduplicationId</code> are
|
|
1957
|
+
* 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
|
|
1958
|
+
* Guide</i>.</p>
|
|
1601
1959
|
* <ul>
|
|
1602
1960
|
* <li>
|
|
1603
1961
|
* <p>Every message must have a unique <code>MessageDeduplicationId</code>,</p>
|
|
1604
1962
|
* <ul>
|
|
1605
1963
|
* <li>
|
|
1606
|
-
* <p>You may provide a <code>MessageDeduplicationId</code>
|
|
1964
|
+
* <p>You may provide a <code>MessageDeduplicationId</code>
|
|
1965
|
+
* explicitly.</p>
|
|
1607
1966
|
* </li>
|
|
1608
1967
|
* <li>
|
|
1609
|
-
* <p>If you aren't able to provide a <code>MessageDeduplicationId</code>
|
|
1610
|
-
*
|
|
1611
|
-
*
|
|
1968
|
+
* <p>If you aren't able to provide a <code>MessageDeduplicationId</code>
|
|
1969
|
+
* and you enable <code>ContentBasedDeduplication</code> for your queue,
|
|
1970
|
+
* Amazon SQS uses a SHA-256 hash to generate the
|
|
1971
|
+
* <code>MessageDeduplicationId</code> using the body of the message
|
|
1972
|
+
* (but not the attributes of the message). </p>
|
|
1612
1973
|
* </li>
|
|
1613
1974
|
* <li>
|
|
1614
|
-
* <p>If you don't provide a <code>MessageDeduplicationId</code> and the
|
|
1615
|
-
*
|
|
1975
|
+
* <p>If you don't provide a <code>MessageDeduplicationId</code> and the
|
|
1976
|
+
* queue doesn't have <code>ContentBasedDeduplication</code> set, the
|
|
1977
|
+
* action fails with an error.</p>
|
|
1616
1978
|
* </li>
|
|
1617
1979
|
* <li>
|
|
1618
|
-
* <p>If the queue has <code>ContentBasedDeduplication</code> set, your
|
|
1980
|
+
* <p>If the queue has <code>ContentBasedDeduplication</code> set, your
|
|
1981
|
+
* <code>MessageDeduplicationId</code> overrides the generated
|
|
1982
|
+
* one.</p>
|
|
1619
1983
|
* </li>
|
|
1620
1984
|
* </ul>
|
|
1621
1985
|
* </li>
|
|
1622
1986
|
* <li>
|
|
1623
|
-
* <p>When <code>ContentBasedDeduplication</code> is in effect, messages with
|
|
1624
|
-
*
|
|
1987
|
+
* <p>When <code>ContentBasedDeduplication</code> is in effect, messages with
|
|
1988
|
+
* identical content sent within the deduplication interval are treated as
|
|
1989
|
+
* duplicates and only one copy of the message is delivered.</p>
|
|
1625
1990
|
* </li>
|
|
1626
1991
|
* <li>
|
|
1627
|
-
* <p>If you send one message with <code>ContentBasedDeduplication</code> enabled
|
|
1628
|
-
*
|
|
1629
|
-
*
|
|
1992
|
+
* <p>If you send one message with <code>ContentBasedDeduplication</code> enabled
|
|
1993
|
+
* and then another message with a <code>MessageDeduplicationId</code> that is the
|
|
1994
|
+
* same as the one generated for the first <code>MessageDeduplicationId</code>, the
|
|
1995
|
+
* two messages are treated as duplicates and only one copy of the message is
|
|
1996
|
+
* delivered. </p>
|
|
1630
1997
|
* </li>
|
|
1631
1998
|
* </ul>
|
|
1632
1999
|
* <note>
|
|
1633
2000
|
* <p>The <code>MessageDeduplicationId</code> is available to the consumer of the
|
|
1634
2001
|
* message (this can be useful for troubleshooting delivery issues).</p>
|
|
1635
|
-
* <p>If a message is sent successfully but the acknowledgement is lost and the message
|
|
1636
|
-
*
|
|
2002
|
+
* <p>If a message is sent successfully but the acknowledgement is lost and the message
|
|
2003
|
+
* is resent with the same <code>MessageDeduplicationId</code> after the deduplication
|
|
2004
|
+
* interval, Amazon SQS can't detect duplicate messages.</p>
|
|
1637
2005
|
* <p>Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.</p>
|
|
1638
2006
|
* </note>
|
|
1639
|
-
* <p>The length of <code>MessageDeduplicationId</code> is 128 characters.
|
|
1640
|
-
*
|
|
1641
|
-
*
|
|
1642
|
-
*
|
|
1643
|
-
*
|
|
2007
|
+
* <p>The length of <code>MessageDeduplicationId</code> is 128 characters.
|
|
2008
|
+
* <code>MessageDeduplicationId</code> can contain alphanumeric characters
|
|
2009
|
+
* (<code>a-z</code>, <code>A-Z</code>, <code>0-9</code>) and punctuation
|
|
2010
|
+
* (<code>!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~</code>).</p>
|
|
2011
|
+
* <p>For best practices of using <code>MessageDeduplicationId</code>, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html">Using the MessageDeduplicationId Property</a> in the <i>Amazon SQS Developer
|
|
2012
|
+
* Guide</i>.</p>
|
|
1644
2013
|
*/
|
|
1645
2014
|
MessageDeduplicationId?: string;
|
|
1646
2015
|
/**
|
|
@@ -1654,21 +2023,26 @@ export interface SendMessageBatchRequestEntry {
|
|
|
1654
2023
|
* fashion.</p>
|
|
1655
2024
|
* <ul>
|
|
1656
2025
|
* <li>
|
|
1657
|
-
* <p>You must associate a non-empty <code>MessageGroupId</code> with a message. If
|
|
2026
|
+
* <p>You must associate a non-empty <code>MessageGroupId</code> with a message. If
|
|
2027
|
+
* you don't provide a <code>MessageGroupId</code>, the action fails.</p>
|
|
1658
2028
|
* </li>
|
|
1659
2029
|
* <li>
|
|
1660
2030
|
* <p>
|
|
1661
|
-
* <code>ReceiveMessage</code> might return messages with multiple
|
|
1662
|
-
*
|
|
2031
|
+
* <code>ReceiveMessage</code> might return messages with multiple
|
|
2032
|
+
* <code>MessageGroupId</code> values. For each <code>MessageGroupId</code>,
|
|
2033
|
+
* the messages are sorted by time sent. The caller can't specify a
|
|
2034
|
+
* <code>MessageGroupId</code>.</p>
|
|
1663
2035
|
* </li>
|
|
1664
2036
|
* </ul>
|
|
1665
|
-
* <p>The length of <code>MessageGroupId</code> is 128 characters. Valid values:
|
|
1666
|
-
*
|
|
1667
|
-
*
|
|
1668
|
-
*
|
|
2037
|
+
* <p>The length of <code>MessageGroupId</code> is 128 characters. Valid values:
|
|
2038
|
+
* alphanumeric characters and punctuation
|
|
2039
|
+
* <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~)</code>.</p>
|
|
2040
|
+
* <p>For best practices of using <code>MessageGroupId</code>, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html">Using the MessageGroupId Property</a> in the <i>Amazon SQS Developer
|
|
2041
|
+
* Guide</i>.</p>
|
|
1669
2042
|
* <important>
|
|
1670
2043
|
* <p>
|
|
1671
|
-
* <code>MessageGroupId</code> is required for FIFO queues. You can't use it for
|
|
2044
|
+
* <code>MessageGroupId</code> is required for FIFO queues. You can't use it for
|
|
2045
|
+
* Standard queues.</p>
|
|
1672
2046
|
* </important>
|
|
1673
2047
|
*/
|
|
1674
2048
|
MessageGroupId?: string;
|
|
@@ -1721,7 +2095,8 @@ export interface SendMessageBatchResultEntry {
|
|
|
1721
2095
|
/**
|
|
1722
2096
|
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
|
|
1723
2097
|
* <p>The large, non-consecutive number that Amazon SQS assigns to each message.</p>
|
|
1724
|
-
* <p>The length of <code>SequenceNumber</code> is 128 bits. As <code>SequenceNumber</code>
|
|
2098
|
+
* <p>The length of <code>SequenceNumber</code> is 128 bits. As <code>SequenceNumber</code>
|
|
2099
|
+
* continues to increase for a particular <code>MessageGroupId</code>.</p>
|
|
1725
2100
|
*/
|
|
1726
2101
|
SequenceNumber?: string;
|
|
1727
2102
|
}
|
|
@@ -1729,9 +2104,11 @@ export interface SendMessageBatchResultEntry {
|
|
|
1729
2104
|
* @public
|
|
1730
2105
|
* <p>For each message in the batch, the response contains a <code>
|
|
1731
2106
|
* <a>SendMessageBatchResultEntry</a>
|
|
1732
|
-
* </code> tag if the message succeeds or a
|
|
2107
|
+
* </code> tag if the message succeeds or a
|
|
2108
|
+
* <code>
|
|
1733
2109
|
* <a>BatchResultErrorEntry</a>
|
|
1734
|
-
* </code> tag if the message
|
|
2110
|
+
* </code> tag if the message
|
|
2111
|
+
* fails.</p>
|
|
1735
2112
|
*/
|
|
1736
2113
|
export interface SendMessageBatchResult {
|
|
1737
2114
|
/**
|
|
@@ -1743,7 +2120,8 @@ export interface SendMessageBatchResult {
|
|
|
1743
2120
|
/**
|
|
1744
2121
|
* <p>A list of <code>
|
|
1745
2122
|
* <a>BatchResultErrorEntry</a>
|
|
1746
|
-
* </code> items with error
|
|
2123
|
+
* </code> items with error
|
|
2124
|
+
* details about each message that can't be enqueued.</p>
|
|
1747
2125
|
*/
|
|
1748
2126
|
Failed: BatchResultErrorEntry[] | undefined;
|
|
1749
2127
|
}
|
|
@@ -1759,121 +2137,200 @@ export interface SetQueueAttributesRequest {
|
|
|
1759
2137
|
QueueUrl: string | undefined;
|
|
1760
2138
|
/**
|
|
1761
2139
|
* <p>A map of attributes to set.</p>
|
|
1762
|
-
* <p>The following lists the names, descriptions, and values of the special request
|
|
2140
|
+
* <p>The following lists the names, descriptions, and values of the special request
|
|
2141
|
+
* parameters that the <code>SetQueueAttributes</code> action uses:</p>
|
|
1763
2142
|
* <ul>
|
|
1764
2143
|
* <li>
|
|
1765
2144
|
* <p>
|
|
1766
|
-
* <code>DelaySeconds</code> – The length of time, in seconds, for which the
|
|
1767
|
-
*
|
|
2145
|
+
* <code>DelaySeconds</code> – The length of time, in seconds, for which the
|
|
2146
|
+
* delivery of all messages in the queue is delayed. Valid values: An integer from
|
|
2147
|
+
* 0 to 900 (15 minutes). Default: 0. </p>
|
|
1768
2148
|
* </li>
|
|
1769
2149
|
* <li>
|
|
1770
2150
|
* <p>
|
|
1771
|
-
* <code>MaximumMessageSize</code> – The limit of how many bytes a message
|
|
1772
|
-
*
|
|
2151
|
+
* <code>MaximumMessageSize</code> – The limit of how many bytes a message
|
|
2152
|
+
* can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes
|
|
2153
|
+
* (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). </p>
|
|
1773
2154
|
* </li>
|
|
1774
2155
|
* <li>
|
|
1775
2156
|
* <p>
|
|
1776
|
-
* <code>MessageRetentionPeriod</code> – The length of time, in seconds, for
|
|
1777
|
-
*
|
|
2157
|
+
* <code>MessageRetentionPeriod</code> – The length of time, in seconds, for
|
|
2158
|
+
* which Amazon SQS retains a message. Valid values: An integer representing seconds,
|
|
2159
|
+
* from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days). When you
|
|
2160
|
+
* change a queue's attributes, the change can take up to 60 seconds for most of
|
|
2161
|
+
* the attributes to propagate throughout the Amazon SQS system. Changes made to the
|
|
2162
|
+
* <code>MessageRetentionPeriod</code> attribute can take up to 15 minutes and
|
|
2163
|
+
* will impact existing messages in the queue potentially causing them to be
|
|
2164
|
+
* expired and deleted if the <code>MessageRetentionPeriod</code> is reduced below
|
|
2165
|
+
* the age of existing messages.</p>
|
|
1778
2166
|
* </li>
|
|
1779
2167
|
* <li>
|
|
1780
2168
|
* <p>
|
|
1781
|
-
* <code>Policy</code> – The queue's policy. A valid Amazon Web Services policy. For more
|
|
1782
|
-
*
|
|
1783
|
-
*
|
|
2169
|
+
* <code>Policy</code> – The queue's policy. A valid Amazon Web Services policy. For more
|
|
2170
|
+
* information about policy structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview of Amazon Web Services IAM
|
|
2171
|
+
* Policies</a> in the <i>Identity and Access Management User
|
|
2172
|
+
* Guide</i>. </p>
|
|
1784
2173
|
* </li>
|
|
1785
2174
|
* <li>
|
|
1786
2175
|
* <p>
|
|
1787
|
-
* <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in
|
|
2176
|
+
* <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in
|
|
2177
|
+
* seconds, for which a <code>
|
|
1788
2178
|
* <a>ReceiveMessage</a>
|
|
1789
|
-
* </code> action waits
|
|
1790
|
-
*
|
|
2179
|
+
* </code> action waits
|
|
2180
|
+
* for a message to arrive. Valid values: An integer from 0 to 20 (seconds).
|
|
2181
|
+
* Default: 0. </p>
|
|
2182
|
+
* </li>
|
|
2183
|
+
* <li>
|
|
2184
|
+
* <p>
|
|
2185
|
+
* <code>VisibilityTimeout</code> – The visibility timeout for the queue, in
|
|
2186
|
+
* seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For
|
|
2187
|
+
* 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
|
|
2188
|
+
* Guide</i>.</p>
|
|
1791
2189
|
* </li>
|
|
2190
|
+
* </ul>
|
|
2191
|
+
* <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">dead-letter queues:</a>
|
|
2192
|
+
* </p>
|
|
2193
|
+
* <ul>
|
|
1792
2194
|
* <li>
|
|
1793
2195
|
* <p>
|
|
1794
2196
|
* <code>RedrivePolicy</code> – The string that includes the parameters for the dead-letter queue functionality
|
|
1795
|
-
*
|
|
1796
|
-
* in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
2197
|
+
* of the source queue as a JSON object. The parameters are as follows:</p>
|
|
1797
2198
|
* <ul>
|
|
1798
2199
|
* <li>
|
|
1799
2200
|
* <p>
|
|
1800
|
-
* <code>deadLetterTargetArn</code> – The Amazon Resource Name (ARN) of the dead-letter queue to
|
|
2201
|
+
* <code>deadLetterTargetArn</code> – The Amazon Resource Name (ARN) of the dead-letter queue to
|
|
2202
|
+
* which Amazon SQS moves messages after the value of <code>maxReceiveCount</code> is exceeded.</p>
|
|
1801
2203
|
* </li>
|
|
1802
2204
|
* <li>
|
|
1803
2205
|
* <p>
|
|
1804
|
-
* <code>maxReceiveCount</code> – The number of times a message is delivered to the source queue before being
|
|
1805
|
-
*
|
|
2206
|
+
* <code>maxReceiveCount</code> – The number of times a message is delivered to the source queue before being
|
|
2207
|
+
* moved to the dead-letter queue. Default: 10. When the <code>ReceiveCount</code> for a message exceeds the <code>maxReceiveCount</code>
|
|
2208
|
+
* for a queue, Amazon SQS moves the message to the dead-letter-queue.</p>
|
|
1806
2209
|
* </li>
|
|
1807
2210
|
* </ul>
|
|
1808
|
-
* <note>
|
|
1809
|
-
* <p>The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.</p>
|
|
1810
|
-
* </note>
|
|
1811
2211
|
* </li>
|
|
1812
2212
|
* <li>
|
|
1813
2213
|
* <p>
|
|
1814
|
-
* <code>
|
|
1815
|
-
*
|
|
2214
|
+
* <code>RedriveAllowPolicy</code> – The string that includes the parameters for the permissions for the dead-letter
|
|
2215
|
+
* queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:</p>
|
|
2216
|
+
* <ul>
|
|
2217
|
+
* <li>
|
|
2218
|
+
* <p>
|
|
2219
|
+
* <code>redrivePermission</code> – The permission type that defines which source queues can
|
|
2220
|
+
* specify the current queue as the dead-letter queue. Valid values are:</p>
|
|
2221
|
+
* <ul>
|
|
2222
|
+
* <li>
|
|
2223
|
+
* <p>
|
|
2224
|
+
* <code>allowAll</code> – (Default) Any source queues in this Amazon Web Services account in the same Region can
|
|
2225
|
+
* specify this queue as the dead-letter queue.</p>
|
|
2226
|
+
* </li>
|
|
2227
|
+
* <li>
|
|
2228
|
+
* <p>
|
|
2229
|
+
* <code>denyAll</code> – No source queues can specify this queue as the dead-letter
|
|
2230
|
+
* queue.</p>
|
|
2231
|
+
* </li>
|
|
2232
|
+
* <li>
|
|
2233
|
+
* <p>
|
|
2234
|
+
* <code>byQueue</code> – Only queues specified by the <code>sourceQueueArns</code> parameter can specify
|
|
2235
|
+
* this queue as the dead-letter queue.</p>
|
|
2236
|
+
* </li>
|
|
2237
|
+
* </ul>
|
|
2238
|
+
* </li>
|
|
2239
|
+
* <li>
|
|
2240
|
+
* <p>
|
|
2241
|
+
* <code>sourceQueueArns</code> – The Amazon Resource Names (ARN)s of the source queues that can specify
|
|
2242
|
+
* this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the
|
|
2243
|
+
* <code>redrivePermission</code> parameter is set to <code>byQueue</code>. You can specify up to 10 source queue ARNs.
|
|
2244
|
+
* To allow more than 10 source queues to specify dead-letter queues, set the <code>redrivePermission</code> parameter
|
|
2245
|
+
* to <code>allowAll</code>.</p>
|
|
2246
|
+
* </li>
|
|
2247
|
+
* </ul>
|
|
1816
2248
|
* </li>
|
|
1817
2249
|
* </ul>
|
|
2250
|
+
* <note>
|
|
2251
|
+
* <p>The dead-letter queue of a
|
|
2252
|
+
* FIFO queue must also be a FIFO queue. Similarly, the dead-letter
|
|
2253
|
+
* queue of a standard queue must also be a standard queue.</p>
|
|
2254
|
+
* </note>
|
|
1818
2255
|
* <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>
|
|
1819
2256
|
* <ul>
|
|
1820
2257
|
* <li>
|
|
1821
2258
|
* <p>
|
|
1822
|
-
* <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer master
|
|
1823
|
-
*
|
|
1824
|
-
*
|
|
1825
|
-
*
|
|
1826
|
-
*
|
|
2259
|
+
* <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer master
|
|
2260
|
+
* key (CMK) for Amazon SQS or a custom CMK. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key Terms</a>. While the alias of the AWS-managed CMK for Amazon SQS is
|
|
2261
|
+
* always <code>alias/aws/sqs</code>, the alias of a custom CMK can, for example,
|
|
2262
|
+
* be <code>alias/<i>MyAlias</i>
|
|
2263
|
+
* </code>. For more examples, see
|
|
2264
|
+
* <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
|
|
2265
|
+
* Reference</i>. </p>
|
|
1827
2266
|
* </li>
|
|
1828
2267
|
* <li>
|
|
1829
2268
|
* <p>
|
|
1830
|
-
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in
|
|
1831
|
-
*
|
|
1832
|
-
*
|
|
1833
|
-
*
|
|
1834
|
-
*
|
|
2269
|
+
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in
|
|
2270
|
+
* seconds, for which Amazon SQS can reuse a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data key</a> to
|
|
2271
|
+
* encrypt or decrypt messages before calling KMS again. An integer
|
|
2272
|
+
* representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
|
2273
|
+
* hours). Default: 300 (5 minutes). A shorter time period provides better security
|
|
2274
|
+
* but results in more calls to KMS which might incur charges after Free Tier. For
|
|
2275
|
+
* 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>
|
|
1835
2276
|
* </li>
|
|
1836
2277
|
* <li>
|
|
1837
2278
|
* <p>
|
|
1838
|
-
* <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption
|
|
2279
|
+
* <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption
|
|
2280
|
+
* using SQS owned encryption keys. Only one server-side encryption option is
|
|
2281
|
+
* 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>
|
|
1839
2282
|
* </li>
|
|
1840
2283
|
* </ul>
|
|
1841
|
-
* <p>The following attribute applies only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO (first-in-first-out)
|
|
2284
|
+
* <p>The following attribute applies only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO (first-in-first-out)
|
|
2285
|
+
* queues</a>:</p>
|
|
1842
2286
|
* <ul>
|
|
1843
2287
|
* <li>
|
|
1844
2288
|
* <p>
|
|
1845
|
-
* <code>ContentBasedDeduplication</code> – Enables content-based
|
|
1846
|
-
*
|
|
1847
|
-
*
|
|
2289
|
+
* <code>ContentBasedDeduplication</code> – Enables content-based
|
|
2290
|
+
* deduplication. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html">Exactly-once processing</a> in the <i>Amazon SQS Developer
|
|
2291
|
+
* Guide</i>. Note the following: </p>
|
|
1848
2292
|
* <ul>
|
|
1849
2293
|
* <li>
|
|
1850
|
-
* <p>Every message must have a unique
|
|
2294
|
+
* <p>Every message must have a unique
|
|
2295
|
+
* <code>MessageDeduplicationId</code>.</p>
|
|
1851
2296
|
* <ul>
|
|
1852
2297
|
* <li>
|
|
1853
|
-
* <p>You may provide a <code>MessageDeduplicationId</code>
|
|
2298
|
+
* <p>You may provide a <code>MessageDeduplicationId</code>
|
|
2299
|
+
* explicitly.</p>
|
|
1854
2300
|
* </li>
|
|
1855
2301
|
* <li>
|
|
1856
|
-
* <p>If you aren't able to provide a
|
|
1857
|
-
*
|
|
1858
|
-
*
|
|
2302
|
+
* <p>If you aren't able to provide a
|
|
2303
|
+
* <code>MessageDeduplicationId</code> and you enable
|
|
2304
|
+
* <code>ContentBasedDeduplication</code> for your queue, Amazon SQS
|
|
2305
|
+
* uses a SHA-256 hash to generate the
|
|
2306
|
+
* <code>MessageDeduplicationId</code> using the body of the
|
|
2307
|
+
* message (but not the attributes of the message). </p>
|
|
1859
2308
|
* </li>
|
|
1860
2309
|
* <li>
|
|
1861
|
-
* <p>If you don't provide a <code>MessageDeduplicationId</code> and
|
|
1862
|
-
*
|
|
2310
|
+
* <p>If you don't provide a <code>MessageDeduplicationId</code> and
|
|
2311
|
+
* the queue doesn't have <code>ContentBasedDeduplication</code>
|
|
2312
|
+
* set, the action fails with an error.</p>
|
|
1863
2313
|
* </li>
|
|
1864
2314
|
* <li>
|
|
1865
|
-
* <p>If the queue has <code>ContentBasedDeduplication</code> set,
|
|
2315
|
+
* <p>If the queue has <code>ContentBasedDeduplication</code> set,
|
|
2316
|
+
* your <code>MessageDeduplicationId</code> overrides the generated
|
|
2317
|
+
* one.</p>
|
|
1866
2318
|
* </li>
|
|
1867
2319
|
* </ul>
|
|
1868
2320
|
* </li>
|
|
1869
2321
|
* <li>
|
|
1870
|
-
* <p>When <code>ContentBasedDeduplication</code> is in effect, messages
|
|
1871
|
-
*
|
|
2322
|
+
* <p>When <code>ContentBasedDeduplication</code> is in effect, messages
|
|
2323
|
+
* with identical content sent within the deduplication interval are
|
|
2324
|
+
* treated as duplicates and only one copy of the message is
|
|
2325
|
+
* delivered.</p>
|
|
1872
2326
|
* </li>
|
|
1873
2327
|
* <li>
|
|
1874
|
-
* <p>If you send one message with <code>ContentBasedDeduplication</code>
|
|
1875
|
-
*
|
|
1876
|
-
*
|
|
2328
|
+
* <p>If you send one message with <code>ContentBasedDeduplication</code>
|
|
2329
|
+
* enabled and then another message with a
|
|
2330
|
+
* <code>MessageDeduplicationId</code> that is the same as the one
|
|
2331
|
+
* generated for the first <code>MessageDeduplicationId</code>, the two
|
|
2332
|
+
* messages are treated as duplicates and only one copy of the message is
|
|
2333
|
+
* delivered. </p>
|
|
1877
2334
|
* </li>
|
|
1878
2335
|
* </ul>
|
|
1879
2336
|
* </li>
|
|
@@ -1911,6 +2368,42 @@ export interface SetQueueAttributesRequest {
|
|
|
1911
2368
|
*/
|
|
1912
2369
|
Attributes: Record<string, string> | undefined;
|
|
1913
2370
|
}
|
|
2371
|
+
/**
|
|
2372
|
+
* @public
|
|
2373
|
+
*/
|
|
2374
|
+
export interface StartMessageMoveTaskRequest {
|
|
2375
|
+
/**
|
|
2376
|
+
* <p>The ARN of the queue that contains the messages to be moved to another queue.
|
|
2377
|
+
* Currently, only dead-letter queue (DLQ) ARNs are accepted.</p>
|
|
2378
|
+
*/
|
|
2379
|
+
SourceArn: string | undefined;
|
|
2380
|
+
/**
|
|
2381
|
+
* <p>The ARN of the queue that receives the moved messages. You can use this field to
|
|
2382
|
+
* specify the destination queue where you would like to redrive messages. If this field is
|
|
2383
|
+
* left blank, the messages will be redriven back to their respective original source
|
|
2384
|
+
* queues.</p>
|
|
2385
|
+
*/
|
|
2386
|
+
DestinationArn?: string;
|
|
2387
|
+
/**
|
|
2388
|
+
* <p>The number of messages to be moved per second (the message movement rate). You can use
|
|
2389
|
+
* this field to define a fixed message movement rate. The maximum value for messages per
|
|
2390
|
+
* second is 500. If this field is left blank, the system will optimize the rate based on
|
|
2391
|
+
* the queue message backlog size, which may vary throughout the duration of the message
|
|
2392
|
+
* movement task.</p>
|
|
2393
|
+
*/
|
|
2394
|
+
MaxNumberOfMessagesPerSecond?: number;
|
|
2395
|
+
}
|
|
2396
|
+
/**
|
|
2397
|
+
* @public
|
|
2398
|
+
*/
|
|
2399
|
+
export interface StartMessageMoveTaskResult {
|
|
2400
|
+
/**
|
|
2401
|
+
* <p>An identifier associated with a message movement task. You can use this identifier to
|
|
2402
|
+
* cancel a specified message movement task using the <code>CancelMessageMoveTask</code>
|
|
2403
|
+
* action.</p>
|
|
2404
|
+
*/
|
|
2405
|
+
TaskHandle?: string;
|
|
2406
|
+
}
|
|
1914
2407
|
/**
|
|
1915
2408
|
* @public
|
|
1916
2409
|
*/
|