@aws-sdk/client-sqs 3.327.0 → 3.329.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -13
- package/dist-cjs/commands/AddPermissionCommand.js +3 -3
- package/dist-cjs/commands/ChangeMessageVisibilityBatchCommand.js +3 -3
- package/dist-cjs/commands/ChangeMessageVisibilityCommand.js +3 -3
- package/dist-cjs/commands/CreateQueueCommand.js +3 -3
- package/dist-cjs/commands/DeleteMessageBatchCommand.js +3 -3
- package/dist-cjs/commands/DeleteMessageCommand.js +3 -3
- package/dist-cjs/commands/DeleteQueueCommand.js +3 -3
- package/dist-cjs/commands/GetQueueAttributesCommand.js +3 -3
- package/dist-cjs/commands/GetQueueUrlCommand.js +3 -3
- package/dist-cjs/commands/ListDeadLetterSourceQueuesCommand.js +3 -3
- package/dist-cjs/commands/ListQueueTagsCommand.js +3 -3
- package/dist-cjs/commands/ListQueuesCommand.js +3 -3
- package/dist-cjs/commands/PurgeQueueCommand.js +3 -3
- package/dist-cjs/commands/ReceiveMessageCommand.js +3 -3
- package/dist-cjs/commands/RemovePermissionCommand.js +3 -3
- package/dist-cjs/commands/SendMessageBatchCommand.js +3 -3
- package/dist-cjs/commands/SendMessageCommand.js +3 -3
- package/dist-cjs/commands/SetQueueAttributesCommand.js +3 -3
- package/dist-cjs/commands/TagQueueCommand.js +3 -3
- package/dist-cjs/commands/UntagQueueCommand.js +3 -3
- package/dist-cjs/models/models_0.js +29 -172
- package/dist-cjs/protocols/Aws_query.js +2127 -0
- package/dist-es/commands/AddPermissionCommand.js +1 -1
- package/dist-es/commands/ChangeMessageVisibilityBatchCommand.js +1 -1
- package/dist-es/commands/ChangeMessageVisibilityCommand.js +1 -1
- package/dist-es/commands/CreateQueueCommand.js +1 -1
- package/dist-es/commands/DeleteMessageBatchCommand.js +1 -1
- package/dist-es/commands/DeleteMessageCommand.js +1 -1
- package/dist-es/commands/DeleteQueueCommand.js +1 -1
- package/dist-es/commands/GetQueueAttributesCommand.js +1 -1
- package/dist-es/commands/GetQueueUrlCommand.js +1 -1
- package/dist-es/commands/ListDeadLetterSourceQueuesCommand.js +1 -1
- package/dist-es/commands/ListQueueTagsCommand.js +1 -1
- package/dist-es/commands/ListQueuesCommand.js +1 -1
- package/dist-es/commands/PurgeQueueCommand.js +1 -1
- package/dist-es/commands/ReceiveMessageCommand.js +1 -1
- package/dist-es/commands/RemovePermissionCommand.js +1 -1
- package/dist-es/commands/SendMessageBatchCommand.js +1 -1
- package/dist-es/commands/SendMessageCommand.js +1 -1
- package/dist-es/commands/SetQueueAttributesCommand.js +1 -1
- package/dist-es/commands/TagQueueCommand.js +1 -1
- package/dist-es/commands/UntagQueueCommand.js +1 -1
- package/dist-es/models/models_0.js +24 -156
- package/dist-es/protocols/Aws_query.js +2084 -0
- package/dist-types/SQS.d.ts +6 -10
- package/dist-types/SQSClient.d.ts +6 -10
- package/dist-types/commands/AddPermissionCommand.d.ts +23 -48
- package/dist-types/commands/ChangeMessageVisibilityBatchCommand.d.ts +12 -34
- package/dist-types/commands/ChangeMessageVisibilityCommand.d.ts +13 -47
- package/dist-types/commands/CreateQueueCommand.d.ts +18 -53
- package/dist-types/commands/DeleteMessageBatchCommand.d.ts +10 -31
- package/dist-types/commands/DeleteMessageCommand.d.ts +1 -29
- package/dist-types/commands/DeleteQueueCommand.d.ts +8 -44
- package/dist-types/commands/GetQueueAttributesCommand.d.ts +0 -28
- package/dist-types/commands/GetQueueUrlCommand.d.ts +4 -35
- package/dist-types/commands/ListDeadLetterSourceQueuesCommand.d.ts +10 -39
- package/dist-types/commands/ListQueueTagsCommand.d.ts +2 -34
- package/dist-types/commands/ListQueuesCommand.d.ts +11 -41
- package/dist-types/commands/PurgeQueueCommand.d.ts +5 -35
- package/dist-types/commands/ReceiveMessageCommand.d.ts +14 -87
- package/dist-types/commands/RemovePermissionCommand.d.ts +2 -34
- package/dist-types/commands/SendMessageBatchCommand.d.ts +13 -73
- package/dist-types/commands/SendMessageCommand.d.ts +0 -59
- package/dist-types/commands/SetQueueAttributesCommand.d.ts +3 -47
- package/dist-types/commands/TagQueueCommand.d.ts +1 -32
- package/dist-types/commands/UntagQueueCommand.d.ts +1 -32
- package/dist-types/models/models_0.d.ts +412 -926
- package/dist-types/protocols/{Aws_json1_0.d.ts → Aws_query.d.ts} +40 -40
- package/dist-types/ts3.4/models/models_0.d.ts +21 -78
- package/package.json +32 -31
- package/dist-cjs/protocols/Aws_json1_0.js +0 -1608
- package/dist-es/protocols/Aws_json1_0.js +0 -1565
- /package/dist-types/ts3.4/protocols/{Aws_json1_0.d.ts → Aws_query.d.ts} +0 -0
package/dist-types/SQS.d.ts
CHANGED
|
@@ -145,15 +145,12 @@ export interface SQS {
|
|
|
145
145
|
/**
|
|
146
146
|
* @public
|
|
147
147
|
* <p>Welcome to the <i>Amazon SQS API Reference</i>.</p>
|
|
148
|
-
* <p>Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel
|
|
149
|
-
*
|
|
150
|
-
*
|
|
151
|
-
*
|
|
152
|
-
* Guide.</i>
|
|
148
|
+
* <p>Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.</p>
|
|
149
|
+
* <p>For information on the permissions you need to use this API, see
|
|
150
|
+
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-authentication-and-access-control.html">Identity and
|
|
151
|
+
* access management</a> in the <i>Amazon SQS Developer Guide.</i>
|
|
153
152
|
* </p>
|
|
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>
|
|
153
|
+
* <p>You can use <a href="http://aws.amazon.com/tools/#sdk">Amazon Web Services SDKs</a> to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:</p>
|
|
157
154
|
* <ul>
|
|
158
155
|
* <li>
|
|
159
156
|
* <p>Cryptographically sign your service requests</p>
|
|
@@ -209,8 +206,7 @@ export interface SQS {
|
|
|
209
206
|
* <ul>
|
|
210
207
|
* <li>
|
|
211
208
|
* <p>
|
|
212
|
-
* <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#sqs_region">Regions and
|
|
213
|
-
* Endpoints</a>
|
|
209
|
+
* <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#sqs_region">Regions and Endpoints</a>
|
|
214
210
|
* </p>
|
|
215
211
|
* </li>
|
|
216
212
|
* </ul>
|
|
@@ -170,15 +170,12 @@ export interface SQSClientResolvedConfig extends SQSClientResolvedConfigType {
|
|
|
170
170
|
/**
|
|
171
171
|
* @public
|
|
172
172
|
* <p>Welcome to the <i>Amazon SQS API Reference</i>.</p>
|
|
173
|
-
* <p>Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel
|
|
174
|
-
*
|
|
175
|
-
*
|
|
176
|
-
*
|
|
177
|
-
* Guide.</i>
|
|
173
|
+
* <p>Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.</p>
|
|
174
|
+
* <p>For information on the permissions you need to use this API, see
|
|
175
|
+
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-authentication-and-access-control.html">Identity and
|
|
176
|
+
* access management</a> in the <i>Amazon SQS Developer Guide.</i>
|
|
178
177
|
* </p>
|
|
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>
|
|
178
|
+
* <p>You can use <a href="http://aws.amazon.com/tools/#sdk">Amazon Web Services SDKs</a> to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:</p>
|
|
182
179
|
* <ul>
|
|
183
180
|
* <li>
|
|
184
181
|
* <p>Cryptographically sign your service requests</p>
|
|
@@ -234,8 +231,7 @@ export interface SQSClientResolvedConfig extends SQSClientResolvedConfigType {
|
|
|
234
231
|
* <ul>
|
|
235
232
|
* <li>
|
|
236
233
|
* <p>
|
|
237
|
-
* <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#sqs_region">Regions and
|
|
238
|
-
* Endpoints</a>
|
|
234
|
+
* <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#sqs_region">Regions and Endpoints</a>
|
|
239
235
|
* </p>
|
|
240
236
|
* </li>
|
|
241
237
|
* </ul>
|
|
@@ -19,39 +19,45 @@ 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
|
-
*
|
|
22
|
+
* <p>Adds a permission to a queue for a specific
|
|
23
|
+
* <a href="https://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P">principal</a>.
|
|
24
|
+
* This allows sharing access to the queue.</p>
|
|
25
|
+
* <p>When you create a queue, you have full control access rights for the queue.
|
|
26
|
+
* Only you, the owner of the queue, can grant or deny permissions to the queue.
|
|
27
|
+
* For more information about these permissions, see
|
|
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>
|
|
28
30
|
* <note>
|
|
29
31
|
* <ul>
|
|
30
32
|
* <li>
|
|
31
33
|
* <p>
|
|
32
34
|
* <code>AddPermission</code> generates a policy for you. You can use
|
|
33
|
-
*
|
|
35
|
+
* <code>
|
|
34
36
|
* <a>SetQueueAttributes</a>
|
|
35
|
-
* </code> to
|
|
36
|
-
* policy. For more information, see
|
|
37
|
-
*
|
|
37
|
+
* </code> to
|
|
38
|
+
* upload your policy. For more information, see
|
|
39
|
+
* <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
|
|
40
|
+
* the <i>Amazon SQS Developer Guide</i>.</p>
|
|
38
41
|
* </li>
|
|
39
42
|
* <li>
|
|
40
|
-
* <p>An Amazon SQS policy can have a maximum of
|
|
43
|
+
* <p>An Amazon SQS policy can have a maximum of 7 actions.</p>
|
|
41
44
|
* </li>
|
|
42
45
|
* <li>
|
|
43
46
|
* <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
47
|
* </li>
|
|
45
|
-
* <li>
|
|
46
|
-
* <p>Amazon SQS <code>AddPermission</code> does not support adding a non-account
|
|
47
|
-
* principal.</p>
|
|
48
|
-
* </li>
|
|
49
48
|
* </ul>
|
|
50
49
|
* </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>
|
|
51
57
|
* <note>
|
|
52
58
|
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
53
59
|
* 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
|
|
54
|
-
* cross-account permissions to a role and a
|
|
60
|
+
* cross-account permissions to a role and a user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
55
61
|
* </note>
|
|
56
62
|
* @example
|
|
57
63
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -81,43 +87,12 @@ export interface AddPermissionCommandOutput extends __MetadataBearer {
|
|
|
81
87
|
* @see {@link AddPermissionCommandOutput} for command's `response` shape.
|
|
82
88
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
83
89
|
*
|
|
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
|
-
*
|
|
90
90
|
* @throws {@link OverLimit} (client fault)
|
|
91
91
|
* <p>The specified action violates a limit. For example, <code>ReceiveMessage</code>
|
|
92
|
-
* returns this error if the maximum number of
|
|
92
|
+
* returns this error if the maximum number of inflight messages is reached and
|
|
93
93
|
* <code>AddPermission</code> returns this error if the maximum number of permissions
|
|
94
94
|
* for the queue is reached.</p>
|
|
95
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
96
|
* @throws {@link SQSServiceException}
|
|
122
97
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
123
98
|
*
|
|
@@ -19,17 +19,21 @@ 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
|
-
*
|
|
25
|
-
* on each message is reported individually in the response. You can send up to 10
|
|
26
|
-
* <code>
|
|
22
|
+
* <p>Changes the visibility timeout of multiple messages. This is a batch version of <code>
|
|
23
|
+
* <a>ChangeMessageVisibility</a>.</code> The result of the action on each message is reported individually in the response.
|
|
24
|
+
* You can send up to 10 <code>
|
|
27
25
|
* <a>ChangeMessageVisibility</a>
|
|
28
|
-
* </code> requests with each
|
|
29
|
-
* <code>ChangeMessageVisibilityBatch</code> action.</p>
|
|
26
|
+
* </code> requests with each <code>ChangeMessageVisibilityBatch</code> action.</p>
|
|
30
27
|
* <important>
|
|
31
28
|
* <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>
|
|
32
29
|
* </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>
|
|
33
37
|
* @example
|
|
34
38
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
39
|
* ```javascript
|
|
@@ -79,37 +83,11 @@ export interface ChangeMessageVisibilityBatchCommandOutput extends ChangeMessage
|
|
|
79
83
|
* <p>The batch request doesn't contain any entries.</p>
|
|
80
84
|
*
|
|
81
85
|
* @throws {@link InvalidBatchEntryId} (client fault)
|
|
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>
|
|
86
|
+
* <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the specification.</p>
|
|
106
87
|
*
|
|
107
88
|
* @throws {@link TooManyEntriesInBatchRequest} (client fault)
|
|
108
89
|
* <p>The batch request contains more entries than permissible.</p>
|
|
109
90
|
*
|
|
110
|
-
* @throws {@link UnsupportedOperation} (client fault)
|
|
111
|
-
* <p>Error code 400. Unsupported operation.</p>
|
|
112
|
-
*
|
|
113
91
|
* @throws {@link SQSServiceException}
|
|
114
92
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
115
93
|
*
|
|
@@ -21,15 +21,12 @@ 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
|
-
* 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>
|
|
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 Guide</i>.</p>
|
|
25
|
+
* <p>For example, you have a message with a visibility timeout of 5 minutes. After 3
|
|
26
|
+
* minutes, you call <code>ChangeMessageVisibility</code> with a timeout of 10 minutes. You
|
|
27
|
+
* can continue to call <code>ChangeMessageVisibility</code> to extend the visibility
|
|
28
|
+
* timeout to the maximum allowed time. If you try to extend the visibility timeout beyond
|
|
29
|
+
* the maximum, your request is rejected.</p>
|
|
33
30
|
* <p>An Amazon SQS message has three basic states:</p>
|
|
34
31
|
* <ol>
|
|
35
32
|
* <li>
|
|
@@ -43,23 +40,17 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer {
|
|
|
43
40
|
* </li>
|
|
44
41
|
* </ol>
|
|
45
42
|
* <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.
|
|
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
|
|
47
|
-
* <p>Limits that apply to
|
|
48
|
-
* <p>For most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000
|
|
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 inflight messages.</p>
|
|
44
|
+
* <p>Limits that apply to inflight messages are unrelated to the <i>unlimited</i> number of stored messages.</p>
|
|
45
|
+
* <p>For most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue).
|
|
49
46
|
* If you reach this limit, Amazon SQS returns the <code>OverLimit</code> error message.
|
|
50
47
|
* 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.
|
|
51
48
|
* 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>
|
|
52
|
-
* <p>For FIFO queues, there can be a maximum of 20,000
|
|
49
|
+
* <p>For FIFO queues, there can be a maximum of 20,000 inflight 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>
|
|
53
50
|
* <important>
|
|
54
|
-
* <p>If you attempt to set the <code>VisibilityTimeout</code> to a value greater than
|
|
55
|
-
*
|
|
56
|
-
*
|
|
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>
|
|
51
|
+
* <p>If you attempt to set the <code>VisibilityTimeout</code> to a value greater than the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically recalculate and increase the timeout to the maximum remaining time.</p>
|
|
52
|
+
* <p>Unlike with a queue, when you change the visibility timeout for a specific message the timeout value is applied immediately but isn't saved in memory for that message. If you don't delete a message after it is received, the visibility timeout
|
|
53
|
+
* for the message reverts to the original timeout value (not to the value you set using the <code>ChangeMessageVisibility</code> action) the next time the message is received.</p>
|
|
63
54
|
* </important>
|
|
64
55
|
* @example
|
|
65
56
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -87,34 +78,9 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer {
|
|
|
87
78
|
* @throws {@link MessageNotInflight} (client fault)
|
|
88
79
|
* <p>The specified message isn't in flight.</p>
|
|
89
80
|
*
|
|
90
|
-
* @throws {@link QueueDoesNotExist} (client fault)
|
|
91
|
-
* <p>The specified queue doesn't exist.</p>
|
|
92
|
-
*
|
|
93
81
|
* @throws {@link ReceiptHandleIsInvalid} (client fault)
|
|
94
82
|
* <p>The specified receipt handle isn't valid.</p>
|
|
95
83
|
*
|
|
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
84
|
* @throws {@link SQSServiceException}
|
|
119
85
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
120
86
|
*
|
|
@@ -33,43 +33,42 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB
|
|
|
33
33
|
* </note>
|
|
34
34
|
* </li>
|
|
35
35
|
* <li>
|
|
36
|
-
* <p>If you don't provide a value for an attribute, the queue is created with the
|
|
37
|
-
* default value for the attribute.</p>
|
|
36
|
+
* <p>If you don't provide a value for an attribute, the queue is created with the default value for the attribute.</p>
|
|
38
37
|
* </li>
|
|
39
38
|
* <li>
|
|
40
|
-
* <p>If you delete a queue, you must wait at least 60 seconds before creating a
|
|
41
|
-
* queue with the same name.</p>
|
|
39
|
+
* <p>If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.</p>
|
|
42
40
|
* </li>
|
|
43
41
|
* </ul>
|
|
44
|
-
* <p>To successfully create a new queue, you must provide a queue name that adheres to the
|
|
45
|
-
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html">limits
|
|
46
|
-
* related to queues</a> and is unique within the scope of your queues.</p>
|
|
42
|
+
* <p>To successfully create a new queue, you must provide a queue name that adheres to the <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html">limits related to queues</a> and is unique within the scope of your queues.</p>
|
|
47
43
|
* <note>
|
|
48
44
|
* <p>After you create a queue, you must wait at least one second after the queue is
|
|
49
45
|
* created to be able to use the queue.</p>
|
|
50
46
|
* </note>
|
|
51
47
|
* <p>To get the queue URL, use the <code>
|
|
52
48
|
* <a>GetQueueUrl</a>
|
|
53
|
-
* </code> action.
|
|
54
|
-
* <code>
|
|
49
|
+
* </code> action. <code>
|
|
55
50
|
* <a>GetQueueUrl</a>
|
|
56
|
-
* </code> requires only the
|
|
57
|
-
*
|
|
51
|
+
* </code> requires only the <code>QueueName</code> parameter.
|
|
52
|
+
* be aware of existing queue names:</p>
|
|
58
53
|
* <ul>
|
|
59
54
|
* <li>
|
|
60
|
-
* <p>If you provide the name of an existing queue along with the exact names and
|
|
61
|
-
* values of all the queue's attributes, <code>CreateQueue</code> returns the queue
|
|
62
|
-
* URL for the existing queue.</p>
|
|
55
|
+
* <p>If you provide the name of an existing queue along with the exact names and values of all the queue's attributes, <code>CreateQueue</code> returns the queue URL for the existing queue.</p>
|
|
63
56
|
* </li>
|
|
64
57
|
* <li>
|
|
65
|
-
* <p>If the queue name, attribute names, or attribute values don't match an
|
|
66
|
-
* existing queue, <code>CreateQueue</code> returns an error.</p>
|
|
58
|
+
* <p>If the queue name, attribute names, or attribute values don't match an existing queue, <code>CreateQueue</code> returns an error.</p>
|
|
67
59
|
* </li>
|
|
68
60
|
* </ul>
|
|
61
|
+
* <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>
|
|
62
|
+
* <p>
|
|
63
|
+
* <code>&AttributeName.1=first</code>
|
|
64
|
+
* </p>
|
|
65
|
+
* <p>
|
|
66
|
+
* <code>&AttributeName.2=second</code>
|
|
67
|
+
* </p>
|
|
69
68
|
* <note>
|
|
70
69
|
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
71
70
|
* 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
|
|
72
|
-
* cross-account permissions to a role and a
|
|
71
|
+
* cross-account permissions to a role and a user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
73
72
|
* </note>
|
|
74
73
|
* @example
|
|
75
74
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -79,10 +78,10 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB
|
|
|
79
78
|
* const client = new SQSClient(config);
|
|
80
79
|
* const input = { // CreateQueueRequest
|
|
81
80
|
* QueueName: "STRING_VALUE", // required
|
|
82
|
-
*
|
|
81
|
+
* tags: { // TagMap
|
|
83
82
|
* "<keys>": "STRING_VALUE",
|
|
84
83
|
* },
|
|
85
|
-
*
|
|
84
|
+
* Attributes: { // QueueAttributeMap
|
|
86
85
|
* "<keys>": "STRING_VALUE",
|
|
87
86
|
* },
|
|
88
87
|
* };
|
|
@@ -100,18 +99,6 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB
|
|
|
100
99
|
* @see {@link CreateQueueCommandOutput} for command's `response` shape.
|
|
101
100
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
102
101
|
*
|
|
103
|
-
* @throws {@link InvalidAddress} (client fault)
|
|
104
|
-
* <p>The <code>accountId</code> is invalid.</p>
|
|
105
|
-
*
|
|
106
|
-
* @throws {@link InvalidAttributeName} (client fault)
|
|
107
|
-
* <p>The specified attribute doesn't exist.</p>
|
|
108
|
-
*
|
|
109
|
-
* @throws {@link InvalidAttributeValue} (client fault)
|
|
110
|
-
* <p>A queue attribute value is invalid.</p>
|
|
111
|
-
*
|
|
112
|
-
* @throws {@link InvalidSecurity} (client fault)
|
|
113
|
-
* <p>When the request to a queue is not HTTPS and SigV4.</p>
|
|
114
|
-
*
|
|
115
102
|
* @throws {@link QueueDeletedRecently} (client fault)
|
|
116
103
|
* <p>You must wait 60 seconds after deleting a queue before you can create another queue
|
|
117
104
|
* with the same name.</p>
|
|
@@ -120,28 +107,6 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB
|
|
|
120
107
|
* <p>A queue with this name already exists. Amazon SQS returns this error only if the request
|
|
121
108
|
* includes attributes whose values differ from those of the existing queue.</p>
|
|
122
109
|
*
|
|
123
|
-
* @throws {@link RequestThrottled} (client fault)
|
|
124
|
-
* <p>The request was denied due to request throttling.</p>
|
|
125
|
-
* <ul>
|
|
126
|
-
* <li>
|
|
127
|
-
* <p>The rate of requests per second exceeds the AWS KMS request quota for an
|
|
128
|
-
* account and Region. </p>
|
|
129
|
-
* </li>
|
|
130
|
-
* <li>
|
|
131
|
-
* <p>A burst or sustained high rate of requests to change the state of the same KMS
|
|
132
|
-
* key. This condition is often known as a "hot key."</p>
|
|
133
|
-
* </li>
|
|
134
|
-
* <li>
|
|
135
|
-
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
136
|
-
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
137
|
-
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
138
|
-
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
139
|
-
* </li>
|
|
140
|
-
* </ul>
|
|
141
|
-
*
|
|
142
|
-
* @throws {@link UnsupportedOperation} (client fault)
|
|
143
|
-
* <p>Error code 400. Unsupported operation.</p>
|
|
144
|
-
*
|
|
145
110
|
* @throws {@link SQSServiceException}
|
|
146
111
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
147
112
|
*
|
|
@@ -19,13 +19,18 @@ export interface DeleteMessageBatchCommandOutput extends DeleteMessageBatchResul
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Deletes up to ten messages from the specified queue. This is a batch version of
|
|
23
|
-
*
|
|
24
|
-
* <a>DeleteMessage</a>.</code> The result of the action on each
|
|
25
|
-
* message is reported individually in the response.</p>
|
|
22
|
+
* <p>Deletes up to ten messages from the specified queue. This is a batch version of <code>
|
|
23
|
+
* <a>DeleteMessage</a>.</code> The result of the action on each message is reported individually in the response.</p>
|
|
26
24
|
* <important>
|
|
27
25
|
* <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>
|
|
28
26
|
* </important>
|
|
27
|
+
* <p>Some actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this:</p>
|
|
28
|
+
* <p>
|
|
29
|
+
* <code>&AttributeName.1=first</code>
|
|
30
|
+
* </p>
|
|
31
|
+
* <p>
|
|
32
|
+
* <code>&AttributeName.2=second</code>
|
|
33
|
+
* </p>
|
|
29
34
|
* @example
|
|
30
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
36
|
* ```javascript
|
|
@@ -74,37 +79,11 @@ export interface DeleteMessageBatchCommandOutput extends DeleteMessageBatchResul
|
|
|
74
79
|
* <p>The batch request doesn't contain any entries.</p>
|
|
75
80
|
*
|
|
76
81
|
* @throws {@link InvalidBatchEntryId} (client fault)
|
|
77
|
-
* <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the
|
|
78
|
-
* specification.</p>
|
|
79
|
-
*
|
|
80
|
-
* @throws {@link QueueDoesNotExist} (client fault)
|
|
81
|
-
* <p>The specified queue doesn't exist.</p>
|
|
82
|
-
*
|
|
83
|
-
* @throws {@link RequestThrottled} (client fault)
|
|
84
|
-
* <p>The request was denied due to request throttling.</p>
|
|
85
|
-
* <ul>
|
|
86
|
-
* <li>
|
|
87
|
-
* <p>The rate of requests per second exceeds the AWS KMS request quota for an
|
|
88
|
-
* account and Region. </p>
|
|
89
|
-
* </li>
|
|
90
|
-
* <li>
|
|
91
|
-
* <p>A burst or sustained high rate of requests to change the state of the same KMS
|
|
92
|
-
* key. This condition is often known as a "hot key."</p>
|
|
93
|
-
* </li>
|
|
94
|
-
* <li>
|
|
95
|
-
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
96
|
-
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
97
|
-
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
98
|
-
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
99
|
-
* </li>
|
|
100
|
-
* </ul>
|
|
82
|
+
* <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the specification.</p>
|
|
101
83
|
*
|
|
102
84
|
* @throws {@link TooManyEntriesInBatchRequest} (client fault)
|
|
103
85
|
* <p>The batch request contains more entries than permissible.</p>
|
|
104
86
|
*
|
|
105
|
-
* @throws {@link UnsupportedOperation} (client fault)
|
|
106
|
-
* <p>Error code 400. Unsupported operation.</p>
|
|
107
|
-
*
|
|
108
87
|
* @throws {@link SQSServiceException}
|
|
109
88
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
110
89
|
*
|
|
@@ -31,7 +31,7 @@ export interface DeleteMessageCommandOutput extends __MetadataBearer {
|
|
|
31
31
|
* once, the <code>ReceiptHandle</code> is different each time you receive a message.
|
|
32
32
|
* When you use the <code>DeleteMessage</code> action, you must provide the most
|
|
33
33
|
* recently received <code>ReceiptHandle</code> for the message (otherwise, the request
|
|
34
|
-
* succeeds, but the message
|
|
34
|
+
* succeeds, but the message might not be deleted).</p>
|
|
35
35
|
* <p>For standard queues, it is possible to receive a message even after you
|
|
36
36
|
* delete it. This might happen on rare occasions if one of the servers which stores a
|
|
37
37
|
* copy of the message is unavailable when you send the request to delete the message.
|
|
@@ -64,37 +64,9 @@ export interface DeleteMessageCommandOutput extends __MetadataBearer {
|
|
|
64
64
|
* @throws {@link InvalidIdFormat} (client fault)
|
|
65
65
|
* <p>The specified receipt handle isn't valid for the current version.</p>
|
|
66
66
|
*
|
|
67
|
-
* @throws {@link InvalidSecurity} (client fault)
|
|
68
|
-
* <p>When the request to a queue is not HTTPS and SigV4.</p>
|
|
69
|
-
*
|
|
70
|
-
* @throws {@link QueueDoesNotExist} (client fault)
|
|
71
|
-
* <p>The specified queue doesn't exist.</p>
|
|
72
|
-
*
|
|
73
67
|
* @throws {@link ReceiptHandleIsInvalid} (client fault)
|
|
74
68
|
* <p>The specified receipt handle isn't valid.</p>
|
|
75
69
|
*
|
|
76
|
-
* @throws {@link RequestThrottled} (client fault)
|
|
77
|
-
* <p>The request was denied due to request throttling.</p>
|
|
78
|
-
* <ul>
|
|
79
|
-
* <li>
|
|
80
|
-
* <p>The rate of requests per second exceeds the AWS KMS request quota for an
|
|
81
|
-
* account and Region. </p>
|
|
82
|
-
* </li>
|
|
83
|
-
* <li>
|
|
84
|
-
* <p>A burst or sustained high rate of requests to change the state of the same KMS
|
|
85
|
-
* key. This condition is often known as a "hot key."</p>
|
|
86
|
-
* </li>
|
|
87
|
-
* <li>
|
|
88
|
-
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
89
|
-
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
90
|
-
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
91
|
-
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
92
|
-
* </li>
|
|
93
|
-
* </ul>
|
|
94
|
-
*
|
|
95
|
-
* @throws {@link UnsupportedOperation} (client fault)
|
|
96
|
-
* <p>Error code 400. Unsupported operation.</p>
|
|
97
|
-
*
|
|
98
70
|
* @throws {@link SQSServiceException}
|
|
99
71
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
100
72
|
*
|