@aws-sdk/client-sqs 3.345.0 → 3.347.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. package/README.md +34 -6
  2. package/dist-cjs/SQS.js +6 -0
  3. package/dist-cjs/commands/CancelMessageMoveTaskCommand.js +46 -0
  4. package/dist-cjs/commands/ListMessageMoveTasksCommand.js +46 -0
  5. package/dist-cjs/commands/StartMessageMoveTaskCommand.js +46 -0
  6. package/dist-cjs/commands/index.js +3 -0
  7. package/dist-cjs/models/models_0.js +28 -14
  8. package/dist-cjs/protocols/Aws_query.js +247 -1
  9. package/dist-es/SQS.js +6 -0
  10. package/dist-es/commands/CancelMessageMoveTaskCommand.js +42 -0
  11. package/dist-es/commands/ListMessageMoveTasksCommand.js +42 -0
  12. package/dist-es/commands/StartMessageMoveTaskCommand.js +42 -0
  13. package/dist-es/commands/index.js +3 -0
  14. package/dist-es/models/models_0.js +25 -12
  15. package/dist-es/protocols/Aws_query.js +242 -2
  16. package/dist-types/SQS.d.ts +31 -6
  17. package/dist-types/SQSClient.d.ts +15 -8
  18. package/dist-types/commands/AddPermissionCommand.d.ts +17 -23
  19. package/dist-types/commands/CancelMessageMoveTaskCommand.d.ts +92 -0
  20. package/dist-types/commands/ChangeMessageVisibilityBatchCommand.d.ts +9 -12
  21. package/dist-types/commands/ChangeMessageVisibilityCommand.d.ts +22 -13
  22. package/dist-types/commands/CreateQueueCommand.d.ts +17 -16
  23. package/dist-types/commands/DeleteMessageBatchCommand.d.ts +6 -10
  24. package/dist-types/commands/DeleteMessageCommand.d.ts +1 -1
  25. package/dist-types/commands/DeleteQueueCommand.d.ts +13 -8
  26. package/dist-types/commands/GetQueueUrlCommand.d.ts +7 -4
  27. package/dist-types/commands/ListDeadLetterSourceQueuesCommand.d.ts +11 -10
  28. package/dist-types/commands/ListMessageMoveTasksCommand.d.ts +93 -0
  29. package/dist-types/commands/ListQueueTagsCommand.d.ts +3 -2
  30. package/dist-types/commands/ListQueuesCommand.d.ts +12 -10
  31. package/dist-types/commands/PurgeQueueCommand.d.ts +7 -5
  32. package/dist-types/commands/ReceiveMessageCommand.d.ts +25 -14
  33. package/dist-types/commands/RemovePermissionCommand.d.ts +3 -2
  34. package/dist-types/commands/SendMessageBatchCommand.d.ts +14 -13
  35. package/dist-types/commands/SetQueueAttributesCommand.d.ts +7 -3
  36. package/dist-types/commands/StartMessageMoveTaskCommand.d.ts +100 -0
  37. package/dist-types/commands/TagQueueCommand.d.ts +1 -1
  38. package/dist-types/commands/UntagQueueCommand.d.ts +1 -1
  39. package/dist-types/commands/index.d.ts +3 -0
  40. package/dist-types/index.d.ts +10 -6
  41. package/dist-types/models/models_0.d.ts +852 -359
  42. package/dist-types/protocols/Aws_query.d.ts +27 -0
  43. package/dist-types/ts3.4/SQS.d.ts +51 -0
  44. package/dist-types/ts3.4/SQSClient.d.ts +18 -0
  45. package/dist-types/ts3.4/commands/CancelMessageMoveTaskCommand.d.ts +42 -0
  46. package/dist-types/ts3.4/commands/ListMessageMoveTasksCommand.d.ts +42 -0
  47. package/dist-types/ts3.4/commands/StartMessageMoveTaskCommand.d.ts +42 -0
  48. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  49. package/dist-types/ts3.4/models/models_0.d.ts +47 -7
  50. package/dist-types/ts3.4/protocols/Aws_query.d.ts +36 -0
  51. package/package.json +31 -31
