@aws-sdk/client-sqs 3.312.0 → 3.316.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 (7) hide show
  1. package/dist-cjs/SQS.js +24 -280
  2. package/dist-cjs/protocols/Aws_query.js +41 -60
  3. package/dist-es/SQS.js +24 -280
  4. package/dist-es/protocols/Aws_query.js +42 -61
  5. package/dist-types/SQS.d.ts +95 -466
  6. package/dist-types/ts3.4/SQS.d.ts +2 -1
  7. package/package.json +6 -6
package/dist-types/SQS.d.ts CHANGED
@@ -20,570 +20,199 @@ import { SetQueueAttributesCommandInput, SetQueueAttributesCommandOutput } from
20
20
  import { TagQueueCommandInput, TagQueueCommandOutput } from "./commands/TagQueueCommand";
21
21
  import { UntagQueueCommandInput, UntagQueueCommandOutput } from "./commands/UntagQueueCommand";
22
22
  import { SQSClient } from "./SQSClient";
23
- /**
24
- * @public
25
- * <p>Welcome to the <i>Amazon SQS API Reference</i>.</p>
26
- * <p>Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.</p>
27
- * <p>For information on the permissions you need to use this API, see
28
- * <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-authentication-and-access-control.html">Identity and
29
- * access management</a> in the <i>Amazon SQS Developer Guide.</i>
30
- * </p>
31
- * <p>You can use <a href="http://aws.amazon.com/tools/#sdk">Amazon Web Services SDKs</a> to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:</p>
32
- * <ul>
33
- * <li>
34
- * <p>Cryptographically sign your service requests</p>
35
- * </li>
36
- * <li>
37
- * <p>Retry requests</p>
38
- * </li>
39
- * <li>
40
- * <p>Handle error responses</p>
41
- * </li>
42
- * </ul>
43
- *
44
- * <p>
45
- * <b>Additional information</b>
46
- * </p>
47
- * <ul>
48
- * <li>
49
- * <p>
50
- * <a href="http://aws.amazon.com/sqs/">Amazon SQS Product Page</a>
51
- * </p>
52
- * </li>
53
- * <li>
54
- * <p>
55
- * <i>Amazon SQS Developer Guide</i>
56
- * </p>
57
- * <ul>
58
- * <li>
59
- * <p>
60
- * <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-making-api-requests.html">Making API Requests</a>
61
- * </p>
62
- * </li>
63
- * <li>
64
- * <p>
65
- * <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes">Amazon SQS Message Attributes</a>
66
- * </p>
67
- * </li>
68
- * <li>
69
- * <p>
70
- * <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">Amazon SQS Dead-Letter Queues</a>
71
- * </p>
72
- * </li>
73
- * </ul>
74
- * </li>
75
- * <li>
76
- * <p>
77
- * <a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line Interface</i>
78
- * </a>
79
- * </p>
80
- * </li>
81
- * <li>
82
- * <p>
83
- * <i>Amazon Web Services General Reference</i>
84
- * </p>
85
- * <ul>
86
- * <li>
87
- * <p>
88
- * <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#sqs_region">Regions and Endpoints</a>
89
- * </p>
90
- * </li>
91
- * </ul>
92
- * </li>
93
- * </ul>
94
- */
95
- export declare class SQS extends SQSClient {
23
+ export interface SQS {
96
24
  /**
97
- * @public
98
- * <p>Adds a permission to a queue for a specific
99
- * <a href="https://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P">principal</a>.
100
- * This allows sharing access to the queue.</p>
101
- * <p>When you create a queue, you have full control access rights for the queue.
102
- * Only you, the owner of the queue, can grant or deny permissions to the queue.
103
- * For more information about these permissions, see
104
- * <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-writing-an-sqs-policy.html#write-messages-to-shared-queue">Allow
105
- * Developers to Write Messages to a Shared Queue</a> in the <i>Amazon SQS Developer Guide</i>.</p>
106
- * <note>
107
- * <ul>
108
- * <li>
109
- * <p>
110
- * <code>AddPermission</code> generates a policy for you. You can use
111
- * <code>
112
- * <a>SetQueueAttributes</a>
113
- * </code> to
114
- * upload your policy. For more information, see
115
- * <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-creating-custom-policies.html">Using Custom Policies with the Amazon SQS Access Policy Language</a> in
116
- * the <i>Amazon SQS Developer Guide</i>.</p>
117
- * </li>
118
- * <li>
119
- * <p>An Amazon SQS policy can have a maximum of 7 actions.</p>
120
- * </li>
121
- * <li>
122
- * <p>To remove the ability to change queue permissions, you must deny permission to the <code>AddPermission</code>, <code>RemovePermission</code>, and <code>SetQueueAttributes</code> actions in your IAM policy.</p>
123
- * </li>
124
- * </ul>
125
- * </note>
126
- * <p>Some actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this:</p>
127
- * <p>
128
- * <code>&AttributeName.1=first</code>
129
- * </p>
130
- * <p>
131
- * <code>&AttributeName.2=second</code>
132
- * </p>
133
- * <note>
134
- * <p>Cross-account permissions don't apply to this action. For more information,
135
- * see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name">Grant
136
- * cross-account permissions to a role and a user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
137
- * </note>
25
+ * @see {@link AddPermissionCommand}
138
26
  */
139
27
  addPermission(args: AddPermissionCommandInput, options?: __HttpHandlerOptions): Promise<AddPermissionCommandOutput>;
140
28
  addPermission(args: AddPermissionCommandInput, cb: (err: any, data?: AddPermissionCommandOutput) => void): void;
141
29
  addPermission(args: AddPermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddPermissionCommandOutput) => void): void;
142
30
  /**
143
- * @public
144
- * <p>Changes the visibility timeout of a specified message in a queue to a new value. The
145
- * default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The
146
- * maximum is 12 hours. 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>
147
- * <p>For example, you have a message with a visibility timeout of 5 minutes. After 3
148
- * minutes, you call <code>ChangeMessageVisibility</code> with a timeout of 10 minutes. You
149
- * can continue to call <code>ChangeMessageVisibility</code> to extend the visibility
150
- * timeout to the maximum allowed time. If you try to extend the visibility timeout beyond
151
- * the maximum, your request is rejected.</p>
152
- * <p>An Amazon SQS message has three basic states:</p>
153
- * <ol>
154
- * <li>
155
- * <p>Sent to a queue by a producer.</p>
156
- * </li>
157
- * <li>
158
- * <p>Received from the queue by a consumer.</p>
159
- * </li>
160
- * <li>
161
- * <p>Deleted from the queue.</p>
162
- * </li>
163
- * </ol>
164
- * <p>A message is considered to be <i>stored</i> after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages.
165
- * A message is considered to be <i>in flight</i> after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of inflight messages.</p>
166
- * <p>Limits that apply to inflight messages are unrelated to the <i>unlimited</i> number of stored messages.</p>
167
- * <p>For most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue).
168
- * If you reach this limit, Amazon SQS returns the <code>OverLimit</code> error message.
169
- * To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages.
170
- * To request a limit increase, <a href="https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-sqs">file a support request</a>.</p>
171
- * <p>For FIFO queues, there can be a maximum of 20,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.</p>
172
- *
173
- * <important>
174
- * <p>If you attempt to set the <code>VisibilityTimeout</code> to a value greater than the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically recalculate and increase the timeout to the maximum remaining time.</p>
175
- * <p>Unlike with a queue, when you change the visibility timeout for a specific message the timeout value is applied immediately but isn't saved in memory for that message. If you don't delete a message after it is received, the visibility timeout
176
- * for the message reverts to the original timeout value (not to the value you set using the <code>ChangeMessageVisibility</code> action) the next time the message is received.</p>
177
- * </important>
31
+ * @see {@link ChangeMessageVisibilityCommand}
178
32
  */
179
33
  changeMessageVisibility(args: ChangeMessageVisibilityCommandInput, options?: __HttpHandlerOptions): Promise<ChangeMessageVisibilityCommandOutput>;
180
34
  changeMessageVisibility(args: ChangeMessageVisibilityCommandInput, cb: (err: any, data?: ChangeMessageVisibilityCommandOutput) => void): void;
181
35
  changeMessageVisibility(args: ChangeMessageVisibilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ChangeMessageVisibilityCommandOutput) => void): void;
