@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,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",
|
|
@@ -112,12 +123,74 @@ export interface ReceiveMessageCommandOutput extends ReceiveMessageResult, __Met
|
|
|
112
123
|
* @see {@link ReceiveMessageCommandOutput} for command's `response` shape.
|
|
113
124
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
114
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
|
+
*
|
|
115
163
|
* @throws {@link OverLimit} (client fault)
|
|
116
164
|
* <p>The specified action violates a limit. For example, <code>ReceiveMessage</code>
|
|
117
|
-
* returns this error if the maximum number of
|
|
165
|
+
* returns this error if the maximum number of in flight messages is reached and
|
|
118
166
|
* <code>AddPermission</code> returns this error if the maximum number of permissions
|
|
119
167
|
* for the queue is reached.</p>
|
|
120
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
|
+
*
|
|
121
194
|
* @throws {@link SQSServiceException}
|
|
122
195
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
123
196
|
*
|
|
@@ -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
|
|
@@ -57,6 +58,37 @@ export interface RemovePermissionCommandOutput extends __MetadataBearer {
|
|
|
57
58
|
* @see {@link RemovePermissionCommandOutput} for command's `response` shape.
|
|
58
59
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
59
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
|
+
*
|
|
60
92
|
* @throws {@link SQSServiceException}
|
|
61
93
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
62
94
|
*
|
|
@@ -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
|
|
@@ -123,7 +123,67 @@ export interface SendMessageBatchCommandOutput extends SendMessageBatchResult, _
|
|
|
123
123
|
* <p>The batch request doesn't contain any entries.</p>
|
|
124
124
|
*
|
|
125
125
|
* @throws {@link InvalidBatchEntryId} (client fault)
|
|
126
|
-
* <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>
|
|
127
187
|
*
|
|
128
188
|
* @throws {@link TooManyEntriesInBatchRequest} (client fault)
|
|
129
189
|
* <p>The batch request contains more entries than permissible.</p>
|
|
@@ -21,11 +21,11 @@ export interface SendMessageCommandOutput extends SendMessageResult, __MetadataB
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Delivers a message to the specified queue.</p>
|
|
23
23
|
* <important>
|
|
24
|
-
*
|
|
25
|
-
*
|
|
24
|
+
* <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:</p>
|
|
25
|
+
* <p>
|
|
26
26
|
* <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>
|
|
27
27
|
* </p>
|
|
28
|
-
*
|
|
28
|
+
* <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>
|
|
29
29
|
* </important>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -87,6 +87,65 @@ export interface SendMessageCommandOutput extends SendMessageResult, __MetadataB
|
|
|
87
87
|
* @throws {@link InvalidMessageContents} (client fault)
|
|
88
88
|
* <p>The message contains characters outside the allowed set.</p>
|
|
89
89
|
*
|
|
90
|
+
* @throws {@link InvalidSecurity} (client fault)
|
|
91
|
+
* <p>When the request to a queue is not HTTPS and SigV4.</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link KmsAccessDenied} (client fault)
|
|
94
|
+
* <p>The caller doesn't have the required KMS access.</p>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link KmsDisabled} (client fault)
|
|
97
|
+
* <p>The request was denied due to request throttling.</p>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link KmsInvalidKeyUsage} (client fault)
|
|
100
|
+
* <p>The request was rejected for one of the following reasons:</p>
|
|
101
|
+
* <ul>
|
|
102
|
+
* <li>
|
|
103
|
+
* <p>The KeyUsage value of the KMS key is incompatible with the API
|
|
104
|
+
* operation.</p>
|
|
105
|
+
* </li>
|
|
106
|
+
* <li>
|
|
107
|
+
* <p>The encryption algorithm or signing algorithm specified for the operation is
|
|
108
|
+
* incompatible with the type of key material in the KMS key (KeySpec).</p>
|
|
109
|
+
* </li>
|
|
110
|
+
* </ul>
|
|
111
|
+
*
|
|
112
|
+
* @throws {@link KmsInvalidState} (client fault)
|
|
113
|
+
* <p>The request was rejected because the state of the specified resource is not valid for
|
|
114
|
+
* this request.</p>
|
|
115
|
+
*
|
|
116
|
+
* @throws {@link KmsNotFound} (client fault)
|
|
117
|
+
* <p>The request was rejected because the specified entity or resource could not be found.
|
|
118
|
+
* </p>
|
|
119
|
+
*
|
|
120
|
+
* @throws {@link KmsOptInRequired} (client fault)
|
|
121
|
+
* <p>The request was rejected because the specified key policy isn't syntactically or
|
|
122
|
+
* semantically correct.</p>
|
|
123
|
+
*
|
|
124
|
+
* @throws {@link KmsThrottled} (client fault)
|
|
125
|
+
* <p>Amazon Web Services KMS throttles requests for the following conditions.</p>
|
|
126
|
+
*
|
|
127
|
+
* @throws {@link QueueDoesNotExist} (client fault)
|
|
128
|
+
* <p>The specified queue doesn't exist.</p>
|
|
129
|
+
*
|
|
130
|
+
* @throws {@link RequestThrottled} (client fault)
|
|
131
|
+
* <p>The request was denied due to request throttling.</p>
|
|
132
|
+
* <ul>
|
|
133
|
+
* <li>
|
|
134
|
+
* <p>The rate of requests per second exceeds the AWS KMS request quota for an
|
|
135
|
+
* account and Region. </p>
|
|
136
|
+
* </li>
|
|
137
|
+
* <li>
|
|
138
|
+
* <p>A burst or sustained high rate of requests to change the state of the same KMS
|
|
139
|
+
* key. This condition is often known as a "hot key."</p>
|
|
140
|
+
* </li>
|
|
141
|
+
* <li>
|
|
142
|
+
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
143
|
+
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
144
|
+
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
145
|
+
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
146
|
+
* </li>
|
|
147
|
+
* </ul>
|
|
148
|
+
*
|
|
90
149
|
* @throws {@link UnsupportedOperation} (client fault)
|
|
91
150
|
* <p>Error code 400. Unsupported operation.</p>
|
|
92
151
|
*
|
|
@@ -19,21 +19,25 @@ export interface SetQueueAttributesCommandOutput extends __MetadataBearer {
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Sets the value of one or more queue attributes. When you change a queue's attributes,
|
|
23
|
-
*
|
|
22
|
+
* <p>Sets the value of one or more queue attributes. When you change a queue's attributes,
|
|
23
|
+
* the change can take up to 60 seconds for most of the attributes to propagate throughout
|
|
24
|
+
* the Amazon SQS system. Changes made to the <code>MessageRetentionPeriod</code> attribute can
|
|
25
|
+
* take up to 15 minutes and will impact existing messages in the queue potentially causing
|
|
26
|
+
* them to be expired and deleted if the <code>MessageRetentionPeriod</code> is reduced
|
|
27
|
+
* below the age of existing messages.</p>
|
|
24
28
|
* <note>
|
|
25
29
|
* <ul>
|
|
26
30
|
* <li>
|
|
27
31
|
* <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>
|
|
28
|
-
*
|
|
32
|
+
* </li>
|
|
29
33
|
* <li>
|
|
30
34
|
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
31
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
|
|
32
|
-
* cross-account permissions to a role and a
|
|
33
|
-
*
|
|
36
|
+
* cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
37
|
+
* </li>
|
|
34
38
|
* <li>
|
|
35
39
|
* <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>
|
|
36
|
-
*
|
|
40
|
+
* </li>
|
|
37
41
|
* </ul>
|
|
38
42
|
* </note>
|
|
39
43
|
* @example
|
|
@@ -60,9 +64,49 @@ export interface SetQueueAttributesCommandOutput extends __MetadataBearer {
|
|
|
60
64
|
* @see {@link SetQueueAttributesCommandOutput} for command's `response` shape.
|
|
61
65
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
62
66
|
*
|
|
67
|
+
* @throws {@link InvalidAddress} (client fault)
|
|
68
|
+
* <p>The <code>accountId</code> is invalid.</p>
|
|
69
|
+
*
|
|
63
70
|
* @throws {@link InvalidAttributeName} (client fault)
|
|
64
71
|
* <p>The specified attribute doesn't exist.</p>
|
|
65
72
|
*
|
|
73
|
+
* @throws {@link InvalidAttributeValue} (client fault)
|
|
74
|
+
* <p>A queue attribute value is invalid.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link InvalidSecurity} (client fault)
|
|
77
|
+
* <p>When the request to a queue is not HTTPS and SigV4.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link OverLimit} (client fault)
|
|
80
|
+
* <p>The specified action violates a limit. For example, <code>ReceiveMessage</code>
|
|
81
|
+
* returns this error if the maximum number of in flight messages is reached and
|
|
82
|
+
* <code>AddPermission</code> returns this error if the maximum number of permissions
|
|
83
|
+
* for the queue is reached.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link QueueDoesNotExist} (client fault)
|
|
86
|
+
* <p>The specified queue doesn't exist.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link RequestThrottled} (client fault)
|
|
89
|
+
* <p>The request was denied due to request throttling.</p>
|
|
90
|
+
* <ul>
|
|
91
|
+
* <li>
|
|
92
|
+
* <p>The rate of requests per second exceeds the AWS KMS request quota for an
|
|
93
|
+
* account and Region. </p>
|
|
94
|
+
* </li>
|
|
95
|
+
* <li>
|
|
96
|
+
* <p>A burst or sustained high rate of requests to change the state of the same KMS
|
|
97
|
+
* key. This condition is often known as a "hot key."</p>
|
|
98
|
+
* </li>
|
|
99
|
+
* <li>
|
|
100
|
+
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
101
|
+
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
102
|
+
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
103
|
+
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
104
|
+
* </li>
|
|
105
|
+
* </ul>
|
|
106
|
+
*
|
|
107
|
+
* @throws {@link UnsupportedOperation} (client fault)
|
|
108
|
+
* <p>Error code 400. Unsupported operation.</p>
|
|
109
|
+
*
|
|
66
110
|
* @throws {@link SQSServiceException}
|
|
67
111
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
68
112
|
*
|
|
@@ -21,7 +21,6 @@ export interface TagQueueCommandOutput extends __MetadataBearer {
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Add cost allocation tags to the specified Amazon SQS queue. For an overview, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html">Tagging
|
|
23
23
|
* Your Amazon SQS Queues</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
24
|
-
*
|
|
25
24
|
* <p>When you use queue tags, keep the following guidelines in mind:</p>
|
|
26
25
|
* <ul>
|
|
27
26
|
* <li>
|
|
@@ -40,11 +39,11 @@ export interface TagQueueCommandOutput extends __MetadataBearer {
|
|
|
40
39
|
* <p>For a full list of tag restrictions, see
|
|
41
40
|
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues">Quotas related to queues</a>
|
|
42
41
|
* in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
43
|
-
*
|
|
42
|
+
* <note>
|
|
44
43
|
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
45
44
|
* 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
|
|
46
|
-
* cross-account permissions to a role and a
|
|
47
|
-
*
|
|
45
|
+
* cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
46
|
+
* </note>
|
|
48
47
|
* @example
|
|
49
48
|
* Use a bare-bones client and the command you need to make an API call.
|
|
50
49
|
* ```javascript
|
|
@@ -69,6 +68,37 @@ export interface TagQueueCommandOutput extends __MetadataBearer {
|
|
|
69
68
|
* @see {@link TagQueueCommandOutput} for command's `response` shape.
|
|
70
69
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
71
70
|
*
|
|
71
|
+
* @throws {@link InvalidAddress} (client fault)
|
|
72
|
+
* <p>The <code>accountId</code> is invalid.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link InvalidSecurity} (client fault)
|
|
75
|
+
* <p>When the request to a queue is not HTTPS and SigV4.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link QueueDoesNotExist} (client fault)
|
|
78
|
+
* <p>The specified queue doesn't exist.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link RequestThrottled} (client fault)
|
|
81
|
+
* <p>The request was denied due to request throttling.</p>
|
|
82
|
+
* <ul>
|
|
83
|
+
* <li>
|
|
84
|
+
* <p>The rate of requests per second exceeds the AWS KMS request quota for an
|
|
85
|
+
* account and Region. </p>
|
|
86
|
+
* </li>
|
|
87
|
+
* <li>
|
|
88
|
+
* <p>A burst or sustained high rate of requests to change the state of the same KMS
|
|
89
|
+
* key. This condition is often known as a "hot key."</p>
|
|
90
|
+
* </li>
|
|
91
|
+
* <li>
|
|
92
|
+
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
93
|
+
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
94
|
+
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
95
|
+
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
96
|
+
* </li>
|
|
97
|
+
* </ul>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link UnsupportedOperation} (client fault)
|
|
100
|
+
* <p>Error code 400. Unsupported operation.</p>
|
|
101
|
+
*
|
|
72
102
|
* @throws {@link SQSServiceException}
|
|
73
103
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
74
104
|
*
|
|
@@ -21,11 +21,11 @@ export interface UntagQueueCommandOutput extends __MetadataBearer {
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html">Tagging
|
|
23
23
|
* Your Amazon SQS Queues</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
24
|
-
*
|
|
24
|
+
* <note>
|
|
25
25
|
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
26
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
|
|
27
|
-
* cross-account permissions to a role and a
|
|
28
|
-
*
|
|
27
|
+
* cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
28
|
+
* </note>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
31
|
* ```javascript
|
|
@@ -50,6 +50,37 @@ export interface UntagQueueCommandOutput extends __MetadataBearer {
|
|
|
50
50
|
* @see {@link UntagQueueCommandOutput} for command's `response` shape.
|
|
51
51
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
52
52
|
*
|
|
53
|
+
* @throws {@link InvalidAddress} (client fault)
|
|
54
|
+
* <p>The <code>accountId</code> is invalid.</p>
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link InvalidSecurity} (client fault)
|
|
57
|
+
* <p>When the request to a queue is not HTTPS and SigV4.</p>
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link QueueDoesNotExist} (client fault)
|
|
60
|
+
* <p>The specified queue doesn't exist.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link RequestThrottled} (client fault)
|
|
63
|
+
* <p>The request was denied due to request throttling.</p>
|
|
64
|
+
* <ul>
|
|
65
|
+
* <li>
|
|
66
|
+
* <p>The rate of requests per second exceeds the AWS KMS request quota for an
|
|
67
|
+
* account and Region. </p>
|
|
68
|
+
* </li>
|
|
69
|
+
* <li>
|
|
70
|
+
* <p>A burst or sustained high rate of requests to change the state of the same KMS
|
|
71
|
+
* key. This condition is often known as a "hot key."</p>
|
|
72
|
+
* </li>
|
|
73
|
+
* <li>
|
|
74
|
+
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
75
|
+
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
76
|
+
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
77
|
+
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
78
|
+
* </li>
|
|
79
|
+
* </ul>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link UnsupportedOperation} (client fault)
|
|
82
|
+
* <p>Error code 400. Unsupported operation.</p>
|
|
83
|
+
*
|
|
53
84
|
* @throws {@link SQSServiceException}
|
|
54
85
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
55
86
|
*
|