@@ -0,0 +1,92 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { CancelMessageMoveTaskRequest, CancelMessageMoveTaskResult } from "../models/models_0";
5
+ import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link CancelMessageMoveTaskCommand}.
14
+ */
15
+ export interface CancelMessageMoveTaskCommandInput extends CancelMessageMoveTaskRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link CancelMessageMoveTaskCommand}.
21
+ */
22
+ export interface CancelMessageMoveTaskCommandOutput extends CancelMessageMoveTaskResult, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Cancels a specified message movement task.</p>
27
+ * <note>
28
+ * <ul>
29
+ * <li>
30
+ * <p>A message movement can only be cancelled when the current status is
31
+ * RUNNING.</p>
32
+ * </li>
33
+ * <li>
34
+ * <p>Cancelling a message movement task does not revert the messages that have
35
+ * already been moved. It can only stop the messages that have not been moved
36
+ * yet.</p>
37
+ * </li>
38
+ * </ul>
39
+ * </note>
40
+ * @example
41
+ * Use a bare-bones client and the command you need to make an API call.
42
+ * ```javascript
43
+ * import { SQSClient, CancelMessageMoveTaskCommand } from "@aws-sdk/client-sqs"; // ES Modules import
44
+ * // const { SQSClient, CancelMessageMoveTaskCommand } = require("@aws-sdk/client-sqs"); // CommonJS import
45
+ * const client = new SQSClient(config);
46
+ * const input = { // CancelMessageMoveTaskRequest
47
+ * TaskHandle: "STRING_VALUE", // required
48
+ * };
49
+ * const command = new CancelMessageMoveTaskCommand(input);
50
+ * const response = await client.send(command);
51
+ * // { // CancelMessageMoveTaskResult
52
+ * // ApproximateNumberOfMessagesMoved: Number("long"),
53
+ * // };
54
+ *
55
+ * ```
56
+ *
57
+ * @param CancelMessageMoveTaskCommandInput - {@link CancelMessageMoveTaskCommandInput}
58
+ * @returns {@link CancelMessageMoveTaskCommandOutput}
59
+ * @see {@link CancelMessageMoveTaskCommandInput} for command's `input` shape.
60
+ * @see {@link CancelMessageMoveTaskCommandOutput} for command's `response` shape.
61
+ * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
62
+ *
63
+ * @throws {@link ResourceNotFoundException} (client fault)
64
+ * <p>One or more specified resources don't exist.</p>
65
+ *
66
+ * @throws {@link UnsupportedOperation} (client fault)
67
+ * <p>Error code 400. Unsupported operation.</p>
68
+ *
69
+ * @throws {@link SQSServiceException}
70
+ * <p>Base exception class for all service exceptions from SQS service.</p>
71
+ *
72
+ */
73
+ export declare class CancelMessageMoveTaskCommand extends $Command<CancelMessageMoveTaskCommandInput, CancelMessageMoveTaskCommandOutput, SQSClientResolvedConfig> {
74
+ readonly input: CancelMessageMoveTaskCommandInput;
75
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
76
+ /**
77
+ * @public
78
+ */
79
+ constructor(input: CancelMessageMoveTaskCommandInput);
80
+ /**
81
+ * @internal
82
+ */
83
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SQSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CancelMessageMoveTaskCommandInput, CancelMessageMoveTaskCommandOutput>;
84
+ /**
85
+ * @internal
86
+ */
87
+ private serialize;
88
+ /**
89
+ * @internal
90
+ */
91
+ private deserialize;
92
+ }
@@ -23,21 +23,17 @@ export interface ChangeMessageVisibilityBatchCommandOutput extends ChangeMessage
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Changes the visibility timeout of multiple messages. This is a batch version of <code>
27
- * <a>ChangeMessageVisibility</a>.</code> The result of the action on each message is reported individually in the response.
28
- * You can send up to 10 <code>
26
+ * <p>Changes the visibility timeout of multiple messages. This is a batch version of
27
+ * <code>
28
+ * <a>ChangeMessageVisibility</a>.</code> The result of the action
29
+ * on each message is reported individually in the response. You can send up to 10
30
+ * <code>
29
31
  * <a>ChangeMessageVisibility</a>
30
- * </code> requests with each <code>ChangeMessageVisibilityBatch</code> action.</p>
32
+ * </code> requests with each
33
+ * <code>ChangeMessageVisibilityBatch</code> action.</p>
31
34
  * <important>