182
36
  /**
183
- * @public
184
- * <p>Changes the visibility timeout of multiple messages. This is a batch version of <code>
185
- * <a>ChangeMessageVisibility</a>.</code> The result of the action on each message is reported individually in the response.
186
- * You can send up to 10 <code>
187
- * <a>ChangeMessageVisibility</a>
188
- * </code> requests with each <code>ChangeMessageVisibilityBatch</code> action.</p>
189
- * <important>
190
- * <p>Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of <code>200</code>.</p>
191
- * </important>
192
- * <p>Some actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this:</p>
193
- * <p>
194
- * <code>&AttributeName.1=first</code>
195
- * </p>
196
- * <p>
197
- * <code>&AttributeName.2=second</code>
198
- * </p>
37
+ * @see {@link ChangeMessageVisibilityBatchCommand}
199
38
  */
200
39
  changeMessageVisibilityBatch(args: ChangeMessageVisibilityBatchCommandInput, options?: __HttpHandlerOptions): Promise<ChangeMessageVisibilityBatchCommandOutput>;
201
40
  changeMessageVisibilityBatch(args: ChangeMessageVisibilityBatchCommandInput, cb: (err: any, data?: ChangeMessageVisibilityBatchCommandOutput) => void): void;
202
41
  changeMessageVisibilityBatch(args: ChangeMessageVisibilityBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ChangeMessageVisibilityBatchCommandOutput) => void): void;
