feat(client-sqs): This release adds MessageSystemAttributeNames to Re…

…ceiveMessageRequest to replace AttributeNames.
aws · May 8, 2024 · 35284e8 · 35284e8
1 parent daf6bd4
commit 35284e8
Show file tree

Hide file tree

Showing 28 changed files with 647 additions and 665 deletions.
diff --git a/clients/client-sqs/README.md b/clients/client-sqs/README.md
@@ -7,15 +7,15 @@
 AWS SDK for JavaScript SQS Client for Node.js, Browser and React Native.
 
 <p>Welcome to the <i>Amazon SQS API Reference</i>.</p>
-<p>Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they
-travel between applications or microservices. Amazon SQS moves data between distributed
-application components and helps you decouple these components.</p>
+<p>Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel
+between applications or microservices. Amazon SQS moves data between distributed application
+components and helps you decouple these components.</p>
 <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
 Guide.</i>
 </p>
-<p>You can use <a href="http://aws.amazon.com/tools/#sdk">Amazon Web Services
-SDKs</a> to access Amazon SQS using your favorite programming language. The SDKs
-perform tasks such as the following automatically:</p>
+<p>You can use <a href="http://aws.amazon.com/tools/#sdk">Amazon Web Services SDKs</a> to access
+Amazon SQS using your favorite programming language. The SDKs perform tasks such as the
+following automatically:</p>
 <ul>
 <li>
 <p>Cryptographically sign your service requests</p>
@@ -60,8 +60,7 @@ perform tasks such as the following automatically:</p>
 </li>
 <li>
 <p>
-<a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line
-Interface</i>
+<a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line Interface</i>
 </a>
 </p>
 </li>

