Skip to content

Commit 35284e8

Browse files
author
awstools
committed
feat(client-sqs): This release adds MessageSystemAttributeNames to ReceiveMessageRequest to replace AttributeNames.
1 parent daf6bd4 commit 35284e8

28 files changed

+647
-665
lines changed

‎clients/client-sqs/README.md

+7-8
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@
77
AWS SDK for JavaScript SQS Client for Node.js, Browser and React Native.
88

99
<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-
travel between applications or microservices. Amazon SQS moves data between distributed
12-
application components and helps you decouple these components.</p>
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>
1313
<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
1414
Guide.</i>
1515
</p>
16-
<p>You can use <a href="http://aws.amazon.com/tools/#sdk">Amazon Web Services
17-
SDKs</a> to access Amazon SQS using your favorite programming language. The SDKs
18-
perform tasks such as the following automatically:</p>
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>
1919
<ul>
2020
<li>
2121
<p>Cryptographically sign your service requests</p>
@@ -60,8 +60,7 @@ perform tasks such as the following automatically:</p>
6060
</li>
6161
<li>
6262
<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>
6564
</a>
6665
</p>
6766
</li>

‎clients/client-sqs/src/SQS.ts

+7-8
Original file line numberDiff line numberDiff line change
@@ -440,15 +440,15 @@ export interface SQS {
440440

441441
/**
442442
* <p>Welcome to the <i>Amazon SQS API Reference</i>.</p>
443-
* <p>Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they
444-
* travel between applications or microservices. Amazon SQS moves data between distributed
445-
* application components and helps you decouple these components.</p>
443+
* <p>Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel
444+
* between applications or microservices. Amazon SQS moves data between distributed application
445+
* components and helps you decouple these components.</p>
446446
* <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
447447
* Guide.</i>
448448
* </p>
449-
* <p>You can use <a href="http://aws.amazon.com/tools/#sdk">Amazon Web Services
450-
* SDKs</a> to access Amazon SQS using your favorite programming language. The SDKs
451-
* perform tasks such as the following automatically:</p>
449+
* <p>You can use <a href="http://aws.amazon.com/tools/#sdk">Amazon Web Services SDKs</a> to access
450+
* Amazon SQS using your favorite programming language. The SDKs perform tasks such as the
451+
* following automatically:</p>
452452
* <ul>
453453
* <li>
454454
* <p>Cryptographically sign your service requests</p>
@@ -493,8 +493,7 @@ export interface SQS {
493493
* </li>
494494
* <li>
495495
* <p>
496-
* <a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line
497-
* Interface</i>
496+
* <a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line Interface</i>
498497
* </a>
499498
* </p>
500499
* </li>

‎clients/client-sqs/src/SQSClient.ts

+7-8
Original file line numberDiff line numberDiff line change
@@ -350,15 +350,15 @@ export interface SQSClientResolvedConfig extends SQSClientResolvedConfigType {}
350350

351351
/**
352352
* <p>Welcome to the <i>Amazon SQS API Reference</i>.</p>
353-
* <p>Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they
354-
* travel between applications or microservices. Amazon SQS moves data between distributed
355-
* application components and helps you decouple these components.</p>
353+
* <p>Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel
354+
* between applications or microservices. Amazon SQS moves data between distributed application
355+
* components and helps you decouple these components.</p>
356356
* <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
357357
* Guide.</i>
358358
* </p>
359-
* <p>You can use <a href="http://aws.amazon.com/tools/#sdk">Amazon Web Services
360-
* SDKs</a> to access Amazon SQS using your favorite programming language. The SDKs
361-
* perform tasks such as the following automatically:</p>
359+
* <p>You can use <a href="http://aws.amazon.com/tools/#sdk">Amazon Web Services SDKs</a> to access
360+
* Amazon SQS using your favorite programming language. The SDKs perform tasks such as the
361+
* following automatically:</p>
362362
* <ul>
363363
* <li>
364364
* <p>Cryptographically sign your service requests</p>
@@ -403,8 +403,7 @@ export interface SQSClientResolvedConfig extends SQSClientResolvedConfigType {}
403403
* </li>
404404
* <li>
405405
* <p>
406-
* <a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line
407-
* Interface</i>
406+
* <a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line Interface</i>
408407
* </a>
409408
* </p>
410409
* </li>

‎clients/client-sqs/src/commands/AddPermissionCommand.ts

+11-15
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ export interface AddPermissionCommandOutput extends __MetadataBearer {}
3131
* access to the queue.</p>
3232
* <p>When you create a queue, you have full control access rights for the queue. Only you,
3333
* the owner of the queue, can grant or deny permissions to the queue. For more information
34-
* 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
35-
* <i>Amazon SQS Developer Guide</i>.</p>
34+
* 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
35+
* Developer Guide</i>.</p>
3636
* <note>
3737
* <ul>
3838
* <li>
@@ -41,29 +41,25 @@ export interface AddPermissionCommandOutput extends __MetadataBearer {}
4141
* <code>
4242
* <a>SetQueueAttributes</a>
4343
* </code> to upload your
44-
* 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
45-
* Language</a> in the <i>Amazon SQS Developer
46-
* Guide</i>.</p>
44+
* 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
45+
* the <i>Amazon SQS Developer Guide</i>.</p>
4746
* </li>
4847
* <li>
49-
* <p>An Amazon SQS policy can have a maximum of seven actions per
50-
* statement.</p>
48+
* <p>An Amazon SQS policy can have a maximum of seven actions per statement.</p>
5149
* </li>
5250
* <li>
53-
* <p>To remove the ability to change queue permissions, you must deny
54-
* permission to the <code>AddPermission</code>, <code>RemovePermission</code>,
55-
* and <code>SetQueueAttributes</code> actions in your IAM policy.</p>
51+
* <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>
5652
* </li>
5753
* <li>
58-
* <p>Amazon SQS <code>AddPermission</code> does not support adding a
59-
* non-account principal.</p>
54+
* <p>Amazon SQS <code>AddPermission</code> does not support adding a non-account
55+
* principal.</p>
6056
* </li>
6157
* </ul>
6258
* </note>
6359
* <note>
64-
* <p>Cross-account permissions don't apply to this action. For more information, see
65-
* <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
66-
* <i>Amazon SQS Developer Guide</i>.</p>
60+
* <p>Cross-account permissions don't apply to this action. For more information,
61+
* 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
62+
* cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
6763
* </note>
6864
* @example
6965
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-sqs/src/commands/CancelMessageMoveTaskCommand.ts

-3
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,6 @@ export interface CancelMessageMoveTaskCommandOutput extends CancelMessageMoveTas
4040
* dead-letter-queue), or a custom destination queue. </p>
4141
* </li>
4242
* <li>
43-
* <p>Currently, only standard queues are supported.</p>
44-
* </li>
45-
* <li>
4643
* <p>Only one active message movement task is supported per queue at any given
4744
* time.</p>
4845
* </li>

‎clients/client-sqs/src/commands/ChangeMessageVisibilityBatchCommand.ts

+1-3
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,7 @@ export interface ChangeMessageVisibilityBatchCommandOutput
4141
* </code> requests with each
4242
* <code>ChangeMessageVisibilityBatch</code> action.</p>
4343
* <important>
44-
* <p>Because the batch request can result in a combination of successful and
45-
* unsuccessful actions, you should check for batch errors even when the call returns
46-
* an HTTP status code of <code>200</code>.</p>
44+
* <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>
4745
* </important>
4846
* @example
4947
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-sqs/src/commands/ChangeMessageVisibilityCommand.ts

+8-17
Original file line numberDiff line numberDiff line change
@@ -50,23 +50,14 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer {
5050
* <p>Deleted from the queue.</p>
5151
* </li>
5252
* </ol>
53-
* <p>A message is considered to be <i>stored</i> after it is sent to a queue
54-
* by a producer, but not yet received from the queue by a consumer (that is, between
55-
* states 1 and 2). There is no limit to the number of stored messages. A message is
56-
* considered to be <i>in flight</i> after it is received from a queue by a
57-
* consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is
58-
* a limit to the number of in flight messages.</p>
59-
* <p>Limits that apply to in flight messages are unrelated to the
60-
* <i>unlimited</i> number of stored messages.</p>
61-
* <p>For most standard queues (depending on queue traffic and message backlog), there can
62-
* be a maximum of approximately 120,000 in flight messages (received from a queue by a
63-
* consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS
64-
* returns the <code>OverLimit</code> error message. To avoid reaching the limit, you
65-
* should delete messages from the queue after they're processed. You can also increase the
66-
* 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>
67-
* <p>For FIFO queues, there can be a maximum of 20,000 in flight messages (received from a
68-
* queue by a consumer, but not yet deleted from the queue). If you reach this limit,
69-
* Amazon SQS returns no error messages.</p>
53+
* <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.
54+
* 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>
55+
* <p>Limits that apply to in flight messages are unrelated to the <i>unlimited</i> number of stored messages.</p>
56+
* <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).
57+
* If you reach this limit, Amazon SQS returns the <code>OverLimit</code> error message.
58+
* 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.
59+
* 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>
60+
* <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>
7061
* <important>
7162
* <p>If you attempt to set the <code>VisibilityTimeout</code> to a value greater than
7263
* the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically

‎clients/client-sqs/src/commands/CreateQueueCommand.ts

+8-9
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,11 @@ export interface CreateQueueCommandInput extends CreateQueueRequest {}
2727
export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataBearer {}
2828

2929
/**
30-
* <p>Creates a new standard or FIFO queue. You can pass one or more attributes in the
31-
* request. Keep the following in mind:</p>
30+
* <p>Creates a new standard or FIFO queue. You can pass one or more attributes in
31+
* the request. Keep the following in mind:</p>
3232
* <ul>
3333
* <li>
34-
* <p>If you don't specify the <code>FifoQueue</code> attribute, Amazon SQS creates
35-
* a standard queue.</p>
34+
* <p>If you don't specify the <code>FifoQueue</code> attribute, Amazon SQS creates a standard queue.</p>
3635
* <note>
3736
* <p>You can't change the queue type after you create it and you can't convert
3837
* an existing standard queue into a FIFO queue. You must either create a new
@@ -76,9 +75,9 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB
7675
* </li>
7776
* </ul>
7877
* <note>
79-
* <p>Cross-account permissions don't apply to this action. For more information, see
80-
* <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
81-
* <i>Amazon SQS Developer Guide</i>.</p>
78+
* <p>Cross-account permissions don't apply to this action. For more information,
79+
* 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
80+
* cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
8281
* </note>
8382
* @example
8483
* Use a bare-bones client and the command you need to make an API call.
@@ -126,8 +125,8 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB
126125
* with the same name.</p>
127126
*
128127
* @throws {@link QueueNameExists} (client fault)
129-
* <p>A queue with this name already exists. Amazon SQS returns this error only if the
130-
* request includes attributes whose values differ from those of the existing queue.</p>
128+
* <p>A queue with this name already exists. Amazon SQS returns this error only if the request
129+
* includes attributes whose values differ from those of the existing queue.</p>
131130
*
132131
* @throws {@link RequestThrottled} (client fault)
133132
* <p>The request was denied due to request throttling.</p>

‎clients/client-sqs/src/commands/DeleteMessageBatchCommand.ts

+1-3
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,7 @@ export interface DeleteMessageBatchCommandOutput extends DeleteMessageBatchResul
3232
* <a>DeleteMessage</a>.</code> The result of the action on each
3333
* message is reported individually in the response.</p>
3434
* <important>
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>
35+
* <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>
3836
* </important>
3937
* @example
4038
* Use a bare-bones client and the command you need to make an API call.

0 commit comments

Comments
 (0)