203
42
  /**
204
- * @public
205
- * <p>Creates a new standard or FIFO queue. You can pass one or more attributes in
206
- * the request. Keep the following in mind:</p>
207
- * <ul>
208
- * <li>
209
- * <p>If you don't specify the <code>FifoQueue</code> attribute, Amazon SQS creates a standard queue.</p>
210
- * <note>
211
- * <p>You can't change the queue type after you create it and you can't convert
212
- * an existing standard queue into a FIFO queue. You must either create a new
213
- * FIFO queue for your application or delete your existing standard queue and
214
- * recreate it as a FIFO queue. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-moving">Moving From a Standard Queue to a FIFO Queue</a> in the
215
- * <i>Amazon SQS Developer Guide</i>. </p>
216
- * </note>
217
- * </li>
218
- * <li>
219
- * <p>If you don't provide a value for an attribute, the queue is created with the default value for the attribute.</p>
220
- * </li>
221
- * <li>
222
- * <p>If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.</p>
223
- * </li>
224
- * </ul>
225
- *
226
- * <p>To successfully create a new queue, you must provide a queue name that adheres to the <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html">limits related to queues</a> and is unique within the scope of your queues.</p>
227
- * <note>
228
- * <p>After you create a queue, you must wait at least one second after the queue is
229
- * created to be able to use the queue.</p>
230
- * </note>
231
- * <p>To get the queue URL, use the <code>
232
- * <a>GetQueueUrl</a>
233
- * </code> action. <code>
234
- * <a>GetQueueUrl</a>
235
- * </code> requires only the <code>QueueName</code> parameter.
236
- * be aware of existing queue names:</p>
237
- * <ul>
238
- * <li>
239
- * <p>If you provide the name of an existing queue along with the exact names and values of all the queue's attributes, <code>CreateQueue</code> returns the queue URL for the existing queue.</p>
240
- * </li>
241
- * <li>
242
- * <p>If the queue name, attribute names, or attribute values don't match an existing queue, <code>CreateQueue</code> returns an error.</p>
243
- * </li>
244
- * </ul>
245
- * <p>Some actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this:</p>
246
- * <p>
247
- * <code>&AttributeName.1=first</code>
248
- * </p>
249
- * <p>
250
- * <code>&AttributeName.2=second</code>
251
- * </p>
252
- * <note>
253
- * <p>Cross-account permissions don't apply to this action. For more information,
254
- * see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name">Grant
255
- * cross-account permissions to a role and a user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
256
- * </note>
43
+ * @see {@link CreateQueueCommand}
257
44
  */
258
45
  createQueue(args: CreateQueueCommandInput, options?: __HttpHandlerOptions): Promise<CreateQueueCommandOutput>;
259
46
  createQueue(args: CreateQueueCommandInput, cb: (err: any, data?: CreateQueueCommandOutput) => void): void;
260
47
  createQueue(args: CreateQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateQueueCommandOutput) => void): void;
261
48
  /**
262
- * @public
263
- * <p>Deletes the specified message from the specified queue. To select the message to
264
- * delete, use the <code>ReceiptHandle</code> of the message (<i>not</i> the
265
- * <code>MessageId</code> which you receive when you send the message). Amazon SQS can
266
- * delete a message from a queue even if a visibility timeout setting causes the message to
267
- * be locked by another consumer. Amazon SQS automatically deletes messages left in a queue
268
- * longer than the retention period configured for the queue. </p>
269
- * <note>
270
- * <p>The <code>ReceiptHandle</code> is associated with a <i>specific
271
- * instance</i> of receiving a message. If you receive a message more than
272
- * once, the <code>ReceiptHandle</code> is different each time you receive a message.
273
- * When you use the <code>DeleteMessage</code> action, you must provide the most
274
- * recently received <code>ReceiptHandle</code> for the message (otherwise, the request
275
- * succeeds, but the message might not be deleted).</p>
276
- * <p>For standard queues, it is possible to receive a message even after you
277
- * delete it. This might happen on rare occasions if one of the servers which stores a
278
- * copy of the message is unavailable when you send the request to delete the message.
279
- * The copy remains on the server and might be returned to you during a subsequent
280
- * receive request. You should ensure that your application is idempotent, so that
281
- * receiving a message more than once does not cause issues.</p>
282
- * </note>
49
+ * @see {@link DeleteMessageCommand}
283
50
  */
