@aws-sdk/client-sqs 3.327.0 → 3.328.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -10
- package/dist-cjs/commands/AddPermissionCommand.js +3 -3
- package/dist-cjs/commands/ChangeMessageVisibilityBatchCommand.js +3 -3
- package/dist-cjs/commands/ChangeMessageVisibilityCommand.js +3 -3
- package/dist-cjs/commands/CreateQueueCommand.js +3 -3
- package/dist-cjs/commands/DeleteMessageBatchCommand.js +3 -3
- package/dist-cjs/commands/DeleteMessageCommand.js +3 -3
- package/dist-cjs/commands/DeleteQueueCommand.js +3 -3
- package/dist-cjs/commands/GetQueueAttributesCommand.js +3 -3
- package/dist-cjs/commands/GetQueueUrlCommand.js +3 -3
- package/dist-cjs/commands/ListDeadLetterSourceQueuesCommand.js +3 -3
- package/dist-cjs/commands/ListQueueTagsCommand.js +3 -3
- package/dist-cjs/commands/ListQueuesCommand.js +3 -3
- package/dist-cjs/commands/PurgeQueueCommand.js +3 -3
- package/dist-cjs/commands/ReceiveMessageCommand.js +3 -3
- package/dist-cjs/commands/RemovePermissionCommand.js +3 -3
- package/dist-cjs/commands/SendMessageBatchCommand.js +3 -3
- package/dist-cjs/commands/SendMessageCommand.js +3 -3
- package/dist-cjs/commands/SetQueueAttributesCommand.js +3 -3
- package/dist-cjs/commands/TagQueueCommand.js +3 -3
- package/dist-cjs/commands/UntagQueueCommand.js +3 -3
- package/dist-cjs/models/models_0.js +29 -172
- package/dist-cjs/protocols/Aws_query.js +2127 -0
- package/dist-es/commands/AddPermissionCommand.js +1 -1
- package/dist-es/commands/ChangeMessageVisibilityBatchCommand.js +1 -1
- package/dist-es/commands/ChangeMessageVisibilityCommand.js +1 -1
- package/dist-es/commands/CreateQueueCommand.js +1 -1
- package/dist-es/commands/DeleteMessageBatchCommand.js +1 -1
- package/dist-es/commands/DeleteMessageCommand.js +1 -1
- package/dist-es/commands/DeleteQueueCommand.js +1 -1
- package/dist-es/commands/GetQueueAttributesCommand.js +1 -1
- package/dist-es/commands/GetQueueUrlCommand.js +1 -1
- package/dist-es/commands/ListDeadLetterSourceQueuesCommand.js +1 -1
- package/dist-es/commands/ListQueueTagsCommand.js +1 -1
- package/dist-es/commands/ListQueuesCommand.js +1 -1
- package/dist-es/commands/PurgeQueueCommand.js +1 -1
- package/dist-es/commands/ReceiveMessageCommand.js +1 -1
- package/dist-es/commands/RemovePermissionCommand.js +1 -1
- package/dist-es/commands/SendMessageBatchCommand.js +1 -1
- package/dist-es/commands/SendMessageCommand.js +1 -1
- package/dist-es/commands/SetQueueAttributesCommand.js +1 -1
- package/dist-es/commands/TagQueueCommand.js +1 -1
- package/dist-es/commands/UntagQueueCommand.js +1 -1
- package/dist-es/models/models_0.js +24 -156
- package/dist-es/protocols/Aws_query.js +2084 -0
- package/dist-types/SQS.d.ts +6 -10
- package/dist-types/SQSClient.d.ts +6 -10
- package/dist-types/commands/AddPermissionCommand.d.ts +23 -48
- package/dist-types/commands/ChangeMessageVisibilityBatchCommand.d.ts +12 -34
- package/dist-types/commands/ChangeMessageVisibilityCommand.d.ts +13 -47
- package/dist-types/commands/CreateQueueCommand.d.ts +18 -53
- package/dist-types/commands/DeleteMessageBatchCommand.d.ts +10 -31
- package/dist-types/commands/DeleteMessageCommand.d.ts +1 -29
- package/dist-types/commands/DeleteQueueCommand.d.ts +8 -44
- package/dist-types/commands/GetQueueAttributesCommand.d.ts +0 -28
- package/dist-types/commands/GetQueueUrlCommand.d.ts +4 -35
- package/dist-types/commands/ListDeadLetterSourceQueuesCommand.d.ts +10 -39
- package/dist-types/commands/ListQueueTagsCommand.d.ts +2 -34
- package/dist-types/commands/ListQueuesCommand.d.ts +11 -41
- package/dist-types/commands/PurgeQueueCommand.d.ts +5 -35
- package/dist-types/commands/ReceiveMessageCommand.d.ts +14 -87
- package/dist-types/commands/RemovePermissionCommand.d.ts +2 -34
- package/dist-types/commands/SendMessageBatchCommand.d.ts +13 -73
- package/dist-types/commands/SendMessageCommand.d.ts +0 -59
- package/dist-types/commands/SetQueueAttributesCommand.d.ts +3 -47
- package/dist-types/commands/TagQueueCommand.d.ts +1 -32
- package/dist-types/commands/UntagQueueCommand.d.ts +1 -32
- package/dist-types/models/models_0.d.ts +412 -926
- package/dist-types/protocols/{Aws_json1_0.d.ts → Aws_query.d.ts} +40 -40
- package/dist-types/ts3.4/models/models_0.d.ts +21 -78
- package/package.json +5 -4
- package/dist-cjs/protocols/Aws_json1_0.js +0 -1608
- package/dist-es/protocols/Aws_json1_0.js +0 -1565
- /package/dist-types/ts3.4/protocols/{Aws_json1_0.d.ts → Aws_query.d.ts} +0 -0
|
@@ -11,10 +11,7 @@ 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,
|
|
15
|
-
* <code>AliceSendMessage</code>). Maximum 80 characters. Allowed characters include
|
|
16
|
-
* alphanumeric characters, hyphens (<code>-</code>), and underscores
|
|
17
|
-
* (<code>_</code>).</p>
|
|
14
|
+
* <p>The unique identification of the permission you're setting (for example, <code>AliceSendMessage</code>). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (<code>-</code>), and underscores (<code>_</code>).</p>
|
|
18
15
|
*/
|
|
19
16
|
Label: string | undefined;
|
|
20
17
|
/**
|
|
@@ -24,46 +21,18 @@ export interface AddPermissionRequest {
|
|
|
24
21
|
*/
|
|
25
22
|
AWSAccountIds: string[] | undefined;
|
|
26
23
|
/**
|
|
27
|
-
* <p>The action the client wants to allow for the specified principal. Valid values: the
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
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>
|
|
24
|
+
* <p>The action the client wants to allow for the specified principal. Valid values: the name of any action or <code>*</code>.</p>
|
|
25
|
+
* <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 Resource</a>
|
|
26
|
+
* in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
27
|
+
* <p>Specifying <code>SendMessage</code>, <code>DeleteMessage</code>, or <code>ChangeMessageVisibility</code> for <code>ActionName.n</code> also grants permissions for the corresponding batch versions of those actions: <code>SendMessageBatch</code>,
|
|
28
|
+
* <code>DeleteMessageBatch</code>, and <code>ChangeMessageVisibilityBatch</code>.</p>
|
|
36
29
|
*/
|
|
37
30
|
Actions: string[] | undefined;
|
|
38
31
|
}
|
|
39
|
-
/**
|
|
40
|
-
* @public
|
|
41
|
-
* <p>The <code>accountId</code> is invalid.</p>
|
|
42
|
-
*/
|
|
43
|
-
export declare class InvalidAddress extends __BaseException {
|
|
44
|
-
readonly name: "InvalidAddress";
|
|
45
|
-
readonly $fault: "client";
|
|
46
|
-
/**
|
|
47
|
-
* @internal
|
|
48
|
-
*/
|
|
49
|
-
constructor(opts: __ExceptionOptionType<InvalidAddress, __BaseException>);
|
|
50
|
-
}
|
|
51
|
-
/**
|
|
52
|
-
* @public
|
|
53
|
-
* <p>When the request to a queue is not HTTPS and SigV4.</p>
|
|
54
|
-
*/
|
|
55
|
-
export declare class InvalidSecurity extends __BaseException {
|
|
56
|
-
readonly name: "InvalidSecurity";
|
|
57
|
-
readonly $fault: "client";
|
|
58
|
-
/**
|
|
59
|
-
* @internal
|
|
60
|
-
*/
|
|
61
|
-
constructor(opts: __ExceptionOptionType<InvalidSecurity, __BaseException>);
|
|
62
|
-
}
|
|
63
32
|
/**
|
|
64
33
|
* @public
|
|
65
34
|
* <p>The specified action violates a limit. For example, <code>ReceiveMessage</code>
|
|
66
|
-
* returns this error if the maximum number of
|
|
35
|
+
* returns this error if the maximum number of inflight messages is reached and
|
|
67
36
|
* <code>AddPermission</code> returns this error if the maximum number of permissions
|
|
68
37
|
* for the queue is reached.</p>
|
|
69
38
|
*/
|
|
@@ -75,58 +44,6 @@ export declare class OverLimit extends __BaseException {
|
|
|
75
44
|
*/
|
|
76
45
|
constructor(opts: __ExceptionOptionType<OverLimit, __BaseException>);
|
|
77
46
|
}
|
|
78
|
-
/**
|
|
79
|
-
* @public
|
|
80
|
-
* <p>The specified queue doesn't exist.</p>
|
|
81
|
-
*/
|
|
82
|
-
export declare class QueueDoesNotExist extends __BaseException {
|
|
83
|
-
readonly name: "QueueDoesNotExist";
|
|
84
|
-
readonly $fault: "client";
|
|
85
|
-
/**
|
|
86
|
-
* @internal
|
|
87
|
-
*/
|
|
88
|
-
constructor(opts: __ExceptionOptionType<QueueDoesNotExist, __BaseException>);
|
|
89
|
-
}
|
|
90
|
-
/**
|
|
91
|
-
* @public
|
|
92
|
-
* <p>The request was denied due to request throttling.</p>
|
|
93
|
-
* <ul>
|
|
94
|
-
* <li>
|
|
95
|
-
* <p>The rate of requests per second exceeds the AWS KMS request quota for an
|
|
96
|
-
* account and Region. </p>
|
|
97
|
-
* </li>
|
|
98
|
-
* <li>
|
|
99
|
-
* <p>A burst or sustained high rate of requests to change the state of the same KMS
|
|
100
|
-
* key. This condition is often known as a "hot key."</p>
|
|
101
|
-
* </li>
|
|
102
|
-
* <li>
|
|
103
|
-
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
104
|
-
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
105
|
-
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
106
|
-
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
107
|
-
* </li>
|
|
108
|
-
* </ul>
|
|
109
|
-
*/
|
|
110
|
-
export declare class RequestThrottled extends __BaseException {
|
|
111
|
-
readonly name: "RequestThrottled";
|
|
112
|
-
readonly $fault: "client";
|
|
113
|
-
/**
|
|
114
|
-
* @internal
|
|
115
|
-
*/
|
|
116
|
-
constructor(opts: __ExceptionOptionType<RequestThrottled, __BaseException>);
|
|
117
|
-
}
|
|
118
|
-
/**
|
|
119
|
-
* @public
|
|
120
|
-
* <p>Error code 400. Unsupported operation.</p>
|
|
121
|
-
*/
|
|
122
|
-
export declare class UnsupportedOperation extends __BaseException {
|
|
123
|
-
readonly name: "UnsupportedOperation";
|
|
124
|
-
readonly $fault: "client";
|
|
125
|
-
/**
|
|
126
|
-
* @internal
|
|
127
|
-
*/
|
|
128
|
-
constructor(opts: __ExceptionOptionType<UnsupportedOperation, __BaseException>);
|
|
129
|
-
}
|
|
130
47
|
/**
|
|
131
48
|
* @public
|
|
132
49
|
*/
|
|
@@ -137,16 +54,13 @@ export interface ChangeMessageVisibilityRequest {
|
|
|
137
54
|
*/
|
|
138
55
|
QueueUrl: string | undefined;
|
|
139
56
|
/**
|
|
140
|
-
* <p>The receipt handle associated with the message whose visibility timeout is changed.
|
|
141
|
-
* This parameter is returned by the <code>
|
|
57
|
+
* <p>The receipt handle associated with the message whose visibility timeout is changed. This parameter is returned by the <code>
|
|
142
58
|
* <a>ReceiveMessage</a>
|
|
143
|
-
* </code>
|
|
144
|
-
* action.</p>
|
|
59
|
+
* </code> action.</p>
|
|
145
60
|
*/
|
|
146
61
|
ReceiptHandle: string | undefined;
|
|
147
62
|
/**
|
|
148
|
-
* <p>The new value for the message's visibility timeout (in seconds). Values range:
|
|
149
|
-
* <code>0</code> to <code>43200</code>. Maximum: 12 hours.</p>
|
|
63
|
+
* <p>The new value for the message's visibility timeout (in seconds). Values range: <code>0</code> to <code>43200</code>. Maximum: 12 hours.</p>
|
|
150
64
|
*/
|
|
151
65
|
VisibilityTimeout: number | undefined;
|
|
152
66
|
}
|
|
@@ -191,11 +105,22 @@ export declare class BatchEntryIdsNotDistinct extends __BaseException {
|
|
|
191
105
|
* <p>Encloses a receipt handle and an entry id for each message in <code>
|
|
192
106
|
* <a>ChangeMessageVisibilityBatch</a>.</code>
|
|
193
107
|
* </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>
|
|
194
120
|
*/
|
|
195
121
|
export interface ChangeMessageVisibilityBatchRequestEntry {
|
|
196
122
|
/**
|
|
197
|
-
* <p>An identifier for this particular receipt handle used to communicate the
|
|
198
|
-
* result.</p>
|
|
123
|
+
* <p>An identifier for this particular receipt handle used to communicate the result.</p>
|
|
199
124
|
* <note>
|
|
200
125
|
* <p>The <code>Id</code>s of a batch request need to be unique within a request.</p>
|
|
201
126
|
* <p>This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).</p>
|
|
@@ -222,8 +147,7 @@ export interface ChangeMessageVisibilityBatchRequest {
|
|
|
222
147
|
*/
|
|
223
148
|
QueueUrl: string | undefined;
|
|
224
149
|
/**
|
|
225
|
-
* <p>A list of receipt handles of the messages for which the visibility timeout must be
|
|
226
|
-
* changed.</p>
|
|
150
|
+
* <p>A list of receipt handles of the messages for which the visibility timeout must be changed.</p>
|
|
227
151
|
*/
|
|
228
152
|
Entries: ChangeMessageVisibilityBatchRequestEntry[] | undefined;
|
|
229
153
|
}
|
|
@@ -266,18 +190,15 @@ export interface ChangeMessageVisibilityBatchResultEntry {
|
|
|
266
190
|
* @public
|
|
267
191
|
* <p>For each message in the batch, the response contains a <code>
|
|
268
192
|
* <a>ChangeMessageVisibilityBatchResultEntry</a>
|
|
269
|
-
* </code> tag if the message
|
|
270
|
-
* succeeds or a <code>
|
|
193
|
+
* </code> tag if the message succeeds or a <code>
|
|
271
194
|
* <a>BatchResultErrorEntry</a>
|
|
272
|
-
* </code> tag if the message
|
|
273
|
-
* fails.</p>
|
|
195
|
+
* </code> tag if the message fails.</p>
|
|
274
196
|
*/
|
|
275
197
|
export interface ChangeMessageVisibilityBatchResult {
|
|
276
198
|
/**
|
|
277
199
|
* <p>A list of <code>
|
|
278
200
|
* <a>ChangeMessageVisibilityBatchResultEntry</a>
|
|
279
|
-
* </code>
|
|
280
|
-
* items.</p>
|
|
201
|
+
* </code> items.</p>
|
|
281
202
|
*/
|
|
282
203
|
Successful: ChangeMessageVisibilityBatchResultEntry[] | undefined;
|
|
283
204
|
/**
|
|
@@ -301,8 +222,7 @@ export declare class EmptyBatchRequest extends __BaseException {
|
|
|
301
222
|
}
|
|
302
223
|
/**
|
|
303
224
|
* @public
|
|
304
|
-
* <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the
|
|
305
|
-
* specification.</p>
|
|
225
|
+
* <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the specification.</p>
|
|
306
226
|
*/
|
|
307
227
|
export declare class InvalidBatchEntryId extends __BaseException {
|
|
308
228
|
readonly name: "InvalidBatchEntryId";
|
|
@@ -368,8 +288,7 @@ export interface CreateQueueRequest {
|
|
|
368
288
|
* <p>A queue name can have up to 80 characters.</p>
|
|
369
289
|
* </li>
|
|
370
290
|
* <li>
|
|
371
|
-
* <p>Valid values: alphanumeric characters, hyphens (<code>-</code>), and
|
|
372
|
-
* underscores (<code>_</code>).</p>
|
|
291
|
+
* <p>Valid values: alphanumeric characters, hyphens (<code>-</code>), and underscores (<code>_</code>).</p>
|
|
373
292
|
* </li>
|
|
374
293
|
* <li>
|
|
375
294
|
* <p>A FIFO queue name must end with the <code>.fifo</code> suffix.</p>
|
|
@@ -379,212 +298,160 @@ export interface CreateQueueRequest {
|
|
|
379
298
|
*/
|
|
380
299
|
QueueName: string | undefined;
|
|
381
300
|
/**
|
|
382
|
-
* <p>
|
|
383
|
-
*
|
|
384
|
-
*
|
|
301
|
+
* <p>Add cost allocation tags to the specified Amazon SQS queue. For an overview, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html">Tagging
|
|
302
|
+
* Your Amazon SQS Queues</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
303
|
+
* <p>When you use queue tags, keep the following guidelines in mind:</p>
|
|
385
304
|
* <ul>
|
|
386
305
|
* <li>
|
|
387
|
-
* <p>
|
|
388
|
-
*
|
|
389
|
-
*
|
|
390
|
-
*
|
|
306
|
+
* <p>Adding more than 50 tags to a queue isn't recommended.</p>
|
|
307
|
+
* </li>
|
|
308
|
+
* <li>
|
|
309
|
+
* <p>Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.</p>
|
|
310
|
+
* </li>
|
|
311
|
+
* <li>
|
|
312
|
+
* <p>Tags are case-sensitive.</p>
|
|
313
|
+
* </li>
|
|
314
|
+
* <li>
|
|
315
|
+
* <p>A new tag with a key identical to that of an existing tag overwrites the existing tag.</p>
|
|
391
316
|
* </li>
|
|
317
|
+
* </ul>
|
|
318
|
+
* <p>For a full list of tag restrictions, see
|
|
319
|
+
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues">Quotas related to queues</a>
|
|
320
|
+
* in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
321
|
+
* <note>
|
|
322
|
+
* <p>To be able to tag a queue on creation, you must have the
|
|
323
|
+
* <code>sqs:CreateQueue</code> and <code>sqs:TagQueue</code> permissions.</p>
|
|
324
|
+
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
325
|
+
* 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 user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
327
|
+
* </note>
|
|
328
|
+
*/
|
|
329
|
+
tags?: Record<string, string>;
|
|
330
|
+
/**
|
|
331
|
+
* <p>A map of attributes with their corresponding values.</p>
|
|
332
|
+
* <p>The following lists the names, descriptions, and values of the special request parameters that the <code>CreateQueue</code> action uses:</p>
|
|
333
|
+
* <ul>
|
|
392
334
|
* <li>
|
|
393
335
|
* <p>
|
|
394
|
-
* <code>
|
|
395
|
-
*
|
|
396
|
-
* (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). </p>
|
|
336
|
+
* <code>DelaySeconds</code> – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0.
|
|
337
|
+
* </p>
|
|
397
338
|
* </li>
|
|
398
339
|
* <li>
|
|
399
340
|
* <p>
|
|
400
|
-
* <code>
|
|
401
|
-
*
|
|
402
|
-
* minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days). When you
|
|
403
|
-
* change a queue's attributes, the change can take up to 60 seconds for most of
|
|
404
|
-
* the attributes to propagate throughout the Amazon SQS system. Changes made to the
|
|
405
|
-
* <code>MessageRetentionPeriod</code> attribute can take up to 15 minutes and
|
|
406
|
-
* will impact existing messages in the queue potentially causing them to be
|
|
407
|
-
* expired and deleted if the <code>MessageRetentionPeriod</code> is reduced below
|
|
408
|
-
* the age of existing messages.</p>
|
|
341
|
+
* <code>MaximumMessageSize</code> – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
|
|
342
|
+
* </p>
|
|
409
343
|
* </li>
|
|
410
344
|
* <li>
|
|
411
345
|
* <p>
|
|
412
|
-
* <code>
|
|
413
|
-
*
|
|
414
|
-
* Policies</a> in the <i>IAM User Guide</i>. </p>
|
|
346
|
+
* <code>MessageRetentionPeriod</code> – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days).
|
|
347
|
+
* </p>
|
|
415
348
|
* </li>
|
|
416
349
|
* <li>
|
|
417
350
|
* <p>
|
|
418
|
-
* <code>
|
|
419
|
-
*
|
|
420
|
-
* <a>ReceiveMessage</a>
|
|
421
|
-
* </code> action waits
|
|
422
|
-
* for a message to arrive. Valid values: An integer from 0 to 20 (seconds).
|
|
423
|
-
* Default: 0. </p>
|
|
351
|
+
* <code>Policy</code> – The queue's policy. A valid Amazon Web Services policy. For more information about policy structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview of Amazon Web Services IAM Policies</a> in the <i>Amazon IAM User Guide</i>.
|
|
352
|
+
* </p>
|
|
424
353
|
* </li>
|
|
425
354
|
* <li>
|
|
426
355
|
* <p>
|
|
427
|
-
* <code>
|
|
428
|
-
*
|
|
429
|
-
*
|
|
430
|
-
*
|
|
356
|
+
* <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in seconds, for which a <code>
|
|
357
|
+
* <a>ReceiveMessage</a>
|
|
358
|
+
* </code> action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.
|
|
359
|
+
* </p>
|
|
431
360
|
* </li>
|
|
432
|
-
* </ul>
|
|
433
|
-
* <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>
|
|
434
|
-
* </p>
|
|
435
|
-
* <ul>
|
|
436
361
|
* <li>
|
|
437
362
|
* <p>
|
|
438
363
|
* <code>RedrivePolicy</code> – The string that includes the parameters for the dead-letter queue functionality
|
|
439
|
-
*
|
|
364
|
+
* of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">Using Amazon SQS Dead-Letter Queues</a>
|
|
365
|
+
* in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
440
366
|
* <ul>
|
|
441
367
|
* <li>
|
|
442
368
|
* <p>
|
|
443
|
-
* <code>deadLetterTargetArn</code> – The Amazon Resource Name (ARN) of the dead-letter queue to
|
|
444
|
-
* which Amazon SQS moves messages after the value of <code>maxReceiveCount</code> is exceeded.</p>
|
|
369
|
+
* <code>deadLetterTargetArn</code> – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of <code>maxReceiveCount</code> is exceeded.</p>
|
|
445
370
|
* </li>
|
|
446
371
|
* <li>
|
|
447
372
|
* <p>
|
|
448
|
-
* <code>maxReceiveCount</code> – The number of times a message is delivered to the source queue before being
|
|
449
|
-
*
|
|
450
|
-
* for a queue, Amazon SQS moves the message to the dead-letter-queue.</p>
|
|
373
|
+
* <code>maxReceiveCount</code> – The number of times a message is delivered to the source queue before being moved to the dead-letter queue.
|
|
374
|
+
* When the <code>ReceiveCount</code> for a message exceeds the <code>maxReceiveCount</code> for a queue, Amazon SQS moves the message to the dead-letter-queue.</p>
|
|
451
375
|
* </li>
|
|
452
376
|
* </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>
|
|
453
380
|
* </li>
|
|
454
381
|
* <li>
|
|
455
382
|
* <p>
|
|
456
|
-
* <code>
|
|
457
|
-
*
|
|
458
|
-
* <ul>
|
|
459
|
-
* <li>
|
|
460
|
-
* <p>
|
|
461
|
-
* <code>redrivePermission</code> – The permission type that defines which source queues can
|
|
462
|
-
* specify the current queue as the dead-letter queue. Valid values are:</p>
|
|
463
|
-
* <ul>
|
|
464
|
-
* <li>
|
|
465
|
-
* <p>
|
|
466
|
-
* <code>allowAll</code> – (Default) Any source queues in this Amazon Web Services account in the same Region can
|
|
467
|
-
* specify this queue as the dead-letter queue.</p>
|
|
468
|
-
* </li>
|
|
469
|
-
* <li>
|
|
470
|
-
* <p>
|
|
471
|
-
* <code>denyAll</code> – No source queues can specify this queue as the dead-letter
|
|
472
|
-
* queue.</p>
|
|
473
|
-
* </li>
|
|
474
|
-
* <li>
|
|
475
|
-
* <p>
|
|
476
|
-
* <code>byQueue</code> – Only queues specified by the <code>sourceQueueArns</code> parameter can specify
|
|
477
|
-
* this queue as the dead-letter queue.</p>
|
|
478
|
-
* </li>
|
|
479
|
-
* </ul>
|
|
480
|
-
* </li>
|
|
481
|
-
* <li>
|
|
482
|
-
* <p>
|
|
483
|
-
* <code>sourceQueueArns</code> – The Amazon Resource Names (ARN)s of the source queues that can specify
|
|
484
|
-
* this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the
|
|
485
|
-
* <code>redrivePermission</code> parameter is set to <code>byQueue</code>. You can specify up to 10 source queue ARNs.
|
|
486
|
-
* To allow more than 10 source queues to specify dead-letter queues, set the <code>redrivePermission</code> parameter
|
|
487
|
-
* to <code>allowAll</code>.</p>
|
|
488
|
-
* </li>
|
|
489
|
-
* </ul>
|
|
383
|
+
* <code>VisibilityTimeout</code> – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see
|
|
384
|
+
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
490
385
|
* </li>
|
|
491
386
|
* </ul>
|
|
492
|
-
* <note>
|
|
493
|
-
* <p>The dead-letter queue of a
|
|
494
|
-
* FIFO queue must also be a FIFO queue. Similarly, the dead-letter
|
|
495
|
-
* queue of a standard queue must also be a standard queue.</p>
|
|
496
|
-
* </note>
|
|
497
387
|
* <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html">server-side-encryption</a>:</p>
|
|
498
388
|
* <ul>
|
|
499
389
|
* <li>
|
|
500
390
|
* <p>
|
|
501
|
-
* <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer master
|
|
502
|
-
*
|
|
503
|
-
*
|
|
504
|
-
*
|
|
505
|
-
*
|
|
506
|
-
* <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
|
|
507
|
-
* Reference</i>. </p>
|
|
391
|
+
* <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key Terms</a>.
|
|
392
|
+
* While the alias of the Amazon Web Services managed CMK for Amazon SQS is always <code>alias/aws/sqs</code>, the alias of a custom CMK can, for example, be <code>alias/<i>MyAlias</i>
|
|
393
|
+
* </code>.
|
|
394
|
+
* For more examples, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a> in the <i>Key Management Service API Reference</i>.
|
|
395
|
+
* </p>
|
|
508
396
|
* </li>
|
|
509
397
|
* <li>
|
|
510
398
|
* <p>
|
|
511
|
-
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in
|
|
512
|
-
*
|
|
513
|
-
*
|
|
514
|
-
*
|
|
515
|
-
*
|
|
516
|
-
* but results in more calls to KMS which might incur charges after Free Tier. For
|
|
517
|
-
* 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>
|
|
518
|
-
* </p>
|
|
399
|
+
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in seconds, for which Amazon SQS can reuse a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data key</a> to encrypt
|
|
400
|
+
* or decrypt messages before calling KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security
|
|
401
|
+
* but results in more calls to KMS which might incur charges after Free Tier. For more information, see
|
|
402
|
+
* <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>.
|
|
403
|
+
* </p>
|
|
519
404
|
* </li>
|
|
520
405
|
* <li>
|
|
521
406
|
* <p>
|
|
522
|
-
* <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption
|
|
523
|
-
* using SQS owned encryption keys. Only one server-side encryption option is
|
|
524
|
-
* 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>
|
|
407
|
+
* <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html">SSE-KMS</a> or <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html">SSE-SQS</a>).</p>
|
|
525
408
|
* </li>
|
|
526
409
|
* </ul>
|
|
527
|
-
* <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)
|
|
528
|
-
* queues</a>:</p>
|
|
410
|
+
* <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO (first-in-first-out) queues</a>:</p>
|
|
529
411
|
* <ul>
|
|
530
412
|
* <li>
|
|
531
413
|
* <p>
|
|
532
|
-
* <code>FifoQueue</code> – Designates a queue as FIFO. Valid values are
|
|
533
|
-
*
|
|
534
|
-
*
|
|
535
|
-
*
|
|
536
|
-
*
|
|
537
|
-
*
|
|
538
|
-
* Guide</i>.</p>
|
|
414
|
+
* <code>FifoQueue</code> – Designates a queue as FIFO. Valid values are <code>true</code> and <code>false</code>. If you don't specify the <code>FifoQueue</code> attribute, Amazon SQS creates a standard queue.
|
|
415
|
+
* You can provide this attribute only during queue creation. You can't change it for an existing queue.
|
|
416
|
+
* When you set this attribute, you must also provide the <code>MessageGroupId</code> for your messages explicitly.</p>
|
|
417
|
+
* <p>For more information, see
|
|
418
|
+
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html">FIFO queue logic</a>
|
|
419
|
+
* in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
539
420
|
* </li>
|
|
540
421
|
* <li>
|
|
541
422
|
* <p>
|
|
542
|
-
* <code>ContentBasedDeduplication</code> – Enables content-based
|
|
543
|
-
*
|
|
544
|
-
*
|
|
545
|
-
* Guide</i>. Note the following: </p>
|
|
423
|
+
* <code>ContentBasedDeduplication</code> – Enables content-based deduplication. Valid values are <code>true</code> and <code>false</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html">Exactly-once processing</a> in the
|
|
424
|
+
* <i>Amazon SQS Developer Guide</i>. Note the following:
|
|
425
|
+
* </p>
|
|
546
426
|
* <ul>
|
|
547
427
|
* <li>
|
|
548
|
-
* <p>Every message must have a unique
|
|
549
|
-
* <code>MessageDeduplicationId</code>.</p>
|
|
428
|
+
* <p>Every message must have a unique <code>MessageDeduplicationId</code>.</p>
|
|
550
429
|
* <ul>
|
|
551
430
|
* <li>
|
|
552
|
-
* <p>You may provide a <code>MessageDeduplicationId</code>
|
|
553
|
-
* explicitly.</p>
|
|
431
|
+
* <p>You may provide a <code>MessageDeduplicationId</code> explicitly.</p>
|
|
554
432
|
* </li>
|
|
555
433
|
* <li>
|
|
556
|
-
* <p>If you aren't able to provide a
|
|
557
|
-
*
|
|
558
|
-
*
|
|
559
|
-
* uses a SHA-256 hash to generate the
|
|
560
|
-
* <code>MessageDeduplicationId</code> using the body of the
|
|
561
|
-
* message (but not the attributes of the message). </p>
|
|
434
|
+
* <p>If you aren't able to provide a <code>MessageDeduplicationId</code> and you enable <code>ContentBasedDeduplication</code> for your queue,
|
|
435
|
+
* Amazon SQS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using the body of the message (but not the attributes of the message).
|
|
436
|
+
* </p>
|
|
562
437
|
* </li>
|
|
563
438
|
* <li>
|
|
564
|
-
* <p>If you don't provide a <code>MessageDeduplicationId</code> and
|
|
565
|
-
*
|
|
566
|
-
* set, the action fails with an error.</p>
|
|
439
|
+
* <p>If you don't provide a <code>MessageDeduplicationId</code> and the queue doesn't have <code>ContentBasedDeduplication</code> set,
|
|
440
|
+
* the action fails with an error.</p>
|
|
567
441
|
* </li>
|
|
568
442
|
* <li>
|
|
569
|
-
* <p>If the queue has <code>ContentBasedDeduplication</code> set,
|
|
570
|
-
* your <code>MessageDeduplicationId</code> overrides the generated
|
|
571
|
-
* one.</p>
|
|
443
|
+
* <p>If the queue has <code>ContentBasedDeduplication</code> set, your <code>MessageDeduplicationId</code> overrides the generated one.</p>
|
|
572
444
|
* </li>
|
|
573
445
|
* </ul>
|
|
574
446
|
* </li>
|
|
575
447
|
* <li>
|
|
576
|
-
* <p>When <code>ContentBasedDeduplication</code> is in effect, messages
|
|
577
|
-
*
|
|
578
|
-
* treated as duplicates and only one copy of the message is
|
|
579
|
-
* delivered.</p>
|
|
448
|
+
* <p>When <code>ContentBasedDeduplication</code> is in effect, messages with identical content sent within the deduplication interval are treated as duplicates
|
|
449
|
+
* and only one copy of the message is delivered.</p>
|
|
580
450
|
* </li>
|
|
581
451
|
* <li>
|
|
582
|
-
* <p>If you send one message with <code>ContentBasedDeduplication</code>
|
|
583
|
-
*
|
|
584
|
-
*
|
|
585
|
-
* generated for the first <code>MessageDeduplicationId</code>, the two
|
|
586
|
-
* messages are treated as duplicates and only one copy of the message is
|
|
587
|
-
* delivered. </p>
|
|
452
|
+
* <p>If you send one message with <code>ContentBasedDeduplication</code> enabled and then another message with a <code>MessageDeduplicationId</code> that is the same
|
|
453
|
+
* as the one generated for the first <code>MessageDeduplicationId</code>, the two messages are treated as duplicates and only one copy of the message is delivered.
|
|
454
|
+
* </p>
|
|
588
455
|
* </li>
|
|
589
456
|
* </ul>
|
|
590
457
|
* </li>
|
|
@@ -621,36 +488,6 @@ export interface CreateQueueRequest {
|
|
|
621
488
|
* in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
622
489
|
*/
|
|
623
490
|
Attributes?: Record<string, string>;
|
|
624
|
-
/**
|
|
625
|
-
* <p>Add cost allocation tags to the specified Amazon SQS queue. For an overview, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html">Tagging
|
|
626
|
-
* Your Amazon SQS Queues</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
627
|
-
* <p>When you use queue tags, keep the following guidelines in mind:</p>
|
|
628
|
-
* <ul>
|
|
629
|
-
* <li>
|
|
630
|
-
* <p>Adding more than 50 tags to a queue isn't recommended.</p>
|
|
631
|
-
* </li>
|
|
632
|
-
* <li>
|
|
633
|
-
* <p>Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.</p>
|
|
634
|
-
* </li>
|
|
635
|
-
* <li>
|
|
636
|
-
* <p>Tags are case-sensitive.</p>
|
|
637
|
-
* </li>
|
|
638
|
-
* <li>
|
|
639
|
-
* <p>A new tag with a key identical to that of an existing tag overwrites the existing tag.</p>
|
|
640
|
-
* </li>
|
|
641
|
-
* </ul>
|
|
642
|
-
* <p>For a full list of tag restrictions, see
|
|
643
|
-
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues">Quotas related to queues</a>
|
|
644
|
-
* in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
645
|
-
* <note>
|
|
646
|
-
* <p>To be able to tag a queue on creation, you must have the
|
|
647
|
-
* <code>sqs:CreateQueue</code> and <code>sqs:TagQueue</code> permissions.</p>
|
|
648
|
-
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
649
|
-
* 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
|
|
650
|
-
* cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
651
|
-
* </note>
|
|
652
|
-
*/
|
|
653
|
-
tags?: Record<string, string>;
|
|
654
491
|
}
|
|
655
492
|
/**
|
|
656
493
|
* @public
|
|
@@ -662,30 +499,6 @@ export interface CreateQueueResult {
|
|
|
662
499
|
*/
|
|
663
500
|
QueueUrl?: string;
|
|
664
501
|
}
|
|
665
|
-
/**
|
|
666
|
-
* @public
|
|
667
|
-
* <p>The specified attribute doesn't exist.</p>
|
|
668
|
-
*/
|
|
669
|
-
export declare class InvalidAttributeName extends __BaseException {
|
|
670
|
-
readonly name: "InvalidAttributeName";
|
|
671
|
-
readonly $fault: "client";
|
|
672
|
-
/**
|
|
673
|
-
* @internal
|
|
674
|
-
*/
|
|
675
|
-
constructor(opts: __ExceptionOptionType<InvalidAttributeName, __BaseException>);
|
|
676
|
-
}
|
|
677
|
-
/**
|
|
678
|
-
* @public
|
|
679
|
-
* <p>A queue attribute value is invalid.</p>
|
|
680
|
-
*/
|
|
681
|
-
export declare class InvalidAttributeValue extends __BaseException {
|
|
682
|
-
readonly name: "InvalidAttributeValue";
|
|
683
|
-
readonly $fault: "client";
|
|
684
|
-
/**
|
|
685
|
-
* @internal
|
|
686
|
-
*/
|
|
687
|
-
constructor(opts: __ExceptionOptionType<InvalidAttributeValue, __BaseException>);
|
|
688
|
-
}
|
|
689
502
|
/**
|
|
690
503
|
* @public
|
|
691
504
|
* <p>You must wait 60 seconds after deleting a queue before you can create another queue
|
|
@@ -729,8 +542,6 @@ export interface DeleteMessageRequest {
|
|
|
729
542
|
}
|
|
730
543
|
/**
|
|
731
544
|
* @public
|
|
732
|
-
* @deprecated
|
|
733
|
-
*
|
|
734
545
|
* <p>The specified receipt handle isn't valid for the current version.</p>
|
|
735
546
|
*/
|
|
736
547
|
export declare class InvalidIdFormat extends __BaseException {
|
|
@@ -747,8 +558,7 @@ export declare class InvalidIdFormat extends __BaseException {
|
|
|
747
558
|
*/
|
|
748
559
|
export interface DeleteMessageBatchRequestEntry {
|
|
749
560
|
/**
|
|
750
|
-
* <p>An identifier for this particular receipt handle. This is used to communicate the
|
|
751
|
-
* result.</p>
|
|
561
|
+
* <p>An identifier for this particular receipt handle. This is used to communicate the result.</p>
|
|
752
562
|
* <note>
|
|
753
563
|
* <p>The <code>Id</code>s of a batch request need to be unique within a request.</p>
|
|
754
564
|
* <p>This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).</p>
|
|
@@ -789,13 +599,11 @@ export interface DeleteMessageBatchResultEntry {
|
|
|
789
599
|
}
|
|
790
600
|
/**
|
|
791
601
|
* @public
|
|
792
|
-
* <p>For each message in the batch, the response contains a
|
|
602
|
+
* <p>For each message in the batch, the response contains a <code>
|
|
793
603
|
* <a>DeleteMessageBatchResultEntry</a>
|
|
794
|
-
* </code> tag if the message is deleted
|
|
795
|
-
* or a <code>
|
|
604
|
+
* </code> tag if the message is deleted or a <code>
|
|
796
605
|
* <a>BatchResultErrorEntry</a>
|
|
797
|
-
* </code> tag if the message can't be
|
|
798
|
-
* deleted.</p>
|
|
606
|
+
* </code> tag if the message can't be deleted.</p>
|
|
799
607
|
*/
|
|
800
608
|
export interface DeleteMessageBatchResult {
|
|
801
609
|
/**
|
|
@@ -834,18 +642,17 @@ export interface GetQueueAttributesRequest {
|
|
|
834
642
|
QueueUrl: string | undefined;
|
|
835
643
|
/**
|
|
836
644
|
* <p>A list of attributes for which to retrieve information.</p>
|
|
837
|
-
* <p>The <code>
|
|
838
|
-
*
|
|
645
|
+
* <p>The <code>AttributeName.N</code> parameter is optional, but if you don't specify values for this parameter,
|
|
646
|
+
* the request returns empty results.</p>
|
|
839
647
|
* <note>
|
|
840
648
|
* <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>
|
|
841
649
|
* </note>
|
|
842
650
|
* <p>The following attributes are supported:</p>
|
|
843
651
|
* <important>
|
|
844
|
-
* <p>The <code>ApproximateNumberOfMessagesDelayed</code>,
|
|
845
|
-
*
|
|
846
|
-
*
|
|
847
|
-
*
|
|
848
|
-
* required for the queue metadata to reach eventual consistency. </p>
|
|
652
|
+
* <p>The <code>ApproximateNumberOfMessagesDelayed</code>, <code>ApproximateNumberOfMessagesNotVisible</code>,
|
|
653
|
+
* and <code>ApproximateNumberOfMessagesVisible</code> metrics may not achieve consistency
|
|
654
|
+
* until at least 1 minute after the producers stop sending messages. This period is required for
|
|
655
|
+
* the queue metadata to reach eventual consistency. </p>
|
|
849
656
|
* </important>
|
|
850
657
|
* <ul>
|
|
851
658
|
* <li>
|
|
@@ -854,29 +661,28 @@ export interface GetQueueAttributesRequest {
|
|
|
854
661
|
* </li>
|
|
855
662
|
* <li>
|
|
856
663
|
* <p>
|
|
857
|
-
* <code>ApproximateNumberOfMessages</code> – Returns the approximate
|
|
858
|
-
*
|
|
664
|
+
* <code>ApproximateNumberOfMessages</code> – Returns the approximate number of
|
|
665
|
+
* messages available for retrieval from the queue.</p>
|
|
859
666
|
* </li>
|
|
860
667
|
* <li>
|
|
861
668
|
* <p>
|
|
862
|
-
* <code>ApproximateNumberOfMessagesDelayed</code> – Returns the
|
|
863
|
-
*
|
|
864
|
-
*
|
|
865
|
-
*
|
|
669
|
+
* <code>ApproximateNumberOfMessagesDelayed</code> – Returns the approximate number
|
|
670
|
+
* of messages in the queue that are delayed and not available for reading
|
|
671
|
+
* immediately. This can happen when the queue is configured as a delay queue or
|
|
672
|
+
* when a message has been sent with a delay parameter.</p>
|
|
866
673
|
* </li>
|
|
867
674
|
* <li>
|
|
868
675
|
* <p>
|
|
869
|
-
* <code>ApproximateNumberOfMessagesNotVisible</code> – Returns the
|
|
870
|
-
*
|
|
676
|
+
* <code>ApproximateNumberOfMessagesNotVisible</code> – Returns the approximate
|
|
677
|
+
* number of messages that are in flight. Messages are considered to be
|
|
871
678
|
* <i>in flight</i> if they have been sent to a client but have
|
|
872
|
-
* not yet been deleted or have not yet reached the end of their visibility window.
|
|
873
|
-
* </p>
|
|
679
|
+
* not yet been deleted or have not yet reached the end of their visibility window. </p>
|
|
874
680
|
* </li>
|
|
875
681
|
* <li>
|
|
876
682
|
* <p>
|
|
877
|
-
* <code>CreatedTimestamp</code> – Returns the time when the queue was
|
|
878
|
-
*
|
|
879
|
-
*
|
|
683
|
+
* <code>CreatedTimestamp</code> – Returns the time when the queue was created in
|
|
684
|
+
* seconds (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch
|
|
685
|
+
* time</a>).</p>
|
|
880
686
|
* </li>
|
|
881
687
|
* <li>
|
|
882
688
|
* <p>
|
|
@@ -885,24 +691,19 @@ export interface GetQueueAttributesRequest {
|
|
|
885
691
|
* </li>
|
|
886
692
|
* <li>
|
|
887
693
|
* <p>
|
|
888
|
-
* <code>LastModifiedTimestamp</code> – Returns the time when the queue
|
|
889
|
-
*
|
|
694
|
+
* <code>LastModifiedTimestamp</code> – Returns the time when the queue was last
|
|
695
|
+
* changed in seconds (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch
|
|
696
|
+
* time</a>).</p>
|
|
890
697
|
* </li>
|
|
891
698
|
* <li>
|
|
892
699
|
* <p>
|
|
893
|
-
* <code>MaximumMessageSize</code> – Returns the limit of how many bytes a
|
|
894
|
-
*
|
|
700
|
+
* <code>MaximumMessageSize</code> – Returns the limit of how many bytes a message
|
|
701
|
+
* can contain before Amazon SQS rejects it.</p>
|
|
895
702
|
* </li>
|
|
896
703
|
* <li>
|
|
897
704
|
* <p>
|
|
898
|
-
* <code>MessageRetentionPeriod</code> – Returns the length of time, in
|
|
899
|
-
*
|
|
900
|
-
* attributes, the change can take up to 60 seconds for most of the attributes to
|
|
901
|
-
* propagate throughout the Amazon SQS system. Changes made to the
|
|
902
|
-
* <code>MessageRetentionPeriod</code> attribute can take up to 15 minutes and
|
|
903
|
-
* will impact existing messages in the queue potentially causing them to be
|
|
904
|
-
* expired and deleted if the <code>MessageRetentionPeriod</code> is reduced below
|
|
905
|
-
* the age of existing messages.</p>
|
|
705
|
+
* <code>MessageRetentionPeriod</code> – Returns the length of time, in seconds,
|
|
706
|
+
* for which Amazon SQS retains a message.</p>
|
|
906
707
|
* </li>
|
|
907
708
|
* <li>
|
|
908
709
|
* <p>
|
|
@@ -915,119 +716,64 @@ export interface GetQueueAttributesRequest {
|
|
|
915
716
|
* </li>
|
|
916
717
|
* <li>
|
|
917
718
|
* <p>
|
|
918
|
-
* <code>ReceiveMessageWaitTimeSeconds</code> – Returns the length of
|
|
919
|
-
*
|
|
920
|
-
*
|
|
921
|
-
* </li>
|
|
922
|
-
* <li>
|
|
923
|
-
* <p>
|
|
924
|
-
* <code>VisibilityTimeout</code> – Returns the visibility timeout for the
|
|
925
|
-
* 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
|
|
926
|
-
* Guide</i>. </p>
|
|
719
|
+
* <code>ReceiveMessageWaitTimeSeconds</code> – Returns the length of time, in
|
|
720
|
+
* seconds, for which the <code>ReceiveMessage</code> action waits for a message to
|
|
721
|
+
* arrive. </p>
|
|
927
722
|
* </li>
|
|
928
|
-
* </ul>
|
|
929
|
-
* <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>
|
|
930
|
-
* </p>
|
|
931
|
-
* <ul>
|
|
932
723
|
* <li>
|
|
933
724
|
* <p>
|
|
934
725
|
* <code>RedrivePolicy</code> – The string that includes the parameters for the dead-letter queue functionality
|
|
935
|
-
*
|
|
726
|
+
* of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">Using Amazon SQS Dead-Letter Queues</a>
|
|
727
|
+
* in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
936
728
|
* <ul>
|
|
937
729
|
* <li>
|
|
938
730
|
* <p>
|
|
939
|
-
* <code>deadLetterTargetArn</code> – The Amazon Resource Name (ARN) of the dead-letter queue to
|
|
940
|
-
* which Amazon SQS moves messages after the value of <code>maxReceiveCount</code> is exceeded.</p>
|
|
731
|
+
* <code>deadLetterTargetArn</code> – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of <code>maxReceiveCount</code> is exceeded.</p>
|
|
941
732
|
* </li>
|
|
942
733
|
* <li>
|
|
943
734
|
* <p>
|
|
944
|
-
* <code>maxReceiveCount</code> – The number of times a message is delivered to the source queue before being
|
|
945
|
-
*
|
|
946
|
-
* for a queue, Amazon SQS moves the message to the dead-letter-queue.</p>
|
|
735
|
+
* <code>maxReceiveCount</code> – The number of times a message is delivered to the source queue before being moved to the dead-letter queue.
|
|
736
|
+
* When the <code>ReceiveCount</code> for a message exceeds the <code>maxReceiveCount</code> for a queue, Amazon SQS moves the message to the dead-letter-queue.</p>
|
|
947
737
|
* </li>
|
|
948
738
|
* </ul>
|
|
949
739
|
* </li>
|
|
950
740
|
* <li>
|
|
951
741
|
* <p>
|
|
952
|
-
* <code>
|
|
953
|
-
*
|
|
954
|
-
* <ul>
|
|
955
|
-
* <li>
|
|
956
|
-
* <p>
|
|
957
|
-
* <code>redrivePermission</code> – The permission type that defines which source queues can
|
|
958
|
-
* specify the current queue as the dead-letter queue. Valid values are:</p>
|
|
959
|
-
* <ul>
|
|
960
|
-
* <li>
|
|
961
|
-
* <p>
|
|
962
|
-
* <code>allowAll</code> – (Default) Any source queues in this Amazon Web Services account in the same Region can
|
|
963
|
-
* specify this queue as the dead-letter queue.</p>
|
|
964
|
-
* </li>
|
|
965
|
-
* <li>
|
|
966
|
-
* <p>
|
|
967
|
-
* <code>denyAll</code> – No source queues can specify this queue as the dead-letter
|
|
968
|
-
* queue.</p>
|
|
969
|
-
* </li>
|
|
970
|
-
* <li>
|
|
971
|
-
* <p>
|
|
972
|
-
* <code>byQueue</code> – Only queues specified by the <code>sourceQueueArns</code> parameter can specify
|
|
973
|
-
* this queue as the dead-letter queue.</p>
|
|
974
|
-
* </li>
|
|
975
|
-
* </ul>
|
|
976
|
-
* </li>
|
|
977
|
-
* <li>
|
|
978
|
-
* <p>
|
|
979
|
-
* <code>sourceQueueArns</code> – The Amazon Resource Names (ARN)s of the source queues that can specify
|
|
980
|
-
* this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the
|
|
981
|
-
* <code>redrivePermission</code> parameter is set to <code>byQueue</code>. You can specify up to 10 source queue ARNs.
|
|
982
|
-
* To allow more than 10 source queues to specify dead-letter queues, set the <code>redrivePermission</code> parameter
|
|
983
|
-
* to <code>allowAll</code>.</p>
|
|
984
|
-
* </li>
|
|
985
|
-
* </ul>
|
|
742
|
+
* <code>VisibilityTimeout</code> – Returns the visibility timeout for the 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 Guide</i>.
|
|
743
|
+
* </p>
|
|
986
744
|
* </li>
|
|
987
745
|
* </ul>
|
|
988
|
-
* <note>
|
|
989
|
-
* <p>The dead-letter queue of a
|
|
990
|
-
* FIFO queue must also be a FIFO queue. Similarly, the dead-letter
|
|
991
|
-
* queue of a standard queue must also be a standard queue.</p>
|
|
992
|
-
* </note>
|
|
993
746
|
* <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html">server-side-encryption</a>:</p>
|
|
994
747
|
* <ul>
|
|
995
748
|
* <li>
|
|
996
749
|
* <p>
|
|
997
|
-
* <code>KmsMasterKeyId</code> – Returns the ID of an Amazon Web Services managed customer
|
|
998
|
-
*
|
|
750
|
+
* <code>KmsMasterKeyId</code> – Returns the ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key Terms</a>.
|
|
751
|
+
* </p>
|
|
999
752
|
* </li>
|
|
1000
753
|
* <li>
|
|
1001
754
|
* <p>
|
|
1002
|
-
* <code>KmsDataKeyReusePeriodSeconds</code> – Returns the length of time,
|
|
1003
|
-
*
|
|
1004
|
-
*
|
|
1005
|
-
* <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>
|
|
755
|
+
* <code>KmsDataKeyReusePeriodSeconds</code> – Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling KMS again.
|
|
756
|
+
* For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work">How Does the Data Key Reuse Period Work?</a>.
|
|
757
|
+
* </p>
|
|
1006
758
|
* </li>
|
|
1007
759
|
* <li>
|
|
1008
760
|
* <p>
|
|
1009
|
-
* <code>SqsManagedSseEnabled</code> – Returns information about whether the
|
|
1010
|
-
* queue is using SSE-SQS encryption using SQS owned encryption keys. Only one
|
|
1011
|
-
* 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>
|
|
761
|
+
* <code>SqsManagedSseEnabled</code> – Returns information about whether the queue is using SSE-SQS encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html">SSE-KMS</a> or <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html">SSE-SQS</a>).</p>
|
|
1012
762
|
* </li>
|
|
1013
763
|
* </ul>
|
|
1014
|
-
* <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)
|
|
1015
|
-
* queues</a>:</p>
|
|
764
|
+
* <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO (first-in-first-out) queues</a>:</p>
|
|
1016
765
|
* <ul>
|
|
1017
766
|
* <li>
|
|
1018
767
|
* <p>
|
|
1019
|
-
* <code>FifoQueue</code> – Returns information about whether the queue is
|
|
1020
|
-
* 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
|
|
1021
|
-
* Guide</i>.</p>
|
|
768
|
+
* <code>FifoQueue</code> – Returns information about whether the queue is FIFO. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html">FIFO queue logic</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
1022
769
|
* <note>
|
|
1023
770
|
* <p>To determine whether a queue is <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO</a>, you can check whether <code>QueueName</code> ends with the <code>.fifo</code> suffix.</p>
|
|
1024
771
|
* </note>
|
|
1025
772
|
* </li>
|
|
1026
773
|
* <li>
|
|
1027
774
|
* <p>
|
|
1028
|
-
* <code>ContentBasedDeduplication</code> – Returns whether content-based
|
|
1029
|
-
*
|
|
1030
|
-
* Guide</i>. </p>
|
|
775
|
+
* <code>ContentBasedDeduplication</code> – Returns whether content-based deduplication is enabled for the queue. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html">Exactly-once processing</a> in the <i>Amazon SQS Developer Guide</i>.
|
|
776
|
+
* </p>
|
|
1031
777
|
* </li>
|
|
1032
778
|
* </ul>
|
|
1033
779
|
* <p>The following attributes apply only to
|
|
@@ -1073,15 +819,25 @@ export interface GetQueueAttributesResult {
|
|
|
1073
819
|
*/
|
|
1074
820
|
Attributes?: Record<string, string>;
|
|
1075
821
|
}
|
|
822
|
+
/**
|
|
823
|
+
* @public
|
|
824
|
+
* <p>The specified attribute doesn't exist.</p>
|
|
825
|
+
*/
|
|
826
|
+
export declare class InvalidAttributeName extends __BaseException {
|
|
827
|
+
readonly name: "InvalidAttributeName";
|
|
828
|
+
readonly $fault: "client";
|
|
829
|
+
/**
|
|
830
|
+
* @internal
|
|
831
|
+
*/
|
|
832
|
+
constructor(opts: __ExceptionOptionType<InvalidAttributeName, __BaseException>);
|
|
833
|
+
}
|
|
1076
834
|
/**
|
|
1077
835
|
* @public
|
|
1078
836
|
* <p></p>
|
|
1079
837
|
*/
|
|
1080
838
|
export interface GetQueueUrlRequest {
|
|
1081
839
|
/**
|
|
1082
|
-
* <p>The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values:
|
|
1083
|
-
* alphanumeric characters, hyphens (<code>-</code>), and underscores
|
|
1084
|
-
* (<code>_</code>).</p>
|
|
840
|
+
* <p>The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values: alphanumeric characters, hyphens (<code>-</code>), and underscores (<code>_</code>).</p>
|
|
1085
841
|
* <p>Queue URLs and names are case-sensitive.</p>
|
|
1086
842
|
*/
|
|
1087
843
|
QueueName: string | undefined;
|
|
@@ -1092,8 +848,7 @@ export interface GetQueueUrlRequest {
|
|
|
1092
848
|
}
|
|
1093
849
|
/**
|
|
1094
850
|
* @public
|
|
1095
|
-
* <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
|
|
1096
|
-
* Guide</i>.</p>
|
|
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 Guide</i>.</p>
|
|
1097
852
|
*/
|
|
1098
853
|
export interface GetQueueUrlResult {
|
|
1099
854
|
/**
|
|
@@ -1101,6 +856,18 @@ export interface GetQueueUrlResult {
|
|
|
1101
856
|
*/
|
|
1102
857
|
QueueUrl?: string;
|
|
1103
858
|
}
|
|
859
|
+
/**
|
|
860
|
+
* @public
|
|
861
|
+
* <p>The specified queue doesn't exist.</p>
|
|
862
|
+
*/
|
|
863
|
+
export declare class QueueDoesNotExist extends __BaseException {
|
|
864
|
+
readonly name: "QueueDoesNotExist";
|
|
865
|
+
readonly $fault: "client";
|
|
866
|
+
/**
|
|
867
|
+
* @internal
|
|
868
|
+
*/
|
|
869
|
+
constructor(opts: __ExceptionOptionType<QueueDoesNotExist, __BaseException>);
|
|
870
|
+
}
|
|
1104
871
|
/**
|
|
1105
872
|
* @public
|
|
1106
873
|
* <p></p>
|
|
@@ -1116,9 +883,8 @@ export interface ListDeadLetterSourceQueuesRequest {
|
|
|
1116
883
|
*/
|
|
1117
884
|
NextToken?: string;
|
|
1118
885
|
/**
|
|
1119
|
-
* <p>Maximum number of results to include in the response. Value range is 1 to 1000.
|
|
1120
|
-
*
|
|
1121
|
-
* response.</p>
|
|
886
|
+
* <p>Maximum number of results to include in the response. Value range is 1 to 1000.
|
|
887
|
+
* You must set <code>MaxResults</code> to receive a value for <code>NextToken</code> in the response.</p>
|
|
1122
888
|
*/
|
|
1123
889
|
MaxResults?: number;
|
|
1124
890
|
}
|
|
@@ -1128,14 +894,12 @@ export interface ListDeadLetterSourceQueuesRequest {
|
|
|
1128
894
|
*/
|
|
1129
895
|
export interface ListDeadLetterSourceQueuesResult {
|
|
1130
896
|
/**
|
|
1131
|
-
* <p>A list of source queue URLs that have the <code>RedrivePolicy</code> queue attribute
|
|
1132
|
-
* configured with a dead-letter queue.</p>
|
|
897
|
+
* <p>A list of source queue URLs that have the <code>RedrivePolicy</code> queue attribute configured with a dead-letter queue.</p>
|
|
1133
898
|
*/
|
|
1134
899
|
queueUrls: string[] | undefined;
|
|
1135
900
|
/**
|
|
1136
|
-
* <p>Pagination token to include in the next request. Token value is <code>null</code> if
|
|
1137
|
-
*
|
|
1138
|
-
* <code>MaxResults</code> in the request.</p>
|
|
901
|
+
* <p>Pagination token to include in the next request. Token value is <code>null</code> if there are no additional
|
|
902
|
+
* results to request, or if you did not set <code>MaxResults</code> in the request.</p>
|
|
1139
903
|
*/
|
|
1140
904
|
NextToken?: string;
|
|
1141
905
|
}
|
|
@@ -1145,8 +909,7 @@ export interface ListDeadLetterSourceQueuesResult {
|
|
|
1145
909
|
*/
|
|
1146
910
|
export interface ListQueuesRequest {
|
|
1147
911
|
/**
|
|
1148
|
-
* <p>A string to use for filtering the list results. Only those queues whose name begins
|
|
1149
|
-
* with the specified string are returned.</p>
|
|
912
|
+
* <p>A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.</p>
|
|
1150
913
|
* <p>Queue URLs and names are case-sensitive.</p>
|
|
1151
914
|
*/
|
|
1152
915
|
QueueNamePrefix?: string;
|
|
@@ -1155,9 +918,8 @@ export interface ListQueuesRequest {
|
|
|
1155
918
|
*/
|
|
1156
919
|
NextToken?: string;
|
|
1157
920
|
/**
|
|
1158
|
-
* <p>Maximum number of results to include in the response. Value range is 1 to 1000.
|
|
1159
|
-
*
|
|
1160
|
-
* response.</p>
|
|
921
|
+
* <p>Maximum number of results to include in the response. Value range is 1 to 1000.
|
|
922
|
+
* You must set <code>MaxResults</code> to receive a value for <code>NextToken</code> in the response.</p>
|
|
1161
923
|
*/
|
|
1162
924
|
MaxResults?: number;
|
|
1163
925
|
}
|
|
@@ -1167,16 +929,14 @@ export interface ListQueuesRequest {
|
|
|
1167
929
|
*/
|
|
1168
930
|
export interface ListQueuesResult {
|
|
1169
931
|
/**
|
|
1170
|
-
* <p>
|
|
1171
|
-
*
|
|
932
|
+
* <p>Pagination token to include in the next request. Token value is <code>null</code> if there are no additional
|
|
933
|
+
* results to request, or if you did not set <code>MaxResults</code> in the request.</p>
|
|
1172
934
|
*/
|
|
1173
|
-
|
|
935
|
+
NextToken?: string;
|
|
1174
936
|
/**
|
|
1175
|
-
* <p>
|
|
1176
|
-
* there are no additional results to request, or if you did not set
|
|
1177
|
-
* <code>MaxResults</code> in the request.</p>
|
|
937
|
+
* <p>A list of queue URLs, up to 1,000 entries, or the value of MaxResults that you sent in the request.</p>
|
|
1178
938
|
*/
|
|
1179
|
-
|
|
939
|
+
QueueUrls?: string[];
|
|
1180
940
|
}
|
|
1181
941
|
/**
|
|
1182
942
|
* @public
|
|
@@ -1198,9 +958,7 @@ export interface ListQueueTagsResult {
|
|
|
1198
958
|
}
|
|
1199
959
|
/**
|
|
1200
960
|
* @public
|
|
1201
|
-
* <p>Indicates that the specified queue previously received a <code>PurgeQueue</code>
|
|
1202
|
-
* request within the last 60 seconds (the time it can take to delete the messages in the
|
|
1203
|
-
* queue).</p>
|
|
961
|
+
* <p>Indicates that the specified queue previously received a <code>PurgeQueue</code> request within the last 60 seconds (the time it can take to delete the messages in the queue).</p>
|
|
1204
962
|
*/
|
|
1205
963
|
export declare class PurgeQueueInProgress extends __BaseException {
|
|
1206
964
|
readonly name: "PurgeQueueInProgress";
|
|
@@ -1216,109 +974,11 @@ export declare class PurgeQueueInProgress extends __BaseException {
|
|
|
1216
974
|
*/
|
|
1217
975
|
export interface PurgeQueueRequest {
|
|
1218
976
|
/**
|
|
1219
|
-
* <p>The URL of the queue from which the <code>PurgeQueue</code> action deletes
|
|
1220
|
-
* messages.</p>
|
|
977
|
+
* <p>The URL of the queue from which the <code>PurgeQueue</code> action deletes messages.</p>
|
|
1221
978
|
* <p>Queue URLs and names are case-sensitive.</p>
|
|
1222
979
|
*/
|
|
1223
980
|
QueueUrl: string | undefined;
|
|
1224
981
|
}
|
|
1225
|
-
/**
|
|
1226
|
-
* @public
|
|
1227
|
-
* <p>The caller doesn't have the required KMS access.</p>
|
|
1228
|
-
*/
|
|
1229
|
-
export declare class KmsAccessDenied extends __BaseException {
|
|
1230
|
-
readonly name: "KmsAccessDenied";
|
|
1231
|
-
readonly $fault: "client";
|
|
1232
|
-
/**
|
|
1233
|
-
* @internal
|
|
1234
|
-
*/
|
|
1235
|
-
constructor(opts: __ExceptionOptionType<KmsAccessDenied, __BaseException>);
|
|
1236
|
-
}
|
|
1237
|
-
/**
|
|
1238
|
-
* @public
|
|
1239
|
-
* <p>The request was denied due to request throttling.</p>
|
|
1240
|
-
*/
|
|
1241
|
-
export declare class KmsDisabled extends __BaseException {
|
|
1242
|
-
readonly name: "KmsDisabled";
|
|
1243
|
-
readonly $fault: "client";
|
|
1244
|
-
/**
|
|
1245
|
-
* @internal
|
|
1246
|
-
*/
|
|
1247
|
-
constructor(opts: __ExceptionOptionType<KmsDisabled, __BaseException>);
|
|
1248
|
-
}
|
|
1249
|
-
/**
|
|
1250
|
-
* @public
|
|
1251
|
-
* <p>The request was rejected for one of the following reasons:</p>
|
|
1252
|
-
* <ul>
|
|
1253
|
-
* <li>
|
|
1254
|
-
* <p>The KeyUsage value of the KMS key is incompatible with the API
|
|
1255
|
-
* operation.</p>
|
|
1256
|
-
* </li>
|
|
1257
|
-
* <li>
|
|
1258
|
-
* <p>The encryption algorithm or signing algorithm specified for the operation is
|
|
1259
|
-
* incompatible with the type of key material in the KMS key (KeySpec).</p>
|
|
1260
|
-
* </li>
|
|
1261
|
-
* </ul>
|
|
1262
|
-
*/
|
|
1263
|
-
export declare class KmsInvalidKeyUsage extends __BaseException {
|
|
1264
|
-
readonly name: "KmsInvalidKeyUsage";
|
|
1265
|
-
readonly $fault: "client";
|
|
1266
|
-
/**
|
|
1267
|
-
* @internal
|
|
1268
|
-
*/
|
|
1269
|
-
constructor(opts: __ExceptionOptionType<KmsInvalidKeyUsage, __BaseException>);
|
|
1270
|
-
}
|
|
1271
|
-
/**
|
|
1272
|
-
* @public
|
|
1273
|
-
* <p>The request was rejected because the state of the specified resource is not valid for
|
|
1274
|
-
* this request.</p>
|
|
1275
|
-
*/
|
|
1276
|
-
export declare class KmsInvalidState extends __BaseException {
|
|
1277
|
-
readonly name: "KmsInvalidState";
|
|
1278
|
-
readonly $fault: "client";
|
|
1279
|
-
/**
|
|
1280
|
-
* @internal
|
|
1281
|
-
*/
|
|
1282
|
-
constructor(opts: __ExceptionOptionType<KmsInvalidState, __BaseException>);
|
|
1283
|
-
}
|
|
1284
|
-
/**
|
|
1285
|
-
* @public
|
|
1286
|
-
* <p>The request was rejected because the specified entity or resource could not be found.
|
|
1287
|
-
* </p>
|
|
1288
|
-
*/
|
|
1289
|
-
export declare class KmsNotFound extends __BaseException {
|
|
1290
|
-
readonly name: "KmsNotFound";
|
|
1291
|
-
readonly $fault: "client";
|
|
1292
|
-
/**
|
|
1293
|
-
* @internal
|
|
1294
|
-
*/
|
|
1295
|
-
constructor(opts: __ExceptionOptionType<KmsNotFound, __BaseException>);
|
|
1296
|
-
}
|
|
1297
|
-
/**
|
|
1298
|
-
* @public
|
|
1299
|
-
* <p>The request was rejected because the specified key policy isn't syntactically or
|
|
1300
|
-
* semantically correct.</p>
|
|
1301
|
-
*/
|
|
1302
|
-
export declare class KmsOptInRequired extends __BaseException {
|
|
1303
|
-
readonly name: "KmsOptInRequired";
|
|
1304
|
-
readonly $fault: "client";
|
|
1305
|
-
/**
|
|
1306
|
-
* @internal
|
|
1307
|
-
*/
|
|
1308
|
-
constructor(opts: __ExceptionOptionType<KmsOptInRequired, __BaseException>);
|
|
1309
|
-
}
|
|
1310
|
-
/**
|
|
1311
|
-
* @public
|
|
1312
|
-
* <p>Amazon Web Services KMS throttles requests for the following conditions.</p>
|
|
1313
|
-
*/
|
|
1314
|
-
export declare class KmsThrottled extends __BaseException {
|
|
1315
|
-
readonly name: "KmsThrottled";
|
|
1316
|
-
readonly $fault: "client";
|
|
1317
|
-
/**
|
|
1318
|
-
* @internal
|
|
1319
|
-
*/
|
|
1320
|
-
constructor(opts: __ExceptionOptionType<KmsThrottled, __BaseException>);
|
|
1321
|
-
}
|
|
1322
982
|
/**
|
|
1323
983
|
* @public
|
|
1324
984
|
* <p></p>
|
|
@@ -1330,8 +990,8 @@ export interface ReceiveMessageRequest {
|
|
|
1330
990
|
*/
|
|
1331
991
|
QueueUrl: string | undefined;
|
|
1332
992
|
/**
|
|
1333
|
-
* <p>A list of attributes that need to be returned along with each message. These
|
|
1334
|
-
*
|
|
993
|
+
* <p>A list of attributes that need to be returned along with each message. These attributes
|
|
994
|
+
* include:</p>
|
|
1335
995
|
* <ul>
|
|
1336
996
|
* <li>
|
|
1337
997
|
* <p>
|
|
@@ -1339,19 +999,16 @@ export interface ReceiveMessageRequest {
|
|
|
1339
999
|
* </li>
|
|
1340
1000
|
* <li>
|
|
1341
1001
|
* <p>
|
|
1342
|
-
* <code>ApproximateFirstReceiveTimestamp</code> – Returns the time the
|
|
1343
|
-
* message was first received from the queue (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a> in
|
|
1344
|
-
* milliseconds).</p>
|
|
1002
|
+
* <code>ApproximateFirstReceiveTimestamp</code> – Returns the time the message was first received from the queue (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a> in milliseconds).</p>
|
|
1345
1003
|
* </li>
|
|
1346
1004
|
* <li>
|
|
1347
1005
|
* <p>
|
|
1348
|
-
* <code>ApproximateReceiveCount</code> – Returns the number of times a
|
|
1349
|
-
* message has been received across all queues but not deleted.</p>
|
|
1006
|
+
* <code>ApproximateReceiveCount</code> – Returns the number of times a message has been received across all queues but not deleted.</p>
|
|
1350
1007
|
* </li>
|
|
1351
1008
|
* <li>
|
|
1352
1009
|
* <p>
|
|
1353
|
-
* <code>AWSTraceHeader</code> – Returns the X-Ray trace
|
|
1354
|
-
*
|
|
1010
|
+
* <code>AWSTraceHeader</code> – Returns the X-Ray trace header string.
|
|
1011
|
+
* </p>
|
|
1355
1012
|
* </li>
|
|
1356
1013
|
* <li>
|
|
1357
1014
|
* <p>
|
|
@@ -1359,26 +1016,20 @@ export interface ReceiveMessageRequest {
|
|
|
1359
1016
|
* </p>
|
|
1360
1017
|
* <ul>
|
|
1361
1018
|
* <li>
|
|
1362
|
-
* <p>For
|
|
1363
|
-
* <code>ABCDEFGHI1JKLMNOPQ23R</code>.</p>
|
|
1019
|
+
* <p>For an IAM user, returns the IAM user ID, for example <code>ABCDEFGHI1JKLMNOPQ23R</code>.</p>
|
|
1364
1020
|
* </li>
|
|
1365
1021
|
* <li>
|
|
1366
|
-
* <p>For an IAM role, returns the IAM role ID, for example
|
|
1367
|
-
* <code>ABCDE1F2GH3I4JK5LMNOP:i-a123b456</code>.</p>
|
|
1022
|
+
* <p>For an IAM role, returns the IAM role ID, for example <code>ABCDE1F2GH3I4JK5LMNOP:i-a123b456</code>.</p>
|
|
1368
1023
|
* </li>
|
|
1369
1024
|
* </ul>
|
|
1370
1025
|
* </li>
|
|
1371
1026
|
* <li>
|
|
1372
1027
|
* <p>
|
|
1373
|
-
* <code>SentTimestamp</code> – Returns the time the message was sent to the
|
|
1374
|
-
* queue (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a> in
|
|
1375
|
-
* milliseconds).</p>
|
|
1028
|
+
* <code>SentTimestamp</code> – Returns the time the message was sent to the queue (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a> in milliseconds).</p>
|
|
1376
1029
|
* </li>
|
|
1377
1030
|
* <li>
|
|
1378
1031
|
* <p>
|
|
1379
|
-
* <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption
|
|
1380
|
-
* using SQS owned encryption keys. Only one server-side encryption option is
|
|
1381
|
-
* 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>
|
|
1032
|
+
* <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html">SSE-KMS</a> or <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html">SSE-SQS</a>).</p>
|
|
1382
1033
|
* </li>
|
|
1383
1034
|
* <li>
|
|
1384
1035
|
* <p>
|
|
@@ -1390,17 +1041,15 @@ export interface ReceiveMessageRequest {
|
|
|
1390
1041
|
* </li>
|
|
1391
1042
|
* <li>
|
|
1392
1043
|
* <p>
|
|
1393
|
-
* <code>MessageGroupId</code> – Returns the value provided by the
|
|
1394
|
-
*
|
|
1044
|
+
* <code>MessageGroupId</code> – Returns the value provided by the producer that
|
|
1045
|
+
* calls the <code>
|
|
1395
1046
|
* <a>SendMessage</a>
|
|
1396
|
-
* </code> action.
|
|
1397
|
-
*
|
|
1398
|
-
* sequence.</p>
|
|
1047
|
+
* </code> action. Messages with the
|
|
1048
|
+
* same <code>MessageGroupId</code> are returned in sequence.</p>
|
|
1399
1049
|
* </li>
|
|
1400
1050
|
* <li>
|
|
1401
1051
|
* <p>
|
|
1402
|
-
* <code>SequenceNumber</code> – Returns the value provided by
|
|
1403
|
-
* Amazon SQS.</p>
|
|
1052
|
+
* <code>SequenceNumber</code> – Returns the value provided by Amazon SQS.</p>
|
|
1404
1053
|
* </li>
|
|
1405
1054
|
* </ul>
|
|
1406
1055
|
*/
|
|
@@ -1409,89 +1058,65 @@ export interface ReceiveMessageRequest {
|
|
|
1409
1058
|
* <p>The name of the message attribute, where <i>N</i> is the index.</p>
|
|
1410
1059
|
* <ul>
|
|
1411
1060
|
* <li>
|
|
1412
|
-
* <p>The name can contain alphanumeric characters and the underscore
|
|
1413
|
-
* (<code>_</code>), hyphen (<code>-</code>), and period
|
|
1414
|
-
* (<code>.</code>).</p>
|
|
1061
|
+
* <p>The name can contain alphanumeric characters and the underscore (<code>_</code>), hyphen (<code>-</code>), and period (<code>.</code>).</p>
|
|
1415
1062
|
* </li>
|
|
1416
1063
|
* <li>
|
|
1417
|
-
* <p>The name is case-sensitive and must be unique among all attribute names for
|
|
1418
|
-
* the message.</p>
|
|
1064
|
+
* <p>The name is case-sensitive and must be unique among all attribute names for the message.</p>
|
|
1419
1065
|
* </li>
|
|
1420
1066
|
* <li>
|
|
1421
|
-
* <p>The name must not start with AWS-reserved prefixes such as <code>AWS.</code>
|
|
1422
|
-
* or <code>Amazon.</code> (or any casing variants).</p>
|
|
1067
|
+
* <p>The name must not start with AWS-reserved prefixes such as <code>AWS.</code> or <code>Amazon.</code> (or any casing variants).</p>
|
|
1423
1068
|
* </li>
|
|
1424
1069
|
* <li>
|
|
1425
|
-
* <p>The name must not start or end with a period (<code>.</code>), and it should
|
|
1426
|
-
* not have periods in succession (<code>..</code>).</p>
|
|
1070
|
+
* <p>The name must not start or end with a period (<code>.</code>), and it should not have periods in succession (<code>..</code>).</p>
|
|
1427
1071
|
* </li>
|
|
1428
1072
|
* <li>
|
|
1429
1073
|
* <p>The name can be up to 256 characters long.</p>
|
|
1430
1074
|
* </li>
|
|
1431
1075
|
* </ul>
|
|
1432
|
-
* <p>When using <code>ReceiveMessage</code>, you can send a list of attribute names to
|
|
1433
|
-
*
|
|
1434
|
-
* <code>.*</code> in your request. You can also use all message attributes starting
|
|
1435
|
-
* with a prefix, for example <code>bar.*</code>.</p>
|
|
1076
|
+
* <p>When using <code>ReceiveMessage</code>, you can send a list of attribute names to receive, or you can return all of the attributes by specifying <code>All</code> or <code>.*</code> in your request.
|
|
1077
|
+
* You can also use all message attributes starting with a prefix, for example <code>bar.*</code>.</p>
|
|
1436
1078
|
*/
|
|
1437
1079
|
MessageAttributeNames?: string[];
|
|
1438
1080
|
/**
|
|
1439
|
-
* <p>The maximum number of messages to return. Amazon SQS never returns more messages than this
|
|
1440
|
-
* value (however, fewer messages might be returned). Valid values: 1 to 10. Default:
|
|
1441
|
-
* 1.</p>
|
|
1081
|
+
* <p>The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values: 1 to 10. Default: 1.</p>
|
|
1442
1082
|
*/
|
|
1443
1083
|
MaxNumberOfMessages?: number;
|
|
1444
1084
|
/**
|
|
1445
|
-
* <p>The duration (in seconds) that the received messages are hidden from subsequent
|
|
1446
|
-
* retrieve requests after being retrieved by a <code>ReceiveMessage</code> request.</p>
|
|
1085
|
+
* <p>The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a <code>ReceiveMessage</code> request.</p>
|
|
1447
1086
|
*/
|
|
1448
1087
|
VisibilityTimeout?: number;
|
|
1449
1088
|
/**
|
|
1450
|
-
* <p>The duration (in seconds) for which the call waits for a message to arrive in the
|
|
1451
|
-
*
|
|
1452
|
-
* <code>WaitTimeSeconds</code>. If no messages are available and the wait time
|
|
1453
|
-
* expires, the call returns successfully with an empty list of messages.</p>
|
|
1089
|
+
* <p>The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than <code>WaitTimeSeconds</code>.
|
|
1090
|
+
* If no messages are available and the wait time expires, the call returns successfully with an empty list of messages.</p>
|
|
1454
1091
|
* <important>
|
|
1455
|
-
* <p>To avoid HTTP errors, ensure that the HTTP response timeout for
|
|
1456
|
-
*
|
|
1457
|
-
*
|
|
1458
|
-
* 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>
|
|
1092
|
+
* <p>To avoid HTTP errors, ensure that the HTTP response timeout for <code>ReceiveMessage</code>
|
|
1093
|
+
* requests is longer than the <code>WaitTimeSeconds</code> parameter. For example,
|
|
1094
|
+
* with the Java SDK, you can 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>
|
|
1459
1095
|
* </important>
|
|
1460
1096
|
*/
|
|
1461
1097
|
WaitTimeSeconds?: number;
|
|
1462
1098
|
/**
|
|
1463
1099
|
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
|
|
1464
|
-
* <p>The token used for deduplication of <code>ReceiveMessage</code> calls. If a networking
|
|
1465
|
-
*
|
|
1466
|
-
* receive a generic error, it is possible to retry the same action with an identical
|
|
1467
|
-
* <code>ReceiveRequestAttemptId</code> to retrieve the same set of messages, even if
|
|
1468
|
-
* their visibility timeout has not yet expired.</p>
|
|
1100
|
+
* <p>The token used for deduplication of <code>ReceiveMessage</code> calls. If a networking issue occurs after a <code>ReceiveMessage</code> action, and instead of a response you receive a generic error,
|
|
1101
|
+
* it is possible to retry the same action with an identical <code>ReceiveRequestAttemptId</code> to retrieve the same set of messages, even if their visibility timeout has not yet expired.</p>
|
|
1469
1102
|
* <ul>
|
|
1470
1103
|
* <li>
|
|
1471
|
-
* <p>You can use <code>ReceiveRequestAttemptId</code> only for 5 minutes after a
|
|
1472
|
-
* <code>ReceiveMessage</code> action.</p>
|
|
1104
|
+
* <p>You can use <code>ReceiveRequestAttemptId</code> only for 5 minutes after a <code>ReceiveMessage</code> action.</p>
|
|
1473
1105
|
* </li>
|
|
1474
1106
|
* <li>
|
|
1475
|
-
* <p>When you set <code>FifoQueue</code>, a caller of the
|
|
1476
|
-
* <code>ReceiveMessage</code> action can provide a
|
|
1477
|
-
* <code>ReceiveRequestAttemptId</code> explicitly.</p>
|
|
1107
|
+
* <p>When you set <code>FifoQueue</code>, a caller of the <code>ReceiveMessage</code> action can provide a <code>ReceiveRequestAttemptId</code> explicitly.</p>
|
|
1478
1108
|
* </li>
|
|
1479
1109
|
* <li>
|
|
1480
|
-
* <p>If a caller of the <code>ReceiveMessage</code> action doesn't provide a
|
|
1481
|
-
* <code>ReceiveRequestAttemptId</code>, Amazon SQS generates a
|
|
1482
|
-
* <code>ReceiveRequestAttemptId</code>.</p>
|
|
1110
|
+
* <p>If a caller of the <code>ReceiveMessage</code> action doesn't provide a <code>ReceiveRequestAttemptId</code>, Amazon SQS generates a <code>ReceiveRequestAttemptId</code>.</p>
|
|
1483
1111
|
* </li>
|
|
1484
1112
|
* <li>
|
|
1485
|
-
* <p>It is possible to retry the <code>ReceiveMessage</code> action with the same
|
|
1486
|
-
* <code>ReceiveRequestAttemptId</code> if none of the messages have been
|
|
1487
|
-
* modified (deleted or had their visibility changes).</p>
|
|
1113
|
+
* <p>It is possible to retry the <code>ReceiveMessage</code> action with the same <code>ReceiveRequestAttemptId</code> if none of the messages have been modified (deleted or had their visibility changes).</p>
|
|
1488
1114
|
* </li>
|
|
1489
1115
|
* <li>
|
|
1490
|
-
* <p>During a visibility timeout, subsequent calls with the same
|
|
1491
|
-
*
|
|
1492
|
-
*
|
|
1493
|
-
*
|
|
1494
|
-
* Guide</i>.</p>
|
|
1116
|
+
* <p>During a visibility timeout, subsequent calls with the same <code>ReceiveRequestAttemptId</code> return the same messages and receipt handles. If a retry occurs within the deduplication interval,
|
|
1117
|
+
* it resets the visibility timeout. For more information, see
|
|
1118
|
+
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility Timeout</a>
|
|
1119
|
+
* in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
1495
1120
|
* <important>
|
|
1496
1121
|
* <p>If a caller of the <code>ReceiveMessage</code> action still processes
|
|
1497
1122
|
* messages when the visibility timeout expires and messages become visible,
|
|
@@ -1499,30 +1124,23 @@ export interface ReceiveMessageRequest {
|
|
|
1499
1124
|
* and therefore process duplicates. Also, if a consumer whose message
|
|
1500
1125
|
* processing time is longer than the visibility timeout tries to delete the
|
|
1501
1126
|
* processed messages, the action fails with an error.</p>
|
|
1502
|
-
* <p>To mitigate this effect, ensure that your application observes a safe
|
|
1503
|
-
* threshold before the visibility timeout expires and extend the visibility
|
|
1504
|
-
* timeout as necessary.</p>
|
|
1127
|
+
* <p>To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary.</p>
|
|
1505
1128
|
* </important>
|
|
1506
1129
|
* </li>
|
|
1507
1130
|
* <li>
|
|
1508
|
-
* <p>While messages with a particular <code>MessageGroupId</code> are invisible, no
|
|
1509
|
-
*
|
|
1510
|
-
* until the visibility timeout expires. You can still receive messages with
|
|
1511
|
-
* another <code>MessageGroupId</code> as long as it is also visible.</p>
|
|
1131
|
+
* <p>While messages with a particular <code>MessageGroupId</code> are invisible, no more messages belonging to the same <code>MessageGroupId</code> are returned until the visibility timeout expires. You can still receive
|
|
1132
|
+
* messages with another <code>MessageGroupId</code> as long as it is also visible.</p>
|
|
1512
1133
|
* </li>
|
|
1513
1134
|
* <li>
|
|
1514
|
-
* <p>If a caller of <code>ReceiveMessage</code> can't track the
|
|
1515
|
-
*
|
|
1516
|
-
* visibility timeout expires. As a result, delays might occur but the messages in
|
|
1517
|
-
* the queue remain in a strict order.</p>
|
|
1135
|
+
* <p>If a caller of <code>ReceiveMessage</code> can't track the <code>ReceiveRequestAttemptId</code>, no retries work until the original visibility timeout expires. As a result, delays might occur but
|
|
1136
|
+
* the messages in the queue remain in a strict order.</p>
|
|
1518
1137
|
* </li>
|
|
1519
1138
|
* </ul>
|
|
1520
|
-
* <p>The maximum length of <code>ReceiveRequestAttemptId</code> is 128 characters.
|
|
1521
|
-
*
|
|
1522
|
-
*
|
|
1523
|
-
*
|
|
1524
|
-
*
|
|
1525
|
-
* Developer Guide</i>.</p>
|
|
1139
|
+
* <p>The maximum length of <code>ReceiveRequestAttemptId</code> is 128 characters. <code>ReceiveRequestAttemptId</code> can contain alphanumeric characters (<code>a-z</code>, <code>A-Z</code>, <code>0-9</code>) and
|
|
1140
|
+
* punctuation (<code>!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~</code>).</p>
|
|
1141
|
+
* <p>For best practices of using <code>ReceiveRequestAttemptId</code>, see
|
|
1142
|
+
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-receiverequestattemptid-request-parameter.html">Using the ReceiveRequestAttemptId Request Parameter</a>
|
|
1143
|
+
* in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
1526
1144
|
*/
|
|
1527
1145
|
ReceiveRequestAttemptId?: string;
|
|
1528
1146
|
}
|
|
@@ -1546,26 +1164,19 @@ export declare const MessageSystemAttributeName: {
|
|
|
1546
1164
|
export type MessageSystemAttributeName = (typeof MessageSystemAttributeName)[keyof typeof MessageSystemAttributeName];
|
|
1547
1165
|
/**
|
|
1548
1166
|
* @public
|
|
1549
|
-
* <p>The user-specified message attribute value. For string data types, the
|
|
1550
|
-
* <code>Value</code> attribute has the same restrictions on the content as the message
|
|
1551
|
-
* body. For more information, see <code>
|
|
1167
|
+
* <p>The user-specified message attribute value. For string data types, the <code>Value</code> attribute has the same restrictions on the content as the message body. For more information, see <code>
|
|
1552
1168
|
* <a>SendMessage</a>.</code>
|
|
1553
1169
|
* </p>
|
|
1554
1170
|
* <p>
|
|
1555
|
-
* <code>Name</code>, <code>type</code>, <code>value</code> and the message body must not
|
|
1556
|
-
* be empty or null. All parts of the message attribute, including <code>Name</code>,
|
|
1557
|
-
* <code>Type</code>, and <code>Value</code>, are part of the message size restriction
|
|
1558
|
-
* (256 KiB or 262,144 bytes).</p>
|
|
1171
|
+
* <code>Name</code>, <code>type</code>, <code>value</code> and the message body must not be empty or null. All parts of the message attribute, including <code>Name</code>, <code>Type</code>, and <code>Value</code>, are part of the message size restriction (256 KB or 262,144 bytes).</p>
|
|
1559
1172
|
*/
|
|
1560
1173
|
export interface MessageAttributeValue {
|
|
1561
1174
|
/**
|
|
1562
|
-
* <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
|
|
1563
|
-
* Characters</a>.</p>
|
|
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 Characters</a>.</p>
|
|
1564
1176
|
*/
|
|
1565
1177
|
StringValue?: string;
|
|
1566
1178
|
/**
|
|
1567
|
-
* <p>Binary type attributes can store any binary data, such as compressed data, encrypted
|
|
1568
|
-
* data, or images.</p>
|
|
1179
|
+
* <p>Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.</p>
|
|
1569
1180
|
*/
|
|
1570
1181
|
BinaryValue?: Uint8Array;
|
|
1571
1182
|
/**
|
|
@@ -1577,11 +1188,8 @@ export interface MessageAttributeValue {
|
|
|
1577
1188
|
*/
|
|
1578
1189
|
BinaryListValues?: Uint8Array[];
|
|
1579
1190
|
/**
|
|
1580
|
-
* <p>Amazon SQS supports the following logical data types: <code>String</code>,
|
|
1581
|
-
*
|
|
1582
|
-
* you must use <code>StringValue</code>.</p>
|
|
1583
|
-
* <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
|
|
1584
|
-
* Guide</i>.</p>
|
|
1191
|
+
* <p>Amazon SQS supports the following logical data types: <code>String</code>, <code>Number</code>, and <code>Binary</code>. For the <code>Number</code> data type, you must use <code>StringValue</code>.</p>
|
|
1192
|
+
* <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 Guide</i>.</p>
|
|
1585
1193
|
*/
|
|
1586
1194
|
DataType: string | undefined;
|
|
1587
1195
|
}
|
|
@@ -1591,14 +1199,11 @@ export interface MessageAttributeValue {
|
|
|
1591
1199
|
*/
|
|
1592
1200
|
export interface Message {
|
|
1593
1201
|
/**
|
|
1594
|
-
* <p>A unique identifier for the message. A <code>MessageId</code>is considered unique
|
|
1595
|
-
* across all Amazon Web Services accounts for an extended period of time.</p>
|
|
1202
|
+
* <p>A unique identifier for the message. A <code>MessageId</code>is considered unique across all Amazon Web Services accounts for an extended period of time.</p>
|
|
1596
1203
|
*/
|
|
1597
1204
|
MessageId?: string;
|
|
1598
1205
|
/**
|
|
1599
|
-
* <p>An identifier associated with the act of receiving the message. A new receipt handle
|
|
1600
|
-
* is returned every time you receive a message. When deleting a message, you provide the
|
|
1601
|
-
* last received receipt handle to delete the message.</p>
|
|
1206
|
+
* <p>An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.</p>
|
|
1602
1207
|
*/
|
|
1603
1208
|
ReceiptHandle?: string;
|
|
1604
1209
|
/**
|
|
@@ -1612,8 +1217,8 @@ export interface Message {
|
|
|
1612
1217
|
/**
|
|
1613
1218
|
* <p>A map of the attributes requested in <code>
|
|
1614
1219
|
* <a>ReceiveMessage</a>
|
|
1615
|
-
* </code> to
|
|
1616
|
-
*
|
|
1220
|
+
* </code> to their respective values.
|
|
1221
|
+
* Supported attributes:</p>
|
|
1617
1222
|
* <ul>
|
|
1618
1223
|
* <li>
|
|
1619
1224
|
* <p>
|
|
@@ -1652,9 +1257,8 @@ export interface Message {
|
|
|
1652
1257
|
* </li>
|
|
1653
1258
|
* </ul>
|
|
1654
1259
|
* <p>
|
|
1655
|
-
* <code>ApproximateFirstReceiveTimestamp</code> and <code>SentTimestamp</code> are each
|
|
1656
|
-
*
|
|
1657
|
-
* milliseconds.</p>
|
|
1260
|
+
* <code>ApproximateFirstReceiveTimestamp</code> and <code>SentTimestamp</code> are each returned as an integer representing the
|
|
1261
|
+
* <a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a> in milliseconds.</p>
|
|
1658
1262
|
*/
|
|
1659
1263
|
Attributes?: Record<string, string>;
|
|
1660
1264
|
/**
|
|
@@ -1690,8 +1294,7 @@ export interface RemovePermissionRequest {
|
|
|
1690
1294
|
*/
|
|
1691
1295
|
QueueUrl: string | undefined;
|
|
1692
1296
|
/**
|
|
1693
|
-
* <p>The identification of the permission to remove. This is the label added using the
|
|
1694
|
-
* <code>
|
|
1297
|
+
* <p>The identification of the permission to remove. This is the label added using the <code>
|
|
1695
1298
|
* <a>AddPermission</a>
|
|
1696
1299
|
* </code> action.</p>
|
|
1697
1300
|
*/
|
|
@@ -1722,24 +1325,19 @@ export declare const MessageSystemAttributeNameForSends: {
|
|
|
1722
1325
|
export type MessageSystemAttributeNameForSends = (typeof MessageSystemAttributeNameForSends)[keyof typeof MessageSystemAttributeNameForSends];
|
|
1723
1326
|
/**
|
|
1724
1327
|
* @public
|
|
1725
|
-
* <p>The user-specified message system attribute value. For string data types, the
|
|
1726
|
-
* <code>Value</code> attribute has the same restrictions on the content as the message
|
|
1727
|
-
* body. For more information, see <code>
|
|
1328
|
+
* <p>The user-specified message system attribute value. For string data types, the <code>Value</code> attribute has the same restrictions on the content as the message body. For more information, see <code>
|
|
1728
1329
|
* <a>SendMessage</a>.</code>
|
|
1729
1330
|
* </p>
|
|
1730
1331
|
* <p>
|
|
1731
|
-
* <code>Name</code>, <code>type</code>, <code>value</code> and the message body must not
|
|
1732
|
-
* be empty or null.</p>
|
|
1332
|
+
* <code>Name</code>, <code>type</code>, <code>value</code> and the message body must not be empty or null.</p>
|
|
1733
1333
|
*/
|
|
1734
1334
|
export interface MessageSystemAttributeValue {
|
|
1735
1335
|
/**
|
|
1736
|
-
* <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
|
|
1737
|
-
* Characters</a>.</p>
|
|
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 Characters</a>.</p>
|
|
1738
1337
|
*/
|
|
1739
1338
|
StringValue?: string;
|
|
1740
1339
|
/**
|
|
1741
|
-
* <p>Binary type attributes can store any binary data, such as compressed data, encrypted
|
|
1742
|
-
* data, or images.</p>
|
|
1340
|
+
* <p>Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.</p>
|
|
1743
1341
|
*/
|
|
1744
1342
|
BinaryValue?: Uint8Array;
|
|
1745
1343
|
/**
|
|
@@ -1751,11 +1349,8 @@ export interface MessageSystemAttributeValue {
|
|
|
1751
1349
|
*/
|
|
1752
1350
|
BinaryListValues?: Uint8Array[];
|
|
1753
1351
|
/**
|
|
1754
|
-
* <p>Amazon SQS supports the following logical data types: <code>String</code>,
|
|
1755
|
-
*
|
|
1756
|
-
* you must use <code>StringValue</code>.</p>
|
|
1757
|
-
* <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
|
|
1758
|
-
* Guide</i>.</p>
|
|
1352
|
+
* <p>Amazon SQS supports the following logical data types: <code>String</code>, <code>Number</code>, and <code>Binary</code>. For the <code>Number</code> data type, you must use <code>StringValue</code>.</p>
|
|
1353
|
+
* <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 Guide</i>.</p>
|
|
1759
1354
|
*/
|
|
1760
1355
|
DataType: string | undefined;
|
|
1761
1356
|
}
|
|
@@ -1770,8 +1365,7 @@ export interface SendMessageRequest {
|
|
|
1770
1365
|
*/
|
|
1771
1366
|
QueueUrl: string | undefined;
|
|
1772
1367
|
/**
|
|
1773
|
-
* <p>The message to send. The minimum size is one character. The maximum size is 256
|
|
1774
|
-
* KiB.</p>
|
|
1368
|
+
* <p>The message to send. The minimum size is one character. The maximum size is 256 KB.</p>
|
|
1775
1369
|
* <important>
|
|
1776
1370
|
* <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:</p>
|
|
1777
1371
|
* <p>
|
|
@@ -1782,10 +1376,10 @@ export interface SendMessageRequest {
|
|
|
1782
1376
|
*/
|
|
1783
1377
|
MessageBody: string | undefined;
|
|
1784
1378
|
/**
|
|
1785
|
-
* <p>
|
|
1786
|
-
*
|
|
1787
|
-
*
|
|
1788
|
-
*
|
|
1379
|
+
* <p>
|
|
1380
|
+
* The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive <code>DelaySeconds</code> value become available for processing after the delay period is finished.
|
|
1381
|
+
* If you don't specify a value, the default value for the queue applies.
|
|
1382
|
+
* </p>
|
|
1789
1383
|
* <note>
|
|
1790
1384
|
* <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>
|
|
1791
1385
|
* </note>
|
|
@@ -1816,65 +1410,52 @@ export interface SendMessageRequest {
|
|
|
1816
1410
|
MessageSystemAttributes?: Record<string, MessageSystemAttributeValue>;
|
|
1817
1411
|
/**
|
|
1818
1412
|
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
|
|
1819
|
-
* <p>The token used for deduplication of sent messages. If a message with a particular
|
|
1820
|
-
*
|
|
1821
|
-
*
|
|
1822
|
-
* 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
|
|
1823
|
-
* Guide</i>.</p>
|
|
1413
|
+
* <p>The token used for deduplication of sent messages. If a message with a particular <code>MessageDeduplicationId</code> is sent successfully, any messages sent with the same <code>MessageDeduplicationId</code>
|
|
1414
|
+
* are accepted successfully but aren't delivered 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">
|
|
1415
|
+
* Exactly-once processing</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
1824
1416
|
* <ul>
|
|
1825
1417
|
* <li>
|
|
1826
1418
|
* <p>Every message must have a unique <code>MessageDeduplicationId</code>,</p>
|
|
1827
1419
|
* <ul>
|
|
1828
1420
|
* <li>
|
|
1829
|
-
* <p>You may provide a <code>MessageDeduplicationId</code>
|
|
1830
|
-
* explicitly.</p>
|
|
1421
|
+
* <p>You may provide a <code>MessageDeduplicationId</code> explicitly.</p>
|
|
1831
1422
|
* </li>
|
|
1832
1423
|
* <li>
|
|
1833
|
-
* <p>If you aren't able to provide a <code>MessageDeduplicationId</code>
|
|
1834
|
-
*
|
|
1835
|
-
*
|
|
1836
|
-
* <code>MessageDeduplicationId</code> using the body of the message
|
|
1837
|
-
* (but not the attributes of the message). </p>
|
|
1424
|
+
* <p>If you aren't able to provide a <code>MessageDeduplicationId</code> and you enable <code>ContentBasedDeduplication</code> for your queue,
|
|
1425
|
+
* Amazon SQS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using the body of the message (but not the attributes of the message).
|
|
1426
|
+
* </p>
|
|
1838
1427
|
* </li>
|
|
1839
1428
|
* <li>
|
|
1840
|
-
* <p>If you don't provide a <code>MessageDeduplicationId</code> and the
|
|
1841
|
-
*
|
|
1842
|
-
* action fails with an error.</p>
|
|
1429
|
+
* <p>If you don't provide a <code>MessageDeduplicationId</code> and the queue doesn't have <code>ContentBasedDeduplication</code> set,
|
|
1430
|
+
* the action fails with an error.</p>
|
|
1843
1431
|
* </li>
|
|
1844
1432
|
* <li>
|
|
1845
|
-
* <p>If the queue has <code>ContentBasedDeduplication</code> set, your
|
|
1846
|
-
* <code>MessageDeduplicationId</code> overrides the generated
|
|
1847
|
-
* one.</p>
|
|
1433
|
+
* <p>If the queue has <code>ContentBasedDeduplication</code> set, your <code>MessageDeduplicationId</code> overrides the generated one.</p>
|
|
1848
1434
|
* </li>
|
|
1849
1435
|
* </ul>
|
|
1850
1436
|
* </li>
|
|
1851
1437
|
* <li>
|
|
1852
|
-
* <p>When <code>ContentBasedDeduplication</code> is in effect, messages with
|
|
1853
|
-
*
|
|
1854
|
-
* duplicates and only one copy of the message is delivered.</p>
|
|
1438
|
+
* <p>When <code>ContentBasedDeduplication</code> is in effect, messages with identical content sent within the deduplication interval are treated as duplicates
|
|
1439
|
+
* and only one copy of the message is delivered.</p>
|
|
1855
1440
|
* </li>
|
|
1856
1441
|
* <li>
|
|
1857
|
-
* <p>If you send one message with <code>ContentBasedDeduplication</code> enabled
|
|
1858
|
-
*
|
|
1859
|
-
*
|
|
1860
|
-
* two messages are treated as duplicates and only one copy of the message is
|
|
1861
|
-
* delivered. </p>
|
|
1442
|
+
* <p>If you send one message with <code>ContentBasedDeduplication</code> enabled and then another message with a <code>MessageDeduplicationId</code> that is the same
|
|
1443
|
+
* as the one generated for the first <code>MessageDeduplicationId</code>, the two messages are treated as duplicates and only one copy of the message is delivered.
|
|
1444
|
+
* </p>
|
|
1862
1445
|
* </li>
|
|
1863
1446
|
* </ul>
|
|
1864
1447
|
* <note>
|
|
1865
1448
|
* <p>The <code>MessageDeduplicationId</code> is available to the consumer of the
|
|
1866
1449
|
* message (this can be useful for troubleshooting delivery issues).</p>
|
|
1867
|
-
* <p>If a message is sent successfully but the acknowledgement is lost and the message
|
|
1868
|
-
*
|
|
1869
|
-
* interval, Amazon SQS can't detect duplicate messages.</p>
|
|
1450
|
+
* <p>If a message is sent successfully but the acknowledgement is lost and the message is resent with the same
|
|
1451
|
+
* <code>MessageDeduplicationId</code> after the deduplication interval, Amazon SQS can't detect duplicate messages.</p>
|
|
1870
1452
|
* <p>Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.</p>
|
|
1871
1453
|
* </note>
|
|
1872
|
-
* <p>The maximum length of <code>MessageDeduplicationId</code> is 128 characters.
|
|
1873
|
-
*
|
|
1874
|
-
*
|
|
1875
|
-
*
|
|
1876
|
-
*
|
|
1877
|
-
* Guide</i>.</p>
|
|
1454
|
+
* <p>The maximum length of <code>MessageDeduplicationId</code> is 128 characters. <code>MessageDeduplicationId</code> can contain alphanumeric characters (<code>a-z</code>, <code>A-Z</code>, <code>0-9</code>) and
|
|
1455
|
+
* punctuation (<code>!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~</code>).</p>
|
|
1456
|
+
* <p>For best practices of using <code>MessageDeduplicationId</code>, see
|
|
1457
|
+
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html">Using the MessageDeduplicationId Property</a>
|
|
1458
|
+
* in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
1878
1459
|
*/
|
|
1879
1460
|
MessageDeduplicationId?: string;
|
|
1880
1461
|
/**
|
|
@@ -1888,26 +1469,21 @@ export interface SendMessageRequest {
|
|
|
1888
1469
|
* fashion.</p>
|
|
1889
1470
|
* <ul>
|
|
1890
1471
|
* <li>
|
|
1891
|
-
* <p>You must associate a non-empty <code>MessageGroupId</code> with a message. If
|
|
1892
|
-
* you don't provide a <code>MessageGroupId</code>, the action fails.</p>
|
|
1472
|
+
* <p>You must associate a non-empty <code>MessageGroupId</code> with a message. If you don't provide a <code>MessageGroupId</code>, the action fails.</p>
|
|
1893
1473
|
* </li>
|
|
1894
1474
|
* <li>
|
|
1895
1475
|
* <p>
|
|
1896
|
-
* <code>ReceiveMessage</code> might return messages with multiple
|
|
1897
|
-
*
|
|
1898
|
-
* the messages are sorted by time sent. The caller can't specify a
|
|
1899
|
-
* <code>MessageGroupId</code>.</p>
|
|
1476
|
+
* <code>ReceiveMessage</code> might return messages with multiple <code>MessageGroupId</code> values. For each <code>MessageGroupId</code>, the messages are sorted by time sent. The caller can't
|
|
1477
|
+
* specify a <code>MessageGroupId</code>.</p>
|
|
1900
1478
|
* </li>
|
|
1901
1479
|
* </ul>
|
|
1902
|
-
* <p>The length of <code>MessageGroupId</code> is 128 characters. Valid values:
|
|
1903
|
-
*
|
|
1904
|
-
*
|
|
1905
|
-
*
|
|
1906
|
-
* Guide</i>.</p>
|
|
1480
|
+
* <p>The length of <code>MessageGroupId</code> is 128 characters. Valid values: alphanumeric characters and punctuation <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~)</code>.</p>
|
|
1481
|
+
* <p>For best practices of using <code>MessageGroupId</code>, see
|
|
1482
|
+
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html">Using the MessageGroupId Property</a>
|
|
1483
|
+
* in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
1907
1484
|
* <important>
|
|
1908
1485
|
* <p>
|
|
1909
|
-
* <code>MessageGroupId</code> is required for FIFO queues. You can't use it for
|
|
1910
|
-
* Standard queues.</p>
|
|
1486
|
+
* <code>MessageGroupId</code> is required for FIFO queues. You can't use it for Standard queues.</p>
|
|
1911
1487
|
* </important>
|
|
1912
1488
|
*/
|
|
1913
1489
|
MessageGroupId?: string;
|
|
@@ -1931,19 +1507,30 @@ export interface SendMessageResult {
|
|
|
1931
1507
|
*/
|
|
1932
1508
|
MD5OfMessageSystemAttributes?: string;
|
|
1933
1509
|
/**
|
|
1934
|
-
* <p>An attribute containing the <code>MessageId</code> of the message sent to the queue.
|
|
1935
|
-
*
|
|
1936
|
-
*
|
|
1510
|
+
* <p>An attribute containing the <code>MessageId</code> of the message sent to the queue. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html">Queue and Message Identifiers</a>
|
|
1511
|
+
* in the <i>Amazon SQS Developer Guide</i>.
|
|
1512
|
+
* </p>
|
|
1937
1513
|
*/
|
|
1938
1514
|
MessageId?: string;
|
|
1939
1515
|
/**
|
|
1940
1516
|
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
|
|
1941
1517
|
* <p>The large, non-consecutive number that Amazon SQS assigns to each message.</p>
|
|
1942
|
-
* <p>The length of <code>SequenceNumber</code> is 128 bits. <code>SequenceNumber</code>
|
|
1943
|
-
* continues to increase for a particular <code>MessageGroupId</code>.</p>
|
|
1518
|
+
* <p>The length of <code>SequenceNumber</code> is 128 bits. <code>SequenceNumber</code> continues to increase for a particular <code>MessageGroupId</code>.</p>
|
|
1944
1519
|
*/
|
|
1945
1520
|
SequenceNumber?: string;
|
|
1946
1521
|
}
|
|
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
|
+
}
|
|
1947
1534
|
/**
|
|
1948
1535
|
* @public
|
|
1949
1536
|
* <p>The length of all the messages put together is more than the limit.</p>
|
|
@@ -1974,10 +1561,9 @@ export interface SendMessageBatchRequestEntry {
|
|
|
1974
1561
|
*/
|
|
1975
1562
|
MessageBody: string | undefined;
|
|
1976
1563
|
/**
|
|
1977
|
-
* <p>The length of time, in seconds, for which a specific message is delayed. Valid values:
|
|
1978
|
-
*
|
|
1979
|
-
*
|
|
1980
|
-
* a value, the default value for the queue is applied. </p>
|
|
1564
|
+
* <p>The length of time, in seconds, for which a specific message is delayed. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive <code>DelaySeconds</code> value become available for processing after the delay period is finished.
|
|
1565
|
+
* If you don't specify a value, the default value for the queue is applied.
|
|
1566
|
+
* </p>
|
|
1981
1567
|
* <note>
|
|
1982
1568
|
* <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>
|
|
1983
1569
|
* </note>
|
|
@@ -2008,65 +1594,53 @@ export interface SendMessageBatchRequestEntry {
|
|
|
2008
1594
|
MessageSystemAttributes?: Record<string, MessageSystemAttributeValue>;
|
|
2009
1595
|
/**
|
|
2010
1596
|
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
|
|
2011
|
-
* <p>The token used for deduplication of messages within a 5-minute minimum deduplication
|
|
2012
|
-
*
|
|
2013
|
-
*
|
|
2014
|
-
*
|
|
2015
|
-
* Guide</i>.</p>
|
|
1597
|
+
* <p>The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular
|
|
1598
|
+
* <code>MessageDeduplicationId</code> is sent successfully, subsequent messages with the same <code>MessageDeduplicationId</code> are
|
|
1599
|
+
* 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">
|
|
1600
|
+
* Exactly-once processing</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
2016
1601
|
* <ul>
|
|
2017
1602
|
* <li>
|
|
2018
1603
|
* <p>Every message must have a unique <code>MessageDeduplicationId</code>,</p>
|
|
2019
1604
|
* <ul>
|
|
2020
1605
|
* <li>
|
|
2021
|
-
* <p>You may provide a <code>MessageDeduplicationId</code>
|
|
2022
|
-
* explicitly.</p>
|
|
1606
|
+
* <p>You may provide a <code>MessageDeduplicationId</code> explicitly.</p>
|
|
2023
1607
|
* </li>
|
|
2024
1608
|
* <li>
|
|
2025
|
-
* <p>If you aren't able to provide a <code>MessageDeduplicationId</code>
|
|
2026
|
-
*
|
|
2027
|
-
*
|
|
2028
|
-
* <code>MessageDeduplicationId</code> using the body of the message
|
|
2029
|
-
* (but not the attributes of the message). </p>
|
|
1609
|
+
* <p>If you aren't able to provide a <code>MessageDeduplicationId</code> and you enable <code>ContentBasedDeduplication</code> for your queue,
|
|
1610
|
+
* Amazon SQS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using the body of the message (but not the attributes of the message).
|
|
1611
|
+
* </p>
|
|
2030
1612
|
* </li>
|
|
2031
1613
|
* <li>
|
|
2032
|
-
* <p>If you don't provide a <code>MessageDeduplicationId</code> and the
|
|
2033
|
-
*
|
|
2034
|
-
* action fails with an error.</p>
|
|
1614
|
+
* <p>If you don't provide a <code>MessageDeduplicationId</code> and the queue doesn't have <code>ContentBasedDeduplication</code> set,
|
|
1615
|
+
* the action fails with an error.</p>
|
|
2035
1616
|
* </li>
|
|
2036
1617
|
* <li>
|
|
2037
|
-
* <p>If the queue has <code>ContentBasedDeduplication</code> set, your
|
|
2038
|
-
* <code>MessageDeduplicationId</code> overrides the generated
|
|
2039
|
-
* one.</p>
|
|
1618
|
+
* <p>If the queue has <code>ContentBasedDeduplication</code> set, your <code>MessageDeduplicationId</code> overrides the generated one.</p>
|
|
2040
1619
|
* </li>
|
|
2041
1620
|
* </ul>
|
|
2042
1621
|
* </li>
|
|
2043
1622
|
* <li>
|
|
2044
|
-
* <p>When <code>ContentBasedDeduplication</code> is in effect, messages with
|
|
2045
|
-
*
|
|
2046
|
-
* duplicates and only one copy of the message is delivered.</p>
|
|
1623
|
+
* <p>When <code>ContentBasedDeduplication</code> is in effect, messages with identical content sent within the deduplication interval are treated as duplicates
|
|
1624
|
+
* and only one copy of the message is delivered.</p>
|
|
2047
1625
|
* </li>
|
|
2048
1626
|
* <li>
|
|
2049
|
-
* <p>If you send one message with <code>ContentBasedDeduplication</code> enabled
|
|
2050
|
-
*
|
|
2051
|
-
*
|
|
2052
|
-
* two messages are treated as duplicates and only one copy of the message is
|
|
2053
|
-
* delivered. </p>
|
|
1627
|
+
* <p>If you send one message with <code>ContentBasedDeduplication</code> enabled and then another message with a <code>MessageDeduplicationId</code> that is the same
|
|
1628
|
+
* as the one generated for the first <code>MessageDeduplicationId</code>, the two messages are treated as duplicates and only one copy of the message is delivered.
|
|
1629
|
+
* </p>
|
|
2054
1630
|
* </li>
|
|
2055
1631
|
* </ul>
|
|
2056
1632
|
* <note>
|
|
2057
1633
|
* <p>The <code>MessageDeduplicationId</code> is available to the consumer of the
|
|
2058
1634
|
* message (this can be useful for troubleshooting delivery issues).</p>
|
|
2059
|
-
* <p>If a message is sent successfully but the acknowledgement is lost and the message
|
|
2060
|
-
*
|
|
2061
|
-
* interval, Amazon SQS can't detect duplicate messages.</p>
|
|
1635
|
+
* <p>If a message is sent successfully but the acknowledgement is lost and the message is resent with the same
|
|
1636
|
+
* <code>MessageDeduplicationId</code> after the deduplication interval, Amazon SQS can't detect duplicate messages.</p>
|
|
2062
1637
|
* <p>Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.</p>
|
|
2063
1638
|
* </note>
|
|
2064
|
-
* <p>The length of <code>MessageDeduplicationId</code> is 128 characters.
|
|
2065
|
-
*
|
|
2066
|
-
*
|
|
2067
|
-
*
|
|
2068
|
-
*
|
|
2069
|
-
* Guide</i>.</p>
|
|
1639
|
+
* <p>The length of <code>MessageDeduplicationId</code> is 128 characters. <code>MessageDeduplicationId</code> can contain alphanumeric characters (<code>a-z</code>, <code>A-Z</code>, <code>0-9</code>) and
|
|
1640
|
+
* punctuation (<code>!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~</code>).</p>
|
|
1641
|
+
* <p>For best practices of using <code>MessageDeduplicationId</code>, see
|
|
1642
|
+
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html">Using the MessageDeduplicationId Property</a>
|
|
1643
|
+
* in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
2070
1644
|
*/
|
|
2071
1645
|
MessageDeduplicationId?: string;
|
|
2072
1646
|
/**
|
|
@@ -2080,26 +1654,21 @@ export interface SendMessageBatchRequestEntry {
|
|
|
2080
1654
|
* fashion.</p>
|
|
2081
1655
|
* <ul>
|
|
2082
1656
|
* <li>
|
|
2083
|
-
* <p>You must associate a non-empty <code>MessageGroupId</code> with a message. If
|
|
2084
|
-
* you don't provide a <code>MessageGroupId</code>, the action fails.</p>
|
|
1657
|
+
* <p>You must associate a non-empty <code>MessageGroupId</code> with a message. If you don't provide a <code>MessageGroupId</code>, the action fails.</p>
|
|
2085
1658
|
* </li>
|
|
2086
1659
|
* <li>
|
|
2087
1660
|
* <p>
|
|
2088
|
-
* <code>ReceiveMessage</code> might return messages with multiple
|
|
2089
|
-
*
|
|
2090
|
-
* the messages are sorted by time sent. The caller can't specify a
|
|
2091
|
-
* <code>MessageGroupId</code>.</p>
|
|
1661
|
+
* <code>ReceiveMessage</code> might return messages with multiple <code>MessageGroupId</code> values. For each <code>MessageGroupId</code>, the messages are sorted by time sent. The caller can't
|
|
1662
|
+
* specify a <code>MessageGroupId</code>.</p>
|
|
2092
1663
|
* </li>
|
|
2093
1664
|
* </ul>
|
|
2094
|
-
* <p>The length of <code>MessageGroupId</code> is 128 characters. Valid values:
|
|
2095
|
-
*
|
|
2096
|
-
*
|
|
2097
|
-
*
|
|
2098
|
-
* Guide</i>.</p>
|
|
1665
|
+
* <p>The length of <code>MessageGroupId</code> is 128 characters. Valid values: alphanumeric characters and punctuation <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~)</code>.</p>
|
|
1666
|
+
* <p>For best practices of using <code>MessageGroupId</code>, see
|
|
1667
|
+
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html">Using the MessageGroupId Property</a>
|
|
1668
|
+
* in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
2099
1669
|
* <important>
|
|
2100
1670
|
* <p>
|
|
2101
|
-
* <code>MessageGroupId</code> is required for FIFO queues. You can't use it for
|
|
2102
|
-
* Standard queues.</p>
|
|
1671
|
+
* <code>MessageGroupId</code> is required for FIFO queues. You can't use it for Standard queues.</p>
|
|
2103
1672
|
* </important>
|
|
2104
1673
|
*/
|
|
2105
1674
|
MessageGroupId?: string;
|
|
@@ -2152,8 +1721,7 @@ export interface SendMessageBatchResultEntry {
|
|
|
2152
1721
|
/**
|
|
2153
1722
|
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
|
|
2154
1723
|
* <p>The large, non-consecutive number that Amazon SQS assigns to each message.</p>
|
|
2155
|
-
* <p>The length of <code>SequenceNumber</code> is 128 bits. As <code>SequenceNumber</code>
|
|
2156
|
-
* continues to increase for a particular <code>MessageGroupId</code>.</p>
|
|
1724
|
+
* <p>The length of <code>SequenceNumber</code> is 128 bits. As <code>SequenceNumber</code> continues to increase for a particular <code>MessageGroupId</code>.</p>
|
|
2157
1725
|
*/
|
|
2158
1726
|
SequenceNumber?: string;
|
|
2159
1727
|
}
|
|
@@ -2161,11 +1729,9 @@ export interface SendMessageBatchResultEntry {
|
|
|
2161
1729
|
* @public
|
|
2162
1730
|
* <p>For each message in the batch, the response contains a <code>
|
|
2163
1731
|
* <a>SendMessageBatchResultEntry</a>
|
|
2164
|
-
* </code> tag if the message succeeds or a
|
|
2165
|
-
* <code>
|
|
1732
|
+
* </code> tag if the message succeeds or a <code>
|
|
2166
1733
|
* <a>BatchResultErrorEntry</a>
|
|
2167
|
-
* </code> tag if the message
|
|
2168
|
-
* fails.</p>
|
|
1734
|
+
* </code> tag if the message fails.</p>
|
|
2169
1735
|
*/
|
|
2170
1736
|
export interface SendMessageBatchResult {
|
|
2171
1737
|
/**
|
|
@@ -2177,8 +1743,7 @@ export interface SendMessageBatchResult {
|
|
|
2177
1743
|
/**
|
|
2178
1744
|
* <p>A list of <code>
|
|
2179
1745
|
* <a>BatchResultErrorEntry</a>
|
|
2180
|
-
* </code> items with error
|
|
2181
|
-
* details about each message that can't be enqueued.</p>
|
|
1746
|
+
* </code> items with error details about each message that can't be enqueued.</p>
|
|
2182
1747
|
*/
|
|
2183
1748
|
Failed: BatchResultErrorEntry[] | undefined;
|
|
2184
1749
|
}
|
|
@@ -2194,200 +1759,121 @@ export interface SetQueueAttributesRequest {
|
|
|
2194
1759
|
QueueUrl: string | undefined;
|
|
2195
1760
|
/**
|
|
2196
1761
|
* <p>A map of attributes to set.</p>
|
|
2197
|
-
* <p>The following lists the names, descriptions, and values of the special request
|
|
2198
|
-
* parameters that the <code>SetQueueAttributes</code> action uses:</p>
|
|
1762
|
+
* <p>The following lists the names, descriptions, and values of the special request parameters that the <code>SetQueueAttributes</code> action uses:</p>
|
|
2199
1763
|
* <ul>
|
|
2200
1764
|
* <li>
|
|
2201
1765
|
* <p>
|
|
2202
|
-
* <code>DelaySeconds</code> – The length of time, in seconds, for which the
|
|
2203
|
-
*
|
|
2204
|
-
* 0 to 900 (15 minutes). Default: 0. </p>
|
|
1766
|
+
* <code>DelaySeconds</code> – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 (15 minutes). Default: 0.
|
|
1767
|
+
* </p>
|
|
2205
1768
|
* </li>
|
|
2206
1769
|
* <li>
|
|
2207
1770
|
* <p>
|
|
2208
|
-
* <code>MaximumMessageSize</code> – The limit of how many bytes a message
|
|
2209
|
-
*
|
|
2210
|
-
* (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). </p>
|
|
1771
|
+
* <code>MaximumMessageSize</code> – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
|
|
1772
|
+
* </p>
|
|
2211
1773
|
* </li>
|
|
2212
1774
|
* <li>
|
|
2213
1775
|
* <p>
|
|
2214
|
-
* <code>MessageRetentionPeriod</code> – The length of time, in seconds, for
|
|
2215
|
-
*
|
|
2216
|
-
* from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days). When you
|
|
2217
|
-
* change a queue's attributes, the change can take up to 60 seconds for most of
|
|
2218
|
-
* the attributes to propagate throughout the Amazon SQS system. Changes made to the
|
|
2219
|
-
* <code>MessageRetentionPeriod</code> attribute can take up to 15 minutes and
|
|
2220
|
-
* will impact existing messages in the queue potentially causing them to be
|
|
2221
|
-
* expired and deleted if the <code>MessageRetentionPeriod</code> is reduced below
|
|
2222
|
-
* the age of existing messages.</p>
|
|
1776
|
+
* <code>MessageRetentionPeriod</code> – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer representing seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days).
|
|
1777
|
+
* </p>
|
|
2223
1778
|
* </li>
|
|
2224
1779
|
* <li>
|
|
2225
1780
|
* <p>
|
|
2226
|
-
* <code>Policy</code> – The queue's policy. A valid Amazon Web Services policy. For more
|
|
2227
|
-
*
|
|
2228
|
-
*
|
|
2229
|
-
* Guide</i>. </p>
|
|
1781
|
+
* <code>Policy</code> – The queue's policy. A valid Amazon Web Services policy. For more information about policy structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview of Amazon Web Services IAM Policies</a>
|
|
1782
|
+
* in the <i>Identity and Access Management User Guide</i>.
|
|
1783
|
+
* </p>
|
|
2230
1784
|
* </li>
|
|
2231
1785
|
* <li>
|
|
2232
1786
|
* <p>
|
|
2233
|
-
* <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in
|
|
2234
|
-
* seconds, for which a <code>
|
|
1787
|
+
* <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in seconds, for which a <code>
|
|
2235
1788
|
* <a>ReceiveMessage</a>
|
|
2236
|
-
* </code> action waits
|
|
2237
|
-
*
|
|
2238
|
-
* Default: 0. </p>
|
|
2239
|
-
* </li>
|
|
2240
|
-
* <li>
|
|
2241
|
-
* <p>
|
|
2242
|
-
* <code>VisibilityTimeout</code> – The visibility timeout for the queue, in
|
|
2243
|
-
* seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For
|
|
2244
|
-
* 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
|
|
2245
|
-
* Guide</i>.</p>
|
|
1789
|
+
* </code> action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.
|
|
1790
|
+
* </p>
|
|
2246
1791
|
* </li>
|
|
2247
|
-
* </ul>
|
|
2248
|
-
* <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>
|
|
2249
|
-
* </p>
|
|
2250
|
-
* <ul>
|
|
2251
1792
|
* <li>
|
|
2252
1793
|
* <p>
|
|
2253
1794
|
* <code>RedrivePolicy</code> – The string that includes the parameters for the dead-letter queue functionality
|
|
2254
|
-
*
|
|
1795
|
+
* of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">Using Amazon SQS Dead-Letter Queues</a>
|
|
1796
|
+
* in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
2255
1797
|
* <ul>
|
|
2256
1798
|
* <li>
|
|
2257
1799
|
* <p>
|
|
2258
|
-
* <code>deadLetterTargetArn</code> – The Amazon Resource Name (ARN) of the dead-letter queue to
|
|
2259
|
-
* which Amazon SQS moves messages after the value of <code>maxReceiveCount</code> is exceeded.</p>
|
|
1800
|
+
* <code>deadLetterTargetArn</code> – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of <code>maxReceiveCount</code> is exceeded.</p>
|
|
2260
1801
|
* </li>
|
|
2261
1802
|
* <li>
|
|
2262
1803
|
* <p>
|
|
2263
|
-
* <code>maxReceiveCount</code> – The number of times a message is delivered to the source queue before being
|
|
2264
|
-
*
|
|
2265
|
-
* for a queue, Amazon SQS moves the message to the dead-letter-queue.</p>
|
|
1804
|
+
* <code>maxReceiveCount</code> – The number of times a message is delivered to the source queue before being moved to the dead-letter queue.
|
|
1805
|
+
* When the <code>ReceiveCount</code> for a message exceeds the <code>maxReceiveCount</code> for a queue, Amazon SQS moves the message to the dead-letter-queue.</p>
|
|
2266
1806
|
* </li>
|
|
2267
1807
|
* </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>
|
|
2268
1811
|
* </li>
|
|
2269
1812
|
* <li>
|
|
2270
1813
|
* <p>
|
|
2271
|
-
* <code>
|
|
2272
|
-
*
|
|
2273
|
-
* <ul>
|
|
2274
|
-
* <li>
|
|
2275
|
-
* <p>
|
|
2276
|
-
* <code>redrivePermission</code> – The permission type that defines which source queues can
|
|
2277
|
-
* specify the current queue as the dead-letter queue. Valid values are:</p>
|
|
2278
|
-
* <ul>
|
|
2279
|
-
* <li>
|
|
2280
|
-
* <p>
|
|
2281
|
-
* <code>allowAll</code> – (Default) Any source queues in this Amazon Web Services account in the same Region can
|
|
2282
|
-
* specify this queue as the dead-letter queue.</p>
|
|
2283
|
-
* </li>
|
|
2284
|
-
* <li>
|
|
2285
|
-
* <p>
|
|
2286
|
-
* <code>denyAll</code> – No source queues can specify this queue as the dead-letter
|
|
2287
|
-
* queue.</p>
|
|
2288
|
-
* </li>
|
|
2289
|
-
* <li>
|
|
2290
|
-
* <p>
|
|
2291
|
-
* <code>byQueue</code> – Only queues specified by the <code>sourceQueueArns</code> parameter can specify
|
|
2292
|
-
* this queue as the dead-letter queue.</p>
|
|
2293
|
-
* </li>
|
|
2294
|
-
* </ul>
|
|
2295
|
-
* </li>
|
|
2296
|
-
* <li>
|
|
2297
|
-
* <p>
|
|
2298
|
-
* <code>sourceQueueArns</code> – The Amazon Resource Names (ARN)s of the source queues that can specify
|
|
2299
|
-
* this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the
|
|
2300
|
-
* <code>redrivePermission</code> parameter is set to <code>byQueue</code>. You can specify up to 10 source queue ARNs.
|
|
2301
|
-
* To allow more than 10 source queues to specify dead-letter queues, set the <code>redrivePermission</code> parameter
|
|
2302
|
-
* to <code>allowAll</code>.</p>
|
|
2303
|
-
* </li>
|
|
2304
|
-
* </ul>
|
|
1814
|
+
* <code>VisibilityTimeout</code> – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout,
|
|
1815
|
+
* see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
2305
1816
|
* </li>
|
|
2306
1817
|
* </ul>
|
|
2307
|
-
* <note>
|
|
2308
|
-
* <p>The dead-letter queue of a
|
|
2309
|
-
* FIFO queue must also be a FIFO queue. Similarly, the dead-letter
|
|
2310
|
-
* queue of a standard queue must also be a standard queue.</p>
|
|
2311
|
-
* </note>
|
|
2312
1818
|
* <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html">server-side-encryption</a>:</p>
|
|
2313
1819
|
* <ul>
|
|
2314
1820
|
* <li>
|
|
2315
1821
|
* <p>
|
|
2316
|
-
* <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer master
|
|
2317
|
-
*
|
|
2318
|
-
*
|
|
2319
|
-
*
|
|
2320
|
-
*
|
|
2321
|
-
* <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
|
|
2322
|
-
* Reference</i>. </p>
|
|
1822
|
+
* <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key Terms</a>.
|
|
1823
|
+
* While the alias of the AWS-managed CMK for Amazon SQS is always <code>alias/aws/sqs</code>, the alias of a custom CMK can, for example, be <code>alias/<i>MyAlias</i>
|
|
1824
|
+
* </code>.
|
|
1825
|
+
* For more examples, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a> in the <i>Key Management Service API Reference</i>.
|
|
1826
|
+
* </p>
|
|
2323
1827
|
* </li>
|
|
2324
1828
|
* <li>
|
|
2325
1829
|
* <p>
|
|
2326
|
-
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in
|
|
2327
|
-
*
|
|
2328
|
-
*
|
|
2329
|
-
*
|
|
2330
|
-
*
|
|
2331
|
-
* but results in more calls to KMS which might incur charges after Free Tier. For
|
|
2332
|
-
* 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>
|
|
1830
|
+
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in seconds, for which Amazon SQS can reuse a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data key</a> to encrypt
|
|
1831
|
+
* or decrypt messages before calling KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security
|
|
1832
|
+
* but results in more calls to KMS which might incur charges after Free Tier. For more information, see
|
|
1833
|
+
* <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>.
|
|
1834
|
+
* </p>
|
|
2333
1835
|
* </li>
|
|
2334
1836
|
* <li>
|
|
2335
1837
|
* <p>
|
|
2336
|
-
* <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption
|
|
2337
|
-
* using SQS owned encryption keys. Only one server-side encryption option is
|
|
2338
|
-
* 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>
|
|
1838
|
+
* <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html">SSE-KMS</a> or <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html">SSE-SQS</a>).</p>
|
|
2339
1839
|
* </li>
|
|
2340
1840
|
* </ul>
|
|
2341
|
-
* <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)
|
|
2342
|
-
* queues</a>:</p>
|
|
1841
|
+
* <p>The following attribute applies only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO (first-in-first-out) queues</a>:</p>
|
|
2343
1842
|
* <ul>
|
|
2344
1843
|
* <li>
|
|
2345
1844
|
* <p>
|
|
2346
|
-
* <code>ContentBasedDeduplication</code> – Enables content-based
|
|
2347
|
-
*
|
|
2348
|
-
*
|
|
1845
|
+
* <code>ContentBasedDeduplication</code> – Enables content-based deduplication. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html">Exactly-once processing</a> in the
|
|
1846
|
+
* <i>Amazon SQS Developer Guide</i>. Note the following:
|
|
1847
|
+
* </p>
|
|
2349
1848
|
* <ul>
|
|
2350
1849
|
* <li>
|
|
2351
|
-
* <p>Every message must have a unique
|
|
2352
|
-
* <code>MessageDeduplicationId</code>.</p>
|
|
1850
|
+
* <p>Every message must have a unique <code>MessageDeduplicationId</code>.</p>
|
|
2353
1851
|
* <ul>
|
|
2354
1852
|
* <li>
|
|
2355
|
-
* <p>You may provide a <code>MessageDeduplicationId</code>
|
|
2356
|
-
* explicitly.</p>
|
|
1853
|
+
* <p>You may provide a <code>MessageDeduplicationId</code> explicitly.</p>
|
|
2357
1854
|
* </li>
|
|
2358
1855
|
* <li>
|
|
2359
|
-
* <p>If you aren't able to provide a
|
|
2360
|
-
*
|
|
2361
|
-
*
|
|
2362
|
-
* uses a SHA-256 hash to generate the
|
|
2363
|
-
* <code>MessageDeduplicationId</code> using the body of the
|
|
2364
|
-
* message (but not the attributes of the message). </p>
|
|
1856
|
+
* <p>If you aren't able to provide a <code>MessageDeduplicationId</code> and you enable <code>ContentBasedDeduplication</code> for your queue,
|
|
1857
|
+
* Amazon SQS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using the body of the message (but not the attributes of the message).
|
|
1858
|
+
* </p>
|
|
2365
1859
|
* </li>
|
|
2366
1860
|
* <li>
|
|
2367
|
-
* <p>If you don't provide a <code>MessageDeduplicationId</code> and
|
|
2368
|
-
*
|
|
2369
|
-
* set, the action fails with an error.</p>
|
|
1861
|
+
* <p>If you don't provide a <code>MessageDeduplicationId</code> and the queue doesn't have <code>ContentBasedDeduplication</code> set,
|
|
1862
|
+
* the action fails with an error.</p>
|
|
2370
1863
|
* </li>
|
|
2371
1864
|
* <li>
|
|
2372
|
-
* <p>If the queue has <code>ContentBasedDeduplication</code> set,
|
|
2373
|
-
* your <code>MessageDeduplicationId</code> overrides the generated
|
|
2374
|
-
* one.</p>
|
|
1865
|
+
* <p>If the queue has <code>ContentBasedDeduplication</code> set, your <code>MessageDeduplicationId</code> overrides the generated one.</p>
|
|
2375
1866
|
* </li>
|
|
2376
1867
|
* </ul>
|
|
2377
1868
|
* </li>
|
|
2378
1869
|
* <li>
|
|
2379
|
-
* <p>When <code>ContentBasedDeduplication</code> is in effect, messages
|
|
2380
|
-
*
|
|
2381
|
-
* treated as duplicates and only one copy of the message is
|
|
2382
|
-
* delivered.</p>
|
|
1870
|
+
* <p>When <code>ContentBasedDeduplication</code> is in effect, messages with identical content sent within the deduplication interval are treated as duplicates
|
|
1871
|
+
* and only one copy of the message is delivered.</p>
|
|
2383
1872
|
* </li>
|
|
2384
1873
|
* <li>
|
|
2385
|
-
* <p>If you send one message with <code>ContentBasedDeduplication</code>
|
|
2386
|
-
*
|
|
2387
|
-
*
|
|
2388
|
-
* generated for the first <code>MessageDeduplicationId</code>, the two
|
|
2389
|
-
* messages are treated as duplicates and only one copy of the message is
|
|
2390
|
-
* delivered. </p>
|
|
1874
|
+
* <p>If you send one message with <code>ContentBasedDeduplication</code> enabled and then another message with a <code>MessageDeduplicationId</code> that is the same
|
|
1875
|
+
* as the one generated for the first <code>MessageDeduplicationId</code>, the two messages are treated as duplicates and only one copy of the message is delivered.
|
|
1876
|
+
* </p>
|
|
2391
1877
|
* </li>
|
|
2392
1878
|
* </ul>
|
|
2393
1879
|
* </li>
|