diff --git a/clients/client-sqs/src/SQS.ts b/clients/client-sqs/src/SQS.ts
@@ -440,15 +440,15 @@ export interface SQS {
 
 /**
  * <p>Welcome to the <i>Amazon SQS API Reference</i>.</p>
- *          <p>Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they
- *             travel between applications or microservices. Amazon SQS moves data between distributed
- *             application components and helps you decouple these components.</p>
+ *          <p>Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel
+ *             between applications or microservices. Amazon SQS moves data between distributed application
+ *             components and helps you decouple these components.</p>
  *          <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
  *                 Guide.</i>
  *          </p>
- *          <p>You can use <a href="http://aws.amazon.com/tools/#sdk">Amazon Web Services
- *                 SDKs</a> to access Amazon SQS using your favorite programming language. The SDKs
- *             perform tasks such as the following automatically:</p>
+ *          <p>You can use <a href="http://aws.amazon.com/tools/#sdk">Amazon Web Services SDKs</a> to access
+ *             Amazon SQS using your favorite programming language. The SDKs perform tasks such as the
+ *             following automatically:</p>
  *          <ul>
  *             <li>
  *                <p>Cryptographically sign your service requests</p>
@@ -493,8 +493,7 @@ export interface SQS {
  *             </li>
  *             <li>
  *                <p>
- *                   <a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line
- *                             Interface</i>
+ *                   <a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line Interface</i>
  *                   </a>
  *                </p>
  *             </li>

diff --git a/clients/client-sqs/src/SQSClient.ts b/clients/client-sqs/src/SQSClient.ts
@@ -350,15 +350,15 @@ export interface SQSClientResolvedConfig extends SQSClientResolvedConfigType {}
 
 /**
  * <p>Welcome to the <i>Amazon SQS API Reference</i>.</p>
- *          <p>Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they
- *             travel between applications or microservices. Amazon SQS moves data between distributed
- *             application components and helps you decouple these components.</p>
+ *          <p>Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel
+ *             between applications or microservices. Amazon SQS moves data between distributed application
+ *             components and helps you decouple these components.</p>
  *          <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
  *                 Guide.</i>
  *          </p>
- *          <p>You can use <a href="http://aws.amazon.com/tools/#sdk">Amazon Web Services
- *                 SDKs</a> to access Amazon SQS using your favorite programming language. The SDKs
- *             perform tasks such as the following automatically:</p>
+ *          <p>You can use <a href="http://aws.amazon.com/tools/#sdk">Amazon Web Services SDKs</a> to access
+ *             Amazon SQS using your favorite programming language. The SDKs perform tasks such as the
+ *             following automatically:</p>
  *          <ul>
  *             <li>
  *                <p>Cryptographically sign your service requests</p>
@@ -403,8 +403,7 @@ export interface SQSClientResolvedConfig extends SQSClientResolvedConfigType {}
  *             </li>
  *             <li>
  *                <p>
- *                   <a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line
- *                             Interface</i>
+ *                   <a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line Interface</i>
  *                   </a>
  *                </p>
  *             </li>

diff --git a/clients/client-sqs/src/commands/AddPermissionCommand.ts b/clients/client-sqs/src/commands/AddPermissionCommand.ts
@@ -31,8 +31,8 @@ export interface AddPermissionCommandOutput extends __MetadataBearer {}
  *             access to the queue.</p>
  *          <p>When you create a queue, you have full control access rights for the queue. Only you,
  *             the owner of the queue, can grant or deny permissions to the queue. For more information
- *             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 Developer Guide</i>.</p>
+ *             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
+ *                 Developer Guide</i>.</p>
  *          <note>
  *             <ul>
  *                <li>
@@ -41,29 +41,25 @@ export interface AddPermissionCommandOutput extends __MetadataBearer {}
  *                                 <code>
  *                         <a>SetQueueAttributes</a>
  *                      </code> to upload your
- *                         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 the <i>Amazon SQS Developer
- *                         Guide</i>.</p>
+ *                         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
+ *                         the <i>Amazon SQS Developer Guide</i>.</p>
  *                </li>
  *                <li>
- *                   <p>An Amazon SQS policy can have a maximum of seven actions per
- *                         statement.</p>
+ *                   <p>An Amazon SQS policy can have a maximum of seven actions per statement.</p>
  *                </li>
  *                <li>
- *                   <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>
+ *                   <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>
  *                </li>
  *                <li>
- *                   <p>Amazon SQS <code>AddPermission</code> does not support adding a
- *                         non-account principal.</p>
+ *                   <p>Amazon SQS <code>AddPermission</code> does not support adding a non-account
+ *                         principal.</p>
  *                </li>
  *             </ul>
  *          </note>
  *          <note>
- *             <p>Cross-account permissions don't apply to this action. For more information, 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 cross-account permissions to a role and a username</a> in the
- *                     <i>Amazon SQS Developer Guide</i>.</p>
+ *             <p>Cross-account permissions don't apply to this action. For more information,
+ * 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
+ * cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
  *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-sqs/src/commands/CancelMessageMoveTaskCommand.ts b/clients/client-sqs/src/commands/CancelMessageMoveTaskCommand.ts
@@ -40,9 +40,6 @@ export interface CancelMessageMoveTaskCommandOutput extends CancelMessageMoveTas
  *                         dead-letter-queue), or a custom destination queue. </p>
  *                </li>
  *                <li>
- *                   <p>Currently, only standard queues are supported.</p>
- *                </li>
- *                <li>
  *                   <p>Only one active message movement task is supported per queue at any given
  *                         time.</p>
  *                </li>

diff --git a/clients/client-sqs/src/commands/ChangeMessageVisibilityBatchCommand.ts b/clients/client-sqs/src/commands/ChangeMessageVisibilityBatchCommand.ts
@@ -41,9 +41,7 @@ export interface ChangeMessageVisibilityBatchCommandOutput
  *             </code> requests with each
  *                 <code>ChangeMessageVisibilityBatch</code> action.</p>
  *          <important>
- *             <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>
+ *             <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>
  *          </important>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-sqs/src/commands/ChangeMessageVisibilityCommand.ts b/clients/client-sqs/src/commands/ChangeMessageVisibilityCommand.ts
@@ -50,23 +50,14 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer {
  *                <p>Deleted from the queue.</p>
  *             </li>
  *          </ol>
- *          <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. 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>
- *          <p>Limits that apply to in flight messages are unrelated to the
- *                 <i>unlimited</i> number of stored messages.</p>
- *          <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). If you reach this limit, Amazon SQS
- *             returns the <code>OverLimit</code> error message. 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. 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>
- *          <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>
+ *          <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.
+ *     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>
+ *          <p>Limits that apply to in flight messages are unrelated to the <i>unlimited</i> number of stored messages.</p>
+ *          <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).
+ *     If you reach this limit, Amazon SQS returns the <code>OverLimit</code> error message.
+ *     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.
+ *     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>
+ *          <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>
  *          <important>
  *             <p>If you attempt to set the <code>VisibilityTimeout</code> to a value greater than
  *                 the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically

diff --git a/clients/client-sqs/src/commands/CreateQueueCommand.ts b/clients/client-sqs/src/commands/CreateQueueCommand.ts
@@ -27,12 +27,11 @@ export interface CreateQueueCommandInput extends CreateQueueRequest {}
 export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataBearer {}
 
 /**
- * <p>Creates a new standard or FIFO queue. You can pass one or more attributes in the
- *             request. Keep the following in mind:</p>
+ * <p>Creates a new standard or FIFO queue. You can pass one or more attributes in
+ *             the request. Keep the following in mind:</p>
  *          <ul>
  *             <li>
- *                <p>If you don't specify the <code>FifoQueue</code> attribute, Amazon SQS creates
- *                     a standard queue.</p>
+ *                <p>If you don't specify the <code>FifoQueue</code> attribute, Amazon SQS creates a standard queue.</p>
  *                <note>
  *                   <p>You can't change the queue type after you create it and you can't convert
  *                         an existing standard queue into a FIFO queue. You must either create a new
@@ -76,9 +75,9 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB
  *             </li>
  *          </ul>
  *          <note>
- *             <p>Cross-account permissions don't apply to this action. For more information, 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 cross-account permissions to a role and a username</a> in the
- *                     <i>Amazon SQS Developer Guide</i>.</p>
+ *             <p>Cross-account permissions don't apply to this action. For more information,
+ * 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
+ * cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
  *          </note>
  * @example
  * 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
  *             with the same name.</p>
  *
  * @throws {@link QueueNameExists} (client fault)
- *  <p>A queue with this name already exists. Amazon SQS returns this error only if the
- *             request includes attributes whose values differ from those of the existing queue.</p>
+ *  <p>A queue with this name already exists. Amazon SQS returns this error only if the request
+ *             includes attributes whose values differ from those of the existing queue.</p>
  *
  * @throws {@link RequestThrottled} (client fault)
  *  <p>The request was denied due to request throttling.</p>

diff --git a/clients/client-sqs/src/commands/DeleteMessageBatchCommand.ts b/clients/client-sqs/src/commands/DeleteMessageBatchCommand.ts
@@ -32,9 +32,7 @@ export interface DeleteMessageBatchCommandOutput extends DeleteMessageBatchResul
  *                <a>DeleteMessage</a>.</code> The result of the action on each
  *             message is reported individually in the response.</p>
  *          <important>
- *             <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>
+ *             <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>
  *          </important>
  * @example
  * Use a bare-bones client and the command you need to make an API call.