-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathschemas.ts
786 lines (736 loc) · 39.9 KB
/
schemas.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
export type SQSTarget = "SendMessage" |
"SendMessageBatch" |
"DeleteMessage" |
"DeleteMessageBatch" |
"ReceiveMessage" |
"ChangeMessageVisibility" |
"ChangeMessageVisibilityBatch";
export const QueueAttributeName = {
All: "All",
ApproximateNumberOfMessages: "ApproximateNumberOfMessages",
ApproximateNumberOfMessagesDelayed: "ApproximateNumberOfMessagesDelayed",
ApproximateNumberOfMessagesNotVisible: "ApproximateNumberOfMessagesNotVisible",
ContentBasedDeduplication: "ContentBasedDeduplication",
CreatedTimestamp: "CreatedTimestamp",
DeduplicationScope: "DeduplicationScope",
DelaySeconds: "DelaySeconds",
FifoQueue: "FifoQueue",
FifoThroughputLimit: "FifoThroughputLimit",
KmsDataKeyReusePeriodSeconds: "KmsDataKeyReusePeriodSeconds",
KmsMasterKeyId: "KmsMasterKeyId",
LastModifiedTimestamp: "LastModifiedTimestamp",
MaximumMessageSize: "MaximumMessageSize",
MessageRetentionPeriod: "MessageRetentionPeriod",
Policy: "Policy",
QueueArn: "QueueArn",
ReceiveMessageWaitTimeSeconds: "ReceiveMessageWaitTimeSeconds",
RedriveAllowPolicy: "RedriveAllowPolicy",
RedrivePolicy: "RedrivePolicy",
SqsManagedSseEnabled: "SqsManagedSseEnabled",
VisibilityTimeout: "VisibilityTimeout",
} as const;
export type QueueAttributeName = (typeof QueueAttributeName)[keyof typeof QueueAttributeName];
export interface MessageAttributeValue {
/**
* <p>Strings are Unicode with UTF-8 binary encoding. For a list of code values, see <a href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters">ASCII Printable
* Characters</a>.</p>
*/
StringValue?: string;
/**
* <p>Binary type attributes can store any binary data, such as compressed data, encrypted
* data, or images.</p>
*/
BinaryValue?: Uint8Array;
/**
* <p>Amazon SQS supports the following logical data types: <code>String</code>,
* <code>Number</code>, and <code>Binary</code>. For the <code>Number</code> data type,
* you must use <code>StringValue</code>.</p>
* <p>You can also append custom labels. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes">Amazon SQS Message Attributes</a> in the <i>Amazon SQS Developer
* Guide</i>.</p>
*/
DataType: "String" | "Number" | "Binary";
}
export interface Message {
/**
* <p>A unique identifier for the message. A <code>MessageId</code>is considered unique
* across all Amazon Web Services accounts for an extended period of time.</p>
*/
MessageId?: string;
/**
* <p>An identifier associated with the act of receiving the message. A new receipt handle
* is returned every time you receive a message. When deleting a message, you provide the
* last received receipt handle to delete the message.</p>
*/
ReceiptHandle?: string;
/**
* <p>An MD5 digest of the non-URL-encoded message body string.</p>
*/
MD5OfBody?: string;
/**
* <p>The message's contents (not URL-encoded).</p>
*/
Body?: string;
/**
* <p>A map of the attributes requested in <code>
* <a>ReceiveMessage</a>
* </code> to
* their respective values. Supported attributes:</p>
* <ul>
* <li>
* <p>
* <code>ApproximateReceiveCount</code>
* </p>
* </li>
* <li>
* <p>
* <code>ApproximateFirstReceiveTimestamp</code>
* </p>
* </li>
* <li>
* <p>
* <code>MessageDeduplicationId</code>
* </p>
* </li>
* <li>
* <p>
* <code>MessageGroupId</code>
* </p>
* </li>
* <li>
* <p>
* <code>SenderId</code>
* </p>
* </li>
* <li>
* <p>
* <code>SentTimestamp</code>
* </p>
* </li>
* <li>
* <p>
* <code>SequenceNumber</code>
* </p>
* </li>
* </ul>
* <p>
* <code>ApproximateFirstReceiveTimestamp</code> and <code>SentTimestamp</code> are each
* returned as an integer representing the <a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a> in
* milliseconds.</p>
*/
Attributes?: Record<string, string>;
/**
* <p>An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
*/
MD5OfMessageAttributes?: string;
/**
* <p>Each message attribute consists of a <code>Name</code>, <code>Type</code>,
* and <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 Guide</i>.</p>
*/
MessageAttributes?: Record<string, MessageAttributeValue>;
}
export interface MessageSystemAttributeValue {
/**
* <p>Strings are Unicode with UTF-8 binary encoding. For a list of code values, see <a href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters">ASCII Printable
* Characters</a>.</p>
*/
StringValue?: string;
/**
* <p>Binary type attributes can store any binary data, such as compressed data, encrypted
* data, or images.</p>
*/
BinaryValue?: Uint8Array;
/**
* <p>Amazon SQS supports the following logical data types: <code>String</code>,
* <code>Number</code>, and <code>Binary</code>. For the <code>Number</code> data type,
* you must use <code>StringValue</code>.</p>
* <p>You can also append custom labels. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes">Amazon SQS Message Attributes</a> in the <i>Amazon SQS Developer
* Guide</i>.</p>
*/
DataType: "String" | "Number" | "Binary";
}
export interface SendMessage {
/**
* <p>The message to send. The minimum size is one character. The maximum size is 256
* KiB.</p>
* <important>
* <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:</p>
* <p>
* <code>#x9</code> | <code>#xA</code> | <code>#xD</code> | <code>#x20</code> to <code>#xD7FF</code> | <code>#xE000</code> to <code>#xFFFD</code> | <code>#x10000</code> to <code>#x10FFFF</code>
* </p>
* <p>Any characters not included in this list will be rejected. For more information, see the <a href="http://www.w3.org/TR/REC-xml/#charsets">W3C specification for characters</a>.</p>
* </important>
*/
MessageBody: string;
/**
* <p> The length of time, in seconds, for which to delay a specific message. Valid values:
* 0 to 900. Maximum: 15 minutes. Messages with a positive <code>DelaySeconds</code> value
* become available for processing after the delay period is finished. If you don't specify
* a value, the default value for the queue applies. </p>
* <note>
* <p>When you set <code>FifoQueue</code>, you can't set <code>DelaySeconds</code> per message. You can set this parameter only on a queue level.</p>
* </note>
*/
DelaySeconds?: number;
/**
* <p>Each message attribute consists of a <code>Name</code>, <code>Type</code>,
* and <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 Guide</i>.</p>
*/
MessageAttributes?: Record<string, MessageAttributeValue>;
/**
* <p>The message system attribute to send. Each message system attribute consists of a <code>Name</code>, <code>Type</code>, and <code>Value</code>.</p>
* <important>
* <ul>
* <li>
* <p>Currently, the only supported message system attribute is <code>AWSTraceHeader</code>.
* Its type must be <code>String</code> and its value must be a correctly formatted
* X-Ray trace header string.</p>
* </li>
* <li>
* <p>The size of a message system attribute doesn't count towards the total size of a message.</p>
* </li>
* </ul>
* </important>
*/
MessageSystemAttributes?: Record<string, MessageSystemAttributeValue>;
/**
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
* <p>The token used for deduplication of sent messages. If a message with a particular
* <code>MessageDeduplicationId</code> is sent successfully, any messages sent with the
* same <code>MessageDeduplicationId</code> are accepted successfully but aren't delivered
* during the 5-minute deduplication interval. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html"> Exactly-once processing</a> in the <i>Amazon SQS Developer
* Guide</i>.</p>
* <ul>
* <li>
* <p>Every message must have a unique <code>MessageDeduplicationId</code>,</p>
* <ul>
* <li>
* <p>You may provide a <code>MessageDeduplicationId</code>
* explicitly.</p>
* </li>
* <li>
* <p>If you aren't able to provide a <code>MessageDeduplicationId</code>
* and you enable <code>ContentBasedDeduplication</code> for your queue,
* Amazon SQS uses a SHA-256 hash to generate the
* <code>MessageDeduplicationId</code> using the body of the message
* (but not the attributes of the message). </p>
* </li>
* <li>
* <p>If you don't provide a <code>MessageDeduplicationId</code> and the
* queue doesn't have <code>ContentBasedDeduplication</code> set, the
* action fails with an error.</p>
* </li>
* <li>
* <p>If the queue has <code>ContentBasedDeduplication</code> set, your
* <code>MessageDeduplicationId</code> overrides the generated
* one.</p>
* </li>
* </ul>
* </li>
* <li>
* <p>When <code>ContentBasedDeduplication</code> is in effect, messages with
* identical content sent within the deduplication interval are treated as
* duplicates and only one copy of the message is delivered.</p>
* </li>
* <li>
* <p>If you send one message with <code>ContentBasedDeduplication</code> enabled
* and then another message with a <code>MessageDeduplicationId</code> that is the
* same as the one generated for the first <code>MessageDeduplicationId</code>, the
* two messages are treated as duplicates and only one copy of the message is
* delivered. </p>
* </li>
* </ul>
* <note>
* <p>The <code>MessageDeduplicationId</code> is available to the consumer of the
* message (this can be useful for troubleshooting delivery issues).</p>
* <p>If a message is sent successfully but the acknowledgement is lost and the message
* is resent with the same <code>MessageDeduplicationId</code> after the deduplication
* interval, Amazon SQS can't detect duplicate messages.</p>
* <p>Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.</p>
* </note>
* <p>The maximum length of <code>MessageDeduplicationId</code> is 128 characters.
* <code>MessageDeduplicationId</code> can contain alphanumeric characters
* (<code>a-z</code>, <code>A-Z</code>, <code>0-9</code>) and punctuation
* (<code>!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~</code>).</p>
* <p>For best practices of using <code>MessageDeduplicationId</code>, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html">Using the MessageDeduplicationId Property</a> in the <i>Amazon SQS Developer
* Guide</i>.</p>
*/
MessageDeduplicationId?: string;
/**
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
* <p>The tag that specifies that a message belongs to a specific message group. Messages
* that belong to the same message group are processed in a FIFO manner (however,
* messages in different message groups might be processed out of order). To interleave
* multiple ordered streams within a single queue, use <code>MessageGroupId</code> values
* (for example, session data for multiple users). In this scenario, multiple consumers can
* process the queue, but the session data of each user is processed in a FIFO
* fashion.</p>
* <ul>
* <li>
* <p>You must associate a non-empty <code>MessageGroupId</code> with a message. If
* you don't provide a <code>MessageGroupId</code>, the action fails.</p>
* </li>
* <li>
* <p>
* <code>ReceiveMessage</code> might return messages with multiple
* <code>MessageGroupId</code> values. For each <code>MessageGroupId</code>,
* the messages are sorted by time sent. The caller can't specify a
* <code>MessageGroupId</code>.</p>
* </li>
* </ul>
* <p>The length of <code>MessageGroupId</code> is 128 characters. Valid values:
* alphanumeric characters and punctuation
* <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~)</code>.</p>
* <p>For best practices of using <code>MessageGroupId</code>, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html">Using the MessageGroupId Property</a> in the <i>Amazon SQS Developer
* Guide</i>.</p>
* <important>
* <p>
* <code>MessageGroupId</code> is required for FIFO queues. You can't use it for
* Standard queues.</p>
* </important>
*/
MessageGroupId?: string;
}
export interface SendMessageResult {
/**
* <p>An MD5 digest of the non-URL-encoded message body string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
*/
MD5OfMessageBody?: string;
/**
* <p>An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
*/
MD5OfMessageAttributes?: string;
/**
* <p>An MD5 digest of the non-URL-encoded message system attribute string. You can use this
* attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest.</p>
*/
MD5OfMessageSystemAttributes?: string;
/**
* <p>An attribute containing the <code>MessageId</code> of the message sent to the queue.
* For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html">Queue and Message Identifiers</a> in the <i>Amazon SQS Developer
* Guide</i>. </p>
*/
MessageId?: string;
/**
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
* <p>The large, non-consecutive number that Amazon SQS assigns to each message.</p>
* <p>The length of <code>SequenceNumber</code> is 128 bits. <code>SequenceNumber</code>
* continues to increase for a particular <code>MessageGroupId</code>.</p>
*/
SequenceNumber?: string;
}
export interface SendMessageBatchItem {
/**
* <p>An identifier for a message in this batch used to communicate the result.</p>
* <note>
* <p>The <code>Id</code>s of a batch request need to be unique within a request.</p>
* <p>This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).</p>
* </note>
*/
Id?: string;
/**
* <p>The body of the message.</p>
*/
MessageBody: string;
/**
* <p>The length of time, in seconds, for which a specific message is delayed. Valid values:
* 0 to 900. Maximum: 15 minutes. Messages with a positive <code>DelaySeconds</code> value
* become available for processing after the delay period is finished. If you don't specify
* a value, the default value for the queue is applied. </p>
* <note>
* <p>When you set <code>FifoQueue</code>, you can't set <code>DelaySeconds</code> per message. You can set this parameter only on a queue level.</p>
* </note>
*/
DelaySeconds?: number;
/**
* <p>Each message attribute consists of a <code>Name</code>, <code>Type</code>,
* and <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 Guide</i>.</p>
*/
MessageAttributes?: Record<string, MessageAttributeValue>;
/**
* <p>The message system attribute to send Each message system attribute consists of a <code>Name</code>, <code>Type</code>, and <code>Value</code>.</p>
* <important>
* <ul>
* <li>
* <p>Currently, the only supported message system attribute is <code>AWSTraceHeader</code>.
* Its type must be <code>String</code> and its value must be a correctly formatted
* X-Ray trace header string.</p>
* </li>
* <li>
* <p>The size of a message system attribute doesn't count towards the total size of a message.</p>
* </li>
* </ul>
* </important>
*/
MessageSystemAttributes?: Record<string, MessageSystemAttributeValue>;
/**
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
* <p>The token used for deduplication of messages within a 5-minute minimum deduplication
* interval. If a message with a particular <code>MessageDeduplicationId</code> is sent
* successfully, subsequent messages with the same <code>MessageDeduplicationId</code> are
* accepted successfully but aren't delivered. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html"> Exactly-once processing</a> in the <i>Amazon SQS Developer
* Guide</i>.</p>
* <ul>
* <li>
* <p>Every message must have a unique <code>MessageDeduplicationId</code>,</p>
* <ul>
* <li>
* <p>You may provide a <code>MessageDeduplicationId</code>
* explicitly.</p>
* </li>
* <li>
* <p>If you aren't able to provide a <code>MessageDeduplicationId</code>
* and you enable <code>ContentBasedDeduplication</code> for your queue,
* Amazon SQS uses a SHA-256 hash to generate the
* <code>MessageDeduplicationId</code> using the body of the message
* (but not the attributes of the message). </p>
* </li>
* <li>
* <p>If you don't provide a <code>MessageDeduplicationId</code> and the
* queue doesn't have <code>ContentBasedDeduplication</code> set, the
* action fails with an error.</p>
* </li>
* <li>
* <p>If the queue has <code>ContentBasedDeduplication</code> set, your
* <code>MessageDeduplicationId</code> overrides the generated
* one.</p>
* </li>
* </ul>
* </li>
* <li>
* <p>When <code>ContentBasedDeduplication</code> is in effect, messages with
* identical content sent within the deduplication interval are treated as
* duplicates and only one copy of the message is delivered.</p>
* </li>
* <li>
* <p>If you send one message with <code>ContentBasedDeduplication</code> enabled
* and then another message with a <code>MessageDeduplicationId</code> that is the
* same as the one generated for the first <code>MessageDeduplicationId</code>, the
* two messages are treated as duplicates and only one copy of the message is
* delivered. </p>
* </li>
* </ul>
* <note>
* <p>The <code>MessageDeduplicationId</code> is available to the consumer of the
* message (this can be useful for troubleshooting delivery issues).</p>
* <p>If a message is sent successfully but the acknowledgement is lost and the message
* is resent with the same <code>MessageDeduplicationId</code> after the deduplication
* interval, Amazon SQS can't detect duplicate messages.</p>
* <p>Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.</p>
* </note>
* <p>The length of <code>MessageDeduplicationId</code> is 128 characters.
* <code>MessageDeduplicationId</code> can contain alphanumeric characters
* (<code>a-z</code>, <code>A-Z</code>, <code>0-9</code>) and punctuation
* (<code>!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~</code>).</p>
* <p>For best practices of using <code>MessageDeduplicationId</code>, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html">Using the MessageDeduplicationId Property</a> in the <i>Amazon SQS Developer
* Guide</i>.</p>
*/
MessageDeduplicationId?: string;
/**
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
* <p>The tag that specifies that a message belongs to a specific message group. Messages
* that belong to the same message group are processed in a FIFO manner (however,
* messages in different message groups might be processed out of order). To interleave
* multiple ordered streams within a single queue, use <code>MessageGroupId</code> values
* (for example, session data for multiple users). In this scenario, multiple consumers can
* process the queue, but the session data of each user is processed in a FIFO
* fashion.</p>
* <ul>
* <li>
* <p>You must associate a non-empty <code>MessageGroupId</code> with a message. If
* you don't provide a <code>MessageGroupId</code>, the action fails.</p>
* </li>
* <li>
* <p>
* <code>ReceiveMessage</code> might return messages with multiple
* <code>MessageGroupId</code> values. For each <code>MessageGroupId</code>,
* the messages are sorted by time sent. The caller can't specify a
* <code>MessageGroupId</code>.</p>
* </li>
* </ul>
* <p>The length of <code>MessageGroupId</code> is 128 characters. Valid values:
* alphanumeric characters and punctuation
* <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~)</code>.</p>
* <p>For best practices of using <code>MessageGroupId</code>, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html">Using the MessageGroupId Property</a> in the <i>Amazon SQS Developer
* Guide</i>.</p>
* <important>
* <p>
* <code>MessageGroupId</code> is required for FIFO queues. You can't use it for
* Standard queues.</p>
* </important>
*/
MessageGroupId?: string;
}
export interface SendMessageBatchResultEntry {
/**
* <p>An identifier for the message in this batch.</p>
*/
Id: string | undefined;
/**
* <p>An identifier for the message.</p>
*/
MessageId: string | undefined;
/**
* <p>An MD5 digest of the non-URL-encoded message body string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
*/
MD5OfMessageBody: string | undefined;
/**
* <p>An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
*/
MD5OfMessageAttributes?: string;
/**
* <p>An MD5 digest of the non-URL-encoded message system attribute string. You can use this
* attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
*/
MD5OfMessageSystemAttributes?: string;
/**
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
* <p>The large, non-consecutive number that Amazon SQS assigns to each message.</p>
* <p>The length of <code>SequenceNumber</code> is 128 bits. As <code>SequenceNumber</code>
* continues to increase for a particular <code>MessageGroupId</code>.</p>
*/
SequenceNumber?: string;
}
export interface BatchResultErrorEntry {
/**
* <p>The <code>Id</code> of an entry in a batch request.</p>
*/
Id: string | undefined;
/**
* <p>Specifies whether the error happened due to the caller of the batch API action.</p>
*/
SenderFault: boolean | undefined;
/**
* <p>An error code representing why the action failed on this entry.</p>
*/
Code: string | undefined;
/**
* <p>A message explaining why the action failed on this entry.</p>
*/
Message?: string;
}
export interface SendMessageBatchResult {
/**
* <p>A list of <code>
* <a>SendMessageBatchResultEntry</a>
* </code> items.</p>
*/
Successful: SendMessageBatchResultEntry[] | undefined;
/**
* <p>A list of <code>
* <a>BatchResultErrorEntry</a>
* </code> items with error
* details about each message that can't be enqueued.</p>
*/
Failed: BatchResultErrorEntry[] | undefined;
}
export interface ReceiveMessage {
/**
* <p>A list of attributes that need to be returned along with each message. These
* attributes include:</p>
* <ul>
* <li>
* <p>
* <code>All</code> – Returns all values.</p>
* </li>
* <li>
* <p>
* <code>ApproximateFirstReceiveTimestamp</code> – Returns the time the
* message was first received from the queue (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a> in
* milliseconds).</p>
* </li>
* <li>
* <p>
* <code>ApproximateReceiveCount</code> – Returns the number of times a
* message has been received across all queues but not deleted.</p>
* </li>
* <li>
* <p>
* <code>AWSTraceHeader</code> – Returns the X-Ray trace
* header string. </p>
* </li>
* <li>
* <p>
* <code>SenderId</code>
* </p>
* <ul>
* <li>
* <p>For a user, returns the user ID, for example
* <code>ABCDEFGHI1JKLMNOPQ23R</code>.</p>
* </li>
* <li>
* <p>For an IAM role, returns the IAM role ID, for example
* <code>ABCDE1F2GH3I4JK5LMNOP:i-a123b456</code>.</p>
* </li>
* </ul>
* </li>
* <li>
* <p>
* <code>SentTimestamp</code> – Returns the time the message was sent to the
* queue (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a> in
* milliseconds).</p>
* </li>
* <li>
* <p>
* <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption
* using SQS owned encryption keys. Only one server-side encryption option is
* supported per queue (for example, <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html">SSE-KMS</a> or <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html">SSE-SQS</a>).</p>
* </li>
* <li>
* <p>
* <code>MessageDeduplicationId</code> – Returns the value provided by the
* producer that calls the <code>
* <a>SendMessage</a>
* </code>
* action.</p>
* </li>
* <li>
* <p>
* <code>MessageGroupId</code> – Returns the value provided by the
* producer that calls the <code>
* <a>SendMessage</a>
* </code> action.
* Messages with the same <code>MessageGroupId</code> are returned in
* sequence.</p>
* </li>
* <li>
* <p>
* <code>SequenceNumber</code> – Returns the value provided by
* Amazon SQS.</p>
* </li>
* </ul>
*/
// eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents
AttributeNames?: (QueueAttributeName | string)[];
/**
* <p>The name of the message attribute, where <i>N</i> is the index.</p>
* <ul>
* <li>
* <p>The name can contain alphanumeric characters and the underscore
* (<code>_</code>), hyphen (<code>-</code>), and period
* (<code>.</code>).</p>
* </li>
* <li>
* <p>The name is case-sensitive and must be unique among all attribute names for
* the message.</p>
* </li>
* <li>
* <p>The name must not start with AWS-reserved prefixes such as <code>AWS.</code>
* or <code>Amazon.</code> (or any casing variants).</p>
* </li>
* <li>
* <p>The name must not start or end with a period (<code>.</code>), and it should
* not have periods in succession (<code>..</code>).</p>
* </li>
* <li>
* <p>The name can be up to 256 characters long.</p>
* </li>
* </ul>
* <p>When using <code>ReceiveMessage</code>, you can send a list of attribute names to
* receive, or you can return all of the attributes by specifying <code>All</code> or
* <code>.*</code> in your request. You can also use all message attributes starting
* with a prefix, for example <code>bar.*</code>.</p>
*/
MessageAttributeNames?: string[];
/**
* <p>The maximum number of messages to return. Amazon SQS never returns more messages than this
* value (however, fewer messages might be returned). Valid values: 1 to 10. Default:
* 1.</p>
*/
MaxNumberOfMessages?: number;
/**
* <p>The duration (in seconds) that the received messages are hidden from subsequent
* retrieve requests after being retrieved by a <code>ReceiveMessage</code> request.</p>
*/
VisibilityTimeout?: number;
/**
* <p>The duration (in seconds) for which the call waits for a message to arrive in the
* queue before returning. If a message is available, the call returns sooner than
* <code>WaitTimeSeconds</code>. If no messages are available and the wait time
* expires, the call returns successfully with an empty list of messages.</p>
* <important>
* <p>To avoid HTTP errors, ensure that the HTTP response timeout for
* <code>ReceiveMessage</code> requests is longer than the
* <code>WaitTimeSeconds</code> parameter. For example, with the Java SDK, you can
* set HTTP transport settings using the <a href="https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/nio/netty/NettyNioAsyncHttpClient.html"> NettyNioAsyncHttpClient</a> for asynchronous clients, or the <a href="https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.html"> ApacheHttpClient</a> for synchronous clients. </p>
* </important>
*/
WaitTimeSeconds?: number;
/**
* <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
* <p>The token used for deduplication of <code>ReceiveMessage</code> calls. If a networking
* issue occurs after a <code>ReceiveMessage</code> action, and instead of a response you
* receive a generic error, it is possible to retry the same action with an identical
* <code>ReceiveRequestAttemptId</code> to retrieve the same set of messages, even if
* their visibility timeout has not yet expired.</p>
* <ul>
* <li>
* <p>You can use <code>ReceiveRequestAttemptId</code> only for 5 minutes after a
* <code>ReceiveMessage</code> action.</p>
* </li>
* <li>
* <p>When you set <code>FifoQueue</code>, a caller of the
* <code>ReceiveMessage</code> action can provide a
* <code>ReceiveRequestAttemptId</code> explicitly.</p>
* </li>
* <li>
* <p>If a caller of the <code>ReceiveMessage</code> action doesn't provide a
* <code>ReceiveRequestAttemptId</code>, Amazon SQS generates a
* <code>ReceiveRequestAttemptId</code>.</p>
* </li>
* <li>
* <p>It is possible to retry the <code>ReceiveMessage</code> action with the same
* <code>ReceiveRequestAttemptId</code> if none of the messages have been
* modified (deleted or had their visibility changes).</p>
* </li>
* <li>
* <p>During a visibility timeout, subsequent calls with the same
* <code>ReceiveRequestAttemptId</code> return the same messages and receipt
* handles. If a retry occurs within the deduplication interval, it resets the
* visibility timeout. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility Timeout</a> in the <i>Amazon SQS Developer
* Guide</i>.</p>
* <important>
* <p>If a caller of the <code>ReceiveMessage</code> action still processes
* messages when the visibility timeout expires and messages become visible,
* another worker consuming from the same queue can receive the same messages
* and therefore process duplicates. Also, if a consumer whose message
* processing time is longer than the visibility timeout tries to delete the
* processed messages, the action fails with an error.</p>
* <p>To mitigate this effect, ensure that your application observes a safe
* threshold before the visibility timeout expires and extend the visibility
* timeout as necessary.</p>
* </important>
* </li>
* <li>
* <p>While messages with a particular <code>MessageGroupId</code> are invisible, no
* more messages belonging to the same <code>MessageGroupId</code> are returned
* until the visibility timeout expires. You can still receive messages with
* another <code>MessageGroupId</code> as long as it is also visible.</p>
* </li>
* <li>
* <p>If a caller of <code>ReceiveMessage</code> can't track the
* <code>ReceiveRequestAttemptId</code>, no retries work until the original
* visibility timeout expires. As a result, delays might occur but the messages in
* the queue remain in a strict order.</p>
* </li>
* </ul>
* <p>The maximum length of <code>ReceiveRequestAttemptId</code> is 128 characters.
* <code>ReceiveRequestAttemptId</code> can contain alphanumeric characters
* (<code>a-z</code>, <code>A-Z</code>, <code>0-9</code>) and punctuation
* (<code>!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~</code>).</p>
* <p>For best practices of using <code>ReceiveRequestAttemptId</code>, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-receiverequestattemptid-request-parameter.html">Using the ReceiveRequestAttemptId Request Parameter</a> in the <i>Amazon SQS
* Developer Guide</i>.</p>
*/
ReceiveRequestAttemptId?: string;
}
export interface ReceiveMessageResult {
/**
* <p>A list of messages.</p>
*/
Messages?: Message[];
}