32
35
  * <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>
33
36
  * </important>
34
- * <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>
35
- * <p>
36
- * <code>&AttributeName.1=first</code>
37
- * </p>
38
- * <p>
39
- * <code>&AttributeName.2=second</code>
40
- * </p>
41
37
  * @example
42
38
  * Use a bare-bones client and the command you need to make an API call.
43
39
  * ```javascript
@@ -87,7 +83,8 @@ export interface ChangeMessageVisibilityBatchCommandOutput extends ChangeMessage
87
83
  * <p>The batch request doesn't contain any entries.</p>
88
84
  *
89
85
  * @throws {@link InvalidBatchEntryId} (client fault)
90
- * <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the specification.</p>
86
+ * <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the
87
+ * specification.</p>
91
88
  *
92
89
  * @throws {@link TooManyEntriesInBatchRequest} (client fault)
93
90
  * <p>The batch request contains more entries than permissible.</p>
@@ -25,12 +25,15 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer {
25
25
  * @public
26
26
  * <p>Changes the visibility timeout of a specified message in a queue to a new value. The
27
27
  * default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The
28
- * 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>
29
- * <p>For example, you have a message with a visibility timeout of 5 minutes. After 3
30
- * minutes, you call <code>ChangeMessageVisibility</code> with a timeout of 10 minutes. You
31
- * can continue to call <code>ChangeMessageVisibility</code> to extend the visibility
32
- * timeout to the maximum allowed time. If you try to extend the visibility timeout beyond
33
- * the maximum, your request is rejected.</p>
28
+ * 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
29
+ * Guide</i>.</p>
30
+ * <p>For example, if the default timeout for a queue is 60 seconds, 15 seconds have elapsed
31
+ * since you received the message, and you send a ChangeMessageVisibility call with
32
+ * <code>VisibilityTimeout</code> set to 10 seconds, the 10 seconds begin to count from
33
+ * the time that you make the <code>ChangeMessageVisibility</code> call. Thus, any attempt
34
+ * to change the visibility timeout or to delete that message 10 seconds after you
35
+ * initially change the visibility timeout (a total of 25 seconds) might result in an
36
+ * error.</p>
34
37
  * <p>An Amazon SQS message has three basic states:</p>
35
38
  * <ol>
36
39
  * <li>
@@ -44,17 +47,23 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer {
44
47
  * </li>
45
48
  * </ol>
46
49
  * <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.
47
- * 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>
48
- * <p>Limits that apply to inflight messages are unrelated to the <i>unlimited</i> number of stored messages.</p>
49
- * <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).
50
+ * 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 in flight messages.</p>
51
+ * <p>Limits that apply to in flight messages are unrelated to the <i>unlimited</i> number of stored messages.</p>
52
+ * <p>For most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue).
50
53
  * If you reach this limit, Amazon SQS returns the <code>OverLimit</code> error message.
51
54
  * 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.
52
55
  * 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>
53
- * <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>
56
+ * <p>For FIFO queues, there can be a maximum of 20,000 in flight 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>
54
57
  * <important>
55
- * <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>
56
- * <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
57
- * 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>
58
+ * <p>If you attempt to set the <code>VisibilityTimeout</code> to a value greater than
59
+ * the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically
60
+ * recalculate and increase the timeout to the maximum remaining time.</p>
61
+ * <p>Unlike with a queue, when you change the visibility timeout for a specific message
62
+ * the timeout value is applied immediately but isn't saved in memory for that message.
63
+ * If you don't delete a message after it is received, the visibility timeout for the
64
+ * message reverts to the original timeout value (not to the value you set using the
65
+ * <code>ChangeMessageVisibility</code> action) the next time the message is
66
+ * received.</p>
58
67
  * </important>
59
68
  * @example
60
69
  * Use a bare-bones client and the command you need to make an API call.
@@ -37,42 +37,43 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB
37
37
  * </note>
38
38
  * </li>
39
39
  * <li>
40
- * <p>If you don't provide a value for an attribute, the queue is created with the default value for the attribute.</p>
40
+ * <p>If you don't provide a value for an attribute, the queue is created with the
41
+ * default value for the attribute.</p>
41
42
  * </li>
42
43
  * <li>
43
- * <p>If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.</p>
44
+ * <p>If you delete a queue, you must wait at least 60 seconds before creating a
45
+ * queue with the same name.</p>
44
46
  * </li>
45
47
  * </ul>
46
- * <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>
48
+ * <p>To successfully create a new queue, you must provide a queue name that adheres to the
49
+ * <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html">limits
50
+ * related to queues</a> and is unique within the scope of your queues.</p>
47
51
  * <note>
48
52
  * <p>After you create a queue, you must wait at least one second after the queue is
49
53
  * created to be able to use the queue.</p>
50
54
  * </note>
51
55
  * <p>To get the queue URL, use the <code>
52
56
  * <a>GetQueueUrl</a>
53
- * </code> action. <code>
57
+ * </code> action.
58
+ * <code>
54
59
  * <a>GetQueueUrl</a>
55
- * </code> requires only the <code>QueueName</code> parameter.
56
- * be aware of existing queue names:</p>
60
+ * </code> requires only the
61
+ * <code>QueueName</code> parameter. be aware of existing queue names:</p>
57
62
  * <ul>
58
63
  * <li>
59
- * <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>
64
+ * <p>If you provide the name of an existing queue along with the exact names and
65
+ * values of all the queue's attributes, <code>CreateQueue</code> returns the queue
66
+ * URL for the existing queue.</p>
60
67
  * </li>
61
68
  * <li>
62
- * <p>If the queue name, attribute names, or attribute values don't match an existing queue, <code>CreateQueue</code> returns an error.</p>
69
+ * <p>If the queue name, attribute names, or attribute values don't match an
70
+ * existing queue, <code>CreateQueue</code> returns an error.</p>
63
71
  * </li>
64
72
  * </ul>
65
- * <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>
66
- * <p>
67
- * <code>&AttributeName.1=first</code>
68
- * </p>
69
- * <p>
70
- * <code>&AttributeName.2=second</code>
71
- * </p>
72
73
  * <note>
73
74
  * <p>Cross-account permissions don't apply to this action. For more information,
74
75
  * 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
75
- * cross-account permissions to a role and a user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
76
+ * cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
76
77
  * </note>
77
78
  * @example
78
79
  * Use a bare-bones client and the command you need to make an API call.
@@ -23,18 +23,13 @@ export interface DeleteMessageBatchCommandOutput extends DeleteMessageBatchResul
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Deletes up to ten messages from the specified queue. This is a batch version of <code>
27
- * <a>DeleteMessage</a>.</code> The result of the action on each message is reported individually in the response.</p>
26
+ * <p>Deletes up to ten messages from the specified queue. This is a batch version of
27
+ * <code>
28
+ * <a>DeleteMessage</a>.</code> The result of the action on each
29
+ * message is reported individually in the response.</p>
28
30
  * <important>
29
31
  * <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>
30
32
  * </important>
31
- * <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>
32
- * <p>
33
- * <code>&AttributeName.1=first</code>
34
- * </p>
35
- * <p>
36
- * <code>&AttributeName.2=second</code>
37
- * </p>
38
33
  * @example
39
34
  * Use a bare-bones client and the command you need to make an API call.
40
35
  * ```javascript
