@aws-sdk/client-sqs 3.325.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 +55 -26
- package/dist-types/commands/ChangeMessageVisibilityBatchCommand.d.ts +52 -12
- package/dist-types/commands/ChangeMessageVisibilityCommand.d.ts +52 -15
- package/dist-types/commands/CreateQueueCommand.d.ts +64 -24
- package/dist-types/commands/DeleteMessageBatchCommand.d.ts +49 -10
- package/dist-types/commands/DeleteMessageCommand.d.ts +33 -1
- package/dist-types/commands/DeleteQueueCommand.d.ts +48 -8
- package/dist-types/commands/GetQueueAttributesCommand.d.ts +37 -1
- package/dist-types/commands/GetQueueUrlCommand.d.ts +41 -4
- package/dist-types/commands/ListDeadLetterSourceQueuesCommand.d.ts +48 -11
- package/dist-types/commands/ListQueueTagsCommand.d.ts +44 -4
- package/dist-types/commands/ListQueuesCommand.d.ts +49 -10
- package/dist-types/commands/PurgeQueueCommand.d.ts +40 -7
- package/dist-types/commands/ReceiveMessageCommand.d.ts +118 -15
- package/dist-types/commands/RemovePermissionCommand.d.ts +41 -5
- package/dist-types/commands/SendMessageBatchCommand.d.ts +99 -16
- package/dist-types/commands/SendMessageCommand.d.ts +72 -3
- package/dist-types/commands/SetQueueAttributesCommand.d.ts +54 -6
- package/dist-types/commands/TagQueueCommand.d.ts +38 -4
- package/dist-types/commands/UntagQueueCommand.d.ts +38 -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 +8 -9
- 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,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
|
|
@@ -37,6 +38,12 @@ export interface ListQueueTagsCommandOutput extends ListQueueTagsResult, __Metad
|
|
|
37
38
|
* };
|
|
38
39
|
* const command = new ListQueueTagsCommand(input);
|
|
39
40
|
* const response = await client.send(command);
|
|
41
|
+
* // { // ListQueueTagsResult
|
|
42
|
+
* // Tags: { // TagMap
|
|
43
|
+
* // "<keys>": "STRING_VALUE",
|
|
44
|
+
* // },
|
|
45
|
+
* // };
|
|
46
|
+
*
|
|
40
47
|
* ```
|
|
41
48
|
*
|
|
42
49
|
* @param ListQueueTagsCommandInput - {@link ListQueueTagsCommandInput}
|
|
@@ -45,6 +52,39 @@ export interface ListQueueTagsCommandOutput extends ListQueueTagsResult, __Metad
|
|
|
45
52
|
* @see {@link ListQueueTagsCommandOutput} for command's `response` shape.
|
|
46
53
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
47
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
|
+
*
|
|
86
|
+
* @throws {@link SQSServiceException}
|
|
87
|
+
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
48
88
|
*
|
|
49
89
|
*/
|
|
50
90
|
export declare class ListQueueTagsCommand extends $Command<ListQueueTagsCommandInput, ListQueueTagsCommandOutput, SQSClientResolvedConfig> {
|
|
@@ -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.
|
|
@@ -46,6 +48,13 @@ export interface ListQueuesCommandOutput extends ListQueuesResult, __MetadataBea
|
|
|
46
48
|
* };
|
|
47
49
|
* const command = new ListQueuesCommand(input);
|
|
48
50
|
* const response = await client.send(command);
|
|
51
|
+
* // { // ListQueuesResult
|
|
52
|
+
* // QueueUrls: [ // QueueUrlList
|
|
53
|
+
* // "STRING_VALUE",
|
|
54
|
+
* // ],
|
|
55
|
+
* // NextToken: "STRING_VALUE",
|
|
56
|
+
* // };
|
|
57
|
+
*
|
|
49
58
|
* ```
|
|
50
59
|
*
|
|
51
60
|
* @param ListQueuesCommandInput - {@link ListQueuesCommandInput}
|
|
@@ -54,6 +63,36 @@ export interface ListQueuesCommandOutput extends ListQueuesResult, __MetadataBea
|
|
|
54
63
|
* @see {@link ListQueuesCommandOutput} for command's `response` shape.
|
|
55
64
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
56
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
|
+
*
|
|
94
|
+
* @throws {@link SQSServiceException}
|
|
95
|
+
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
57
96
|
*
|
|
58
97
|
*/
|
|
59
98
|
export declare class ListQueuesCommand extends $Command<ListQueuesCommandInput, ListQueuesCommandOutput, SQSClientResolvedConfig> {
|
|
@@ -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
|
|
@@ -44,6 +43,8 @@ export interface PurgeQueueCommandOutput extends __MetadataBearer {
|
|
|
44
43
|
* };
|
|
45
44
|
* const command = new PurgeQueueCommand(input);
|
|
46
45
|
* const response = await client.send(command);
|
|
46
|
+
* // {};
|
|
47
|
+
*
|
|
47
48
|
* ```
|
|
48
49
|
*
|
|
49
50
|
* @param PurgeQueueCommandInput - {@link PurgeQueueCommandInput}
|
|
@@ -52,12 +53,44 @@ export interface PurgeQueueCommandOutput extends __MetadataBearer {
|
|
|
52
53
|
* @see {@link PurgeQueueCommandOutput} for command's `response` shape.
|
|
53
54
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
54
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
|
+
*
|
|
55
62
|
* @throws {@link PurgeQueueInProgress} (client fault)
|
|
56
|
-
* <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>
|
|
57
66
|
*
|
|
58
67
|
* @throws {@link QueueDoesNotExist} (client fault)
|
|
59
68
|
* <p>The specified queue doesn't exist.</p>
|
|
60
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
|
+
* @throws {@link SQSServiceException}
|
|
93
|
+
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
61
94
|
*
|
|
62
95
|
*/
|
|
63
96
|
export declare class PurgeQueueCommand extends $Command<PurgeQueueCommandInput, PurgeQueueCommandOutput, SQSClientResolvedConfig> {
|
|
@@ -19,13 +19,17 @@ 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
|
-
*
|
|
22
|
+
* <p>Retrieves one or more messages (up to 10), from the specified queue. Using the
|
|
23
|
+
* <code>WaitTimeSeconds</code> parameter enables long-poll support. For more
|
|
24
|
+
* information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html">Amazon SQS
|
|
25
|
+
* Long Polling</a> in the <i>Amazon SQS Developer Guide</i>. </p>
|
|
26
|
+
* <p>Short poll is the default behavior where a weighted random set of machines is sampled
|
|
27
|
+
* on a <code>ReceiveMessage</code> call. Thus, only the messages on the sampled machines
|
|
28
|
+
* are returned. If the number of messages in the queue is small (fewer than 1,000), you
|
|
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>
|
|
29
33
|
* <p>For each message returned, the response includes the following:</p>
|
|
30
34
|
* <ul>
|
|
31
35
|
* <li>
|
|
@@ -35,7 +39,8 @@ export interface ReceiveMessageCommandOutput extends ReceiveMessageResult, __Met
|
|
|
35
39
|
* <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>
|
|
36
40
|
* </li>
|
|
37
41
|
* <li>
|
|
38
|
-
* <p>The <code>MessageId</code> you received when you sent the message to the
|
|
42
|
+
* <p>The <code>MessageId</code> you received when you sent the message to the
|
|
43
|
+
* queue.</p>
|
|
39
44
|
* </li>
|
|
40
45
|
* <li>
|
|
41
46
|
* <p>The receipt handle.</p>
|
|
@@ -47,11 +52,17 @@ export interface ReceiveMessageCommandOutput extends ReceiveMessageResult, __Met
|
|
|
47
52
|
* <p>An MD5 digest of the message attributes.</p>
|
|
48
53
|
* </li>
|
|
49
54
|
* </ul>
|
|
50
|
-
* <p>The receipt handle is the identifier you must provide when deleting the message. For
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
+
* <p>The receipt handle is the identifier you must provide when deleting the message. For
|
|
56
|
+
* more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html">Queue and Message Identifiers</a> in the <i>Amazon SQS Developer
|
|
57
|
+
* Guide</i>.</p>
|
|
58
|
+
* <p>You can provide the <code>VisibilityTimeout</code> parameter in your request. The
|
|
59
|
+
* parameter is applied to the messages that Amazon SQS returns in the response. If you don't
|
|
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>
|
|
55
66
|
* <note>
|
|
56
67
|
* <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>
|
|
57
68
|
* </note>
|
|
@@ -64,7 +75,7 @@ export interface ReceiveMessageCommandOutput extends ReceiveMessageResult, __Met
|
|
|
64
75
|
* const input = { // ReceiveMessageRequest
|
|
65
76
|
* QueueUrl: "STRING_VALUE", // required
|
|
66
77
|
* AttributeNames: [ // AttributeNameList
|
|
67
|
-
* "
|
|
78
|
+
* "All" || "Policy" || "VisibilityTimeout" || "MaximumMessageSize" || "MessageRetentionPeriod" || "ApproximateNumberOfMessages" || "ApproximateNumberOfMessagesNotVisible" || "CreatedTimestamp" || "LastModifiedTimestamp" || "QueueArn" || "ApproximateNumberOfMessagesDelayed" || "DelaySeconds" || "ReceiveMessageWaitTimeSeconds" || "RedrivePolicy" || "FifoQueue" || "ContentBasedDeduplication" || "KmsMasterKeyId" || "KmsDataKeyReusePeriodSeconds" || "DeduplicationScope" || "FifoThroughputLimit" || "RedriveAllowPolicy" || "SqsManagedSseEnabled",
|
|
68
79
|
* ],
|
|
69
80
|
* MessageAttributeNames: [ // MessageAttributeNameList
|
|
70
81
|
* "STRING_VALUE",
|
|
@@ -76,6 +87,34 @@ export interface ReceiveMessageCommandOutput extends ReceiveMessageResult, __Met
|
|
|
76
87
|
* };
|
|
77
88
|
* const command = new ReceiveMessageCommand(input);
|
|
78
89
|
* const response = await client.send(command);
|
|
90
|
+
* // { // ReceiveMessageResult
|
|
91
|
+
* // Messages: [ // MessageList
|
|
92
|
+
* // { // Message
|
|
93
|
+
* // MessageId: "STRING_VALUE",
|
|
94
|
+
* // ReceiptHandle: "STRING_VALUE",
|
|
95
|
+
* // MD5OfBody: "STRING_VALUE",
|
|
96
|
+
* // Body: "STRING_VALUE",
|
|
97
|
+
* // Attributes: { // MessageSystemAttributeMap
|
|
98
|
+
* // "<keys>": "STRING_VALUE",
|
|
99
|
+
* // },
|
|
100
|
+
* // MD5OfMessageAttributes: "STRING_VALUE",
|
|
101
|
+
* // MessageAttributes: { // MessageBodyAttributeMap
|
|
102
|
+
* // "<keys>": { // MessageAttributeValue
|
|
103
|
+
* // StringValue: "STRING_VALUE",
|
|
104
|
+
* // BinaryValue: "BLOB_VALUE",
|
|
105
|
+
* // StringListValues: [ // StringList
|
|
106
|
+
* // "STRING_VALUE",
|
|
107
|
+
* // ],
|
|
108
|
+
* // BinaryListValues: [ // BinaryList
|
|
109
|
+
* // "BLOB_VALUE",
|
|
110
|
+
* // ],
|
|
111
|
+
* // DataType: "STRING_VALUE", // required
|
|
112
|
+
* // },
|
|
113
|
+
* // },
|
|
114
|
+
* // },
|
|
115
|
+
* // ],
|
|
116
|
+
* // };
|
|
117
|
+
*
|
|
79
118
|
* ```
|
|
80
119
|
*
|
|
81
120
|
* @param ReceiveMessageCommandInput - {@link ReceiveMessageCommandInput}
|
|
@@ -84,12 +123,76 @@ export interface ReceiveMessageCommandOutput extends ReceiveMessageResult, __Met
|
|
|
84
123
|
* @see {@link ReceiveMessageCommandOutput} for command's `response` shape.
|
|
85
124
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
86
125
|
*
|
|
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
|
+
*
|
|
87
163
|
* @throws {@link OverLimit} (client fault)
|
|
88
164
|
* <p>The specified action violates a limit. For example, <code>ReceiveMessage</code>
|
|
89
|
-
* returns this error if the maximum number of
|
|
165
|
+
* returns this error if the maximum number of in flight messages is reached and
|
|
90
166
|
* <code>AddPermission</code> returns this error if the maximum number of permissions
|
|
91
167
|
* for the queue is reached.</p>
|
|
92
168
|
*
|
|
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
|
+
* @throws {@link SQSServiceException}
|
|
195
|
+
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
93
196
|
*
|
|
94
197
|
*/
|
|
95
198
|
export declare class ReceiveMessageCommand extends $Command<ReceiveMessageCommandInput, ReceiveMessageCommandOutput, SQSClientResolvedConfig> {
|
|
@@ -19,20 +19,21 @@ 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
|
|
22
|
+
* <p>Revokes any permissions in the queue policy that matches the specified
|
|
23
|
+
* <code>Label</code> parameter.</p>
|
|
23
24
|
* <note>
|
|
24
25
|
* <ul>
|
|
25
26
|
* <li>
|
|
26
27
|
* <p>Only the owner of a queue can remove permissions from it.</p>
|
|
27
|
-
*
|
|
28
|
+
* </li>
|
|
28
29
|
* <li>
|
|
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
|
|
32
|
-
*
|
|
32
|
+
* cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
33
|
+
* </li>
|
|
33
34
|
* <li>
|
|
34
35
|
* <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>
|
|
35
|
-
*
|
|
36
|
+
* </li>
|
|
36
37
|
* </ul>
|
|
37
38
|
* </note>
|
|
38
39
|
* @example
|
|
@@ -47,6 +48,8 @@ export interface RemovePermissionCommandOutput extends __MetadataBearer {
|
|
|
47
48
|
* };
|
|
48
49
|
* const command = new RemovePermissionCommand(input);
|
|
49
50
|
* const response = await client.send(command);
|
|
51
|
+
* // {};
|
|
52
|
+
*
|
|
50
53
|
* ```
|
|
51
54
|
*
|
|
52
55
|
* @param RemovePermissionCommandInput - {@link RemovePermissionCommandInput}
|
|
@@ -55,6 +58,39 @@ export interface RemovePermissionCommandOutput extends __MetadataBearer {
|
|
|
55
58
|
* @see {@link RemovePermissionCommandOutput} for command's `response` shape.
|
|
56
59
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
57
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
|
+
*
|
|
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
|
+
* @throws {@link SQSServiceException}
|
|
93
|
+
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
58
94
|
*
|
|
59
95
|
*/
|
|
60
96
|
export declare class RemovePermissionCommand extends $Command<RemovePermissionCommandInput, RemovePermissionCommandOutput, SQSClientResolvedConfig> {
|
|
@@ -19,25 +19,25 @@ export interface SendMessageBatchCommandOutput extends SendMessageBatchResult, _
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
22
|
+
* <p>You can use <code>SendMessageBatch</code> to send up to 10 messages to the specified
|
|
23
|
+
* queue by assigning either identical or different values to each message (or by not
|
|
24
|
+
* assigning values at all). This is a batch version of <code>
|
|
25
|
+
* <a>SendMessage</a>.</code> For a FIFO queue, multiple messages within a single batch are enqueued
|
|
26
|
+
* in the order they are sent.</p>
|
|
27
|
+
* <p>The result of sending each message is reported individually in the response.
|
|
28
|
+
* 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>
|
|
29
|
+
* <p>The maximum allowed individual message size and the maximum total payload size (the
|
|
30
|
+
* sum of the individual lengths of all of the batched messages) are both 256 KiB (262,144
|
|
31
|
+
* bytes).</p>
|
|
26
32
|
* <important>
|
|
27
|
-
*
|
|
28
|
-
*
|
|
33
|
+
* <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:</p>
|
|
34
|
+
* <p>
|
|
29
35
|
* <code>#x9</code> | <code>#xA</code> | <code>#xD</code> | <code>#x20</code> to <code>#xD7FF</code> | <code>#xE000</code> to <code>#xFFFD</code> | <code>#x10000</code> to <code>#x10FFFF</code>
|
|
30
36
|
* </p>
|
|
31
|
-
*
|
|
37
|
+
* <p>Any characters not included in this list will be rejected. For more information, see the <a href="http://www.w3.org/TR/REC-xml/#charsets">W3C specification for characters</a>.</p>
|
|
32
38
|
* </important>
|
|
33
|
-
* <p>If you don't specify the <code>DelaySeconds</code> parameter for an entry, Amazon SQS uses
|
|
34
|
-
*
|
|
35
|
-
* <p>
|
|
36
|
-
* <code>&AttributeName.1=first</code>
|
|
37
|
-
* </p>
|
|
38
|
-
* <p>
|
|
39
|
-
* <code>&AttributeName.2=second</code>
|
|
40
|
-
* </p>
|
|
39
|
+
* <p>If you don't specify the <code>DelaySeconds</code> parameter for an entry, Amazon SQS uses
|
|
40
|
+
* the default value for the queue.</p>
|
|
41
41
|
* @example
|
|
42
42
|
* Use a bare-bones client and the command you need to make an API call.
|
|
43
43
|
* ```javascript
|
|
@@ -84,6 +84,27 @@ export interface SendMessageBatchCommandOutput extends SendMessageBatchResult, _
|
|
|
84
84
|
* };
|
|
85
85
|
* const command = new SendMessageBatchCommand(input);
|
|
86
86
|
* const response = await client.send(command);
|
|
87
|
+
* // { // SendMessageBatchResult
|
|
88
|
+
* // Successful: [ // SendMessageBatchResultEntryList // required
|
|
89
|
+
* // { // SendMessageBatchResultEntry
|
|
90
|
+
* // Id: "STRING_VALUE", // required
|
|
91
|
+
* // MessageId: "STRING_VALUE", // required
|
|
92
|
+
* // MD5OfMessageBody: "STRING_VALUE", // required
|
|
93
|
+
* // MD5OfMessageAttributes: "STRING_VALUE",
|
|
94
|
+
* // MD5OfMessageSystemAttributes: "STRING_VALUE",
|
|
95
|
+
* // SequenceNumber: "STRING_VALUE",
|
|
96
|
+
* // },
|
|
97
|
+
* // ],
|
|
98
|
+
* // Failed: [ // BatchResultErrorEntryList // required
|
|
99
|
+
* // { // BatchResultErrorEntry
|
|
100
|
+
* // Id: "STRING_VALUE", // required
|
|
101
|
+
* // SenderFault: true || false, // required
|
|
102
|
+
* // Code: "STRING_VALUE", // required
|
|
103
|
+
* // Message: "STRING_VALUE",
|
|
104
|
+
* // },
|
|
105
|
+
* // ],
|
|
106
|
+
* // };
|
|
107
|
+
*
|
|
87
108
|
* ```
|
|
88
109
|
*
|
|
89
110
|
* @param SendMessageBatchCommandInput - {@link SendMessageBatchCommandInput}
|
|
@@ -102,7 +123,67 @@ export interface SendMessageBatchCommandOutput extends SendMessageBatchResult, _
|
|
|
102
123
|
* <p>The batch request doesn't contain any entries.</p>
|
|
103
124
|
*
|
|
104
125
|
* @throws {@link InvalidBatchEntryId} (client fault)
|
|
105
|
-
* <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the
|
|
126
|
+
* <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the
|
|
127
|
+
* specification.</p>
|
|
128
|
+
*
|
|
129
|
+
* @throws {@link InvalidSecurity} (client fault)
|
|
130
|
+
* <p>When the request to a queue is not HTTPS and SigV4.</p>
|
|
131
|
+
*
|
|
132
|
+
* @throws {@link KmsAccessDenied} (client fault)
|
|
133
|
+
* <p>The caller doesn't have the required KMS access.</p>
|
|
134
|
+
*
|
|
135
|
+
* @throws {@link KmsDisabled} (client fault)
|
|
136
|
+
* <p>The request was denied due to request throttling.</p>
|
|
137
|
+
*
|
|
138
|
+
* @throws {@link KmsInvalidKeyUsage} (client fault)
|
|
139
|
+
* <p>The request was rejected for one of the following reasons:</p>
|
|
140
|
+
* <ul>
|
|
141
|
+
* <li>
|
|
142
|
+
* <p>The KeyUsage value of the KMS key is incompatible with the API
|
|
143
|
+
* operation.</p>
|
|
144
|
+
* </li>
|
|
145
|
+
* <li>
|
|
146
|
+
* <p>The encryption algorithm or signing algorithm specified for the operation is
|
|
147
|
+
* incompatible with the type of key material in the KMS key (KeySpec).</p>
|
|
148
|
+
* </li>
|
|
149
|
+
* </ul>
|
|
150
|
+
*
|
|
151
|
+
* @throws {@link KmsInvalidState} (client fault)
|
|
152
|
+
* <p>The request was rejected because the state of the specified resource is not valid for
|
|
153
|
+
* this request.</p>
|
|
154
|
+
*
|
|
155
|
+
* @throws {@link KmsNotFound} (client fault)
|
|
156
|
+
* <p>The request was rejected because the specified entity or resource could not be found.
|
|
157
|
+
* </p>
|
|
158
|
+
*
|
|
159
|
+
* @throws {@link KmsOptInRequired} (client fault)
|
|
160
|
+
* <p>The request was rejected because the specified key policy isn't syntactically or
|
|
161
|
+
* semantically correct.</p>
|
|
162
|
+
*
|
|
163
|
+
* @throws {@link KmsThrottled} (client fault)
|
|
164
|
+
* <p>Amazon Web Services KMS throttles requests for the following conditions.</p>
|
|
165
|
+
*
|
|
166
|
+
* @throws {@link QueueDoesNotExist} (client fault)
|
|
167
|
+
* <p>The specified queue doesn't exist.</p>
|
|
168
|
+
*
|
|
169
|
+
* @throws {@link RequestThrottled} (client fault)
|
|
170
|
+
* <p>The request was denied due to request throttling.</p>
|
|
171
|
+
* <ul>
|
|
172
|
+
* <li>
|
|
173
|
+
* <p>The rate of requests per second exceeds the AWS KMS request quota for an
|
|
174
|
+
* account and Region. </p>
|
|
175
|
+
* </li>
|
|
176
|
+
* <li>
|
|
177
|
+
* <p>A burst or sustained high rate of requests to change the state of the same KMS
|
|
178
|
+
* key. This condition is often known as a "hot key."</p>
|
|
179
|
+
* </li>
|
|
180
|
+
* <li>
|
|
181
|
+
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
182
|
+
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
183
|
+
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
184
|
+
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
185
|
+
* </li>
|
|
186
|
+
* </ul>
|
|
106
187
|
*
|
|
107
188
|
* @throws {@link TooManyEntriesInBatchRequest} (client fault)
|
|
108
189
|
* <p>The batch request contains more entries than permissible.</p>
|
|
@@ -110,6 +191,8 @@ export interface SendMessageBatchCommandOutput extends SendMessageBatchResult, _
|
|
|
110
191
|
* @throws {@link UnsupportedOperation} (client fault)
|
|
111
192
|
* <p>Error code 400. Unsupported operation.</p>
|
|
112
193
|
*
|
|
194
|
+
* @throws {@link SQSServiceException}
|
|
195
|
+
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
113
196
|
*
|
|
114
197
|
*/
|
|
115
198
|
export declare class SendMessageBatchCommand extends $Command<SendMessageBatchCommandInput, SendMessageBatchCommandOutput, SQSClientResolvedConfig> {
|