@aws-sdk/client-sqs 3.379.1 → 3.385.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.
@@ -6,11 +6,13 @@ import { SQSServiceException as __BaseException } from "./SQSServiceException";
6
6
  */
7
7
  export interface AddPermissionRequest {
8
8
  /**
9
+ * @public
9
10
  * <p>The URL of the Amazon SQS queue to which permissions are added.</p>
10
11
  * <p>Queue URLs and names are case-sensitive.</p>
11
12
  */
12
13
  QueueUrl: string | undefined;
13
14
  /**
15
+ * @public
14
16
  * <p>The unique identification of the permission you're setting (for example,
15
17
  * <code>AliceSendMessage</code>). Maximum 80 characters. Allowed characters include
16
18
  * alphanumeric characters, hyphens (<code>-</code>), and underscores
@@ -18,12 +20,14 @@ export interface AddPermissionRequest {
18
20
  */
19
21
  Label: string | undefined;
20
22
  /**
23
+ * @public
21
24
  * <p>The Amazon Web 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
22
25
  * permission. For information about locating the Amazon Web Services 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 Services Identifiers</a> in the <i>Amazon SQS Developer
23
26
  * Guide</i>.</p>
24
27
  */
25
28
  AWSAccountIds: string[] | undefined;
26
29
  /**
30
+ * @public
27
31
  * <p>The action the client wants to allow for the specified principal. Valid values: the
28
32
  * name of any action or <code>*</code>.</p>
29
33
  * <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
@@ -56,6 +60,7 @@ export declare class OverLimit extends __BaseException {
56
60
  */
57
61
  export interface CancelMessageMoveTaskRequest {
58
62
  /**
63
+ * @public
59
64
  * <p>An identifier associated with a message movement task.</p>
60
65
  */
61
66
  TaskHandle: string | undefined;
@@ -65,6 +70,7 @@ export interface CancelMessageMoveTaskRequest {
65
70
  */
66
71
  export interface CancelMessageMoveTaskResult {
67
72
  /**
73
+ * @public
68
74
  * <p>The approximate number of messages already moved to the destination queue.</p>
69
75
  */
70
76
  ApproximateNumberOfMessagesMoved?: number;
@@ -98,11 +104,13 @@ export declare class UnsupportedOperation extends __BaseException {
98
104
  */
99
105
  export interface ChangeMessageVisibilityRequest {
100
106
  /**
107
+ * @public
101
108
  * <p>The URL of the Amazon SQS queue whose message's visibility is changed.</p>
102
109
  * <p>Queue URLs and names are case-sensitive.</p>
103
110
  */
104
111
  QueueUrl: string | undefined;
105
112
  /**
113
+ * @public
106
114
  * <p>The receipt handle associated with the message, whose visibility timeout is changed.
107
115
  * This parameter is returned by the <code>
108
116
  * <a>ReceiveMessage</a>
@@ -111,6 +119,7 @@ export interface ChangeMessageVisibilityRequest {
111
119
  */
112
120
  ReceiptHandle: string | undefined;
113
121
  /**
122
+ * @public
114
123
  * <p>The new value for the message's visibility timeout (in seconds). Values range:
115
124
  * <code>0</code> to <code>43200</code>. Maximum: 12 hours.</p>
116
125
  */
@@ -160,6 +169,7 @@ export declare class BatchEntryIdsNotDistinct extends __BaseException {
160
169
  */
161
170
  export interface ChangeMessageVisibilityBatchRequestEntry {
162
171
  /**
172
+ * @public
163
173
  * <p>An identifier for this particular receipt handle used to communicate the
164
174
  * result.</p>
165
175
  * <note>
@@ -169,10 +179,12 @@ export interface ChangeMessageVisibilityBatchRequestEntry {
169
179
  */
170
180
  Id: string | undefined;
171
181
  /**
182
+ * @public
172
183
  * <p>A receipt handle.</p>
173
184
  */
174
185
  ReceiptHandle: string | undefined;
175
186
  /**
187
+ * @public
176
188
  * <p>The new value (in seconds) for the message's visibility timeout.</p>
177
189
  */
178
190
  VisibilityTimeout?: number;
@@ -183,11 +195,13 @@ export interface ChangeMessageVisibilityBatchRequestEntry {
183
195
  */
184
196
  export interface ChangeMessageVisibilityBatchRequest {
185
197
  /**
198
+ * @public
186
199
  * <p>The URL of the Amazon SQS queue whose messages' visibility is changed.</p>
187
200
  * <p>Queue URLs and names are case-sensitive.</p>
188
201
  */
189
202
  QueueUrl: string | undefined;
190
203
  /**
204
+ * @public
191
205
  * <p>Lists the receipt handles of the messages for which the visibility timeout must be
192
206
  * changed.</p>
193
207
  */
@@ -200,18 +214,22 @@ export interface ChangeMessageVisibilityBatchRequest {
200
214
  */
201
215
  export interface BatchResultErrorEntry {
202
216
  /**
217
+ * @public
203
218
  * <p>The <code>Id</code> of an entry in a batch request.</p>
204
219
  */
205
220
  Id: string | undefined;
206
221
  /**
222
+ * @public
207
223
  * <p>Specifies whether the error happened due to the caller of the batch API action.</p>
208
224
  */
209
225
  SenderFault: boolean | undefined;
210
226
  /**
227
+ * @public
211
228
  * <p>An error code representing why the action failed on this entry.</p>
212
229
  */
213
230
  Code: string | undefined;
214
231
  /**
232
+ * @public
215
233
  * <p>A message explaining why the action failed on this entry.</p>
216
234
  */
217
235
  Message?: string;
@@ -224,6 +242,7 @@ export interface BatchResultErrorEntry {
224
242
  */
225
243
  export interface ChangeMessageVisibilityBatchResultEntry {
226
244
  /**
245
+ * @public
227
246
  * <p>Represents a message whose visibility timeout has been changed successfully.</p>
228
247
  */
229
248
  Id: string | undefined;
@@ -240,6 +259,7 @@ export interface ChangeMessageVisibilityBatchResultEntry {
240
259
  */
241
260
  export interface ChangeMessageVisibilityBatchResult {
242
261
  /**
262
+ * @public
243
263
  * <p>A list of <code>
244
264
  * <a>ChangeMessageVisibilityBatchResultEntry</a>
245
265
  * </code>
@@ -247,6 +267,7 @@ export interface ChangeMessageVisibilityBatchResult {
247
267
  */
248
268
  Successful: ChangeMessageVisibilityBatchResultEntry[] | undefined;
249
269
  /**
270
+ * @public
250
271
  * <p>A list of <code>
251
272
  * <a>BatchResultErrorEntry</a>
252
273
  * </code> items.</p>
@@ -328,6 +349,7 @@ export type QueueAttributeName = (typeof QueueAttributeName)[keyof typeof QueueA
328
349
  */
329
350
  export interface CreateQueueRequest {
330
351
  /**
352
+ * @public
331
353
  * <p>The name of the new queue. The following limits apply to this name:</p>
332
354
  * <ul>
333
355
  * <li>
@@ -345,6 +367,7 @@ export interface CreateQueueRequest {
345
367
  */
346
368
  QueueName: string | undefined;
347
369
  /**
370
+ * @public
348
371
  * <p>Add cost allocation tags to the specified Amazon SQS queue. For an overview, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html">Tagging
349
372
  * Your Amazon SQS Queues</a> in the <i>Amazon SQS Developer Guide</i>.</p>
350
373
  * <p>When you use queue tags, keep the following guidelines in mind:</p>
@@ -375,6 +398,7 @@ export interface CreateQueueRequest {
375
398
  */
376
399
  tags?: Record<string, string>;
377
400
  /**
401
+ * @public
378
402
  * <p>A map of attributes with their corresponding values.</p>
379
403
  * <p>The following lists the names, descriptions, and values of the special request
380
404
  * parameters that the <code>CreateQueue</code> action uses:</p>
@@ -624,6 +648,7 @@ export interface CreateQueueRequest {
624
648
  */
625
649
  export interface CreateQueueResult {
626
650
  /**
651
+ * @public
627
652
  * <p>The URL of the created Amazon SQS queue.</p>
628
653
  */
629
654
  QueueUrl?: string;
@@ -660,11 +685,13 @@ export declare class QueueNameExists extends __BaseException {
660
685
  */
661
686
  export interface DeleteMessageRequest {
662
687
  /**
688
+ * @public
663
689
  * <p>The URL of the Amazon SQS queue from which messages are deleted.</p>
664
690
  * <p>Queue URLs and names are case-sensitive.</p>
665
691
  */
666
692
  QueueUrl: string | undefined;
667
693
  /**
694
+ * @public
668
695
  * <p>The receipt handle associated with the message to delete.</p>
669
696
  */
670
697
  ReceiptHandle: string | undefined;
@@ -687,6 +714,7 @@ export declare class InvalidIdFormat extends __BaseException {
687
714
  */
688
715
  export interface DeleteMessageBatchRequestEntry {
689
716
  /**
717
+ * @public
690
718
  * <p>The identifier for this particular receipt handle. This is used to communicate the
691
719
  * result.</p>
692
720
  * <note>
@@ -696,6 +724,7 @@ export interface DeleteMessageBatchRequestEntry {
696
724
  */
697
725
  Id: string | undefined;
698
726
  /**
727
+ * @public
699
728
  * <p>A receipt handle.</p>
700
729
  */
701
730
  ReceiptHandle: string | undefined;
@@ -706,11 +735,13 @@ export interface DeleteMessageBatchRequestEntry {
706
735
  */
707
736
  export interface DeleteMessageBatchRequest {
708
737
  /**
738
+ * @public
709
739
  * <p>The URL of the Amazon SQS queue from which messages are deleted.</p>
710
740
  * <p>Queue URLs and names are case-sensitive.</p>
711
741
  */
712
742
  QueueUrl: string | undefined;
713
743
  /**
744
+ * @public
714
745
  * <p>Lists the receipt handles for the messages to be deleted.</p>
715
746
  */
716
747
  Entries: DeleteMessageBatchRequestEntry[] | undefined;
@@ -723,6 +754,7 @@ export interface DeleteMessageBatchRequest {
723
754
  */
724
755
  export interface DeleteMessageBatchResultEntry {
725
756
  /**
757
+ * @public
726
758
  * <p>Represents a successfully deleted message.</p>
727
759
  */
728
760
  Id: string | undefined;
@@ -739,12 +771,14 @@ export interface DeleteMessageBatchResultEntry {
739
771
  */
740
772
  export interface DeleteMessageBatchResult {
741
773
  /**
774
+ * @public
742
775
  * <p>A list of <code>
743
776
  * <a>DeleteMessageBatchResultEntry</a>
744
777
  * </code> items.</p>
745
778
  */
746
779
  Successful: DeleteMessageBatchResultEntry[] | undefined;
747
780
  /**
781
+ * @public
748
782
  * <p>A list of <code>
749
783
  * <a>BatchResultErrorEntry</a>
750
784
  * </code> items.</p>
@@ -757,6 +791,7 @@ export interface DeleteMessageBatchResult {
757
791
  */
758
792
  export interface DeleteQueueRequest {
759
793
  /**
794
+ * @public
760
795
  * <p>The URL of the Amazon SQS queue to delete.</p>
761
796
  * <p>Queue URLs and names are case-sensitive.</p>
762
797
  */
@@ -768,11 +803,13 @@ export interface DeleteQueueRequest {
768
803
  */
769
804
  export interface GetQueueAttributesRequest {
770
805
  /**
806
+ * @public
771
807
  * <p>The URL of the Amazon SQS queue whose attribute information is retrieved.</p>
772
808
  * <p>Queue URLs and names are case-sensitive.</p>
773
809
  */
774
810
  QueueUrl: string | undefined;
775
811
  /**
812
+ * @public
776
813
  * <p>A list of attributes for which to retrieve information.</p>
777
814
  * <p>The <code>AttributeNames</code> parameter is optional, but if you don't specify values
778
815
  * for this parameter, the request returns empty results.</p>
@@ -1009,6 +1046,7 @@ export interface GetQueueAttributesRequest {
1009
1046
  */
1010
1047
  export interface GetQueueAttributesResult {
1011
1048
  /**
1049
+ * @public
1012
1050
  * <p>A map of attributes to their respective values.</p>
1013
1051
  */
1014
1052
  Attributes?: Record<string, string>;
@@ -1031,6 +1069,7 @@ export declare class InvalidAttributeName extends __BaseException {
1031
1069
  */
1032
1070
  export interface GetQueueUrlRequest {
1033
1071
  /**
1072
+ * @public
1034
1073
  * <p>The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values:
1035
1074
  * alphanumeric characters, hyphens (<code>-</code>), and underscores
1036
1075
  * (<code>_</code>).</p>
@@ -1038,6 +1077,7 @@ export interface GetQueueUrlRequest {
1038
1077
  */
1039
1078
  QueueName: string | undefined;
1040
1079
  /**
1080
+ * @public
1041
1081
  * <p>The Amazon Web Services account ID of the account that created the queue.</p>
1042
1082
  */
1043
1083
  QueueOwnerAWSAccountId?: string;
@@ -1049,6 +1089,7 @@ export interface GetQueueUrlRequest {
1049
1089
  */
1050
1090
  export interface GetQueueUrlResult {
1051
1091
  /**
1092
+ * @public
1052
1093
  * <p>The URL of the queue.</p>
1053
1094
  */
1054
1095
  QueueUrl?: string;
@@ -1071,15 +1112,18 @@ export declare class QueueDoesNotExist extends __BaseException {
1071
1112
  */
1072
1113
  export interface ListDeadLetterSourceQueuesRequest {
1073
1114
  /**
1115
+ * @public
1074
1116
  * <p>The URL of a dead-letter queue.</p>
1075
1117
  * <p>Queue URLs and names are case-sensitive.</p>
1076
1118
  */
1077
1119
  QueueUrl: string | undefined;
1078
1120
  /**
1121
+ * @public
1079
1122
  * <p>Pagination token to request the next set of results.</p>
1080
1123
  */
1081
1124
  NextToken?: string;
1082
1125
  /**
1126
+ * @public
1083
1127
  * <p>Maximum number of results to include in the response. Value range is 1 to 1000. You
1084
1128
  * must set <code>MaxResults</code> to receive a value for <code>NextToken</code> in the
1085
1129
  * response.</p>
@@ -1092,11 +1136,13 @@ export interface ListDeadLetterSourceQueuesRequest {
1092
1136
  */
1093
1137
  export interface ListDeadLetterSourceQueuesResult {
1094
1138
  /**
1139
+ * @public
1095
1140
  * <p>A list of source queue URLs that have the <code>RedrivePolicy</code> queue attribute
1096
1141
  * configured with a dead-letter queue.</p>
1097
1142
  */
1098
1143
  queueUrls: string[] | undefined;
1099
1144
  /**
1145
+ * @public
1100
1146
  * <p>Pagination token to include in the next request. Token value is <code>null</code> if
1101
1147
  * there are no additional results to request, or if you did not set
1102
1148
  * <code>MaxResults</code> in the request.</p>
@@ -1108,10 +1154,12 @@ export interface ListDeadLetterSourceQueuesResult {
1108
1154
  */
1109
1155
  export interface ListMessageMoveTasksRequest {
1110
1156
  /**
1157
+ * @public
1111
1158
  * <p>The ARN of the queue whose message movement tasks are to be listed.</p>
1112
1159
  */
1113
1160
  SourceArn: string | undefined;
1114
1161
  /**
1162
+ * @public
1115
1163
  * <p>The maximum number of results to include in the response. The default is 1, which
1116
1164
  * provides the most recent message movement task. The upper limit is 10.</p>
1117
1165
  */
@@ -1123,21 +1171,25 @@ export interface ListMessageMoveTasksRequest {
1123
1171
  */
1124
1172
  export interface ListMessageMoveTasksResultEntry {
1125
1173
  /**
1174
+ * @public
1126
1175
  * <p>An identifier associated with a message movement task. When this field is returned in
1127
1176
  * the response of the <code>ListMessageMoveTasks</code> action, it is only populated for
1128
1177
  * tasks that are in RUNNING status.</p>
1129
1178
  */
1130
1179
  TaskHandle?: string;
1131
1180
  /**
1181
+ * @public
1132
1182
  * <p>The status of the message movement task. Possible values are: RUNNING, COMPLETED,
1133
1183
  * CANCELLING, CANCELLED, and FAILED.</p>
1134
1184
  */
1135
1185
  Status?: string;
1136
1186
  /**
1187
+ * @public
1137
1188
  * <p>The ARN of the queue that contains the messages to be moved to another queue.</p>
1138
1189
  */
1139
1190
  SourceArn?: string;
1140
1191
  /**
1192
+ * @public
1141
1193
  * <p>The ARN of the destination queue if it has been specified in the
1142
1194
  * <code>StartMessageMoveTask</code> request. If a <code>DestinationArn</code> has not
1143
1195
  * been specified in the <code>StartMessageMoveTask</code> request, this field value will
@@ -1145,6 +1197,7 @@ export interface ListMessageMoveTasksResultEntry {
1145
1197
  */
1146
1198
  DestinationArn?: string;
1147
1199
  /**
1200
+ * @public
1148
1201
  * <p>The number of messages to be moved per second (the message movement rate), if it has
1149
1202
  * been specified in the <code>StartMessageMoveTask</code> request. If a
1150
1203
  * <code>MaxNumberOfMessagesPerSecond</code> has not been specified in the
@@ -1152,19 +1205,23 @@ export interface ListMessageMoveTasksResultEntry {
1152
1205
  */
1153
1206
  MaxNumberOfMessagesPerSecond?: number;
1154
1207
  /**
1208
+ * @public
1155
1209
  * <p>The approximate number of messages already moved to the destination queue.</p>
1156
1210
  */
1157
1211
  ApproximateNumberOfMessagesMoved?: number;
1158
1212
  /**
1213
+ * @public
1159
1214
  * <p>The number of messages to be moved from the source queue. This number is obtained at
1160
1215
  * the time of starting the message movement task.</p>
1161
1216
  */
1162
1217
  ApproximateNumberOfMessagesToMove?: number;
1163
1218
  /**
1219
+ * @public
1164
1220
  * <p>The task failure reason (only included if the task status is FAILED).</p>
1165
1221
  */
1166
1222
  FailureReason?: string;
1167
1223
  /**
1224
+ * @public
1168
1225
  * <p>The timestamp of starting the message movement task.</p>
1169
1226
  */
1170
1227
  StartedTimestamp?: number;
@@ -1174,6 +1231,7 @@ export interface ListMessageMoveTasksResultEntry {
1174
1231
  */
1175
1232
  export interface ListMessageMoveTasksResult {
1176
1233
  /**
1234
+ * @public
1177
1235
  * <p>A list of message movement tasks and their attributes.</p>
1178
1236
  */
1179
1237
  Results?: ListMessageMoveTasksResultEntry[];
@@ -1184,16 +1242,19 @@ export interface ListMessageMoveTasksResult {
1184
1242
  */
1185
1243
  export interface ListQueuesRequest {
1186
1244
  /**
1245
+ * @public
1187
1246
  * <p>A string to use for filtering the list results. Only those queues whose name begins
1188
1247
  * with the specified string are returned.</p>
1189
1248
  * <p>Queue URLs and names are case-sensitive.</p>
1190
1249
  */
1191
1250
  QueueNamePrefix?: string;
1192
1251
  /**
1252
+ * @public
1193
1253
  * <p>Pagination token to request the next set of results.</p>
1194
1254
  */
1195
1255
  NextToken?: string;
1196
1256
  /**
1257
+ * @public
1197
1258
  * <p>Maximum number of results to include in the response. Value range is 1 to 1000. You
1198
1259
  * must set <code>MaxResults</code> to receive a value for <code>NextToken</code> in the
1199
1260
  * response.</p>
@@ -1206,12 +1267,14 @@ export interface ListQueuesRequest {
1206
1267
  */
1207
1268
  export interface ListQueuesResult {
1208
1269
  /**
1270
+ * @public
1209
1271
  * <p>Pagination token to include in the next request. Token value is <code>null</code> if
1210
1272
  * there are no additional results to request, or if you did not set
1211
1273
  * <code>MaxResults</code> in the request.</p>
1212
1274
  */
1213
1275
  NextToken?: string;
1214
1276
  /**
1277
+ * @public
1215
1278
  * <p>A list of queue URLs, up to 1,000 entries, or the value of <code>MaxResults</code>
1216
1279
  * that you sent in the request.</p>
1217
1280
  */
@@ -1222,6 +1285,7 @@ export interface ListQueuesResult {
1222
1285
  */
1223
1286
  export interface ListQueueTagsRequest {
1224
1287
  /**
1288
+ * @public
1225
1289
  * <p>The URL of the queue.</p>
1226
1290
  */
1227
1291
  QueueUrl: string | undefined;
@@ -1231,6 +1295,7 @@ export interface ListQueueTagsRequest {
1231
1295
  */
1232
1296
  export interface ListQueueTagsResult {
1233
1297
  /**
1298
+ * @public
1234
1299
  * <p>The list of all tags added to the specified queue.</p>
1235
1300
  */
1236
1301
  Tags?: Record<string, string>;
@@ -1255,6 +1320,7 @@ export declare class PurgeQueueInProgress extends __BaseException {
1255
1320
  */
1256
1321
  export interface PurgeQueueRequest {
1257
1322
  /**
1323
+ * @public
1258
1324
  * <p>The URL of the queue from which the <code>PurgeQueue</code> action deletes
1259
1325
  * messages.</p>
1260
1326
  * <p>Queue URLs and names are case-sensitive.</p>
@@ -1267,11 +1333,13 @@ export interface PurgeQueueRequest {
1267
1333
  */
1268
1334
  export interface ReceiveMessageRequest {
1269
1335
  /**
1336
+ * @public
1270
1337
  * <p>The URL of the Amazon SQS queue from which messages are received.</p>
1271
1338
  * <p>Queue URLs and names are case-sensitive.</p>
1272
1339
  */
1273
1340
  QueueUrl: string | undefined;
1274
1341
  /**
1342
+ * @public
1275
1343
  * <p>A list of attributes that need to be returned along with each message. These
1276
1344
  * attributes include:</p>
1277
1345
  * <ul>
@@ -1348,6 +1416,7 @@ export interface ReceiveMessageRequest {
1348
1416
  */
1349
1417
  AttributeNames?: (QueueAttributeName | string)[];
1350
1418
  /**
1419
+ * @public
1351
1420
  * <p>The name of the message attribute, where <i>N</i> is the index.</p>
1352
1421
  * <ul>
1353
1422
  * <li>
@@ -1378,17 +1447,20 @@ export interface ReceiveMessageRequest {
1378
1447
  */
1379
1448
  MessageAttributeNames?: string[];
1380
1449
  /**
1450
+ * @public
1381
1451
  * <p>The maximum number of messages to return. Amazon SQS never returns more messages than this
1382
1452
  * value (however, fewer messages might be returned). Valid values: 1 to 10. Default:
1383
1453
  * 1.</p>
1384
1454
  */
1385
1455
  MaxNumberOfMessages?: number;
1386
1456
  /**
1457
+ * @public
1387
1458
  * <p>The duration (in seconds) that the received messages are hidden from subsequent
1388
1459
  * retrieve requests after being retrieved by a <code>ReceiveMessage</code> request.</p>
1389
1460
  */
1390
1461
  VisibilityTimeout?: number;
1391
1462
  /**
1463
+ * @public
1392
1464
  * <p>The duration (in seconds) for which the call waits for a message to arrive in the
1393
1465
  * queue before returning. If a message is available, the call returns sooner than
1394
1466
  * <code>WaitTimeSeconds</code>. If no messages are available and the wait time
@@ -1402,6 +1474,7 @@ export interface ReceiveMessageRequest {
1402
1474
  */
1403
1475
  WaitTimeSeconds?: number;
1404
1476
  /**
1477
+ * @public
1405
1478
  * <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
1406
1479
  * <p>The token used for deduplication of <code>ReceiveMessage</code> calls. If a networking
1407
1480
  * issue occurs after a <code>ReceiveMessage</code> action, and instead of a response you
@@ -1502,24 +1575,29 @@ export type MessageSystemAttributeName = (typeof MessageSystemAttributeName)[key
1502
1575
  */
1503
1576
  export interface MessageAttributeValue {
1504
1577
  /**
1578
+ * @public
1505
1579
  * <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
1506
1580
  * Characters</a>.</p>
1507
1581
  */
1508
1582
  StringValue?: string;
1509
1583
  /**
1584
+ * @public
1510
1585
  * <p>Binary type attributes can store any binary data, such as compressed data, encrypted
1511
1586
  * data, or images.</p>
1512
1587
  */
1513
1588
  BinaryValue?: Uint8Array;
1514
1589
  /**
1590
+ * @public
1515
1591
  * <p>Not implemented. Reserved for future use.</p>
1516
1592
  */
1517
1593
  StringListValues?: string[];
1518
1594
  /**
1595
+ * @public
1519
1596
  * <p>Not implemented. Reserved for future use.</p>
1520
1597
  */
1521
1598
  BinaryListValues?: Uint8Array[];
1522
1599
  /**
1600
+ * @public
1523
1601
  * <p>Amazon SQS supports the following logical data types: <code>String</code>,
1524
1602
  * <code>Number</code>, and <code>Binary</code>. For the <code>Number</code> data type,
1525
1603
  * you must use <code>StringValue</code>.</p>
@@ -1534,25 +1612,30 @@ export interface MessageAttributeValue {
1534
1612
  */
1535
1613
  export interface Message {
1536
1614
  /**
1615
+ * @public
1537
1616
  * <p>A unique identifier for the message. A <code>MessageId</code>is considered unique
1538
1617
  * across all Amazon Web Services accounts for an extended period of time.</p>
1539
1618
  */
1540
1619
  MessageId?: string;
1541
1620
  /**
1621
+ * @public
1542
1622
  * <p>An identifier associated with the act of receiving the message. A new receipt handle
1543
1623
  * is returned every time you receive a message. When deleting a message, you provide the
1544
1624
  * last received receipt handle to delete the message.</p>
1545
1625
  */
1546
1626
  ReceiptHandle?: string;
1547
1627
  /**
1628
+ * @public
1548
1629
  * <p>An MD5 digest of the non-URL-encoded message body string.</p>
1549
1630
  */
1550
1631
  MD5OfBody?: string;
1551
1632
  /**
1633
+ * @public
1552
1634
  * <p>The message's contents (not URL-encoded).</p>
1553
1635
  */
1554
1636
  Body?: string;
1555
1637
  /**
1638
+ * @public
1556
1639
  * <p>A map of the attributes requested in <code>
1557
1640
  * <a>ReceiveMessage</a>
1558
1641
  * </code> to
@@ -1601,10 +1684,12 @@ export interface Message {
1601
1684
  */
1602
1685
  Attributes?: Record<string, string>;
1603
1686
  /**
1687
+ * @public
1604
1688
  * <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>
1605
1689
  */
1606
1690
  MD5OfMessageAttributes?: string;
1607
1691
  /**
1692
+ * @public
1608
1693
  * <p>Each message attribute consists of a <code>Name</code>, <code>Type</code>,
1609
1694
  * and <code>Value</code>. For more information, see
1610
1695
  * <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes">Amazon SQS
@@ -1618,6 +1703,7 @@ export interface Message {
1618
1703
  */
1619
1704
  export interface ReceiveMessageResult {
1620
1705
  /**
1706
+ * @public
1621
1707
  * <p>A list of messages.</p>
1622
1708
  */
1623
1709
  Messages?: Message[];
@@ -1628,11 +1714,13 @@ export interface ReceiveMessageResult {
1628
1714
  */
1629
1715
  export interface RemovePermissionRequest {
1630
1716
  /**
1717
+ * @public
1631
1718
  * <p>The URL of the Amazon SQS queue from which permissions are removed.</p>
1632
1719
  * <p>Queue URLs and names are case-sensitive.</p>
1633
1720
  */
1634
1721
  QueueUrl: string | undefined;
1635
1722
  /**
1723
+ * @public
1636
1724
  * <p>The identification of the permission to remove. This is the label added using the
1637
1725
  * <code>
1638
1726
  * <a>AddPermission</a>
@@ -1676,24 +1764,29 @@ export type MessageSystemAttributeNameForSends = (typeof MessageSystemAttributeN
1676
1764
  */
1677
1765
  export interface MessageSystemAttributeValue {
1678
1766
  /**
1767
+ * @public
1679
1768
  * <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
1680
1769
  * Characters</a>.</p>
1681
1770
  */
1682
1771
  StringValue?: string;
1683
1772
  /**
1773
+ * @public
1684
1774
  * <p>Binary type attributes can store any binary data, such as compressed data, encrypted
1685
1775
  * data, or images.</p>
1686
1776
  */
1687
1777
  BinaryValue?: Uint8Array;
1688
1778
  /**
1779
+ * @public
1689
1780
  * <p>Not implemented. Reserved for future use.</p>
1690
1781
  */
1691
1782
  StringListValues?: string[];
1692
1783
  /**
1784
+ * @public
1693
1785
  * <p>Not implemented. Reserved for future use.</p>
1694
1786
  */
1695
1787
  BinaryListValues?: Uint8Array[];
1696
1788
  /**
1789
+ * @public
1697
1790
  * <p>Amazon SQS supports the following logical data types: <code>String</code>,
1698
1791
  * <code>Number</code>, and <code>Binary</code>. For the <code>Number</code> data type,
1699
1792
  * you must use <code>StringValue</code>.</p>
@@ -1708,11 +1801,13 @@ export interface MessageSystemAttributeValue {
1708
1801
  */
1709
1802
  export interface SendMessageRequest {
1710
1803
  /**
1804
+ * @public
1711
1805
  * <p>The URL of the Amazon SQS queue to which a message is sent.</p>
1712
1806
  * <p>Queue URLs and names are case-sensitive.</p>
1713
1807
  */
1714
1808
  QueueUrl: string | undefined;
1715
1809
  /**
1810
+ * @public
1716
1811
  * <p>The message to send. The minimum size is one character. The maximum size is 256
1717
1812
  * KiB.</p>
1718
1813
  * <important>
@@ -1725,6 +1820,7 @@ export interface SendMessageRequest {
1725
1820
  */
1726
1821
  MessageBody: string | undefined;
1727
1822
  /**
1823
+ * @public
1728
1824
  * <p> The length of time, in seconds, for which to delay a specific message. Valid values:
1729
1825
  * 0 to 900. Maximum: 15 minutes. Messages with a positive <code>DelaySeconds</code> value
1730
1826
  * become available for processing after the delay period is finished. If you don't specify
@@ -1735,6 +1831,7 @@ export interface SendMessageRequest {
1735
1831
  */
1736
1832
  DelaySeconds?: number;
1737
1833
  /**
1834
+ * @public
1738
1835
  * <p>Each message attribute consists of a <code>Name</code>, <code>Type</code>,
1739
1836
  * and <code>Value</code>. For more information, see
1740
1837
  * <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes">Amazon SQS
@@ -1742,6 +1839,7 @@ export interface SendMessageRequest {
1742
1839
  */
1743
1840
  MessageAttributes?: Record<string, MessageAttributeValue>;
1744
1841
  /**
1842
+ * @public
1745
1843
  * <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>
1746
1844
  * <important>
1747
1845
  * <ul>
@@ -1758,6 +1856,7 @@ export interface SendMessageRequest {
1758
1856
  */
1759
1857
  MessageSystemAttributes?: Record<string, MessageSystemAttributeValue>;
1760
1858
  /**
1859
+ * @public
1761
1860
  * <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
1762
1861
  * <p>The token used for deduplication of sent messages. If a message with a particular
1763
1862
  * <code>MessageDeduplicationId</code> is sent successfully, any messages sent with the
@@ -1821,6 +1920,7 @@ export interface SendMessageRequest {
1821
1920
  */
1822
1921
  MessageDeduplicationId?: string;
1823
1922
  /**
1923
+ * @public
1824
1924
  * <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
1825
1925
  * <p>The tag that specifies that a message belongs to a specific message group. Messages
1826
1926
  * that belong to the same message group are processed in a FIFO manner (however,
@@ -1861,25 +1961,30 @@ export interface SendMessageRequest {
1861
1961
  */
1862
1962
  export interface SendMessageResult {
1863
1963
  /**
1964
+ * @public
1864
1965
  * <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>
1865
1966
  */
1866
1967
  MD5OfMessageBody?: string;
1867
1968
  /**
1969
+ * @public
1868
1970
  * <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>
1869
1971
  */
1870
1972
  MD5OfMessageAttributes?: string;
1871
1973
  /**
1974
+ * @public
1872
1975
  * <p>An MD5 digest of the non-URL-encoded message system attribute string. You can use this
1873
1976
  * attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest.</p>
1874
1977
  */
1875
1978
  MD5OfMessageSystemAttributes?: string;
1876
1979
  /**
1980
+ * @public
1877
1981
  * <p>An attribute containing the <code>MessageId</code> of the message sent to the queue.
1878
1982
  * 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
1879
1983
  * Guide</i>. </p>
1880
1984
  */
1881
1985
  MessageId?: string;
1882
1986
  /**
1987
+ * @public
1883
1988
  * <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
1884
1989
  * <p>The large, non-consecutive number that Amazon SQS assigns to each message.</p>
1885
1990
  * <p>The length of <code>SequenceNumber</code> is 128 bits. <code>SequenceNumber</code>
@@ -1905,6 +2010,7 @@ export declare class BatchRequestTooLong extends __BaseException {
1905
2010
  */
1906
2011
  export interface SendMessageBatchRequestEntry {
1907
2012
  /**
2013
+ * @public
1908
2014
  * <p>An identifier for a message in this batch used to communicate the result.</p>
1909
2015
  * <note>
1910
2016
  * <p>The <code>Id</code>s of a batch request need to be unique within a request.</p>
@@ -1913,10 +2019,12 @@ export interface SendMessageBatchRequestEntry {
1913
2019
  */
1914
2020
  Id: string | undefined;
1915
2021
  /**
2022
+ * @public
1916
2023
  * <p>The body of the message.</p>
1917
2024
  */
1918
2025
  MessageBody: string | undefined;
1919
2026
  /**
2027
+ * @public
1920
2028
  * <p>The length of time, in seconds, for which a specific message is delayed. Valid values:
1921
2029
  * 0 to 900. Maximum: 15 minutes. Messages with a positive <code>DelaySeconds</code> value
1922
2030
  * become available for processing after the delay period is finished. If you don't specify
@@ -1927,6 +2035,7 @@ export interface SendMessageBatchRequestEntry {
1927
2035
  */
1928
2036
  DelaySeconds?: number;
1929
2037
  /**
2038
+ * @public
1930
2039
  * <p>Each message attribute consists of a <code>Name</code>, <code>Type</code>,
1931
2040
  * and <code>Value</code>. For more information, see
1932
2041
  * <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes">Amazon SQS
@@ -1934,6 +2043,7 @@ export interface SendMessageBatchRequestEntry {
1934
2043
  */
1935
2044
  MessageAttributes?: Record<string, MessageAttributeValue>;
1936
2045
  /**
2046
+ * @public
1937
2047
  * <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>
1938
2048
  * <important>
1939
2049
  * <ul>
@@ -1950,6 +2060,7 @@ export interface SendMessageBatchRequestEntry {
1950
2060
  */
1951
2061
  MessageSystemAttributes?: Record<string, MessageSystemAttributeValue>;
1952
2062
  /**
2063
+ * @public
1953
2064
  * <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
1954
2065
  * <p>The token used for deduplication of messages within a 5-minute minimum deduplication
1955
2066
  * interval. If a message with a particular <code>MessageDeduplicationId</code> is sent
@@ -2013,6 +2124,7 @@ export interface SendMessageBatchRequestEntry {
2013
2124
  */
2014
2125
  MessageDeduplicationId?: string;
2015
2126
  /**
2127
+ * @public
2016
2128
  * <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
2017
2129
  * <p>The tag that specifies that a message belongs to a specific message group. Messages
2018
2130
  * that belong to the same message group are processed in a FIFO manner (however,
@@ -2053,11 +2165,13 @@ export interface SendMessageBatchRequestEntry {
2053
2165
  */
2054
2166
  export interface SendMessageBatchRequest {
2055
2167
  /**
2168
+ * @public
2056
2169
  * <p>The URL of the Amazon SQS queue to which batched messages are sent.</p>
2057
2170
  * <p>Queue URLs and names are case-sensitive.</p>
2058
2171
  */
2059
2172
  QueueUrl: string | undefined;
2060
2173
  /**
2174
+ * @public
2061
2175
  * <p>A list of <code>
2062
2176
  * <a>SendMessageBatchRequestEntry</a>
2063
2177
  * </code> items.</p>
@@ -2072,27 +2186,33 @@ export interface SendMessageBatchRequest {
2072
2186
  */
2073
2187
  export interface SendMessageBatchResultEntry {
2074
2188
  /**
2189
+ * @public
2075
2190
  * <p>An identifier for the message in this batch.</p>
2076
2191
  */
2077
2192
  Id: string | undefined;
2078
2193
  /**
2194
+ * @public
2079
2195
  * <p>An identifier for the message.</p>
2080
2196
  */
2081
2197
  MessageId: string | undefined;
2082
2198
  /**
2199
+ * @public
2083
2200
  * <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>
2084
2201
  */
2085
2202
  MD5OfMessageBody: string | undefined;
2086
2203
  /**
2204
+ * @public
2087
2205
  * <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>
2088
2206
  */
2089
2207
  MD5OfMessageAttributes?: string;
2090
2208
  /**
2209
+ * @public
2091
2210
  * <p>An MD5 digest of the non-URL-encoded message system attribute string. You can use this
2092
2211
  * 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>
2093
2212
  */
2094
2213
  MD5OfMessageSystemAttributes?: string;
2095
2214
  /**
2215
+ * @public
2096
2216
  * <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
2097
2217
  * <p>The large, non-consecutive number that Amazon SQS assigns to each message.</p>
2098
2218
  * <p>The length of <code>SequenceNumber</code> is 128 bits. As <code>SequenceNumber</code>
@@ -2112,12 +2232,14 @@ export interface SendMessageBatchResultEntry {
2112
2232
  */
2113
2233
  export interface SendMessageBatchResult {
2114
2234
  /**
2235
+ * @public
2115
2236
  * <p>A list of <code>
2116
2237
  * <a>SendMessageBatchResultEntry</a>
2117
2238
  * </code> items.</p>
2118
2239
  */
2119
2240
  Successful: SendMessageBatchResultEntry[] | undefined;
2120
2241
  /**
2242
+ * @public
2121
2243
  * <p>A list of <code>
2122
2244
  * <a>BatchResultErrorEntry</a>
2123
2245
  * </code> items with error
@@ -2131,11 +2253,13 @@ export interface SendMessageBatchResult {
2131
2253
  */
2132
2254
  export interface SetQueueAttributesRequest {
2133
2255
  /**
2256
+ * @public
2134
2257
  * <p>The URL of the Amazon SQS queue whose attributes are set.</p>
2135
2258
  * <p>Queue URLs and names are case-sensitive.</p>
2136
2259
  */
2137
2260
  QueueUrl: string | undefined;
2138
2261
  /**
2262
+ * @public
2139
2263
  * <p>A map of attributes to set.</p>
2140
2264
  * <p>The following lists the names, descriptions, and values of the special request
2141
2265
  * parameters that the <code>SetQueueAttributes</code> action uses:</p>
@@ -2373,6 +2497,7 @@ export interface SetQueueAttributesRequest {
2373
2497
  */
2374
2498
  export interface StartMessageMoveTaskRequest {
2375
2499
  /**
2500
+ * @public
2376
2501
  * <p>The ARN of the queue that contains the messages to be moved to another queue.
2377
2502
  * Currently, only ARNs of dead-letter queues (DLQs) whose sources are other Amazon SQS queues
2378
2503
  * are accepted. DLQs whose sources are non-SQS queues, such as Lambda or Amazon SNS topics, are
@@ -2380,6 +2505,7 @@ export interface StartMessageMoveTaskRequest {
2380
2505
  */
2381
2506
  SourceArn: string | undefined;
2382
2507
  /**
2508
+ * @public
2383
2509
  * <p>The ARN of the queue that receives the moved messages. You can use this field to
2384
2510
  * specify the destination queue where you would like to redrive messages. If this field is
2385
2511
  * left blank, the messages will be redriven back to their respective original source
@@ -2387,6 +2513,7 @@ export interface StartMessageMoveTaskRequest {
2387
2513
  */
2388
2514
  DestinationArn?: string;
2389
2515
  /**
2516
+ * @public
2390
2517
  * <p>The number of messages to be moved per second (the message movement rate). You can use
2391
2518
  * this field to define a fixed message movement rate. The maximum value for messages per
2392
2519
  * second is 500. If this field is left blank, the system will optimize the rate based on
@@ -2400,6 +2527,7 @@ export interface StartMessageMoveTaskRequest {
2400
2527
  */
2401
2528
  export interface StartMessageMoveTaskResult {
2402
2529
  /**
2530
+ * @public
2403
2531
  * <p>An identifier associated with a message movement task. You can use this identifier to
2404
2532
  * cancel a specified message movement task using the <code>CancelMessageMoveTask</code>
2405
2533
  * action.</p>
@@ -2411,10 +2539,12 @@ export interface StartMessageMoveTaskResult {
2411
2539
  */
2412
2540
  export interface TagQueueRequest {
2413
2541
  /**
2542
+ * @public
2414
2543
  * <p>The URL of the queue.</p>
2415
2544
  */
2416
2545
  QueueUrl: string | undefined;
2417
2546
  /**
2547
+ * @public
2418
2548
  * <p>The list of tags to be added to the specified queue.</p>
2419
2549
  */
2420
2550
  Tags: Record<string, string> | undefined;
@@ -2424,10 +2554,12 @@ export interface TagQueueRequest {
2424
2554
  */
2425
2555
  export interface UntagQueueRequest {
2426
2556
  /**
2557
+ * @public
2427
2558
  * <p>The URL of the queue.</p>
2428
2559
  */
2429
2560
  QueueUrl: string | undefined;
2430
2561
  /**
2562
+ * @public
2431
2563
  * <p>The list of tags to be removed from the specified queue.</p>
2432
2564
  */
2433
2565
  TagKeys: string[] | undefined;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-sqs",
3
3
  "description": "AWS SDK for JavaScript Sqs Client for Node.js, Browser and React Native",
4
- "version": "3.379.1",
4
+ "version": "3.385.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,16 +21,16 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.379.1",
25
- "@aws-sdk/credential-provider-node": "3.379.1",
24
+ "@aws-sdk/client-sts": "3.385.0",
25
+ "@aws-sdk/credential-provider-node": "3.385.0",
26
26
  "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
29
  "@aws-sdk/middleware-sdk-sqs": "3.378.0",
30
30
  "@aws-sdk/middleware-signing": "3.379.1",
31
- "@aws-sdk/middleware-user-agent": "3.379.1",
31
+ "@aws-sdk/middleware-user-agent": "3.382.0",
32
32
  "@aws-sdk/types": "3.378.0",
33
- "@aws-sdk/util-endpoints": "3.378.0",
33
+ "@aws-sdk/util-endpoints": "3.382.0",
34
34
  "@aws-sdk/util-user-agent-browser": "3.378.0",
35
35
  "@aws-sdk/util-user-agent-node": "3.378.0",
36
36
  "@smithy/config-resolver": "^2.0.1",