@aws-sdk/client-sqs 3.533.0 → 3.535.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.
Files changed (51) hide show
  1. package/dist-types/SQS.d.ts +2 -1
  2. package/dist-types/SQSClient.d.ts +1 -1
  3. package/dist-types/commands/AddPermissionCommand.d.ts +2 -1
  4. package/dist-types/commands/CancelMessageMoveTaskCommand.d.ts +2 -1
  5. package/dist-types/commands/ChangeMessageVisibilityBatchCommand.d.ts +2 -1
  6. package/dist-types/commands/ChangeMessageVisibilityCommand.d.ts +2 -1
  7. package/dist-types/commands/CreateQueueCommand.d.ts +2 -1
  8. package/dist-types/commands/DeleteMessageBatchCommand.d.ts +2 -1
  9. package/dist-types/commands/DeleteMessageCommand.d.ts +2 -1
  10. package/dist-types/commands/DeleteQueueCommand.d.ts +2 -1
  11. package/dist-types/commands/GetQueueAttributesCommand.d.ts +2 -1
  12. package/dist-types/commands/GetQueueUrlCommand.d.ts +2 -1
  13. package/dist-types/commands/ListDeadLetterSourceQueuesCommand.d.ts +2 -1
  14. package/dist-types/commands/ListMessageMoveTasksCommand.d.ts +2 -1
  15. package/dist-types/commands/ListQueueTagsCommand.d.ts +2 -1
  16. package/dist-types/commands/ListQueuesCommand.d.ts +2 -1
  17. package/dist-types/commands/PurgeQueueCommand.d.ts +2 -1
  18. package/dist-types/commands/ReceiveMessageCommand.d.ts +2 -1
  19. package/dist-types/commands/RemovePermissionCommand.d.ts +2 -1
  20. package/dist-types/commands/SendMessageBatchCommand.d.ts +2 -1
  21. package/dist-types/commands/SendMessageCommand.d.ts +2 -1
  22. package/dist-types/commands/SetQueueAttributesCommand.d.ts +2 -1
  23. package/dist-types/commands/StartMessageMoveTaskCommand.d.ts +2 -1
  24. package/dist-types/commands/TagQueueCommand.d.ts +2 -1
  25. package/dist-types/commands/UntagQueueCommand.d.ts +2 -1
  26. package/dist-types/models/models_0.d.ts +198 -199
  27. package/dist-types/ts3.4/SQS.d.ts +1 -0
  28. package/dist-types/ts3.4/commands/AddPermissionCommand.d.ts +9 -0
  29. package/dist-types/ts3.4/commands/CancelMessageMoveTaskCommand.d.ts +9 -0
  30. package/dist-types/ts3.4/commands/ChangeMessageVisibilityBatchCommand.d.ts +9 -0
  31. package/dist-types/ts3.4/commands/ChangeMessageVisibilityCommand.d.ts +9 -0
  32. package/dist-types/ts3.4/commands/CreateQueueCommand.d.ts +9 -0
  33. package/dist-types/ts3.4/commands/DeleteMessageBatchCommand.d.ts +9 -0
  34. package/dist-types/ts3.4/commands/DeleteMessageCommand.d.ts +9 -0
  35. package/dist-types/ts3.4/commands/DeleteQueueCommand.d.ts +9 -0
  36. package/dist-types/ts3.4/commands/GetQueueAttributesCommand.d.ts +9 -0
  37. package/dist-types/ts3.4/commands/GetQueueUrlCommand.d.ts +9 -0
  38. package/dist-types/ts3.4/commands/ListDeadLetterSourceQueuesCommand.d.ts +9 -0
  39. package/dist-types/ts3.4/commands/ListMessageMoveTasksCommand.d.ts +9 -0
  40. package/dist-types/ts3.4/commands/ListQueueTagsCommand.d.ts +9 -0
  41. package/dist-types/ts3.4/commands/ListQueuesCommand.d.ts +9 -0
  42. package/dist-types/ts3.4/commands/PurgeQueueCommand.d.ts +9 -0
  43. package/dist-types/ts3.4/commands/ReceiveMessageCommand.d.ts +9 -0
  44. package/dist-types/ts3.4/commands/RemovePermissionCommand.d.ts +9 -0
  45. package/dist-types/ts3.4/commands/SendMessageBatchCommand.d.ts +9 -0
  46. package/dist-types/ts3.4/commands/SendMessageCommand.d.ts +9 -0
  47. package/dist-types/ts3.4/commands/SetQueueAttributesCommand.d.ts +9 -0
  48. package/dist-types/ts3.4/commands/StartMessageMoveTaskCommand.d.ts +9 -0
  49. package/dist-types/ts3.4/commands/TagQueueCommand.d.ts +9 -0
  50. package/dist-types/ts3.4/commands/UntagQueueCommand.d.ts +9 -0
  51. 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,26 @@ 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
+ * @public
811
+ * @deprecated exception has been included in ReceiptHandleIsInvalid
813
812
  */
