@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
package/dist-types/SQS.d.ts
CHANGED
|
@@ -145,38 +145,40 @@ export interface SQS {
|
|
|
145
145
|
/**
|
|
146
146
|
* @public
|
|
147
147
|
* <p>Welcome to the <i>Amazon SQS API Reference</i>.</p>
|
|
148
|
-
*
|
|
149
|
-
*
|
|
150
|
-
*
|
|
151
|
-
*
|
|
148
|
+
* <p>Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel
|
|
149
|
+
* between applications or microservices. Amazon SQS moves data between distributed application
|
|
150
|
+
* components and helps you decouple these components.</p>
|
|
151
|
+
* <p>For information on the permissions you need to use this API, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-authentication-and-access-control.html">Identity and access management</a> in the <i>Amazon SQS Developer
|
|
152
|
+
* Guide.</i>
|
|
152
153
|
* </p>
|
|
153
|
-
*
|
|
154
|
-
*
|
|
154
|
+
* <p>You can use <a href="http://aws.amazon.com/tools/#sdk">Amazon Web Services SDKs</a> to access
|
|
155
|
+
* Amazon SQS using your favorite programming language. The SDKs perform tasks such as the
|
|
156
|
+
* following automatically:</p>
|
|
157
|
+
* <ul>
|
|
155
158
|
* <li>
|
|
156
|
-
*
|
|
159
|
+
* <p>Cryptographically sign your service requests</p>
|
|
157
160
|
* </li>
|
|
158
161
|
* <li>
|
|
159
|
-
*
|
|
162
|
+
* <p>Retry requests</p>
|
|
160
163
|
* </li>
|
|
161
164
|
* <li>
|
|
162
|
-
*
|
|
165
|
+
* <p>Handle error responses</p>
|
|
163
166
|
* </li>
|
|
164
167
|
* </ul>
|
|
165
|
-
*
|
|
166
|
-
* <p>
|
|
168
|
+
* <p>
|
|
167
169
|
* <b>Additional information</b>
|
|
168
170
|
* </p>
|
|
169
|
-
*
|
|
171
|
+
* <ul>
|
|
170
172
|
* <li>
|
|
171
|
-
*
|
|
172
|
-
*
|
|
173
|
-
*
|
|
173
|
+
* <p>
|
|
174
|
+
* <a href="http://aws.amazon.com/sqs/">Amazon SQS Product Page</a>
|
|
175
|
+
* </p>
|
|
174
176
|
* </li>
|
|
175
177
|
* <li>
|
|
176
|
-
*
|
|
178
|
+
* <p>
|
|
177
179
|
* <i>Amazon SQS Developer Guide</i>
|
|
178
180
|
* </p>
|
|
179
|
-
*
|
|
181
|
+
* <ul>
|
|
180
182
|
* <li>
|
|
181
183
|
* <p>
|
|
182
184
|
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-making-api-requests.html">Making API Requests</a>
|
|
@@ -195,19 +197,20 @@ export interface SQS {
|
|
|
195
197
|
* </ul>
|
|
196
198
|
* </li>
|
|
197
199
|
* <li>
|
|
198
|
-
*
|
|
200
|
+
* <p>
|
|
199
201
|
* <a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line Interface</i>
|
|
200
202
|
* </a>
|
|
201
203
|
* </p>
|
|
202
204
|
* </li>
|
|
203
205
|
* <li>
|
|
204
|
-
*
|
|
206
|
+
* <p>
|
|
205
207
|
* <i>Amazon Web Services General Reference</i>
|
|
206
208
|
* </p>
|
|
207
|
-
*
|
|
209
|
+
* <ul>
|
|
208
210
|
* <li>
|
|
209
211
|
* <p>
|
|
210
|
-
* <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#sqs_region">Regions and
|
|
212
|
+
* <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#sqs_region">Regions and
|
|
213
|
+
* Endpoints</a>
|
|
211
214
|
* </p>
|
|
212
215
|
* </li>
|
|
213
216
|
* </ul>
|
|
@@ -170,38 +170,40 @@ export interface SQSClientResolvedConfig extends SQSClientResolvedConfigType {
|
|
|
170
170
|
/**
|
|
171
171
|
* @public
|
|
172
172
|
* <p>Welcome to the <i>Amazon SQS API Reference</i>.</p>
|
|
173
|
-
*
|
|
174
|
-
*
|
|
175
|
-
*
|
|
176
|
-
*
|
|
173
|
+
* <p>Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel
|
|
174
|
+
* between applications or microservices. Amazon SQS moves data between distributed application
|
|
175
|
+
* components and helps you decouple these components.</p>
|
|
176
|
+
* <p>For information on the permissions you need to use this API, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-authentication-and-access-control.html">Identity and access management</a> in the <i>Amazon SQS Developer
|
|
177
|
+
* Guide.</i>
|
|
177
178
|
* </p>
|
|
178
|
-
*
|
|
179
|
-
*
|
|
179
|
+
* <p>You can use <a href="http://aws.amazon.com/tools/#sdk">Amazon Web Services SDKs</a> to access
|
|
180
|
+
* Amazon SQS using your favorite programming language. The SDKs perform tasks such as the
|
|
181
|
+
* following automatically:</p>
|
|
182
|
+
* <ul>
|
|
180
183
|
* <li>
|
|
181
|
-
*
|
|
184
|
+
* <p>Cryptographically sign your service requests</p>
|
|
182
185
|
* </li>
|
|
183
186
|
* <li>
|
|
184
|
-
*
|
|
187
|
+
* <p>Retry requests</p>
|
|
185
188
|
* </li>
|
|
186
189
|
* <li>
|
|
187
|
-
*
|
|
190
|
+
* <p>Handle error responses</p>
|
|
188
191
|
* </li>
|
|
189
192
|
* </ul>
|
|
190
|
-
*
|
|
191
|
-
* <p>
|
|
193
|
+
* <p>
|
|
192
194
|
* <b>Additional information</b>
|
|
193
195
|
* </p>
|
|
194
|
-
*
|
|
196
|
+
* <ul>
|
|
195
197
|
* <li>
|
|
196
|
-
*
|
|
197
|
-
*
|
|
198
|
-
*
|
|
198
|
+
* <p>
|
|
199
|
+
* <a href="http://aws.amazon.com/sqs/">Amazon SQS Product Page</a>
|
|
200
|
+
* </p>
|
|
199
201
|
* </li>
|
|
200
202
|
* <li>
|
|
201
|
-
*
|
|
203
|
+
* <p>
|
|
202
204
|
* <i>Amazon SQS Developer Guide</i>
|
|
203
205
|
* </p>
|
|
204
|
-
*
|
|
206
|
+
* <ul>
|
|
205
207
|
* <li>
|
|
206
208
|
* <p>
|
|
207
209
|
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-making-api-requests.html">Making API Requests</a>
|
|
@@ -220,19 +222,20 @@ export interface SQSClientResolvedConfig extends SQSClientResolvedConfigType {
|
|
|
220
222
|
* </ul>
|
|
221
223
|
* </li>
|
|
222
224
|
* <li>
|
|
223
|
-
*
|
|
225
|
+
* <p>
|
|
224
226
|
* <a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line Interface</i>
|
|
225
227
|
* </a>
|
|
226
228
|
* </p>
|
|
227
229
|
* </li>
|
|
228
230
|
* <li>
|
|
229
|
-
*
|
|
231
|
+
* <p>
|
|
230
232
|
* <i>Amazon Web Services General Reference</i>
|
|
231
233
|
* </p>
|
|
232
|
-
*
|
|
234
|
+
* <ul>
|
|
233
235
|
* <li>
|
|
234
236
|
* <p>
|
|
235
|
-
* <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#sqs_region">Regions and
|
|
237
|
+
* <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#sqs_region">Regions and
|
|
238
|
+
* Endpoints</a>
|
|
236
239
|
* </p>
|
|
237
240
|
* </li>
|
|
238
241
|
* </ul>
|
|
@@ -19,45 +19,39 @@ export interface AddPermissionCommandOutput extends __MetadataBearer {
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Adds a permission to a queue for a specific
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-writing-an-sqs-policy.html#write-messages-to-shared-queue">Allow
|
|
29
|
-
* Developers to Write Messages to a Shared Queue</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
22
|
+
* <p>Adds a permission to a queue for a specific <a href="https://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P">principal</a>. This allows sharing
|
|
23
|
+
* access to the queue.</p>
|
|
24
|
+
* <p>When you create a queue, you have full control access rights for the queue. Only you,
|
|
25
|
+
* the owner of the queue, can grant or deny permissions to the queue. For more information
|
|
26
|
+
* about these permissions, 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
|
|
27
|
+
* Developer Guide</i>.</p>
|
|
30
28
|
* <note>
|
|
31
29
|
* <ul>
|
|
32
30
|
* <li>
|
|
33
|
-
*
|
|
31
|
+
* <p>
|
|
34
32
|
* <code>AddPermission</code> generates a policy for you. You can use
|
|
35
|
-
*
|
|
33
|
+
* <code>
|
|
36
34
|
* <a>SetQueueAttributes</a>
|
|
37
|
-
* </code> to
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
* the <i>Amazon SQS Developer Guide</i>.</p>
|
|
35
|
+
* </code> to upload your
|
|
36
|
+
* policy. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-creating-custom-policies.html">Using Custom Policies with the Amazon SQS Access Policy Language</a> in
|
|
37
|
+
* the <i>Amazon SQS Developer Guide</i>.</p>
|
|
41
38
|
* </li>
|
|
42
39
|
* <li>
|
|
43
|
-
*
|
|
40
|
+
* <p>An Amazon SQS policy can have a maximum of seven actions per statement.</p>
|
|
44
41
|
* </li>
|
|
45
42
|
* <li>
|
|
46
|
-
*
|
|
47
|
-
*
|
|
43
|
+
* <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>
|
|
44
|
+
* </li>
|
|
45
|
+
* <li>
|
|
46
|
+
* <p>Amazon SQS <code>AddPermission</code> does not support adding a non-account
|
|
47
|
+
* principal.</p>
|
|
48
|
+
* </li>
|
|
48
49
|
* </ul>
|
|
49
50
|
* </note>
|
|
50
|
-
* <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>
|
|
51
|
-
* <p>
|
|
52
|
-
* <code>&AttributeName.1=first</code>
|
|
53
|
-
* </p>
|
|
54
|
-
* <p>
|
|
55
|
-
* <code>&AttributeName.2=second</code>
|
|
56
|
-
* </p>
|
|
57
51
|
* <note>
|
|
58
52
|
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
59
53
|
* 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
|
|
60
|
-
* cross-account permissions to a role and a
|
|
54
|
+
* cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
61
55
|
* </note>
|
|
62
56
|
* @example
|
|
63
57
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -77,6 +71,8 @@ export interface AddPermissionCommandOutput extends __MetadataBearer {
|
|
|
77
71
|
* };
|
|
78
72
|
* const command = new AddPermissionCommand(input);
|
|
79
73
|
* const response = await client.send(command);
|
|
74
|
+
* // {};
|
|
75
|
+
*
|
|
80
76
|
* ```
|
|
81
77
|
*
|
|
82
78
|
* @param AddPermissionCommandInput - {@link AddPermissionCommandInput}
|
|
@@ -85,12 +81,45 @@ export interface AddPermissionCommandOutput extends __MetadataBearer {
|
|
|
85
81
|
* @see {@link AddPermissionCommandOutput} for command's `response` shape.
|
|
86
82
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
87
83
|
*
|
|
84
|
+
* @throws {@link InvalidAddress} (client fault)
|
|
85
|
+
* <p>The <code>accountId</code> is invalid.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link InvalidSecurity} (client fault)
|
|
88
|
+
* <p>When the request to a queue is not HTTPS and SigV4.</p>
|
|
89
|
+
*
|
|
88
90
|
* @throws {@link OverLimit} (client fault)
|
|
89
91
|
* <p>The specified action violates a limit. For example, <code>ReceiveMessage</code>
|
|
90
|
-
* returns this error if the maximum number of
|
|
92
|
+
* returns this error if the maximum number of in flight messages is reached and
|
|
91
93
|
* <code>AddPermission</code> returns this error if the maximum number of permissions
|
|
92
94
|
* for the queue is reached.</p>
|
|
93
95
|
*
|
|
96
|
+
* @throws {@link QueueDoesNotExist} (client fault)
|
|
97
|
+
* <p>The specified queue doesn't exist.</p>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link RequestThrottled} (client fault)
|
|
100
|
+
* <p>The request was denied due to request throttling.</p>
|
|
101
|
+
* <ul>
|
|
102
|
+
* <li>
|
|
103
|
+
* <p>The rate of requests per second exceeds the AWS KMS request quota for an
|
|
104
|
+
* account and Region. </p>
|
|
105
|
+
* </li>
|
|
106
|
+
* <li>
|
|
107
|
+
* <p>A burst or sustained high rate of requests to change the state of the same KMS
|
|
108
|
+
* key. This condition is often known as a "hot key."</p>
|
|
109
|
+
* </li>
|
|
110
|
+
* <li>
|
|
111
|
+
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
112
|
+
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
113
|
+
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
114
|
+
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
115
|
+
* </li>
|
|
116
|
+
* </ul>
|
|
117
|
+
*
|
|
118
|
+
* @throws {@link UnsupportedOperation} (client fault)
|
|
119
|
+
* <p>Error code 400. Unsupported operation.</p>
|
|
120
|
+
*
|
|
121
|
+
* @throws {@link SQSServiceException}
|
|
122
|
+
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
94
123
|
*
|
|
95
124
|
*/
|
|
96
125
|
export declare class AddPermissionCommand extends $Command<AddPermissionCommandInput, AddPermissionCommandOutput, SQSClientResolvedConfig> {
|
|
@@ -19,21 +19,17 @@ export interface ChangeMessageVisibilityBatchCommandOutput extends ChangeMessage
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Changes the visibility timeout of multiple messages. This is a batch version of
|
|
23
|
-
*
|
|
24
|
-
*
|
|
22
|
+
* <p>Changes the visibility timeout of multiple messages. This is a batch version of
|
|
23
|
+
* <code>
|
|
24
|
+
* <a>ChangeMessageVisibility</a>.</code> The result of the action
|
|
25
|
+
* on each message is reported individually in the response. You can send up to 10
|
|
26
|
+
* <code>
|
|
25
27
|
* <a>ChangeMessageVisibility</a>
|
|
26
|
-
* </code> requests with each
|
|
28
|
+
* </code> requests with each
|
|
29
|
+
* <code>ChangeMessageVisibilityBatch</code> action.</p>
|
|
27
30
|
* <important>
|
|
28
31
|
* <p>Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of <code>200</code>.</p>
|
|
29
32
|
* </important>
|
|
30
|
-
* <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>
|
|
31
|
-
* <p>
|
|
32
|
-
* <code>&AttributeName.1=first</code>
|
|
33
|
-
* </p>
|
|
34
|
-
* <p>
|
|
35
|
-
* <code>&AttributeName.2=second</code>
|
|
36
|
-
* </p>
|
|
37
33
|
* @example
|
|
38
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
39
35
|
* ```javascript
|
|
@@ -52,6 +48,22 @@ export interface ChangeMessageVisibilityBatchCommandOutput extends ChangeMessage
|
|
|
52
48
|
* };
|
|
53
49
|
* const command = new ChangeMessageVisibilityBatchCommand(input);
|
|
54
50
|
* const response = await client.send(command);
|
|
51
|
+
* // { // ChangeMessageVisibilityBatchResult
|
|
52
|
+
* // Successful: [ // ChangeMessageVisibilityBatchResultEntryList // required
|
|
53
|
+
* // { // ChangeMessageVisibilityBatchResultEntry
|
|
54
|
+
* // Id: "STRING_VALUE", // required
|
|
55
|
+
* // },
|
|
56
|
+
* // ],
|
|
57
|
+
* // Failed: [ // BatchResultErrorEntryList // required
|
|
58
|
+
* // { // BatchResultErrorEntry
|
|
59
|
+
* // Id: "STRING_VALUE", // required
|
|
60
|
+
* // SenderFault: true || false, // required
|
|
61
|
+
* // Code: "STRING_VALUE", // required
|
|
62
|
+
* // Message: "STRING_VALUE",
|
|
63
|
+
* // },
|
|
64
|
+
* // ],
|
|
65
|
+
* // };
|
|
66
|
+
*
|
|
55
67
|
* ```
|
|
56
68
|
*
|
|
57
69
|
* @param ChangeMessageVisibilityBatchCommandInput - {@link ChangeMessageVisibilityBatchCommandInput}
|
|
@@ -67,11 +79,39 @@ export interface ChangeMessageVisibilityBatchCommandOutput extends ChangeMessage
|
|
|
67
79
|
* <p>The batch request doesn't contain any entries.</p>
|
|
68
80
|
*
|
|
69
81
|
* @throws {@link InvalidBatchEntryId} (client fault)
|
|
70
|
-
* <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the
|
|
82
|
+
* <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the
|
|
83
|
+
* specification.</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>
|
|
71
106
|
*
|
|
72
107
|
* @throws {@link TooManyEntriesInBatchRequest} (client fault)
|
|
73
108
|
* <p>The batch request contains more entries than permissible.</p>
|
|
74
109
|
*
|
|
110
|
+
* @throws {@link UnsupportedOperation} (client fault)
|
|
111
|
+
* <p>Error code 400. Unsupported operation.</p>
|
|
112
|
+
*
|
|
113
|
+
* @throws {@link SQSServiceException}
|
|
114
|
+
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
75
115
|
*
|
|
76
116
|
*/
|
|
77
117
|
export declare class ChangeMessageVisibilityBatchCommand extends $Command<ChangeMessageVisibilityBatchCommandInput, ChangeMessageVisibilityBatchCommandOutput, SQSClientResolvedConfig> {
|
|
@@ -21,13 +21,16 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer {
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Changes the visibility timeout of a specified message in a queue to a new value. The
|
|
23
23
|
* default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The
|
|
24
|
-
* maximum is 12 hours. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility Timeout</a> in the <i>Amazon SQS Developer
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
* the
|
|
30
|
-
*
|
|
24
|
+
* maximum is 12 hours. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility Timeout</a> in the <i>Amazon SQS Developer
|
|
25
|
+
* Guide</i>.</p>
|
|
26
|
+
* <p>For example, if the default timeout for a queue is 60 seconds, 15 seconds have elapsed
|
|
27
|
+
* since you received the message, and you send a ChangeMessageVisibility call with
|
|
28
|
+
* <code>VisibilityTimeout</code> set to 10 seconds, the 10 seconds begin to count from
|
|
29
|
+
* the time that you make the <code>ChangeMessageVisibility</code> call. Thus, any attempt
|
|
30
|
+
* to change the visibility timeout or to delete that message 10 seconds after you
|
|
31
|
+
* initially change the visibility timeout (a total of 25 seconds) might result in an
|
|
32
|
+
* error.</p>
|
|
33
|
+
* <p>An Amazon SQS message has three basic states:</p>
|
|
31
34
|
* <ol>
|
|
32
35
|
* <li>
|
|
33
36
|
* <p>Sent to a queue by a producer.</p>
|
|
@@ -40,18 +43,23 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer {
|
|
|
40
43
|
* </li>
|
|
41
44
|
* </ol>
|
|
42
45
|
* <p>A message is considered to be <i>stored</i> after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages.
|
|
43
|
-
* A message is considered to be <i>in flight</i> after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of
|
|
44
|
-
* <p>Limits that apply to
|
|
45
|
-
* <p>For most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000
|
|
46
|
+
* A message is considered to be <i>in flight</i> after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of in flight messages.</p>
|
|
47
|
+
* <p>Limits that apply to in flight messages are unrelated to the <i>unlimited</i> number of stored messages.</p>
|
|
48
|
+
* <p>For most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue).
|
|
46
49
|
* If you reach this limit, Amazon SQS returns the <code>OverLimit</code> error message.
|
|
47
50
|
* To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages.
|
|
48
51
|
* To request a limit increase, <a href="https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-sqs">file a support request</a>.</p>
|
|
49
|
-
* <p>For FIFO queues, there can be a maximum of 20,000
|
|
50
|
-
*
|
|
52
|
+
* <p>For FIFO queues, there can be a maximum of 20,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.</p>
|
|
51
53
|
* <important>
|
|
52
|
-
* <p>If you attempt to set the <code>VisibilityTimeout</code> to a value greater than
|
|
53
|
-
*
|
|
54
|
-
*
|
|
54
|
+
* <p>If you attempt to set the <code>VisibilityTimeout</code> to a value greater than
|
|
55
|
+
* the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically
|
|
56
|
+
* recalculate and increase the timeout to the maximum remaining time.</p>
|
|
57
|
+
* <p>Unlike with a queue, when you change the visibility timeout for a specific message
|
|
58
|
+
* the timeout value is applied immediately but isn't saved in memory for that message.
|
|
59
|
+
* If you don't delete a message after it is received, the visibility timeout for the
|
|
60
|
+
* message reverts to the original timeout value (not to the value you set using the
|
|
61
|
+
* <code>ChangeMessageVisibility</code> action) the next time the message is
|
|
62
|
+
* received.</p>
|
|
55
63
|
* </important>
|
|
56
64
|
* @example
|
|
57
65
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -66,6 +74,8 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer {
|
|
|
66
74
|
* };
|
|
67
75
|
* const command = new ChangeMessageVisibilityCommand(input);
|
|
68
76
|
* const response = await client.send(command);
|
|
77
|
+
* // {};
|
|
78
|
+
*
|
|
69
79
|
* ```
|
|
70
80
|
*
|
|
71
81
|
* @param ChangeMessageVisibilityCommandInput - {@link ChangeMessageVisibilityCommandInput}
|
|
@@ -77,9 +87,36 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer {
|
|
|
77
87
|
* @throws {@link MessageNotInflight} (client fault)
|
|
78
88
|
* <p>The specified message isn't in flight.</p>
|
|
79
89
|
*
|
|
90
|
+
* @throws {@link QueueDoesNotExist} (client fault)
|
|
91
|
+
* <p>The specified queue doesn't exist.</p>
|
|
92
|
+
*
|
|
80
93
|
* @throws {@link ReceiptHandleIsInvalid} (client fault)
|
|
81
94
|
* <p>The specified receipt handle isn't valid.</p>
|
|
82
95
|
*
|
|
96
|
+
* @throws {@link RequestThrottled} (client fault)
|
|
97
|
+
* <p>The request was denied due to request throttling.</p>
|
|
98
|
+
* <ul>
|
|
99
|
+
* <li>
|
|
100
|
+
* <p>The rate of requests per second exceeds the AWS KMS request quota for an
|
|
101
|
+
* account and Region. </p>
|
|
102
|
+
* </li>
|
|
103
|
+
* <li>
|
|
104
|
+
* <p>A burst or sustained high rate of requests to change the state of the same KMS
|
|
105
|
+
* key. This condition is often known as a "hot key."</p>
|
|
106
|
+
* </li>
|
|
107
|
+
* <li>
|
|
108
|
+
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
109
|
+
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
110
|
+
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
111
|
+
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
112
|
+
* </li>
|
|
113
|
+
* </ul>
|
|
114
|
+
*
|
|
115
|
+
* @throws {@link UnsupportedOperation} (client fault)
|
|
116
|
+
* <p>Error code 400. Unsupported operation.</p>
|
|
117
|
+
*
|
|
118
|
+
* @throws {@link SQSServiceException}
|
|
119
|
+
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
83
120
|
*
|
|
84
121
|
*/
|
|
85
122
|
export declare class ChangeMessageVisibilityCommand extends $Command<ChangeMessageVisibilityCommandInput, ChangeMessageVisibilityCommandOutput, SQSClientResolvedConfig> {
|