@aws-sdk/client-sqs 3.569.0 → 3.574.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 +7 -8
- package/dist-cjs/index.js +7 -0
- package/dist-es/models/models_0.js +1 -0
- package/dist-es/protocols/Aws_json1_0.js +8 -0
- package/dist-types/SQS.d.ts +7 -8
- package/dist-types/SQSClient.d.ts +7 -8
- package/dist-types/commands/AddPermissionCommand.d.ts +11 -15
- package/dist-types/commands/CancelMessageMoveTaskCommand.d.ts +0 -3
- package/dist-types/commands/ChangeMessageVisibilityBatchCommand.d.ts +1 -3
- package/dist-types/commands/ChangeMessageVisibilityCommand.d.ts +8 -17
- package/dist-types/commands/CreateQueueCommand.d.ts +8 -9
- package/dist-types/commands/DeleteMessageBatchCommand.d.ts +1 -3
- package/dist-types/commands/DeleteMessageCommand.d.ts +6 -6
- package/dist-types/commands/DeleteQueueCommand.d.ts +3 -3
- package/dist-types/commands/GetQueueAttributesCommand.d.ts +1 -2
- package/dist-types/commands/GetQueueUrlCommand.d.ts +2 -2
- package/dist-types/commands/ListMessageMoveTasksCommand.d.ts +0 -3
- package/dist-types/commands/ListQueueTagsCommand.d.ts +6 -7
- package/dist-types/commands/ListQueuesCommand.d.ts +3 -3
- package/dist-types/commands/ReceiveMessageCommand.d.ts +9 -8
- package/dist-types/commands/RemovePermissionCommand.d.ts +4 -6
- package/dist-types/commands/SendMessageBatchCommand.d.ts +9 -16
- package/dist-types/commands/SendMessageCommand.d.ts +3 -8
- package/dist-types/commands/SetQueueAttributesCommand.d.ts +10 -14
- package/dist-types/commands/StartMessageMoveTaskCommand.d.ts +0 -4
- package/dist-types/commands/TagQueueCommand.d.ts +10 -13
- package/dist-types/commands/UntagQueueCommand.d.ts +5 -7
- package/dist-types/index.d.ts +7 -8
- package/dist-types/models/models_0.d.ts +420 -419
- package/dist-types/ts3.4/models/models_0.d.ts +11 -9
- package/package.json +8 -8
package/README.md
CHANGED
|
@@ -7,15 +7,15 @@
|
|
|
7
7
|
AWS SDK for JavaScript SQS Client for Node.js, Browser and React Native.
|
|
8
8
|
|
|
9
9
|
<p>Welcome to the <i>Amazon SQS API Reference</i>.</p>
|
|
10
|
-
<p>Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they
|
|
11
|
-
|
|
12
|
-
|
|
10
|
+
<p>Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel
|
|
11
|
+
between applications or microservices. Amazon SQS moves data between distributed application
|
|
12
|
+
components and helps you decouple these components.</p>
|
|
13
13
|
<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
|
|
14
14
|
Guide.</i>
|
|
15
15
|
</p>
|
|
16
|
-
<p>You can use <a href="http://aws.amazon.com/tools/#sdk">Amazon Web Services
|
|
17
|
-
|
|
18
|
-
|
|
16
|
+
<p>You can use <a href="http://aws.amazon.com/tools/#sdk">Amazon Web Services SDKs</a> to access
|
|
17
|
+
Amazon SQS using your favorite programming language. The SDKs perform tasks such as the
|
|
18
|
+
following automatically:</p>
|
|
19
19
|
<ul>
|
|
20
20
|
<li>
|
|
21
21
|
<p>Cryptographically sign your service requests</p>
|
|
@@ -60,8 +60,7 @@ perform tasks such as the following automatically:</p>
|
|
|
60
60
|
</li>
|
|
61
61
|
<li>
|
|
62
62
|
<p>
|
|
63
|
-
<a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line
|
|
64
|
-
Interface</i>
|
|
63
|
+
<a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line Interface</i>
|
|
65
64
|
</a>
|
|
66
65
|
</p>
|
|
67
66
|
</li>
|
package/dist-cjs/index.js
CHANGED
|
@@ -727,6 +727,7 @@ __name(_KmsThrottled, "KmsThrottled");
|
|
|
727
727
|
var KmsThrottled = _KmsThrottled;
|
|
728
728
|
var MessageSystemAttributeName = {
|
|
729
729
|
AWSTraceHeader: "AWSTraceHeader",
|
|
730
|
+
All: "All",
|
|
730
731
|
ApproximateFirstReceiveTimestamp: "ApproximateFirstReceiveTimestamp",
|
|
731
732
|
ApproximateReceiveCount: "ApproximateReceiveCount",
|
|
732
733
|
DeadLetterQueueSourceArn: "DeadLetterQueueSourceArn",
|
|
@@ -1703,6 +1704,11 @@ var se_MessageBodySystemAttributeMap = /* @__PURE__ */ __name((input, context) =
|
|
|
1703
1704
|
{}
|
|
1704
1705
|
);
|
|
1705
1706
|
}, "se_MessageBodySystemAttributeMap");
|
|
1707
|
+
var se_MessageSystemAttributeList = /* @__PURE__ */ __name((input, context) => {
|
|
1708
|
+
return input.filter((e) => e != null).map((entry) => {
|
|
1709
|
+
return (0, import_core2._toStr)(entry);
|
|
1710
|
+
});
|
|
1711
|
+
}, "se_MessageSystemAttributeList");
|
|
1706
1712
|
var se_MessageSystemAttributeValue = /* @__PURE__ */ __name((input, context) => {
|
|
1707
1713
|
return (0, import_smithy_client.take)(input, {
|
|
1708
1714
|
BinaryListValues: (_) => se_BinaryList(_, context),
|
|
@@ -1731,6 +1737,7 @@ var se_ReceiveMessageRequest = /* @__PURE__ */ __name((input, context) => {
|
|
|
1731
1737
|
AttributeNames: (_) => se_AttributeNameList(_, context),
|
|
1732
1738
|
MaxNumberOfMessages: import_core2._toNum,
|
|
1733
1739
|
MessageAttributeNames: (_) => se_MessageAttributeNameList(_, context),
|
|
1740
|
+
MessageSystemAttributeNames: (_) => se_MessageSystemAttributeList(_, context),
|
|
1734
1741
|
QueueUrl: import_core2._toStr,
|
|
1735
1742
|
ReceiveRequestAttemptId: import_core2._toStr,
|
|
1736
1743
|
VisibilityTimeout: import_core2._toNum,
|
|
@@ -337,6 +337,7 @@ export class KmsThrottled extends __BaseException {
|
|
|
337
337
|
}
|
|
338
338
|
export const MessageSystemAttributeName = {
|
|
339
339
|
AWSTraceHeader: "AWSTraceHeader",
|
|
340
|
+
All: "All",
|
|
340
341
|
ApproximateFirstReceiveTimestamp: "ApproximateFirstReceiveTimestamp",
|
|
341
342
|
ApproximateReceiveCount: "ApproximateReceiveCount",
|
|
342
343
|
DeadLetterQueueSourceArn: "DeadLetterQueueSourceArn",
|
|
@@ -942,6 +942,13 @@ const se_MessageBodySystemAttributeMap = (input, context) => {
|
|
|
942
942
|
return acc;
|
|
943
943
|
}, {});
|
|
944
944
|
};
|
|
945
|
+
const se_MessageSystemAttributeList = (input, context) => {
|
|
946
|
+
return input
|
|
947
|
+
.filter((e) => e != null)
|
|
948
|
+
.map((entry) => {
|
|
949
|
+
return _toStr(entry);
|
|
950
|
+
});
|
|
951
|
+
};
|
|
945
952
|
const se_MessageSystemAttributeValue = (input, context) => {
|
|
946
953
|
return take(input, {
|
|
947
954
|
BinaryListValues: (_) => se_BinaryList(_, context),
|
|
@@ -970,6 +977,7 @@ const se_ReceiveMessageRequest = (input, context) => {
|
|
|
970
977
|
AttributeNames: (_) => se_AttributeNameList(_, context),
|
|
971
978
|
MaxNumberOfMessages: _toNum,
|
|
972
979
|
MessageAttributeNames: (_) => se_MessageAttributeNameList(_, context),
|
|
980
|
+
MessageSystemAttributeNames: (_) => se_MessageSystemAttributeList(_, context),
|
|
973
981
|
QueueUrl: _toStr,
|
|
974
982
|
ReceiveRequestAttemptId: _toStr,
|
|
975
983
|
VisibilityTimeout: _toNum,
|
package/dist-types/SQS.d.ts
CHANGED
|
@@ -166,15 +166,15 @@ export interface SQS {
|
|
|
166
166
|
}
|
|
167
167
|
/**
|
|
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
|
-
*
|
|
171
|
-
*
|
|
169
|
+
* <p>Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel
|
|
170
|
+
* between applications or microservices. Amazon SQS moves data between distributed application
|
|
171
|
+
* 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
|
-
*
|
|
175
|
+
* <p>You can use <a href="http://aws.amazon.com/tools/#sdk">Amazon Web Services SDKs</a> to access
|
|
176
|
+
* Amazon SQS using your favorite programming language. The SDKs perform tasks such as the
|
|
177
|
+
* following automatically:</p>
|
|
178
178
|
* <ul>
|
|
179
179
|
* <li>
|
|
180
180
|
* <p>Cryptographically sign your service requests</p>
|
|
@@ -219,8 +219,7 @@ 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
|
|
223
|
-
* Interface</i>
|
|
222
|
+
* <a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line Interface</i>
|
|
224
223
|
* </a>
|
|
225
224
|
* </p>
|
|
226
225
|
* </li>
|
|
@@ -181,15 +181,15 @@ export interface SQSClientResolvedConfig extends SQSClientResolvedConfigType {
|
|
|
181
181
|
}
|
|
182
182
|
/**
|
|
183
183
|
* <p>Welcome to the <i>Amazon SQS API Reference</i>.</p>
|
|
184
|
-
* <p>Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they
|
|
185
|
-
*
|
|
186
|
-
*
|
|
184
|
+
* <p>Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel
|
|
185
|
+
* between applications or microservices. Amazon SQS moves data between distributed application
|
|
186
|
+
* components and helps you decouple these components.</p>
|
|
187
187
|
* <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
|
|
188
188
|
* Guide.</i>
|
|
189
189
|
* </p>
|
|
190
|
-
* <p>You can use <a href="http://aws.amazon.com/tools/#sdk">Amazon Web Services
|
|
191
|
-
*
|
|
192
|
-
*
|
|
190
|
+
* <p>You can use <a href="http://aws.amazon.com/tools/#sdk">Amazon Web Services SDKs</a> to access
|
|
191
|
+
* Amazon SQS using your favorite programming language. The SDKs perform tasks such as the
|
|
192
|
+
* following automatically:</p>
|
|
193
193
|
* <ul>
|
|
194
194
|
* <li>
|
|
195
195
|
* <p>Cryptographically sign your service requests</p>
|
|
@@ -234,8 +234,7 @@ export interface SQSClientResolvedConfig extends SQSClientResolvedConfigType {
|
|
|
234
234
|
* </li>
|
|
235
235
|
* <li>
|
|
236
236
|
* <p>
|
|
237
|
-
* <a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line
|
|
238
|
-
* Interface</i>
|
|
237
|
+
* <a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line Interface</i>
|
|
239
238
|
* </a>
|
|
240
239
|
* </p>
|
|
241
240
|
* </li>
|
|
@@ -30,8 +30,8 @@ declare const AddPermissionCommand_base: {
|
|
|
30
30
|
* access to the queue.</p>
|
|
31
31
|
* <p>When you create a queue, you have full control access rights for the queue. Only you,
|
|
32
32
|
* the owner of the queue, can grant or deny permissions to the queue. For more information
|
|
33
|
-
* 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
|
|
34
|
-
*
|
|
33
|
+
* 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
|
|
34
|
+
* Developer Guide</i>.</p>
|
|
35
35
|
* <note>
|
|
36
36
|
* <ul>
|
|
37
37
|
* <li>
|
|
@@ -40,29 +40,25 @@ declare const AddPermissionCommand_base: {
|
|
|
40
40
|
* <code>
|
|
41
41
|
* <a>SetQueueAttributes</a>
|
|
42
42
|
* </code> to upload your
|
|
43
|
-
* 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
|
|
44
|
-
*
|
|
45
|
-
* Guide</i>.</p>
|
|
43
|
+
* 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
|
|
44
|
+
* the <i>Amazon SQS Developer Guide</i>.</p>
|
|
46
45
|
* </li>
|
|
47
46
|
* <li>
|
|
48
|
-
* <p>An Amazon SQS policy can have a maximum of seven actions per
|
|
49
|
-
* statement.</p>
|
|
47
|
+
* <p>An Amazon SQS policy can have a maximum of seven actions per statement.</p>
|
|
50
48
|
* </li>
|
|
51
49
|
* <li>
|
|
52
|
-
* <p>To remove the ability to change queue permissions, you must deny
|
|
53
|
-
* permission to the <code>AddPermission</code>, <code>RemovePermission</code>,
|
|
54
|
-
* and <code>SetQueueAttributes</code> actions in your IAM policy.</p>
|
|
50
|
+
* <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>
|
|
55
51
|
* </li>
|
|
56
52
|
* <li>
|
|
57
|
-
* <p>Amazon SQS <code>AddPermission</code> does not support adding a
|
|
58
|
-
*
|
|
53
|
+
* <p>Amazon SQS <code>AddPermission</code> does not support adding a non-account
|
|
54
|
+
* principal.</p>
|
|
59
55
|
* </li>
|
|
60
56
|
* </ul>
|
|
61
57
|
* </note>
|
|
62
58
|
* <note>
|
|
63
|
-
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
64
|
-
*
|
|
65
|
-
*
|
|
59
|
+
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
60
|
+
* 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
|
|
61
|
+
* cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
66
62
|
* </note>
|
|
67
63
|
* @example
|
|
68
64
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -39,9 +39,6 @@ declare const CancelMessageMoveTaskCommand_base: {
|
|
|
39
39
|
* dead-letter-queue), or a custom destination queue. </p>
|
|
40
40
|
* </li>
|
|
41
41
|
* <li>
|
|
42
|
-
* <p>Currently, only standard queues are supported.</p>
|
|
43
|
-
* </li>
|
|
44
|
-
* <li>
|
|
45
42
|
* <p>Only one active message movement task is supported per queue at any given
|
|
46
43
|
* time.</p>
|
|
47
44
|
* </li>
|
|
@@ -35,9 +35,7 @@ declare const ChangeMessageVisibilityBatchCommand_base: {
|
|
|
35
35
|
* </code> requests with each
|
|
36
36
|
* <code>ChangeMessageVisibilityBatch</code> action.</p>
|
|
37
37
|
* <important>
|
|
38
|
-
* <p>Because the batch request can result in a combination of successful and
|
|
39
|
-
* unsuccessful actions, you should check for batch errors even when the call returns
|
|
40
|
-
* an HTTP status code of <code>200</code>.</p>
|
|
38
|
+
* <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>
|
|
41
39
|
* </important>
|
|
42
40
|
* @example
|
|
43
41
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -49,23 +49,14 @@ declare const ChangeMessageVisibilityCommand_base: {
|
|
|
49
49
|
* <p>Deleted from the queue.</p>
|
|
50
50
|
* </li>
|
|
51
51
|
* </ol>
|
|
52
|
-
* <p>A message is considered to be <i>stored</i> after it is sent to a queue
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
* <p>For most standard queues (depending on queue traffic and message backlog), there can
|
|
61
|
-
* be a maximum of approximately 120,000 in flight messages (received from a queue by a
|
|
62
|
-
* consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS
|
|
63
|
-
* returns the <code>OverLimit</code> error message. To avoid reaching the limit, you
|
|
64
|
-
* should delete messages from the queue after they're processed. You can also increase the
|
|
65
|
-
* 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>
|
|
66
|
-
* <p>For FIFO queues, there can be a maximum of 20,000 in flight messages (received from a
|
|
67
|
-
* queue by a consumer, but not yet deleted from the queue). If you reach this limit,
|
|
68
|
-
* Amazon SQS returns no error messages.</p>
|
|
52
|
+
* <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.
|
|
53
|
+
* 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>
|
|
54
|
+
* <p>Limits that apply to in flight messages are unrelated to the <i>unlimited</i> number of stored messages.</p>
|
|
55
|
+
* <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).
|
|
56
|
+
* If you reach this limit, Amazon SQS returns the <code>OverLimit</code> error message.
|
|
57
|
+
* 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.
|
|
58
|
+
* 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>
|
|
59
|
+
* <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>
|
|
69
60
|
* <important>
|
|
70
61
|
* <p>If you attempt to set the <code>VisibilityTimeout</code> to a value greater than
|
|
71
62
|
* the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically
|
|
@@ -26,12 +26,11 @@ declare const CreateQueueCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Creates a new standard or FIFO queue. You can pass one or more attributes in
|
|
30
|
-
* request. Keep the following in mind:</p>
|
|
29
|
+
* <p>Creates a new standard or FIFO queue. You can pass one or more attributes in
|
|
30
|
+
* the request. Keep the following in mind:</p>
|
|
31
31
|
* <ul>
|
|
32
32
|
* <li>
|
|
33
|
-
* <p>If you don't specify the <code>FifoQueue</code> attribute, Amazon SQS creates
|
|
34
|
-
* a standard queue.</p>
|
|
33
|
+
* <p>If you don't specify the <code>FifoQueue</code> attribute, Amazon SQS creates a standard queue.</p>
|
|
35
34
|
* <note>
|
|
36
35
|
* <p>You can't change the queue type after you create it and you can't convert
|
|
37
36
|
* an existing standard queue into a FIFO queue. You must either create a new
|
|
@@ -75,9 +74,9 @@ declare const CreateQueueCommand_base: {
|
|
|
75
74
|
* </li>
|
|
76
75
|
* </ul>
|
|
77
76
|
* <note>
|
|
78
|
-
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
79
|
-
*
|
|
80
|
-
*
|
|
77
|
+
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
78
|
+
* 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
|
|
79
|
+
* cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
81
80
|
* </note>
|
|
82
81
|
* @example
|
|
83
82
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -125,8 +124,8 @@ declare const CreateQueueCommand_base: {
|
|
|
125
124
|
* with the same name.</p>
|
|
126
125
|
*
|
|
127
126
|
* @throws {@link QueueNameExists} (client fault)
|
|
128
|
-
* <p>A queue with this name already exists. Amazon SQS returns this error only if the
|
|
129
|
-
*
|
|
127
|
+
* <p>A queue with this name already exists. Amazon SQS returns this error only if the request
|
|
128
|
+
* includes attributes whose values differ from those of the existing queue.</p>
|
|
130
129
|
*
|
|
131
130
|
* @throws {@link RequestThrottled} (client fault)
|
|
132
131
|
* <p>The request was denied due to request throttling.</p>
|
|
@@ -31,9 +31,7 @@ declare const DeleteMessageBatchCommand_base: {
|
|
|
31
31
|
* <a>DeleteMessage</a>.</code> The result of the action on each
|
|
32
32
|
* message is reported individually in the response.</p>
|
|
33
33
|
* <important>
|
|
34
|
-
* <p>Because the batch request can result in a combination of successful and
|
|
35
|
-
* unsuccessful actions, you should check for batch errors even when the call returns
|
|
36
|
-
* an HTTP status code of <code>200</code>.</p>
|
|
34
|
+
* <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>
|
|
37
35
|
* </important>
|
|
38
36
|
* @example
|
|
39
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -39,12 +39,12 @@ declare const DeleteMessageCommand_base: {
|
|
|
39
39
|
* When you use the <code>DeleteMessage</code> action, you must provide the most
|
|
40
40
|
* recently received <code>ReceiptHandle</code> for the message (otherwise, the request
|
|
41
41
|
* succeeds, but the message will not be deleted).</p>
|
|
42
|
-
* <p>For standard queues, it is possible to receive a message even after you
|
|
43
|
-
* This might happen on rare occasions if one of the servers which stores a
|
|
44
|
-
* message is unavailable when you send the request to delete the message.
|
|
45
|
-
* remains on the server and might be returned to you during a subsequent
|
|
46
|
-
* request. You should ensure that your application is idempotent, so that
|
|
47
|
-
* message more than once does not cause issues.</p>
|
|
42
|
+
* <p>For standard queues, it is possible to receive a message even after you
|
|
43
|
+
* delete it. This might happen on rare occasions if one of the servers which stores a
|
|
44
|
+
* copy of the message is unavailable when you send the request to delete the message.
|
|
45
|
+
* The copy remains on the server and might be returned to you during a subsequent
|
|
46
|
+
* receive request. You should ensure that your application is idempotent, so that
|
|
47
|
+
* receiving a message more than once does not cause issues.</p>
|
|
48
48
|
* </note>
|
|
49
49
|
* @example
|
|
50
50
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -41,9 +41,9 @@ declare const DeleteQueueCommand_base: {
|
|
|
41
41
|
* <p>When you delete a queue, you must wait at least 60 seconds before creating a queue
|
|
42
42
|
* with the same name.</p>
|
|
43
43
|
* <note>
|
|
44
|
-
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
45
|
-
*
|
|
46
|
-
*
|
|
44
|
+
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
45
|
+
* see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name">Grant
|
|
46
|
+
* cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
47
47
|
* <p>The delete operation uses the HTTP <code>GET</code> verb.</p>
|
|
48
48
|
* </note>
|
|
49
49
|
* @example
|
|
@@ -28,8 +28,7 @@ declare const GetQueueAttributesCommand_base: {
|
|
|
28
28
|
/**
|
|
29
29
|
* <p>Gets attributes for the specified queue.</p>
|
|
30
30
|
* <note>
|
|
31
|
-
* <p>To determine whether a queue is <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO</a>, you can check whether <code>QueueName</code> ends with the
|
|
32
|
-
* <code>.fifo</code> suffix.</p>
|
|
31
|
+
* <p>To determine whether a queue is <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO</a>, you can check whether <code>QueueName</code> ends with the <code>.fifo</code> suffix.</p>
|
|
33
32
|
* </note>
|
|
34
33
|
* @example
|
|
35
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -33,8 +33,8 @@ declare const GetQueueUrlCommand_base: {
|
|
|
33
33
|
* information about shared queue access, see <code>
|
|
34
34
|
* <a>AddPermission</a>
|
|
35
35
|
* </code>
|
|
36
|
-
* or 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
|
|
37
|
-
*
|
|
36
|
+
* or 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
|
|
37
|
+
* Developer Guide</i>. </p>
|
|
38
38
|
* @example
|
|
39
39
|
* Use a bare-bones client and the command you need to make an API call.
|
|
40
40
|
* ```javascript
|
|
@@ -37,9 +37,6 @@ declare const ListMessageMoveTasksCommand_base: {
|
|
|
37
37
|
* dead-letter-queue), or a custom destination queue. </p>
|
|
38
38
|
* </li>
|
|
39
39
|
* <li>
|
|
40
|
-
* <p>Currently, only standard queues are supported.</p>
|
|
41
|
-
* </li>
|
|
42
|
-
* <li>
|
|
43
40
|
* <p>Only one active message movement task is supported per queue at any given
|
|
44
41
|
* time.</p>
|
|
45
42
|
* </li>
|
|
@@ -26,14 +26,13 @@ declare const ListQueueTagsCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>List all cost allocation tags added to the specified Amazon SQS queue.
|
|
30
|
-
* overview, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html">Tagging
|
|
31
|
-
*
|
|
32
|
-
* Guide</i>.</p>
|
|
29
|
+
* <p>List all cost allocation tags added to the specified Amazon SQS queue.
|
|
30
|
+
* For an overview, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html">Tagging
|
|
31
|
+
* Your Amazon SQS Queues</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
33
32
|
* <note>
|
|
34
|
-
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
35
|
-
*
|
|
36
|
-
*
|
|
33
|
+
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
34
|
+
* 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
|
|
35
|
+
* cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
37
36
|
* </note>
|
|
38
37
|
* @example
|
|
39
38
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -38,9 +38,9 @@ declare const ListQueuesCommand_base: {
|
|
|
38
38
|
* Use <code>NextToken</code> as a parameter in your next request to
|
|
39
39
|
* <code>listQueues</code> to receive the next page of results. </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,
|
|
42
|
+
* 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
|
|
43
|
+
* cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
44
44
|
* </note>
|
|
45
45
|
* @example
|
|
46
46
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -28,8 +28,8 @@ declare const ReceiveMessageCommand_base: {
|
|
|
28
28
|
/**
|
|
29
29
|
* <p>Retrieves one or more messages (up to 10), from the specified queue. Using the
|
|
30
30
|
* <code>WaitTimeSeconds</code> parameter enables long-poll support. For more
|
|
31
|
-
* information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html">Amazon
|
|
32
|
-
*
|
|
31
|
+
* information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html">Amazon SQS
|
|
32
|
+
* Long Polling</a> in the <i>Amazon SQS Developer Guide</i>. </p>
|
|
33
33
|
* <p>Short poll is the default behavior where a weighted random set of machines is sampled
|
|
34
34
|
* on a <code>ReceiveMessage</code> call. Thus, only the messages on the sampled machines
|
|
35
35
|
* are returned. If the number of messages in the queue is small (fewer than 1,000), you
|
|
@@ -63,17 +63,15 @@ declare const ReceiveMessageCommand_base: {
|
|
|
63
63
|
* more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html">Queue and Message Identifiers</a> in the <i>Amazon SQS Developer
|
|
64
64
|
* Guide</i>.</p>
|
|
65
65
|
* <p>You can provide the <code>VisibilityTimeout</code> parameter in your request. The
|
|
66
|
-
* parameter is applied to the messages that Amazon SQS returns in the response. If you
|
|
67
|
-
*
|
|
68
|
-
*
|
|
66
|
+
* parameter is applied to the messages that Amazon SQS returns in the response. If you don't
|
|
67
|
+
* include the parameter, the overall visibility timeout for the queue is used for the
|
|
68
|
+
* returned messages. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility Timeout</a> in the <i>Amazon SQS Developer
|
|
69
69
|
* Guide</i>.</p>
|
|
70
70
|
* <p>A message that isn't deleted or a message whose visibility isn't extended before the
|
|
71
71
|
* visibility timeout expires counts as a failed receive. Depending on the configuration of
|
|
72
72
|
* the queue, the message might be sent to the dead-letter queue.</p>
|
|
73
73
|
* <note>
|
|
74
|
-
* <p>In the future, new attributes might be added. If you write code that calls this
|
|
75
|
-
* action, we recommend that you structure your code so that it can handle new
|
|
76
|
-
* attributes gracefully.</p>
|
|
74
|
+
* <p>In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.</p>
|
|
77
75
|
* </note>
|
|
78
76
|
* @example
|
|
79
77
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -86,6 +84,9 @@ declare const ReceiveMessageCommand_base: {
|
|
|
86
84
|
* AttributeNames: [ // AttributeNameList
|
|
87
85
|
* "All" || "Policy" || "VisibilityTimeout" || "MaximumMessageSize" || "MessageRetentionPeriod" || "ApproximateNumberOfMessages" || "ApproximateNumberOfMessagesNotVisible" || "CreatedTimestamp" || "LastModifiedTimestamp" || "QueueArn" || "ApproximateNumberOfMessagesDelayed" || "DelaySeconds" || "ReceiveMessageWaitTimeSeconds" || "RedrivePolicy" || "FifoQueue" || "ContentBasedDeduplication" || "KmsMasterKeyId" || "KmsDataKeyReusePeriodSeconds" || "DeduplicationScope" || "FifoThroughputLimit" || "RedriveAllowPolicy" || "SqsManagedSseEnabled",
|
|
88
86
|
* ],
|
|
87
|
+
* MessageSystemAttributeNames: [ // MessageSystemAttributeList
|
|
88
|
+
* "All" || "SenderId" || "SentTimestamp" || "ApproximateReceiveCount" || "ApproximateFirstReceiveTimestamp" || "SequenceNumber" || "MessageDeduplicationId" || "MessageGroupId" || "AWSTraceHeader" || "DeadLetterQueueSourceArn",
|
|
89
|
+
* ],
|
|
89
90
|
* MessageAttributeNames: [ // MessageAttributeNameList
|
|
90
91
|
* "STRING_VALUE",
|
|
91
92
|
* ],
|
|
@@ -34,14 +34,12 @@ declare const RemovePermissionCommand_base: {
|
|
|
34
34
|
* <p>Only the owner of a queue can remove permissions from it.</p>
|
|
35
35
|
* </li>
|
|
36
36
|
* <li>
|
|
37
|
-
* <p>Cross-account permissions don't apply to this action. For more
|
|
38
|
-
*
|
|
39
|
-
*
|
|
37
|
+
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
38
|
+
* 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
|
|
39
|
+
* cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
40
40
|
* </li>
|
|
41
41
|
* <li>
|
|
42
|
-
* <p>To remove the ability to change queue permissions, you must deny
|
|
43
|
-
* permission to the <code>AddPermission</code>, <code>RemovePermission</code>,
|
|
44
|
-
* and <code>SetQueueAttributes</code> actions in your IAM policy.</p>
|
|
42
|
+
* <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>
|
|
45
43
|
* </li>
|
|
46
44
|
* </ul>
|
|
47
45
|
* </note>
|
|
@@ -29,29 +29,22 @@ declare const SendMessageBatchCommand_base: {
|
|
|
29
29
|
* <p>You can use <code>SendMessageBatch</code> to send up to 10 messages to the specified
|
|
30
30
|
* queue by assigning either identical or different values to each message (or by not
|
|
31
31
|
* assigning values at all). This is a batch version of <code>
|
|
32
|
-
* <a>SendMessage</a>.</code> For a FIFO queue, multiple messages within a single batch are enqueued
|
|
33
|
-
* the order they are sent.</p>
|
|
34
|
-
* <p>The result of sending each message is reported individually in the response.
|
|
35
|
-
* the batch request can result in a combination of successful and unsuccessful actions,
|
|
36
|
-
* you should check for batch errors even when the call returns an HTTP status code of
|
|
37
|
-
* <code>200</code>.</p>
|
|
32
|
+
* <a>SendMessage</a>.</code> For a FIFO queue, multiple messages within a single batch are enqueued
|
|
33
|
+
* in the order they are sent.</p>
|
|
34
|
+
* <p>The result of sending each message is reported individually in the response.
|
|
35
|
+
* 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>
|
|
38
36
|
* <p>The maximum allowed individual message size and the maximum total payload size (the
|
|
39
37
|
* sum of the individual lengths of all of the batched messages) are both 256 KiB (262,144
|
|
40
38
|
* bytes).</p>
|
|
41
39
|
* <important>
|
|
42
|
-
* <p>A message can include only XML, JSON, and unformatted text. The following Unicode
|
|
43
|
-
* characters are allowed:</p>
|
|
40
|
+
* <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:</p>
|
|
44
41
|
* <p>
|
|
45
|
-
* <code>#x9</code> | <code>#xA</code> | <code>#xD</code> | <code>#x20</code> to
|
|
46
|
-
* <code>#xD7FF</code> | <code>#xE000</code> to <code>#xFFFD</code> |
|
|
47
|
-
* <code>#x10000</code> to <code>#x10FFFF</code>
|
|
42
|
+
* <code>#x9</code> | <code>#xA</code> | <code>#xD</code> | <code>#x20</code> to <code>#xD7FF</code> | <code>#xE000</code> to <code>#xFFFD</code> | <code>#x10000</code> to <code>#x10FFFF</code>
|
|
48
43
|
* </p>
|
|
49
|
-
* <p>Any characters not included in this list will be rejected. For more information,
|
|
50
|
-
* see the <a href="http://www.w3.org/TR/REC-xml/#charsets">W3C specification for
|
|
51
|
-
* characters</a>.</p>
|
|
44
|
+
* <p>Any characters not included in this list will be rejected. For more information, see the <a href="http://www.w3.org/TR/REC-xml/#charsets">W3C specification for characters</a>.</p>
|
|
52
45
|
* </important>
|
|
53
|
-
* <p>If you don't specify the <code>DelaySeconds</code> parameter for an entry, Amazon SQS
|
|
54
|
-
*
|
|
46
|
+
* <p>If you don't specify the <code>DelaySeconds</code> parameter for an entry, Amazon SQS uses
|
|
47
|
+
* the default value for the queue.</p>
|
|
55
48
|
* @example
|
|
56
49
|
* Use a bare-bones client and the command you need to make an API call.
|
|
57
50
|
* ```javascript
|
|
@@ -28,16 +28,11 @@ declare const SendMessageCommand_base: {
|
|
|
28
28
|
/**
|
|
29
29
|
* <p>Delivers a message to the specified queue.</p>
|
|
30
30
|
* <important>
|
|
31
|
-
* <p>A message can include only XML, JSON, and unformatted text. The following Unicode
|
|
32
|
-
* characters are allowed:</p>
|
|
31
|
+
* <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:</p>
|
|
33
32
|
* <p>
|
|
34
|
-
* <code>#x9</code> | <code>#xA</code> | <code>#xD</code> | <code>#x20</code> to
|
|
35
|
-
* <code>#xD7FF</code> | <code>#xE000</code> to <code>#xFFFD</code> |
|
|
36
|
-
* <code>#x10000</code> to <code>#x10FFFF</code>
|
|
33
|
+
* <code>#x9</code> | <code>#xA</code> | <code>#xD</code> | <code>#x20</code> to <code>#xD7FF</code> | <code>#xE000</code> to <code>#xFFFD</code> | <code>#x10000</code> to <code>#x10FFFF</code>
|
|
37
34
|
* </p>
|
|
38
|
-
* <p>Any characters not included in this list will be rejected. For more information,
|
|
39
|
-
* see the <a href="http://www.w3.org/TR/REC-xml/#charsets">W3C specification for
|
|
40
|
-
* characters</a>.</p>
|
|
35
|
+
* <p>Any characters not included in this list will be rejected. For more information, see the <a href="http://www.w3.org/TR/REC-xml/#charsets">W3C specification for characters</a>.</p>
|
|
41
36
|
* </important>
|
|
42
37
|
* @example
|
|
43
38
|
* Use a bare-bones client and the command you need to make an API call.
|