284
51
  deleteMessage(args: DeleteMessageCommandInput, options?: __HttpHandlerOptions): Promise<DeleteMessageCommandOutput>;
285
52
  deleteMessage(args: DeleteMessageCommandInput, cb: (err: any, data?: DeleteMessageCommandOutput) => void): void;
286
53
  deleteMessage(args: DeleteMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMessageCommandOutput) => void): void;
287
54
  /**
288
- * @public
289
- * <p>Deletes up to ten messages from the specified queue. This is a batch version of <code>
290
- * <a>DeleteMessage</a>.</code> The result of the action on each message is reported individually in the response.</p>
291
- * <important>
292
- * <p>Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of <code>200</code>.</p>
293
- * </important>
294
- * <p>Some actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this:</p>
295
- * <p>
296
- * <code>&AttributeName.1=first</code>
297
- * </p>
298
- * <p>
299
- * <code>&AttributeName.2=second</code>
300
- * </p>
55
+ * @see {@link DeleteMessageBatchCommand}
301
56
  */
302
57
  deleteMessageBatch(args: DeleteMessageBatchCommandInput, options?: __HttpHandlerOptions): Promise<DeleteMessageBatchCommandOutput>;
303
58
  deleteMessageBatch(args: DeleteMessageBatchCommandInput, cb: (err: any, data?: DeleteMessageBatchCommandOutput) => void): void;
304
59
  deleteMessageBatch(args: DeleteMessageBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMessageBatchCommandOutput) => void): void;
305
60
  /**
306
- * @public
307
- * <p>Deletes the queue specified by the <code>QueueUrl</code>, regardless of the queue's contents.</p>
308
- * <important>
309
- * <p>Be careful with the <code>DeleteQueue</code> action: When you delete a queue, any messages in the queue are no longer available.
310
- * </p>
311
- * </important>
312
- * <p>When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a
313
- * <code>
314
- * <a>SendMessage</a>
315
- * </code> request might succeed, but after 60 seconds the queue and the message you sent no longer exist.</p>
316
- * <p>When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.</p>
317
- * <note>
318
- * <p>Cross-account permissions don't apply to this action. For more information,
319
- * see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name">Grant
320
- * cross-account permissions to a role and a user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
321
- * </note>
61
+ * @see {@link DeleteQueueCommand}
322
62
  */
323
63
  deleteQueue(args: DeleteQueueCommandInput, options?: __HttpHandlerOptions): Promise<DeleteQueueCommandOutput>;
324
64
  deleteQueue(args: DeleteQueueCommandInput, cb: (err: any, data?: DeleteQueueCommandOutput) => void): void;
325
65
  deleteQueue(args: DeleteQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteQueueCommandOutput) => void): void;
326
66
  /**
327
- * @public
328
- * <p>Gets attributes for the specified queue.</p>
329
- * <note>
330
- * <p>To determine whether a queue is <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO</a>, you can check whether <code>QueueName</code> ends with the <code>.fifo</code> suffix.</p>
331
- * </note>
67
+ * @see {@link GetQueueAttributesCommand}
332
68
  */
333
69
  getQueueAttributes(args: GetQueueAttributesCommandInput, options?: __HttpHandlerOptions): Promise<GetQueueAttributesCommandOutput>;
334
70
  getQueueAttributes(args: GetQueueAttributesCommandInput, cb: (err: any, data?: GetQueueAttributesCommandOutput) => void): void;
335
71
  getQueueAttributes(args: GetQueueAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQueueAttributesCommandOutput) => void): void;
336
72
  /**
337
- * @public
338
- * <p>Returns the URL of an existing Amazon SQS queue.</p>
339
- * <p>To access a queue that belongs to another AWS account, use the <code>QueueOwnerAWSAccountId</code> parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue.
340
- * For more information about shared queue access, see <code>
341
- * <a>AddPermission</a>
342
- * </code> or see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-writing-an-sqs-policy.html#write-messages-to-shared-queue">Allow Developers to Write Messages to a Shared Queue</a> in the <i>Amazon SQS Developer Guide</i>.
343
- * </p>
73
+ * @see {@link GetQueueUrlCommand}
344
74
  */
345
75
  getQueueUrl(args: GetQueueUrlCommandInput, options?: __HttpHandlerOptions): Promise<GetQueueUrlCommandOutput>;
346
76
  getQueueUrl(args: GetQueueUrlCommandInput, cb: (err: any, data?: GetQueueUrlCommandOutput) => void): void;
347
77
  getQueueUrl(args: GetQueueUrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQueueUrlCommandOutput) => void): void;
348
78
  /**
349
- * @public
350
- * <p>Returns a list of your queues that have the <code>RedrivePolicy</code> queue attribute configured with a dead-letter queue.</p>
351
- * <p> The <code>ListDeadLetterSourceQueues</code> methods supports
352
- * pagination. Set parameter <code>MaxResults</code> in the request to specify the maximum number of
353
- * results to be returned in the response. If you do not set <code>MaxResults</code>,
354
- * the response includes a maximum of 1,000 results. If you set <code>MaxResults</code> and there are additional results to
355
- * display, the response includes a value for <code>NextToken</code>. Use
356
- * <code>NextToken</code> as a parameter in your next request to
357
- * <code>ListDeadLetterSourceQueues</code> to receive the next page of results. </p>
358
- *
359
- * <p>For more information about using dead-letter queues, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">Using Amazon SQS Dead-Letter Queues</a>
360
- * in the <i>Amazon SQS Developer Guide</i>.</p>
79
+ * @see {@link ListDeadLetterSourceQueuesCommand}
361
80
  */
362
81
  listDeadLetterSourceQueues(args: ListDeadLetterSourceQueuesCommandInput, options?: __HttpHandlerOptions): Promise<ListDeadLetterSourceQueuesCommandOutput>;
363
82
  listDeadLetterSourceQueues(args: ListDeadLetterSourceQueuesCommandInput, cb: (err: any, data?: ListDeadLetterSourceQueuesCommandOutput) => void): void;
364
83
  listDeadLetterSourceQueues(args: ListDeadLetterSourceQueuesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeadLetterSourceQueuesCommandOutput) => void): void;
365
84
  /**
366
- * @public
367
- * <p>Returns a list of your queues in the current region. The response includes a maximum of 1,000 results. If you specify a value for the optional
368
- * <code>QueueNamePrefix</code> parameter, only queues with a name that begins with the specified value are returned.</p>
369
- * <p> The <code>listQueues</code> methods supports
370
- * pagination. Set parameter <code>MaxResults</code> in the request to specify the maximum number of
371
- * results to be returned in the response. If you do not set <code>MaxResults</code>,
372
- * the response includes a maximum of 1,000 results. If you set <code>MaxResults</code> and there are additional results to
373
- * display, the response includes a value for <code>NextToken</code>. Use
374
- * <code>NextToken</code> as a parameter in your next request to
375
- * <code>listQueues</code> to receive the next page of results. </p>
376
- * <note>
377
- * <p>Cross-account permissions don't apply to this action. For more information,
378
- * see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name">Grant
379
- * cross-account permissions to a role and a user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
380
- * </note>
85
+ * @see {@link ListQueuesCommand}
381
86
  */
382
87
  listQueues(args: ListQueuesCommandInput, options?: __HttpHandlerOptions): Promise<ListQueuesCommandOutput>;
383
88
  listQueues(args: ListQueuesCommandInput, cb: (err: any, data?: ListQueuesCommandOutput) => void): void;
384
89
  listQueues(args: ListQueuesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListQueuesCommandOutput) => void): void;
385
90
  /**
386
- * @public
387
- * <p>List all cost allocation tags added 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
388
- * Your Amazon SQS Queues</a> in the <i>Amazon SQS Developer Guide</i>.</p>
389
- * <note>
390
- * <p>Cross-account permissions don't apply to this action. For more information,
391
- * see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name">Grant
392
- * cross-account permissions to a role and a user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
393
- * </note>
91
+ * @see {@link ListQueueTagsCommand}
394
92
  */
395
93
  listQueueTags(args: ListQueueTagsCommandInput, options?: __HttpHandlerOptions): Promise<ListQueueTagsCommandOutput>;