@@ -83,7 +78,8 @@ export interface DeleteMessageBatchCommandOutput extends DeleteMessageBatchResul
83
78
  * <p>The batch request doesn't contain any entries.</p>
84
79
  *
85
80
  * @throws {@link InvalidBatchEntryId} (client fault)
86
- * <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the specification.</p>
81
+ * <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the
82
+ * specification.</p>
87
83
  *
88
84
  * @throws {@link TooManyEntriesInBatchRequest} (client fault)
89
85
  * <p>The batch request contains more entries than permissible.</p>
@@ -35,7 +35,7 @@ export interface DeleteMessageCommandOutput extends __MetadataBearer {
35
35
  * once, the <code>ReceiptHandle</code> is different each time you receive a message.
36
36
  * When you use the <code>DeleteMessage</code> action, you must provide the most
37
37
  * recently received <code>ReceiptHandle</code> for the message (otherwise, the request
38
- * succeeds, but the message might not be deleted).</p>
38
+ * succeeds, but the message will not be deleted).</p>
39
39
  * <p>For standard queues, it is possible to receive a message even after you
40
40
  * delete it. This might happen on rare occasions if one of the servers which stores a
41
41
  * copy of the message is unavailable when you send the request to delete the message.
@@ -23,20 +23,25 @@ export interface DeleteQueueCommandOutput extends __MetadataBearer {
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Deletes the queue specified by the <code>QueueUrl</code>, regardless of the queue's contents.</p>
26
+ * <p>Deletes the queue specified by the <code>QueueUrl</code>, regardless of the queue's
27
+ * contents.</p>
27
28
  * <important>
28
- * <p>Be careful with the <code>DeleteQueue</code> action: When you delete a queue, any messages in the queue are no longer available.
29
- * </p>
29
+ * <p>Be careful with the <code>DeleteQueue</code> action: When you delete a queue, any
30
+ * messages in the queue are no longer available. </p>
30
31
  * </important>
31
- * <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
32
- * <code>
32
+ * <p>When you delete a queue, the deletion process takes up to 60 seconds. Requests you
33
+ * send involving that queue during the 60 seconds might succeed. For example, a
34
+ * <code>
33
35
  * <a>SendMessage</a>
34
- * </code> request might succeed, but after 60 seconds the queue and the message you sent no longer exist.</p>
35
- * <p>When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.</p>
36
+ * </code> request might succeed, but after 60
37
+ * seconds the queue and the message you sent no longer exist.</p>
38
+ * <p>When you delete a queue, you must wait at least 60 seconds before creating a queue
39
+ * with the same name.</p>
36
40
  * <note>
37
41
  * <p>Cross-account permissions don't apply to this action. For more information,
38
42
  * 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
39
- * cross-account permissions to a role and a user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
43
+ * cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
44
+ * <p>The delete operation uses the HTTP <code>GET</code> verb.</p>
40
45
  * </note>
41
46
  * @example
42
47
  * Use a bare-bones client and the command you need to make an API call.
@@ -24,11 +24,14 @@ export interface GetQueueUrlCommandOutput extends GetQueueUrlResult, __MetadataB
24
24
  /**
25
25
  * @public
26
26
  * <p>Returns the URL of an existing Amazon SQS queue.</p>
27
- * <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.
28
- * For more information about shared queue access, see <code>
27
+ * <p>To access a queue that belongs to another AWS account, use the
28
+ * <code>QueueOwnerAWSAccountId</code> parameter to specify the account ID of the
29
+ * queue's owner. The queue's owner must grant you permission to access the queue. For more
30
+ * information about shared queue access, see <code>
29
31
  * <a>AddPermission</a>
30
- * </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>.
31
- * </p>
32
+ * </code>
33
+ * 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
34
+ * Developer Guide</i>. </p>
32
35
  * @example
33
36
  * Use a bare-bones client and the command you need to make an API call.
34
37
  * ```javascript
@@ -23,16 +23,17 @@ export interface ListDeadLetterSourceQueuesCommandOutput extends ListDeadLetterS
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Returns a list of your queues that have the <code>RedrivePolicy</code> queue attribute configured with a dead-letter queue.</p>
27
- * <p> The <code>ListDeadLetterSourceQueues</code> methods supports
28
- * pagination. Set parameter <code>MaxResults</code> in the request to specify the maximum number of
29
- * results to be returned in the response. If you do not set <code>MaxResults</code>,
30
- * the response includes a maximum of 1,000 results. If you set <code>MaxResults</code> and there are additional results to
31
- * display, the response includes a value for <code>NextToken</code>. Use
32
- * <code>NextToken</code> as a parameter in your next request to
33
- * <code>ListDeadLetterSourceQueues</code> to receive the next page of results. </p>
34
- * <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>
35
- * in the <i>Amazon SQS Developer Guide</i>.</p>
26
+ * <p>Returns a list of your queues that have the <code>RedrivePolicy</code> queue attribute
27
+ * configured with a dead-letter queue.</p>
28
+ * <p> The <code>ListDeadLetterSourceQueues</code> methods supports pagination. Set
29
+ * parameter <code>MaxResults</code> in the request to specify the maximum number of
30
+ * results to be returned in the response. If you do not set <code>MaxResults</code>, the
31
+ * response includes a maximum of 1,000 results. If you set <code>MaxResults</code> and
32
+ * there are additional results to display, the response includes a value for
33
+ * <code>NextToken</code>. Use <code>NextToken</code> as a parameter in your next
34
+ * request to <code>ListDeadLetterSourceQueues</code> to receive the next page of results. </p>
35
+ * <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> in the <i>Amazon SQS Developer
36
+ * Guide</i>.</p>
36
37
  * @example
37
38
  * Use a bare-bones client and the command you need to make an API call.
38
39
  * ```javascript
@@ -0,0 +1,93 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { ListMessageMoveTasksRequest, ListMessageMoveTasksResult } from "../models/models_0";
5
+ import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListMessageMoveTasksCommand}.
14
+ */
15
+ export interface ListMessageMoveTasksCommandInput extends ListMessageMoveTasksRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListMessageMoveTasksCommand}.
21
+ */
22
+ export interface ListMessageMoveTasksCommandOutput extends ListMessageMoveTasksResult, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Gets the most recent message movement tasks (up to 10) under a specific source
27
+ * queue.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { SQSClient, ListMessageMoveTasksCommand } from "@aws-sdk/client-sqs"; // ES Modules import
32
+ * // const { SQSClient, ListMessageMoveTasksCommand } = require("@aws-sdk/client-sqs"); // CommonJS import
33
+ * const client = new SQSClient(config);
34
+ * const input = { // ListMessageMoveTasksRequest
35
+ * SourceArn: "STRING_VALUE", // required
36
+ * MaxResults: Number("int"),
37
+ * };
38
+ * const command = new ListMessageMoveTasksCommand(input);
39
+ * const response = await client.send(command);
40
+ * // { // ListMessageMoveTasksResult
41
+ * // Results: [ // ListMessageMoveTasksResultEntryList
42
+ * // { // ListMessageMoveTasksResultEntry
43
+ * // TaskHandle: "STRING_VALUE",
44
+ * // Status: "STRING_VALUE",
45
+ * // SourceArn: "STRING_VALUE",
46
+ * // DestinationArn: "STRING_VALUE",
47
+ * // MaxNumberOfMessagesPerSecond: Number("int"),
48
+ * // ApproximateNumberOfMessagesMoved: Number("long"),
49
+ * // ApproximateNumberOfMessagesToMove: Number("long"),
50
+ * // FailureReason: "STRING_VALUE",
51
+ * // StartedTimestamp: Number("long"),
52
+ * // },
53
+ * // ],
54
+ * // };
55
+ *
56
+ * ```
57
+ *
58
+ * @param ListMessageMoveTasksCommandInput - {@link ListMessageMoveTasksCommandInput}
59
+ * @returns {@link ListMessageMoveTasksCommandOutput}
60
+ * @see {@link ListMessageMoveTasksCommandInput} for command's `input` shape.
61
+ * @see {@link ListMessageMoveTasksCommandOutput} for command's `response` shape.
62
+ * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
63
+ *
64
+ * @throws {@link ResourceNotFoundException} (client fault)
65
+ * <p>One or more specified resources don't exist.</p>
66
+ *
67
+ * @throws {@link UnsupportedOperation} (client fault)
68
+ * <p>Error code 400. Unsupported operation.</p>
69
+ *
70
+ * @throws {@link SQSServiceException}
71
+ * <p>Base exception class for all service exceptions from SQS service.</p>
72
+ *
73
+ */
74
+ export declare class ListMessageMoveTasksCommand extends $Command<ListMessageMoveTasksCommandInput, ListMessageMoveTasksCommandOutput, SQSClientResolvedConfig> {
75
+ readonly input: ListMessageMoveTasksCommandInput;
76
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
77
+ /**
78
+ * @public
79
+ */
80
+ constructor(input: ListMessageMoveTasksCommandInput);
81
+ /**
82
+ * @internal
83
+ */
84
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SQSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListMessageMoveTasksCommandInput, ListMessageMoveTasksCommandOutput>;
85
+ /**
86
+ * @internal
87
+ */
88
+ private serialize;
89
+ /**
90
+ * @internal
91
+ */
92
+ private deserialize;
93
+ }
@@ -23,12 +23,13 @@ export interface ListQueueTagsCommandOutput extends ListQueueTagsResult, __Metad
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <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
26
+ * <p>List all cost allocation tags added to the specified Amazon SQS queue.
27
+ * For an overview, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html">Tagging
27
28
  * Your Amazon SQS Queues</a> in the <i>Amazon SQS Developer Guide</i>.</p>
28
29
  * <note>
29
30
  * <p>Cross-account permissions don't apply to this action. For more information,
30
31
  * 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
31
- * cross-account permissions to a role and a user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
32
+ * cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
32
33
  * </note>
33
34
  * @example
34
35
  * Use a bare-bones client and the command you need to make an API call.
@@ -23,19 +23,21 @@ export interface ListQueuesCommandOutput extends ListQueuesResult, __MetadataBea
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <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
27
- * <code>QueueNamePrefix</code> parameter, only queues with a name that begins with the specified value are returned.</p>
28
- * <p> The <code>listQueues</code> methods supports
29
- * pagination. Set parameter <code>MaxResults</code> in the request to specify the maximum number of
30
- * results to be returned in the response. If you do not set <code>MaxResults</code>,
31
- * the response includes a maximum of 1,000 results. If you set <code>MaxResults</code> and there are additional results to
32
- * display, the response includes a value for <code>NextToken</code>. Use
33
- * <code>NextToken</code> as a parameter in your next request to
34
- * <code>listQueues</code> to receive the next page of results. </p>
26
+ * <p>Returns a list of your queues in the current region. The response includes a maximum
27
+ * of 1,000 results. If you specify a value for the optional <code>QueueNamePrefix</code>
28
+ * parameter, only queues with a name that begins with the specified value are
29
+ * returned.</p>
30
+ * <p> The <code>listQueues</code> methods supports pagination. Set parameter
31
+ * <code>MaxResults</code> in the request to specify the maximum number of results to
32
+ * be returned in the response. If you do not set <code>MaxResults</code>, the response
33
+ * includes a maximum of 1,000 results. If you set <code>MaxResults</code> and there are
34
+ * additional results to display, the response includes a value for <code>NextToken</code>.
35
+ * Use <code>NextToken</code> as a parameter in your next request to
36
+ * <code>listQueues</code> to receive the next page of results. </p>
35
37
  * <note>
36
38
  * <p>Cross-account permissions don't apply to this action. For more information,
37
39
  * 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
38
- * cross-account permissions to a role and a user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
40
+ * cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
39
41
  * </note>
40
42
  * @example
41
43
  * Use a bare-bones client and the command you need to make an API call.
@@ -28,14 +28,14 @@ export interface PurgeQueueCommandOutput extends __MetadataBearer {
28
28
  * <important>
29
29
  * <p>When you use the <code>PurgeQueue</code> action, you can't retrieve any messages
30
30
  * deleted from a queue.</p>
31
- * <p>The message deletion process takes up to 60 seconds. We recommend waiting for
32
- * 60 seconds regardless of your queue's size. </p>
31
+ * <p>The message deletion process takes up to 60 seconds. We recommend waiting for 60
32
+ * seconds regardless of your queue's size. </p>
33
33
  * </important>
34
34
  * <p>Messages sent to the queue <i>before</i> you call
35
35
  * <code>PurgeQueue</code> might be received but are deleted within the next
36
36
  * minute.</p>
37
- * <p>Messages sent to the queue <i>after</i> you call
38
- * <code>PurgeQueue</code> might be deleted while the queue is being purged.</p>
37
+ * <p>Messages sent to the queue <i>after</i> you call <code>PurgeQueue</code>
38
+ * might be deleted while the queue is being purged.</p>
39
39
  * @example
40
40
  * Use a bare-bones client and the command you need to make an API call.
41
41
  * ```javascript
@@ -58,7 +58,9 @@ export interface PurgeQueueCommandOutput extends __MetadataBearer {
58
58
  * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
59
59
  *
60
60
  * @throws {@link PurgeQueueInProgress} (client fault)
61
- * <p>Indicates that the specified queue previously received a <code>PurgeQueue</code> request within the last 60 seconds (the time it can take to delete the messages in the queue).</p>
61
+ * <p>Indicates that the specified queue previously received a <code>PurgeQueue</code>
62
+ * request within the last 60 seconds (the time it can take to delete the messages in the
63
+ * queue).</p>
62
64
  *
63
65
  * @throws {@link QueueDoesNotExist} (client fault)
64
66
  * <p>The specified queue doesn't exist.</p>