@aws-sdk/client-sqs 3.327.0 → 3.328.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.
- package/README.md +6 -10
- package/dist-cjs/commands/AddPermissionCommand.js +3 -3
- package/dist-cjs/commands/ChangeMessageVisibilityBatchCommand.js +3 -3
- package/dist-cjs/commands/ChangeMessageVisibilityCommand.js +3 -3
- package/dist-cjs/commands/CreateQueueCommand.js +3 -3
- package/dist-cjs/commands/DeleteMessageBatchCommand.js +3 -3
- package/dist-cjs/commands/DeleteMessageCommand.js +3 -3
- package/dist-cjs/commands/DeleteQueueCommand.js +3 -3
- package/dist-cjs/commands/GetQueueAttributesCommand.js +3 -3
- package/dist-cjs/commands/GetQueueUrlCommand.js +3 -3
- package/dist-cjs/commands/ListDeadLetterSourceQueuesCommand.js +3 -3
- package/dist-cjs/commands/ListQueueTagsCommand.js +3 -3
- package/dist-cjs/commands/ListQueuesCommand.js +3 -3
- package/dist-cjs/commands/PurgeQueueCommand.js +3 -3
- package/dist-cjs/commands/ReceiveMessageCommand.js +3 -3
- package/dist-cjs/commands/RemovePermissionCommand.js +3 -3
- package/dist-cjs/commands/SendMessageBatchCommand.js +3 -3
- package/dist-cjs/commands/SendMessageCommand.js +3 -3
- package/dist-cjs/commands/SetQueueAttributesCommand.js +3 -3
- package/dist-cjs/commands/TagQueueCommand.js +3 -3
- package/dist-cjs/commands/UntagQueueCommand.js +3 -3
- package/dist-cjs/models/models_0.js +29 -172
- package/dist-cjs/protocols/Aws_query.js +2127 -0
- package/dist-es/commands/AddPermissionCommand.js +1 -1
- package/dist-es/commands/ChangeMessageVisibilityBatchCommand.js +1 -1
- package/dist-es/commands/ChangeMessageVisibilityCommand.js +1 -1
- package/dist-es/commands/CreateQueueCommand.js +1 -1
- package/dist-es/commands/DeleteMessageBatchCommand.js +1 -1
- package/dist-es/commands/DeleteMessageCommand.js +1 -1
- package/dist-es/commands/DeleteQueueCommand.js +1 -1
- package/dist-es/commands/GetQueueAttributesCommand.js +1 -1
- package/dist-es/commands/GetQueueUrlCommand.js +1 -1
- package/dist-es/commands/ListDeadLetterSourceQueuesCommand.js +1 -1
- package/dist-es/commands/ListQueueTagsCommand.js +1 -1
- package/dist-es/commands/ListQueuesCommand.js +1 -1
- package/dist-es/commands/PurgeQueueCommand.js +1 -1
- package/dist-es/commands/ReceiveMessageCommand.js +1 -1
- package/dist-es/commands/RemovePermissionCommand.js +1 -1
- package/dist-es/commands/SendMessageBatchCommand.js +1 -1
- package/dist-es/commands/SendMessageCommand.js +1 -1
- package/dist-es/commands/SetQueueAttributesCommand.js +1 -1
- package/dist-es/commands/TagQueueCommand.js +1 -1
- package/dist-es/commands/UntagQueueCommand.js +1 -1
- package/dist-es/models/models_0.js +24 -156
- package/dist-es/protocols/Aws_query.js +2084 -0
- package/dist-types/SQS.d.ts +6 -10
- package/dist-types/SQSClient.d.ts +6 -10
- package/dist-types/commands/AddPermissionCommand.d.ts +23 -48
- package/dist-types/commands/ChangeMessageVisibilityBatchCommand.d.ts +12 -34
- package/dist-types/commands/ChangeMessageVisibilityCommand.d.ts +13 -47
- package/dist-types/commands/CreateQueueCommand.d.ts +18 -53
- package/dist-types/commands/DeleteMessageBatchCommand.d.ts +10 -31
- package/dist-types/commands/DeleteMessageCommand.d.ts +1 -29
- package/dist-types/commands/DeleteQueueCommand.d.ts +8 -44
- package/dist-types/commands/GetQueueAttributesCommand.d.ts +0 -28
- package/dist-types/commands/GetQueueUrlCommand.d.ts +4 -35
- package/dist-types/commands/ListDeadLetterSourceQueuesCommand.d.ts +10 -39
- package/dist-types/commands/ListQueueTagsCommand.d.ts +2 -34
- package/dist-types/commands/ListQueuesCommand.d.ts +11 -41
- package/dist-types/commands/PurgeQueueCommand.d.ts +5 -35
- package/dist-types/commands/ReceiveMessageCommand.d.ts +14 -87
- package/dist-types/commands/RemovePermissionCommand.d.ts +2 -34
- package/dist-types/commands/SendMessageBatchCommand.d.ts +13 -73
- package/dist-types/commands/SendMessageCommand.d.ts +0 -59
- package/dist-types/commands/SetQueueAttributesCommand.d.ts +3 -47
- package/dist-types/commands/TagQueueCommand.d.ts +1 -32
- package/dist-types/commands/UntagQueueCommand.d.ts +1 -32
- package/dist-types/models/models_0.d.ts +412 -926
- package/dist-types/protocols/{Aws_json1_0.d.ts → Aws_query.d.ts} +40 -40
- package/dist-types/ts3.4/models/models_0.d.ts +21 -78
- package/package.json +5 -4
- package/dist-cjs/protocols/Aws_json1_0.js +0 -1608
- package/dist-es/protocols/Aws_json1_0.js +0 -1565
- /package/dist-types/ts3.4/protocols/{Aws_json1_0.d.ts → Aws_query.d.ts} +0 -0
|
@@ -19,25 +19,20 @@ export interface DeleteQueueCommandOutput extends __MetadataBearer {
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Deletes the queue specified by the <code>QueueUrl</code>, regardless of the queue's
|
|
23
|
-
* contents.</p>
|
|
22
|
+
* <p>Deletes the queue specified by the <code>QueueUrl</code>, regardless of the queue's contents.</p>
|
|
24
23
|
* <important>
|
|
25
|
-
* <p>Be careful with the <code>DeleteQueue</code> action: When you delete a queue, any
|
|
26
|
-
*
|
|
24
|
+
* <p>Be careful with the <code>DeleteQueue</code> action: When you delete a queue, any messages in the queue are no longer available.
|
|
25
|
+
* </p>
|
|
27
26
|
* </important>
|
|
28
|
-
* <p>When you delete a queue, the deletion process takes up to 60 seconds. Requests you
|
|
29
|
-
*
|
|
30
|
-
* <code>
|
|
27
|
+
* <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
|
|
28
|
+
* <code>
|
|
31
29
|
* <a>SendMessage</a>
|
|
32
|
-
* </code> request might succeed, but after 60
|
|
33
|
-
*
|
|
34
|
-
* <p>When you delete a queue, you must wait at least 60 seconds before creating a queue
|
|
35
|
-
* with the same name.</p>
|
|
30
|
+
* </code> request might succeed, but after 60 seconds the queue and the message you sent no longer exist.</p>
|
|
31
|
+
* <p>When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.</p>
|
|
36
32
|
* <note>
|
|
37
33
|
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
38
34
|
* 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
|
|
40
|
-
* <p>The delete operation uses the HTTP <code>GET</code> verb.</p>
|
|
35
|
+
* cross-account permissions to a role and a user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
41
36
|
* </note>
|
|
42
37
|
* @example
|
|
43
38
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -60,37 +55,6 @@ export interface DeleteQueueCommandOutput extends __MetadataBearer {
|
|
|
60
55
|
* @see {@link DeleteQueueCommandOutput} for command's `response` shape.
|
|
61
56
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
62
57
|
*
|
|
63
|
-
* @throws {@link InvalidAddress} (client fault)
|
|
64
|
-
* <p>The <code>accountId</code> is invalid.</p>
|
|
65
|
-
*
|
|
66
|
-
* @throws {@link InvalidSecurity} (client fault)
|
|
67
|
-
* <p>When the request to a queue is not HTTPS and SigV4.</p>
|
|
68
|
-
*
|
|
69
|
-
* @throws {@link QueueDoesNotExist} (client fault)
|
|
70
|
-
* <p>The specified queue doesn't exist.</p>
|
|
71
|
-
*
|
|
72
|
-
* @throws {@link RequestThrottled} (client fault)
|
|
73
|
-
* <p>The request was denied due to request throttling.</p>
|
|
74
|
-
* <ul>
|
|
75
|
-
* <li>
|
|
76
|
-
* <p>The rate of requests per second exceeds the AWS KMS request quota for an
|
|
77
|
-
* account and Region. </p>
|
|
78
|
-
* </li>
|
|
79
|
-
* <li>
|
|
80
|
-
* <p>A burst or sustained high rate of requests to change the state of the same KMS
|
|
81
|
-
* key. This condition is often known as a "hot key."</p>
|
|
82
|
-
* </li>
|
|
83
|
-
* <li>
|
|
84
|
-
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
85
|
-
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
86
|
-
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
87
|
-
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
88
|
-
* </li>
|
|
89
|
-
* </ul>
|
|
90
|
-
*
|
|
91
|
-
* @throws {@link UnsupportedOperation} (client fault)
|
|
92
|
-
* <p>Error code 400. Unsupported operation.</p>
|
|
93
|
-
*
|
|
94
58
|
* @throws {@link SQSServiceException}
|
|
95
59
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
96
60
|
*
|
|
@@ -54,34 +54,6 @@ export interface GetQueueAttributesCommandOutput extends GetQueueAttributesResul
|
|
|
54
54
|
* @throws {@link InvalidAttributeName} (client fault)
|
|
55
55
|
* <p>The specified attribute doesn't exist.</p>
|
|
56
56
|
*
|
|
57
|
-
* @throws {@link InvalidSecurity} (client fault)
|
|
58
|
-
* <p>When the request to a queue is not HTTPS and SigV4.</p>
|
|
59
|
-
*
|
|
60
|
-
* @throws {@link QueueDoesNotExist} (client fault)
|
|
61
|
-
* <p>The specified queue doesn't exist.</p>
|
|
62
|
-
*
|
|
63
|
-
* @throws {@link RequestThrottled} (client fault)
|
|
64
|
-
* <p>The request was denied due to request throttling.</p>
|
|
65
|
-
* <ul>
|
|
66
|
-
* <li>
|
|
67
|
-
* <p>The rate of requests per second exceeds the AWS KMS request quota for an
|
|
68
|
-
* account and Region. </p>
|
|
69
|
-
* </li>
|
|
70
|
-
* <li>
|
|
71
|
-
* <p>A burst or sustained high rate of requests to change the state of the same KMS
|
|
72
|
-
* key. This condition is often known as a "hot key."</p>
|
|
73
|
-
* </li>
|
|
74
|
-
* <li>
|
|
75
|
-
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
76
|
-
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
77
|
-
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
78
|
-
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
79
|
-
* </li>
|
|
80
|
-
* </ul>
|
|
81
|
-
*
|
|
82
|
-
* @throws {@link UnsupportedOperation} (client fault)
|
|
83
|
-
* <p>Error code 400. Unsupported operation.</p>
|
|
84
|
-
*
|
|
85
57
|
* @throws {@link SQSServiceException}
|
|
86
58
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
87
59
|
*
|
|
@@ -20,14 +20,11 @@ export interface GetQueueUrlCommandOutput extends GetQueueUrlResult, __MetadataB
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Returns the URL of an existing Amazon SQS queue.</p>
|
|
23
|
-
* <p>To access a queue that belongs to another AWS account, use the
|
|
24
|
-
*
|
|
25
|
-
* queue's owner. The queue's owner must grant you permission to access the queue. For more
|
|
26
|
-
* information about shared queue access, see <code>
|
|
23
|
+
* <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.
|
|
24
|
+
* For more information about shared queue access, see <code>
|
|
27
25
|
* <a>AddPermission</a>
|
|
28
|
-
* </code>
|
|
29
|
-
*
|
|
30
|
-
* Developer Guide</i>. </p>
|
|
26
|
+
* </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>.
|
|
27
|
+
* </p>
|
|
31
28
|
* @example
|
|
32
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
30
|
* ```javascript
|
|
@@ -52,37 +49,9 @@ export interface GetQueueUrlCommandOutput extends GetQueueUrlResult, __MetadataB
|
|
|
52
49
|
* @see {@link GetQueueUrlCommandOutput} for command's `response` shape.
|
|
53
50
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
54
51
|
*
|
|
55
|
-
* @throws {@link InvalidAddress} (client fault)
|
|
56
|
-
* <p>The <code>accountId</code> is invalid.</p>
|
|
57
|
-
*
|
|
58
|
-
* @throws {@link InvalidSecurity} (client fault)
|
|
59
|
-
* <p>When the request to a queue is not HTTPS and SigV4.</p>
|
|
60
|
-
*
|
|
61
52
|
* @throws {@link QueueDoesNotExist} (client fault)
|
|
62
53
|
* <p>The specified queue doesn't exist.</p>
|
|
63
54
|
*
|
|
64
|
-
* @throws {@link RequestThrottled} (client fault)
|
|
65
|
-
* <p>The request was denied due to request throttling.</p>
|
|
66
|
-
* <ul>
|
|
67
|
-
* <li>
|
|
68
|
-
* <p>The rate of requests per second exceeds the AWS KMS request quota for an
|
|
69
|
-
* account and Region. </p>
|
|
70
|
-
* </li>
|
|
71
|
-
* <li>
|
|
72
|
-
* <p>A burst or sustained high rate of requests to change the state of the same KMS
|
|
73
|
-
* key. This condition is often known as a "hot key."</p>
|
|
74
|
-
* </li>
|
|
75
|
-
* <li>
|
|
76
|
-
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
77
|
-
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
78
|
-
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
79
|
-
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
80
|
-
* </li>
|
|
81
|
-
* </ul>
|
|
82
|
-
*
|
|
83
|
-
* @throws {@link UnsupportedOperation} (client fault)
|
|
84
|
-
* <p>Error code 400. Unsupported operation.</p>
|
|
85
|
-
*
|
|
86
55
|
* @throws {@link SQSServiceException}
|
|
87
56
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
88
57
|
*
|
|
@@ -19,17 +19,16 @@ export interface ListDeadLetterSourceQueuesCommandOutput extends ListDeadLetterS
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Returns a list of your queues that have the <code>RedrivePolicy</code> queue attribute
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
* Guide</i>.</p>
|
|
22
|
+
* <p>Returns a list of your queues that have the <code>RedrivePolicy</code> queue attribute configured with a dead-letter queue.</p>
|
|
23
|
+
* <p> The <code>ListDeadLetterSourceQueues</code> methods supports
|
|
24
|
+
* pagination. Set parameter <code>MaxResults</code> in the request to specify the maximum number of
|
|
25
|
+
* results to be returned in the response. If you do not set <code>MaxResults</code>,
|
|
26
|
+
* the response includes a maximum of 1,000 results. If you set <code>MaxResults</code> and there are additional results to
|
|
27
|
+
* display, the response includes a value for <code>NextToken</code>. Use
|
|
28
|
+
* <code>NextToken</code> as a parameter in your next request to
|
|
29
|
+
* <code>ListDeadLetterSourceQueues</code> to receive the next page of results. </p>
|
|
30
|
+
* <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>
|
|
31
|
+
* in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
33
32
|
* @example
|
|
34
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
34
|
* ```javascript
|
|
@@ -58,37 +57,9 @@ export interface ListDeadLetterSourceQueuesCommandOutput extends ListDeadLetterS
|
|
|
58
57
|
* @see {@link ListDeadLetterSourceQueuesCommandOutput} for command's `response` shape.
|
|
59
58
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
60
59
|
*
|
|
61
|
-
* @throws {@link InvalidAddress} (client fault)
|
|
62
|
-
* <p>The <code>accountId</code> is invalid.</p>
|
|
63
|
-
*
|
|
64
|
-
* @throws {@link InvalidSecurity} (client fault)
|
|
65
|
-
* <p>When the request to a queue is not HTTPS and SigV4.</p>
|
|
66
|
-
*
|
|
67
60
|
* @throws {@link QueueDoesNotExist} (client fault)
|
|
68
61
|
* <p>The specified queue doesn't exist.</p>
|
|
69
62
|
*
|
|
70
|
-
* @throws {@link RequestThrottled} (client fault)
|
|
71
|
-
* <p>The request was denied due to request throttling.</p>
|
|
72
|
-
* <ul>
|
|
73
|
-
* <li>
|
|
74
|
-
* <p>The rate of requests per second exceeds the AWS KMS request quota for an
|
|
75
|
-
* account and Region. </p>
|
|
76
|
-
* </li>
|
|
77
|
-
* <li>
|
|
78
|
-
* <p>A burst or sustained high rate of requests to change the state of the same KMS
|
|
79
|
-
* key. This condition is often known as a "hot key."</p>
|
|
80
|
-
* </li>
|
|
81
|
-
* <li>
|
|
82
|
-
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
83
|
-
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
84
|
-
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
85
|
-
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
86
|
-
* </li>
|
|
87
|
-
* </ul>
|
|
88
|
-
*
|
|
89
|
-
* @throws {@link UnsupportedOperation} (client fault)
|
|
90
|
-
* <p>Error code 400. Unsupported operation.</p>
|
|
91
|
-
*
|
|
92
63
|
* @throws {@link SQSServiceException}
|
|
93
64
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
94
65
|
*
|
|
@@ -19,13 +19,12 @@ export interface ListQueueTagsCommandOutput extends ListQueueTagsResult, __Metad
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>List all cost allocation tags added to the specified Amazon SQS queue.
|
|
23
|
-
* For an overview, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html">Tagging
|
|
22
|
+
* <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
|
|
24
23
|
* Your Amazon SQS Queues</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
25
24
|
* <note>
|
|
26
25
|
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
27
26
|
* 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
|
|
28
|
-
* cross-account permissions to a role and a
|
|
27
|
+
* cross-account permissions to a role and a user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
29
28
|
* </note>
|
|
30
29
|
* @example
|
|
31
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -52,37 +51,6 @@ export interface ListQueueTagsCommandOutput extends ListQueueTagsResult, __Metad
|
|
|
52
51
|
* @see {@link ListQueueTagsCommandOutput} for command's `response` shape.
|
|
53
52
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
54
53
|
*
|
|
55
|
-
* @throws {@link InvalidAddress} (client fault)
|
|
56
|
-
* <p>The <code>accountId</code> is invalid.</p>
|
|
57
|
-
*
|
|
58
|
-
* @throws {@link InvalidSecurity} (client fault)
|
|
59
|
-
* <p>When the request to a queue is not HTTPS and SigV4.</p>
|
|
60
|
-
*
|
|
61
|
-
* @throws {@link QueueDoesNotExist} (client fault)
|
|
62
|
-
* <p>The specified queue doesn't exist.</p>
|
|
63
|
-
*
|
|
64
|
-
* @throws {@link RequestThrottled} (client fault)
|
|
65
|
-
* <p>The request was denied due to request throttling.</p>
|
|
66
|
-
* <ul>
|
|
67
|
-
* <li>
|
|
68
|
-
* <p>The rate of requests per second exceeds the AWS KMS request quota for an
|
|
69
|
-
* account and Region. </p>
|
|
70
|
-
* </li>
|
|
71
|
-
* <li>
|
|
72
|
-
* <p>A burst or sustained high rate of requests to change the state of the same KMS
|
|
73
|
-
* key. This condition is often known as a "hot key."</p>
|
|
74
|
-
* </li>
|
|
75
|
-
* <li>
|
|
76
|
-
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
77
|
-
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
78
|
-
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
79
|
-
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
80
|
-
* </li>
|
|
81
|
-
* </ul>
|
|
82
|
-
*
|
|
83
|
-
* @throws {@link UnsupportedOperation} (client fault)
|
|
84
|
-
* <p>Error code 400. Unsupported operation.</p>
|
|
85
|
-
*
|
|
86
54
|
* @throws {@link SQSServiceException}
|
|
87
55
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
88
56
|
*
|
|
@@ -19,21 +19,19 @@ export interface ListQueuesCommandOutput extends ListQueuesResult, __MetadataBea
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Returns a list of your queues in the current region. The response includes a maximum
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
* Use <code>NextToken</code> as a parameter in your next request to
|
|
32
|
-
* <code>listQueues</code> to receive the next page of results. </p>
|
|
22
|
+
* <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
|
|
23
|
+
* <code>QueueNamePrefix</code> parameter, only queues with a name that begins with the specified value are returned.</p>
|
|
24
|
+
* <p> The <code>listQueues</code> methods supports
|
|
25
|
+
* pagination. Set parameter <code>MaxResults</code> in the request to specify the maximum number of
|
|
26
|
+
* results to be returned in the response. If you do not set <code>MaxResults</code>,
|
|
27
|
+
* the response includes a maximum of 1,000 results. If you set <code>MaxResults</code> and there are additional results to
|
|
28
|
+
* display, the response includes a value for <code>NextToken</code>. Use
|
|
29
|
+
* <code>NextToken</code> as a parameter in your next request to
|
|
30
|
+
* <code>listQueues</code> to receive the next page of results. </p>
|
|
33
31
|
* <note>
|
|
34
32
|
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
35
33
|
* 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
|
|
36
|
-
* cross-account permissions to a role and a
|
|
34
|
+
* cross-account permissions to a role and a user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
37
35
|
* </note>
|
|
38
36
|
* @example
|
|
39
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -49,10 +47,10 @@ export interface ListQueuesCommandOutput extends ListQueuesResult, __MetadataBea
|
|
|
49
47
|
* const command = new ListQueuesCommand(input);
|
|
50
48
|
* const response = await client.send(command);
|
|
51
49
|
* // { // ListQueuesResult
|
|
50
|
+
* // NextToken: "STRING_VALUE",
|
|
52
51
|
* // QueueUrls: [ // QueueUrlList
|
|
53
52
|
* // "STRING_VALUE",
|
|
54
53
|
* // ],
|
|
55
|
-
* // NextToken: "STRING_VALUE",
|
|
56
54
|
* // };
|
|
57
55
|
*
|
|
58
56
|
* ```
|
|
@@ -63,34 +61,6 @@ export interface ListQueuesCommandOutput extends ListQueuesResult, __MetadataBea
|
|
|
63
61
|
* @see {@link ListQueuesCommandOutput} for command's `response` shape.
|
|
64
62
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
65
63
|
*
|
|
66
|
-
* @throws {@link InvalidAddress} (client fault)
|
|
67
|
-
* <p>The <code>accountId</code> is invalid.</p>
|
|
68
|
-
*
|
|
69
|
-
* @throws {@link InvalidSecurity} (client fault)
|
|
70
|
-
* <p>When the request to a queue is not HTTPS and SigV4.</p>
|
|
71
|
-
*
|
|
72
|
-
* @throws {@link RequestThrottled} (client fault)
|
|
73
|
-
* <p>The request was denied due to request throttling.</p>
|
|
74
|
-
* <ul>
|
|
75
|
-
* <li>
|
|
76
|
-
* <p>The rate of requests per second exceeds the AWS KMS request quota for an
|
|
77
|
-
* account and Region. </p>
|
|
78
|
-
* </li>
|
|
79
|
-
* <li>
|
|
80
|
-
* <p>A burst or sustained high rate of requests to change the state of the same KMS
|
|
81
|
-
* key. This condition is often known as a "hot key."</p>
|
|
82
|
-
* </li>
|
|
83
|
-
* <li>
|
|
84
|
-
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
85
|
-
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
86
|
-
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
87
|
-
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
88
|
-
* </li>
|
|
89
|
-
* </ul>
|
|
90
|
-
*
|
|
91
|
-
* @throws {@link UnsupportedOperation} (client fault)
|
|
92
|
-
* <p>Error code 400. Unsupported operation.</p>
|
|
93
|
-
*
|
|
94
64
|
* @throws {@link SQSServiceException}
|
|
95
65
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
96
66
|
*
|
|
@@ -24,14 +24,14 @@ export interface PurgeQueueCommandOutput extends __MetadataBearer {
|
|
|
24
24
|
* <important>
|
|
25
25
|
* <p>When you use the <code>PurgeQueue</code> action, you can't retrieve any messages
|
|
26
26
|
* deleted from a queue.</p>
|
|
27
|
-
* <p>The message deletion process takes up to 60 seconds. We recommend waiting for
|
|
28
|
-
* seconds regardless of your queue's size. </p>
|
|
27
|
+
* <p>The message deletion process takes up to 60 seconds. We recommend waiting for
|
|
28
|
+
* 60 seconds regardless of your queue's size. </p>
|
|
29
29
|
* </important>
|
|
30
30
|
* <p>Messages sent to the queue <i>before</i> you call
|
|
31
31
|
* <code>PurgeQueue</code> might be received but are deleted within the next
|
|
32
32
|
* minute.</p>
|
|
33
|
-
* <p>Messages sent to the queue <i>after</i> you call
|
|
34
|
-
*
|
|
33
|
+
* <p>Messages sent to the queue <i>after</i> you call
|
|
34
|
+
* <code>PurgeQueue</code> might be deleted while the queue is being purged.</p>
|
|
35
35
|
* @example
|
|
36
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
37
|
* ```javascript
|
|
@@ -53,42 +53,12 @@ export interface PurgeQueueCommandOutput extends __MetadataBearer {
|
|
|
53
53
|
* @see {@link PurgeQueueCommandOutput} for command's `response` shape.
|
|
54
54
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
55
55
|
*
|
|
56
|
-
* @throws {@link InvalidAddress} (client fault)
|
|
57
|
-
* <p>The <code>accountId</code> is invalid.</p>
|
|
58
|
-
*
|
|
59
|
-
* @throws {@link InvalidSecurity} (client fault)
|
|
60
|
-
* <p>When the request to a queue is not HTTPS and SigV4.</p>
|
|
61
|
-
*
|
|
62
56
|
* @throws {@link PurgeQueueInProgress} (client fault)
|
|
63
|
-
* <p>Indicates that the specified queue previously received a <code>PurgeQueue</code>
|
|
64
|
-
* request within the last 60 seconds (the time it can take to delete the messages in the
|
|
65
|
-
* queue).</p>
|
|
57
|
+
* <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>
|
|
66
58
|
*
|
|
67
59
|
* @throws {@link QueueDoesNotExist} (client fault)
|
|
68
60
|
* <p>The specified queue doesn't exist.</p>
|
|
69
61
|
*
|
|
70
|
-
* @throws {@link RequestThrottled} (client fault)
|
|
71
|
-
* <p>The request was denied due to request throttling.</p>
|
|
72
|
-
* <ul>
|
|
73
|
-
* <li>
|
|
74
|
-
* <p>The rate of requests per second exceeds the AWS KMS request quota for an
|
|
75
|
-
* account and Region. </p>
|
|
76
|
-
* </li>
|
|
77
|
-
* <li>
|
|
78
|
-
* <p>A burst or sustained high rate of requests to change the state of the same KMS
|
|
79
|
-
* key. This condition is often known as a "hot key."</p>
|
|
80
|
-
* </li>
|
|
81
|
-
* <li>
|
|
82
|
-
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
83
|
-
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
84
|
-
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
85
|
-
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
86
|
-
* </li>
|
|
87
|
-
* </ul>
|
|
88
|
-
*
|
|
89
|
-
* @throws {@link UnsupportedOperation} (client fault)
|
|
90
|
-
* <p>Error code 400. Unsupported operation.</p>
|
|
91
|
-
*
|
|
92
62
|
* @throws {@link SQSServiceException}
|
|
93
63
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
94
64
|
*
|
|
@@ -19,17 +19,13 @@ export interface ReceiveMessageCommandOutput extends ReceiveMessageResult, __Met
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Retrieves one or more messages (up to 10), from the specified queue. Using the
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
* most likely get fewer messages than you requested per <code>ReceiveMessage</code> call.
|
|
30
|
-
* If the number of messages in the queue is extremely small, you might not receive any
|
|
31
|
-
* messages in a particular <code>ReceiveMessage</code> response. If this happens, repeat
|
|
32
|
-
* the request. </p>
|
|
22
|
+
* <p>Retrieves one or more messages (up to 10), from the specified queue. Using the <code>WaitTimeSeconds</code> parameter enables long-poll support.
|
|
23
|
+
* 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>.
|
|
24
|
+
* </p>
|
|
25
|
+
* <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.
|
|
26
|
+
* 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,
|
|
27
|
+
* you might not receive any messages in a particular <code>ReceiveMessage</code> response. If this happens, repeat the request.
|
|
28
|
+
* </p>
|
|
33
29
|
* <p>For each message returned, the response includes the following:</p>
|
|
34
30
|
* <ul>
|
|
35
31
|
* <li>
|
|
@@ -39,8 +35,7 @@ export interface ReceiveMessageCommandOutput extends ReceiveMessageResult, __Met
|
|
|
39
35
|
* <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>
|
|
40
36
|
* </li>
|
|
41
37
|
* <li>
|
|
42
|
-
* <p>The <code>MessageId</code> you received when you sent the message to the
|
|
43
|
-
* queue.</p>
|
|
38
|
+
* <p>The <code>MessageId</code> you received when you sent the message to the queue.</p>
|
|
44
39
|
* </li>
|
|
45
40
|
* <li>
|
|
46
41
|
* <p>The receipt handle.</p>
|
|
@@ -52,17 +47,11 @@ export interface ReceiveMessageCommandOutput extends ReceiveMessageResult, __Met
|
|
|
52
47
|
* <p>An MD5 digest of the message attributes.</p>
|
|
53
48
|
* </li>
|
|
54
49
|
* </ul>
|
|
55
|
-
* <p>The receipt handle is the identifier you must provide when deleting the message. For
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
* include the parameter, the overall visibility timeout for the queue is used for the
|
|
61
|
-
* 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
|
|
62
|
-
* Guide</i>.</p>
|
|
63
|
-
* <p>A message that isn't deleted or a message whose visibility isn't extended before the
|
|
64
|
-
* visibility timeout expires counts as a failed receive. Depending on the configuration of
|
|
65
|
-
* the queue, the message might be sent to the dead-letter queue.</p>
|
|
50
|
+
* <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
|
|
51
|
+
* and Message Identifiers</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
52
|
+
* <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
|
|
53
|
+
* 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>
|
|
54
|
+
* <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>
|
|
66
55
|
* <note>
|
|
67
56
|
* <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>
|
|
68
57
|
* </note>
|
|
@@ -123,74 +112,12 @@ export interface ReceiveMessageCommandOutput extends ReceiveMessageResult, __Met
|
|
|
123
112
|
* @see {@link ReceiveMessageCommandOutput} for command's `response` shape.
|
|
124
113
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
125
114
|
*
|
|
126
|
-
* @throws {@link InvalidSecurity} (client fault)
|
|
127
|
-
* <p>When the request to a queue is not HTTPS and SigV4.</p>
|
|
128
|
-
*
|
|
129
|
-
* @throws {@link KmsAccessDenied} (client fault)
|
|
130
|
-
* <p>The caller doesn't have the required KMS access.</p>
|
|
131
|
-
*
|
|
132
|
-
* @throws {@link KmsDisabled} (client fault)
|
|
133
|
-
* <p>The request was denied due to request throttling.</p>
|
|
134
|
-
*
|
|
135
|
-
* @throws {@link KmsInvalidKeyUsage} (client fault)
|
|
136
|
-
* <p>The request was rejected for one of the following reasons:</p>
|
|
137
|
-
* <ul>
|
|
138
|
-
* <li>
|
|
139
|
-
* <p>The KeyUsage value of the KMS key is incompatible with the API
|
|
140
|
-
* operation.</p>
|
|
141
|
-
* </li>
|
|
142
|
-
* <li>
|
|
143
|
-
* <p>The encryption algorithm or signing algorithm specified for the operation is
|
|
144
|
-
* incompatible with the type of key material in the KMS key (KeySpec).</p>
|
|
145
|
-
* </li>
|
|
146
|
-
* </ul>
|
|
147
|
-
*
|
|
148
|
-
* @throws {@link KmsInvalidState} (client fault)
|
|
149
|
-
* <p>The request was rejected because the state of the specified resource is not valid for
|
|
150
|
-
* this request.</p>
|
|
151
|
-
*
|
|
152
|
-
* @throws {@link KmsNotFound} (client fault)
|
|
153
|
-
* <p>The request was rejected because the specified entity or resource could not be found.
|
|
154
|
-
* </p>
|
|
155
|
-
*
|
|
156
|
-
* @throws {@link KmsOptInRequired} (client fault)
|
|
157
|
-
* <p>The request was rejected because the specified key policy isn't syntactically or
|
|
158
|
-
* semantically correct.</p>
|
|
159
|
-
*
|
|
160
|
-
* @throws {@link KmsThrottled} (client fault)
|
|
161
|
-
* <p>Amazon Web Services KMS throttles requests for the following conditions.</p>
|
|
162
|
-
*
|
|
163
115
|
* @throws {@link OverLimit} (client fault)
|
|
164
116
|
* <p>The specified action violates a limit. For example, <code>ReceiveMessage</code>
|
|
165
|
-
* returns this error if the maximum number of
|
|
117
|
+
* returns this error if the maximum number of inflight messages is reached and
|
|
166
118
|
* <code>AddPermission</code> returns this error if the maximum number of permissions
|
|
167
119
|
* for the queue is reached.</p>
|
|
168
120
|
*
|
|
169
|
-
* @throws {@link QueueDoesNotExist} (client fault)
|
|
170
|
-
* <p>The specified queue doesn't exist.</p>
|
|
171
|
-
*
|
|
172
|
-
* @throws {@link RequestThrottled} (client fault)
|
|
173
|
-
* <p>The request was denied due to request throttling.</p>
|
|
174
|
-
* <ul>
|
|
175
|
-
* <li>
|
|
176
|
-
* <p>The rate of requests per second exceeds the AWS KMS request quota for an
|
|
177
|
-
* account and Region. </p>
|
|
178
|
-
* </li>
|
|
179
|
-
* <li>
|
|
180
|
-
* <p>A burst or sustained high rate of requests to change the state of the same KMS
|
|
181
|
-
* key. This condition is often known as a "hot key."</p>
|
|
182
|
-
* </li>
|
|
183
|
-
* <li>
|
|
184
|
-
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
185
|
-
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
186
|
-
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
187
|
-
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
188
|
-
* </li>
|
|
189
|
-
* </ul>
|
|
190
|
-
*
|
|
191
|
-
* @throws {@link UnsupportedOperation} (client fault)
|
|
192
|
-
* <p>Error code 400. Unsupported operation.</p>
|
|
193
|
-
*
|
|
194
121
|
* @throws {@link SQSServiceException}
|
|
195
122
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
196
123
|
*
|
|
@@ -19,8 +19,7 @@ export interface RemovePermissionCommandOutput extends __MetadataBearer {
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Revokes any permissions in the queue policy that matches the specified
|
|
23
|
-
* <code>Label</code> parameter.</p>
|
|
22
|
+
* <p>Revokes any permissions in the queue policy that matches the specified <code>Label</code> parameter.</p>
|
|
24
23
|
* <note>
|
|
25
24
|
* <ul>
|
|
26
25
|
* <li>
|
|
@@ -29,7 +28,7 @@ export interface RemovePermissionCommandOutput extends __MetadataBearer {
|
|
|
29
28
|
* <li>
|
|
30
29
|
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
31
30
|
* 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
|
|
32
|
-
* cross-account permissions to a role and a
|
|
31
|
+
* cross-account permissions to a role and a user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
33
32
|
* </li>
|
|
34
33
|
* <li>
|
|
35
34
|
* <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>
|
|
@@ -58,37 +57,6 @@ export interface RemovePermissionCommandOutput extends __MetadataBearer {
|
|
|
58
57
|
* @see {@link RemovePermissionCommandOutput} for command's `response` shape.
|
|
59
58
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
60
59
|
*
|
|
61
|
-
* @throws {@link InvalidAddress} (client fault)
|
|
62
|
-
* <p>The <code>accountId</code> is invalid.</p>
|
|
63
|
-
*
|
|
64
|
-
* @throws {@link InvalidSecurity} (client fault)
|
|
65
|
-
* <p>When the request to a queue is not HTTPS and SigV4.</p>
|
|
66
|
-
*
|
|
67
|
-
* @throws {@link QueueDoesNotExist} (client fault)
|
|
68
|
-
* <p>The specified queue doesn't exist.</p>
|
|
69
|
-
*
|
|
70
|
-
* @throws {@link RequestThrottled} (client fault)
|
|
71
|
-
* <p>The request was denied due to request throttling.</p>
|
|
72
|
-
* <ul>
|
|
73
|
-
* <li>
|
|
74
|
-
* <p>The rate of requests per second exceeds the AWS KMS request quota for an
|
|
75
|
-
* account and Region. </p>
|
|
76
|
-
* </li>
|
|
77
|
-
* <li>
|
|
78
|
-
* <p>A burst or sustained high rate of requests to change the state of the same KMS
|
|
79
|
-
* key. This condition is often known as a "hot key."</p>
|
|
80
|
-
* </li>
|
|
81
|
-
* <li>
|
|
82
|
-
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
83
|
-
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
84
|
-
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
85
|
-
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
86
|
-
* </li>
|
|
87
|
-
* </ul>
|
|
88
|
-
*
|
|
89
|
-
* @throws {@link UnsupportedOperation} (client fault)
|
|
90
|
-
* <p>Error code 400. Unsupported operation.</p>
|
|
91
|
-
*
|
|
92
60
|
* @throws {@link SQSServiceException}
|
|
93
61
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
94
62
|
*
|