Skip to content

Commit

Permalink
docs(client-sqs): Documentation changes related to SQS APIs.
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Jul 28, 2023
1 parent df4b8a7 commit e6c7917
Show file tree
Hide file tree
Showing 6 changed files with 55 additions and 23 deletions.
19 changes: 13 additions & 6 deletions clients/client-sqs/src/commands/CancelMessageMoveTaskCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,24 @@ export interface CancelMessageMoveTaskCommandOutput extends CancelMessageMoveTas

/**
* @public
* <p>Cancels a specified message movement task.</p>
* <p>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.</p>
* <note>
* <ul>
* <li>
* <p>A message movement can only be cancelled when the current status is
* RUNNING.</p>
* <p>This action is currently limited to supporting message redrive from <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">dead-letter queues (DLQs)</a> 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>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.</p>
* <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>
Expand Down
17 changes: 17 additions & 0 deletions clients/client-sqs/src/commands/ListMessageMoveTasksCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,23 @@ export interface ListMessageMoveTasksCommandOutput extends ListMessageMoveTasksR
* @public
* <p>Gets the most recent message movement tasks (up to 10) under a specific source
* queue.</p>
* <note>
* <ul>
* <li>
* <p>This action is currently limited to supporting message redrive from <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">dead-letter queues (DLQs)</a> 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
Expand Down
4 changes: 2 additions & 2 deletions clients/client-sqs/src/commands/PurgeQueueCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ export interface PurgeQueueCommandOutput extends __MetadataBearer {}

/**
* @public
* <p>Deletes the messages in a queue specified by the <code>QueueURL</code>
* parameter.</p>
* <p>Deletes available messages in a queue (including in-flight messages) specified by the
* <code>QueueURL</code> parameter.</p>
* <important>
* <p>When you use the <code>PurgeQueue</code> action, you can't retrieve any messages
* deleted from a queue.</p>
Expand Down
18 changes: 12 additions & 6 deletions clients/client-sqs/src/commands/StartMessageMoveTaskCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,20 @@ export interface StartMessageMoveTaskCommandOutput extends StartMessageMoveTaskR
* <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>
* <p>This action is currently limited to supporting message redrive from queues
* that are configured as <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">dead-letter queues (DLQs)</a> 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.</p>
* </li>
* <li>
* <p>Currently, only standard queues are supported.</p>
* <p>In dead-letter queues redrive context, the
* <code>StartMessageMoveTask</code> 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.</p>
* </li>
* <li>
* <p>Currently, only standard queues support redrive. FIFO queues don't support
* redrive.</p>
* </li>
* <li>
* <p>Only one active message movement task is supported per queue at any given
Expand Down
8 changes: 5 additions & 3 deletions clients/client-sqs/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1391,8 +1391,8 @@ export interface ListQueuesResult {
NextToken?: string;

/**
* <p>A list of queue URLs, up to 1,000 entries, or the value of <code>MaxResults</code> that you sent in
* the request.</p>
* <p>A list of queue URLs, up to 1,000 entries, or the value of <code>MaxResults</code>
* that you sent in the request.</p>
*/
QueueUrls?: string[];
}
Expand Down Expand Up @@ -2644,7 +2644,9 @@ export interface SetQueueAttributesRequest {
export interface StartMessageMoveTaskRequest {
/**
* <p>The ARN of the queue that contains the messages to be moved to another queue.
* Currently, only dead-letter queue (DLQ) ARNs are accepted.</p>
* 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.</p>
*/
SourceArn: string | undefined;

Expand Down
12 changes: 6 additions & 6 deletions codegen/sdk-codegen/aws-models/sqs.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1344,7 +1344,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Cancels a specified message movement task.</p>\n <note>\n <ul>\n <li>\n <p>A message movement can only be cancelled when the current status is\n RUNNING.</p>\n </li>\n <li>\n <p>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.</p>\n </li>\n </ul>\n </note>"
"smithy.api#documentation": "<p>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.</p>\n <note>\n <ul>\n <li>\n <p>This action is currently limited to supporting message redrive from <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html\">dead-letter queues (DLQs)</a> 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. </p>\n </li>\n <li>\n <p>Currently, only standard queues are supported.</p>\n </li>\n <li>\n <p>Only one active message movement task is supported per queue at any given\n time.</p>\n </li>\n </ul>\n </note>"
}
},
"com.amazonaws.sqs#CancelMessageMoveTaskRequest": {
Expand Down Expand Up @@ -2086,7 +2086,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Gets the most recent message movement tasks (up to 10) under a specific source\n queue.</p>"
"smithy.api#documentation": "<p>Gets the most recent message movement tasks (up to 10) under a specific source\n queue.</p>\n <note>\n <ul>\n <li>\n <p>This action is currently limited to supporting message redrive from <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html\">dead-letter queues (DLQs)</a> 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. </p>\n </li>\n <li>\n <p>Currently, only standard queues are supported.</p>\n </li>\n <li>\n <p>Only one active message movement task is supported per queue at any given\n time.</p>\n </li>\n </ul>\n </note>"
}
},
"com.amazonaws.sqs#ListMessageMoveTasksRequest": {
Expand Down Expand Up @@ -2299,7 +2299,7 @@
"QueueUrls": {
"target": "com.amazonaws.sqs#QueueUrlList",
"traits": {
"smithy.api#documentation": "<p>A list of queue URLs, up to 1,000 entries, or the value of <code>MaxResults</code> that you sent in\n the request.</p>",
"smithy.api#documentation": "<p>A list of queue URLs, up to 1,000 entries, or the value of <code>MaxResults</code>\n that you sent in the request.</p>",
"smithy.api#xmlFlattened": {},
"smithy.api#xmlName": "QueueUrl"
}
Expand Down Expand Up @@ -2629,7 +2629,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes the messages in a queue specified by the <code>QueueURL</code>\n parameter.</p>\n <important>\n <p>When you use the <code>PurgeQueue</code> action, you can't retrieve any messages\n deleted from a queue.</p>\n <p>The message deletion process takes up to 60 seconds. We recommend waiting for 60\n seconds regardless of your queue's size. </p>\n </important>\n <p>Messages sent to the queue <i>before</i> you call\n <code>PurgeQueue</code> might be received but are deleted within the next\n minute.</p>\n <p>Messages sent to the queue <i>after</i> you call <code>PurgeQueue</code>\n might be deleted while the queue is being purged.</p>"
"smithy.api#documentation": "<p>Deletes available messages in a queue (including in-flight messages) specified by the\n <code>QueueURL</code> parameter.</p>\n <important>\n <p>When you use the <code>PurgeQueue</code> action, you can't retrieve any messages\n deleted from a queue.</p>\n <p>The message deletion process takes up to 60 seconds. We recommend waiting for 60\n seconds regardless of your queue's size. </p>\n </important>\n <p>Messages sent to the queue <i>before</i> you call\n <code>PurgeQueue</code> might be received but are deleted within the next\n minute.</p>\n <p>Messages sent to the queue <i>after</i> you call <code>PurgeQueue</code>\n might be deleted while the queue is being purged.</p>"
}
},
"com.amazonaws.sqs#PurgeQueueInProgress": {
Expand Down Expand Up @@ -3383,7 +3383,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Starts an asynchronous task to move messages from a specified source queue to a\n specified destination queue.</p>\n <note>\n <ul>\n <li>\n <p>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. </p>\n </li>\n <li>\n <p>Currently, only standard queues are supported.</p>\n </li>\n <li>\n <p>Only one active message movement task is supported per queue at any given\n time.</p>\n </li>\n </ul>\n </note>"
"smithy.api#documentation": "<p>Starts an asynchronous task to move messages from a specified source queue to a\n specified destination queue.</p>\n <note>\n <ul>\n <li>\n <p>This action is currently limited to supporting message redrive from queues\n that are configured as <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html\">dead-letter queues (DLQs)</a> 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.</p>\n </li>\n <li>\n <p>In dead-letter queues redrive context, the\n <code>StartMessageMoveTask</code> 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.</p>\n </li>\n <li>\n <p>Currently, only standard queues support redrive. FIFO queues don't support\n redrive.</p>\n </li>\n <li>\n <p>Only one active message movement task is supported per queue at any given\n time.</p>\n </li>\n </ul>\n </note>"
}
},
"com.amazonaws.sqs#StartMessageMoveTaskRequest": {
Expand All @@ -3392,7 +3392,7 @@
"SourceArn": {
"target": "com.amazonaws.sqs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>",
"smithy.api#documentation": "<p>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.</p>",
"smithy.api#required": {}
}
},
Expand Down

0 comments on commit e6c7917

Please sign in to comment.