From e6c791717a94aa00f7e735e841f30dff3bcaf6fa Mon Sep 17 00:00:00 2001 From: awstools Date: Fri, 28 Jul 2023 00:27:14 +0000 Subject: [PATCH] docs(client-sqs): Documentation changes related to SQS APIs. --- .../commands/CancelMessageMoveTaskCommand.ts | 19 +++++++++++++------ .../commands/ListMessageMoveTasksCommand.ts | 17 +++++++++++++++++ .../src/commands/PurgeQueueCommand.ts | 4 ++-- .../commands/StartMessageMoveTaskCommand.ts | 18 ++++++++++++------ clients/client-sqs/src/models/models_0.ts | 8 +++++--- codegen/sdk-codegen/aws-models/sqs.json | 12 ++++++------ 6 files changed, 55 insertions(+), 23 deletions(-) diff --git a/clients/client-sqs/src/commands/CancelMessageMoveTaskCommand.ts b/clients/client-sqs/src/commands/CancelMessageMoveTaskCommand.ts index e647518aadc5..a650bb394a35 100644 --- a/clients/client-sqs/src/commands/CancelMessageMoveTaskCommand.ts +++ b/clients/client-sqs/src/commands/CancelMessageMoveTaskCommand.ts @@ -36,17 +36,24 @@ export interface CancelMessageMoveTaskCommandOutput extends CancelMessageMoveTas /** * @public - *

Cancels a specified message movement task.

+ *

Cancels a specified message movement task. A message movement can only be cancelled + * when the current status is RUNNING. Cancelling a message movement task does not revert + * the messages that have already been moved. It can only stop the messages that have not + * been moved yet.

* * * diff --git a/clients/client-sqs/src/commands/ListMessageMoveTasksCommand.ts b/clients/client-sqs/src/commands/ListMessageMoveTasksCommand.ts index 0f20c7a9ca80..fdc6d11f694b 100644 --- a/clients/client-sqs/src/commands/ListMessageMoveTasksCommand.ts +++ b/clients/client-sqs/src/commands/ListMessageMoveTasksCommand.ts @@ -38,6 +38,23 @@ export interface ListMessageMoveTasksCommandOutput extends ListMessageMoveTasksR * @public *

Gets the most recent message movement tasks (up to 10) under a specific source * queue.

+ * + * + * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-sqs/src/commands/PurgeQueueCommand.ts b/clients/client-sqs/src/commands/PurgeQueueCommand.ts index 181fcf03c65b..85c17d5a2e2e 100644 --- a/clients/client-sqs/src/commands/PurgeQueueCommand.ts +++ b/clients/client-sqs/src/commands/PurgeQueueCommand.ts @@ -36,8 +36,8 @@ export interface PurgeQueueCommandOutput extends __MetadataBearer {} /** * @public - *

Deletes the messages in a queue specified by the QueueURL - * parameter.

+ *

Deletes available messages in a queue (including in-flight messages) specified by the + * QueueURL parameter.

* *

When you use the PurgeQueue action, you can't retrieve any messages * deleted from a queue.

diff --git a/clients/client-sqs/src/commands/StartMessageMoveTaskCommand.ts b/clients/client-sqs/src/commands/StartMessageMoveTaskCommand.ts index c236fdf654d3..330e78b15f46 100644 --- a/clients/client-sqs/src/commands/StartMessageMoveTaskCommand.ts +++ b/clients/client-sqs/src/commands/StartMessageMoveTaskCommand.ts @@ -41,14 +41,20 @@ export interface StartMessageMoveTaskCommandOutput extends StartMessageMoveTaskR * *
    *
  • - *

    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.

    + *

    This action is currently limited to supporting message redrive from queues + * that are configured as dead-letter queues (DLQs) of other Amazon SQS queues only. Non-SQS + * queue sources of dead-letter queues, such as Lambda or Amazon SNS topics, are + * currently not supported.

    *
    • *
  • - *

    Currently, only standard queues are supported.

    + *

    In dead-letter queues redrive context, the + * StartMessageMoveTask the source queue is the 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.

    + *
    • + *
  • + *

    Currently, only standard queues support redrive. FIFO queues don't support + * redrive.

    *
    • *
  • *

    Only one active message movement task is supported per queue at any given diff --git a/clients/client-sqs/src/models/models_0.ts b/clients/client-sqs/src/models/models_0.ts index a7fa22e2742b..cc2012a811e8 100644 --- a/clients/client-sqs/src/models/models_0.ts +++ b/clients/client-sqs/src/models/models_0.ts @@ -1391,8 +1391,8 @@ export interface ListQueuesResult { NextToken?: string; /** - *

    A list of queue URLs, up to 1,000 entries, or the value of MaxResults that you sent in - * the request.

    + *

    A list of queue URLs, up to 1,000 entries, or the value of MaxResults + * that you sent in the request.

    */ QueueUrls?: string[]; } @@ -2644,7 +2644,9 @@ export interface SetQueueAttributesRequest { export interface StartMessageMoveTaskRequest { /** *

    The ARN of the queue that contains the messages to be moved to another queue. - * Currently, only dead-letter queue (DLQ) ARNs are accepted.

    + * Currently, only ARNs of dead-letter queues (DLQs) whose sources are other Amazon SQS queues + * are accepted. DLQs whose sources are non-SQS queues, such as Lambda or Amazon SNS topics, are + * not currently supported.

    */ SourceArn: string | undefined; diff --git a/codegen/sdk-codegen/aws-models/sqs.json b/codegen/sdk-codegen/aws-models/sqs.json index 00433f942991..87e3a5d55e01 100644 --- a/codegen/sdk-codegen/aws-models/sqs.json +++ b/codegen/sdk-codegen/aws-models/sqs.json @@ -1344,7 +1344,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Cancels a specified message movement task.

    \n \n
      \n
    • \n

      A message movement can only be cancelled when the current status is\n RUNNING.

      \n
      • \n
    • \n

      Cancelling a message movement task does not revert the messages that have\n already been moved. It can only stop the messages that have not been moved\n yet.

      \n
      • \n
    \n     " + "smithy.api#documentation": "

    Cancels a specified message movement task. A message movement can only be cancelled\n when the current status is RUNNING. Cancelling a message movement task does not revert\n the messages that have already been moved. It can only stop the messages that have not\n been moved yet.

    \n \n
      \n
    • \n

      This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source\n queue is the dead-letter queue (DLQ), while the destination queue can be the\n original source queue (from which the messages were driven to the\n dead-letter-queue), or a custom destination queue.

      \n
      • \n
    • \n

      Currently, only standard queues are supported.

      \n
      • \n
    • \n

      Only one active message movement task is supported per queue at any given\n time.

      \n
      • \n
    \n     " } }, "com.amazonaws.sqs#CancelMessageMoveTaskRequest": { @@ -2086,7 +2086,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Gets the most recent message movement tasks (up to 10) under a specific source\n queue.

    " + "smithy.api#documentation": "

    Gets the most recent message movement tasks (up to 10) under a specific source\n queue.

    \n \n
      \n
    • \n

      This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source\n queue is the dead-letter queue (DLQ), while the destination queue can be the\n original source queue (from which the messages were driven to the\n dead-letter-queue), or a custom destination queue.

      \n
      • \n
    • \n

      Currently, only standard queues are supported.

      \n
      • \n
    • \n

      Only one active message movement task is supported per queue at any given\n time.

      \n
      • \n
    \n     " } }, "com.amazonaws.sqs#ListMessageMoveTasksRequest": { @@ -2299,7 +2299,7 @@ "QueueUrls": { "target": "com.amazonaws.sqs#QueueUrlList", "traits": { - "smithy.api#documentation": "

    A list of queue URLs, up to 1,000 entries, or the value of MaxResults that you sent in\n the request.

    ", + "smithy.api#documentation": "

    A list of queue URLs, up to 1,000 entries, or the value of MaxResults\n that you sent in the request.

    ", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "QueueUrl" } @@ -2629,7 +2629,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Deletes the messages in a queue specified by the QueueURL\n parameter.

    \n \n

    When you use the PurgeQueue action, you can't retrieve any messages\n deleted from a queue.

    \n

    The message deletion process takes up to 60 seconds. We recommend waiting for 60\n seconds regardless of your queue's size.

    \n     \n

    Messages sent to the queue before you call\n PurgeQueue might be received but are deleted within the next\n minute.

    \n

    Messages sent to the queue after you call PurgeQueue\n might be deleted while the queue is being purged.

    " + "smithy.api#documentation": "

    Deletes available messages in a queue (including in-flight messages) specified by the\n QueueURL parameter.

    \n \n

    When you use the PurgeQueue action, you can't retrieve any messages\n deleted from a queue.

    \n

    The message deletion process takes up to 60 seconds. We recommend waiting for 60\n seconds regardless of your queue's size.

    \n     \n

    Messages sent to the queue before you call\n PurgeQueue might be received but are deleted within the next\n minute.

    \n

    Messages sent to the queue after you call PurgeQueue\n might be deleted while the queue is being purged.

    " } }, "com.amazonaws.sqs#PurgeQueueInProgress": { @@ -3383,7 +3383,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Starts an asynchronous task to move messages from a specified source queue to a\n specified destination queue.

    \n \n
      \n
    • \n

      This action is currently limited to supporting message redrive from\n dead-letter queues (DLQs) only. In this context, the source queue is the\n dead-letter queue (DLQ), while the destination queue can be the original\n source queue (from which the messages were driven to the dead-letter-queue),\n or a custom destination queue.

      \n
      • \n
    • \n

      Currently, only standard queues are supported.

      \n
      • \n
    • \n

      Only one active message movement task is supported per queue at any given\n time.

      \n
      • \n
    \n     " + "smithy.api#documentation": "

    Starts an asynchronous task to move messages from a specified source queue to a\n specified destination queue.

    \n \n
      \n
    • \n

      This action is currently limited to supporting message redrive from queues\n that are configured as dead-letter queues (DLQs) of other Amazon SQS queues only. Non-SQS\n queue sources of dead-letter queues, such as Lambda or Amazon SNS topics, are\n currently not supported.

      \n
      • \n
    • \n

      In dead-letter queues redrive context, the\n StartMessageMoveTask the source queue is the DLQ, while the\n destination queue can be the original source queue (from which the messages\n were driven to the dead-letter-queue), or a custom destination queue.

      \n
      • \n
    • \n

      Currently, only standard queues support redrive. FIFO queues don't support\n redrive.

      \n
      • \n
    • \n

      Only one active message movement task is supported per queue at any given\n time.

      \n
      • \n
    \n     " } }, "com.amazonaws.sqs#StartMessageMoveTaskRequest": { @@ -3392,7 +3392,7 @@ "SourceArn": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

    The ARN of the queue that contains the messages to be moved to another queue.\n Currently, only dead-letter queue (DLQ) ARNs are accepted.

    ", + "smithy.api#documentation": "

    The ARN of the queue that contains the messages to be moved to another queue.\n Currently, only ARNs of dead-letter queues (DLQs) whose sources are other Amazon SQS queues\n are accepted. DLQs whose sources are non-SQS queues, such as Lambda or Amazon SNS topics, are\n not currently supported.

    ", "smithy.api#required": {} } },