396
94
  listQueueTags(args: ListQueueTagsCommandInput, cb: (err: any, data?: ListQueueTagsCommandOutput) => void): void;
397
95
  listQueueTags(args: ListQueueTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListQueueTagsCommandOutput) => void): void;
398
96
  /**
399
- * @public
400
- * <p>Deletes the messages in a queue specified by the <code>QueueURL</code>
401
- * parameter.</p>
402
- *
403
- * <important>
404
- * <p>When you use the <code>PurgeQueue</code> action, you can't retrieve any messages
405
- * deleted from a queue.</p>
406
- * <p>The message deletion process takes up to 60 seconds. We recommend waiting for
407
- * 60 seconds regardless of your queue's size. </p>
408
- * </important>
409
- * <p>Messages sent to the queue <i>before</i> you call
410
- * <code>PurgeQueue</code> might be received but are deleted within the next
411
- * minute.</p>
412
- * <p>Messages sent to the queue <i>after</i> you call
413
- * <code>PurgeQueue</code> might be deleted while the queue is being purged.</p>
97
+ * @see {@link PurgeQueueCommand}
414
98
  */
415
99
  purgeQueue(args: PurgeQueueCommandInput, options?: __HttpHandlerOptions): Promise<PurgeQueueCommandOutput>;
416
100
  purgeQueue(args: PurgeQueueCommandInput, cb: (err: any, data?: PurgeQueueCommandOutput) => void): void;
417
101
  purgeQueue(args: PurgeQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PurgeQueueCommandOutput) => void): void;
418
102
  /**
419
- * @public
420
- * <p>Retrieves one or more messages (up to 10), from the specified queue. Using the <code>WaitTimeSeconds</code> parameter enables long-poll support.
421
- * For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html">Amazon SQS Long Polling</a> in the <i>Amazon SQS Developer Guide</i>.
422
- * </p>
423
- * <p>Short poll is the default behavior where a weighted random set of machines is sampled on a <code>ReceiveMessage</code> call. Thus, only the messages on the sampled machines are returned.
424
- * If the number of messages in the queue is small (fewer than 1,000), you most likely get fewer messages than you requested per <code>ReceiveMessage</code> call. If the number of messages in the queue is extremely small,
425
- * you might not receive any messages in a particular <code>ReceiveMessage</code> response. If this happens, repeat the request.
426
- * </p>
427
- * <p>For each message returned, the response includes the following:</p>
428
- * <ul>
429
- * <li>
430
- * <p>The message body.</p>
431
- * </li>
432
- * <li>
433
- * <p>An MD5 digest of the message body. For information about MD5, see <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
434
- * </li>
435
- * <li>
436
- * <p>The <code>MessageId</code> you received when you sent the message to the queue.</p>
437
- * </li>
438
- * <li>
439
- * <p>The receipt handle.</p>
440
- * </li>
441
- * <li>
442
- * <p>The message attributes.</p>
443
- * </li>
444
- * <li>
445
- * <p>An MD5 digest of the message attributes.</p>
446
- * </li>
447
- * </ul>
448
- * <p>The receipt handle is the identifier you must provide when deleting the message. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html">Queue
449
- * and Message Identifiers</a> in the <i>Amazon SQS Developer Guide</i>.</p>
450
- * <p>You can provide the <code>VisibilityTimeout</code> parameter in your request. The parameter is applied to the messages that Amazon SQS returns in the response. If you don't include the parameter, the overall visibility timeout for the queue
451
- * is used for the returned messages. 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>
452
- * <p>A message that isn't deleted or a message whose visibility isn't extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead-letter queue.</p>
453
- * <note>
454
- * <p>In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.</p>
455
- * </note>
103
+ * @see {@link ReceiveMessageCommand}
456
104
  */
457
105
  receiveMessage(args: ReceiveMessageCommandInput, options?: __HttpHandlerOptions): Promise<ReceiveMessageCommandOutput>;
458
106
  receiveMessage(args: ReceiveMessageCommandInput, cb: (err: any, data?: ReceiveMessageCommandOutput) => void): void;
459
107
  receiveMessage(args: ReceiveMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReceiveMessageCommandOutput) => void): void;
460
108
  /**
461
- * @public
462
- * <p>Revokes any permissions in the queue policy that matches the specified <code>Label</code> parameter.</p>
463
- * <note>
464
- * <ul>
465
- * <li>
466
- * <p>Only the owner of a queue can remove permissions from it.</p>
467
- * </li>
468
- * <li>
469
- * <p>Cross-account permissions don't apply to this action. For more information,
470
- * see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name">Grant
471
- * cross-account permissions to a role and a user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
472
- * </li>
473
- * <li>
474
- * <p>To remove the ability to change queue permissions, you must deny permission to the <code>AddPermission</code>, <code>RemovePermission</code>, and <code>SetQueueAttributes</code> actions in your IAM policy.</p>
475
- * </li>
476
- * </ul>
477
- * </note>
109
+ * @see {@link RemovePermissionCommand}
478
110
  */
479
111
  removePermission(args: RemovePermissionCommandInput, options?: __HttpHandlerOptions): Promise<RemovePermissionCommandOutput>;
480
112
  removePermission(args: RemovePermissionCommandInput, cb: (err: any, data?: RemovePermissionCommandOutput) => void): void;
481
113
  removePermission(args: RemovePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemovePermissionCommandOutput) => void): void;
482
114
  /**
483
- * @public
484
- * <p>Delivers a message to the specified queue.</p>
485
- * <important>
486
- * <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:</p>
487
- * <p>
488
- * <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>
489
- * </p>
490
- * <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>
491
- * </important>
115
+ * @see {@link SendMessageCommand}
492
116
  */
493
117
  sendMessage(args: SendMessageCommandInput, options?: __HttpHandlerOptions): Promise<SendMessageCommandOutput>;
494
118
  sendMessage(args: SendMessageCommandInput, cb: (err: any, data?: SendMessageCommandOutput) => void): void;
495
119
  sendMessage(args: SendMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendMessageCommandOutput) => void): void;
496
120
  /**
497
- * @public
498
- * <p>Delivers up to ten messages to the specified queue. This is a batch version of <code>
499
- * <a>SendMessage</a>.</code> For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.</p>
500
- * <p>The result of sending each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of <code>200</code>.</p>
501
- * <p>The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).</p>
502
- * <important>
503
- * <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:</p>
504
- * <p>
505
- * <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>
506
- * </p>
507
- * <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>
508
- * </important>
509
- * <p>If you don't specify the <code>DelaySeconds</code> parameter for an entry, Amazon SQS uses the default value for the queue.</p>
510
- * <p>Some actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this:</p>
511
- * <p>
512
- * <code>&AttributeName.1=first</code>
513
- * </p>
514
- * <p>
515
- * <code>&AttributeName.2=second</code>
516
- * </p>
121
+ * @see {@link SendMessageBatchCommand}
517
122
  */
518
123
  sendMessageBatch(args: SendMessageBatchCommandInput, options?: __HttpHandlerOptions): Promise<SendMessageBatchCommandOutput>;
519
124
  sendMessageBatch(args: SendMessageBatchCommandInput, cb: (err: any, data?: SendMessageBatchCommandOutput) => void): void;
520
125
  sendMessageBatch(args: SendMessageBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendMessageBatchCommandOutput) => void): void;
521
126
  /**
522
- * @public
523
- * <p>Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system.
524
- * Changes made to the <code>MessageRetentionPeriod</code> attribute can take up to 15 minutes.</p>
525
- * <note>
526
- * <ul>
527
- * <li>
528
- * <p>In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.</p>
529
- * </li>
530
- * <li>
531
- * <p>Cross-account permissions don't apply to this action. For more information,
532
- * see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name">Grant
533
- * cross-account permissions to a role and a user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
534
- * </li>
535
- * <li>
536
- * <p>To remove the ability to change queue permissions, you must deny permission to the <code>AddPermission</code>, <code>RemovePermission</code>, and <code>SetQueueAttributes</code> actions in your IAM policy.</p>
537
- * </li>
538
- * </ul>
539
- * </note>
127
+ * @see {@link SetQueueAttributesCommand}
540
128
  */
541
129
  setQueueAttributes(args: SetQueueAttributesCommandInput, options?: __HttpHandlerOptions): Promise<SetQueueAttributesCommandOutput>;
542
130
  setQueueAttributes(args: SetQueueAttributesCommandInput, cb: (err: any, data?: SetQueueAttributesCommandOutput) => void): void;
543
131
  setQueueAttributes(args: SetQueueAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetQueueAttributesCommandOutput) => void): void;
544
132
  /**
545
- * @public
546
- * <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
547
- * Your Amazon SQS Queues</a> in the <i>Amazon SQS Developer Guide</i>.</p>
548
- *
549
- * <p>When you use queue tags, keep the following guidelines in mind:</p>
550
- * <ul>
551
- * <li>
552
- * <p>Adding more than 50 tags to a queue isn't recommended.</p>
553
- * </li>
554
- * <li>
555
- * <p>Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.</p>
556
- * </li>
557
- * <li>
558
- * <p>Tags are case-sensitive.</p>
559
- * </li>
560
- * <li>
561
- * <p>A new tag with a key identical to that of an existing tag overwrites the existing tag.</p>
562
- * </li>
563
- * </ul>
564
- * <p>For a full list of tag restrictions, see
565
- * <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues">Quotas related to queues</a>
566
- * in the <i>Amazon SQS Developer Guide</i>.</p>
567
- * <note>
568
- * <p>Cross-account permissions don't apply to this action. For more information,
569
- * see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name">Grant
570
- * cross-account permissions to a role and a user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
571
- * </note>
133
+ * @see {@link TagQueueCommand}
572
134
  */
573
135
  tagQueue(args: TagQueueCommandInput, options?: __HttpHandlerOptions): Promise<TagQueueCommandOutput>;
574
136
  tagQueue(args: TagQueueCommandInput, cb: (err: any, data?: TagQueueCommandOutput) => void): void;
575
137
  tagQueue(args: TagQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagQueueCommandOutput) => void): void;
576
138
  /**
577
- * @public
578
- * <p>Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html">Tagging
579
- * Your Amazon SQS Queues</a> in the <i>Amazon SQS Developer Guide</i>.</p>
580
- * <note>
581
- * <p>Cross-account permissions don't apply to this action. For more information,
582
- * see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name">Grant
583
- * cross-account permissions to a role and a user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
584
- * </note>
139
+ * @see {@link UntagQueueCommand}
585
140
  */
586
141
  untagQueue(args: UntagQueueCommandInput, options?: __HttpHandlerOptions): Promise<UntagQueueCommandOutput>;
587
142
  untagQueue(args: UntagQueueCommandInput, cb: (err: any, data?: UntagQueueCommandOutput) => void): void;
588
143
  untagQueue(args: UntagQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagQueueCommandOutput) => void): void;
589
144
  }
145
+ /**
146
+ * @public
147
+ * <p>Welcome to the <i>Amazon SQS API Reference</i>.</p>
148
+ * <p>Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.</p>
149
+ * <p>For information on the permissions you need to use this API, see
150
+ * <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-authentication-and-access-control.html">Identity and
151
+ * access management</a> in the <i>Amazon SQS Developer Guide.</i>
152
+ * </p>
153
+ * <p>You can use <a href="http://aws.amazon.com/tools/#sdk">Amazon Web Services SDKs</a> to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:</p>
154
+ * <ul>
155
+ * <li>
156
+ * <p>Cryptographically sign your service requests</p>
157
+ * </li>
158
+ * <li>
159
+ * <p>Retry requests</p>
160
+ * </li>
161
+ * <li>
162
+ * <p>Handle error responses</p>
163
+ * </li>
164
+ * </ul>
165
+ *
166
+ * <p>
167
+ * <b>Additional information</b>
168
+ * </p>
169
+ * <ul>
170
+ * <li>
171
+ * <p>
172
+ * <a href="http://aws.amazon.com/sqs/">Amazon SQS Product Page</a>
173
+ * </p>
174
+ * </li>
175
+ * <li>
176
+ * <p>
177
+ * <i>Amazon SQS Developer Guide</i>
178
+ * </p>
179
+ * <ul>
180
+ * <li>
181
+ * <p>
182
+ * <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-making-api-requests.html">Making API Requests</a>
183
+ * </p>
184
+ * </li>
185
+ * <li>
186
+ * <p>
187
+ * <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes">Amazon SQS Message Attributes</a>
188
+ * </p>
189
+ * </li>
190
+ * <li>
191
+ * <p>
192
+ * <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">Amazon SQS Dead-Letter Queues</a>
193
+ * </p>
194
+ * </li>
195
+ * </ul>
196
+ * </li>
197
+ * <li>
198
+ * <p>
199
+ * <a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line Interface</i>
200
+ * </a>
201
+ * </p>
202
+ * </li>
203
+ * <li>
204
+ * <p>
205
+ * <i>Amazon Web Services General Reference</i>
206
+ * </p>
207
+ * <ul>
208
+ * <li>
209
+ * <p>
210
+ * <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#sqs_region">Regions and Endpoints</a>
211
+ * </p>
212
+ * </li>
213
+ * </ul>
214
+ * </li>
215
+ * </ul>
216
+ */
217
+ export declare class SQS extends SQSClient implements SQS {
218
+ }