@aws-sdk/client-sqs 3.445.0 → 3.446.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 +8 -7
- package/dist-cjs/commands/AddPermissionCommand.js +3 -3
- package/dist-cjs/commands/CancelMessageMoveTaskCommand.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/ListMessageMoveTasksCommand.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/StartMessageMoveTaskCommand.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 +171 -21
- package/dist-cjs/protocols/Aws_json1_0.js +2025 -0
- package/dist-es/commands/AddPermissionCommand.js +1 -1
- package/dist-es/commands/CancelMessageMoveTaskCommand.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/ListMessageMoveTasksCommand.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/StartMessageMoveTaskCommand.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 +155 -16
- package/dist-es/protocols/Aws_json1_0.js +1976 -0
- package/dist-types/SQS.d.ts +8 -7
- package/dist-types/SQSClient.d.ts +8 -7
- package/dist-types/commands/AddPermissionCommand.d.ts +46 -11
- package/dist-types/commands/CancelMessageMoveTaskCommand.d.ts +25 -0
- package/dist-types/commands/ChangeMessageVisibilityBatchCommand.d.ts +34 -1
- package/dist-types/commands/ChangeMessageVisibilityCommand.d.ts +48 -8
- package/dist-types/commands/CreateQueueCommand.d.ts +45 -10
- package/dist-types/commands/DeleteMessageBatchCommand.d.ts +34 -1
- package/dist-types/commands/DeleteMessageCommand.d.ts +37 -6
- package/dist-types/commands/DeleteQueueCommand.d.ts +34 -3
- package/dist-types/commands/GetQueueAttributesCommand.d.ts +33 -1
- package/dist-types/commands/GetQueueUrlCommand.d.ts +30 -2
- package/dist-types/commands/ListDeadLetterSourceQueuesCommand.d.ts +28 -0
- package/dist-types/commands/ListMessageMoveTasksCommand.d.ts +26 -1
- package/dist-types/commands/ListQueueTagsCommand.d.ts +38 -6
- package/dist-types/commands/ListQueuesCommand.d.ts +32 -4
- package/dist-types/commands/PurgeQueueCommand.d.ts +28 -0
- package/dist-types/commands/ReceiveMessageCommand.d.ts +73 -6
- package/dist-types/commands/RemovePermissionCommand.d.ts +37 -4
- package/dist-types/commands/SendMessageBatchCommand.d.ts +78 -9
- package/dist-types/commands/SendMessageCommand.d.ts +70 -3
- package/dist-types/commands/SetQueueAttributesCommand.d.ts +53 -9
- package/dist-types/commands/StartMessageMoveTaskCommand.d.ts +25 -0
- package/dist-types/commands/TagQueueCommand.d.ts +44 -10
- package/dist-types/commands/UntagQueueCommand.d.ts +38 -5
- package/dist-types/index.d.ts +8 -7
- package/dist-types/models/models_0.d.ts +633 -374
- package/dist-types/protocols/{Aws_query.d.ts → Aws_json1_0.d.ts} +46 -46
- package/dist-types/ts3.4/models/models_0.d.ts +87 -22
- package/package.json +1 -2
- package/dist-cjs/protocols/Aws_query.js +0 -2367
- package/dist-es/protocols/Aws_query.js +0 -2318
- /package/dist-types/ts3.4/protocols/{Aws_query.d.ts → Aws_json1_0.d.ts} +0 -0
package/dist-types/SQS.d.ts
CHANGED
|
@@ -166,15 +166,15 @@ export interface SQS {
|
|
|
166
166
|
/**
|
|
167
167
|
* @public
|
|
168
168
|
* <p>Welcome to the <i>Amazon SQS API Reference</i>.</p>
|
|
169
|
-
* <p>Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they
|
|
170
|
-
* between applications or microservices. Amazon SQS moves data between distributed
|
|
171
|
-
* components and helps you decouple these components.</p>
|
|
169
|
+
* <p>Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they
|
|
170
|
+
* travel between applications or microservices. Amazon SQS moves data between distributed
|
|
171
|
+
* application components and helps you decouple these components.</p>
|
|
172
172
|
* <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
|
|
173
173
|
* Guide.</i>
|
|
174
174
|
* </p>
|
|
175
|
-
* <p>You can use <a href="http://aws.amazon.com/tools/#sdk">Amazon Web Services
|
|
176
|
-
*
|
|
177
|
-
* following automatically:</p>
|
|
175
|
+
* <p>You can use <a href="http://aws.amazon.com/tools/#sdk">Amazon Web Services
|
|
176
|
+
* SDKs</a> to access Amazon SQS using your favorite programming language. The SDKs
|
|
177
|
+
* perform tasks such as the following automatically:</p>
|
|
178
178
|
* <ul>
|
|
179
179
|
* <li>
|
|
180
180
|
* <p>Cryptographically sign your service requests</p>
|
|
@@ -219,7 +219,8 @@ export interface SQS {
|
|
|
219
219
|
* </li>
|
|
220
220
|
* <li>
|
|
221
221
|
* <p>
|
|
222
|
-
* <a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line
|
|
222
|
+
* <a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line
|
|
223
|
+
* Interface</i>
|
|
223
224
|
* </a>
|
|
224
225
|
* </p>
|
|
225
226
|
* </li>
|
|
@@ -182,15 +182,15 @@ export interface SQSClientResolvedConfig extends SQSClientResolvedConfigType {
|
|
|
182
182
|
/**
|
|
183
183
|
* @public
|
|
184
184
|
* <p>Welcome to the <i>Amazon SQS API Reference</i>.</p>
|
|
185
|
-
* <p>Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they
|
|
186
|
-
* between applications or microservices. Amazon SQS moves data between distributed
|
|
187
|
-
* components and helps you decouple these components.</p>
|
|
185
|
+
* <p>Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they
|
|
186
|
+
* travel between applications or microservices. Amazon SQS moves data between distributed
|
|
187
|
+
* application components and helps you decouple these components.</p>
|
|
188
188
|
* <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
|
|
189
189
|
* Guide.</i>
|
|
190
190
|
* </p>
|
|
191
|
-
* <p>You can use <a href="http://aws.amazon.com/tools/#sdk">Amazon Web Services
|
|
192
|
-
*
|
|
193
|
-
* following automatically:</p>
|
|
191
|
+
* <p>You can use <a href="http://aws.amazon.com/tools/#sdk">Amazon Web Services
|
|
192
|
+
* SDKs</a> to access Amazon SQS using your favorite programming language. The SDKs
|
|
193
|
+
* perform tasks such as the following automatically:</p>
|
|
194
194
|
* <ul>
|
|
195
195
|
* <li>
|
|
196
196
|
* <p>Cryptographically sign your service requests</p>
|
|
@@ -235,7 +235,8 @@ export interface SQSClientResolvedConfig extends SQSClientResolvedConfigType {
|
|
|
235
235
|
* </li>
|
|
236
236
|
* <li>
|
|
237
237
|
* <p>
|
|
238
|
-
* <a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line
|
|
238
|
+
* <a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line
|
|
239
|
+
* Interface</i>
|
|
239
240
|
* </a>
|
|
240
241
|
* </p>
|
|
241
242
|
* </li>
|
|
@@ -27,8 +27,8 @@ export interface AddPermissionCommandOutput extends __MetadataBearer {
|
|
|
27
27
|
* access to the queue.</p>
|
|
28
28
|
* <p>When you create a queue, you have full control access rights for the queue. Only you,
|
|
29
29
|
* the owner of the queue, can grant or deny permissions to the queue. For more information
|
|
30
|
-
* 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
|
|
31
|
-
* Developer Guide</i>.</p>
|
|
30
|
+
* 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
|
|
31
|
+
* <i>Amazon SQS Developer Guide</i>.</p>
|
|
32
32
|
* <note>
|
|
33
33
|
* <ul>
|
|
34
34
|
* <li>
|
|
@@ -37,25 +37,29 @@ export interface AddPermissionCommandOutput extends __MetadataBearer {
|
|
|
37
37
|
* <code>
|
|
38
38
|
* <a>SetQueueAttributes</a>
|
|
39
39
|
* </code> to upload your
|
|
40
|
-
* 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
|
|
41
|
-
*
|
|
40
|
+
* 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
|
|
41
|
+
* Language</a> in the <i>Amazon SQS Developer
|
|
42
|
+
* Guide</i>.</p>
|
|
42
43
|
* </li>
|
|
43
44
|
* <li>
|
|
44
|
-
* <p>An Amazon SQS policy can have a maximum of seven actions per
|
|
45
|
+
* <p>An Amazon SQS policy can have a maximum of seven actions per
|
|
46
|
+
* statement.</p>
|
|
45
47
|
* </li>
|
|
46
48
|
* <li>
|
|
47
|
-
* <p>To remove the ability to change queue permissions, you must deny
|
|
49
|
+
* <p>To remove the ability to change queue permissions, you must deny
|
|
50
|
+
* permission to the <code>AddPermission</code>, <code>RemovePermission</code>,
|
|
51
|
+
* and <code>SetQueueAttributes</code> actions in your IAM policy.</p>
|
|
48
52
|
* </li>
|
|
49
53
|
* <li>
|
|
50
|
-
* <p>Amazon SQS <code>AddPermission</code> does not support adding a
|
|
51
|
-
* principal.</p>
|
|
54
|
+
* <p>Amazon SQS <code>AddPermission</code> does not support adding a
|
|
55
|
+
* non-account principal.</p>
|
|
52
56
|
* </li>
|
|
53
57
|
* </ul>
|
|
54
58
|
* </note>
|
|
55
59
|
* <note>
|
|
56
|
-
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
57
|
-
*
|
|
58
|
-
*
|
|
60
|
+
* <p>Cross-account permissions don't apply to this action. For more information, see
|
|
61
|
+
* <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 cross-account permissions to a role and a username</a> in the
|
|
62
|
+
* <i>Amazon SQS Developer Guide</i>.</p>
|
|
59
63
|
* </note>
|
|
60
64
|
* @example
|
|
61
65
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -85,12 +89,43 @@ export interface AddPermissionCommandOutput extends __MetadataBearer {
|
|
|
85
89
|
* @see {@link AddPermissionCommandOutput} for command's `response` shape.
|
|
86
90
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
87
91
|
*
|
|
92
|
+
* @throws {@link InvalidAddress} (client fault)
|
|
93
|
+
* <p>The <code>accountId</code> is invalid.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link InvalidSecurity} (client fault)
|
|
96
|
+
* <p>When the request to a queue is not HTTPS and SigV4.</p>
|
|
97
|
+
*
|
|
88
98
|
* @throws {@link OverLimit} (client fault)
|
|
89
99
|
* <p>The specified action violates a limit. For example, <code>ReceiveMessage</code>
|
|
90
100
|
* returns this error if the maximum number of in flight messages is reached and
|
|
91
101
|
* <code>AddPermission</code> returns this error if the maximum number of permissions
|
|
92
102
|
* for the queue is reached.</p>
|
|
93
103
|
*
|
|
104
|
+
* @throws {@link QueueDoesNotExist} (client fault)
|
|
105
|
+
* <p>The specified queue doesn't exist.</p>
|
|
106
|
+
*
|
|
107
|
+
* @throws {@link RequestThrottled} (client fault)
|
|
108
|
+
* <p>The request was denied due to request throttling.</p>
|
|
109
|
+
* <ul>
|
|
110
|
+
* <li>
|
|
111
|
+
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request quota for an
|
|
112
|
+
* account and Region. </p>
|
|
113
|
+
* </li>
|
|
114
|
+
* <li>
|
|
115
|
+
* <p>A burst or sustained high rate of requests to change the state of the same KMS
|
|
116
|
+
* key. This condition is often known as a "hot key."</p>
|
|
117
|
+
* </li>
|
|
118
|
+
* <li>
|
|
119
|
+
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
120
|
+
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
121
|
+
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
122
|
+
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
123
|
+
* </li>
|
|
124
|
+
* </ul>
|
|
125
|
+
*
|
|
126
|
+
* @throws {@link UnsupportedOperation} (client fault)
|
|
127
|
+
* <p>Error code 400. Unsupported operation.</p>
|
|
128
|
+
*
|
|
94
129
|
* @throws {@link SQSServiceException}
|
|
95
130
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
96
131
|
*
|
|
@@ -67,6 +67,31 @@ export interface CancelMessageMoveTaskCommandOutput extends CancelMessageMoveTas
|
|
|
67
67
|
* @see {@link CancelMessageMoveTaskCommandOutput} for command's `response` shape.
|
|
68
68
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
69
69
|
*
|
|
70
|
+
* @throws {@link InvalidAddress} (client fault)
|
|
71
|
+
* <p>The <code>accountId</code> is invalid.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link InvalidSecurity} (client fault)
|
|
74
|
+
* <p>When the request to a queue is not HTTPS and SigV4.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link RequestThrottled} (client fault)
|
|
77
|
+
* <p>The request was denied due to request throttling.</p>
|
|
78
|
+
* <ul>
|
|
79
|
+
* <li>
|
|
80
|
+
* <p>The rate of requests per second exceeds the Amazon Web Services 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
|
+
*
|
|
70
95
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
71
96
|
* <p>One or more specified resources don't exist.</p>
|
|
72
97
|
*
|
|
@@ -32,7 +32,9 @@ export interface ChangeMessageVisibilityBatchCommandOutput extends ChangeMessage
|
|
|
32
32
|
* </code> requests with each
|
|
33
33
|
* <code>ChangeMessageVisibilityBatch</code> action.</p>
|
|
34
34
|
* <important>
|
|
35
|
-
* <p>Because the batch request can result in a combination of successful and
|
|
35
|
+
* <p>Because the batch request can result in a combination of successful and
|
|
36
|
+
* unsuccessful actions, you should check for batch errors even when the call returns
|
|
37
|
+
* an HTTP status code of <code>200</code>.</p>
|
|
36
38
|
* </important>
|
|
37
39
|
* @example
|
|
38
40
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -82,13 +84,44 @@ export interface ChangeMessageVisibilityBatchCommandOutput extends ChangeMessage
|
|
|
82
84
|
* @throws {@link EmptyBatchRequest} (client fault)
|
|
83
85
|
* <p>The batch request doesn't contain any entries.</p>
|
|
84
86
|
*
|
|
87
|
+
* @throws {@link InvalidAddress} (client fault)
|
|
88
|
+
* <p>The <code>accountId</code> is invalid.</p>
|
|
89
|
+
*
|
|
85
90
|
* @throws {@link InvalidBatchEntryId} (client fault)
|
|
86
91
|
* <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the
|
|
87
92
|
* specification.</p>
|
|
88
93
|
*
|
|
94
|
+
* @throws {@link InvalidSecurity} (client fault)
|
|
95
|
+
* <p>When the request to a queue is not HTTPS and SigV4.</p>
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link QueueDoesNotExist} (client fault)
|
|
98
|
+
* <p>The specified queue doesn't exist.</p>
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link RequestThrottled} (client fault)
|
|
101
|
+
* <p>The request was denied due to request throttling.</p>
|
|
102
|
+
* <ul>
|
|
103
|
+
* <li>
|
|
104
|
+
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request quota for an
|
|
105
|
+
* account and Region. </p>
|
|
106
|
+
* </li>
|
|
107
|
+
* <li>
|
|
108
|
+
* <p>A burst or sustained high rate of requests to change the state of the same KMS
|
|
109
|
+
* key. This condition is often known as a "hot key."</p>
|
|
110
|
+
* </li>
|
|
111
|
+
* <li>
|
|
112
|
+
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
113
|
+
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
114
|
+
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
115
|
+
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
116
|
+
* </li>
|
|
117
|
+
* </ul>
|
|
118
|
+
*
|
|
89
119
|
* @throws {@link TooManyEntriesInBatchRequest} (client fault)
|
|
90
120
|
* <p>The batch request contains more entries than permissible.</p>
|
|
91
121
|
*
|
|
122
|
+
* @throws {@link UnsupportedOperation} (client fault)
|
|
123
|
+
* <p>Error code 400. Unsupported operation.</p>
|
|
124
|
+
*
|
|
92
125
|
* @throws {@link SQSServiceException}
|
|
93
126
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
94
127
|
*
|
|
@@ -46,14 +46,23 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer {
|
|
|
46
46
|
* <p>Deleted from the queue.</p>
|
|
47
47
|
* </li>
|
|
48
48
|
* </ol>
|
|
49
|
-
* <p>A message is considered to be <i>stored</i> after it is sent to a queue
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
*
|
|
56
|
-
*
|
|
49
|
+
* <p>A message is considered to be <i>stored</i> after it is sent to a queue
|
|
50
|
+
* by a producer, but not yet received from the queue by a consumer (that is, between
|
|
51
|
+
* states 1 and 2). There is no limit to the number of stored messages. A message is
|
|
52
|
+
* considered to be <i>in flight</i> after it is received from a queue by a
|
|
53
|
+
* consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is
|
|
54
|
+
* a limit to the number of in flight messages.</p>
|
|
55
|
+
* <p>Limits that apply to in flight messages are unrelated to the
|
|
56
|
+
* <i>unlimited</i> number of stored messages.</p>
|
|
57
|
+
* <p>For most standard queues (depending on queue traffic and message backlog), there can
|
|
58
|
+
* be a maximum of approximately 120,000 in flight messages (received from a queue by a
|
|
59
|
+
* consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS
|
|
60
|
+
* returns the <code>OverLimit</code> error message. To avoid reaching the limit, you
|
|
61
|
+
* should delete messages from the queue after they're processed. You can also increase the
|
|
62
|
+
* number of queues you use to process your messages. 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>
|
|
63
|
+
* <p>For FIFO queues, there can be a maximum of 20,000 in flight messages (received from a
|
|
64
|
+
* queue by a consumer, but not yet deleted from the queue). If you reach this limit,
|
|
65
|
+
* Amazon SQS returns no error messages.</p>
|
|
57
66
|
* <important>
|
|
58
67
|
* <p>If you attempt to set the <code>VisibilityTimeout</code> to a value greater than
|
|
59
68
|
* the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically
|
|
@@ -88,12 +97,43 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer {
|
|
|
88
97
|
* @see {@link ChangeMessageVisibilityCommandOutput} for command's `response` shape.
|
|
89
98
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
90
99
|
*
|
|
100
|
+
* @throws {@link InvalidAddress} (client fault)
|
|
101
|
+
* <p>The <code>accountId</code> is invalid.</p>
|
|
102
|
+
*
|
|
103
|
+
* @throws {@link InvalidSecurity} (client fault)
|
|
104
|
+
* <p>When the request to a queue is not HTTPS and SigV4.</p>
|
|
105
|
+
*
|
|
91
106
|
* @throws {@link MessageNotInflight} (client fault)
|
|
92
107
|
* <p>The specified message isn't in flight.</p>
|
|
93
108
|
*
|
|
109
|
+
* @throws {@link QueueDoesNotExist} (client fault)
|
|
110
|
+
* <p>The specified queue doesn't exist.</p>
|
|
111
|
+
*
|
|
94
112
|
* @throws {@link ReceiptHandleIsInvalid} (client fault)
|
|
95
113
|
* <p>The specified receipt handle isn't valid.</p>
|
|
96
114
|
*
|
|
115
|
+
* @throws {@link RequestThrottled} (client fault)
|
|
116
|
+
* <p>The request was denied due to request throttling.</p>
|
|
117
|
+
* <ul>
|
|
118
|
+
* <li>
|
|
119
|
+
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request quota for an
|
|
120
|
+
* account and Region. </p>
|
|
121
|
+
* </li>
|
|
122
|
+
* <li>
|
|
123
|
+
* <p>A burst or sustained high rate of requests to change the state of the same KMS
|
|
124
|
+
* key. This condition is often known as a "hot key."</p>
|
|
125
|
+
* </li>
|
|
126
|
+
* <li>
|
|
127
|
+
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
128
|
+
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
129
|
+
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
130
|
+
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
131
|
+
* </li>
|
|
132
|
+
* </ul>
|
|
133
|
+
*
|
|
134
|
+
* @throws {@link UnsupportedOperation} (client fault)
|
|
135
|
+
* <p>Error code 400. Unsupported operation.</p>
|
|
136
|
+
*
|
|
97
137
|
* @throws {@link SQSServiceException}
|
|
98
138
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
99
139
|
*
|
|
@@ -23,11 +23,12 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Creates a new standard or FIFO queue. You can pass one or more attributes in
|
|
27
|
-
*
|
|
26
|
+
* <p>Creates a new standard or FIFO queue. You can pass one or more attributes in the
|
|
27
|
+
* request. Keep the following in mind:</p>
|
|
28
28
|
* <ul>
|
|
29
29
|
* <li>
|
|
30
|
-
* <p>If you don't specify the <code>FifoQueue</code> attribute, Amazon SQS creates
|
|
30
|
+
* <p>If you don't specify the <code>FifoQueue</code> attribute, Amazon SQS creates
|
|
31
|
+
* a standard queue.</p>
|
|
31
32
|
* <note>
|
|
32
33
|
* <p>You can't change the queue type after you create it and you can't convert
|
|
33
34
|
* an existing standard queue into a FIFO queue. You must either create a new
|
|
@@ -71,9 +72,9 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB
|
|
|
71
72
|
* </li>
|
|
72
73
|
* </ul>
|
|
73
74
|
* <note>
|
|
74
|
-
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
75
|
-
*
|
|
76
|
-
*
|
|
75
|
+
* <p>Cross-account permissions don't apply to this action. For more information, see
|
|
76
|
+
* <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 cross-account permissions to a role and a username</a> in the
|
|
77
|
+
* <i>Amazon SQS Developer Guide</i>.</p>
|
|
77
78
|
* </note>
|
|
78
79
|
* @example
|
|
79
80
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -83,10 +84,10 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB
|
|
|
83
84
|
* const client = new SQSClient(config);
|
|
84
85
|
* const input = { // CreateQueueRequest
|
|
85
86
|
* QueueName: "STRING_VALUE", // required
|
|
86
|
-
*
|
|
87
|
+
* Attributes: { // QueueAttributeMap
|
|
87
88
|
* "<keys>": "STRING_VALUE",
|
|
88
89
|
* },
|
|
89
|
-
*
|
|
90
|
+
* tags: { // TagMap
|
|
90
91
|
* "<keys>": "STRING_VALUE",
|
|
91
92
|
* },
|
|
92
93
|
* };
|
|
@@ -104,13 +105,47 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB
|
|
|
104
105
|
* @see {@link CreateQueueCommandOutput} for command's `response` shape.
|
|
105
106
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
106
107
|
*
|
|
108
|
+
* @throws {@link InvalidAddress} (client fault)
|
|
109
|
+
* <p>The <code>accountId</code> is invalid.</p>
|
|
110
|
+
*
|
|
111
|
+
* @throws {@link InvalidAttributeName} (client fault)
|
|
112
|
+
* <p>The specified attribute doesn't exist.</p>
|
|
113
|
+
*
|
|
114
|
+
* @throws {@link InvalidAttributeValue} (client fault)
|
|
115
|
+
* <p>A queue attribute value is invalid.</p>
|
|
116
|
+
*
|
|
117
|
+
* @throws {@link InvalidSecurity} (client fault)
|
|
118
|
+
* <p>When the request to a queue is not HTTPS and SigV4.</p>
|
|
119
|
+
*
|
|
107
120
|
* @throws {@link QueueDeletedRecently} (client fault)
|
|
108
121
|
* <p>You must wait 60 seconds after deleting a queue before you can create another queue
|
|
109
122
|
* with the same name.</p>
|
|
110
123
|
*
|
|
111
124
|
* @throws {@link QueueNameExists} (client fault)
|
|
112
|
-
* <p>A queue with this name already exists. Amazon SQS returns this error only if the
|
|
113
|
-
* includes attributes whose values differ from those of the existing queue.</p>
|
|
125
|
+
* <p>A queue with this name already exists. Amazon SQS returns this error only if the
|
|
126
|
+
* request includes attributes whose values differ from those of the existing queue.</p>
|
|
127
|
+
*
|
|
128
|
+
* @throws {@link RequestThrottled} (client fault)
|
|
129
|
+
* <p>The request was denied due to request throttling.</p>
|
|
130
|
+
* <ul>
|
|
131
|
+
* <li>
|
|
132
|
+
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request quota for an
|
|
133
|
+
* account and Region. </p>
|
|
134
|
+
* </li>
|
|
135
|
+
* <li>
|
|
136
|
+
* <p>A burst or sustained high rate of requests to change the state of the same KMS
|
|
137
|
+
* key. This condition is often known as a "hot key."</p>
|
|
138
|
+
* </li>
|
|
139
|
+
* <li>
|
|
140
|
+
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
141
|
+
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
142
|
+
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
143
|
+
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
144
|
+
* </li>
|
|
145
|
+
* </ul>
|
|
146
|
+
*
|
|
147
|
+
* @throws {@link UnsupportedOperation} (client fault)
|
|
148
|
+
* <p>Error code 400. Unsupported operation.</p>
|
|
114
149
|
*
|
|
115
150
|
* @throws {@link SQSServiceException}
|
|
116
151
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
@@ -28,7 +28,9 @@ export interface DeleteMessageBatchCommandOutput extends DeleteMessageBatchResul
|
|
|
28
28
|
* <a>DeleteMessage</a>.</code> The result of the action on each
|
|
29
29
|
* message is reported individually in the response.</p>
|
|
30
30
|
* <important>
|
|
31
|
-
* <p>Because the batch request can result in a combination of successful and
|
|
31
|
+
* <p>Because the batch request can result in a combination of successful and
|
|
32
|
+
* unsuccessful actions, you should check for batch errors even when the call returns
|
|
33
|
+
* an HTTP status code of <code>200</code>.</p>
|
|
32
34
|
* </important>
|
|
33
35
|
* @example
|
|
34
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -77,13 +79,44 @@ export interface DeleteMessageBatchCommandOutput extends DeleteMessageBatchResul
|
|
|
77
79
|
* @throws {@link EmptyBatchRequest} (client fault)
|
|
78
80
|
* <p>The batch request doesn't contain any entries.</p>
|
|
79
81
|
*
|
|
82
|
+
* @throws {@link InvalidAddress} (client fault)
|
|
83
|
+
* <p>The <code>accountId</code> is invalid.</p>
|
|
84
|
+
*
|
|
80
85
|
* @throws {@link InvalidBatchEntryId} (client fault)
|
|
81
86
|
* <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the
|
|
82
87
|
* specification.</p>
|
|
83
88
|
*
|
|
89
|
+
* @throws {@link InvalidSecurity} (client fault)
|
|
90
|
+
* <p>When the request to a queue is not HTTPS and SigV4.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link QueueDoesNotExist} (client fault)
|
|
93
|
+
* <p>The specified queue doesn't exist.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link RequestThrottled} (client fault)
|
|
96
|
+
* <p>The request was denied due to request throttling.</p>
|
|
97
|
+
* <ul>
|
|
98
|
+
* <li>
|
|
99
|
+
* <p>The rate of requests per second exceeds the Amazon Web Services KMS request quota for an
|
|
100
|
+
* account and Region. </p>
|
|
101
|
+
* </li>
|
|
102
|
+
* <li>
|
|
103
|
+
* <p>A burst or sustained high rate of requests to change the state of the same KMS
|
|
104
|
+
* key. This condition is often known as a "hot key."</p>
|
|
105
|
+
* </li>
|
|
106
|
+
* <li>
|
|
107
|
+
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
108
|
+
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
109
|
+
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
110
|
+
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
111
|
+
* </li>
|
|
112
|
+
* </ul>
|
|
113
|
+
*
|
|
84
114
|
* @throws {@link TooManyEntriesInBatchRequest} (client fault)
|
|
85
115
|
* <p>The batch request contains more entries than permissible.</p>
|
|
86
116
|
*
|
|
117
|
+
* @throws {@link UnsupportedOperation} (client fault)
|
|
118
|
+
* <p>Error code 400. Unsupported operation.</p>
|
|
119
|
+
*
|
|
87
120
|
* @throws {@link SQSServiceException}
|
|
88
121
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
89
122
|
*
|
|
@@ -36,12 +36,12 @@ export interface DeleteMessageCommandOutput extends __MetadataBearer {
|
|
|
36
36
|
* When you use the <code>DeleteMessage</code> action, you must provide the most
|
|
37
37
|
* recently received <code>ReceiptHandle</code> for the message (otherwise, the request
|
|
38
38
|
* succeeds, but the message will not be deleted).</p>
|
|
39
|
-
* <p>For standard queues, it is possible to receive a message even after you
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
39
|
+
* <p>For standard queues, it is possible to receive a message even after you delete it.
|
|
40
|
+
* This might happen on rare occasions if one of the servers which stores a copy of the
|
|
41
|
+
* message is unavailable when you send the request to delete the message. The copy
|
|
42
|
+
* remains on the server and might be returned to you during a subsequent receive
|
|
43
|
+
* request. You should ensure that your application is idempotent, so that receiving a
|
|
44
|
+
* message more than once does not cause issues.</p>
|
|
45
45
|
* </note>
|
|
46
46
|
* @example
|
|
47
47
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -65,12 +65,43 @@ export interface DeleteMessageCommandOutput extends __MetadataBearer {
|
|
|
65
65
|
* @see {@link DeleteMessageCommandOutput} for command's `response` shape.
|
|
66
66
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
67
67
|
*
|
|
68
|
+
* @throws {@link InvalidAddress} (client fault)
|
|
69
|
+
* <p>The <code>accountId</code> is invalid.</p>
|
|
70
|
+
*
|
|
68
71
|
* @throws {@link InvalidIdFormat} (client fault)
|
|
69
72
|
* <p>The specified receipt handle isn't valid for the current version.</p>
|
|
70
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
|
+
*
|
|
71
80
|
* @throws {@link ReceiptHandleIsInvalid} (client fault)
|
|
72
81
|
* <p>The specified receipt handle isn't valid.</p>
|
|
73
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 Amazon Web Services 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>
|
|
101
|
+
*
|
|
102
|
+
* @throws {@link UnsupportedOperation} (client fault)
|
|
103
|
+
* <p>Error code 400. Unsupported operation.</p>
|
|
104
|
+
*
|
|
74
105
|
* @throws {@link SQSServiceException}
|
|
75
106
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
76
107
|
*
|
|
@@ -38,9 +38,9 @@ export interface DeleteQueueCommandOutput extends __MetadataBearer {
|
|
|
38
38
|
* <p>When you delete a queue, you must wait at least 60 seconds before creating a queue
|
|
39
39
|
* with the same name.</p>
|
|
40
40
|
* <note>
|
|
41
|
-
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
42
|
-
*
|
|
43
|
-
*
|
|
41
|
+
* <p>Cross-account permissions don't apply to this action. For more information, see
|
|
42
|
+
* <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 cross-account permissions to a role and a username</a> in the
|
|
43
|
+
* <i>Amazon SQS Developer Guide</i>.</p>
|
|
44
44
|
* <p>The delete operation uses the HTTP <code>GET</code> verb.</p>
|
|
45
45
|
* </note>
|
|
46
46
|
* @example
|
|
@@ -64,6 +64,37 @@ export interface DeleteQueueCommandOutput extends __MetadataBearer {
|
|
|
64
64
|
* @see {@link DeleteQueueCommandOutput} for command's `response` shape.
|
|
65
65
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
66
66
|
*
|
|
67
|
+
* @throws {@link InvalidAddress} (client fault)
|
|
68
|
+
* <p>The <code>accountId</code> is invalid.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link InvalidSecurity} (client fault)
|
|
71
|
+
* <p>When the request to a queue is not HTTPS and SigV4.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link QueueDoesNotExist} (client fault)
|
|
74
|
+
* <p>The specified queue doesn't exist.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link RequestThrottled} (client fault)
|
|
77
|
+
* <p>The request was denied due to request throttling.</p>
|
|
78
|
+
* <ul>
|
|
79
|
+
* <li>
|
|
80
|
+
* <p>The rate of requests per second exceeds the Amazon Web Services 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
|
+
*
|
|
67
98
|
* @throws {@link SQSServiceException}
|
|
68
99
|
* <p>Base exception class for all service exceptions from SQS service.</p>
|
|
69
100
|
*
|