@aws-sdk/client-sqs 3.345.0 → 3.347.0

package/dist-types/commands/ReceiveMessageCommand.d.ts

@@ -23,13 +23,17 @@ export interface ReceiveMessageCommandOutput extends ReceiveMessageResult, __Met
 }
 /**
  * @public
- * <p>Retrieves one or more messages (up to 10), from the specified queue. Using the <code>WaitTimeSeconds</code> parameter enables long-poll support.
- *          For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html">Amazon SQS Long Polling</a> in the <i>Amazon SQS Developer Guide</i>.
- *     </p>
- *          <p>Short poll is the default behavior where a weighted random set of machines is sampled on a <code>ReceiveMessage</code> call. Thus, only the messages on the sampled machines are returned.
- *           If the number of messages in the queue is small (fewer than 1,000), you most likely get fewer messages than you requested per <code>ReceiveMessage</code> call. If the number of messages in the queue is extremely small,
- *           you might not receive any messages in a particular <code>ReceiveMessage</code> response. If this happens, repeat the request.
- *     </p>
+ * <p>Retrieves one or more messages (up to 10), from the specified queue. Using the
+ *                 <code>WaitTimeSeconds</code> parameter enables long-poll support. For more
+ *             information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html">Amazon SQS
+ *                 Long Polling</a> in the <i>Amazon SQS Developer Guide</i>. </p>
+ *          <p>Short poll is the default behavior where a weighted random set of machines is sampled
+ *             on a <code>ReceiveMessage</code> call. Thus, only the messages on the sampled machines
+ *             are returned. If the number of messages in the queue is small (fewer than 1,000), you
+ *             most likely get fewer messages than you requested per <code>ReceiveMessage</code> call.
+ *             If the number of messages in the queue is extremely small, you might not receive any
+ *             messages in a particular <code>ReceiveMessage</code> response. If this happens, repeat
+ *             the request. </p>
  *          <p>For each message returned, the response includes the following:</p>
  *          <ul>
  *             <li>
@@ -39,7 +43,8 @@ export interface ReceiveMessageCommandOutput extends ReceiveMessageResult, __Met
  *                <p>An MD5 digest of the message body. For information about MD5, see <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>
  *             </li>
  *             <li>
- *                <p>The <code>MessageId</code> you received when you sent the message to the queue.</p>
+ *                <p>The <code>MessageId</code> you received when you sent the message to the
+ *                     queue.</p>
  *             </li>
  *             <li>
  *                <p>The receipt handle.</p>
@@ -51,11 +56,17 @@ export interface ReceiveMessageCommandOutput extends ReceiveMessageResult, __Met
  *                <p>An MD5 digest of the message attributes.</p>
  *             </li>
  *          </ul>
- *          <p>The receipt handle is the identifier you must provide when deleting the message. For 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 Guide</i>.</p>
- *          <p>You can provide the <code>VisibilityTimeout</code> parameter in your request. The parameter is applied to the messages that Amazon SQS returns in the response. If you don't include the parameter, the overall visibility timeout for the queue
- *           is used for the 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 Guide</i>.</p>
- *          <p>A message that isn't deleted or a message whose visibility isn't extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead-letter queue.</p>
+ *          <p>The receipt handle is the identifier you must provide when deleting the message. For
+ *             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
+ *                 Guide</i>.</p>
+ *          <p>You can provide the <code>VisibilityTimeout</code> parameter in your request. The
+ *             parameter is applied to the messages that Amazon SQS returns in the response. If you don't
+ *             include the parameter, the overall visibility timeout for the queue is used for the
+ *             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
+ *             Guide</i>.</p>
+ *          <p>A message that isn't deleted or a message whose visibility isn't extended before the
+ *             visibility timeout expires counts as a failed receive. Depending on the configuration of
+ *             the queue, the message might be sent to the dead-letter queue.</p>
  *          <note>
  *             <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>
  *          </note>
@@ -118,7 +129,7 @@ export interface ReceiveMessageCommandOutput extends ReceiveMessageResult, __Met
  *
  * @throws {@link OverLimit} (client fault)
  *  <p>The specified action violates a limit. For example, <code>ReceiveMessage</code>
- *             returns this error if the maximum number of inflight messages is reached and
+ *             returns this error if the maximum number of in flight messages is reached and
  *                 <code>AddPermission</code> returns this error if the maximum number of permissions
  *             for the queue is reached.</p>
  *

package/dist-types/commands/RemovePermissionCommand.d.ts

@@ -23,7 +23,8 @@ export interface RemovePermissionCommandOutput extends __MetadataBearer {
 }
 /**
  * @public
- * <p>Revokes any permissions in the queue policy that matches the specified <code>Label</code> parameter.</p>
+ * <p>Revokes any permissions in the queue policy that matches the specified
+ *                 <code>Label</code> parameter.</p>
  *          <note>
  *             <ul>
  *                <li>
@@ -32,7 +33,7 @@ export interface RemovePermissionCommandOutput extends __MetadataBearer {
  *                <li>
  *                   <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 user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
+ * cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</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>

package/dist-types/commands/SendMessageBatchCommand.d.ts

@@ -23,10 +23,16 @@ export interface SendMessageBatchCommandOutput extends SendMessageBatchResult, _
 }
 /**
  * @public
- * <p>Delivers up to ten messages to the specified queue. This is a batch version of <code>
- *                <a>SendMessage</a>.</code> For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.</p>
- *          <p>The result of sending each message is reported individually in the response. 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>The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).</p>
+ * <p>You can use <code>SendMessageBatch</code> to send up to 10 messages to the specified
+ *             queue by assigning either identical or different values to each message (or by not
+ *             assigning values at all). This is a batch version of <code>
+ *                <a>SendMessage</a>.</code> For a FIFO queue, multiple messages within a single batch are enqueued
+ *             in the order they are sent.</p>
+ *          <p>The result of sending each message is reported individually in the response.
+ *             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>The maximum allowed individual message size and the maximum total payload size (the
+ *             sum of the individual lengths of all of the batched messages) are both 256 KiB (262,144
+ *             bytes).</p>
  *          <important>
  *             <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:</p>
  *             <p>
@@ -34,14 +40,8 @@ export interface SendMessageBatchCommandOutput extends SendMessageBatchResult, _
  *             </p>
  *             <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>
  *          </important>
- *          <p>If you don't specify the <code>DelaySeconds</code> parameter for an entry, Amazon SQS uses the default value for the queue.</p>
- *          <p>Some actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this:</p>
- *          <p>
- *             <code>&AttributeName.1=first</code>
- *          </p>
- *          <p>
- *             <code>&AttributeName.2=second</code>
- *          </p>
+ *          <p>If you don't specify the <code>DelaySeconds</code> parameter for an entry, Amazon SQS uses
+ *             the default value for the queue.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -127,7 +127,8 @@ export interface SendMessageBatchCommandOutput extends SendMessageBatchResult, _
  *  <p>The batch request doesn't contain any entries.</p>
  *
  * @throws {@link InvalidBatchEntryId} (client fault)
- *  <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the specification.</p>
+ *  <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the
+ *             specification.</p>
  *
  * @throws {@link TooManyEntriesInBatchRequest} (client fault)
  *  <p>The batch request contains more entries than permissible.</p>

package/dist-types/commands/SetQueueAttributesCommand.d.ts

@@ -23,8 +23,12 @@ export interface SetQueueAttributesCommandOutput extends __MetadataBearer {
 }
 /**
  * @public
- * <p>Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system.
- *       Changes made to the <code>MessageRetentionPeriod</code> attribute can take up to 15 minutes.</p>
+ * <p>Sets the value of one or more queue attributes. When you change a queue's attributes,
+ *             the change can take up to 60 seconds for most of the attributes to propagate throughout
+ *             the Amazon SQS system. Changes made to the <code>MessageRetentionPeriod</code> attribute can
+ *             take up to 15 minutes and will impact existing messages in the queue potentially causing
+ *             them to be expired and deleted if the <code>MessageRetentionPeriod</code> is reduced
+ *             below the age of existing messages.</p>
  *          <note>
  *             <ul>
  *                <li>
@@ -33,7 +37,7 @@ export interface SetQueueAttributesCommandOutput extends __MetadataBearer {
  *                <li>
  *                   <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 user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
+ * cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</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>

package/dist-types/commands/StartMessageMoveTaskCommand.d.ts

@@ -0,0 +1,100 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { StartMessageMoveTaskRequest, StartMessageMoveTaskResult } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link StartMessageMoveTaskCommand}.
+ */
+export interface StartMessageMoveTaskCommandInput extends StartMessageMoveTaskRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link StartMessageMoveTaskCommand}.
+ */
+export interface StartMessageMoveTaskCommandOutput extends StartMessageMoveTaskResult, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Starts an asynchronous task to move messages from a specified source queue to a
+ *             specified destination queue.</p>
+ *          <note>
+ *             <ul>
+ *                <li>
+ *                   <p>This action is currently limited to supporting message redrive from
+ *                         dead-letter queues (DLQs) only. In this context, the source queue is the
+ *                         dead-letter queue (DLQ), while the destination queue can be the original
+ *                         source queue (from which the messages were driven to the 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>
+ *             </ul>
+ *          </note>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SQSClient, StartMessageMoveTaskCommand } from "@aws-sdk/client-sqs"; // ES Modules import
+ * // const { SQSClient, StartMessageMoveTaskCommand } = require("@aws-sdk/client-sqs"); // CommonJS import
+ * const client = new SQSClient(config);
+ * const input = { // StartMessageMoveTaskRequest
+ *   SourceArn: "STRING_VALUE", // required
+ *   DestinationArn: "STRING_VALUE",
+ *   MaxNumberOfMessagesPerSecond: Number("int"),
+ * };
+ * const command = new StartMessageMoveTaskCommand(input);
+ * const response = await client.send(command);
+ * // { // StartMessageMoveTaskResult
+ * //   TaskHandle: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param StartMessageMoveTaskCommandInput - {@link StartMessageMoveTaskCommandInput}
+ * @returns {@link StartMessageMoveTaskCommandOutput}
+ * @see {@link StartMessageMoveTaskCommandInput} for command's `input` shape.
+ * @see {@link StartMessageMoveTaskCommandOutput} for command's `response` shape.
+ * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>One or more specified resources don't exist.</p>
+ *
+ * @throws {@link UnsupportedOperation} (client fault)
+ *  <p>Error code 400. Unsupported operation.</p>
+ *
+ * @throws {@link SQSServiceException}
+ * <p>Base exception class for all service exceptions from SQS service.</p>
+ *
+ */
+export declare class StartMessageMoveTaskCommand extends $Command<StartMessageMoveTaskCommandInput, StartMessageMoveTaskCommandOutput, SQSClientResolvedConfig> {
+    readonly input: StartMessageMoveTaskCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: StartMessageMoveTaskCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SQSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartMessageMoveTaskCommandInput, StartMessageMoveTaskCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/TagQueueCommand.d.ts

@@ -46,7 +46,7 @@ export interface TagQueueCommandOutput extends __MetadataBearer {
  *          <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 user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
+ * 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.

package/dist-types/commands/UntagQueueCommand.d.ts

@@ -28,7 +28,7 @@ export interface UntagQueueCommandOutput extends __MetadataBearer {
  *          <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 user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
+ * 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.

package/dist-types/commands/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./AddPermissionCommand";
+export * from "./CancelMessageMoveTaskCommand";
 export * from "./ChangeMessageVisibilityBatchCommand";
 export * from "./ChangeMessageVisibilityCommand";
 export * from "./CreateQueueCommand";
@@ -8,6 +9,7 @@ export * from "./DeleteQueueCommand";
 export * from "./GetQueueAttributesCommand";
 export * from "./GetQueueUrlCommand";
 export * from "./ListDeadLetterSourceQueuesCommand";
+export * from "./ListMessageMoveTasksCommand";
 export * from "./ListQueueTagsCommand";
 export * from "./ListQueuesCommand";
 export * from "./PurgeQueueCommand";
@@ -16,5 +18,6 @@ export * from "./RemovePermissionCommand";
 export * from "./SendMessageBatchCommand";
 export * from "./SendMessageCommand";
 export * from "./SetQueueAttributesCommand";
+export * from "./StartMessageMoveTaskCommand";
 export * from "./TagQueueCommand";
 export * from "./UntagQueueCommand";

package/dist-types/index.d.ts

@@ -1,11 +1,14 @@
 /**
  * <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>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>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>
@@ -61,7 +64,8 @@
  *                <ul>
  *                   <li>
  *                      <p>
- *                         <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#sqs_region">Regions and Endpoints</a>
+ *                         <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#sqs_region">Regions and
+ *                                 Endpoints</a>
  *                      </p>
  *                   </li>
  *                </ul>