@aws-sdk/client-sqs 3.533.0 → 3.536.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/dist-types/SQS.d.ts +2 -1
- package/dist-types/SQSClient.d.ts +1 -1
- package/dist-types/commands/AddPermissionCommand.d.ts +2 -1
- package/dist-types/commands/CancelMessageMoveTaskCommand.d.ts +2 -1
- package/dist-types/commands/ChangeMessageVisibilityBatchCommand.d.ts +2 -1
- package/dist-types/commands/ChangeMessageVisibilityCommand.d.ts +2 -1
- package/dist-types/commands/CreateQueueCommand.d.ts +2 -1
- package/dist-types/commands/DeleteMessageBatchCommand.d.ts +2 -1
- package/dist-types/commands/DeleteMessageCommand.d.ts +2 -1
- package/dist-types/commands/DeleteQueueCommand.d.ts +2 -1
- package/dist-types/commands/GetQueueAttributesCommand.d.ts +2 -1
- package/dist-types/commands/GetQueueUrlCommand.d.ts +2 -1
- package/dist-types/commands/ListDeadLetterSourceQueuesCommand.d.ts +2 -1
- package/dist-types/commands/ListMessageMoveTasksCommand.d.ts +2 -1
- package/dist-types/commands/ListQueueTagsCommand.d.ts +2 -1
- package/dist-types/commands/ListQueuesCommand.d.ts +2 -1
- package/dist-types/commands/PurgeQueueCommand.d.ts +2 -1
- package/dist-types/commands/ReceiveMessageCommand.d.ts +2 -1
- package/dist-types/commands/RemovePermissionCommand.d.ts +2 -1
- package/dist-types/commands/SendMessageBatchCommand.d.ts +2 -1
- package/dist-types/commands/SendMessageCommand.d.ts +2 -1
- package/dist-types/commands/SetQueueAttributesCommand.d.ts +2 -1
- package/dist-types/commands/StartMessageMoveTaskCommand.d.ts +2 -1
- package/dist-types/commands/TagQueueCommand.d.ts +2 -1
- package/dist-types/commands/UntagQueueCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +199 -199
- package/dist-types/ts3.4/SQS.d.ts +1 -0
- package/dist-types/ts3.4/commands/AddPermissionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CancelMessageMoveTaskCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ChangeMessageVisibilityBatchCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ChangeMessageVisibilityCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateQueueCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteMessageBatchCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteMessageCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteQueueCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetQueueAttributesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetQueueUrlCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListDeadLetterSourceQueuesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListMessageMoveTasksCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListQueueTagsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListQueuesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PurgeQueueCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ReceiveMessageCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RemovePermissionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SendMessageBatchCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SendMessageCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SetQueueAttributesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartMessageMoveTaskCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagQueueCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagQueueCommand.d.ts +9 -0
- package/package.json +42 -42
|
@@ -1,36 +1,35 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { SQSServiceException as __BaseException } from "./SQSServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p></p>
|
|
5
|
+
* @public
|
|
6
6
|
*/
|
|
7
7
|
export interface AddPermissionRequest {
|
|
8
8
|
/**
|
|
9
|
-
* @public
|
|
10
9
|
* <p>The URL of the Amazon SQS queue to which permissions are added.</p>
|
|
11
10
|
* <p>Queue URLs and names are case-sensitive.</p>
|
|
11
|
+
* @public
|
|
12
12
|
*/
|
|
13
13
|
QueueUrl: string | undefined;
|
|
14
14
|
/**
|
|
15
|
-
* @public
|
|
16
15
|
* <p>The unique identification of the permission you're setting (for example,
|
|
17
16
|
* <code>AliceSendMessage</code>). Maximum 80 characters. Allowed characters include
|
|
18
17
|
* alphanumeric characters, hyphens (<code>-</code>), and underscores
|
|
19
18
|
* (<code>_</code>).</p>
|
|
19
|
+
* @public
|
|
20
20
|
*/
|
|
21
21
|
Label: string | undefined;
|
|
22
22
|
/**
|
|
23
|
-
* @public
|
|
24
23
|
* <p>The Amazon Web
|
|
25
24
|
* Services account numbers of the <a href="https://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P">principals</a> who are to receive
|
|
26
25
|
* permission. For information about locating the Amazon Web Services
|
|
27
26
|
* account identification, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-making-api-requests.html#sqs-api-request-authentication">Your Amazon Web
|
|
28
27
|
* Services Identifiers</a> in the <i>Amazon SQS Developer
|
|
29
28
|
* Guide</i>.</p>
|
|
29
|
+
* @public
|
|
30
30
|
*/
|
|
31
31
|
AWSAccountIds: string[] | undefined;
|
|
32
32
|
/**
|
|
33
|
-
* @public
|
|
34
33
|
* <p>The action the client wants to allow for the specified principal. Valid values: the
|
|
35
34
|
* name of any action or <code>*</code>.</p>
|
|
36
35
|
* <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
|
|
@@ -40,12 +39,13 @@ export interface AddPermissionRequest {
|
|
|
40
39
|
* permissions for the corresponding batch versions of those actions:
|
|
41
40
|
* <code>SendMessageBatch</code>, <code>DeleteMessageBatch</code>, and
|
|
42
41
|
* <code>ChangeMessageVisibilityBatch</code>.</p>
|
|
42
|
+
* @public
|
|
43
43
|
*/
|
|
44
44
|
Actions: string[] | undefined;
|
|
45
45
|
}
|
|
46
46
|
/**
|
|
47
|
-
* @public
|
|
48
47
|
* <p>The <code>accountId</code> is invalid.</p>
|
|
48
|
+
* @public
|
|
49
49
|
*/
|
|
50
50
|
export declare class InvalidAddress extends __BaseException {
|
|
51
51
|
readonly name: "InvalidAddress";
|
|
@@ -56,8 +56,8 @@ export declare class InvalidAddress extends __BaseException {
|
|
|
56
56
|
constructor(opts: __ExceptionOptionType<InvalidAddress, __BaseException>);
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
* @public
|
|
60
59
|
* <p>When the request to a queue is not HTTPS and SigV4.</p>
|
|
60
|
+
* @public
|
|
61
61
|
*/
|
|
62
62
|
export declare class InvalidSecurity extends __BaseException {
|
|
63
63
|
readonly name: "InvalidSecurity";
|
|
@@ -68,11 +68,11 @@ export declare class InvalidSecurity extends __BaseException {
|
|
|
68
68
|
constructor(opts: __ExceptionOptionType<InvalidSecurity, __BaseException>);
|
|
69
69
|
}
|
|
70
70
|
/**
|
|
71
|
-
* @public
|
|
72
71
|
* <p>The specified action violates a limit. For example, <code>ReceiveMessage</code>
|
|
73
72
|
* returns this error if the maximum number of in flight messages is reached and
|
|
74
73
|
* <code>AddPermission</code> returns this error if the maximum number of permissions
|
|
75
74
|
* for the queue is reached.</p>
|
|
75
|
+
* @public
|
|
76
76
|
*/
|
|
77
77
|
export declare class OverLimit extends __BaseException {
|
|
78
78
|
readonly name: "OverLimit";
|
|
@@ -83,8 +83,8 @@ export declare class OverLimit extends __BaseException {
|
|
|
83
83
|
constructor(opts: __ExceptionOptionType<OverLimit, __BaseException>);
|
|
84
84
|
}
|
|
85
85
|
/**
|
|
86
|
-
* @public
|
|
87
86
|
* <p>The specified queue doesn't exist.</p>
|
|
87
|
+
* @public
|
|
88
88
|
*/
|
|
89
89
|
export declare class QueueDoesNotExist extends __BaseException {
|
|
90
90
|
readonly name: "QueueDoesNotExist";
|
|
@@ -95,7 +95,6 @@ export declare class QueueDoesNotExist extends __BaseException {
|
|
|
95
95
|
constructor(opts: __ExceptionOptionType<QueueDoesNotExist, __BaseException>);
|
|
96
96
|
}
|
|
97
97
|
/**
|
|
98
|
-
* @public
|
|
99
98
|
* <p>The request was denied due to request throttling.</p>
|
|
100
99
|
* <ul>
|
|
101
100
|
* <li>
|
|
@@ -113,6 +112,7 @@ export declare class QueueDoesNotExist extends __BaseException {
|
|
|
113
112
|
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
114
113
|
* </li>
|
|
115
114
|
* </ul>
|
|
115
|
+
* @public
|
|
116
116
|
*/
|
|
117
117
|
export declare class RequestThrottled extends __BaseException {
|
|
118
118
|
readonly name: "RequestThrottled";
|
|
@@ -123,8 +123,8 @@ export declare class RequestThrottled extends __BaseException {
|
|
|
123
123
|
constructor(opts: __ExceptionOptionType<RequestThrottled, __BaseException>);
|
|
124
124
|
}
|
|
125
125
|
/**
|
|
126
|
-
* @public
|
|
127
126
|
* <p>Error code 400. Unsupported operation.</p>
|
|
127
|
+
* @public
|
|
128
128
|
*/
|
|
129
129
|
export declare class UnsupportedOperation extends __BaseException {
|
|
130
130
|
readonly name: "UnsupportedOperation";
|
|
@@ -139,8 +139,8 @@ export declare class UnsupportedOperation extends __BaseException {
|
|
|
139
139
|
*/
|
|
140
140
|
export interface CancelMessageMoveTaskRequest {
|
|
141
141
|
/**
|
|
142
|
-
* @public
|
|
143
142
|
* <p>An identifier associated with a message movement task.</p>
|
|
143
|
+
* @public
|
|
144
144
|
*/
|
|
145
145
|
TaskHandle: string | undefined;
|
|
146
146
|
}
|
|
@@ -149,14 +149,14 @@ export interface CancelMessageMoveTaskRequest {
|
|
|
149
149
|
*/
|
|
150
150
|
export interface CancelMessageMoveTaskResult {
|
|
151
151
|
/**
|
|
152
|
-
* @public
|
|
153
152
|
* <p>The approximate number of messages already moved to the destination queue.</p>
|
|
153
|
+
* @public
|
|
154
154
|
*/
|
|
155
155
|
ApproximateNumberOfMessagesMoved?: number;
|
|
156
156
|
}
|
|
157
157
|
/**
|
|
158
|
-
* @public
|
|
159
158
|
* <p>One or more specified resources don't exist.</p>
|
|
159
|
+
* @public
|
|
160
160
|
*/
|
|
161
161
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
162
162
|
readonly name: "ResourceNotFoundException";
|
|
@@ -171,30 +171,30 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
171
171
|
*/
|
|
172
172
|
export interface ChangeMessageVisibilityRequest {
|
|
173
173
|
/**
|
|
174
|
-
* @public
|
|
175
174
|
* <p>The URL of the Amazon SQS queue whose message's visibility is changed.</p>
|
|
176
175
|
* <p>Queue URLs and names are case-sensitive.</p>
|
|
176
|
+
* @public
|
|
177
177
|
*/
|
|
178
178
|
QueueUrl: string | undefined;
|
|
179
179
|
/**
|
|
180
|
-
* @public
|
|
181
180
|
* <p>The receipt handle associated with the message, whose visibility timeout is changed.
|
|
182
181
|
* This parameter is returned by the <code>
|
|
183
182
|
* <a>ReceiveMessage</a>
|
|
184
183
|
* </code>
|
|
185
184
|
* action.</p>
|
|
185
|
+
* @public
|
|
186
186
|
*/
|
|
187
187
|
ReceiptHandle: string | undefined;
|
|
188
188
|
/**
|
|
189
|
-
* @public
|
|
190
189
|
* <p>The new value for the message's visibility timeout (in seconds). Values range:
|
|
191
190
|
* <code>0</code> to <code>43200</code>. Maximum: 12 hours.</p>
|
|
191
|
+
* @public
|
|
192
192
|
*/
|
|
193
193
|
VisibilityTimeout: number | undefined;
|
|
194
194
|
}
|
|
195
195
|
/**
|
|
196
|
-
* @public
|
|
197
196
|
* <p>The specified message isn't in flight.</p>
|
|
197
|
+
* @public
|
|
198
198
|
*/
|
|
199
199
|
export declare class MessageNotInflight extends __BaseException {
|
|
200
200
|
readonly name: "MessageNotInflight";
|
|
@@ -205,8 +205,8 @@ export declare class MessageNotInflight extends __BaseException {
|
|
|
205
205
|
constructor(opts: __ExceptionOptionType<MessageNotInflight, __BaseException>);
|
|
206
206
|
}
|
|
207
207
|
/**
|
|
208
|
-
* @public
|
|
209
208
|
* <p>The specified receipt handle isn't valid.</p>
|
|
209
|
+
* @public
|
|
210
210
|
*/
|
|
211
211
|
export declare class ReceiptHandleIsInvalid extends __BaseException {
|
|
212
212
|
readonly name: "ReceiptHandleIsInvalid";
|
|
@@ -217,8 +217,8 @@ export declare class ReceiptHandleIsInvalid extends __BaseException {
|
|
|
217
217
|
constructor(opts: __ExceptionOptionType<ReceiptHandleIsInvalid, __BaseException>);
|
|
218
218
|
}
|
|
219
219
|
/**
|
|
220
|
-
* @public
|
|
221
220
|
* <p>Two or more batch entries in the request have the same <code>Id</code>.</p>
|
|
221
|
+
* @public
|
|
222
222
|
*/
|
|
223
223
|
export declare class BatchEntryIdsNotDistinct extends __BaseException {
|
|
224
224
|
readonly name: "BatchEntryIdsNotDistinct";
|
|
@@ -229,14 +229,13 @@ export declare class BatchEntryIdsNotDistinct extends __BaseException {
|
|
|
229
229
|
constructor(opts: __ExceptionOptionType<BatchEntryIdsNotDistinct, __BaseException>);
|
|
230
230
|
}
|
|
231
231
|
/**
|
|
232
|
-
* @public
|
|
233
232
|
* <p>Encloses a receipt handle and an entry ID for each message in <code>
|
|
234
233
|
* <a>ChangeMessageVisibilityBatch</a>.</code>
|
|
235
234
|
* </p>
|
|
235
|
+
* @public
|
|
236
236
|
*/
|
|
237
237
|
export interface ChangeMessageVisibilityBatchRequestEntry {
|
|
238
238
|
/**
|
|
239
|
-
* @public
|
|
240
239
|
* <p>An identifier for this particular receipt handle used to communicate the
|
|
241
240
|
* result.</p>
|
|
242
241
|
* <note>
|
|
@@ -244,79 +243,79 @@ export interface ChangeMessageVisibilityBatchRequestEntry {
|
|
|
244
243
|
* <p>This identifier can have up to 80 characters. The following characters are
|
|
245
244
|
* accepted: alphanumeric characters, hyphens(-), and underscores (_).</p>
|
|
246
245
|
* </note>
|
|
246
|
+
* @public
|
|
247
247
|
*/
|
|
248
248
|
Id: string | undefined;
|
|
249
249
|
/**
|
|
250
|
-
* @public
|
|
251
250
|
* <p>A receipt handle.</p>
|
|
251
|
+
* @public
|
|
252
252
|
*/
|
|
253
253
|
ReceiptHandle: string | undefined;
|
|
254
254
|
/**
|
|
255
|
-
* @public
|
|
256
255
|
* <p>The new value (in seconds) for the message's visibility timeout.</p>
|
|
256
|
+
* @public
|
|
257
257
|
*/
|
|
258
258
|
VisibilityTimeout?: number;
|
|
259
259
|
}
|
|
260
260
|
/**
|
|
261
|
-
* @public
|
|
262
261
|
* <p></p>
|
|
262
|
+
* @public
|
|
263
263
|
*/
|
|
264
264
|
export interface ChangeMessageVisibilityBatchRequest {
|
|
265
265
|
/**
|
|
266
|
-
* @public
|
|
267
266
|
* <p>The URL of the Amazon SQS queue whose messages' visibility is changed.</p>
|
|
268
267
|
* <p>Queue URLs and names are case-sensitive.</p>
|
|
268
|
+
* @public
|
|
269
269
|
*/
|
|
270
270
|
QueueUrl: string | undefined;
|
|
271
271
|
/**
|
|
272
|
-
* @public
|
|
273
272
|
* <p>Lists the receipt handles of the messages for which the visibility timeout must be
|
|
274
273
|
* changed.</p>
|
|
274
|
+
* @public
|
|
275
275
|
*/
|
|
276
276
|
Entries: ChangeMessageVisibilityBatchRequestEntry[] | undefined;
|
|
277
277
|
}
|
|
278
278
|
/**
|
|
279
|
-
* @public
|
|
280
279
|
* <p>Gives a detailed description of the result of an action on each entry in the
|
|
281
280
|
* request.</p>
|
|
281
|
+
* @public
|
|
282
282
|
*/
|
|
283
283
|
export interface BatchResultErrorEntry {
|
|
284
284
|
/**
|
|
285
|
-
* @public
|
|
286
285
|
* <p>The <code>Id</code> of an entry in a batch request.</p>
|
|
286
|
+
* @public
|
|
287
287
|
*/
|
|
288
288
|
Id: string | undefined;
|
|
289
289
|
/**
|
|
290
|
-
* @public
|
|
291
290
|
* <p>Specifies whether the error happened due to the caller of the batch API action.</p>
|
|
291
|
+
* @public
|
|
292
292
|
*/
|
|
293
293
|
SenderFault: boolean | undefined;
|
|
294
294
|
/**
|
|
295
|
-
* @public
|
|
296
295
|
* <p>An error code representing why the action failed on this entry.</p>
|
|
296
|
+
* @public
|
|
297
297
|
*/
|
|
298
298
|
Code: string | undefined;
|
|
299
299
|
/**
|
|
300
|
-
* @public
|
|
301
300
|
* <p>A message explaining why the action failed on this entry.</p>
|
|
301
|
+
* @public
|
|
302
302
|
*/
|
|
303
303
|
Message?: string;
|
|
304
304
|
}
|
|
305
305
|
/**
|
|
306
|
-
* @public
|
|
307
306
|
* <p>Encloses the <code>Id</code> of an entry in <code>
|
|
308
307
|
* <a>ChangeMessageVisibilityBatch</a>.</code>
|
|
309
308
|
* </p>
|
|
309
|
+
* @public
|
|
310
310
|
*/
|
|
311
311
|
export interface ChangeMessageVisibilityBatchResultEntry {
|
|
312
312
|
/**
|
|
313
|
-
* @public
|
|
314
313
|
* <p>Represents a message whose visibility timeout has been changed successfully.</p>
|
|
314
|
+
* @public
|
|
315
315
|
*/
|
|
316
316
|
Id: string | undefined;
|
|
317
317
|
}
|
|
318
318
|
/**
|
|
319
|
-
* @public
|
|
320
319
|
* <p>For each message in the batch, the response contains a <code>
|
|
321
320
|
* <a>ChangeMessageVisibilityBatchResultEntry</a>
|
|
322
321
|
* </code> tag if the message
|
|
@@ -324,27 +323,28 @@ export interface ChangeMessageVisibilityBatchResultEntry {
|
|
|
324
323
|
* <a>BatchResultErrorEntry</a>
|
|
325
324
|
* </code> tag if the message
|
|
326
325
|
* fails.</p>
|
|
326
|
+
* @public
|
|
327
327
|
*/
|
|
328
328
|
export interface ChangeMessageVisibilityBatchResult {
|
|
329
329
|
/**
|
|
330
|
-
* @public
|
|
331
330
|
* <p>A list of <code>
|
|
332
331
|
* <a>ChangeMessageVisibilityBatchResultEntry</a>
|
|
333
332
|
* </code>
|
|
334
333
|
* items.</p>
|
|
334
|
+
* @public
|
|
335
335
|
*/
|
|
336
336
|
Successful: ChangeMessageVisibilityBatchResultEntry[] | undefined;
|
|
337
337
|
/**
|
|
338
|
-
* @public
|
|
339
338
|
* <p>A list of <code>
|
|
340
339
|
* <a>BatchResultErrorEntry</a>
|
|
341
340
|
* </code> items.</p>
|
|
341
|
+
* @public
|
|
342
342
|
*/
|
|
343
343
|
Failed: BatchResultErrorEntry[] | undefined;
|
|
344
344
|
}
|
|
345
345
|
/**
|
|
346
|
-
* @public
|
|
347
346
|
* <p>The batch request doesn't contain any entries.</p>
|
|
347
|
+
* @public
|
|
348
348
|
*/
|
|
349
349
|
export declare class EmptyBatchRequest extends __BaseException {
|
|
350
350
|
readonly name: "EmptyBatchRequest";
|
|
@@ -355,9 +355,9 @@ export declare class EmptyBatchRequest extends __BaseException {
|
|
|
355
355
|
constructor(opts: __ExceptionOptionType<EmptyBatchRequest, __BaseException>);
|
|
356
356
|
}
|
|
357
357
|
/**
|
|
358
|
-
* @public
|
|
359
358
|
* <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the
|
|
360
359
|
* specification.</p>
|
|
360
|
+
* @public
|
|
361
361
|
*/
|
|
362
362
|
export declare class InvalidBatchEntryId extends __BaseException {
|
|
363
363
|
readonly name: "InvalidBatchEntryId";
|
|
@@ -368,8 +368,8 @@ export declare class InvalidBatchEntryId extends __BaseException {
|
|
|
368
368
|
constructor(opts: __ExceptionOptionType<InvalidBatchEntryId, __BaseException>);
|
|
369
369
|
}
|
|
370
370
|
/**
|
|
371
|
-
* @public
|
|
372
371
|
* <p>The batch request contains more entries than permissible.</p>
|
|
372
|
+
* @public
|
|
373
373
|
*/
|
|
374
374
|
export declare class TooManyEntriesInBatchRequest extends __BaseException {
|
|
375
375
|
readonly name: "TooManyEntriesInBatchRequest";
|
|
@@ -412,12 +412,11 @@ export declare const QueueAttributeName: {
|
|
|
412
412
|
*/
|
|
413
413
|
export type QueueAttributeName = (typeof QueueAttributeName)[keyof typeof QueueAttributeName];
|
|
414
414
|
/**
|
|
415
|
-
* @public
|
|
416
415
|
* <p></p>
|
|
416
|
+
* @public
|
|
417
417
|
*/
|
|
418
418
|
export interface CreateQueueRequest {
|
|
419
419
|
/**
|
|
420
|
-
* @public
|
|
421
420
|
* <p>The name of the new queue. The following limits apply to this name:</p>
|
|
422
421
|
* <ul>
|
|
423
422
|
* <li>
|
|
@@ -432,10 +431,10 @@ export interface CreateQueueRequest {
|
|
|
432
431
|
* </li>
|
|
433
432
|
* </ul>
|
|
434
433
|
* <p>Queue URLs and names are case-sensitive.</p>
|
|
434
|
+
* @public
|
|
435
435
|
*/
|
|
436
436
|
QueueName: string | undefined;
|
|
437
437
|
/**
|
|
438
|
-
* @public
|
|
439
438
|
* <p>A map of attributes with their corresponding values.</p>
|
|
440
439
|
* <p>The following lists the names, descriptions, and values of the special request
|
|
441
440
|
* parameters that the <code>CreateQueue</code> action uses:</p>
|
|
@@ -690,10 +689,10 @@ export interface CreateQueueRequest {
|
|
|
690
689
|
* <p>For information on throughput quotas, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html">Quotas
|
|
691
690
|
* related to messages</a> in the <i>Amazon SQS Developer
|
|
692
691
|
* Guide</i>.</p>
|
|
692
|
+
* @public
|
|
693
693
|
*/
|
|
694
694
|
Attributes?: Partial<Record<QueueAttributeName, string>>;
|
|
695
695
|
/**
|
|
696
|
-
* @public
|
|
697
696
|
* <p>Add cost allocation tags to the specified Amazon SQS queue. For an overview, see
|
|
698
697
|
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html">Tagging
|
|
699
698
|
* Your Amazon SQS Queues</a> in the <i>Amazon SQS Developer
|
|
@@ -724,23 +723,24 @@ export interface CreateQueueRequest {
|
|
|
724
723
|
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name">Grant cross-account permissions to a role and a username</a> in the
|
|
725
724
|
* <i>Amazon SQS Developer Guide</i>.</p>
|
|
726
725
|
* </note>
|
|
726
|
+
* @public
|
|
727
727
|
*/
|
|
728
728
|
tags?: Record<string, string>;
|
|
729
729
|
}
|
|
730
730
|
/**
|
|
731
|
-
* @public
|
|
732
731
|
* <p>Returns the <code>QueueUrl</code> attribute of the created queue.</p>
|
|
732
|
+
* @public
|
|
733
733
|
*/
|
|
734
734
|
export interface CreateQueueResult {
|
|
735
735
|
/**
|
|
736
|
-
* @public
|
|
737
736
|
* <p>The URL of the created Amazon SQS queue.</p>
|
|
737
|
+
* @public
|
|
738
738
|
*/
|
|
739
739
|
QueueUrl?: string;
|
|
740
740
|
}
|
|
741
741
|
/**
|
|
742
|
-
* @public
|
|
743
742
|
* <p>The specified attribute doesn't exist.</p>
|
|
743
|
+
* @public
|
|
744
744
|
*/
|
|
745
745
|
export declare class InvalidAttributeName extends __BaseException {
|
|
746
746
|
readonly name: "InvalidAttributeName";
|
|
@@ -751,8 +751,8 @@ export declare class InvalidAttributeName extends __BaseException {
|
|
|
751
751
|
constructor(opts: __ExceptionOptionType<InvalidAttributeName, __BaseException>);
|
|
752
752
|
}
|
|
753
753
|
/**
|
|
754
|
-
* @public
|
|
755
754
|
* <p>A queue attribute value is invalid.</p>
|
|
755
|
+
* @public
|
|
756
756
|
*/
|
|
757
757
|
export declare class InvalidAttributeValue extends __BaseException {
|
|
758
758
|
readonly name: "InvalidAttributeValue";
|
|
@@ -763,9 +763,9 @@ export declare class InvalidAttributeValue extends __BaseException {
|
|
|
763
763
|
constructor(opts: __ExceptionOptionType<InvalidAttributeValue, __BaseException>);
|
|
764
764
|
}
|
|
765
765
|
/**
|
|
766
|
-
* @public
|
|
767
766
|
* <p>You must wait 60 seconds after deleting a queue before you can create another queue
|
|
768
767
|
* with the same name.</p>
|
|
768
|
+
* @public
|
|
769
769
|
*/
|
|
770
770
|
export declare class QueueDeletedRecently extends __BaseException {
|
|
771
771
|
readonly name: "QueueDeletedRecently";
|
|
@@ -776,9 +776,9 @@ export declare class QueueDeletedRecently extends __BaseException {
|
|
|
776
776
|
constructor(opts: __ExceptionOptionType<QueueDeletedRecently, __BaseException>);
|
|
777
777
|
}
|
|
778
778
|
/**
|
|
779
|
-
* @public
|
|
780
779
|
* <p>A queue with this name already exists. Amazon SQS returns this error only if the
|
|
781
780
|
* request includes attributes whose values differ from those of the existing queue.</p>
|
|
781
|
+
* @public
|
|
782
782
|
*/
|
|
783
783
|
export declare class QueueNameExists extends __BaseException {
|
|
784
784
|
readonly name: "QueueNameExists";
|
|
@@ -789,27 +789,27 @@ export declare class QueueNameExists extends __BaseException {
|
|
|
789
789
|
constructor(opts: __ExceptionOptionType<QueueNameExists, __BaseException>);
|
|
790
790
|
}
|
|
791
791
|
/**
|
|
792
|
-
* @public
|
|
793
792
|
* <p></p>
|
|
793
|
+
* @public
|
|
794
794
|
*/
|
|
795
795
|
export interface DeleteMessageRequest {
|
|
796
796
|
/**
|
|
797
|
-
* @public
|
|
798
797
|
* <p>The URL of the Amazon SQS queue from which messages are deleted.</p>
|
|
799
798
|
* <p>Queue URLs and names are case-sensitive.</p>
|
|
799
|
+
* @public
|
|
800
800
|
*/
|
|
801
801
|
QueueUrl: string | undefined;
|
|
802
802
|
/**
|
|
803
|
-
* @public
|
|
804
803
|
* <p>The receipt handle associated with the message to delete.</p>
|
|
804
|
+
* @public
|
|
805
805
|
*/
|
|
806
806
|
ReceiptHandle: string | undefined;
|
|
807
807
|
}
|
|
808
808
|
/**
|
|
809
|
-
* @public
|
|
810
|
-
* @deprecated
|
|
811
|
-
*
|
|
812
809
|
* <p>The specified receipt handle isn't valid for the current version.</p>
|
|
810
|
+
*
|
|
811
|
+
* @deprecated exception has been included in ReceiptHandleIsInvalid
|
|
812
|
+
* @public
|
|
813
813
|
*/
|
|
814
814
|
export declare class InvalidIdFormat extends __BaseException {
|
|
815
815
|
readonly name: "InvalidIdFormat";
|
|
@@ -820,12 +820,11 @@ export declare class InvalidIdFormat extends __BaseException {
|
|
|
820
820
|
constructor(opts: __ExceptionOptionType<InvalidIdFormat, __BaseException>);
|
|
821
821
|
}
|
|
822
822
|
/**
|
|
823
|
-
* @public
|
|
824
823
|
* <p>Encloses a receipt handle and an identifier for it.</p>
|
|
824
|
+
* @public
|
|
825
825
|
*/
|
|
826
826
|
export interface DeleteMessageBatchRequestEntry {
|
|
827
827
|
/**
|
|
828
|
-
* @public
|
|
829
828
|
* <p>The identifier for this particular receipt handle. This is used to communicate the
|
|
830
829
|
* result.</p>
|
|
831
830
|
* <note>
|
|
@@ -833,46 +832,46 @@ export interface DeleteMessageBatchRequestEntry {
|
|
|
833
832
|
* <p>This identifier can have up to 80 characters. The following characters are
|
|
834
833
|
* accepted: alphanumeric characters, hyphens(-), and underscores (_).</p>
|
|
835
834
|
* </note>
|
|
835
|
+
* @public
|
|
836
836
|
*/
|
|
837
837
|
Id: string | undefined;
|
|
838
838
|
/**
|
|
839
|
-
* @public
|
|
840
839
|
* <p>A receipt handle.</p>
|
|
840
|
+
* @public
|
|
841
841
|
*/
|
|
842
842
|
ReceiptHandle: string | undefined;
|
|
843
843
|
}
|
|
844
844
|
/**
|
|
845
|
-
* @public
|
|
846
845
|
* <p></p>
|
|
846
|
+
* @public
|
|
847
847
|
*/
|
|
848
848
|
export interface DeleteMessageBatchRequest {
|
|
849
849
|
/**
|
|
850
|
-
* @public
|
|
851
850
|
* <p>The URL of the Amazon SQS queue from which messages are deleted.</p>
|
|
852
851
|
* <p>Queue URLs and names are case-sensitive.</p>
|
|
852
|
+
* @public
|
|
853
853
|
*/
|
|
854
854
|
QueueUrl: string | undefined;
|
|
855
855
|
/**
|
|
856
|
-
* @public
|
|
857
856
|
* <p>Lists the receipt handles for the messages to be deleted.</p>
|
|
857
|
+
* @public
|
|
858
858
|
*/
|
|
859
859
|
Entries: DeleteMessageBatchRequestEntry[] | undefined;
|
|
860
860
|
}
|
|
861
861
|
/**
|
|
862
|
-
* @public
|
|
863
862
|
* <p>Encloses the <code>Id</code> of an entry in <code>
|
|
864
863
|
* <a>DeleteMessageBatch</a>.</code>
|
|
865
864
|
* </p>
|
|
865
|
+
* @public
|
|
866
866
|
*/
|
|
867
867
|
export interface DeleteMessageBatchResultEntry {
|
|
868
868
|
/**
|
|
869
|
-
* @public
|
|
870
869
|
* <p>Represents a successfully deleted message.</p>
|
|
870
|
+
* @public
|
|
871
871
|
*/
|
|
872
872
|
Id: string | undefined;
|
|
873
873
|
}
|
|
874
874
|
/**
|
|
875
|
-
* @public
|
|
876
875
|
* <p>For each message in the batch, the response contains a <code>
|
|
877
876
|
* <a>DeleteMessageBatchResultEntry</a>
|
|
878
877
|
* </code> tag if the message is deleted
|
|
@@ -880,48 +879,48 @@ export interface DeleteMessageBatchResultEntry {
|
|
|
880
879
|
* <a>BatchResultErrorEntry</a>
|
|
881
880
|
* </code> tag if the message can't be
|
|
882
881
|
* deleted.</p>
|
|
882
|
+
* @public
|
|
883
883
|
*/
|
|
884
884
|
export interface DeleteMessageBatchResult {
|
|
885
885
|
/**
|
|
886
|
-
* @public
|
|
887
886
|
* <p>A list of <code>
|
|
888
887
|
* <a>DeleteMessageBatchResultEntry</a>
|
|
889
888
|
* </code> items.</p>
|
|
889
|
+
* @public
|
|
890
890
|
*/
|
|
891
891
|
Successful: DeleteMessageBatchResultEntry[] | undefined;
|
|
892
892
|
/**
|
|
893
|
-
* @public
|
|
894
893
|
* <p>A list of <code>
|
|
895
894
|
* <a>BatchResultErrorEntry</a>
|
|
896
895
|
* </code> items.</p>
|
|
896
|
+
* @public
|
|
897
897
|
*/
|
|
898
898
|
Failed: BatchResultErrorEntry[] | undefined;
|
|
899
899
|
}
|
|
900
900
|
/**
|
|
901
|
-
* @public
|
|
902
901
|
* <p></p>
|
|
902
|
+
* @public
|
|
903
903
|
*/
|
|
904
904
|
export interface DeleteQueueRequest {
|
|
905
905
|
/**
|
|
906
|
-
* @public
|
|
907
906
|
* <p>The URL of the Amazon SQS queue to delete.</p>
|
|
908
907
|
* <p>Queue URLs and names are case-sensitive.</p>
|
|
908
|
+
* @public
|
|
909
909
|
*/
|
|
910
910
|
QueueUrl: string | undefined;
|
|
911
911
|
}
|
|
912
912
|
/**
|
|
913
|
-
* @public
|
|
914
913
|
* <p></p>
|
|
914
|
+
* @public
|
|
915
915
|
*/
|
|
916
916
|
export interface GetQueueAttributesRequest {
|
|
917
917
|
/**
|
|
918
|
-
* @public
|
|
919
918
|
* <p>The URL of the Amazon SQS queue whose attribute information is retrieved.</p>
|
|
920
919
|
* <p>Queue URLs and names are case-sensitive.</p>
|
|
920
|
+
* @public
|
|
921
921
|
*/
|
|
922
922
|
QueueUrl: string | undefined;
|
|
923
923
|
/**
|
|
924
|
-
* @public
|
|
925
924
|
* <p>A list of attributes for which to retrieve information.</p>
|
|
926
925
|
* <p>The <code>AttributeNames</code> parameter is optional, but if you don't specify values
|
|
927
926
|
* for this parameter, the request returns empty results.</p>
|
|
@@ -1166,92 +1165,93 @@ export interface GetQueueAttributesRequest {
|
|
|
1166
1165
|
* <p>For information on throughput quotas, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html">Quotas
|
|
1167
1166
|
* related to messages</a> in the <i>Amazon SQS Developer
|
|
1168
1167
|
* Guide</i>.</p>
|
|
1168
|
+
* @public
|
|
1169
1169
|
*/
|
|
1170
1170
|
AttributeNames?: QueueAttributeName[];
|
|
1171
1171
|
}
|
|
1172
1172
|
/**
|
|
1173
|
-
* @public
|
|
1174
1173
|
* <p>A list of returned queue attributes.</p>
|
|
1174
|
+
* @public
|
|
1175
1175
|
*/
|
|
1176
1176
|
export interface GetQueueAttributesResult {
|
|
1177
1177
|
/**
|
|
1178
|
-
* @public
|
|
1179
1178
|
* <p>A map of attributes to their respective values.</p>
|
|
1179
|
+
* @public
|
|
1180
1180
|
*/
|
|
1181
1181
|
Attributes?: Partial<Record<QueueAttributeName, string>>;
|
|
1182
1182
|
}
|
|
1183
1183
|
/**
|
|
1184
|
-
* @public
|
|
1185
1184
|
* <p></p>
|
|
1185
|
+
* @public
|
|
1186
1186
|
*/
|
|
1187
1187
|
export interface GetQueueUrlRequest {
|
|
1188
1188
|
/**
|
|
1189
|
-
* @public
|
|
1190
1189
|
* <p>The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values:
|
|
1191
1190
|
* alphanumeric characters, hyphens (<code>-</code>), and underscores
|
|
1192
1191
|
* (<code>_</code>).</p>
|
|
1193
1192
|
* <p>Queue URLs and names are case-sensitive.</p>
|
|
1193
|
+
* @public
|
|
1194
1194
|
*/
|
|
1195
1195
|
QueueName: string | undefined;
|
|
1196
1196
|
/**
|
|
1197
|
-
* @public
|
|
1198
1197
|
* <p>The Amazon Web
|
|
1199
1198
|
* Services account ID of the account that created the queue.</p>
|
|
1199
|
+
* @public
|
|
1200
1200
|
*/
|
|
1201
1201
|
QueueOwnerAWSAccountId?: string;
|
|
1202
1202
|
}
|
|
1203
1203
|
/**
|
|
1204
|
-
* @public
|
|
1205
1204
|
* <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
|
|
1206
1205
|
* Guide</i>.</p>
|
|
1206
|
+
* @public
|
|
1207
1207
|
*/
|
|
1208
1208
|
export interface GetQueueUrlResult {
|
|
1209
1209
|
/**
|
|
1210
|
-
* @public
|
|
1211
1210
|
* <p>The URL of the queue.</p>
|
|
1211
|
+
* @public
|
|
1212
1212
|
*/
|
|
1213
1213
|
QueueUrl?: string;
|
|
1214
1214
|
}
|
|
1215
1215
|
/**
|
|
1216
|
-
* @public
|
|
1217
1216
|
* <p></p>
|
|
1217
|
+
* @public
|
|
1218
1218
|
*/
|
|
1219
1219
|
export interface ListDeadLetterSourceQueuesRequest {
|
|
1220
1220
|
/**
|
|
1221
|
-
* @public
|
|
1222
1221
|
* <p>The URL of a dead-letter queue.</p>
|
|
1223
1222
|
* <p>Queue URLs and names are case-sensitive.</p>
|
|
1223
|
+
* @public
|
|
1224
1224
|
*/
|
|
1225
1225
|
QueueUrl: string | undefined;
|
|
1226
1226
|
/**
|
|
1227
|
-
* @public
|
|
1228
1227
|
* <p>Pagination token to request the next set of results.</p>
|
|
1228
|
+
* @public
|
|
1229
1229
|
*/
|
|
1230
1230
|
NextToken?: string;
|
|
1231
1231
|
/**
|
|
1232
|
-
* @public
|
|
1233
1232
|
* <p>Maximum number of results to include in the response. Value range is 1 to 1000. You
|
|
1234
1233
|
* must set <code>MaxResults</code> to receive a value for <code>NextToken</code> in the
|
|
1235
1234
|
* response.</p>
|
|
1235
|
+
* @public
|
|
1236
1236
|
*/
|
|
1237
1237
|
MaxResults?: number;
|
|
1238
1238
|
}
|
|
1239
1239
|
/**
|
|
1240
|
-
* @public
|
|
1241
1240
|
* <p>A list of your dead letter source queues.</p>
|
|
1241
|
+
* @public
|
|
1242
1242
|
*/
|
|
1243
1243
|
export interface ListDeadLetterSourceQueuesResult {
|
|
1244
1244
|
/**
|
|
1245
|
-
* @public
|
|
1246
1245
|
* <p>A list of source queue URLs that have the <code>RedrivePolicy</code> queue attribute
|
|
1247
1246
|
* configured with a dead-letter queue.</p>
|
|
1247
|
+
* @public
|
|
1248
1248
|
*/
|
|
1249
1249
|
queueUrls: string[] | undefined;
|
|
1250
1250
|
/**
|
|
1251
|
-
* @public
|
|
1252
1251
|
* <p>Pagination token to include in the next request. Token value is <code>null</code> if
|
|
1253
1252
|
* there are no additional results to request, or if you did not set
|
|
1254
1253
|
* <code>MaxResults</code> in the request.</p>
|
|
1254
|
+
* @public
|
|
1255
1255
|
*/
|
|
1256
1256
|
NextToken?: string;
|
|
1257
1257
|
}
|
|
@@ -1260,75 +1260,75 @@ export interface ListDeadLetterSourceQueuesResult {
|
|
|
1260
1260
|
*/
|
|
1261
1261
|
export interface ListMessageMoveTasksRequest {
|
|
1262
1262
|
/**
|
|
1263
|
-
* @public
|
|
1264
1263
|
* <p>The ARN of the queue whose message movement tasks are to be listed.</p>
|
|
1264
|
+
* @public
|
|
1265
1265
|
*/
|
|
1266
1266
|
SourceArn: string | undefined;
|
|
1267
1267
|
/**
|
|
1268
|
-
* @public
|
|
1269
1268
|
* <p>The maximum number of results to include in the response. The default is 1, which
|
|
1270
1269
|
* provides the most recent message movement task. The upper limit is 10.</p>
|
|
1270
|
+
* @public
|
|
1271
1271
|
*/
|
|
1272
1272
|
MaxResults?: number;
|
|
1273
1273
|
}
|
|
1274
1274
|
/**
|
|
1275
|
-
* @public
|
|
1276
1275
|
* <p>Contains the details of a message movement task. </p>
|
|
1276
|
+
* @public
|
|
1277
1277
|
*/
|
|
1278
1278
|
export interface ListMessageMoveTasksResultEntry {
|
|
1279
1279
|
/**
|
|
1280
|
-
* @public
|
|
1281
1280
|
* <p>An identifier associated with a message movement task. When this field is returned in
|
|
1282
1281
|
* the response of the <code>ListMessageMoveTasks</code> action, it is only populated for
|
|
1283
1282
|
* tasks that are in RUNNING status.</p>
|
|
1283
|
+
* @public
|
|
1284
1284
|
*/
|
|
1285
1285
|
TaskHandle?: string;
|
|
1286
1286
|
/**
|
|
1287
|
-
* @public
|
|
1288
1287
|
* <p>The status of the message movement task. Possible values are: RUNNING, COMPLETED,
|
|
1289
1288
|
* CANCELLING, CANCELLED, and FAILED.</p>
|
|
1289
|
+
* @public
|
|
1290
1290
|
*/
|
|
1291
1291
|
Status?: string;
|
|
1292
1292
|
/**
|
|
1293
|
-
* @public
|
|
1294
1293
|
* <p>The ARN of the queue that contains the messages to be moved to another queue.</p>
|
|
1294
|
+
* @public
|
|
1295
1295
|
*/
|
|
1296
1296
|
SourceArn?: string;
|
|
1297
1297
|
/**
|
|
1298
|
-
* @public
|
|
1299
1298
|
* <p>The ARN of the destination queue if it has been specified in the
|
|
1300
1299
|
* <code>StartMessageMoveTask</code> request. If a <code>DestinationArn</code> has not
|
|
1301
1300
|
* been specified in the <code>StartMessageMoveTask</code> request, this field value will
|
|
1302
1301
|
* be NULL.</p>
|
|
1302
|
+
* @public
|
|
1303
1303
|
*/
|
|
1304
1304
|
DestinationArn?: string;
|
|
1305
1305
|
/**
|
|
1306
|
-
* @public
|
|
1307
1306
|
* <p>The number of messages to be moved per second (the message movement rate), if it has
|
|
1308
1307
|
* been specified in the <code>StartMessageMoveTask</code> request. If a
|
|
1309
1308
|
* <code>MaxNumberOfMessagesPerSecond</code> has not been specified in the
|
|
1310
1309
|
* <code>StartMessageMoveTask</code> request, this field value will be NULL.</p>
|
|
1310
|
+
* @public
|
|
1311
1311
|
*/
|
|
1312
1312
|
MaxNumberOfMessagesPerSecond?: number;
|
|
1313
1313
|
/**
|
|
1314
|
-
* @public
|
|
1315
1314
|
* <p>The approximate number of messages already moved to the destination queue.</p>
|
|
1315
|
+
* @public
|
|
1316
1316
|
*/
|
|
1317
1317
|
ApproximateNumberOfMessagesMoved?: number;
|
|
1318
1318
|
/**
|
|
1319
|
-
* @public
|
|
1320
1319
|
* <p>The number of messages to be moved from the source queue. This number is obtained at
|
|
1321
1320
|
* the time of starting the message movement task.</p>
|
|
1321
|
+
* @public
|
|
1322
1322
|
*/
|
|
1323
1323
|
ApproximateNumberOfMessagesToMove?: number;
|
|
1324
1324
|
/**
|
|
1325
|
-
* @public
|
|
1326
1325
|
* <p>The task failure reason (only included if the task status is FAILED).</p>
|
|
1326
|
+
* @public
|
|
1327
1327
|
*/
|
|
1328
1328
|
FailureReason?: string;
|
|
1329
1329
|
/**
|
|
1330
|
-
* @public
|
|
1331
1330
|
* <p>The timestamp of starting the message movement task.</p>
|
|
1331
|
+
* @public
|
|
1332
1332
|
*/
|
|
1333
1333
|
StartedTimestamp?: number;
|
|
1334
1334
|
}
|
|
@@ -1337,52 +1337,52 @@ export interface ListMessageMoveTasksResultEntry {
|
|
|
1337
1337
|
*/
|
|
1338
1338
|
export interface ListMessageMoveTasksResult {
|
|
1339
1339
|
/**
|
|
1340
|
-
* @public
|
|
1341
1340
|
* <p>A list of message movement tasks and their attributes.</p>
|
|
1341
|
+
* @public
|
|
1342
1342
|
*/
|
|
1343
1343
|
Results?: ListMessageMoveTasksResultEntry[];
|
|
1344
1344
|
}
|
|
1345
1345
|
/**
|
|
1346
|
-
* @public
|
|
1347
1346
|
* <p></p>
|
|
1347
|
+
* @public
|
|
1348
1348
|
*/
|
|
1349
1349
|
export interface ListQueuesRequest {
|
|
1350
1350
|
/**
|
|
1351
|
-
* @public
|
|
1352
1351
|
* <p>A string to use for filtering the list results. Only those queues whose name begins
|
|
1353
1352
|
* with the specified string are returned.</p>
|
|
1354
1353
|
* <p>Queue URLs and names are case-sensitive.</p>
|
|
1354
|
+
* @public
|
|
1355
1355
|
*/
|
|
1356
1356
|
QueueNamePrefix?: string;
|
|
1357
1357
|
/**
|
|
1358
|
-
* @public
|
|
1359
1358
|
* <p>Pagination token to request the next set of results.</p>
|
|
1359
|
+
* @public
|
|
1360
1360
|
*/
|
|
1361
1361
|
NextToken?: string;
|
|
1362
1362
|
/**
|
|
1363
|
-
* @public
|
|
1364
1363
|
* <p>Maximum number of results to include in the response. Value range is 1 to 1000. You
|
|
1365
1364
|
* must set <code>MaxResults</code> to receive a value for <code>NextToken</code> in the
|
|
1366
1365
|
* response.</p>
|
|
1366
|
+
* @public
|
|
1367
1367
|
*/
|
|
1368
1368
|
MaxResults?: number;
|
|
1369
1369
|
}
|
|
1370
1370
|
/**
|
|
1371
|
-
* @public
|
|
1372
1371
|
* <p>A list of your queues.</p>
|
|
1372
|
+
* @public
|
|
1373
1373
|
*/
|
|
1374
1374
|
export interface ListQueuesResult {
|
|
1375
1375
|
/**
|
|
1376
|
-
* @public
|
|
1377
1376
|
* <p>A list of queue URLs, up to 1,000 entries, or the value of <code>MaxResults</code>
|
|
1378
1377
|
* that you sent in the request.</p>
|
|
1378
|
+
* @public
|
|
1379
1379
|
*/
|
|
1380
1380
|
QueueUrls?: string[];
|
|
1381
1381
|
/**
|
|
1382
|
-
* @public
|
|
1383
1382
|
* <p>Pagination token to include in the next request. Token value is <code>null</code> if
|
|
1384
1383
|
* there are no additional results to request, or if you did not set
|
|
1385
1384
|
* <code>MaxResults</code> in the request.</p>
|
|
1385
|
+
* @public
|
|
1386
1386
|
*/
|
|
1387
1387
|
NextToken?: string;
|
|
1388
1388
|
}
|
|
@@ -1391,8 +1391,8 @@ export interface ListQueuesResult {
|
|
|
1391
1391
|
*/
|
|
1392
1392
|
export interface ListQueueTagsRequest {
|
|
1393
1393
|
/**
|
|
1394
|
-
* @public
|
|
1395
1394
|
* <p>The URL of the queue.</p>
|
|
1395
|
+
* @public
|
|
1396
1396
|
*/
|
|
1397
1397
|
QueueUrl: string | undefined;
|
|
1398
1398
|
}
|
|
@@ -1401,16 +1401,16 @@ export interface ListQueueTagsRequest {
|
|
|
1401
1401
|
*/
|
|
1402
1402
|
export interface ListQueueTagsResult {
|
|
1403
1403
|
/**
|
|
1404
|
-
* @public
|
|
1405
1404
|
* <p>The list of all tags added to the specified queue.</p>
|
|
1405
|
+
* @public
|
|
1406
1406
|
*/
|
|
1407
1407
|
Tags?: Record<string, string>;
|
|
1408
1408
|
}
|
|
1409
1409
|
/**
|
|
1410
|
-
* @public
|
|
1411
1410
|
* <p>Indicates that the specified queue previously received a <code>PurgeQueue</code>
|
|
1412
1411
|
* request within the last 60 seconds (the time it can take to delete the messages in the
|
|
1413
1412
|
* queue).</p>
|
|
1413
|
+
* @public
|
|
1414
1414
|
*/
|
|
1415
1415
|
export declare class PurgeQueueInProgress extends __BaseException {
|
|
1416
1416
|
readonly name: "PurgeQueueInProgress";
|
|
@@ -1421,21 +1421,21 @@ export declare class PurgeQueueInProgress extends __BaseException {
|
|
|
1421
1421
|
constructor(opts: __ExceptionOptionType<PurgeQueueInProgress, __BaseException>);
|
|
1422
1422
|
}
|
|
1423
1423
|
/**
|
|
1424
|
-
* @public
|
|
1425
1424
|
* <p></p>
|
|
1425
|
+
* @public
|
|
1426
1426
|
*/
|
|
1427
1427
|
export interface PurgeQueueRequest {
|
|
1428
1428
|
/**
|
|
1429
|
-
* @public
|
|
1430
1429
|
* <p>The URL of the queue from which the <code>PurgeQueue</code> action deletes
|
|
1431
1430
|
* messages.</p>
|
|
1432
1431
|
* <p>Queue URLs and names are case-sensitive.</p>
|
|
1432
|
+
* @public
|
|
1433
1433
|
*/
|
|
1434
1434
|
QueueUrl: string | undefined;
|
|
1435
1435
|
}
|
|
1436
1436
|
/**
|
|
1437
|
-
* @public
|
|
1438
1437
|
* <p>The caller doesn't have the required KMS access.</p>
|
|
1438
|
+
* @public
|
|
1439
1439
|
*/
|
|
1440
1440
|
export declare class KmsAccessDenied extends __BaseException {
|
|
1441
1441
|
readonly name: "KmsAccessDenied";
|
|
@@ -1446,8 +1446,8 @@ export declare class KmsAccessDenied extends __BaseException {
|
|
|
1446
1446
|
constructor(opts: __ExceptionOptionType<KmsAccessDenied, __BaseException>);
|
|
1447
1447
|
}
|
|
1448
1448
|
/**
|
|
1449
|
-
* @public
|
|
1450
1449
|
* <p>The request was denied due to request throttling.</p>
|
|
1450
|
+
* @public
|
|
1451
1451
|
*/
|
|
1452
1452
|
export declare class KmsDisabled extends __BaseException {
|
|
1453
1453
|
readonly name: "KmsDisabled";
|
|
@@ -1458,7 +1458,6 @@ export declare class KmsDisabled extends __BaseException {
|
|
|
1458
1458
|
constructor(opts: __ExceptionOptionType<KmsDisabled, __BaseException>);
|
|
1459
1459
|
}
|
|
1460
1460
|
/**
|
|
1461
|
-
* @public
|
|
1462
1461
|
* <p>The request was rejected for one of the following reasons:</p>
|
|
1463
1462
|
* <ul>
|
|
1464
1463
|
* <li>
|
|
@@ -1470,6 +1469,7 @@ export declare class KmsDisabled extends __BaseException {
|
|
|
1470
1469
|
* incompatible with the type of key material in the KMS key (KeySpec).</p>
|
|
1471
1470
|
* </li>
|
|
1472
1471
|
* </ul>
|
|
1472
|
+
* @public
|
|
1473
1473
|
*/
|
|
1474
1474
|
export declare class KmsInvalidKeyUsage extends __BaseException {
|
|
1475
1475
|
readonly name: "KmsInvalidKeyUsage";
|
|
@@ -1480,9 +1480,9 @@ export declare class KmsInvalidKeyUsage extends __BaseException {
|
|
|
1480
1480
|
constructor(opts: __ExceptionOptionType<KmsInvalidKeyUsage, __BaseException>);
|
|
1481
1481
|
}
|
|
1482
1482
|
/**
|
|
1483
|
-
* @public
|
|
1484
1483
|
* <p>The request was rejected because the state of the specified resource is not valid for
|
|
1485
1484
|
* this request.</p>
|
|
1485
|
+
* @public
|
|
1486
1486
|
*/
|
|
1487
1487
|
export declare class KmsInvalidState extends __BaseException {
|
|
1488
1488
|
readonly name: "KmsInvalidState";
|
|
@@ -1493,9 +1493,9 @@ export declare class KmsInvalidState extends __BaseException {
|
|
|
1493
1493
|
constructor(opts: __ExceptionOptionType<KmsInvalidState, __BaseException>);
|
|
1494
1494
|
}
|
|
1495
1495
|
/**
|
|
1496
|
-
* @public
|
|
1497
1496
|
* <p>The request was rejected because the specified entity or resource could not be found.
|
|
1498
1497
|
* </p>
|
|
1498
|
+
* @public
|
|
1499
1499
|
*/
|
|
1500
1500
|
export declare class KmsNotFound extends __BaseException {
|
|
1501
1501
|
readonly name: "KmsNotFound";
|
|
@@ -1506,9 +1506,9 @@ export declare class KmsNotFound extends __BaseException {
|
|
|
1506
1506
|
constructor(opts: __ExceptionOptionType<KmsNotFound, __BaseException>);
|
|
1507
1507
|
}
|
|
1508
1508
|
/**
|
|
1509
|
-
* @public
|
|
1510
1509
|
* <p>The request was rejected because the specified key policy isn't syntactically or
|
|
1511
1510
|
* semantically correct.</p>
|
|
1511
|
+
* @public
|
|
1512
1512
|
*/
|
|
1513
1513
|
export declare class KmsOptInRequired extends __BaseException {
|
|
1514
1514
|
readonly name: "KmsOptInRequired";
|
|
@@ -1519,8 +1519,8 @@ export declare class KmsOptInRequired extends __BaseException {
|
|
|
1519
1519
|
constructor(opts: __ExceptionOptionType<KmsOptInRequired, __BaseException>);
|
|
1520
1520
|
}
|
|
1521
1521
|
/**
|
|
1522
|
-
* @public
|
|
1523
1522
|
* <p>Amazon Web Services KMS throttles requests for the following conditions.</p>
|
|
1523
|
+
* @public
|
|
1524
1524
|
*/
|
|
1525
1525
|
export declare class KmsThrottled extends __BaseException {
|
|
1526
1526
|
readonly name: "KmsThrottled";
|
|
@@ -1531,18 +1531,17 @@ export declare class KmsThrottled extends __BaseException {
|
|
|
1531
1531
|
constructor(opts: __ExceptionOptionType<KmsThrottled, __BaseException>);
|
|
1532
1532
|
}
|
|
1533
1533
|
/**
|
|
1534
|
-
* @public
|
|
1535
1534
|
* <p></p>
|
|
1535
|
+
* @public
|
|
1536
1536
|
*/
|
|
1537
1537
|
export interface ReceiveMessageRequest {
|
|
1538
1538
|
/**
|
|
1539
|
-
* @public
|
|
1540
1539
|
* <p>The URL of the Amazon SQS queue from which messages are received.</p>
|
|
1541
1540
|
* <p>Queue URLs and names are case-sensitive.</p>
|
|
1541
|
+
* @public
|
|
1542
1542
|
*/
|
|
1543
1543
|
QueueUrl: string | undefined;
|
|
1544
1544
|
/**
|
|
1545
|
-
* @public
|
|
1546
1545
|
* <p>A list of attributes that need to be returned along with each message. These
|
|
1547
1546
|
* attributes include:</p>
|
|
1548
1547
|
* <ul>
|
|
@@ -1614,10 +1613,10 @@ export interface ReceiveMessageRequest {
|
|
|
1614
1613
|
* <code>SequenceNumber</code> – Returns the value provided by Amazon SQS.</p>
|
|
1615
1614
|
* </li>
|
|
1616
1615
|
* </ul>
|
|
1616
|
+
* @public
|
|
1617
1617
|
*/
|
|
1618
1618
|
AttributeNames?: QueueAttributeName[];
|
|
1619
1619
|
/**
|
|
1620
|
-
* @public
|
|
1621
1620
|
* <p>The name of the message attribute, where <i>N</i> is the index.</p>
|
|
1622
1621
|
* <ul>
|
|
1623
1622
|
* <li>
|
|
@@ -1645,23 +1644,23 @@ export interface ReceiveMessageRequest {
|
|
|
1645
1644
|
* receive, or you can return all of the attributes by specifying <code>All</code> or
|
|
1646
1645
|
* <code>.*</code> in your request. You can also use all message attributes starting
|
|
1647
1646
|
* with a prefix, for example <code>bar.*</code>.</p>
|
|
1647
|
+
* @public
|
|
1648
1648
|
*/
|
|
1649
1649
|
MessageAttributeNames?: string[];
|
|
1650
1650
|
/**
|
|
1651
|
-
* @public
|
|
1652
1651
|
* <p>The maximum number of messages to return. Amazon SQS never returns more messages than
|
|
1653
1652
|
* this value (however, fewer messages might be returned). Valid values: 1 to 10. Default:
|
|
1654
1653
|
* 1.</p>
|
|
1654
|
+
* @public
|
|
1655
1655
|
*/
|
|
1656
1656
|
MaxNumberOfMessages?: number;
|
|
1657
1657
|
/**
|
|
1658
|
-
* @public
|
|
1659
1658
|
* <p>The duration (in seconds) that the received messages are hidden from subsequent
|
|
1660
1659
|
* retrieve requests after being retrieved by a <code>ReceiveMessage</code> request.</p>
|
|
1660
|
+
* @public
|
|
1661
1661
|
*/
|
|
1662
1662
|
VisibilityTimeout?: number;
|
|
1663
1663
|
/**
|
|
1664
|
-
* @public
|
|
1665
1664
|
* <p>The duration (in seconds) for which the call waits for a message to arrive in the
|
|
1666
1665
|
* queue before returning. If a message is available, the call returns sooner than
|
|
1667
1666
|
* <code>WaitTimeSeconds</code>. If no messages are available and the wait time
|
|
@@ -1672,10 +1671,10 @@ export interface ReceiveMessageRequest {
|
|
|
1672
1671
|
* <code>WaitTimeSeconds</code> parameter. For example, with the Java SDK, you can
|
|
1673
1672
|
* 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>
|
|
1674
1673
|
* </important>
|
|
1674
|
+
* @public
|
|
1675
1675
|
*/
|
|
1676
1676
|
WaitTimeSeconds?: number;
|
|
1677
1677
|
/**
|
|
1678
|
-
* @public
|
|
1679
1678
|
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
|
|
1680
1679
|
* <p>The token used for deduplication of <code>ReceiveMessage</code> calls. If a networking
|
|
1681
1680
|
* issue occurs after a <code>ReceiveMessage</code> action, and instead of a response you
|
|
@@ -1739,6 +1738,7 @@ export interface ReceiveMessageRequest {
|
|
|
1739
1738
|
* (<code>!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~</code>).</p>
|
|
1740
1739
|
* <p>For best practices of using <code>ReceiveRequestAttemptId</code>, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-receiverequestattemptid-request-parameter.html">Using the ReceiveRequestAttemptId Request Parameter</a> in the <i>Amazon
|
|
1741
1740
|
* SQS Developer Guide</i>.</p>
|
|
1741
|
+
* @public
|
|
1742
1742
|
*/
|
|
1743
1743
|
ReceiveRequestAttemptId?: string;
|
|
1744
1744
|
}
|
|
@@ -1762,7 +1762,6 @@ export declare const MessageSystemAttributeName: {
|
|
|
1762
1762
|
*/
|
|
1763
1763
|
export type MessageSystemAttributeName = (typeof MessageSystemAttributeName)[keyof typeof MessageSystemAttributeName];
|
|
1764
1764
|
/**
|
|
1765
|
-
* @public
|
|
1766
1765
|
* <p>The user-specified message attribute value. For string data types, the
|
|
1767
1766
|
* <code>Value</code> attribute has the same restrictions on the content as the message
|
|
1768
1767
|
* body. For more information, see <code>
|
|
@@ -1773,70 +1772,70 @@ export type MessageSystemAttributeName = (typeof MessageSystemAttributeName)[key
|
|
|
1773
1772
|
* be empty or null. All parts of the message attribute, including <code>Name</code>,
|
|
1774
1773
|
* <code>Type</code>, and <code>Value</code>, are part of the message size restriction
|
|
1775
1774
|
* (256 KiB or 262,144 bytes).</p>
|
|
1775
|
+
* @public
|
|
1776
1776
|
*/
|
|
1777
1777
|
export interface MessageAttributeValue {
|
|
1778
1778
|
/**
|
|
1779
|
-
* @public
|
|
1780
1779
|
* <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
|
|
1781
1780
|
* Characters</a>.</p>
|
|
1781
|
+
* @public
|
|
1782
1782
|
*/
|
|
1783
1783
|
StringValue?: string;
|
|
1784
1784
|
/**
|
|
1785
|
-
* @public
|
|
1786
1785
|
* <p>Binary type attributes can store any binary data, such as compressed data, encrypted
|
|
1787
1786
|
* data, or images.</p>
|
|
1787
|
+
* @public
|
|
1788
1788
|
*/
|
|
1789
1789
|
BinaryValue?: Uint8Array;
|
|
1790
1790
|
/**
|
|
1791
|
-
* @public
|
|
1792
1791
|
* <p>Not implemented. Reserved for future use.</p>
|
|
1792
|
+
* @public
|
|
1793
1793
|
*/
|
|
1794
1794
|
StringListValues?: string[];
|
|
1795
1795
|
/**
|
|
1796
|
-
* @public
|
|
1797
1796
|
* <p>Not implemented. Reserved for future use.</p>
|
|
1797
|
+
* @public
|
|
1798
1798
|
*/
|
|
1799
1799
|
BinaryListValues?: Uint8Array[];
|
|
1800
1800
|
/**
|
|
1801
|
-
* @public
|
|
1802
1801
|
* <p>Amazon SQS supports the following logical data types: <code>String</code>,
|
|
1803
1802
|
* <code>Number</code>, and <code>Binary</code>. For the <code>Number</code> data type,
|
|
1804
1803
|
* you must use <code>StringValue</code>.</p>
|
|
1805
1804
|
* <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
|
|
1806
1805
|
* Guide</i>.</p>
|
|
1806
|
+
* @public
|
|
1807
1807
|
*/
|
|
1808
1808
|
DataType: string | undefined;
|
|
1809
1809
|
}
|
|
1810
1810
|
/**
|
|
1811
|
-
* @public
|
|
1812
1811
|
* <p>An Amazon SQS message.</p>
|
|
1812
|
+
* @public
|
|
1813
1813
|
*/
|
|
1814
1814
|
export interface Message {
|
|
1815
1815
|
/**
|
|
1816
|
-
* @public
|
|
1817
1816
|
* <p>A unique identifier for the message. A <code>MessageId</code>is considered unique
|
|
1818
1817
|
* across all Amazon Web Services accounts for an extended period of time.</p>
|
|
1818
|
+
* @public
|
|
1819
1819
|
*/
|
|
1820
1820
|
MessageId?: string;
|
|
1821
1821
|
/**
|
|
1822
|
-
* @public
|
|
1823
1822
|
* <p>An identifier associated with the act of receiving the message. A new receipt handle
|
|
1824
1823
|
* is returned every time you receive a message. When deleting a message, you provide the
|
|
1825
1824
|
* last received receipt handle to delete the message.</p>
|
|
1825
|
+
* @public
|
|
1826
1826
|
*/
|
|
1827
1827
|
ReceiptHandle?: string;
|
|
1828
1828
|
/**
|
|
1829
|
-
* @public
|
|
1830
1829
|
* <p>An MD5 digest of the non-URL-encoded message body string.</p>
|
|
1830
|
+
* @public
|
|
1831
1831
|
*/
|
|
1832
1832
|
MD5OfBody?: string;
|
|
1833
1833
|
/**
|
|
1834
|
-
* @public
|
|
1835
1834
|
* <p>The message's contents (not URL-encoded).</p>
|
|
1835
|
+
* @public
|
|
1836
1836
|
*/
|
|
1837
1837
|
Body?: string;
|
|
1838
1838
|
/**
|
|
1839
|
-
* @public
|
|
1840
1839
|
* <p>A map of the attributes requested in <code>
|
|
1841
1840
|
* <a>ReceiveMessage</a>
|
|
1842
1841
|
* </code> to
|
|
@@ -1882,58 +1881,59 @@ export interface Message {
|
|
|
1882
1881
|
* <code>ApproximateFirstReceiveTimestamp</code> and <code>SentTimestamp</code> are each
|
|
1883
1882
|
* returned as an integer representing the <a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a> in
|
|
1884
1883
|
* milliseconds.</p>
|
|
1884
|
+
* @public
|
|
1885
1885
|
*/
|
|
1886
1886
|
Attributes?: Partial<Record<MessageSystemAttributeName, string>>;
|
|
1887
1887
|
/**
|
|
1888
|
-
* @public
|
|
1889
1888
|
* <p>An MD5 digest of the non-URL-encoded message attribute string. You can use this
|
|
1890
1889
|
* attribute to verify that Amazon SQS received the message correctly. Amazon SQS
|
|
1891
1890
|
* URL-decodes the message before creating the MD5 digest. For information about MD5, see
|
|
1892
1891
|
* <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
|
|
1892
|
+
* @public
|
|
1893
1893
|
*/
|
|
1894
1894
|
MD5OfMessageAttributes?: string;
|
|
1895
1895
|
/**
|
|
1896
|
-
* @public
|
|
1897
1896
|
* <p>Each message attribute consists of a <code>Name</code>, <code>Type</code>, and
|
|
1898
1897
|
* <code>Value</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes">Amazon SQS message attributes</a> in the <i>Amazon SQS Developer
|
|
1899
1898
|
* Guide</i>.</p>
|
|
1899
|
+
* @public
|
|
1900
1900
|
*/
|
|
1901
1901
|
MessageAttributes?: Record<string, MessageAttributeValue>;
|
|
1902
1902
|
}
|
|
1903
1903
|
/**
|
|
1904
|
-
* @public
|
|
1905
1904
|
* <p>A list of received messages.</p>
|
|
1905
|
+
* @public
|
|
1906
1906
|
*/
|
|
1907
1907
|
export interface ReceiveMessageResult {
|
|
1908
1908
|
/**
|
|
1909
|
-
* @public
|
|
1910
1909
|
* <p>A list of messages.</p>
|
|
1910
|
+
* @public
|
|
1911
1911
|
*/
|
|
1912
1912
|
Messages?: Message[];
|
|
1913
1913
|
}
|
|
1914
1914
|
/**
|
|
1915
|
-
* @public
|
|
1916
1915
|
* <p></p>
|
|
1916
|
+
* @public
|
|
1917
1917
|
*/
|
|
1918
1918
|
export interface RemovePermissionRequest {
|
|
1919
1919
|
/**
|
|
1920
|
-
* @public
|
|
1921
1920
|
* <p>The URL of the Amazon SQS queue from which permissions are removed.</p>
|
|
1922
1921
|
* <p>Queue URLs and names are case-sensitive.</p>
|
|
1922
|
+
* @public
|
|
1923
1923
|
*/
|
|
1924
1924
|
QueueUrl: string | undefined;
|
|
1925
1925
|
/**
|
|
1926
|
-
* @public
|
|
1927
1926
|
* <p>The identification of the permission to remove. This is the label added using the
|
|
1928
1927
|
* <code>
|
|
1929
1928
|
* <a>AddPermission</a>
|
|
1930
1929
|
* </code> action.</p>
|
|
1930
|
+
* @public
|
|
1931
1931
|
*/
|
|
1932
1932
|
Label: string | undefined;
|
|
1933
1933
|
}
|
|
1934
1934
|
/**
|
|
1935
|
-
* @public
|
|
1936
1935
|
* <p>The message contains characters outside the allowed set.</p>
|
|
1936
|
+
* @public
|
|
1937
1937
|
*/
|
|
1938
1938
|
export declare class InvalidMessageContents extends __BaseException {
|
|
1939
1939
|
readonly name: "InvalidMessageContents";
|
|
@@ -1955,7 +1955,6 @@ export declare const MessageSystemAttributeNameForSends: {
|
|
|
1955
1955
|
*/
|
|
1956
1956
|
export type MessageSystemAttributeNameForSends = (typeof MessageSystemAttributeNameForSends)[keyof typeof MessageSystemAttributeNameForSends];
|
|
1957
1957
|
/**
|
|
1958
|
-
* @public
|
|
1959
1958
|
* <p>The user-specified message system attribute value. For string data types, the
|
|
1960
1959
|
* <code>Value</code> attribute has the same restrictions on the content as the message
|
|
1961
1960
|
* body. For more information, see <code>
|
|
@@ -1964,53 +1963,53 @@ export type MessageSystemAttributeNameForSends = (typeof MessageSystemAttributeN
|
|
|
1964
1963
|
* <p>
|
|
1965
1964
|
* <code>Name</code>, <code>type</code>, <code>value</code> and the message body must not
|
|
1966
1965
|
* be empty or null.</p>
|
|
1966
|
+
* @public
|
|
1967
1967
|
*/
|
|
1968
1968
|
export interface MessageSystemAttributeValue {
|
|
1969
1969
|
/**
|
|
1970
|
-
* @public
|
|
1971
1970
|
* <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
|
|
1972
1971
|
* Characters</a>.</p>
|
|
1972
|
+
* @public
|
|
1973
1973
|
*/
|
|
1974
1974
|
StringValue?: string;
|
|
1975
1975
|
/**
|
|
1976
|
-
* @public
|
|
1977
1976
|
* <p>Binary type attributes can store any binary data, such as compressed data, encrypted
|
|
1978
1977
|
* data, or images.</p>
|
|
1978
|
+
* @public
|
|
1979
1979
|
*/
|
|
1980
1980
|
BinaryValue?: Uint8Array;
|
|
1981
1981
|
/**
|
|
1982
|
-
* @public
|
|
1983
1982
|
* <p>Not implemented. Reserved for future use.</p>
|
|
1983
|
+
* @public
|
|
1984
1984
|
*/
|
|
1985
1985
|
StringListValues?: string[];
|
|
1986
1986
|
/**
|
|
1987
|
-
* @public
|
|
1988
1987
|
* <p>Not implemented. Reserved for future use.</p>
|
|
1988
|
+
* @public
|
|
1989
1989
|
*/
|
|
1990
1990
|
BinaryListValues?: Uint8Array[];
|
|
1991
1991
|
/**
|
|
1992
|
-
* @public
|
|
1993
1992
|
* <p>Amazon SQS supports the following logical data types: <code>String</code>,
|
|
1994
1993
|
* <code>Number</code>, and <code>Binary</code>. For the <code>Number</code> data type,
|
|
1995
1994
|
* you must use <code>StringValue</code>.</p>
|
|
1996
1995
|
* <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
|
|
1997
1996
|
* Guide</i>.</p>
|
|
1997
|
+
* @public
|
|
1998
1998
|
*/
|
|
1999
1999
|
DataType: string | undefined;
|
|
2000
2000
|
}
|
|
2001
2001
|
/**
|
|
2002
|
-
* @public
|
|
2003
2002
|
* <p></p>
|
|
2003
|
+
* @public
|
|
2004
2004
|
*/
|
|
2005
2005
|
export interface SendMessageRequest {
|
|
2006
2006
|
/**
|
|
2007
|
-
* @public
|
|
2008
2007
|
* <p>The URL of the Amazon SQS queue to which a message is sent.</p>
|
|
2009
2008
|
* <p>Queue URLs and names are case-sensitive.</p>
|
|
2009
|
+
* @public
|
|
2010
2010
|
*/
|
|
2011
2011
|
QueueUrl: string | undefined;
|
|
2012
2012
|
/**
|
|
2013
|
-
* @public
|
|
2014
2013
|
* <p>The message to send. The minimum size is one character. The maximum size is 256
|
|
2015
2014
|
* KiB.</p>
|
|
2016
2015
|
* <important>
|
|
@@ -2025,10 +2024,10 @@ export interface SendMessageRequest {
|
|
|
2025
2024
|
* see the <a href="http://www.w3.org/TR/REC-xml/#charsets">W3C specification for
|
|
2026
2025
|
* characters</a>.</p>
|
|
2027
2026
|
* </important>
|
|
2027
|
+
* @public
|
|
2028
2028
|
*/
|
|
2029
2029
|
MessageBody: string | undefined;
|
|
2030
2030
|
/**
|
|
2031
|
-
* @public
|
|
2032
2031
|
* <p> The length of time, in seconds, for which to delay a specific message. Valid values:
|
|
2033
2032
|
* 0 to 900. Maximum: 15 minutes. Messages with a positive <code>DelaySeconds</code> value
|
|
2034
2033
|
* become available for processing after the delay period is finished. If you don't specify
|
|
@@ -2037,17 +2036,17 @@ export interface SendMessageRequest {
|
|
|
2037
2036
|
* <p>When you set <code>FifoQueue</code>, you can't set <code>DelaySeconds</code> per
|
|
2038
2037
|
* message. You can set this parameter only on a queue level.</p>
|
|
2039
2038
|
* </note>
|
|
2039
|
+
* @public
|
|
2040
2040
|
*/
|
|
2041
2041
|
DelaySeconds?: number;
|
|
2042
2042
|
/**
|
|
2043
|
-
* @public
|
|
2044
2043
|
* <p>Each message attribute consists of a <code>Name</code>, <code>Type</code>, and
|
|
2045
2044
|
* <code>Value</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes">Amazon SQS message attributes</a> in the <i>Amazon SQS Developer
|
|
2046
2045
|
* Guide</i>.</p>
|
|
2046
|
+
* @public
|
|
2047
2047
|
*/
|
|
2048
2048
|
MessageAttributes?: Record<string, MessageAttributeValue>;
|
|
2049
2049
|
/**
|
|
2050
|
-
* @public
|
|
2051
2050
|
* <p>The message system attribute to send. Each message system attribute consists of a
|
|
2052
2051
|
* <code>Name</code>, <code>Type</code>, and <code>Value</code>.</p>
|
|
2053
2052
|
* <important>
|
|
@@ -2064,10 +2063,10 @@ export interface SendMessageRequest {
|
|
|
2064
2063
|
* </li>
|
|
2065
2064
|
* </ul>
|
|
2066
2065
|
* </important>
|
|
2066
|
+
* @public
|
|
2067
2067
|
*/
|
|
2068
2068
|
MessageSystemAttributes?: Partial<Record<MessageSystemAttributeNameForSends, MessageSystemAttributeValue>>;
|
|
2069
2069
|
/**
|
|
2070
|
-
* @public
|
|
2071
2070
|
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
|
|
2072
2071
|
* <p>The token used for deduplication of sent messages. If a message with a particular
|
|
2073
2072
|
* <code>MessageDeduplicationId</code> is sent successfully, any messages sent with the
|
|
@@ -2129,10 +2128,10 @@ export interface SendMessageRequest {
|
|
|
2129
2128
|
* (<code>!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~</code>).</p>
|
|
2130
2129
|
* <p>For best practices of using <code>MessageDeduplicationId</code>, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html">Using the MessageDeduplicationId Property</a> in the <i>Amazon SQS
|
|
2131
2130
|
* Developer Guide</i>.</p>
|
|
2131
|
+
* @public
|
|
2132
2132
|
*/
|
|
2133
2133
|
MessageDeduplicationId?: string;
|
|
2134
2134
|
/**
|
|
2135
|
-
* @public
|
|
2136
2135
|
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
|
|
2137
2136
|
* <p>The tag that specifies that a message belongs to a specific message group. Messages
|
|
2138
2137
|
* that belong to the same message group are processed in a FIFO manner (however, messages
|
|
@@ -2164,55 +2163,56 @@ export interface SendMessageRequest {
|
|
|
2164
2163
|
* <code>MessageGroupId</code> is required for FIFO queues. You can't use it for
|
|
2165
2164
|
* Standard queues.</p>
|
|
2166
2165
|
* </important>
|
|
2166
|
+
* @public
|
|
2167
2167
|
*/
|
|
2168
2168
|
MessageGroupId?: string;
|
|
2169
2169
|
}
|
|
2170
2170
|
/**
|
|
2171
|
-
* @public
|
|
2172
2171
|
* <p>The <code>MD5OfMessageBody</code> and <code>MessageId</code> elements.</p>
|
|
2172
|
+
* @public
|
|
2173
2173
|
*/
|
|
2174
2174
|
export interface SendMessageResult {
|
|
2175
2175
|
/**
|
|
2176
|
-
* @public
|
|
2177
2176
|
* <p>An MD5 digest of the non-URL-encoded message body string. You can use this attribute
|
|
2178
2177
|
* to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the
|
|
2179
2178
|
* message before creating the MD5 digest. For information about MD5, see <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
|
|
2179
|
+
* @public
|
|
2180
2180
|
*/
|
|
2181
2181
|
MD5OfMessageBody?: string;
|
|
2182
2182
|
/**
|
|
2183
|
-
* @public
|
|
2184
2183
|
* <p>An MD5 digest of the non-URL-encoded message attribute string. You can use this
|
|
2185
2184
|
* attribute to verify that Amazon SQS received the message correctly. Amazon SQS
|
|
2186
2185
|
* URL-decodes the message before creating the MD5 digest. For information about MD5, see
|
|
2187
2186
|
* <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
|
|
2187
|
+
* @public
|
|
2188
2188
|
*/
|
|
2189
2189
|
MD5OfMessageAttributes?: string;
|
|
2190
2190
|
/**
|
|
2191
|
-
* @public
|
|
2192
2191
|
* <p>An MD5 digest of the non-URL-encoded message system attribute string. You can use this
|
|
2193
2192
|
* attribute to verify that Amazon SQS received the message correctly. Amazon SQS
|
|
2194
2193
|
* URL-decodes the message before creating the MD5 digest.</p>
|
|
2194
|
+
* @public
|
|
2195
2195
|
*/
|
|
2196
2196
|
MD5OfMessageSystemAttributes?: string;
|
|
2197
2197
|
/**
|
|
2198
|
-
* @public
|
|
2199
2198
|
* <p>An attribute containing the <code>MessageId</code> of the message sent to the queue.
|
|
2200
2199
|
* 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
|
|
2201
2200
|
* Guide</i>. </p>
|
|
2201
|
+
* @public
|
|
2202
2202
|
*/
|
|
2203
2203
|
MessageId?: string;
|
|
2204
2204
|
/**
|
|
2205
|
-
* @public
|
|
2206
2205
|
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
|
|
2207
2206
|
* <p>The large, non-consecutive number that Amazon SQS assigns to each message.</p>
|
|
2208
2207
|
* <p>The length of <code>SequenceNumber</code> is 128 bits. <code>SequenceNumber</code>
|
|
2209
2208
|
* continues to increase for a particular <code>MessageGroupId</code>.</p>
|
|
2209
|
+
* @public
|
|
2210
2210
|
*/
|
|
2211
2211
|
SequenceNumber?: string;
|
|
2212
2212
|
}
|
|
2213
2213
|
/**
|
|
2214
|
-
* @public
|
|
2215
2214
|
* <p>The length of all the messages put together is more than the limit.</p>
|
|
2215
|
+
* @public
|
|
2216
2216
|
*/
|
|
2217
2217
|
export declare class BatchRequestTooLong extends __BaseException {
|
|
2218
2218
|
readonly name: "BatchRequestTooLong";
|
|
@@ -2223,28 +2223,27 @@ export declare class BatchRequestTooLong extends __BaseException {
|
|
|
2223
2223
|
constructor(opts: __ExceptionOptionType<BatchRequestTooLong, __BaseException>);
|
|
2224
2224
|
}
|
|
2225
2225
|
/**
|
|
2226
|
-
* @public
|
|
2227
2226
|
* <p>Contains the details of a single Amazon SQS message along with an
|
|
2228
2227
|
* <code>Id</code>.</p>
|
|
2228
|
+
* @public
|
|
2229
2229
|
*/
|
|
2230
2230
|
export interface SendMessageBatchRequestEntry {
|
|
2231
2231
|
/**
|
|
2232
|
-
* @public
|
|
2233
2232
|
* <p>An identifier for a message in this batch used to communicate the result.</p>
|
|
2234
2233
|
* <note>
|
|
2235
2234
|
* <p>The <code>Id</code>s of a batch request need to be unique within a request.</p>
|
|
2236
2235
|
* <p>This identifier can have up to 80 characters. The following characters are
|
|
2237
2236
|
* accepted: alphanumeric characters, hyphens(-), and underscores (_).</p>
|
|
2238
2237
|
* </note>
|
|
2238
|
+
* @public
|
|
2239
2239
|
*/
|
|
2240
2240
|
Id: string | undefined;
|
|
2241
2241
|
/**
|
|
2242
|
-
* @public
|
|
2243
2242
|
* <p>The body of the message.</p>
|
|
2243
|
+
* @public
|
|
2244
2244
|
*/
|
|
2245
2245
|
MessageBody: string | undefined;
|
|
2246
2246
|
/**
|
|
2247
|
-
* @public
|
|
2248
2247
|
* <p>The length of time, in seconds, for which a specific message is delayed. Valid values:
|
|
2249
2248
|
* 0 to 900. Maximum: 15 minutes. Messages with a positive <code>DelaySeconds</code> value
|
|
2250
2249
|
* become available for processing after the delay period is finished. If you don't specify
|
|
@@ -2253,17 +2252,17 @@ export interface SendMessageBatchRequestEntry {
|
|
|
2253
2252
|
* <p>When you set <code>FifoQueue</code>, you can't set <code>DelaySeconds</code> per
|
|
2254
2253
|
* message. You can set this parameter only on a queue level.</p>
|
|
2255
2254
|
* </note>
|
|
2255
|
+
* @public
|
|
2256
2256
|
*/
|
|
2257
2257
|
DelaySeconds?: number;
|
|
2258
2258
|
/**
|
|
2259
|
-
* @public
|
|
2260
2259
|
* <p>Each message attribute consists of a <code>Name</code>, <code>Type</code>, and
|
|
2261
2260
|
* <code>Value</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes">Amazon SQS message attributes</a> in the <i>Amazon SQS Developer
|
|
2262
2261
|
* Guide</i>.</p>
|
|
2262
|
+
* @public
|
|
2263
2263
|
*/
|
|
2264
2264
|
MessageAttributes?: Record<string, MessageAttributeValue>;
|
|
2265
2265
|
/**
|
|
2266
|
-
* @public
|
|
2267
2266
|
* <p>The message system attribute to send Each message system attribute consists of a
|
|
2268
2267
|
* <code>Name</code>, <code>Type</code>, and <code>Value</code>.</p>
|
|
2269
2268
|
* <important>
|
|
@@ -2280,10 +2279,10 @@ export interface SendMessageBatchRequestEntry {
|
|
|
2280
2279
|
* </li>
|
|
2281
2280
|
* </ul>
|
|
2282
2281
|
* </important>
|
|
2282
|
+
* @public
|
|
2283
2283
|
*/
|
|
2284
2284
|
MessageSystemAttributes?: Partial<Record<MessageSystemAttributeNameForSends, MessageSystemAttributeValue>>;
|
|
2285
2285
|
/**
|
|
2286
|
-
* @public
|
|
2287
2286
|
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
|
|
2288
2287
|
* <p>The token used for deduplication of messages within a 5-minute minimum deduplication
|
|
2289
2288
|
* interval. If a message with a particular <code>MessageDeduplicationId</code> is sent
|
|
@@ -2345,10 +2344,10 @@ export interface SendMessageBatchRequestEntry {
|
|
|
2345
2344
|
* (<code>!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~</code>).</p>
|
|
2346
2345
|
* <p>For best practices of using <code>MessageDeduplicationId</code>, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html">Using the MessageDeduplicationId Property</a> in the <i>Amazon SQS
|
|
2347
2346
|
* Developer Guide</i>.</p>
|
|
2347
|
+
* @public
|
|
2348
2348
|
*/
|
|
2349
2349
|
MessageDeduplicationId?: string;
|
|
2350
2350
|
/**
|
|
2351
|
-
* @public
|
|
2352
2351
|
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
|
|
2353
2352
|
* <p>The tag that specifies that a message belongs to a specific message group. Messages
|
|
2354
2353
|
* that belong to the same message group are processed in a FIFO manner (however, messages
|
|
@@ -2380,79 +2379,79 @@ export interface SendMessageBatchRequestEntry {
|
|
|
2380
2379
|
* <code>MessageGroupId</code> is required for FIFO queues. You can't use it for
|
|
2381
2380
|
* Standard queues.</p>
|
|
2382
2381
|
* </important>
|
|
2382
|
+
* @public
|
|
2383
2383
|
*/
|
|
2384
2384
|
MessageGroupId?: string;
|
|
2385
2385
|
}
|
|
2386
2386
|
/**
|
|
2387
|
-
* @public
|
|
2388
2387
|
* <p></p>
|
|
2388
|
+
* @public
|
|
2389
2389
|
*/
|
|
2390
2390
|
export interface SendMessageBatchRequest {
|
|
2391
2391
|
/**
|
|
2392
|
-
* @public
|
|
2393
2392
|
* <p>The URL of the Amazon SQS queue to which batched messages are sent.</p>
|
|
2394
2393
|
* <p>Queue URLs and names are case-sensitive.</p>
|
|
2394
|
+
* @public
|
|
2395
2395
|
*/
|
|
2396
2396
|
QueueUrl: string | undefined;
|
|
2397
2397
|
/**
|
|
2398
|
-
* @public
|
|
2399
2398
|
* <p>A list of <code>
|
|
2400
2399
|
* <a>SendMessageBatchRequestEntry</a>
|
|
2401
2400
|
* </code> items.</p>
|
|
2401
|
+
* @public
|
|
2402
2402
|
*/
|
|
2403
2403
|
Entries: SendMessageBatchRequestEntry[] | undefined;
|
|
2404
2404
|
}
|
|
2405
2405
|
/**
|
|
2406
|
-
* @public
|
|
2407
2406
|
* <p>Encloses a <code>MessageId</code> for a successfully-enqueued message in a <code>
|
|
2408
2407
|
* <a>SendMessageBatch</a>.</code>
|
|
2409
2408
|
* </p>
|
|
2409
|
+
* @public
|
|
2410
2410
|
*/
|
|
2411
2411
|
export interface SendMessageBatchResultEntry {
|
|
2412
2412
|
/**
|
|
2413
|
-
* @public
|
|
2414
2413
|
* <p>An identifier for the message in this batch.</p>
|
|
2414
|
+
* @public
|
|
2415
2415
|
*/
|
|
2416
2416
|
Id: string | undefined;
|
|
2417
2417
|
/**
|
|
2418
|
-
* @public
|
|
2419
2418
|
* <p>An identifier for the message.</p>
|
|
2419
|
+
* @public
|
|
2420
2420
|
*/
|
|
2421
2421
|
MessageId: string | undefined;
|
|
2422
2422
|
/**
|
|
2423
|
-
* @public
|
|
2424
2423
|
* <p>An MD5 digest of the non-URL-encoded message body string. You can use this attribute
|
|
2425
2424
|
* to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the
|
|
2426
2425
|
* message before creating the MD5 digest. For information about MD5, see <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
|
|
2426
|
+
* @public
|
|
2427
2427
|
*/
|
|
2428
2428
|
MD5OfMessageBody: string | undefined;
|
|
2429
2429
|
/**
|
|
2430
|
-
* @public
|
|
2431
2430
|
* <p>An MD5 digest of the non-URL-encoded message attribute string. You can use this
|
|
2432
2431
|
* attribute to verify that Amazon SQS received the message correctly. Amazon SQS
|
|
2433
2432
|
* URL-decodes the message before creating the MD5 digest. For information about MD5, see
|
|
2434
2433
|
* <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
|
|
2434
|
+
* @public
|
|
2435
2435
|
*/
|
|
2436
2436
|
MD5OfMessageAttributes?: string;
|
|
2437
2437
|
/**
|
|
2438
|
-
* @public
|
|
2439
2438
|
* <p>An MD5 digest of the non-URL-encoded message system attribute string. You can use this
|
|
2440
2439
|
* attribute to verify that Amazon SQS received the message correctly. Amazon SQS
|
|
2441
2440
|
* URL-decodes the message before creating the MD5 digest. For information about MD5, see
|
|
2442
2441
|
* <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
|
|
2442
|
+
* @public
|
|
2443
2443
|
*/
|
|
2444
2444
|
MD5OfMessageSystemAttributes?: string;
|
|
2445
2445
|
/**
|
|
2446
|
-
* @public
|
|
2447
2446
|
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
|
|
2448
2447
|
* <p>The large, non-consecutive number that Amazon SQS assigns to each message.</p>
|
|
2449
2448
|
* <p>The length of <code>SequenceNumber</code> is 128 bits. As <code>SequenceNumber</code>
|
|
2450
2449
|
* continues to increase for a particular <code>MessageGroupId</code>.</p>
|
|
2450
|
+
* @public
|
|
2451
2451
|
*/
|
|
2452
2452
|
SequenceNumber?: string;
|
|
2453
2453
|
}
|
|
2454
2454
|
/**
|
|
2455
|
-
* @public
|
|
2456
2455
|
* <p>For each message in the batch, the response contains a <code>
|
|
2457
2456
|
* <a>SendMessageBatchResultEntry</a>
|
|
2458
2457
|
* </code> tag if the message succeeds or a
|
|
@@ -2460,37 +2459,37 @@ export interface SendMessageBatchResultEntry {
|
|
|
2460
2459
|
* <a>BatchResultErrorEntry</a>
|
|
2461
2460
|
* </code> tag if the message
|
|
2462
2461
|
* fails.</p>
|
|
2462
|
+
* @public
|
|
2463
2463
|
*/
|
|
2464
2464
|
export interface SendMessageBatchResult {
|
|
2465
2465
|
/**
|
|
2466
|
-
* @public
|
|
2467
2466
|
* <p>A list of <code>
|
|
2468
2467
|
* <a>SendMessageBatchResultEntry</a>
|
|
2469
2468
|
* </code> items.</p>
|
|
2469
|
+
* @public
|
|
2470
2470
|
*/
|
|
2471
2471
|
Successful: SendMessageBatchResultEntry[] | undefined;
|
|
2472
2472
|
/**
|
|
2473
|
-
* @public
|
|
2474
2473
|
* <p>A list of <code>
|
|
2475
2474
|
* <a>BatchResultErrorEntry</a>
|
|
2476
2475
|
* </code> items with error
|
|
2477
2476
|
* details about each message that can't be enqueued.</p>
|
|
2477
|
+
* @public
|
|
2478
2478
|
*/
|
|
2479
2479
|
Failed: BatchResultErrorEntry[] | undefined;
|
|
2480
2480
|
}
|
|
2481
2481
|
/**
|
|
2482
|
-
* @public
|
|
2483
2482
|
* <p></p>
|
|
2483
|
+
* @public
|
|
2484
2484
|
*/
|
|
2485
2485
|
export interface SetQueueAttributesRequest {
|
|
2486
2486
|
/**
|
|
2487
|
-
* @public
|
|
2488
2487
|
* <p>The URL of the Amazon SQS queue whose attributes are set.</p>
|
|
2489
2488
|
* <p>Queue URLs and names are case-sensitive.</p>
|
|
2489
|
+
* @public
|
|
2490
2490
|
*/
|
|
2491
2491
|
QueueUrl: string | undefined;
|
|
2492
2492
|
/**
|
|
2493
|
-
* @public
|
|
2494
2493
|
* <p>A map of attributes to set.</p>
|
|
2495
2494
|
* <p>The following lists the names, descriptions, and values of the special request
|
|
2496
2495
|
* parameters that the <code>SetQueueAttributes</code> action uses:</p>
|
|
@@ -2733,6 +2732,7 @@ export interface SetQueueAttributesRequest {
|
|
|
2733
2732
|
* <p>For information on throughput quotas, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html">Quotas
|
|
2734
2733
|
* related to messages</a> in the <i>Amazon SQS Developer
|
|
2735
2734
|
* Guide</i>.</p>
|
|
2735
|
+
* @public
|
|
2736
2736
|
*/
|
|
2737
2737
|
Attributes: Partial<Record<QueueAttributeName, string>> | undefined;
|
|
2738
2738
|
}
|
|
@@ -2741,28 +2741,28 @@ export interface SetQueueAttributesRequest {
|
|
|
2741
2741
|
*/
|
|
2742
2742
|
export interface StartMessageMoveTaskRequest {
|
|
2743
2743
|
/**
|
|
2744
|
-
* @public
|
|
2745
2744
|
* <p>The ARN of the queue that contains the messages to be moved to another queue.
|
|
2746
2745
|
* Currently, only ARNs of dead-letter queues (DLQs) whose sources are other Amazon SQS queues
|
|
2747
2746
|
* are accepted. DLQs whose sources are non-SQS queues, such as Lambda or Amazon SNS topics, are
|
|
2748
2747
|
* not currently supported.</p>
|
|
2748
|
+
* @public
|
|
2749
2749
|
*/
|
|
2750
2750
|
SourceArn: string | undefined;
|
|
2751
2751
|
/**
|
|
2752
|
-
* @public
|
|
2753
2752
|
* <p>The ARN of the queue that receives the moved messages. You can use this field to
|
|
2754
2753
|
* specify the destination queue where you would like to redrive messages. If this field is
|
|
2755
2754
|
* left blank, the messages will be redriven back to their respective original source
|
|
2756
2755
|
* queues.</p>
|
|
2756
|
+
* @public
|
|
2757
2757
|
*/
|
|
2758
2758
|
DestinationArn?: string;
|
|
2759
2759
|
/**
|
|
2760
|
-
* @public
|
|
2761
2760
|
* <p>The number of messages to be moved per second (the message movement rate). You can use
|
|
2762
2761
|
* this field to define a fixed message movement rate. The maximum value for messages per
|
|
2763
2762
|
* second is 500. If this field is left blank, the system will optimize the rate based on
|
|
2764
2763
|
* the queue message backlog size, which may vary throughout the duration of the message
|
|
2765
2764
|
* movement task.</p>
|
|
2765
|
+
* @public
|
|
2766
2766
|
*/
|
|
2767
2767
|
MaxNumberOfMessagesPerSecond?: number;
|
|
2768
2768
|
}
|
|
@@ -2771,10 +2771,10 @@ export interface StartMessageMoveTaskRequest {
|
|
|
2771
2771
|
*/
|
|
2772
2772
|
export interface StartMessageMoveTaskResult {
|
|
2773
2773
|
/**
|
|
2774
|
-
* @public
|
|
2775
2774
|
* <p>An identifier associated with a message movement task. You can use this identifier to
|
|
2776
2775
|
* cancel a specified message movement task using the <code>CancelMessageMoveTask</code>
|
|
2777
2776
|
* action.</p>
|
|
2777
|
+
* @public
|
|
2778
2778
|
*/
|
|
2779
2779
|
TaskHandle?: string;
|
|
2780
2780
|
}
|
|
@@ -2783,13 +2783,13 @@ export interface StartMessageMoveTaskResult {
|
|
|
2783
2783
|
*/
|
|
2784
2784
|
export interface TagQueueRequest {
|
|
2785
2785
|
/**
|
|
2786
|
-
* @public
|
|
2787
2786
|
* <p>The URL of the queue.</p>
|
|
2787
|
+
* @public
|
|
2788
2788
|
*/
|
|
2789
2789
|
QueueUrl: string | undefined;
|
|
2790
2790
|
/**
|
|
2791
|
-
* @public
|
|
2792
2791
|
* <p>The list of tags to be added to the specified queue.</p>
|
|
2792
|
+
* @public
|
|
2793
2793
|
*/
|
|
2794
2794
|
Tags: Record<string, string> | undefined;
|
|
2795
2795
|
}
|
|
@@ -2798,13 +2798,13 @@ export interface TagQueueRequest {
|
|
|
2798
2798
|
*/
|
|
2799
2799
|
export interface UntagQueueRequest {
|
|
2800
2800
|
/**
|
|
2801
|
-
* @public
|
|
2802
2801
|
* <p>The URL of the queue.</p>
|
|
2802
|
+
* @public
|
|
2803
2803
|
*/
|
|
2804
2804
|
QueueUrl: string | undefined;
|
|
2805
2805
|
/**
|
|
2806
|
-
* @public
|
|
2807
2806
|
* <p>The list of tags to be removed from the specified queue.</p>
|
|
2807
|
+
* @public
|
|
2808
2808
|
*/
|
|
2809
2809
|
TagKeys: string[] | undefined;
|
|
2810
2810
|
}
|