@aws-sdk/client-sqs 3.326.0 → 3.327.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 +10 -7
- 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/endpoint/ruleset.js +2 -2
- package/dist-cjs/models/models_0.js +206 -26
- package/dist-cjs/protocols/Aws_json1_0.js +1608 -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/endpoint/ruleset.js +2 -2
- package/dist-es/models/models_0.js +189 -20
- package/dist-es/protocols/Aws_json1_0.js +1565 -0
- package/dist-types/SQS.d.ts +24 -21
- package/dist-types/SQSClient.d.ts +24 -21
- package/dist-types/commands/AddPermissionCommand.d.ts +51 -26
- package/dist-types/commands/ChangeMessageVisibilityBatchCommand.d.ts +34 -12
- package/dist-types/commands/ChangeMessageVisibilityCommand.d.ts +48 -15
- package/dist-types/commands/CreateQueueCommand.d.ts +58 -24
- package/dist-types/commands/DeleteMessageBatchCommand.d.ts +31 -10
- package/dist-types/commands/DeleteMessageCommand.d.ts +29 -1
- package/dist-types/commands/DeleteQueueCommand.d.ts +44 -8
- package/dist-types/commands/GetQueueAttributesCommand.d.ts +29 -1
- package/dist-types/commands/GetQueueUrlCommand.d.ts +35 -4
- package/dist-types/commands/ListDeadLetterSourceQueuesCommand.d.ts +39 -11
- package/dist-types/commands/ListQueueTagsCommand.d.ts +36 -4
- package/dist-types/commands/ListQueuesCommand.d.ts +41 -11
- package/dist-types/commands/PurgeQueueCommand.d.ts +36 -7
- package/dist-types/commands/ReceiveMessageCommand.d.ts +88 -15
- package/dist-types/commands/RemovePermissionCommand.d.ts +37 -5
- package/dist-types/commands/SendMessageBatchCommand.d.ts +76 -16
- package/dist-types/commands/SendMessageCommand.d.ts +62 -3
- package/dist-types/commands/SetQueueAttributesCommand.d.ts +50 -6
- package/dist-types/commands/TagQueueCommand.d.ts +34 -4
- package/dist-types/commands/UntagQueueCommand.d.ts +34 -3
- package/dist-types/models/models_0.d.ts +1039 -493
- package/dist-types/protocols/{Aws_query.d.ts → Aws_json1_0.d.ts} +40 -40
- package/dist-types/ts3.4/models/models_0.d.ts +119 -52
- package/package.json +7 -8
- package/dist-cjs/protocols/Aws_query.js +0 -2127
- package/dist-es/protocols/Aws_query.js +0 -2084
- /package/dist-types/ts3.4/protocols/{Aws_query.d.ts → Aws_json1_0.d.ts} +0 -0
|
@@ -19,18 +19,13 @@ export interface DeleteMessageBatchCommandOutput extends DeleteMessageBatchResul
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Deletes up to ten messages from the specified queue. This is a batch version of
|
|
23
|
-
*
|
|
22
|
+
* <p>Deletes up to ten messages from the specified queue. This is a batch version of
|
|
23
|
+
* <code>
|
|
24
|
+
* <a>DeleteMessage</a>.</code> The result of the action on each
|
|
25
|
+
* message is reported individually in the response.</p>
|
|
24
26
|
* <important>
|
|
25
27
|
* <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>
|
|
26
28
|
* </important>
|
|
27
|
-
* <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>
|
|
28
|
-
* <p>
|
|
29
|
-
* <code>&AttributeName.1=first</code>
|
|
30
|
-
* </p>
|
|
31
|
-
* <p>
|
|
32
|
-
* <code>&AttributeName.2=second</code>
|
|
33
|
-
* </p>
|
|
34
29
|
* @example
|
|
35
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
31
|
* ```javascript
|
|
@@ -79,11 +74,37 @@ export interface DeleteMessageBatchCommandOutput extends DeleteMessageBatchResul
|
|
|
79
74
|
* <p>The batch request doesn't contain any entries.</p>
|
|
80
75
|
*
|
|
81
76
|
* @throws {@link InvalidBatchEntryId} (client fault)
|
|
82
|
-
* <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the
|
|
77
|
+
* <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the
|
|
78
|
+
* specification.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link QueueDoesNotExist} (client fault)
|
|
81
|
+
* <p>The specified queue doesn't exist.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link RequestThrottled} (client fault)
|
|
84
|
+
* <p>The request was denied due to request throttling.</p>
|
|
85
|
+
* <ul>
|
|
86
|
+
* <li>
|
|
87
|
+
* <p>The rate of requests per second exceeds the AWS KMS request quota for an
|
|
88
|
+
* account and Region. </p>
|
|
89
|
+
* </li>
|
|
90
|
+
* <li>
|
|
91
|
+
* <p>A burst or sustained high rate of requests to change the state of the same KMS
|
|
92
|
+
* key. This condition is often known as a "hot key."</p>
|
|
93
|
+
* </li>
|
|
94
|
+
* <li>
|
|
95
|
+
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
96
|
+
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
97
|
+
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
98
|
+
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
99
|
+
* </li>
|
|
100
|
+
* </ul>
|
|
83
101
|
*
|
|
84
102
|
* @throws {@link TooManyEntriesInBatchRequest} (client fault)
|
|
85
103
|
* <p>The batch request contains more entries than permissible.</p>
|
|
86
104
|
*
|
|
105
|
+
* @throws {@link UnsupportedOperation} (client fault)
|
|
106
|
+
* <p>Error code 400. Unsupported operation.</p>
|
|
107
|
+
*
|
|
87
108
|
* @throws {@link SQSServiceException}
|
|
88
109
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
89
110
|
*
|
|
@@ -31,7 +31,7 @@ export interface DeleteMessageCommandOutput extends __MetadataBearer {
|
|
|
31
31
|
* once, the <code>ReceiptHandle</code> is different each time you receive a message.
|
|
32
32
|
* When you use the <code>DeleteMessage</code> action, you must provide the most
|
|
33
33
|
* recently received <code>ReceiptHandle</code> for the message (otherwise, the request
|
|
34
|
-
* succeeds, but the message
|
|
34
|
+
* succeeds, but the message will not be deleted).</p>
|
|
35
35
|
* <p>For standard queues, it is possible to receive a message even after you
|
|
36
36
|
* delete it. This might happen on rare occasions if one of the servers which stores a
|
|
37
37
|
* copy of the message is unavailable when you send the request to delete the message.
|
|
@@ -64,9 +64,37 @@ export interface DeleteMessageCommandOutput extends __MetadataBearer {
|
|
|
64
64
|
* @throws {@link InvalidIdFormat} (client fault)
|
|
65
65
|
* <p>The specified receipt handle isn't valid for the current version.</p>
|
|
66
66
|
*
|
|
67
|
+
* @throws {@link InvalidSecurity} (client fault)
|
|
68
|
+
* <p>When the request to a queue is not HTTPS and SigV4.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link QueueDoesNotExist} (client fault)
|
|
71
|
+
* <p>The specified queue doesn't exist.</p>
|
|
72
|
+
*
|
|
67
73
|
* @throws {@link ReceiptHandleIsInvalid} (client fault)
|
|
68
74
|
* <p>The specified receipt handle isn't valid.</p>
|
|
69
75
|
*
|
|
76
|
+
* @throws {@link RequestThrottled} (client fault)
|
|
77
|
+
* <p>The request was denied due to request throttling.</p>
|
|
78
|
+
* <ul>
|
|
79
|
+
* <li>
|
|
80
|
+
* <p>The rate of requests per second exceeds the AWS KMS request quota for an
|
|
81
|
+
* account and Region. </p>
|
|
82
|
+
* </li>
|
|
83
|
+
* <li>
|
|
84
|
+
* <p>A burst or sustained high rate of requests to change the state of the same KMS
|
|
85
|
+
* key. This condition is often known as a "hot key."</p>
|
|
86
|
+
* </li>
|
|
87
|
+
* <li>
|
|
88
|
+
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
89
|
+
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
90
|
+
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
91
|
+
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
92
|
+
* </li>
|
|
93
|
+
* </ul>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link UnsupportedOperation} (client fault)
|
|
96
|
+
* <p>Error code 400. Unsupported operation.</p>
|
|
97
|
+
*
|
|
70
98
|
* @throws {@link SQSServiceException}
|
|
71
99
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
72
100
|
*
|
|
@@ -19,20 +19,25 @@ 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
|
|
22
|
+
* <p>Deletes the queue specified by the <code>QueueUrl</code>, regardless of the queue's
|
|
23
|
+
* contents.</p>
|
|
23
24
|
* <important>
|
|
24
|
-
* <p>Be careful with the <code>DeleteQueue</code> action: When you delete a queue, any
|
|
25
|
-
*
|
|
25
|
+
* <p>Be careful with the <code>DeleteQueue</code> action: When you delete a queue, any
|
|
26
|
+
* messages in the queue are no longer available. </p>
|
|
26
27
|
* </important>
|
|
27
|
-
* <p>When you delete a queue, the deletion process takes up to 60 seconds. Requests you
|
|
28
|
-
*
|
|
28
|
+
* <p>When you delete a queue, the deletion process takes up to 60 seconds. Requests you
|
|
29
|
+
* send involving that queue during the 60 seconds might succeed. For example, a
|
|
30
|
+
* <code>
|
|
29
31
|
* <a>SendMessage</a>
|
|
30
|
-
* </code> request might succeed, but after 60
|
|
31
|
-
*
|
|
32
|
+
* </code> request might succeed, but after 60
|
|
33
|
+
* seconds the queue and the message you sent no longer exist.</p>
|
|
34
|
+
* <p>When you delete a queue, you must wait at least 60 seconds before creating a queue
|
|
35
|
+
* with the same name.</p>
|
|
32
36
|
* <note>
|
|
33
37
|
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
34
38
|
* 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
|
|
35
|
-
* cross-account permissions to a role and a
|
|
39
|
+
* cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
40
|
+
* <p>The delete operation uses the HTTP <code>GET</code> verb.</p>
|
|
36
41
|
* </note>
|
|
37
42
|
* @example
|
|
38
43
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -55,6 +60,37 @@ export interface DeleteQueueCommandOutput extends __MetadataBearer {
|
|
|
55
60
|
* @see {@link DeleteQueueCommandOutput} for command's `response` shape.
|
|
56
61
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
57
62
|
*
|
|
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
|
+
*
|
|
58
94
|
* @throws {@link SQSServiceException}
|
|
59
95
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
60
96
|
*
|
|
@@ -32,7 +32,7 @@ export interface GetQueueAttributesCommandOutput extends GetQueueAttributesResul
|
|
|
32
32
|
* const input = { // GetQueueAttributesRequest
|
|
33
33
|
* QueueUrl: "STRING_VALUE", // required
|
|
34
34
|
* AttributeNames: [ // AttributeNameList
|
|
35
|
-
* "
|
|
35
|
+
* "All" || "Policy" || "VisibilityTimeout" || "MaximumMessageSize" || "MessageRetentionPeriod" || "ApproximateNumberOfMessages" || "ApproximateNumberOfMessagesNotVisible" || "CreatedTimestamp" || "LastModifiedTimestamp" || "QueueArn" || "ApproximateNumberOfMessagesDelayed" || "DelaySeconds" || "ReceiveMessageWaitTimeSeconds" || "RedrivePolicy" || "FifoQueue" || "ContentBasedDeduplication" || "KmsMasterKeyId" || "KmsDataKeyReusePeriodSeconds" || "DeduplicationScope" || "FifoThroughputLimit" || "RedriveAllowPolicy" || "SqsManagedSseEnabled",
|
|
36
36
|
* ],
|
|
37
37
|
* };
|
|
38
38
|
* const command = new GetQueueAttributesCommand(input);
|
|
@@ -54,6 +54,34 @@ 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
|
+
*
|
|
57
85
|
* @throws {@link SQSServiceException}
|
|
58
86
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
59
87
|
*
|
|
@@ -20,11 +20,14 @@ 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
|
-
*
|
|
23
|
+
* <p>To access a queue that belongs to another AWS account, use the
|
|
24
|
+
* <code>QueueOwnerAWSAccountId</code> parameter to specify the account ID of the
|
|
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>
|
|
25
27
|
* <a>AddPermission</a>
|
|
26
|
-
* </code>
|
|
27
|
-
*
|
|
28
|
+
* </code>
|
|
29
|
+
* 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
|
|
30
|
+
* Developer Guide</i>. </p>
|
|
28
31
|
* @example
|
|
29
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
33
|
* ```javascript
|
|
@@ -49,9 +52,37 @@ export interface GetQueueUrlCommandOutput extends GetQueueUrlResult, __MetadataB
|
|
|
49
52
|
* @see {@link GetQueueUrlCommandOutput} for command's `response` shape.
|
|
50
53
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
51
54
|
*
|
|
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
|
+
*
|
|
52
61
|
* @throws {@link QueueDoesNotExist} (client fault)
|
|
53
62
|
* <p>The specified queue doesn't exist.</p>
|
|
54
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
|
+
*
|
|
55
86
|
* @throws {@link SQSServiceException}
|
|
56
87
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
57
88
|
*
|
|
@@ -19,17 +19,17 @@ 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
|
-
* <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>
|
|
32
|
-
*
|
|
22
|
+
* <p>Returns a list of your queues that have the <code>RedrivePolicy</code> queue attribute
|
|
23
|
+
* configured with a dead-letter queue.</p>
|
|
24
|
+
* <p> The <code>ListDeadLetterSourceQueues</code> methods supports pagination. Set
|
|
25
|
+
* 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>, the
|
|
27
|
+
* response includes a maximum of 1,000 results. If you set <code>MaxResults</code> and
|
|
28
|
+
* there are additional results to display, the response includes a value for
|
|
29
|
+
* <code>NextToken</code>. Use <code>NextToken</code> as a parameter in your next
|
|
30
|
+
* request to <code>ListDeadLetterSourceQueues</code> to receive the next page of results. </p>
|
|
31
|
+
* <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
|
|
32
|
+
* Guide</i>.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -58,9 +58,37 @@ export interface ListDeadLetterSourceQueuesCommandOutput extends ListDeadLetterS
|
|
|
58
58
|
* @see {@link ListDeadLetterSourceQueuesCommandOutput} for command's `response` shape.
|
|
59
59
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
60
60
|
*
|
|
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
|
+
*
|
|
61
67
|
* @throws {@link QueueDoesNotExist} (client fault)
|
|
62
68
|
* <p>The specified queue doesn't exist.</p>
|
|
63
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
|
+
*
|
|
64
92
|
* @throws {@link SQSServiceException}
|
|
65
93
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
66
94
|
*
|
|
@@ -19,13 +19,14 @@ 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.
|
|
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
|
|
23
24
|
* Your Amazon SQS Queues</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
24
|
-
*
|
|
25
|
+
* <note>
|
|
25
26
|
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
26
27
|
* 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
|
|
27
|
-
* cross-account permissions to a role and a
|
|
28
|
-
*
|
|
28
|
+
* cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
29
|
+
* </note>
|
|
29
30
|
* @example
|
|
30
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
32
|
* ```javascript
|
|
@@ -51,6 +52,37 @@ export interface ListQueueTagsCommandOutput extends ListQueueTagsResult, __Metad
|
|
|
51
52
|
* @see {@link ListQueueTagsCommandOutput} for command's `response` shape.
|
|
52
53
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
53
54
|
*
|
|
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
|
+
*
|
|
54
86
|
* @throws {@link SQSServiceException}
|
|
55
87
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
56
88
|
*
|
|
@@ -19,19 +19,21 @@ 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
|
-
*
|
|
22
|
+
* <p>Returns a list of your queues in the current region. The response includes a maximum
|
|
23
|
+
* of 1,000 results. If you specify a value for the optional <code>QueueNamePrefix</code>
|
|
24
|
+
* parameter, only queues with a name that begins with the specified value are
|
|
25
|
+
* returned.</p>
|
|
26
|
+
* <p> The <code>listQueues</code> methods supports pagination. Set parameter
|
|
27
|
+
* <code>MaxResults</code> in the request to specify the maximum number of results to
|
|
28
|
+
* be returned in the response. If you do not set <code>MaxResults</code>, the response
|
|
29
|
+
* includes a maximum of 1,000 results. If you set <code>MaxResults</code> and there are
|
|
30
|
+
* additional results to display, the response includes a value for <code>NextToken</code>.
|
|
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>
|
|
31
33
|
* <note>
|
|
32
34
|
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
33
35
|
* 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
|
|
34
|
-
* cross-account permissions to a role and a
|
|
36
|
+
* cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
35
37
|
* </note>
|
|
36
38
|
* @example
|
|
37
39
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -47,10 +49,10 @@ export interface ListQueuesCommandOutput extends ListQueuesResult, __MetadataBea
|
|
|
47
49
|
* const command = new ListQueuesCommand(input);
|
|
48
50
|
* const response = await client.send(command);
|
|
49
51
|
* // { // ListQueuesResult
|
|
50
|
-
* // NextToken: "STRING_VALUE",
|
|
51
52
|
* // QueueUrls: [ // QueueUrlList
|
|
52
53
|
* // "STRING_VALUE",
|
|
53
54
|
* // ],
|
|
55
|
+
* // NextToken: "STRING_VALUE",
|
|
54
56
|
* // };
|
|
55
57
|
*
|
|
56
58
|
* ```
|
|
@@ -61,6 +63,34 @@ export interface ListQueuesCommandOutput extends ListQueuesResult, __MetadataBea
|
|
|
61
63
|
* @see {@link ListQueuesCommandOutput} for command's `response` shape.
|
|
62
64
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
63
65
|
*
|
|
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
|
+
*
|
|
64
94
|
* @throws {@link SQSServiceException}
|
|
65
95
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
66
96
|
*
|
|
@@ -21,18 +21,17 @@ export interface PurgeQueueCommandOutput extends __MetadataBearer {
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Deletes the messages in a queue specified by the <code>QueueURL</code>
|
|
23
23
|
* parameter.</p>
|
|
24
|
-
*
|
|
25
24
|
* <important>
|
|
26
25
|
* <p>When you use the <code>PurgeQueue</code> action, you can't retrieve any messages
|
|
27
26
|
* deleted from a queue.</p>
|
|
28
|
-
* <p>The message deletion process takes up to 60 seconds. We recommend waiting for
|
|
29
|
-
*
|
|
27
|
+
* <p>The message deletion process takes up to 60 seconds. We recommend waiting for 60
|
|
28
|
+
* seconds regardless of your queue's size. </p>
|
|
30
29
|
* </important>
|
|
31
|
-
*
|
|
30
|
+
* <p>Messages sent to the queue <i>before</i> you call
|
|
32
31
|
* <code>PurgeQueue</code> might be received but are deleted within the next
|
|
33
32
|
* minute.</p>
|
|
34
|
-
*
|
|
35
|
-
*
|
|
33
|
+
* <p>Messages sent to the queue <i>after</i> you call <code>PurgeQueue</code>
|
|
34
|
+
* might be deleted while the queue is being purged.</p>
|
|
36
35
|
* @example
|
|
37
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
37
|
* ```javascript
|
|
@@ -54,12 +53,42 @@ export interface PurgeQueueCommandOutput extends __MetadataBearer {
|
|
|
54
53
|
* @see {@link PurgeQueueCommandOutput} for command's `response` shape.
|
|
55
54
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
56
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
|
+
*
|
|
57
62
|
* @throws {@link PurgeQueueInProgress} (client fault)
|
|
58
|
-
* <p>Indicates that the specified queue previously received a <code>PurgeQueue</code>
|
|
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>
|
|
59
66
|
*
|
|
60
67
|
* @throws {@link QueueDoesNotExist} (client fault)
|
|
61
68
|
* <p>The specified queue doesn't exist.</p>
|
|
62
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
|
+
*
|
|
63
92
|
* @throws {@link SQSServiceException}
|
|
64
93
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
65
94
|
*
|