@aws-sdk/client-sqs 3.325.0 → 3.327.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 +10 -7
- 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/endpoint/ruleset.js +2 -2
- package/dist-cjs/models/models_0.js +206 -26
- package/dist-cjs/protocols/Aws_json1_0.js +1608 -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/endpoint/ruleset.js +2 -2
- package/dist-es/models/models_0.js +189 -20
- package/dist-es/protocols/Aws_json1_0.js +1565 -0
- package/dist-types/SQS.d.ts +24 -21
- package/dist-types/SQSClient.d.ts +24 -21
- package/dist-types/commands/AddPermissionCommand.d.ts +55 -26
- package/dist-types/commands/ChangeMessageVisibilityBatchCommand.d.ts +52 -12
- package/dist-types/commands/ChangeMessageVisibilityCommand.d.ts +52 -15
- package/dist-types/commands/CreateQueueCommand.d.ts +64 -24
- package/dist-types/commands/DeleteMessageBatchCommand.d.ts +49 -10
- package/dist-types/commands/DeleteMessageCommand.d.ts +33 -1
- package/dist-types/commands/DeleteQueueCommand.d.ts +48 -8
- package/dist-types/commands/GetQueueAttributesCommand.d.ts +37 -1
- package/dist-types/commands/GetQueueUrlCommand.d.ts +41 -4
- package/dist-types/commands/ListDeadLetterSourceQueuesCommand.d.ts +48 -11
- package/dist-types/commands/ListQueueTagsCommand.d.ts +44 -4
- package/dist-types/commands/ListQueuesCommand.d.ts +49 -10
- package/dist-types/commands/PurgeQueueCommand.d.ts +40 -7
- package/dist-types/commands/ReceiveMessageCommand.d.ts +118 -15
- package/dist-types/commands/RemovePermissionCommand.d.ts +41 -5
- package/dist-types/commands/SendMessageBatchCommand.d.ts +99 -16
- package/dist-types/commands/SendMessageCommand.d.ts +72 -3
- package/dist-types/commands/SetQueueAttributesCommand.d.ts +54 -6
- package/dist-types/commands/TagQueueCommand.d.ts +38 -4
- package/dist-types/commands/UntagQueueCommand.d.ts +38 -3
- package/dist-types/models/models_0.d.ts +1039 -493
- package/dist-types/protocols/{Aws_query.d.ts → Aws_json1_0.d.ts} +40 -40
- package/dist-types/ts3.4/models/models_0.d.ts +119 -52
- package/package.json +8 -9
- package/dist-cjs/protocols/Aws_query.js +0 -2127
- package/dist-es/protocols/Aws_query.js +0 -2084
- /package/dist-types/ts3.4/protocols/{Aws_query.d.ts → Aws_json1_0.d.ts} +0 -0
|
@@ -11,7 +11,10 @@ export interface AddPermissionRequest {
|
|
|
11
11
|
*/
|
|
12
12
|
QueueUrl: string | undefined;
|
|
13
13
|
/**
|
|
14
|
-
* <p>The unique identification of the permission you're setting (for example,
|
|
14
|
+
* <p>The unique identification of the permission you're setting (for example,
|
|
15
|
+
* <code>AliceSendMessage</code>). Maximum 80 characters. Allowed characters include
|
|
16
|
+
* alphanumeric characters, hyphens (<code>-</code>), and underscores
|
|
17
|
+
* (<code>_</code>).</p>
|
|
15
18
|
*/
|
|
16
19
|
Label: string | undefined;
|
|
17
20
|
/**
|
|
@@ -21,18 +24,46 @@ export interface AddPermissionRequest {
|
|
|
21
24
|
*/
|
|
22
25
|
AWSAccountIds: string[] | undefined;
|
|
23
26
|
/**
|
|
24
|
-
* <p>The action the client wants to allow for the specified principal. Valid values: the
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
27
|
+
* <p>The action the client wants to allow for the specified principal. Valid values: the
|
|
28
|
+
* name of any action or <code>*</code>.</p>
|
|
29
|
+
* <p>For more information about these actions, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-overview-of-managing-access.html">Overview of Managing Access Permissions to Your Amazon Simple Queue Service
|
|
30
|
+
* Resource</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
31
|
+
* <p>Specifying <code>SendMessage</code>, <code>DeleteMessage</code>, or
|
|
32
|
+
* <code>ChangeMessageVisibility</code> for <code>ActionName.n</code> also grants
|
|
33
|
+
* permissions for the corresponding batch versions of those actions:
|
|
34
|
+
* <code>SendMessageBatch</code>, <code>DeleteMessageBatch</code>, and
|
|
35
|
+
* <code>ChangeMessageVisibilityBatch</code>.</p>
|
|
29
36
|
*/
|
|
30
37
|
Actions: string[] | undefined;
|
|
31
38
|
}
|
|
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
|
+
}
|
|
32
63
|
/**
|
|
33
64
|
* @public
|
|
34
65
|
* <p>The specified action violates a limit. For example, <code>ReceiveMessage</code>
|
|
35
|
-
* returns this error if the maximum number of
|
|
66
|
+
* returns this error if the maximum number of in flight messages is reached and
|
|
36
67
|
* <code>AddPermission</code> returns this error if the maximum number of permissions
|
|
37
68
|
* for the queue is reached.</p>
|
|
38
69
|
*/
|
|
@@ -44,6 +75,58 @@ export declare class OverLimit extends __BaseException {
|
|
|
44
75
|
*/
|
|
45
76
|
constructor(opts: __ExceptionOptionType<OverLimit, __BaseException>);
|
|
46
77
|
}
|
|
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
|
+
}
|
|
47
130
|
/**
|
|
48
131
|
* @public
|
|
49
132
|
*/
|
|
@@ -54,13 +137,16 @@ export interface ChangeMessageVisibilityRequest {
|
|
|
54
137
|
*/
|
|
55
138
|
QueueUrl: string | undefined;
|
|
56
139
|
/**
|
|
57
|
-
* <p>The receipt handle associated with the message whose visibility timeout is changed.
|
|
140
|
+
* <p>The receipt handle associated with the message whose visibility timeout is changed.
|
|
141
|
+
* This parameter is returned by the <code>
|
|
58
142
|
* <a>ReceiveMessage</a>
|
|
59
|
-
* </code>
|
|
143
|
+
* </code>
|
|
144
|
+
* action.</p>
|
|
60
145
|
*/
|
|
61
146
|
ReceiptHandle: string | undefined;
|
|
62
147
|
/**
|
|
63
|
-
* <p>The new value for the message's visibility timeout (in seconds). Values range:
|
|
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>
|
|
64
150
|
*/
|
|
65
151
|
VisibilityTimeout: number | undefined;
|
|
66
152
|
}
|
|
@@ -105,22 +191,11 @@ export declare class BatchEntryIdsNotDistinct extends __BaseException {
|
|
|
105
191
|
* <p>Encloses a receipt handle and an entry id for each message in <code>
|
|
106
192
|
* <a>ChangeMessageVisibilityBatch</a>.</code>
|
|
107
193
|
* </p>
|
|
108
|
-
* <important>
|
|
109
|
-
* <p>All of the following list parameters must be prefixed with <code>ChangeMessageVisibilityBatchRequestEntry.n</code>, where <code>n</code> is an integer value starting with <code>1</code>. For example, a parameter list for this action might look like this:</p>
|
|
110
|
-
* </important>
|
|
111
|
-
* <p>
|
|
112
|
-
* <code>&ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2</code>
|
|
113
|
-
* </p>
|
|
114
|
-
* <p>
|
|
115
|
-
* <code>&ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=your_receipt_handle</code>
|
|
116
|
-
* </p>
|
|
117
|
-
* <p>
|
|
118
|
-
* <code>&ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45</code>
|
|
119
|
-
* </p>
|
|
120
194
|
*/
|
|
121
195
|
export interface ChangeMessageVisibilityBatchRequestEntry {
|
|
122
196
|
/**
|
|
123
|
-
* <p>An identifier for this particular receipt handle used to communicate the
|
|
197
|
+
* <p>An identifier for this particular receipt handle used to communicate the
|
|
198
|
+
* result.</p>
|
|
124
199
|
* <note>
|
|
125
200
|
* <p>The <code>Id</code>s of a batch request need to be unique within a request.</p>
|
|
126
201
|
* <p>This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).</p>
|
|
@@ -147,7 +222,8 @@ export interface ChangeMessageVisibilityBatchRequest {
|
|
|
147
222
|
*/
|
|
148
223
|
QueueUrl: string | undefined;
|
|
149
224
|
/**
|
|
150
|
-
* <p>A list of receipt handles of the messages for which the visibility timeout must be
|
|
225
|
+
* <p>A list of receipt handles of the messages for which the visibility timeout must be
|
|
226
|
+
* changed.</p>
|
|
151
227
|
*/
|
|
152
228
|
Entries: ChangeMessageVisibilityBatchRequestEntry[] | undefined;
|
|
153
229
|
}
|
|
@@ -190,15 +266,18 @@ export interface ChangeMessageVisibilityBatchResultEntry {
|
|
|
190
266
|
* @public
|
|
191
267
|
* <p>For each message in the batch, the response contains a <code>
|
|
192
268
|
* <a>ChangeMessageVisibilityBatchResultEntry</a>
|
|
193
|
-
* </code> tag if the message
|
|
269
|
+
* </code> tag if the message
|
|
270
|
+
* succeeds or a <code>
|
|
194
271
|
* <a>BatchResultErrorEntry</a>
|
|
195
|
-
* </code> tag if the message
|
|
272
|
+
* </code> tag if the message
|
|
273
|
+
* fails.</p>
|
|
196
274
|
*/
|
|
197
275
|
export interface ChangeMessageVisibilityBatchResult {
|
|
198
276
|
/**
|
|
199
277
|
* <p>A list of <code>
|
|
200
278
|
* <a>ChangeMessageVisibilityBatchResultEntry</a>
|
|
201
|
-
* </code>
|
|
279
|
+
* </code>
|
|
280
|
+
* items.</p>
|
|
202
281
|
*/
|
|
203
282
|
Successful: ChangeMessageVisibilityBatchResultEntry[] | undefined;
|
|
204
283
|
/**
|
|
@@ -222,7 +301,8 @@ export declare class EmptyBatchRequest extends __BaseException {
|
|
|
222
301
|
}
|
|
223
302
|
/**
|
|
224
303
|
* @public
|
|
225
|
-
* <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the
|
|
304
|
+
* <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the
|
|
305
|
+
* specification.</p>
|
|
226
306
|
*/
|
|
227
307
|
export declare class InvalidBatchEntryId extends __BaseException {
|
|
228
308
|
readonly name: "InvalidBatchEntryId";
|
|
@@ -244,10 +324,38 @@ export declare class TooManyEntriesInBatchRequest extends __BaseException {
|
|
|
244
324
|
*/
|
|
245
325
|
constructor(opts: __ExceptionOptionType<TooManyEntriesInBatchRequest, __BaseException>);
|
|
246
326
|
}
|
|
327
|
+
/**
|
|
328
|
+
* @public
|
|
329
|
+
* @enum
|
|
330
|
+
*/
|
|
331
|
+
export declare const QueueAttributeName: {
|
|
332
|
+
readonly All: "All";
|
|
333
|
+
readonly ApproximateNumberOfMessages: "ApproximateNumberOfMessages";
|
|
334
|
+
readonly ApproximateNumberOfMessagesDelayed: "ApproximateNumberOfMessagesDelayed";
|
|
335
|
+
readonly ApproximateNumberOfMessagesNotVisible: "ApproximateNumberOfMessagesNotVisible";
|
|
336
|
+
readonly ContentBasedDeduplication: "ContentBasedDeduplication";
|
|
337
|
+
readonly CreatedTimestamp: "CreatedTimestamp";
|
|
338
|
+
readonly DeduplicationScope: "DeduplicationScope";
|
|
339
|
+
readonly DelaySeconds: "DelaySeconds";
|
|
340
|
+
readonly FifoQueue: "FifoQueue";
|
|
341
|
+
readonly FifoThroughputLimit: "FifoThroughputLimit";
|
|
342
|
+
readonly KmsDataKeyReusePeriodSeconds: "KmsDataKeyReusePeriodSeconds";
|
|
343
|
+
readonly KmsMasterKeyId: "KmsMasterKeyId";
|
|
344
|
+
readonly LastModifiedTimestamp: "LastModifiedTimestamp";
|
|
345
|
+
readonly MaximumMessageSize: "MaximumMessageSize";
|
|
346
|
+
readonly MessageRetentionPeriod: "MessageRetentionPeriod";
|
|
347
|
+
readonly Policy: "Policy";
|
|
348
|
+
readonly QueueArn: "QueueArn";
|
|
349
|
+
readonly ReceiveMessageWaitTimeSeconds: "ReceiveMessageWaitTimeSeconds";
|
|
350
|
+
readonly RedriveAllowPolicy: "RedriveAllowPolicy";
|
|
351
|
+
readonly RedrivePolicy: "RedrivePolicy";
|
|
352
|
+
readonly SqsManagedSseEnabled: "SqsManagedSseEnabled";
|
|
353
|
+
readonly VisibilityTimeout: "VisibilityTimeout";
|
|
354
|
+
};
|
|
247
355
|
/**
|
|
248
356
|
* @public
|
|
249
357
|
*/
|
|
250
|
-
export type QueueAttributeName =
|
|
358
|
+
export type QueueAttributeName = (typeof QueueAttributeName)[keyof typeof QueueAttributeName];
|
|
251
359
|
/**
|
|
252
360
|
* @public
|
|
253
361
|
* <p></p>
|
|
@@ -257,183 +365,230 @@ export interface CreateQueueRequest {
|
|
|
257
365
|
* <p>The name of the new queue. The following limits apply to this name:</p>
|
|
258
366
|
* <ul>
|
|
259
367
|
* <li>
|
|
260
|
-
*
|
|
368
|
+
* <p>A queue name can have up to 80 characters.</p>
|
|
261
369
|
* </li>
|
|
262
370
|
* <li>
|
|
263
|
-
*
|
|
371
|
+
* <p>Valid values: alphanumeric characters, hyphens (<code>-</code>), and
|
|
372
|
+
* underscores (<code>_</code>).</p>
|
|
264
373
|
* </li>
|
|
265
374
|
* <li>
|
|
266
|
-
*
|
|
375
|
+
* <p>A FIFO queue name must end with the <code>.fifo</code> suffix.</p>
|
|
267
376
|
* </li>
|
|
268
377
|
* </ul>
|
|
269
378
|
* <p>Queue URLs and names are case-sensitive.</p>
|
|
270
379
|
*/
|
|
271
380
|
QueueName: string | undefined;
|
|
272
|
-
/**
|
|
273
|
-
* <p>Add cost allocation tags to the specified Amazon SQS queue. For an overview, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html">Tagging
|
|
274
|
-
* Your Amazon SQS Queues</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
275
|
-
*
|
|
276
|
-
* <p>When you use queue tags, keep the following guidelines in mind:</p>
|
|
277
|
-
* <ul>
|
|
278
|
-
* <li>
|
|
279
|
-
* <p>Adding more than 50 tags to a queue isn't recommended.</p>
|
|
280
|
-
* </li>
|
|
281
|
-
* <li>
|
|
282
|
-
* <p>Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.</p>
|
|
283
|
-
* </li>
|
|
284
|
-
* <li>
|
|
285
|
-
* <p>Tags are case-sensitive.</p>
|
|
286
|
-
* </li>
|
|
287
|
-
* <li>
|
|
288
|
-
* <p>A new tag with a key identical to that of an existing tag overwrites the existing tag.</p>
|
|
289
|
-
* </li>
|
|
290
|
-
* </ul>
|
|
291
|
-
* <p>For a full list of tag restrictions, see
|
|
292
|
-
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues">Quotas related to queues</a>
|
|
293
|
-
* in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
294
|
-
* <note>
|
|
295
|
-
* <p>To be able to tag a queue on creation, you must have the
|
|
296
|
-
* <code>sqs:CreateQueue</code> and <code>sqs:TagQueue</code> permissions.</p>
|
|
297
|
-
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
298
|
-
* 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
|
|
299
|
-
* cross-account permissions to a role and a user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
300
|
-
* </note>
|
|
301
|
-
*/
|
|
302
|
-
tags?: Record<string, string>;
|
|
303
381
|
/**
|
|
304
382
|
* <p>A map of attributes with their corresponding values.</p>
|
|
305
|
-
* <p>The following lists the names, descriptions, and values of the special request
|
|
383
|
+
* <p>The following lists the names, descriptions, and values of the special request
|
|
384
|
+
* parameters that the <code>CreateQueue</code> action uses:</p>
|
|
306
385
|
* <ul>
|
|
307
386
|
* <li>
|
|
308
387
|
* <p>
|
|
309
|
-
* <code>DelaySeconds</code> – The length of time, in seconds, for which the
|
|
310
|
-
*
|
|
388
|
+
* <code>DelaySeconds</code> – The length of time, in seconds, for which the
|
|
389
|
+
* delivery of all messages in the queue is delayed. Valid values: An integer from
|
|
390
|
+
* 0 to 900 seconds (15 minutes). Default: 0. </p>
|
|
311
391
|
* </li>
|
|
312
392
|
* <li>
|
|
313
393
|
* <p>
|
|
314
|
-
* <code>MaximumMessageSize</code> – The limit of how many bytes a message
|
|
315
|
-
*
|
|
394
|
+
* <code>MaximumMessageSize</code> – The limit of how many bytes a message
|
|
395
|
+
* can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes
|
|
396
|
+
* (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). </p>
|
|
316
397
|
* </li>
|
|
317
398
|
* <li>
|
|
318
399
|
* <p>
|
|
319
|
-
* <code>MessageRetentionPeriod</code> – The length of time, in seconds, for
|
|
320
|
-
*
|
|
400
|
+
* <code>MessageRetentionPeriod</code> – The length of time, in seconds, for
|
|
401
|
+
* which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1
|
|
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>
|
|
321
409
|
* </li>
|
|
322
410
|
* <li>
|
|
323
411
|
* <p>
|
|
324
|
-
* <code>Policy</code> – The queue's policy. A valid Amazon Web Services policy. For more
|
|
325
|
-
*
|
|
412
|
+
* <code>Policy</code> – The queue's policy. A valid Amazon Web Services policy. For more
|
|
413
|
+
* information about policy structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview of Amazon Web Services IAM
|
|
414
|
+
* Policies</a> in the <i>IAM User Guide</i>. </p>
|
|
326
415
|
* </li>
|
|
327
416
|
* <li>
|
|
328
417
|
* <p>
|
|
329
|
-
* <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in
|
|
418
|
+
* <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in
|
|
419
|
+
* seconds, for which a <code>
|
|
330
420
|
* <a>ReceiveMessage</a>
|
|
331
|
-
* </code> action waits
|
|
332
|
-
*
|
|
421
|
+
* </code> action waits
|
|
422
|
+
* for a message to arrive. Valid values: An integer from 0 to 20 (seconds).
|
|
423
|
+
* Default: 0. </p>
|
|
333
424
|
* </li>
|
|
334
425
|
* <li>
|
|
335
426
|
* <p>
|
|
427
|
+
* <code>VisibilityTimeout</code> – The visibility timeout for the queue, in
|
|
428
|
+
* seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For
|
|
429
|
+
* 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
|
|
430
|
+
* Guide</i>.</p>
|
|
431
|
+
* </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
|
+
* <li>
|
|
437
|
+
* <p>
|
|
336
438
|
* <code>RedrivePolicy</code> – The string that includes the parameters for the dead-letter queue functionality
|
|
337
|
-
*
|
|
338
|
-
*
|
|
339
|
-
* <ul>
|
|
439
|
+
* of the source queue as a JSON object. The parameters are as follows:</p>
|
|
440
|
+
* <ul>
|
|
340
441
|
* <li>
|
|
341
|
-
*
|
|
342
|
-
* <code>deadLetterTargetArn</code> – The Amazon Resource Name (ARN) of the dead-letter queue to
|
|
442
|
+
* <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>
|
|
343
445
|
* </li>
|
|
344
446
|
* <li>
|
|
345
|
-
*
|
|
346
|
-
* <code>maxReceiveCount</code> – The number of times a message is delivered to the source queue before being
|
|
347
|
-
*
|
|
447
|
+
* <p>
|
|
448
|
+
* <code>maxReceiveCount</code> – The number of times a message is delivered to the source queue before being
|
|
449
|
+
* moved to the dead-letter queue. Default: 10. When the <code>ReceiveCount</code> for a message exceeds the <code>maxReceiveCount</code>
|
|
450
|
+
* for a queue, Amazon SQS moves the message to the dead-letter-queue.</p>
|
|
348
451
|
* </li>
|
|
349
452
|
* </ul>
|
|
350
|
-
* <note>
|
|
351
|
-
* <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>
|
|
352
|
-
* </note>
|
|
353
453
|
* </li>
|
|
354
454
|
* <li>
|
|
355
455
|
* <p>
|
|
356
|
-
* <code>
|
|
357
|
-
*
|
|
456
|
+
* <code>RedriveAllowPolicy</code> – The string that includes the parameters for the permissions for the dead-letter
|
|
457
|
+
* queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:</p>
|
|
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>
|
|
358
490
|
* </li>
|
|
359
491
|
* </ul>
|
|
360
|
-
*
|
|
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>
|
|
361
497
|
* <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html">server-side-encryption</a>:</p>
|
|
362
498
|
* <ul>
|
|
363
499
|
* <li>
|
|
364
|
-
*
|
|
365
|
-
* <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer master
|
|
366
|
-
*
|
|
367
|
-
*
|
|
368
|
-
*
|
|
369
|
-
*
|
|
500
|
+
* <p>
|
|
501
|
+
* <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer master
|
|
502
|
+
* key (CMK) for Amazon SQS or a custom CMK. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key Terms</a>. While the alias of the Amazon Web Services managed CMK for Amazon SQS is
|
|
503
|
+
* always <code>alias/aws/sqs</code>, the alias of a custom CMK can, for example,
|
|
504
|
+
* be <code>alias/<i>MyAlias</i>
|
|
505
|
+
* </code>. For more examples, see
|
|
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>
|
|
370
508
|
* </li>
|
|
371
509
|
* <li>
|
|
372
|
-
*
|
|
373
|
-
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in
|
|
374
|
-
*
|
|
375
|
-
*
|
|
376
|
-
*
|
|
377
|
-
*
|
|
510
|
+
* <p>
|
|
511
|
+
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in
|
|
512
|
+
* 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
|
|
513
|
+
* encrypt or decrypt messages before calling KMS again. An integer
|
|
514
|
+
* representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
|
515
|
+
* hours). Default: 300 (5 minutes). A shorter time period provides better security
|
|
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>
|
|
378
519
|
* </li>
|
|
379
520
|
* <li>
|
|
380
|
-
*
|
|
381
|
-
* <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption
|
|
521
|
+
* <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>
|
|
382
525
|
* </li>
|
|
383
526
|
* </ul>
|
|
384
|
-
*
|
|
385
|
-
*
|
|
386
|
-
* <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>
|
|
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>
|
|
387
529
|
* <ul>
|
|
388
530
|
* <li>
|
|
389
|
-
*
|
|
390
|
-
* <code>FifoQueue</code> – Designates a queue as FIFO. Valid values are
|
|
391
|
-
*
|
|
392
|
-
*
|
|
393
|
-
*
|
|
394
|
-
*
|
|
395
|
-
*
|
|
531
|
+
* <p>
|
|
532
|
+
* <code>FifoQueue</code> – Designates a queue as FIFO. Valid values are
|
|
533
|
+
* <code>true</code> and <code>false</code>. If you don't specify the <code>FifoQueue</code> attribute, Amazon SQS creates a standard queue. You
|
|
534
|
+
* can provide this attribute only during queue creation. You can't change it for
|
|
535
|
+
* an existing queue. When you set this attribute, you must also provide the
|
|
536
|
+
* <code>MessageGroupId</code> for your messages explicitly.</p>
|
|
537
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html">FIFO queue logic</a> in the <i>Amazon SQS Developer
|
|
538
|
+
* Guide</i>.</p>
|
|
396
539
|
* </li>
|
|
397
540
|
* <li>
|
|
398
|
-
*
|
|
399
|
-
* <code>ContentBasedDeduplication</code> – Enables content-based
|
|
400
|
-
*
|
|
401
|
-
*
|
|
402
|
-
*
|
|
541
|
+
* <p>
|
|
542
|
+
* <code>ContentBasedDeduplication</code> – Enables content-based
|
|
543
|
+
* deduplication. Valid values are <code>true</code> and <code>false</code>. For
|
|
544
|
+
* 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
|
|
545
|
+
* Guide</i>. Note the following: </p>
|
|
546
|
+
* <ul>
|
|
403
547
|
* <li>
|
|
404
|
-
*
|
|
405
|
-
*
|
|
548
|
+
* <p>Every message must have a unique
|
|
549
|
+
* <code>MessageDeduplicationId</code>.</p>
|
|
550
|
+
* <ul>
|
|
406
551
|
* <li>
|
|
407
|
-
*
|
|
408
|
-
*
|
|
552
|
+
* <p>You may provide a <code>MessageDeduplicationId</code>
|
|
553
|
+
* explicitly.</p>
|
|
554
|
+
* </li>
|
|
409
555
|
* <li>
|
|
410
|
-
*
|
|
411
|
-
*
|
|
412
|
-
*
|
|
413
|
-
*
|
|
556
|
+
* <p>If you aren't able to provide a
|
|
557
|
+
* <code>MessageDeduplicationId</code> and you enable
|
|
558
|
+
* <code>ContentBasedDeduplication</code> for your queue, Amazon SQS
|
|
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>
|
|
562
|
+
* </li>
|
|
414
563
|
* <li>
|
|
415
|
-
*
|
|
416
|
-
*
|
|
417
|
-
*
|
|
564
|
+
* <p>If you don't provide a <code>MessageDeduplicationId</code> and
|
|
565
|
+
* the queue doesn't have <code>ContentBasedDeduplication</code>
|
|
566
|
+
* set, the action fails with an error.</p>
|
|
567
|
+
* </li>
|
|
418
568
|
* <li>
|
|
419
|
-
*
|
|
420
|
-
*
|
|
569
|
+
* <p>If the queue has <code>ContentBasedDeduplication</code> set,
|
|
570
|
+
* your <code>MessageDeduplicationId</code> overrides the generated
|
|
571
|
+
* one.</p>
|
|
572
|
+
* </li>
|
|
421
573
|
* </ul>
|
|
422
574
|
* </li>
|
|
423
575
|
* <li>
|
|
424
|
-
*
|
|
425
|
-
*
|
|
576
|
+
* <p>When <code>ContentBasedDeduplication</code> is in effect, messages
|
|
577
|
+
* with identical content sent within the deduplication interval are
|
|
578
|
+
* treated as duplicates and only one copy of the message is
|
|
579
|
+
* delivered.</p>
|
|
426
580
|
* </li>
|
|
427
581
|
* <li>
|
|
428
|
-
*
|
|
429
|
-
*
|
|
430
|
-
*
|
|
582
|
+
* <p>If you send one message with <code>ContentBasedDeduplication</code>
|
|
583
|
+
* enabled and then another message with a
|
|
584
|
+
* <code>MessageDeduplicationId</code> that is the same as the one
|
|
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>
|
|
431
588
|
* </li>
|
|
432
589
|
* </ul>
|
|
433
590
|
* </li>
|
|
434
591
|
* </ul>
|
|
435
|
-
*
|
|
436
|
-
*
|
|
437
592
|
* <p>The following attributes apply only to
|
|
438
593
|
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html">high throughput
|
|
439
594
|
* for FIFO queues</a>:</p>
|
|
@@ -466,6 +621,36 @@ export interface CreateQueueRequest {
|
|
|
466
621
|
* in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
467
622
|
*/
|
|
468
623
|
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>;
|
|
469
654
|
}
|
|
470
655
|
/**
|
|
471
656
|
* @public
|
|
@@ -477,6 +662,30 @@ export interface CreateQueueResult {
|
|
|
477
662
|
*/
|
|
478
663
|
QueueUrl?: string;
|
|
479
664
|
}
|
|
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
|
+
}
|
|
480
689
|
/**
|
|
481
690
|
* @public
|
|
482
691
|
* <p>You must wait 60 seconds after deleting a queue before you can create another queue
|
|
@@ -520,6 +729,8 @@ export interface DeleteMessageRequest {
|
|
|
520
729
|
}
|
|
521
730
|
/**
|
|
522
731
|
* @public
|
|
732
|
+
* @deprecated
|
|
733
|
+
*
|
|
523
734
|
* <p>The specified receipt handle isn't valid for the current version.</p>
|
|
524
735
|
*/
|
|
525
736
|
export declare class InvalidIdFormat extends __BaseException {
|
|
@@ -536,7 +747,8 @@ export declare class InvalidIdFormat extends __BaseException {
|
|
|
536
747
|
*/
|
|
537
748
|
export interface DeleteMessageBatchRequestEntry {
|
|
538
749
|
/**
|
|
539
|
-
* <p>An identifier for this particular receipt handle. This is used to communicate the
|
|
750
|
+
* <p>An identifier for this particular receipt handle. This is used to communicate the
|
|
751
|
+
* result.</p>
|
|
540
752
|
* <note>
|
|
541
753
|
* <p>The <code>Id</code>s of a batch request need to be unique within a request.</p>
|
|
542
754
|
* <p>This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).</p>
|
|
@@ -577,11 +789,13 @@ export interface DeleteMessageBatchResultEntry {
|
|
|
577
789
|
}
|
|
578
790
|
/**
|
|
579
791
|
* @public
|
|
580
|
-
* <p>For each message in the batch, the response contains a
|
|
792
|
+
* <p>For each message in the batch, the response contains a <code>
|
|
581
793
|
* <a>DeleteMessageBatchResultEntry</a>
|
|
582
|
-
* </code> tag if the message is deleted
|
|
794
|
+
* </code> tag if the message is deleted
|
|
795
|
+
* or a <code>
|
|
583
796
|
* <a>BatchResultErrorEntry</a>
|
|
584
|
-
* </code> tag if the message can't be
|
|
797
|
+
* </code> tag if the message can't be
|
|
798
|
+
* deleted.</p>
|
|
585
799
|
*/
|
|
586
800
|
export interface DeleteMessageBatchResult {
|
|
587
801
|
/**
|
|
@@ -620,17 +834,18 @@ export interface GetQueueAttributesRequest {
|
|
|
620
834
|
QueueUrl: string | undefined;
|
|
621
835
|
/**
|
|
622
836
|
* <p>A list of attributes for which to retrieve information.</p>
|
|
623
|
-
* <p>The <code>
|
|
624
|
-
*
|
|
837
|
+
* <p>The <code>AttributeNames</code> parameter is optional, but if you don't specify values
|
|
838
|
+
* for this parameter, the request returns empty results.</p>
|
|
625
839
|
* <note>
|
|
626
840
|
* <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>
|
|
627
841
|
* </note>
|
|
628
842
|
* <p>The following attributes are supported:</p>
|
|
629
843
|
* <important>
|
|
630
|
-
* <p>The <code>ApproximateNumberOfMessagesDelayed</code>,
|
|
631
|
-
*
|
|
632
|
-
*
|
|
633
|
-
*
|
|
844
|
+
* <p>The <code>ApproximateNumberOfMessagesDelayed</code>,
|
|
845
|
+
* <code>ApproximateNumberOfMessagesNotVisible</code>, and
|
|
846
|
+
* <code>ApproximateNumberOfMessages</code> metrics may not achieve consistency
|
|
847
|
+
* until at least 1 minute after the producers stop sending messages. This period is
|
|
848
|
+
* required for the queue metadata to reach eventual consistency. </p>
|
|
634
849
|
* </important>
|
|
635
850
|
* <ul>
|
|
636
851
|
* <li>
|
|
@@ -639,28 +854,29 @@ export interface GetQueueAttributesRequest {
|
|
|
639
854
|
* </li>
|
|
640
855
|
* <li>
|
|
641
856
|
* <p>
|
|
642
|
-
* <code>ApproximateNumberOfMessages</code> – Returns the approximate
|
|
643
|
-
* messages available for retrieval from the queue.</p>
|
|
857
|
+
* <code>ApproximateNumberOfMessages</code> – Returns the approximate
|
|
858
|
+
* number of messages available for retrieval from the queue.</p>
|
|
644
859
|
* </li>
|
|
645
860
|
* <li>
|
|
646
861
|
* <p>
|
|
647
|
-
* <code>ApproximateNumberOfMessagesDelayed</code> – Returns the
|
|
648
|
-
* of messages in the queue that are delayed and not available
|
|
649
|
-
* immediately. This can happen when the queue is configured as a delay
|
|
650
|
-
* when a message has been sent with a delay parameter.</p>
|
|
862
|
+
* <code>ApproximateNumberOfMessagesDelayed</code> – Returns the
|
|
863
|
+
* approximate number of messages in the queue that are delayed and not available
|
|
864
|
+
* for reading immediately. This can happen when the queue is configured as a delay
|
|
865
|
+
* queue or when a message has been sent with a delay parameter.</p>
|
|
651
866
|
* </li>
|
|
652
867
|
* <li>
|
|
653
868
|
* <p>
|
|
654
|
-
* <code>ApproximateNumberOfMessagesNotVisible</code> – Returns the
|
|
655
|
-
* number of messages that are in flight. Messages are considered to be
|
|
869
|
+
* <code>ApproximateNumberOfMessagesNotVisible</code> – Returns the
|
|
870
|
+
* approximate number of messages that are in flight. Messages are considered to be
|
|
656
871
|
* <i>in flight</i> if they have been sent to a client but have
|
|
657
|
-
* not yet been deleted or have not yet reached the end of their visibility window.
|
|
872
|
+
* not yet been deleted or have not yet reached the end of their visibility window.
|
|
873
|
+
* </p>
|
|
658
874
|
* </li>
|
|
659
875
|
* <li>
|
|
660
876
|
* <p>
|
|
661
|
-
* <code>CreatedTimestamp</code> – Returns the time when the queue was
|
|
662
|
-
* seconds (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch
|
|
663
|
-
*
|
|
877
|
+
* <code>CreatedTimestamp</code> – Returns the time when the queue was
|
|
878
|
+
* created in seconds (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch
|
|
879
|
+
* time</a>).</p>
|
|
664
880
|
* </li>
|
|
665
881
|
* <li>
|
|
666
882
|
* <p>
|
|
@@ -669,19 +885,24 @@ export interface GetQueueAttributesRequest {
|
|
|
669
885
|
* </li>
|
|
670
886
|
* <li>
|
|
671
887
|
* <p>
|
|
672
|
-
* <code>LastModifiedTimestamp</code> – Returns the time when the queue
|
|
673
|
-
* changed in seconds (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch
|
|
674
|
-
* time</a>).</p>
|
|
888
|
+
* <code>LastModifiedTimestamp</code> – Returns the time when the queue
|
|
889
|
+
* was last changed in seconds (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a>).</p>
|
|
675
890
|
* </li>
|
|
676
891
|
* <li>
|
|
677
892
|
* <p>
|
|
678
|
-
* <code>MaximumMessageSize</code> – Returns the limit of how many bytes a
|
|
679
|
-
* can contain before Amazon SQS rejects it.</p>
|
|
893
|
+
* <code>MaximumMessageSize</code> – Returns the limit of how many bytes a
|
|
894
|
+
* message can contain before Amazon SQS rejects it.</p>
|
|
680
895
|
* </li>
|
|
681
896
|
* <li>
|
|
682
897
|
* <p>
|
|
683
|
-
* <code>MessageRetentionPeriod</code> – Returns the length of time, in
|
|
684
|
-
* for which Amazon SQS retains a message
|
|
898
|
+
* <code>MessageRetentionPeriod</code> – Returns the length of time, in
|
|
899
|
+
* seconds, for which Amazon SQS retains a message. When you change a queue's
|
|
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>
|
|
685
906
|
* </li>
|
|
686
907
|
* <li>
|
|
687
908
|
* <p>
|
|
@@ -694,71 +915,121 @@ export interface GetQueueAttributesRequest {
|
|
|
694
915
|
* </li>
|
|
695
916
|
* <li>
|
|
696
917
|
* <p>
|
|
697
|
-
* <code>ReceiveMessageWaitTimeSeconds</code> – Returns the length of
|
|
698
|
-
* seconds, for which the <code>ReceiveMessage</code> action waits for a
|
|
699
|
-
* arrive. </p>
|
|
918
|
+
* <code>ReceiveMessageWaitTimeSeconds</code> – Returns the length of
|
|
919
|
+
* time, in seconds, for which the <code>ReceiveMessage</code> action waits for a
|
|
920
|
+
* message to arrive. </p>
|
|
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>
|
|
700
927
|
* </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>
|
|
701
932
|
* <li>
|
|
702
933
|
* <p>
|
|
703
934
|
* <code>RedrivePolicy</code> – The string that includes the parameters for the dead-letter queue functionality
|
|
704
|
-
*
|
|
705
|
-
*
|
|
706
|
-
* <ul>
|
|
935
|
+
* of the source queue as a JSON object. The parameters are as follows:</p>
|
|
936
|
+
* <ul>
|
|
707
937
|
* <li>
|
|
708
|
-
*
|
|
709
|
-
* <code>deadLetterTargetArn</code> – The Amazon Resource Name (ARN) of the dead-letter queue to
|
|
938
|
+
* <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>
|
|
710
941
|
* </li>
|
|
711
942
|
* <li>
|
|
712
|
-
*
|
|
713
|
-
* <code>maxReceiveCount</code> – The number of times a message is delivered to the source queue before being
|
|
714
|
-
*
|
|
943
|
+
* <p>
|
|
944
|
+
* <code>maxReceiveCount</code> – The number of times a message is delivered to the source queue before being
|
|
945
|
+
* moved to the dead-letter queue. Default: 10. When the <code>ReceiveCount</code> for a message exceeds the <code>maxReceiveCount</code>
|
|
946
|
+
* for a queue, Amazon SQS moves the message to the dead-letter-queue.</p>
|
|
715
947
|
* </li>
|
|
716
948
|
* </ul>
|
|
717
949
|
* </li>
|
|
718
950
|
* <li>
|
|
719
951
|
* <p>
|
|
720
|
-
* <code>
|
|
721
|
-
*
|
|
952
|
+
* <code>RedriveAllowPolicy</code> – The string that includes the parameters for the permissions for the dead-letter
|
|
953
|
+
* queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:</p>
|
|
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>
|
|
722
986
|
* </li>
|
|
723
987
|
* </ul>
|
|
724
|
-
*
|
|
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>
|
|
725
993
|
* <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html">server-side-encryption</a>:</p>
|
|
726
994
|
* <ul>
|
|
727
995
|
* <li>
|
|
728
|
-
*
|
|
729
|
-
* <code>KmsMasterKeyId</code> – Returns the ID of an Amazon Web Services managed customer
|
|
730
|
-
*
|
|
996
|
+
* <p>
|
|
997
|
+
* <code>KmsMasterKeyId</code> – Returns the ID of an Amazon Web Services managed customer
|
|
998
|
+
* master key (CMK) for Amazon SQS or a custom CMK. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key Terms</a>. </p>
|
|
731
999
|
* </li>
|
|
732
1000
|
* <li>
|
|
733
|
-
*
|
|
734
|
-
* <code>KmsDataKeyReusePeriodSeconds</code> – Returns the length of time,
|
|
735
|
-
*
|
|
736
|
-
*
|
|
1001
|
+
* <p>
|
|
1002
|
+
* <code>KmsDataKeyReusePeriodSeconds</code> – Returns the length of time,
|
|
1003
|
+
* in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt
|
|
1004
|
+
* messages before calling KMS again. For more information, see
|
|
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>
|
|
737
1006
|
* </li>
|
|
738
1007
|
* <li>
|
|
739
|
-
*
|
|
740
|
-
* <code>SqsManagedSseEnabled</code> – Returns information about whether the
|
|
1008
|
+
* <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>
|
|
741
1012
|
* </li>
|
|
742
1013
|
* </ul>
|
|
743
|
-
*
|
|
744
|
-
*
|
|
745
|
-
* <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>
|
|
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>
|
|
746
1016
|
* <ul>
|
|
747
1017
|
* <li>
|
|
748
|
-
*
|
|
749
|
-
* <code>FifoQueue</code> – Returns information about whether the queue is
|
|
750
|
-
*
|
|
1018
|
+
* <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>
|
|
1022
|
+
* <note>
|
|
751
1023
|
* <p>To determine whether a queue is <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO</a>, you can check whether <code>QueueName</code> ends with the <code>.fifo</code> suffix.</p>
|
|
752
1024
|
* </note>
|
|
753
1025
|
* </li>
|
|
754
1026
|
* <li>
|
|
755
|
-
*
|
|
756
|
-
* <code>ContentBasedDeduplication</code> – Returns whether content-based
|
|
757
|
-
*
|
|
1027
|
+
* <p>
|
|
1028
|
+
* <code>ContentBasedDeduplication</code> – Returns whether content-based
|
|
1029
|
+
* 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
|
|
1030
|
+
* Guide</i>. </p>
|
|
758
1031
|
* </li>
|
|
759
1032
|
* </ul>
|
|
760
|
-
*
|
|
761
|
-
*
|
|
762
1033
|
* <p>The following attributes apply only to
|
|
763
1034
|
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html">high throughput
|
|
764
1035
|
* for FIFO queues</a>:</p>
|
|
@@ -802,25 +1073,15 @@ export interface GetQueueAttributesResult {
|
|
|
802
1073
|
*/
|
|
803
1074
|
Attributes?: Record<string, string>;
|
|
804
1075
|
}
|
|
805
|
-
/**
|
|
806
|
-
* @public
|
|
807
|
-
* <p>The specified attribute doesn't exist.</p>
|
|
808
|
-
*/
|
|
809
|
-
export declare class InvalidAttributeName extends __BaseException {
|
|
810
|
-
readonly name: "InvalidAttributeName";
|
|
811
|
-
readonly $fault: "client";
|
|
812
|
-
/**
|
|
813
|
-
* @internal
|
|
814
|
-
*/
|
|
815
|
-
constructor(opts: __ExceptionOptionType<InvalidAttributeName, __BaseException>);
|
|
816
|
-
}
|
|
817
1076
|
/**
|
|
818
1077
|
* @public
|
|
819
1078
|
* <p></p>
|
|
820
1079
|
*/
|
|
821
1080
|
export interface GetQueueUrlRequest {
|
|
822
1081
|
/**
|
|
823
|
-
* <p>The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values:
|
|
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>
|
|
824
1085
|
* <p>Queue URLs and names are case-sensitive.</p>
|
|
825
1086
|
*/
|
|
826
1087
|
QueueName: string | undefined;
|
|
@@ -831,7 +1092,8 @@ export interface GetQueueUrlRequest {
|
|
|
831
1092
|
}
|
|
832
1093
|
/**
|
|
833
1094
|
* @public
|
|
834
|
-
* <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
|
|
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>
|
|
835
1097
|
*/
|
|
836
1098
|
export interface GetQueueUrlResult {
|
|
837
1099
|
/**
|
|
@@ -839,18 +1101,6 @@ export interface GetQueueUrlResult {
|
|
|
839
1101
|
*/
|
|
840
1102
|
QueueUrl?: string;
|
|
841
1103
|
}
|
|
842
|
-
/**
|
|
843
|
-
* @public
|
|
844
|
-
* <p>The specified queue doesn't exist.</p>
|
|
845
|
-
*/
|
|
846
|
-
export declare class QueueDoesNotExist extends __BaseException {
|
|
847
|
-
readonly name: "QueueDoesNotExist";
|
|
848
|
-
readonly $fault: "client";
|
|
849
|
-
/**
|
|
850
|
-
* @internal
|
|
851
|
-
*/
|
|
852
|
-
constructor(opts: __ExceptionOptionType<QueueDoesNotExist, __BaseException>);
|
|
853
|
-
}
|
|
854
1104
|
/**
|
|
855
1105
|
* @public
|
|
856
1106
|
* <p></p>
|
|
@@ -866,8 +1116,9 @@ export interface ListDeadLetterSourceQueuesRequest {
|
|
|
866
1116
|
*/
|
|
867
1117
|
NextToken?: string;
|
|
868
1118
|
/**
|
|
869
|
-
* <p>Maximum number of results to include in the response. Value range is 1 to 1000.
|
|
870
|
-
*
|
|
1119
|
+
* <p>Maximum number of results to include in the response. Value range is 1 to 1000. You
|
|
1120
|
+
* must set <code>MaxResults</code> to receive a value for <code>NextToken</code> in the
|
|
1121
|
+
* response.</p>
|
|
871
1122
|
*/
|
|
872
1123
|
MaxResults?: number;
|
|
873
1124
|
}
|
|
@@ -877,12 +1128,14 @@ export interface ListDeadLetterSourceQueuesRequest {
|
|
|
877
1128
|
*/
|
|
878
1129
|
export interface ListDeadLetterSourceQueuesResult {
|
|
879
1130
|
/**
|
|
880
|
-
* <p>A list of source queue URLs that have the <code>RedrivePolicy</code> queue attribute
|
|
1131
|
+
* <p>A list of source queue URLs that have the <code>RedrivePolicy</code> queue attribute
|
|
1132
|
+
* configured with a dead-letter queue.</p>
|
|
881
1133
|
*/
|
|
882
1134
|
queueUrls: string[] | undefined;
|
|
883
1135
|
/**
|
|
884
|
-
* <p>Pagination token to include in the next request. Token value is <code>null</code> if
|
|
885
|
-
*
|
|
1136
|
+
* <p>Pagination token to include in the next request. Token value is <code>null</code> if
|
|
1137
|
+
* there are no additional results to request, or if you did not set
|
|
1138
|
+
* <code>MaxResults</code> in the request.</p>
|
|
886
1139
|
*/
|
|
887
1140
|
NextToken?: string;
|
|
888
1141
|
}
|
|
@@ -892,7 +1145,8 @@ export interface ListDeadLetterSourceQueuesResult {
|
|
|
892
1145
|
*/
|
|
893
1146
|
export interface ListQueuesRequest {
|
|
894
1147
|
/**
|
|
895
|
-
* <p>A string to use for filtering the list results. Only those queues whose name begins
|
|
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>
|
|
896
1150
|
* <p>Queue URLs and names are case-sensitive.</p>
|
|
897
1151
|
*/
|
|
898
1152
|
QueueNamePrefix?: string;
|
|
@@ -901,8 +1155,9 @@ export interface ListQueuesRequest {
|
|
|
901
1155
|
*/
|
|
902
1156
|
NextToken?: string;
|
|
903
1157
|
/**
|
|
904
|
-
* <p>Maximum number of results to include in the response. Value range is 1 to 1000.
|
|
905
|
-
*
|
|
1158
|
+
* <p>Maximum number of results to include in the response. Value range is 1 to 1000. You
|
|
1159
|
+
* must set <code>MaxResults</code> to receive a value for <code>NextToken</code> in the
|
|
1160
|
+
* response.</p>
|
|
906
1161
|
*/
|
|
907
1162
|
MaxResults?: number;
|
|
908
1163
|
}
|
|
@@ -912,14 +1167,16 @@ export interface ListQueuesRequest {
|
|
|
912
1167
|
*/
|
|
913
1168
|
export interface ListQueuesResult {
|
|
914
1169
|
/**
|
|
915
|
-
* <p>
|
|
916
|
-
*
|
|
1170
|
+
* <p>A list of queue URLs, up to 1,000 entries, or the value of MaxResults that you sent in
|
|
1171
|
+
* the request.</p>
|
|
917
1172
|
*/
|
|
918
|
-
|
|
1173
|
+
QueueUrls?: string[];
|
|
919
1174
|
/**
|
|
920
|
-
* <p>
|
|
1175
|
+
* <p>Pagination token to include in the next request. Token value is <code>null</code> if
|
|
1176
|
+
* there are no additional results to request, or if you did not set
|
|
1177
|
+
* <code>MaxResults</code> in the request.</p>
|
|
921
1178
|
*/
|
|
922
|
-
|
|
1179
|
+
NextToken?: string;
|
|
923
1180
|
}
|
|
924
1181
|
/**
|
|
925
1182
|
* @public
|
|
@@ -941,7 +1198,9 @@ export interface ListQueueTagsResult {
|
|
|
941
1198
|
}
|
|
942
1199
|
/**
|
|
943
1200
|
* @public
|
|
944
|
-
* <p>Indicates that the specified queue previously received a <code>PurgeQueue</code>
|
|
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>
|
|
945
1204
|
*/
|
|
946
1205
|
export declare class PurgeQueueInProgress extends __BaseException {
|
|
947
1206
|
readonly name: "PurgeQueueInProgress";
|
|
@@ -957,11 +1216,109 @@ export declare class PurgeQueueInProgress extends __BaseException {
|
|
|
957
1216
|
*/
|
|
958
1217
|
export interface PurgeQueueRequest {
|
|
959
1218
|
/**
|
|
960
|
-
* <p>The URL of the queue from which the <code>PurgeQueue</code> action deletes
|
|
1219
|
+
* <p>The URL of the queue from which the <code>PurgeQueue</code> action deletes
|
|
1220
|
+
* messages.</p>
|
|
961
1221
|
* <p>Queue URLs and names are case-sensitive.</p>
|
|
962
1222
|
*/
|
|
963
1223
|
QueueUrl: string | undefined;
|
|
964
1224
|
}
|
|
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
|
+
}
|
|
965
1322
|
/**
|
|
966
1323
|
* @public
|
|
967
1324
|
* <p></p>
|
|
@@ -973,8 +1330,8 @@ export interface ReceiveMessageRequest {
|
|
|
973
1330
|
*/
|
|
974
1331
|
QueueUrl: string | undefined;
|
|
975
1332
|
/**
|
|
976
|
-
* <p>A list of attributes that need to be returned along with each message. These
|
|
977
|
-
* include:</p>
|
|
1333
|
+
* <p>A list of attributes that need to be returned along with each message. These
|
|
1334
|
+
* attributes include:</p>
|
|
978
1335
|
* <ul>
|
|
979
1336
|
* <li>
|
|
980
1337
|
* <p>
|
|
@@ -982,16 +1339,19 @@ export interface ReceiveMessageRequest {
|
|
|
982
1339
|
* </li>
|
|
983
1340
|
* <li>
|
|
984
1341
|
* <p>
|
|
985
|
-
* <code>ApproximateFirstReceiveTimestamp</code> – Returns the time the
|
|
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>
|
|
986
1345
|
* </li>
|
|
987
1346
|
* <li>
|
|
988
1347
|
* <p>
|
|
989
|
-
* <code>ApproximateReceiveCount</code> – Returns the number of times a
|
|
1348
|
+
* <code>ApproximateReceiveCount</code> – Returns the number of times a
|
|
1349
|
+
* message has been received across all queues but not deleted.</p>
|
|
990
1350
|
* </li>
|
|
991
1351
|
* <li>
|
|
992
1352
|
* <p>
|
|
993
|
-
* <code>AWSTraceHeader</code> – Returns the X-Ray trace
|
|
994
|
-
*
|
|
1353
|
+
* <code>AWSTraceHeader</code> – Returns the X-Ray trace
|
|
1354
|
+
* header string. </p>
|
|
995
1355
|
* </li>
|
|
996
1356
|
* <li>
|
|
997
1357
|
* <p>
|
|
@@ -999,20 +1359,26 @@ export interface ReceiveMessageRequest {
|
|
|
999
1359
|
* </p>
|
|
1000
1360
|
* <ul>
|
|
1001
1361
|
* <li>
|
|
1002
|
-
*
|
|
1003
|
-
*
|
|
1362
|
+
* <p>For a user, returns the user ID, for example
|
|
1363
|
+
* <code>ABCDEFGHI1JKLMNOPQ23R</code>.</p>
|
|
1364
|
+
* </li>
|
|
1004
1365
|
* <li>
|
|
1005
|
-
*
|
|
1006
|
-
*
|
|
1366
|
+
* <p>For an IAM role, returns the IAM role ID, for example
|
|
1367
|
+
* <code>ABCDE1F2GH3I4JK5LMNOP:i-a123b456</code>.</p>
|
|
1368
|
+
* </li>
|
|
1007
1369
|
* </ul>
|
|
1008
1370
|
* </li>
|
|
1009
1371
|
* <li>
|
|
1010
1372
|
* <p>
|
|
1011
|
-
* <code>SentTimestamp</code> – Returns the time the message was sent to the
|
|
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>
|
|
1012
1376
|
* </li>
|
|
1013
1377
|
* <li>
|
|
1014
|
-
*
|
|
1015
|
-
* <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption
|
|
1378
|
+
* <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>
|
|
1016
1382
|
* </li>
|
|
1017
1383
|
* <li>
|
|
1018
1384
|
* <p>
|
|
@@ -1024,15 +1390,17 @@ export interface ReceiveMessageRequest {
|
|
|
1024
1390
|
* </li>
|
|
1025
1391
|
* <li>
|
|
1026
1392
|
* <p>
|
|
1027
|
-
* <code>MessageGroupId</code> – Returns the value provided by the
|
|
1028
|
-
* calls the <code>
|
|
1393
|
+
* <code>MessageGroupId</code> – Returns the value provided by the
|
|
1394
|
+
* producer that calls the <code>
|
|
1029
1395
|
* <a>SendMessage</a>
|
|
1030
|
-
* </code> action.
|
|
1031
|
-
* same <code>MessageGroupId</code> are returned in
|
|
1396
|
+
* </code> action.
|
|
1397
|
+
* Messages with the same <code>MessageGroupId</code> are returned in
|
|
1398
|
+
* sequence.</p>
|
|
1032
1399
|
* </li>
|
|
1033
1400
|
* <li>
|
|
1034
1401
|
* <p>
|
|
1035
|
-
* <code>SequenceNumber</code> – Returns the value provided by
|
|
1402
|
+
* <code>SequenceNumber</code> – Returns the value provided by
|
|
1403
|
+
* Amazon SQS.</p>
|
|
1036
1404
|
* </li>
|
|
1037
1405
|
* </ul>
|
|
1038
1406
|
*/
|
|
@@ -1041,112 +1409,163 @@ export interface ReceiveMessageRequest {
|
|
|
1041
1409
|
* <p>The name of the message attribute, where <i>N</i> is the index.</p>
|
|
1042
1410
|
* <ul>
|
|
1043
1411
|
* <li>
|
|
1044
|
-
* <p>The name can contain alphanumeric characters and the underscore
|
|
1412
|
+
* <p>The name can contain alphanumeric characters and the underscore
|
|
1413
|
+
* (<code>_</code>), hyphen (<code>-</code>), and period
|
|
1414
|
+
* (<code>.</code>).</p>
|
|
1045
1415
|
* </li>
|
|
1046
1416
|
* <li>
|
|
1047
|
-
* <p>The name is case-sensitive and must be unique among all attribute names for
|
|
1417
|
+
* <p>The name is case-sensitive and must be unique among all attribute names for
|
|
1418
|
+
* the message.</p>
|
|
1048
1419
|
* </li>
|
|
1049
1420
|
* <li>
|
|
1050
|
-
* <p>The name must not start with AWS-reserved prefixes such as <code>AWS.</code>
|
|
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>
|
|
1051
1423
|
* </li>
|
|
1052
1424
|
* <li>
|
|
1053
|
-
* <p>The name must not start or end with a period (<code>.</code>), and it should
|
|
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>
|
|
1054
1427
|
* </li>
|
|
1055
1428
|
* <li>
|
|
1056
1429
|
* <p>The name can be up to 256 characters long.</p>
|
|
1057
1430
|
* </li>
|
|
1058
1431
|
* </ul>
|
|
1059
|
-
*
|
|
1060
|
-
*
|
|
1061
|
-
*
|
|
1432
|
+
* <p>When using <code>ReceiveMessage</code>, you can send a list of attribute names to
|
|
1433
|
+
* receive, or you can return all of the attributes by specifying <code>All</code> or
|
|
1434
|
+
* <code>.*</code> in your request. You can also use all message attributes starting
|
|
1435
|
+
* with a prefix, for example <code>bar.*</code>.</p>
|
|
1062
1436
|
*/
|
|
1063
1437
|
MessageAttributeNames?: string[];
|
|
1064
1438
|
/**
|
|
1065
|
-
* <p>The maximum number of messages to return. Amazon SQS never returns more messages than this
|
|
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>
|
|
1066
1442
|
*/
|
|
1067
1443
|
MaxNumberOfMessages?: number;
|
|
1068
1444
|
/**
|
|
1069
|
-
* <p>The duration (in seconds) that the received messages are hidden from subsequent
|
|
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>
|
|
1070
1447
|
*/
|
|
1071
1448
|
VisibilityTimeout?: number;
|
|
1072
1449
|
/**
|
|
1073
|
-
* <p>The duration (in seconds) for which the call waits for a message to arrive in the
|
|
1074
|
-
*
|
|
1450
|
+
* <p>The duration (in seconds) for which the call waits for a message to arrive in the
|
|
1451
|
+
* queue before returning. If a message is available, the call returns sooner than
|
|
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>
|
|
1075
1454
|
* <important>
|
|
1076
|
-
* <p>To avoid HTTP errors, ensure that the HTTP response timeout for
|
|
1077
|
-
*
|
|
1078
|
-
*
|
|
1455
|
+
* <p>To avoid HTTP errors, ensure that the HTTP response timeout for
|
|
1456
|
+
* <code>ReceiveMessage</code> requests is longer than the
|
|
1457
|
+
* <code>WaitTimeSeconds</code> parameter. For example, with the Java SDK, you can
|
|
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>
|
|
1079
1459
|
* </important>
|
|
1080
1460
|
*/
|
|
1081
1461
|
WaitTimeSeconds?: number;
|
|
1082
1462
|
/**
|
|
1083
1463
|
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
|
|
1084
|
-
* <p>The token used for deduplication of <code>ReceiveMessage</code> calls. If a networking
|
|
1085
|
-
*
|
|
1464
|
+
* <p>The token used for deduplication of <code>ReceiveMessage</code> calls. If a networking
|
|
1465
|
+
* issue occurs after a <code>ReceiveMessage</code> action, and instead of a response you
|
|
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>
|
|
1086
1469
|
* <ul>
|
|
1087
1470
|
* <li>
|
|
1088
|
-
* <p>You can use <code>ReceiveRequestAttemptId</code> only for 5 minutes after a
|
|
1471
|
+
* <p>You can use <code>ReceiveRequestAttemptId</code> only for 5 minutes after a
|
|
1472
|
+
* <code>ReceiveMessage</code> action.</p>
|
|
1089
1473
|
* </li>
|
|
1090
1474
|
* <li>
|
|
1091
|
-
* <p>When you set <code>FifoQueue</code>, a caller of the
|
|
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>
|
|
1092
1478
|
* </li>
|
|
1093
1479
|
* <li>
|
|
1094
|
-
* <p>If a caller of the <code>ReceiveMessage</code> action doesn't provide a
|
|
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>
|
|
1095
1483
|
* </li>
|
|
1096
1484
|
* <li>
|
|
1097
|
-
* <p>It is possible to retry the <code>ReceiveMessage</code> action with the same
|
|
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>
|
|
1098
1488
|
* </li>
|
|
1099
1489
|
* <li>
|
|
1100
|
-
* <p>During a visibility timeout, subsequent calls with the same
|
|
1101
|
-
*
|
|
1102
|
-
*
|
|
1103
|
-
*
|
|
1104
|
-
*
|
|
1490
|
+
* <p>During a visibility timeout, subsequent calls with the same
|
|
1491
|
+
* <code>ReceiveRequestAttemptId</code> return the same messages and receipt
|
|
1492
|
+
* handles. If a retry occurs within the deduplication interval, it resets the
|
|
1493
|
+
* visibility timeout. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility Timeout</a> in the <i>Amazon SQS Developer
|
|
1494
|
+
* Guide</i>.</p>
|
|
1495
|
+
* <important>
|
|
1105
1496
|
* <p>If a caller of the <code>ReceiveMessage</code> action still processes
|
|
1106
1497
|
* messages when the visibility timeout expires and messages become visible,
|
|
1107
1498
|
* another worker consuming from the same queue can receive the same messages
|
|
1108
1499
|
* and therefore process duplicates. Also, if a consumer whose message
|
|
1109
1500
|
* processing time is longer than the visibility timeout tries to delete the
|
|
1110
1501
|
* processed messages, the action fails with an error.</p>
|
|
1111
|
-
* <p>To mitigate this effect, ensure that your application observes a safe
|
|
1112
|
-
*
|
|
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>
|
|
1505
|
+
* </important>
|
|
1113
1506
|
* </li>
|
|
1114
1507
|
* <li>
|
|
1115
|
-
* <p>While messages with a particular <code>MessageGroupId</code> are invisible, no
|
|
1116
|
-
*
|
|
1508
|
+
* <p>While messages with a particular <code>MessageGroupId</code> are invisible, no
|
|
1509
|
+
* more messages belonging to the same <code>MessageGroupId</code> are returned
|
|
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>
|
|
1117
1512
|
* </li>
|
|
1118
1513
|
* <li>
|
|
1119
|
-
* <p>If a caller of <code>ReceiveMessage</code> can't track the
|
|
1120
|
-
*
|
|
1514
|
+
* <p>If a caller of <code>ReceiveMessage</code> can't track the
|
|
1515
|
+
* <code>ReceiveRequestAttemptId</code>, no retries work until the original
|
|
1516
|
+
* visibility timeout expires. As a result, delays might occur but the messages in
|
|
1517
|
+
* the queue remain in a strict order.</p>
|
|
1121
1518
|
* </li>
|
|
1122
1519
|
* </ul>
|
|
1123
|
-
* <p>The maximum length of <code>ReceiveRequestAttemptId</code> is 128 characters.
|
|
1124
|
-
*
|
|
1125
|
-
*
|
|
1126
|
-
*
|
|
1127
|
-
*
|
|
1520
|
+
* <p>The maximum length of <code>ReceiveRequestAttemptId</code> is 128 characters.
|
|
1521
|
+
* <code>ReceiveRequestAttemptId</code> can contain alphanumeric characters
|
|
1522
|
+
* (<code>a-z</code>, <code>A-Z</code>, <code>0-9</code>) and punctuation
|
|
1523
|
+
* (<code>!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~</code>).</p>
|
|
1524
|
+
* <p>For best practices of using <code>ReceiveRequestAttemptId</code>, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-receiverequestattemptid-request-parameter.html">Using the ReceiveRequestAttemptId Request Parameter</a> in the <i>Amazon SQS
|
|
1525
|
+
* Developer Guide</i>.</p>
|
|
1128
1526
|
*/
|
|
1129
1527
|
ReceiveRequestAttemptId?: string;
|
|
1130
1528
|
}
|
|
1529
|
+
/**
|
|
1530
|
+
* @public
|
|
1531
|
+
* @enum
|
|
1532
|
+
*/
|
|
1533
|
+
export declare const MessageSystemAttributeName: {
|
|
1534
|
+
readonly AWSTraceHeader: "AWSTraceHeader";
|
|
1535
|
+
readonly ApproximateFirstReceiveTimestamp: "ApproximateFirstReceiveTimestamp";
|
|
1536
|
+
readonly ApproximateReceiveCount: "ApproximateReceiveCount";
|
|
1537
|
+
readonly MessageDeduplicationId: "MessageDeduplicationId";
|
|
1538
|
+
readonly MessageGroupId: "MessageGroupId";
|
|
1539
|
+
readonly SenderId: "SenderId";
|
|
1540
|
+
readonly SentTimestamp: "SentTimestamp";
|
|
1541
|
+
readonly SequenceNumber: "SequenceNumber";
|
|
1542
|
+
};
|
|
1131
1543
|
/**
|
|
1132
1544
|
* @public
|
|
1133
1545
|
*/
|
|
1134
|
-
export type MessageSystemAttributeName =
|
|
1546
|
+
export type MessageSystemAttributeName = (typeof MessageSystemAttributeName)[keyof typeof MessageSystemAttributeName];
|
|
1135
1547
|
/**
|
|
1136
1548
|
* @public
|
|
1137
|
-
* <p>The user-specified message attribute value. For string data types, the
|
|
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>
|
|
1138
1552
|
* <a>SendMessage</a>.</code>
|
|
1139
1553
|
* </p>
|
|
1140
1554
|
* <p>
|
|
1141
|
-
* <code>Name</code>, <code>type</code>, <code>value</code> and the message body must not
|
|
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>
|
|
1142
1559
|
*/
|
|
1143
1560
|
export interface MessageAttributeValue {
|
|
1144
1561
|
/**
|
|
1145
|
-
* <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
|
|
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>
|
|
1146
1564
|
*/
|
|
1147
1565
|
StringValue?: string;
|
|
1148
1566
|
/**
|
|
1149
|
-
* <p>Binary type attributes can store any binary data, such as compressed data, encrypted
|
|
1567
|
+
* <p>Binary type attributes can store any binary data, such as compressed data, encrypted
|
|
1568
|
+
* data, or images.</p>
|
|
1150
1569
|
*/
|
|
1151
1570
|
BinaryValue?: Uint8Array;
|
|
1152
1571
|
/**
|
|
@@ -1158,8 +1577,11 @@ export interface MessageAttributeValue {
|
|
|
1158
1577
|
*/
|
|
1159
1578
|
BinaryListValues?: Uint8Array[];
|
|
1160
1579
|
/**
|
|
1161
|
-
* <p>Amazon SQS supports the following logical data types: <code>String</code>,
|
|
1162
|
-
*
|
|
1580
|
+
* <p>Amazon SQS supports the following logical data types: <code>String</code>,
|
|
1581
|
+
* <code>Number</code>, and <code>Binary</code>. For the <code>Number</code> data type,
|
|
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>
|
|
1163
1585
|
*/
|
|
1164
1586
|
DataType: string | undefined;
|
|
1165
1587
|
}
|
|
@@ -1169,11 +1591,14 @@ export interface MessageAttributeValue {
|
|
|
1169
1591
|
*/
|
|
1170
1592
|
export interface Message {
|
|
1171
1593
|
/**
|
|
1172
|
-
* <p>A unique identifier for the message. A <code>MessageId</code>is considered unique
|
|
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>
|
|
1173
1596
|
*/
|
|
1174
1597
|
MessageId?: string;
|
|
1175
1598
|
/**
|
|
1176
|
-
* <p>An identifier associated with the act of receiving the message. A new receipt handle
|
|
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>
|
|
1177
1602
|
*/
|
|
1178
1603
|
ReceiptHandle?: string;
|
|
1179
1604
|
/**
|
|
@@ -1187,8 +1612,8 @@ export interface Message {
|
|
|
1187
1612
|
/**
|
|
1188
1613
|
* <p>A map of the attributes requested in <code>
|
|
1189
1614
|
* <a>ReceiveMessage</a>
|
|
1190
|
-
* </code> to
|
|
1191
|
-
*
|
|
1615
|
+
* </code> to
|
|
1616
|
+
* their respective values. Supported attributes:</p>
|
|
1192
1617
|
* <ul>
|
|
1193
1618
|
* <li>
|
|
1194
1619
|
* <p>
|
|
@@ -1227,8 +1652,9 @@ export interface Message {
|
|
|
1227
1652
|
* </li>
|
|
1228
1653
|
* </ul>
|
|
1229
1654
|
* <p>
|
|
1230
|
-
* <code>ApproximateFirstReceiveTimestamp</code> and <code>SentTimestamp</code> are each
|
|
1231
|
-
*
|
|
1655
|
+
* <code>ApproximateFirstReceiveTimestamp</code> and <code>SentTimestamp</code> are each
|
|
1656
|
+
* returned as an integer representing the <a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a> in
|
|
1657
|
+
* milliseconds.</p>
|
|
1232
1658
|
*/
|
|
1233
1659
|
Attributes?: Record<string, string>;
|
|
1234
1660
|
/**
|
|
@@ -1264,7 +1690,8 @@ export interface RemovePermissionRequest {
|
|
|
1264
1690
|
*/
|
|
1265
1691
|
QueueUrl: string | undefined;
|
|
1266
1692
|
/**
|
|
1267
|
-
* <p>The identification of the permission to remove. This is the label added using the
|
|
1693
|
+
* <p>The identification of the permission to remove. This is the label added using the
|
|
1694
|
+
* <code>
|
|
1268
1695
|
* <a>AddPermission</a>
|
|
1269
1696
|
* </code> action.</p>
|
|
1270
1697
|
*/
|
|
@@ -1284,23 +1711,35 @@ export declare class InvalidMessageContents extends __BaseException {
|
|
|
1284
1711
|
}
|
|
1285
1712
|
/**
|
|
1286
1713
|
* @public
|
|
1714
|
+
* @enum
|
|
1287
1715
|
*/
|
|
1288
|
-
export
|
|
1716
|
+
export declare const MessageSystemAttributeNameForSends: {
|
|
1717
|
+
readonly AWSTraceHeader: "AWSTraceHeader";
|
|
1718
|
+
};
|
|
1289
1719
|
/**
|
|
1290
1720
|
* @public
|
|
1291
|
-
|
|
1721
|
+
*/
|
|
1722
|
+
export type MessageSystemAttributeNameForSends = (typeof MessageSystemAttributeNameForSends)[keyof typeof MessageSystemAttributeNameForSends];
|
|
1723
|
+
/**
|
|
1724
|
+
* @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>
|
|
1292
1728
|
* <a>SendMessage</a>.</code>
|
|
1293
1729
|
* </p>
|
|
1294
1730
|
* <p>
|
|
1295
|
-
* <code>Name</code>, <code>type</code>, <code>value</code> and the message body must not
|
|
1731
|
+
* <code>Name</code>, <code>type</code>, <code>value</code> and the message body must not
|
|
1732
|
+
* be empty or null.</p>
|
|
1296
1733
|
*/
|
|
1297
1734
|
export interface MessageSystemAttributeValue {
|
|
1298
1735
|
/**
|
|
1299
|
-
* <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
|
|
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>
|
|
1300
1738
|
*/
|
|
1301
1739
|
StringValue?: string;
|
|
1302
1740
|
/**
|
|
1303
|
-
* <p>Binary type attributes can store any binary data, such as compressed data, encrypted
|
|
1741
|
+
* <p>Binary type attributes can store any binary data, such as compressed data, encrypted
|
|
1742
|
+
* data, or images.</p>
|
|
1304
1743
|
*/
|
|
1305
1744
|
BinaryValue?: Uint8Array;
|
|
1306
1745
|
/**
|
|
@@ -1312,8 +1751,11 @@ export interface MessageSystemAttributeValue {
|
|
|
1312
1751
|
*/
|
|
1313
1752
|
BinaryListValues?: Uint8Array[];
|
|
1314
1753
|
/**
|
|
1315
|
-
* <p>Amazon SQS supports the following logical data types: <code>String</code>,
|
|
1316
|
-
*
|
|
1754
|
+
* <p>Amazon SQS supports the following logical data types: <code>String</code>,
|
|
1755
|
+
* <code>Number</code>, and <code>Binary</code>. For the <code>Number</code> data type,
|
|
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>
|
|
1317
1759
|
*/
|
|
1318
1760
|
DataType: string | undefined;
|
|
1319
1761
|
}
|
|
@@ -1328,21 +1770,22 @@ export interface SendMessageRequest {
|
|
|
1328
1770
|
*/
|
|
1329
1771
|
QueueUrl: string | undefined;
|
|
1330
1772
|
/**
|
|
1331
|
-
* <p>The message to send. The minimum size is one character. The maximum size is 256
|
|
1773
|
+
* <p>The message to send. The minimum size is one character. The maximum size is 256
|
|
1774
|
+
* KiB.</p>
|
|
1332
1775
|
* <important>
|
|
1333
|
-
*
|
|
1334
|
-
*
|
|
1776
|
+
* <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:</p>
|
|
1777
|
+
* <p>
|
|
1335
1778
|
* <code>#x9</code> | <code>#xA</code> | <code>#xD</code> | <code>#x20</code> to <code>#xD7FF</code> | <code>#xE000</code> to <code>#xFFFD</code> | <code>#x10000</code> to <code>#x10FFFF</code>
|
|
1336
1779
|
* </p>
|
|
1337
|
-
*
|
|
1780
|
+
* <p>Any characters not included in this list will be rejected. For more information, see the <a href="http://www.w3.org/TR/REC-xml/#charsets">W3C specification for characters</a>.</p>
|
|
1338
1781
|
* </important>
|
|
1339
1782
|
*/
|
|
1340
1783
|
MessageBody: string | undefined;
|
|
1341
1784
|
/**
|
|
1342
|
-
* <p>
|
|
1343
|
-
*
|
|
1344
|
-
*
|
|
1345
|
-
*
|
|
1785
|
+
* <p> The length of time, in seconds, for which to delay a specific message. Valid values:
|
|
1786
|
+
* 0 to 900. Maximum: 15 minutes. Messages with a positive <code>DelaySeconds</code> value
|
|
1787
|
+
* become available for processing after the delay period is finished. If you don't specify
|
|
1788
|
+
* a value, the default value for the queue applies. </p>
|
|
1346
1789
|
* <note>
|
|
1347
1790
|
* <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>
|
|
1348
1791
|
* </note>
|
|
@@ -1363,62 +1806,75 @@ export interface SendMessageRequest {
|
|
|
1363
1806
|
* <p>Currently, the only supported message system attribute is <code>AWSTraceHeader</code>.
|
|
1364
1807
|
* Its type must be <code>String</code> and its value must be a correctly formatted
|
|
1365
1808
|
* X-Ray trace header string.</p>
|
|
1366
|
-
*
|
|
1809
|
+
* </li>
|
|
1367
1810
|
* <li>
|
|
1368
1811
|
* <p>The size of a message system attribute doesn't count towards the total size of a message.</p>
|
|
1369
|
-
*
|
|
1812
|
+
* </li>
|
|
1370
1813
|
* </ul>
|
|
1371
1814
|
* </important>
|
|
1372
1815
|
*/
|
|
1373
1816
|
MessageSystemAttributes?: Record<string, MessageSystemAttributeValue>;
|
|
1374
1817
|
/**
|
|
1375
1818
|
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
|
|
1376
|
-
* <p>The token used for deduplication of sent messages. If a message with a particular
|
|
1377
|
-
*
|
|
1378
|
-
*
|
|
1819
|
+
* <p>The token used for deduplication of sent messages. If a message with a particular
|
|
1820
|
+
* <code>MessageDeduplicationId</code> is sent successfully, any messages sent with the
|
|
1821
|
+
* same <code>MessageDeduplicationId</code> are accepted successfully but aren't delivered
|
|
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>
|
|
1379
1824
|
* <ul>
|
|
1380
1825
|
* <li>
|
|
1381
|
-
*
|
|
1382
|
-
*
|
|
1826
|
+
* <p>Every message must have a unique <code>MessageDeduplicationId</code>,</p>
|
|
1827
|
+
* <ul>
|
|
1383
1828
|
* <li>
|
|
1384
|
-
*
|
|
1829
|
+
* <p>You may provide a <code>MessageDeduplicationId</code>
|
|
1830
|
+
* explicitly.</p>
|
|
1385
1831
|
* </li>
|
|
1386
1832
|
* <li>
|
|
1387
|
-
*
|
|
1388
|
-
*
|
|
1389
|
-
*
|
|
1833
|
+
* <p>If you aren't able to provide a <code>MessageDeduplicationId</code>
|
|
1834
|
+
* and you enable <code>ContentBasedDeduplication</code> for your queue,
|
|
1835
|
+
* Amazon SQS uses a SHA-256 hash to generate the
|
|
1836
|
+
* <code>MessageDeduplicationId</code> using the body of the message
|
|
1837
|
+
* (but not the attributes of the message). </p>
|
|
1390
1838
|
* </li>
|
|
1391
1839
|
* <li>
|
|
1392
|
-
*
|
|
1393
|
-
*
|
|
1840
|
+
* <p>If you don't provide a <code>MessageDeduplicationId</code> and the
|
|
1841
|
+
* queue doesn't have <code>ContentBasedDeduplication</code> set, the
|
|
1842
|
+
* action fails with an error.</p>
|
|
1394
1843
|
* </li>
|
|
1395
1844
|
* <li>
|
|
1396
|
-
*
|
|
1845
|
+
* <p>If the queue has <code>ContentBasedDeduplication</code> set, your
|
|
1846
|
+
* <code>MessageDeduplicationId</code> overrides the generated
|
|
1847
|
+
* one.</p>
|
|
1397
1848
|
* </li>
|
|
1398
1849
|
* </ul>
|
|
1399
1850
|
* </li>
|
|
1400
1851
|
* <li>
|
|
1401
|
-
*
|
|
1402
|
-
*
|
|
1852
|
+
* <p>When <code>ContentBasedDeduplication</code> is in effect, messages with
|
|
1853
|
+
* identical content sent within the deduplication interval are treated as
|
|
1854
|
+
* duplicates and only one copy of the message is delivered.</p>
|
|
1403
1855
|
* </li>
|
|
1404
1856
|
* <li>
|
|
1405
|
-
*
|
|
1406
|
-
*
|
|
1407
|
-
*
|
|
1857
|
+
* <p>If you send one message with <code>ContentBasedDeduplication</code> enabled
|
|
1858
|
+
* and then another message with a <code>MessageDeduplicationId</code> that is the
|
|
1859
|
+
* same as the one generated for the first <code>MessageDeduplicationId</code>, the
|
|
1860
|
+
* two messages are treated as duplicates and only one copy of the message is
|
|
1861
|
+
* delivered. </p>
|
|
1408
1862
|
* </li>
|
|
1409
1863
|
* </ul>
|
|
1410
1864
|
* <note>
|
|
1411
1865
|
* <p>The <code>MessageDeduplicationId</code> is available to the consumer of the
|
|
1412
1866
|
* message (this can be useful for troubleshooting delivery issues).</p>
|
|
1413
|
-
* <p>If a message is sent successfully but the acknowledgement is lost and the message
|
|
1414
|
-
*
|
|
1867
|
+
* <p>If a message is sent successfully but the acknowledgement is lost and the message
|
|
1868
|
+
* is resent with the same <code>MessageDeduplicationId</code> after the deduplication
|
|
1869
|
+
* interval, Amazon SQS can't detect duplicate messages.</p>
|
|
1415
1870
|
* <p>Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.</p>
|
|
1416
1871
|
* </note>
|
|
1417
|
-
* <p>The maximum length of <code>MessageDeduplicationId</code> is 128 characters.
|
|
1418
|
-
*
|
|
1419
|
-
*
|
|
1420
|
-
*
|
|
1421
|
-
*
|
|
1872
|
+
* <p>The maximum length of <code>MessageDeduplicationId</code> is 128 characters.
|
|
1873
|
+
* <code>MessageDeduplicationId</code> can contain alphanumeric characters
|
|
1874
|
+
* (<code>a-z</code>, <code>A-Z</code>, <code>0-9</code>) and punctuation
|
|
1875
|
+
* (<code>!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~</code>).</p>
|
|
1876
|
+
* <p>For best practices of using <code>MessageDeduplicationId</code>, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html">Using the MessageDeduplicationId Property</a> in the <i>Amazon SQS Developer
|
|
1877
|
+
* Guide</i>.</p>
|
|
1422
1878
|
*/
|
|
1423
1879
|
MessageDeduplicationId?: string;
|
|
1424
1880
|
/**
|
|
@@ -1432,21 +1888,26 @@ export interface SendMessageRequest {
|
|
|
1432
1888
|
* fashion.</p>
|
|
1433
1889
|
* <ul>
|
|
1434
1890
|
* <li>
|
|
1435
|
-
* <p>You must associate a non-empty <code>MessageGroupId</code> with a message. If
|
|
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>
|
|
1436
1893
|
* </li>
|
|
1437
1894
|
* <li>
|
|
1438
1895
|
* <p>
|
|
1439
|
-
* <code>ReceiveMessage</code> might return messages with multiple
|
|
1440
|
-
*
|
|
1896
|
+
* <code>ReceiveMessage</code> might return messages with multiple
|
|
1897
|
+
* <code>MessageGroupId</code> values. For each <code>MessageGroupId</code>,
|
|
1898
|
+
* the messages are sorted by time sent. The caller can't specify a
|
|
1899
|
+
* <code>MessageGroupId</code>.</p>
|
|
1441
1900
|
* </li>
|
|
1442
1901
|
* </ul>
|
|
1443
|
-
* <p>The length of <code>MessageGroupId</code> is 128 characters. Valid values:
|
|
1444
|
-
*
|
|
1445
|
-
*
|
|
1446
|
-
*
|
|
1902
|
+
* <p>The length of <code>MessageGroupId</code> is 128 characters. Valid values:
|
|
1903
|
+
* alphanumeric characters and punctuation
|
|
1904
|
+
* <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~)</code>.</p>
|
|
1905
|
+
* <p>For best practices of using <code>MessageGroupId</code>, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html">Using the MessageGroupId Property</a> in the <i>Amazon SQS Developer
|
|
1906
|
+
* Guide</i>.</p>
|
|
1447
1907
|
* <important>
|
|
1448
1908
|
* <p>
|
|
1449
|
-
* <code>MessageGroupId</code> is required for FIFO queues. You can't use it for
|
|
1909
|
+
* <code>MessageGroupId</code> is required for FIFO queues. You can't use it for
|
|
1910
|
+
* Standard queues.</p>
|
|
1450
1911
|
* </important>
|
|
1451
1912
|
*/
|
|
1452
1913
|
MessageGroupId?: string;
|
|
@@ -1470,30 +1931,19 @@ export interface SendMessageResult {
|
|
|
1470
1931
|
*/
|
|
1471
1932
|
MD5OfMessageSystemAttributes?: string;
|
|
1472
1933
|
/**
|
|
1473
|
-
* <p>An attribute containing the <code>MessageId</code> of the message sent to the queue.
|
|
1474
|
-
* in the <i>Amazon SQS Developer
|
|
1475
|
-
*
|
|
1934
|
+
* <p>An attribute containing the <code>MessageId</code> of the message sent to the queue.
|
|
1935
|
+
* For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html">Queue and Message Identifiers</a> in the <i>Amazon SQS Developer
|
|
1936
|
+
* Guide</i>. </p>
|
|
1476
1937
|
*/
|
|
1477
1938
|
MessageId?: string;
|
|
1478
1939
|
/**
|
|
1479
1940
|
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
|
|
1480
1941
|
* <p>The large, non-consecutive number that Amazon SQS assigns to each message.</p>
|
|
1481
|
-
* <p>The length of <code>SequenceNumber</code> is 128 bits. <code>SequenceNumber</code>
|
|
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>
|
|
1482
1944
|
*/
|
|
1483
1945
|
SequenceNumber?: string;
|
|
1484
1946
|
}
|
|
1485
|
-
/**
|
|
1486
|
-
* @public
|
|
1487
|
-
* <p>Error code 400. Unsupported operation.</p>
|
|
1488
|
-
*/
|
|
1489
|
-
export declare class UnsupportedOperation extends __BaseException {
|
|
1490
|
-
readonly name: "UnsupportedOperation";
|
|
1491
|
-
readonly $fault: "client";
|
|
1492
|
-
/**
|
|
1493
|
-
* @internal
|
|
1494
|
-
*/
|
|
1495
|
-
constructor(opts: __ExceptionOptionType<UnsupportedOperation, __BaseException>);
|
|
1496
|
-
}
|
|
1497
1947
|
/**
|
|
1498
1948
|
* @public
|
|
1499
1949
|
* <p>The length of all the messages put together is more than the limit.</p>
|
|
@@ -1524,9 +1974,10 @@ export interface SendMessageBatchRequestEntry {
|
|
|
1524
1974
|
*/
|
|
1525
1975
|
MessageBody: string | undefined;
|
|
1526
1976
|
/**
|
|
1527
|
-
* <p>The length of time, in seconds, for which a specific message is delayed. Valid values:
|
|
1528
|
-
*
|
|
1529
|
-
*
|
|
1977
|
+
* <p>The length of time, in seconds, for which a specific message is delayed. Valid values:
|
|
1978
|
+
* 0 to 900. Maximum: 15 minutes. Messages with a positive <code>DelaySeconds</code> value
|
|
1979
|
+
* become available for processing after the delay period is finished. If you don't specify
|
|
1980
|
+
* a value, the default value for the queue is applied. </p>
|
|
1530
1981
|
* <note>
|
|
1531
1982
|
* <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>
|
|
1532
1983
|
* </note>
|
|
@@ -1547,63 +1998,75 @@ export interface SendMessageBatchRequestEntry {
|
|
|
1547
1998
|
* <p>Currently, the only supported message system attribute is <code>AWSTraceHeader</code>.
|
|
1548
1999
|
* Its type must be <code>String</code> and its value must be a correctly formatted
|
|
1549
2000
|
* X-Ray trace header string.</p>
|
|
1550
|
-
*
|
|
2001
|
+
* </li>
|
|
1551
2002
|
* <li>
|
|
1552
2003
|
* <p>The size of a message system attribute doesn't count towards the total size of a message.</p>
|
|
1553
|
-
*
|
|
2004
|
+
* </li>
|
|
1554
2005
|
* </ul>
|
|
1555
2006
|
* </important>
|
|
1556
2007
|
*/
|
|
1557
2008
|
MessageSystemAttributes?: Record<string, MessageSystemAttributeValue>;
|
|
1558
2009
|
/**
|
|
1559
2010
|
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
|
|
1560
|
-
* <p>The token used for deduplication of messages within a 5-minute minimum deduplication
|
|
1561
|
-
*
|
|
1562
|
-
*
|
|
1563
|
-
*
|
|
2011
|
+
* <p>The token used for deduplication of messages within a 5-minute minimum deduplication
|
|
2012
|
+
* interval. If a message with a particular <code>MessageDeduplicationId</code> is sent
|
|
2013
|
+
* successfully, subsequent messages with the same <code>MessageDeduplicationId</code> are
|
|
2014
|
+
* accepted successfully but aren't delivered. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html"> Exactly-once processing</a> in the <i>Amazon SQS Developer
|
|
2015
|
+
* Guide</i>.</p>
|
|
1564
2016
|
* <ul>
|
|
1565
2017
|
* <li>
|
|
1566
|
-
*
|
|
1567
|
-
*
|
|
2018
|
+
* <p>Every message must have a unique <code>MessageDeduplicationId</code>,</p>
|
|
2019
|
+
* <ul>
|
|
1568
2020
|
* <li>
|
|
1569
|
-
*
|
|
2021
|
+
* <p>You may provide a <code>MessageDeduplicationId</code>
|
|
2022
|
+
* explicitly.</p>
|
|
1570
2023
|
* </li>
|
|
1571
2024
|
* <li>
|
|
1572
|
-
*
|
|
1573
|
-
*
|
|
1574
|
-
*
|
|
2025
|
+
* <p>If you aren't able to provide a <code>MessageDeduplicationId</code>
|
|
2026
|
+
* and you enable <code>ContentBasedDeduplication</code> for your queue,
|
|
2027
|
+
* Amazon SQS uses a SHA-256 hash to generate the
|
|
2028
|
+
* <code>MessageDeduplicationId</code> using the body of the message
|
|
2029
|
+
* (but not the attributes of the message). </p>
|
|
1575
2030
|
* </li>
|
|
1576
2031
|
* <li>
|
|
1577
|
-
*
|
|
1578
|
-
*
|
|
2032
|
+
* <p>If you don't provide a <code>MessageDeduplicationId</code> and the
|
|
2033
|
+
* queue doesn't have <code>ContentBasedDeduplication</code> set, the
|
|
2034
|
+
* action fails with an error.</p>
|
|
1579
2035
|
* </li>
|
|
1580
2036
|
* <li>
|
|
1581
|
-
*
|
|
2037
|
+
* <p>If the queue has <code>ContentBasedDeduplication</code> set, your
|
|
2038
|
+
* <code>MessageDeduplicationId</code> overrides the generated
|
|
2039
|
+
* one.</p>
|
|
1582
2040
|
* </li>
|
|
1583
2041
|
* </ul>
|
|
1584
2042
|
* </li>
|
|
1585
2043
|
* <li>
|
|
1586
|
-
*
|
|
1587
|
-
*
|
|
2044
|
+
* <p>When <code>ContentBasedDeduplication</code> is in effect, messages with
|
|
2045
|
+
* identical content sent within the deduplication interval are treated as
|
|
2046
|
+
* duplicates and only one copy of the message is delivered.</p>
|
|
1588
2047
|
* </li>
|
|
1589
2048
|
* <li>
|
|
1590
|
-
*
|
|
1591
|
-
*
|
|
1592
|
-
*
|
|
2049
|
+
* <p>If you send one message with <code>ContentBasedDeduplication</code> enabled
|
|
2050
|
+
* and then another message with a <code>MessageDeduplicationId</code> that is the
|
|
2051
|
+
* same as the one generated for the first <code>MessageDeduplicationId</code>, the
|
|
2052
|
+
* two messages are treated as duplicates and only one copy of the message is
|
|
2053
|
+
* delivered. </p>
|
|
1593
2054
|
* </li>
|
|
1594
2055
|
* </ul>
|
|
1595
2056
|
* <note>
|
|
1596
2057
|
* <p>The <code>MessageDeduplicationId</code> is available to the consumer of the
|
|
1597
2058
|
* message (this can be useful for troubleshooting delivery issues).</p>
|
|
1598
|
-
* <p>If a message is sent successfully but the acknowledgement is lost and the message
|
|
1599
|
-
*
|
|
2059
|
+
* <p>If a message is sent successfully but the acknowledgement is lost and the message
|
|
2060
|
+
* is resent with the same <code>MessageDeduplicationId</code> after the deduplication
|
|
2061
|
+
* interval, Amazon SQS can't detect duplicate messages.</p>
|
|
1600
2062
|
* <p>Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.</p>
|
|
1601
2063
|
* </note>
|
|
1602
|
-
* <p>The length of <code>MessageDeduplicationId</code> is 128 characters.
|
|
1603
|
-
*
|
|
1604
|
-
*
|
|
1605
|
-
*
|
|
1606
|
-
*
|
|
2064
|
+
* <p>The length of <code>MessageDeduplicationId</code> is 128 characters.
|
|
2065
|
+
* <code>MessageDeduplicationId</code> can contain alphanumeric characters
|
|
2066
|
+
* (<code>a-z</code>, <code>A-Z</code>, <code>0-9</code>) and punctuation
|
|
2067
|
+
* (<code>!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~</code>).</p>
|
|
2068
|
+
* <p>For best practices of using <code>MessageDeduplicationId</code>, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html">Using the MessageDeduplicationId Property</a> in the <i>Amazon SQS Developer
|
|
2069
|
+
* Guide</i>.</p>
|
|
1607
2070
|
*/
|
|
1608
2071
|
MessageDeduplicationId?: string;
|
|
1609
2072
|
/**
|
|
@@ -1617,21 +2080,26 @@ export interface SendMessageBatchRequestEntry {
|
|
|
1617
2080
|
* fashion.</p>
|
|
1618
2081
|
* <ul>
|
|
1619
2082
|
* <li>
|
|
1620
|
-
* <p>You must associate a non-empty <code>MessageGroupId</code> with a message. If
|
|
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>
|
|
1621
2085
|
* </li>
|
|
1622
2086
|
* <li>
|
|
1623
2087
|
* <p>
|
|
1624
|
-
* <code>ReceiveMessage</code> might return messages with multiple
|
|
1625
|
-
*
|
|
2088
|
+
* <code>ReceiveMessage</code> might return messages with multiple
|
|
2089
|
+
* <code>MessageGroupId</code> values. For each <code>MessageGroupId</code>,
|
|
2090
|
+
* the messages are sorted by time sent. The caller can't specify a
|
|
2091
|
+
* <code>MessageGroupId</code>.</p>
|
|
1626
2092
|
* </li>
|
|
1627
2093
|
* </ul>
|
|
1628
|
-
* <p>The length of <code>MessageGroupId</code> is 128 characters. Valid values:
|
|
1629
|
-
*
|
|
1630
|
-
*
|
|
1631
|
-
*
|
|
2094
|
+
* <p>The length of <code>MessageGroupId</code> is 128 characters. Valid values:
|
|
2095
|
+
* alphanumeric characters and punctuation
|
|
2096
|
+
* <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~)</code>.</p>
|
|
2097
|
+
* <p>For best practices of using <code>MessageGroupId</code>, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html">Using the MessageGroupId Property</a> in the <i>Amazon SQS Developer
|
|
2098
|
+
* Guide</i>.</p>
|
|
1632
2099
|
* <important>
|
|
1633
2100
|
* <p>
|
|
1634
|
-
* <code>MessageGroupId</code> is required for FIFO queues. You can't use it for
|
|
2101
|
+
* <code>MessageGroupId</code> is required for FIFO queues. You can't use it for
|
|
2102
|
+
* Standard queues.</p>
|
|
1635
2103
|
* </important>
|
|
1636
2104
|
*/
|
|
1637
2105
|
MessageGroupId?: string;
|
|
@@ -1684,7 +2152,8 @@ export interface SendMessageBatchResultEntry {
|
|
|
1684
2152
|
/**
|
|
1685
2153
|
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
|
|
1686
2154
|
* <p>The large, non-consecutive number that Amazon SQS assigns to each message.</p>
|
|
1687
|
-
* <p>The length of <code>SequenceNumber</code> is 128 bits. As <code>SequenceNumber</code>
|
|
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>
|
|
1688
2157
|
*/
|
|
1689
2158
|
SequenceNumber?: string;
|
|
1690
2159
|
}
|
|
@@ -1692,9 +2161,11 @@ export interface SendMessageBatchResultEntry {
|
|
|
1692
2161
|
* @public
|
|
1693
2162
|
* <p>For each message in the batch, the response contains a <code>
|
|
1694
2163
|
* <a>SendMessageBatchResultEntry</a>
|
|
1695
|
-
* </code> tag if the message succeeds or a
|
|
2164
|
+
* </code> tag if the message succeeds or a
|
|
2165
|
+
* <code>
|
|
1696
2166
|
* <a>BatchResultErrorEntry</a>
|
|
1697
|
-
* </code> tag if the message
|
|
2167
|
+
* </code> tag if the message
|
|
2168
|
+
* fails.</p>
|
|
1698
2169
|
*/
|
|
1699
2170
|
export interface SendMessageBatchResult {
|
|
1700
2171
|
/**
|
|
@@ -1706,7 +2177,8 @@ export interface SendMessageBatchResult {
|
|
|
1706
2177
|
/**
|
|
1707
2178
|
* <p>A list of <code>
|
|
1708
2179
|
* <a>BatchResultErrorEntry</a>
|
|
1709
|
-
* </code> items with error
|
|
2180
|
+
* </code> items with error
|
|
2181
|
+
* details about each message that can't be enqueued.</p>
|
|
1710
2182
|
*/
|
|
1711
2183
|
Failed: BatchResultErrorEntry[] | undefined;
|
|
1712
2184
|
}
|
|
@@ -1722,130 +2194,204 @@ export interface SetQueueAttributesRequest {
|
|
|
1722
2194
|
QueueUrl: string | undefined;
|
|
1723
2195
|
/**
|
|
1724
2196
|
* <p>A map of attributes to set.</p>
|
|
1725
|
-
* <p>The following lists the names, descriptions, and values of the special request
|
|
2197
|
+
* <p>The following lists the names, descriptions, and values of the special request
|
|
2198
|
+
* parameters that the <code>SetQueueAttributes</code> action uses:</p>
|
|
1726
2199
|
* <ul>
|
|
1727
2200
|
* <li>
|
|
1728
|
-
*
|
|
1729
|
-
* <code>DelaySeconds</code> – The length of time, in seconds, for which the
|
|
1730
|
-
*
|
|
2201
|
+
* <p>
|
|
2202
|
+
* <code>DelaySeconds</code> – The length of time, in seconds, for which the
|
|
2203
|
+
* delivery of all messages in the queue is delayed. Valid values: An integer from
|
|
2204
|
+
* 0 to 900 (15 minutes). Default: 0. </p>
|
|
1731
2205
|
* </li>
|
|
1732
2206
|
* <li>
|
|
1733
|
-
*
|
|
1734
|
-
* <code>MaximumMessageSize</code> – The limit of how many bytes a message
|
|
1735
|
-
*
|
|
2207
|
+
* <p>
|
|
2208
|
+
* <code>MaximumMessageSize</code> – The limit of how many bytes a message
|
|
2209
|
+
* can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes
|
|
2210
|
+
* (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). </p>
|
|
1736
2211
|
* </li>
|
|
1737
2212
|
* <li>
|
|
1738
|
-
*
|
|
1739
|
-
* <code>MessageRetentionPeriod</code> – The length of time, in seconds, for
|
|
1740
|
-
*
|
|
2213
|
+
* <p>
|
|
2214
|
+
* <code>MessageRetentionPeriod</code> – The length of time, in seconds, for
|
|
2215
|
+
* which Amazon SQS retains a message. Valid values: An integer representing seconds,
|
|
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>
|
|
1741
2223
|
* </li>
|
|
1742
2224
|
* <li>
|
|
1743
|
-
*
|
|
1744
|
-
* <code>Policy</code> – The queue's policy. A valid Amazon Web Services policy. For more
|
|
1745
|
-
*
|
|
1746
|
-
*
|
|
2225
|
+
* <p>
|
|
2226
|
+
* <code>Policy</code> – The queue's policy. A valid Amazon Web Services policy. For more
|
|
2227
|
+
* information about policy structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview of Amazon Web Services IAM
|
|
2228
|
+
* Policies</a> in the <i>Identity and Access Management User
|
|
2229
|
+
* Guide</i>. </p>
|
|
1747
2230
|
* </li>
|
|
1748
2231
|
* <li>
|
|
1749
|
-
*
|
|
1750
|
-
* <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in
|
|
2232
|
+
* <p>
|
|
2233
|
+
* <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in
|
|
2234
|
+
* seconds, for which a <code>
|
|
1751
2235
|
* <a>ReceiveMessage</a>
|
|
1752
|
-
* </code> action waits
|
|
1753
|
-
*
|
|
2236
|
+
* </code> action waits
|
|
2237
|
+
* for a message to arrive. Valid values: An integer from 0 to 20 (seconds).
|
|
2238
|
+
* Default: 0. </p>
|
|
1754
2239
|
* </li>
|
|
1755
2240
|
* <li>
|
|
1756
|
-
*
|
|
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>
|
|
2246
|
+
* </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
|
+
* <li>
|
|
2252
|
+
* <p>
|
|
1757
2253
|
* <code>RedrivePolicy</code> – The string that includes the parameters for the dead-letter queue functionality
|
|
1758
|
-
*
|
|
1759
|
-
*
|
|
1760
|
-
* <ul>
|
|
2254
|
+
* of the source queue as a JSON object. The parameters are as follows:</p>
|
|
2255
|
+
* <ul>
|
|
1761
2256
|
* <li>
|
|
1762
|
-
*
|
|
1763
|
-
* <code>deadLetterTargetArn</code> – The Amazon Resource Name (ARN) of the dead-letter queue to
|
|
2257
|
+
* <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>
|
|
1764
2260
|
* </li>
|
|
1765
2261
|
* <li>
|
|
1766
|
-
*
|
|
1767
|
-
* <code>maxReceiveCount</code> – The number of times a message is delivered to the source queue before being
|
|
1768
|
-
*
|
|
2262
|
+
* <p>
|
|
2263
|
+
* <code>maxReceiveCount</code> – The number of times a message is delivered to the source queue before being
|
|
2264
|
+
* moved to the dead-letter queue. Default: 10. When the <code>ReceiveCount</code> for a message exceeds the <code>maxReceiveCount</code>
|
|
2265
|
+
* for a queue, Amazon SQS moves the message to the dead-letter-queue.</p>
|
|
1769
2266
|
* </li>
|
|
1770
2267
|
* </ul>
|
|
1771
|
-
* <note>
|
|
1772
|
-
* <p>The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.</p>
|
|
1773
|
-
* </note>
|
|
1774
2268
|
* </li>
|
|
1775
2269
|
* <li>
|
|
1776
|
-
*
|
|
1777
|
-
* <code>
|
|
1778
|
-
*
|
|
2270
|
+
* <p>
|
|
2271
|
+
* <code>RedriveAllowPolicy</code> – The string that includes the parameters for the permissions for the dead-letter
|
|
2272
|
+
* queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:</p>
|
|
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>
|
|
1779
2305
|
* </li>
|
|
1780
2306
|
* </ul>
|
|
1781
|
-
*
|
|
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>
|
|
1782
2312
|
* <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html">server-side-encryption</a>:</p>
|
|
1783
2313
|
* <ul>
|
|
1784
2314
|
* <li>
|
|
1785
|
-
*
|
|
1786
|
-
* <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer master
|
|
1787
|
-
*
|
|
1788
|
-
*
|
|
1789
|
-
*
|
|
1790
|
-
*
|
|
2315
|
+
* <p>
|
|
2316
|
+
* <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer master
|
|
2317
|
+
* key (CMK) for Amazon SQS or a custom CMK. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key Terms</a>. While the alias of the AWS-managed CMK for Amazon SQS is
|
|
2318
|
+
* always <code>alias/aws/sqs</code>, the alias of a custom CMK can, for example,
|
|
2319
|
+
* be <code>alias/<i>MyAlias</i>
|
|
2320
|
+
* </code>. For more examples, see
|
|
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>
|
|
1791
2323
|
* </li>
|
|
1792
2324
|
* <li>
|
|
1793
|
-
*
|
|
1794
|
-
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in
|
|
1795
|
-
*
|
|
1796
|
-
*
|
|
1797
|
-
*
|
|
1798
|
-
*
|
|
2325
|
+
* <p>
|
|
2326
|
+
* <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in
|
|
2327
|
+
* 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
|
|
2328
|
+
* encrypt or decrypt messages before calling KMS again. An integer
|
|
2329
|
+
* representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
|
2330
|
+
* hours). Default: 300 (5 minutes). A shorter time period provides better security
|
|
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>
|
|
1799
2333
|
* </li>
|
|
1800
2334
|
* <li>
|
|
1801
|
-
*
|
|
1802
|
-
* <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption
|
|
2335
|
+
* <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>
|
|
1803
2339
|
* </li>
|
|
1804
2340
|
* </ul>
|
|
1805
|
-
*
|
|
1806
|
-
*
|
|
1807
|
-
* <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>
|
|
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>
|
|
1808
2343
|
* <ul>
|
|
1809
2344
|
* <li>
|
|
1810
|
-
*
|
|
1811
|
-
* <code>ContentBasedDeduplication</code> – Enables content-based
|
|
1812
|
-
*
|
|
1813
|
-
*
|
|
1814
|
-
*
|
|
2345
|
+
* <p>
|
|
2346
|
+
* <code>ContentBasedDeduplication</code> – Enables content-based
|
|
2347
|
+
* deduplication. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html">Exactly-once processing</a> in the <i>Amazon SQS Developer
|
|
2348
|
+
* Guide</i>. Note the following: </p>
|
|
2349
|
+
* <ul>
|
|
1815
2350
|
* <li>
|
|
1816
|
-
*
|
|
1817
|
-
*
|
|
2351
|
+
* <p>Every message must have a unique
|
|
2352
|
+
* <code>MessageDeduplicationId</code>.</p>
|
|
2353
|
+
* <ul>
|
|
1818
2354
|
* <li>
|
|
1819
|
-
*
|
|
1820
|
-
*
|
|
2355
|
+
* <p>You may provide a <code>MessageDeduplicationId</code>
|
|
2356
|
+
* explicitly.</p>
|
|
2357
|
+
* </li>
|
|
1821
2358
|
* <li>
|
|
1822
|
-
*
|
|
1823
|
-
*
|
|
1824
|
-
*
|
|
1825
|
-
*
|
|
2359
|
+
* <p>If you aren't able to provide a
|
|
2360
|
+
* <code>MessageDeduplicationId</code> and you enable
|
|
2361
|
+
* <code>ContentBasedDeduplication</code> for your queue, Amazon SQS
|
|
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>
|
|
2365
|
+
* </li>
|
|
1826
2366
|
* <li>
|
|
1827
|
-
*
|
|
1828
|
-
*
|
|
1829
|
-
*
|
|
2367
|
+
* <p>If you don't provide a <code>MessageDeduplicationId</code> and
|
|
2368
|
+
* the queue doesn't have <code>ContentBasedDeduplication</code>
|
|
2369
|
+
* set, the action fails with an error.</p>
|
|
2370
|
+
* </li>
|
|
1830
2371
|
* <li>
|
|
1831
|
-
*
|
|
1832
|
-
*
|
|
2372
|
+
* <p>If the queue has <code>ContentBasedDeduplication</code> set,
|
|
2373
|
+
* your <code>MessageDeduplicationId</code> overrides the generated
|
|
2374
|
+
* one.</p>
|
|
2375
|
+
* </li>
|
|
1833
2376
|
* </ul>
|
|
1834
2377
|
* </li>
|
|
1835
2378
|
* <li>
|
|
1836
|
-
*
|
|
1837
|
-
*
|
|
2379
|
+
* <p>When <code>ContentBasedDeduplication</code> is in effect, messages
|
|
2380
|
+
* with identical content sent within the deduplication interval are
|
|
2381
|
+
* treated as duplicates and only one copy of the message is
|
|
2382
|
+
* delivered.</p>
|
|
1838
2383
|
* </li>
|
|
1839
2384
|
* <li>
|
|
1840
|
-
*
|
|
1841
|
-
*
|
|
1842
|
-
*
|
|
2385
|
+
* <p>If you send one message with <code>ContentBasedDeduplication</code>
|
|
2386
|
+
* enabled and then another message with a
|
|
2387
|
+
* <code>MessageDeduplicationId</code> that is the same as the one
|
|
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>
|
|
1843
2391
|
* </li>
|
|
1844
2392
|
* </ul>
|
|
1845
2393
|
* </li>
|
|
1846
2394
|
* </ul>
|
|
1847
|
-
*
|
|
1848
|
-
*
|
|
1849
2395
|
* <p>The following attributes apply only to
|
|
1850
2396
|
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html">high throughput
|
|
1851
2397
|
* for FIFO queues</a>:</p>
|