814
813
  export declare class InvalidIdFormat extends __BaseException {
815
814
  readonly name: "InvalidIdFormat";
@@ -820,12 +819,11 @@ export declare class InvalidIdFormat extends __BaseException {
820
819
  constructor(opts: __ExceptionOptionType<InvalidIdFormat, __BaseException>);
821
820
  }
822
821
  /**
823
- * @public
824
822
  * <p>Encloses a receipt handle and an identifier for it.</p>
823
+ * @public
825
824
  */
826
825
  export interface DeleteMessageBatchRequestEntry {
827
826
  /**
828
- * @public
829
827
  * <p>The identifier for this particular receipt handle. This is used to communicate the
830
828
  * result.</p>
831
829
  * <note>
@@ -833,46 +831,46 @@ export interface DeleteMessageBatchRequestEntry {
833
831
  * <p>This identifier can have up to 80 characters. The following characters are
834
832
  * accepted: alphanumeric characters, hyphens(-), and underscores (_).</p>
835
833
  * </note>
834
+ * @public
836
835
  */
837
836
  Id: string | undefined;
838
837
  /**
839
- * @public
840
838
  * <p>A receipt handle.</p>
839
+ * @public
841
840
  */
842
841
  ReceiptHandle: string | undefined;
843
842
  }
844
843
  /**
845
- * @public
846
844
  * <p></p>
845
+ * @public
847
846
  */
848
847
  export interface DeleteMessageBatchRequest {
849
848
  /**
850
- * @public
851
849
  * <p>The URL of the Amazon SQS queue from which messages are deleted.</p>
852
850
  * <p>Queue URLs and names are case-sensitive.</p>
851
+ * @public
853
852
  */
854
853
  QueueUrl: string | undefined;
855
854
  /**
856
- * @public
857
855
  * <p>Lists the receipt handles for the messages to be deleted.</p>
856
+ * @public
858
857
  */
859
858
  Entries: DeleteMessageBatchRequestEntry[] | undefined;
860
859
  }
861
860
  /**
862
- * @public
863
861
  * <p>Encloses the <code>Id</code> of an entry in <code>
864
862
  * <a>DeleteMessageBatch</a>.</code>
865
863
  * </p>
864
+ * @public
866
865
  */
867
866
  export interface DeleteMessageBatchResultEntry {
868
867
  /**
869
- * @public
870
868
  * <p>Represents a successfully deleted message.</p>
869
+ * @public
871
870
  */
872
871
  Id: string | undefined;
873
872
  }
874
873
  /**
875
- * @public
876
874
  * <p>For each message in the batch, the response contains a <code>
877
875
  * <a>DeleteMessageBatchResultEntry</a>
878
876
  * </code> tag if the message is deleted
@@ -880,48 +878,48 @@ export interface DeleteMessageBatchResultEntry {
880
878
  * <a>BatchResultErrorEntry</a>
881
879
  * </code> tag if the message can't be
882
880
  * deleted.</p>
881
+ * @public
883
882
  */
884
883
  export interface DeleteMessageBatchResult {
885
884
  /**
886
- * @public
887
885
  * <p>A list of <code>
888
886
  * <a>DeleteMessageBatchResultEntry</a>
889
887
  * </code> items.</p>
888
+ * @public
890
889
  */
891
890
  Successful: DeleteMessageBatchResultEntry[] | undefined;
892
891
  /**
893
- * @public
894
892
  * <p>A list of <code>
895
893
  * <a>BatchResultErrorEntry</a>
896
894
  * </code> items.</p>
895
+ * @public
897
896
  */
898
897
  Failed: BatchResultErrorEntry[] | undefined;
899
898
  }
900
899
  /**
901
- * @public
902
900
  * <p></p>
901
+ * @public
903
902
  */
904
903
  export interface DeleteQueueRequest {
905
904
  /**
906
- * @public
907
905
  * <p>The URL of the Amazon SQS queue to delete.</p>
908
906
  * <p>Queue URLs and names are case-sensitive.</p>
907
+ * @public
909
908
  */
910
909
  QueueUrl: string | undefined;
911
910
  }
912
911
  /**
913
- * @public
914
912
  * <p></p>
913
+ * @public
915
914
  */
916
915
  export interface GetQueueAttributesRequest {
917
916
  /**
918
- * @public
919
917
  * <p>The URL of the Amazon SQS queue whose attribute information is retrieved.</p>
920
918
  * <p>Queue URLs and names are case-sensitive.</p>
919
+ * @public
921
920
  */
922
921
  QueueUrl: string | undefined;
923
922
  /**
924
- * @public
925
923
  * <p>A list of attributes for which to retrieve information.</p>
926
924
  * <p>The <code>AttributeNames</code> parameter is optional, but if you don't specify values
927
925
  * for this parameter, the request returns empty results.</p>
@@ -1166,92 +1164,93 @@ export interface GetQueueAttributesRequest {
1166
1164
  * <p>For information on throughput quotas, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html">Quotas
1167
1165
  * related to messages</a> in the <i>Amazon SQS Developer
1168
1166
  * Guide</i>.</p>
1167
+ * @public
1169
1168
  */
1170
1169
  AttributeNames?: QueueAttributeName[];
1171
1170
  }
1172
1171
  /**
1173
- * @public
1174
1172
  * <p>A list of returned queue attributes.</p>
1173
+ * @public
1175
1174
  */
1176
1175
  export interface GetQueueAttributesResult {
1177
1176
  /**
1178
- * @public
1179
1177
  * <p>A map of attributes to their respective values.</p>
1178
+ * @public
1180
1179
  */
1181
1180
  Attributes?: Partial<Record<QueueAttributeName, string>>;
1182
1181
  }
1183
1182
  /**
1184
- * @public
1185
1183
  * <p></p>
1184
+ * @public
1186
1185
  */
1187
1186
  export interface GetQueueUrlRequest {
1188
1187
  /**
1189
- * @public
1190
1188
  * <p>The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values:
1191
1189
  * alphanumeric characters, hyphens (<code>-</code>), and underscores
1192
1190
  * (<code>_</code>).</p>
1193
1191
  * <p>Queue URLs and names are case-sensitive.</p>
1192
+ * @public
1194
1193
  */
1195
1194
  QueueName: string | undefined;
1196
1195
  /**
1197
- * @public
1198
1196
  * <p>The Amazon Web
1199
1197
  * Services account ID of the account that created the queue.</p>
1198
+ * @public
1200
1199
  */
1201
1200
  QueueOwnerAWSAccountId?: string;
1202
1201
  }
1203
1202
  /**
1204
- * @public
1205
1203
  * <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
1204
  * Guide</i>.</p>
1205
+ * @public
1207
1206
  */
1208
1207
  export interface GetQueueUrlResult {
1209
1208
  /**
1210
- * @public
1211
1209
  * <p>The URL of the queue.</p>
1210
+ * @public
1212
1211
  */
1213
1212
  QueueUrl?: string;
1214
1213
  }
1215
1214
  /**
1216
- * @public
1217
1215
  * <p></p>
1216
+ * @public
1218
1217
  */
1219
1218
  export interface ListDeadLetterSourceQueuesRequest {
1220
1219
  /**
1221
- * @public
1222
1220
  * <p>The URL of a dead-letter queue.</p>
1223
1221
  * <p>Queue URLs and names are case-sensitive.</p>
1222
+ * @public
1224
1223
  */
1225
1224
  QueueUrl: string | undefined;
1226
1225
  /**
1227
- * @public
1228
1226
  * <p>Pagination token to request the next set of results.</p>
1227
+ * @public
1229
1228
  */
1230
1229
  NextToken?: string;
1231
1230
  /**
1232
- * @public
1233
1231
  * <p>Maximum number of results to include in the response. Value range is 1 to 1000. You
1234
1232
  * must set <code>MaxResults</code> to receive a value for <code>NextToken</code> in the
1235
1233
  * response.</p>
1234
+ * @public
1236
1235
  */
1237
1236
  MaxResults?: number;
1238
1237
  }
1239
1238
  /**
1240
- * @public
1241
1239
  * <p>A list of your dead letter source queues.</p>
1240
+ * @public
1242
1241
  */
1243
1242
  export interface ListDeadLetterSourceQueuesResult {
1244
1243
  /**
1245
- * @public
1246
1244
  * <p>A list of source queue URLs that have the <code>RedrivePolicy</code> queue attribute
1247
1245
  * configured with a dead-letter queue.</p>
1246
+ * @public
1248
1247
  */
1249
1248
  queueUrls: string[] | undefined;
1250
1249
  /**
1251
- * @public
1252
1250
  * <p>Pagination token to include in the next request. Token value is <code>null</code> if
1253
1251
  * there are no additional results to request, or if you did not set
1254
1252
  * <code>MaxResults</code> in the request.</p>
1253
+ * @public
1255
1254
  */
1256
1255
  NextToken?: string;
1257
1256
  }
@@ -1260,75 +1259,75 @@ export interface ListDeadLetterSourceQueuesResult {
1260
1259
  */
1261
1260
  export interface ListMessageMoveTasksRequest {
1262
1261
  /**
1263
- * @public
1264
1262
  * <p>The ARN of the queue whose message movement tasks are to be listed.</p>
1263
+ * @public
1265
1264
  */
1266
1265
  SourceArn: string | undefined;
1267
1266
  /**
1268
- * @public
1269
1267
  * <p>The maximum number of results to include in the response. The default is 1, which
1270
1268
  * provides the most recent message movement task. The upper limit is 10.</p>
1269
+ * @public
1271
1270
  */
1272
1271
  MaxResults?: number;
1273
1272
  }
1274
1273
  /**
1275
- * @public
1276
1274
  * <p>Contains the details of a message movement task. </p>
1275
+ * @public
1277
1276
  */
1278
1277
  export interface ListMessageMoveTasksResultEntry {
1279
1278
  /**
1280
- * @public
1281
1279
  * <p>An identifier associated with a message movement task. When this field is returned in
1282
1280
  * the response of the <code>ListMessageMoveTasks</code> action, it is only populated for
1283
1281
  * tasks that are in RUNNING status.</p>
1282
+ * @public
1284
1283
  */
1285
1284
  TaskHandle?: string;
1286
1285
  /**
1287
- * @public
1288
1286
  * <p>The status of the message movement task. Possible values are: RUNNING, COMPLETED,
1289
1287
  * CANCELLING, CANCELLED, and FAILED.</p>
1288
+ * @public
1290
1289
  */
1291
1290
  Status?: string;
1292
1291
  /**
1293
- * @public
1294
1292
  * <p>The ARN of the queue that contains the messages to be moved to another queue.</p>
1293
+ * @public
1295
1294
  */
1296
1295
  SourceArn?: string;
1297
1296
  /**
1298
- * @public
1299
1297
  * <p>The ARN of the destination queue if it has been specified in the
1300
1298
  * <code>StartMessageMoveTask</code> request. If a <code>DestinationArn</code> has not
1301
1299
  * been specified in the <code>StartMessageMoveTask</code> request, this field value will
1302
1300
  * be NULL.</p>
1301
+ * @public
1303
1302
  */
1304
1303
  DestinationArn?: string;
1305
1304
  /**
1306
- * @public
1307
1305
  * <p>The number of messages to be moved per second (the message movement rate), if it has
1308
1306
  * been specified in the <code>StartMessageMoveTask</code> request. If a
1309
1307
  * <code>MaxNumberOfMessagesPerSecond</code> has not been specified in the
1310
1308
  * <code>StartMessageMoveTask</code> request, this field value will be NULL.</p>
1309
+ * @public
1311
1310
  */
1312
1311
  MaxNumberOfMessagesPerSecond?: number;
1313
1312
  /**
1314
- * @public
1315
1313
  * <p>The approximate number of messages already moved to the destination queue.</p>
1314
+ * @public
1316
1315
  */
1317
1316
  ApproximateNumberOfMessagesMoved?: number;
1318
1317
  /**
1319
- * @public
1320
1318
  * <p>The number of messages to be moved from the source queue. This number is obtained at
1321
1319
  * the time of starting the message movement task.</p>
1320
+ * @public
1322
1321
  */
1323
1322
  ApproximateNumberOfMessagesToMove?: number;
1324
1323
  /**
1325
- * @public
1326
1324
  * <p>The task failure reason (only included if the task status is FAILED).</p>
1325
+ * @public
1327
1326
  */
1328
1327
  FailureReason?: string;
1329
1328
  /**
1330
- * @public
1331
1329
  * <p>The timestamp of starting the message movement task.</p>
1330
+ * @public
1332
1331
  */
1333
1332
  StartedTimestamp?: number;
1334
1333
  }
@@ -1337,52 +1336,52 @@ export interface ListMessageMoveTasksResultEntry {
1337
1336
  */
1338
1337
  export interface ListMessageMoveTasksResult {
1339
1338
  /**
1340
- * @public
1341
1339
  * <p>A list of message movement tasks and their attributes.</p>
1340
+ * @public
1342
1341
  */
1343
1342
  Results?: ListMessageMoveTasksResultEntry[];
1344
1343
  }
1345
1344
  /**
1346
- * @public
1347
1345
  * <p></p>
1346
+ * @public
1348
1347
  */
1349
1348
  export interface ListQueuesRequest {
1350
1349
  /**
1351
- * @public
1352
1350
  * <p>A string to use for filtering the list results. Only those queues whose name begins
1353
1351
  * with the specified string are returned.</p>
1354
1352
  * <p>Queue URLs and names are case-sensitive.</p>
1353
+ * @public
1355
1354
  */
1356
1355
  QueueNamePrefix?: string;
1357
1356
  /**
1358
- * @public
1359
1357
  * <p>Pagination token to request the next set of results.</p>
1358
+ * @public
1360
1359
  */
1361
1360
  NextToken?: string;
1362
1361
  /**
1363
- * @public
1364
1362
  * <p>Maximum number of results to include in the response. Value range is 1 to 1000. You
1365
1363
  * must set <code>MaxResults</code> to receive a value for <code>NextToken</code> in the
1366
1364
  * response.</p>
1365
+ * @public
1367
1366
  */
1368
1367
  MaxResults?: number;
1369
1368
  }
1370
1369
  /**
1371
- * @public
1372
1370
  * <p>A list of your queues.</p>
1371
+ * @public
1373
1372
  */
1374
1373
  export interface ListQueuesResult {
1375
1374
  /**
1376
- * @public
1377
1375
  * <p>A list of queue URLs, up to 1,000 entries, or the value of <code>MaxResults</code>
1378
1376
  * that you sent in the request.</p>
1377
+ * @public
1379
1378
  */
1380
1379
  QueueUrls?: string[];
1381
1380
  /**
1382
- * @public
1383
1381
  * <p>Pagination token to include in the next request. Token value is <code>null</code> if
1384
1382
  * there are no additional results to request, or if you did not set
1385
1383
  * <code>MaxResults</code> in the request.</p>
1384
+ * @public
1386
1385
  */
1387
1386
  NextToken?: string;
1388
1387
  }
@@ -1391,8 +1390,8 @@ export interface ListQueuesResult {
1391
1390
  */
1392
1391
  export interface ListQueueTagsRequest {
1393
1392
  /**
1394
- * @public
1395
1393
  * <p>The URL of the queue.</p>
1394
+ * @public
1396
1395
  */
1397
1396
  QueueUrl: string | undefined;
1398
1397
  }
@@ -1401,16 +1400,16 @@ export interface ListQueueTagsRequest {
1401
1400
  */
1402
1401
  export interface ListQueueTagsResult {
1403
1402
  /**
1404
- * @public
1405
1403
  * <p>The list of all tags added to the specified queue.</p>
1404
+ * @public
1406
1405
  */
1407
1406
  Tags?: Record<string, string>;
1408
1407
  }
1409
1408
  /**
1410
- * @public
1411
1409
  * <p>Indicates that the specified queue previously received a <code>PurgeQueue</code>
1412
1410
  * request within the last 60 seconds (the time it can take to delete the messages in the
1413
1411
  * queue).</p>
1412
+ * @public
1414
1413
  */
1415
1414
  export declare class PurgeQueueInProgress extends __BaseException {
1416
1415
  readonly name: "PurgeQueueInProgress";
@@ -1421,21 +1420,21 @@ export declare class PurgeQueueInProgress extends __BaseException {
1421
1420
  constructor(opts: __ExceptionOptionType<PurgeQueueInProgress, __BaseException>);
1422
1421
  }
1423
1422
  /**
1424
- * @public
1425
1423
  * <p></p>
1424
+ * @public
1426
1425
  */
1427
1426
  export interface PurgeQueueRequest {
1428
1427
  /**
1429
- * @public
1430
1428
  * <p>The URL of the queue from which the <code>PurgeQueue</code> action deletes
1431
1429
  * messages.</p>
1432
1430
  * <p>Queue URLs and names are case-sensitive.</p>
1431
+ * @public
1433
1432
  */
1434
1433
  QueueUrl: string | undefined;
1435
1434
  }
1436
1435
  /**
1437
- * @public
1438
1436
  * <p>The caller doesn't have the required KMS access.</p>
1437
+ * @public
1439
1438
  */
1440
1439
  export declare class KmsAccessDenied extends __BaseException {
1441
1440
  readonly name: "KmsAccessDenied";
@@ -1446,8 +1445,8 @@ export declare class KmsAccessDenied extends __BaseException {
1446
1445
  constructor(opts: __ExceptionOptionType<KmsAccessDenied, __BaseException>);
1447
1446
  }
1448
1447
  /**
1449
- * @public
1450
1448
  * <p>The request was denied due to request throttling.</p>
1449
+ * @public
1451
1450
  */
1452
1451
  export declare class KmsDisabled extends __BaseException {
1453
1452
  readonly name: "KmsDisabled";
@@ -1458,7 +1457,6 @@ export declare class KmsDisabled extends __BaseException {
1458
1457
  constructor(opts: __ExceptionOptionType<KmsDisabled, __BaseException>);
1459
1458
  }
1460
1459
  /**
1461
- * @public
1462
1460
  * <p>The request was rejected for one of the following reasons:</p>
1463
1461
  * <ul>
1464
1462
  * <li>
@@ -1470,6 +1468,7 @@ export declare class KmsDisabled extends __BaseException {
1470
1468
  * incompatible with the type of key material in the KMS key (KeySpec).</p>
1471
1469
  * </li>
1472
1470
  * </ul>
1471
+ * @public
1473
1472
  */
1474
1473
  export declare class KmsInvalidKeyUsage extends __BaseException {
1475
1474
  readonly name: "KmsInvalidKeyUsage";
@@ -1480,9 +1479,9 @@ export declare class KmsInvalidKeyUsage extends __BaseException {
1480
1479
  constructor(opts: __ExceptionOptionType<KmsInvalidKeyUsage, __BaseException>);
1481
1480
  }
1482
1481
  /**
1483
- * @public
1484
1482
  * <p>The request was rejected because the state of the specified resource is not valid for
1485
1483
  * this request.</p>
1484
+ * @public
1486
1485
  */
1487
1486
  export declare class KmsInvalidState extends __BaseException {
1488
1487
  readonly name: "KmsInvalidState";
@@ -1493,9 +1492,9 @@ export declare class KmsInvalidState extends __BaseException {
1493
1492
  constructor(opts: __ExceptionOptionType<KmsInvalidState, __BaseException>);
1494
1493
  }
1495
1494
  /**
1496
- * @public
1497
1495
  * <p>The request was rejected because the specified entity or resource could not be found.
1498
1496
  * </p>
1497
+ * @public
1499
1498
  */
1500
1499
  export declare class KmsNotFound extends __BaseException {
1501
1500
  readonly name: "KmsNotFound";
@@ -1506,9 +1505,9 @@ export declare class KmsNotFound extends __BaseException {
1506
1505
  constructor(opts: __ExceptionOptionType<KmsNotFound, __BaseException>);
1507
1506
  }
1508
1507
  /**
1509
- * @public
1510
1508
  * <p>The request was rejected because the specified key policy isn't syntactically or
1511
1509
  * semantically correct.</p>
1510
+ * @public
1512
1511
  */
1513
1512
  export declare class KmsOptInRequired extends __BaseException {
1514
1513
  readonly name: "KmsOptInRequired";
@@ -1519,8 +1518,8 @@ export declare class KmsOptInRequired extends __BaseException {
1519
1518
  constructor(opts: __ExceptionOptionType<KmsOptInRequired, __BaseException>);
1520
1519
  }
1521
1520
  /**
1522
- * @public
1523
1521
  * <p>Amazon Web Services KMS throttles requests for the following conditions.</p>
1522
+ * @public
1524
1523
  */
1525
1524
  export declare class KmsThrottled extends __BaseException {
1526
1525
  readonly name: "KmsThrottled";
@@ -1531,18 +1530,17 @@ export declare class KmsThrottled extends __BaseException {
1531
1530
  constructor(opts: __ExceptionOptionType<KmsThrottled, __BaseException>);
1532
1531
  }
1533
1532
  /**
1534
- * @public
1535
1533
  * <p></p>
1534
+ * @public
1536
1535
  */
1537
1536
  export interface ReceiveMessageRequest {
1538
1537
  /**
1539
- * @public
1540
1538
  * <p>The URL of the Amazon SQS queue from which messages are received.</p>
1541
1539
  * <p>Queue URLs and names are case-sensitive.</p>
1540
+ * @public
1542
1541
  */
1543
1542
  QueueUrl: string | undefined;
1544
1543
  /**
1545
- * @public
1546
1544
  * <p>A list of attributes that need to be returned along with each message. These
1547
1545
  * attributes include:</p>
1548
1546
  * <ul>
@@ -1614,10 +1612,10 @@ export interface ReceiveMessageRequest {
1614
1612
  * <code>SequenceNumber</code> – Returns the value provided by Amazon SQS.</p>
1615
1613
  * </li>
1616
1614
  * </ul>
1615
+ * @public
1617
1616
  */
1618
1617
  AttributeNames?: QueueAttributeName[];
1619
1618
  /**
1620
- * @public
1621
1619
  * <p>The name of the message attribute, where <i>N</i> is the index.</p>
1622
1620
  * <ul>
1623
1621
  * <li>
@@ -1645,23 +1643,23 @@ export interface ReceiveMessageRequest {
1645
1643
  * receive, or you can return all of the attributes by specifying <code>All</code> or
1646
1644
  * <code>.*</code> in your request. You can also use all message attributes starting
1647
1645
  * with a prefix, for example <code>bar.*</code>.</p>
1646
+ * @public
1648
1647
  */
1649
1648
  MessageAttributeNames?: string[];
1650
1649
  /**
1651
- * @public
1652
1650
  * <p>The maximum number of messages to return. Amazon SQS never returns more messages than
1653
1651
  * this value (however, fewer messages might be returned). Valid values: 1 to 10. Default:
1654
1652
  * 1.</p>
1653
+ * @public
1655
1654
  */
1656
1655
  MaxNumberOfMessages?: number;
1657
1656
  /**
1658
- * @public
1659
1657
  * <p>The duration (in seconds) that the received messages are hidden from subsequent
1660
1658
  * retrieve requests after being retrieved by a <code>ReceiveMessage</code> request.</p>
1659
+ * @public
1661
1660
  */
1662
1661
  VisibilityTimeout?: number;
1663
1662
  /**
1664
- * @public
1665
1663
  * <p>The duration (in seconds) for which the call waits for a message to arrive in the
1666
1664
  * queue before returning. If a message is available, the call returns sooner than
1667
1665
  * <code>WaitTimeSeconds</code>. If no messages are available and the wait time
@@ -1672,10 +1670,10 @@ export interface ReceiveMessageRequest {
1672
1670
  * <code>WaitTimeSeconds</code> parameter. For example, with the Java SDK, you can
1673
1671
  * 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
1672
  * </important>
1673
+ * @public
1675
1674
  */
1676
1675
  WaitTimeSeconds?: number;
1677
1676
  /**
1678
- * @public
1679
1677
  * <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
1680
1678
  * <p>The token used for deduplication of <code>ReceiveMessage</code> calls. If a networking
1681
1679
  * issue occurs after a <code>ReceiveMessage</code> action, and instead of a response you
@@ -1739,6 +1737,7 @@ export interface ReceiveMessageRequest {
1739
1737
  * (<code>!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~</code>).</p>
1740
1738
  * <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
1739
  * SQS Developer Guide</i>.</p>
1740
+ * @public
1742
1741
  */
1743
1742
  ReceiveRequestAttemptId?: string;
1744
1743
  }
@@ -1762,7 +1761,6 @@ export declare const MessageSystemAttributeName: {
1762
1761
  */
1763
1762
  export type MessageSystemAttributeName = (typeof MessageSystemAttributeName)[keyof typeof MessageSystemAttributeName];
1764
1763
  /**
1765
- * @public
1766
1764
  * <p>The user-specified message attribute value. For string data types, the
1767
1765
  * <code>Value</code> attribute has the same restrictions on the content as the message
1768
1766
  * body. For more information, see <code>
@@ -1773,70 +1771,70 @@ export type MessageSystemAttributeName = (typeof MessageSystemAttributeName)[key
1773
1771
  * be empty or null. All parts of the message attribute, including <code>Name</code>,
1774
1772
  * <code>Type</code>, and <code>Value</code>, are part of the message size restriction
1775
1773
  * (256 KiB or 262,144 bytes).</p>
1774
+ * @public
1776
1775
  */
1777
1776
  export interface MessageAttributeValue {
1778
1777
  /**
1779
- * @public
1780
1778
  * <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
1779
  * Characters</a>.</p>
1780
+ * @public
1782
1781
  */
1783
1782
  StringValue?: string;
1784
1783
  /**
1785
- * @public
1786
1784
  * <p>Binary type attributes can store any binary data, such as compressed data, encrypted
1787
1785
  * data, or images.</p>
1786
+ * @public
1788
1787
  */
1789
1788
  BinaryValue?: Uint8Array;
1790
1789
  /**
1791
- * @public
1792
1790
  * <p>Not implemented. Reserved for future use.</p>
1791
+ * @public
1793
1792
  */
1794
1793
  StringListValues?: string[];
1795
1794
  /**
1796
- * @public
1797
1795
  * <p>Not implemented. Reserved for future use.</p>
1796
+ * @public
1798
1797
  */
1799
1798
  BinaryListValues?: Uint8Array[];
1800
1799
  /**
1801
- * @public
1802
1800
  * <p>Amazon SQS supports the following logical data types: <code>String</code>,
1803
1801
  * <code>Number</code>, and <code>Binary</code>. For the <code>Number</code> data type,
1804
1802
  * you must use <code>StringValue</code>.</p>
1805
1803
  * <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
1804
  * Guide</i>.</p>
1805
+ * @public
1807
1806
  */
1808
1807
  DataType: string | undefined;
1809
1808
  }
1810
1809
  /**
1811
- * @public
1812
1810
  * <p>An Amazon SQS message.</p>
1811
+ * @public
1813
1812
  */
1814
1813
  export interface Message {
1815
1814
  /**
1816
- * @public
1817
1815
  * <p>A unique identifier for the message. A <code>MessageId</code>is considered unique
1818
1816
  * across all Amazon Web Services accounts for an extended period of time.</p>
1817
+ * @public
1819
1818
  */
1820
1819
  MessageId?: string;
1821
1820
  /**
1822
- * @public
1823
1821
  * <p>An identifier associated with the act of receiving the message. A new receipt handle
1824
1822
  * is returned every time you receive a message. When deleting a message, you provide the
1825
1823
  * last received receipt handle to delete the message.</p>
1824
+ * @public
1826
1825
  */
1827
1826
  ReceiptHandle?: string;
1828
1827
  /**
1829
- * @public
1830
1828
  * <p>An MD5 digest of the non-URL-encoded message body string.</p>
1829
+ * @public
1831
1830
  */
1832
1831
  MD5OfBody?: string;
1833
1832
  /**
1834
- * @public
1835
1833
  * <p>The message's contents (not URL-encoded).</p>
1834
+ * @public
1836
1835
  */
1837
1836
  Body?: string;
1838
1837
  /**
1839
- * @public
1840
1838
  * <p>A map of the attributes requested in <code>
1841
1839
  * <a>ReceiveMessage</a>
1842
1840
  * </code> to
@@ -1882,58 +1880,59 @@ export interface Message {
1882
1880
  * <code>ApproximateFirstReceiveTimestamp</code> and <code>SentTimestamp</code> are each
1883
1881
  * returned as an integer representing the <a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a> in
1884
1882
  * milliseconds.</p>
1883
+ * @public
1885
1884
  */
1886
1885
  Attributes?: Partial<Record<MessageSystemAttributeName, string>>;
1887
1886
  /**
1888
- * @public
1889
1887
  * <p>An MD5 digest of the non-URL-encoded message attribute string. You can use this
1890
1888
  * attribute to verify that Amazon SQS received the message correctly. Amazon SQS
1891
1889
  * URL-decodes the message before creating the MD5 digest. For information about MD5, see
1892
1890
  * <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
1891
+ * @public
1893
1892
  */
1894
1893
  MD5OfMessageAttributes?: string;
1895
1894
  /**
1896
- * @public
1897
1895
  * <p>Each message attribute consists of a <code>Name</code>, <code>Type</code>, and
1898
1896
  * <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
1897
  * Guide</i>.</p>
1898
+ * @public
1900
1899
  */
1901
1900
  MessageAttributes?: Record<string, MessageAttributeValue>;
1902
1901
  }
1903
1902
  /**
1904
- * @public
1905
1903
  * <p>A list of received messages.</p>
1904
+ * @public
1906
1905
  */
1907
1906
  export interface ReceiveMessageResult {
1908
1907
  /**
1909
- * @public
1910
1908
  * <p>A list of messages.</p>
1909
+ * @public
1911
1910
  */
1912
1911
  Messages?: Message[];
1913
1912
  }
1914
1913
  /**
1915
- * @public
1916
1914
  * <p></p>
1915
+ * @public
1917
1916
  */
1918
1917
  export interface RemovePermissionRequest {
1919
1918
  /**
1920
- * @public
1921
1919
  * <p>The URL of the Amazon SQS queue from which permissions are removed.</p>
1922
1920
  * <p>Queue URLs and names are case-sensitive.</p>
1921
+ * @public
1923
1922
  */
1924
1923
  QueueUrl: string | undefined;
1925
1924
  /**
1926
- * @public
1927
1925
  * <p>The identification of the permission to remove. This is the label added using the
1928
1926
  * <code>
1929
1927
  * <a>AddPermission</a>
1930
1928
  * </code> action.</p>
1929
+ * @public
1931
1930
  */
1932
1931
  Label: string | undefined;
1933
1932
  }
1934
1933
  /**
1935
- * @public
1936
1934
  * <p>The message contains characters outside the allowed set.</p>
1935
+ * @public
1937
1936
  */
1938
1937
  export declare class InvalidMessageContents extends __BaseException {
1939
1938
  readonly name: "InvalidMessageContents";
@@ -1955,7 +1954,6 @@ export declare const MessageSystemAttributeNameForSends: {
1955
1954
  */
1956
1955
  export type MessageSystemAttributeNameForSends = (typeof MessageSystemAttributeNameForSends)[keyof typeof MessageSystemAttributeNameForSends];
1957
1956
  /**
1958
- * @public
1959
1957
  * <p>The user-specified message system attribute value. For string data types, the
1960
1958
  * <code>Value</code> attribute has the same restrictions on the content as the message
1961
1959
  * body. For more information, see <code>
@@ -1964,53 +1962,53 @@ export type MessageSystemAttributeNameForSends = (typeof MessageSystemAttributeN
1964
1962
  * <p>
1965
1963
  * <code>Name</code>, <code>type</code>, <code>value</code> and the message body must not
1966
1964
  * be empty or null.</p>
1965
+ * @public
1967
1966
  */
1968
1967
  export interface MessageSystemAttributeValue {
1969
1968
  /**
1970
- * @public
1971
1969
  * <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
1970
  * Characters</a>.</p>
1971
+ * @public
1973
1972
  */
1974
1973
  StringValue?: string;
1975
1974
  /**
1976
- * @public
1977
1975
  * <p>Binary type attributes can store any binary data, such as compressed data, encrypted
1978
1976
  * data, or images.</p>
1977
+ * @public
1979
1978
  */
1980
1979
  BinaryValue?: Uint8Array;
1981
1980
  /**
1982
- * @public
1983
1981
  * <p>Not implemented. Reserved for future use.</p>
1982
+ * @public
1984
1983
  */
1985
1984
  StringListValues?: string[];
1986
1985
  /**
1987
- * @public
1988
1986
  * <p>Not implemented. Reserved for future use.</p>
1987
+ * @public
1989
1988
  */
1990
1989
  BinaryListValues?: Uint8Array[];
1991
1990
  /**
1992
- * @public
1993
1991
  * <p>Amazon SQS supports the following logical data types: <code>String</code>,
1994
1992
  * <code>Number</code>, and <code>Binary</code>. For the <code>Number</code> data type,
1995
1993
  * you must use <code>StringValue</code>.</p>
1996
1994
  * <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
1995
  * Guide</i>.</p>
1996
+ * @public
1998
1997
  */
1999
1998
  DataType: string | undefined;
2000
1999
  }
2001
2000
  /**
2002
- * @public
2003
2001
  * <p></p>
2002
+ * @public
2004
2003
  */
2005
2004
  export interface SendMessageRequest {
2006
2005
  /**
2007
- * @public
2008
2006
  * <p>The URL of the Amazon SQS queue to which a message is sent.</p>
2009
2007
  * <p>Queue URLs and names are case-sensitive.</p>
2008
+ * @public
2010
2009
  */
2011
2010
  QueueUrl: string | undefined;
2012
2011
  /**
2013
- * @public
2014
2012
  * <p>The message to send. The minimum size is one character. The maximum size is 256
2015
2013
  * KiB.</p>
2016
2014
  * <important>
@@ -2025,10 +2023,10 @@ export interface SendMessageRequest {
2025
2023
  * see the <a href="http://www.w3.org/TR/REC-xml/#charsets">W3C specification for
2026
2024
  * characters</a>.</p>
2027
2025
  * </important>
2026
+ * @public
2028
2027
  */
2029
2028
  MessageBody: string | undefined;
2030
2029
  /**
2031
- * @public
2032
2030
  * <p> The length of time, in seconds, for which to delay a specific message. Valid values:
2033
2031
  * 0 to 900. Maximum: 15 minutes. Messages with a positive <code>DelaySeconds</code> value
2034
2032
  * become available for processing after the delay period is finished. If you don't specify
@@ -2037,17 +2035,17 @@ export interface SendMessageRequest {
2037
2035
  * <p>When you set <code>FifoQueue</code>, you can't set <code>DelaySeconds</code> per
2038
2036
  * message. You can set this parameter only on a queue level.</p>
2039
2037
  * </note>
2038
+ * @public
2040
2039
  */
2041
2040
  DelaySeconds?: number;
2042
2041
  /**
2043
- * @public
2044
2042
  * <p>Each message attribute consists of a <code>Name</code>, <code>Type</code>, and
2045
2043
  * <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
2044
  * Guide</i>.</p>
2045
+ * @public
2047
2046
  */
2048
2047
  MessageAttributes?: Record<string, MessageAttributeValue>;
2049
2048
  /**
2050
- * @public
2051
2049
  * <p>The message system attribute to send. Each message system attribute consists of a
2052
2050
  * <code>Name</code>, <code>Type</code>, and <code>Value</code>.</p>
2053
2051
  * <important>
@@ -2064,10 +2062,10 @@ export interface SendMessageRequest {
2064
2062
  * </li>
2065
2063
  * </ul>
2066
2064
  * </important>
2065
+ * @public
2067
2066
  */
2068
2067
  MessageSystemAttributes?: Partial<Record<MessageSystemAttributeNameForSends, MessageSystemAttributeValue>>;
2069
2068
  /**
2070
- * @public
2071
2069
  * <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
2072
2070
  * <p>The token used for deduplication of sent messages. If a message with a particular
2073
2071
  * <code>MessageDeduplicationId</code> is sent successfully, any messages sent with the
@@ -2129,10 +2127,10 @@ export interface SendMessageRequest {
2129
2127
  * (<code>!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~</code>).</p>
2130
2128
  * <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
2129
  * Developer Guide</i>.</p>
2130
+ * @public
2132
2131
  */
2133
2132
  MessageDeduplicationId?: string;
2134
2133
  /**
2135
- * @public
2136
2134
  * <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
2137
2135
  * <p>The tag that specifies that a message belongs to a specific message group. Messages
2138
2136
  * that belong to the same message group are processed in a FIFO manner (however, messages
@@ -2164,55 +2162,56 @@ export interface SendMessageRequest {
2164
2162
  * <code>MessageGroupId</code> is required for FIFO queues. You can't use it for
2165
2163
  * Standard queues.</p>
2166
2164
  * </important>
2165
+ * @public
2167
2166
  */
2168
2167
  MessageGroupId?: string;
2169
2168
  }
2170
2169
  /**
2171
- * @public
2172
2170
  * <p>The <code>MD5OfMessageBody</code> and <code>MessageId</code> elements.</p>
2171
+ * @public
2173
2172
  */
2174
2173
  export interface SendMessageResult {
2175
2174
  /**
2176
- * @public
2177
2175
  * <p>An MD5 digest of the non-URL-encoded message body string. You can use this attribute
2178
2176
  * to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the
2179
2177
  * message before creating the MD5 digest. For information about MD5, see <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
2178
+ * @public
2180
2179
  */
2181
2180
  MD5OfMessageBody?: string;
2182
2181
  /**
2183
- * @public
2184
2182
  * <p>An MD5 digest of the non-URL-encoded message attribute string. You can use this
2185
2183
  * attribute to verify that Amazon SQS received the message correctly. Amazon SQS
2186
2184
  * URL-decodes the message before creating the MD5 digest. For information about MD5, see
2187
2185
  * <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
2186
+ * @public
2188
2187
  */
2189
2188
  MD5OfMessageAttributes?: string;
2190
2189
  /**
2191
- * @public
2192
2190
  * <p>An MD5 digest of the non-URL-encoded message system attribute string. You can use this
2193
2191
  * attribute to verify that Amazon SQS received the message correctly. Amazon SQS
2194
2192
  * URL-decodes the message before creating the MD5 digest.</p>
2193
+ * @public
2195
2194
  */
2196
2195
  MD5OfMessageSystemAttributes?: string;
2197
2196
  /**
2198
- * @public
2199
2197
  * <p>An attribute containing the <code>MessageId</code> of the message sent to the queue.
2200
2198
  * 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
2199
  * Guide</i>. </p>
2200
+ * @public
2202
2201
  */
2203
2202
  MessageId?: string;
2204
2203
  /**
2205
- * @public
2206
2204
  * <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
2207
2205
  * <p>The large, non-consecutive number that Amazon SQS assigns to each message.</p>
2208
2206
  * <p>The length of <code>SequenceNumber</code> is 128 bits. <code>SequenceNumber</code>
2209
2207
  * continues to increase for a particular <code>MessageGroupId</code>.</p>
2208
+ * @public
2210
2209
  */
2211
2210
  SequenceNumber?: string;
2212
2211
  }
2213
2212
  /**
2214
- * @public
2215
2213
  * <p>The length of all the messages put together is more than the limit.</p>
2214
+ * @public
2216
2215
  */
2217
2216
  export declare class BatchRequestTooLong extends __BaseException {
2218
2217
  readonly name: "BatchRequestTooLong";
@@ -2223,28 +2222,27 @@ export declare class BatchRequestTooLong extends __BaseException {
2223
2222
  constructor(opts: __ExceptionOptionType<BatchRequestTooLong, __BaseException>);
2224
2223
  }
2225
2224
  /**
2226
- * @public
2227
2225
  * <p>Contains the details of a single Amazon SQS message along with an
2228
2226
  * <code>Id</code>.</p>
2227
+ * @public
2229
2228
  */
2230
2229
  export interface SendMessageBatchRequestEntry {
2231
2230
  /**
2232
- * @public
2233
2231
  * <p>An identifier for a message in this batch used to communicate the result.</p>
2234
2232
  * <note>
2235
2233
  * <p>The <code>Id</code>s of a batch request need to be unique within a request.</p>
2236
2234
  * <p>This identifier can have up to 80 characters. The following characters are
2237
2235
  * accepted: alphanumeric characters, hyphens(-), and underscores (_).</p>
2238
2236
  * </note>
2237
+ * @public
2239
2238
  */
2240
2239
  Id: string | undefined;
2241
2240
  /**
2242
- * @public
2243
2241
  * <p>The body of the message.</p>
2242
+ * @public
2244
2243
  */
2245
2244
  MessageBody: string | undefined;
2246
2245
  /**
2247
- * @public
2248
2246
  * <p>The length of time, in seconds, for which a specific message is delayed. Valid values:
2249
2247
  * 0 to 900. Maximum: 15 minutes. Messages with a positive <code>DelaySeconds</code> value
2250
2248
  * become available for processing after the delay period is finished. If you don't specify
@@ -2253,17 +2251,17 @@ export interface SendMessageBatchRequestEntry {
2253
2251
  * <p>When you set <code>FifoQueue</code>, you can't set <code>DelaySeconds</code> per
2254
2252
  * message. You can set this parameter only on a queue level.</p>
2255
2253
  * </note>
2254
+ * @public
2256
2255
  */
2257
2256
  DelaySeconds?: number;
2258
2257
  /**
2259
- * @public
2260
2258
  * <p>Each message attribute consists of a <code>Name</code>, <code>Type</code>, and
2261
2259
  * <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
2260
  * Guide</i>.</p>
2261
+ * @public
2263
2262
  */
2264
2263
  MessageAttributes?: Record<string, MessageAttributeValue>;
2265
2264
  /**
2266
- * @public
2267
2265
  * <p>The message system attribute to send Each message system attribute consists of a
2268
2266
  * <code>Name</code>, <code>Type</code>, and <code>Value</code>.</p>
2269
2267
  * <important>
@@ -2280,10 +2278,10 @@ export interface SendMessageBatchRequestEntry {
2280
2278
  * </li>
2281
2279
  * </ul>
2282
2280
  * </important>
2281
+ * @public
2283
2282
  */
2284
2283
  MessageSystemAttributes?: Partial<Record<MessageSystemAttributeNameForSends, MessageSystemAttributeValue>>;
2285
2284
  /**
2286
- * @public
2287
2285
  * <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
2288
2286
  * <p>The token used for deduplication of messages within a 5-minute minimum deduplication
2289
2287
  * interval. If a message with a particular <code>MessageDeduplicationId</code> is sent
@@ -2345,10 +2343,10 @@ export interface SendMessageBatchRequestEntry {
2345
2343
  * (<code>!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~</code>).</p>
2346
2344
  * <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
2345
  * Developer Guide</i>.</p>
2346
+ * @public
2348
2347
  */
2349
2348
  MessageDeduplicationId?: string;
2350
2349
  /**
2351
- * @public
2352
2350
  * <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
2353
2351
  * <p>The tag that specifies that a message belongs to a specific message group. Messages
2354
2352
  * that belong to the same message group are processed in a FIFO manner (however, messages
@@ -2380,79 +2378,79 @@ export interface SendMessageBatchRequestEntry {
2380
2378
  * <code>MessageGroupId</code> is required for FIFO queues. You can't use it for
2381
2379
  * Standard queues.</p>
2382
2380
  * </important>
2381
+ * @public
2383
2382
  */
2384
2383
  MessageGroupId?: string;
2385
2384
  }
2386
2385
  /**
2387
- * @public
2388
2386
  * <p></p>
2387
+ * @public
2389
2388
  */
2390
2389
  export interface SendMessageBatchRequest {
2391
2390
  /**
2392
- * @public
2393
2391
  * <p>The URL of the Amazon SQS queue to which batched messages are sent.</p>
2394
2392
  * <p>Queue URLs and names are case-sensitive.</p>
2393
+ * @public
2395
2394
  */
2396
2395
  QueueUrl: string | undefined;
2397
2396
  /**
2398
- * @public
2399
2397
  * <p>A list of <code>
2400
2398
  * <a>SendMessageBatchRequestEntry</a>
2401
2399
  * </code> items.</p>
2400
+ * @public
2402
2401
  */
2403
2402
  Entries: SendMessageBatchRequestEntry[] | undefined;
2404
2403
  }
2405
2404
  /**
2406
- * @public
2407
2405
  * <p>Encloses a <code>MessageId</code> for a successfully-enqueued message in a <code>
2408
2406
  * <a>SendMessageBatch</a>.</code>
2409
2407
  * </p>
2408
+ * @public
2410
2409
  */
2411
2410
  export interface SendMessageBatchResultEntry {
2412
2411
  /**
2413
- * @public
2414
2412
  * <p>An identifier for the message in this batch.</p>
2413
+ * @public
2415
2414
  */
2416
2415
  Id: string | undefined;
2417
2416
  /**
2418
- * @public
2419
2417
  * <p>An identifier for the message.</p>
2418
+ * @public
2420
2419
  */
2421
2420
  MessageId: string | undefined;
2422
2421
  /**
2423
- * @public
2424
2422
  * <p>An MD5 digest of the non-URL-encoded message body string. You can use this attribute
2425
2423
  * to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the
2426
2424
  * message before creating the MD5 digest. For information about MD5, see <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
2425
+ * @public
2427
2426
  */
2428
2427
  MD5OfMessageBody: string | undefined;
2429
2428
  /**
2430
- * @public
2431
2429
  * <p>An MD5 digest of the non-URL-encoded message attribute string. You can use this
2432
2430
  * attribute to verify that Amazon SQS received the message correctly. Amazon SQS
2433
2431
  * URL-decodes the message before creating the MD5 digest. For information about MD5, see
2434
2432
  * <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
2433
+ * @public
2435
2434
  */
2436
2435
  MD5OfMessageAttributes?: string;
2437
2436
  /**
2438
- * @public
2439
2437
  * <p>An MD5 digest of the non-URL-encoded message system attribute string. You can use this
2440
2438
  * attribute to verify that Amazon SQS received the message correctly. Amazon SQS
2441
2439
  * URL-decodes the message before creating the MD5 digest. For information about MD5, see
2442
2440
  * <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
2441
+ * @public
2443
2442
  */
2444
2443
  MD5OfMessageSystemAttributes?: string;
2445
2444
  /**
2446
- * @public
2447
2445
  * <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
2448
2446
  * <p>The large, non-consecutive number that Amazon SQS assigns to each message.</p>
2449
2447
  * <p>The length of <code>SequenceNumber</code> is 128 bits. As <code>SequenceNumber</code>
2450
2448
  * continues to increase for a particular <code>MessageGroupId</code>.</p>
2449
+ * @public
2451
2450
  */
2452
2451
  SequenceNumber?: string;
2453
2452
  }
2454
2453
  /**
2455
- * @public
2456
2454
  * <p>For each message in the batch, the response contains a <code>
2457
2455
  * <a>SendMessageBatchResultEntry</a>
2458
2456
  * </code> tag if the message succeeds or a
@@ -2460,37 +2458,37 @@ export interface SendMessageBatchResultEntry {
2460
2458
  * <a>BatchResultErrorEntry</a>
2461
2459
  * </code> tag if the message
2462
2460
  * fails.</p>
2461
+ * @public
2463
2462
  */
2464
2463
  export interface SendMessageBatchResult {
2465
2464
  /**
2466
- * @public
2467
2465
  * <p>A list of <code>
2468
2466
  * <a>SendMessageBatchResultEntry</a>
2469
2467
  * </code> items.</p>
2468
+ * @public
2470
2469
  */
2471
2470
  Successful: SendMessageBatchResultEntry[] | undefined;
2472
2471
  /**
2473
- * @public
2474
2472
  * <p>A list of <code>
2475
2473
  * <a>BatchResultErrorEntry</a>
2476
2474
  * </code> items with error
2477
2475
  * details about each message that can't be enqueued.</p>
2476
+ * @public
2478
2477
  */
2479
2478
  Failed: BatchResultErrorEntry[] | undefined;
2480
2479
  }
2481
2480
  /**
2482
- * @public
2483
2481
  * <p></p>
2482
+ * @public
2484
2483
  */
2485
2484
  export interface SetQueueAttributesRequest {
2486
2485
  /**
2487
- * @public
2488
2486
  * <p>The URL of the Amazon SQS queue whose attributes are set.</p>
2489
2487
  * <p>Queue URLs and names are case-sensitive.</p>
2488
+ * @public
2490
2489
  */
2491
2490
  QueueUrl: string | undefined;
2492
2491
  /**
2493
- * @public
2494
2492
  * <p>A map of attributes to set.</p>
2495
2493
  * <p>The following lists the names, descriptions, and values of the special request
2496
2494
  * parameters that the <code>SetQueueAttributes</code> action uses:</p>
@@ -2733,6 +2731,7 @@ export interface SetQueueAttributesRequest {
2733
2731
  * <p>For information on throughput quotas, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html">Quotas
2734
2732
  * related to messages</a> in the <i>Amazon SQS Developer
2735
2733
  * Guide</i>.</p>
2734
+ * @public
2736
2735
  */
2737
2736
  Attributes: Partial<Record<QueueAttributeName, string>> | undefined;
2738
2737
  }
@@ -2741,28 +2740,28 @@ export interface SetQueueAttributesRequest {
2741
2740
  */
2742
2741
  export interface StartMessageMoveTaskRequest {
2743
2742
  /**
2744
- * @public
2745
2743
  * <p>The ARN of the queue that contains the messages to be moved to another queue.
2746
2744
  * Currently, only ARNs of dead-letter queues (DLQs) whose sources are other Amazon SQS queues
2747
2745
  * are accepted. DLQs whose sources are non-SQS queues, such as Lambda or Amazon SNS topics, are
2748
2746
  * not currently supported.</p>
2747
+ * @public
2749
2748
  */
2750
2749
  SourceArn: string | undefined;
2751
2750
  /**
2752
- * @public
2753
2751
  * <p>The ARN of the queue that receives the moved messages. You can use this field to
2754
2752
  * specify the destination queue where you would like to redrive messages. If this field is
2755
2753
  * left blank, the messages will be redriven back to their respective original source
2756
2754
  * queues.</p>
2755
+ * @public
2757
2756
  */
2758
2757
  DestinationArn?: string;
2759
2758
  /**
2760
- * @public
2761
2759
  * <p>The number of messages to be moved per second (the message movement rate). You can use
2762
2760
  * this field to define a fixed message movement rate. The maximum value for messages per
2763
2761
  * second is 500. If this field is left blank, the system will optimize the rate based on
2764
2762
  * the queue message backlog size, which may vary throughout the duration of the message
2765
2763
  * movement task.</p>
2764
+ * @public
2766
2765
  */
2767
2766
  MaxNumberOfMessagesPerSecond?: number;
2768
2767
  }
@@ -2771,10 +2770,10 @@ export interface StartMessageMoveTaskRequest {
2771
2770
  */
2772
2771
  export interface StartMessageMoveTaskResult {
2773
2772
  /**
2774
- * @public
2775
2773
  * <p>An identifier associated with a message movement task. You can use this identifier to
2776
2774
  * cancel a specified message movement task using the <code>CancelMessageMoveTask</code>
2777
2775
  * action.</p>
2776
+ * @public
2778
2777
  */
2779
2778
  TaskHandle?: string;
2780
2779
  }
@@ -2783,13 +2782,13 @@ export interface StartMessageMoveTaskResult {
2783
2782
  */
2784
2783
  export interface TagQueueRequest {
2785
2784
  /**
2786
- * @public
2787
2785
  * <p>The URL of the queue.</p>
2786
+ * @public
2788
2787
  */
2789
2788
  QueueUrl: string | undefined;
2790
2789
  /**
2791
- * @public
2792
2790
  * <p>The list of tags to be added to the specified queue.</p>
2791
+ * @public
2793
2792
  */
2794
2793
  Tags: Record<string, string> | undefined;
2795
2794
  }
@@ -2798,13 +2797,13 @@ export interface TagQueueRequest {
2798
2797
  */
2799
2798
  export interface UntagQueueRequest {
2800
2799
  /**
2801
- * @public
2802
2800
  * <p>The URL of the queue.</p>
2801
+ * @public
2803
2802
  */
2804
2803
  QueueUrl: string | undefined;
2805
2804
  /**
2806
- * @public
2807
2805
  * <p>The list of tags to be removed from the specified queue.</p>
2806
+ * @public
2808
2807
  */
2809
2808
  TagKeys: string[] | undefined;
2810
2809
  }