- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
CancelMessageMoveTaskCommand
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.
-
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.
-
Only one active message movement task is supported per queue at any given time.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { SQSClient, CancelMessageMoveTaskCommand } from "@aws-sdk/client-sqs"; // ES Modules import
// const { SQSClient, CancelMessageMoveTaskCommand } = require("@aws-sdk/client-sqs"); // CommonJS import
const client = new SQSClient(config);
const input = { // CancelMessageMoveTaskRequest
TaskHandle: "STRING_VALUE", // required
};
const command = new CancelMessageMoveTaskCommand(input);
const response = await client.send(command);
// { // CancelMessageMoveTaskResult
// ApproximateNumberOfMessagesMoved: Number("long"),
// };
CancelMessageMoveTaskCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
TaskHandleRequired | string | undefined | An identifier associated with a message movement task. |
CancelMessageMoveTaskCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
ApproximateNumberOfMessagesMoved | number | undefined | The approximate number of messages already moved to the destination queue. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| InvalidAddress | client | The specified ID is invalid. |
| InvalidSecurity | client | The request was not made over HTTPS or did not use SigV4 for signing. |
| RequestThrottled | client | The request was denied due to request throttling.
|
| ResourceNotFoundException | client | One or more specified resources don't exist. |
| UnsupportedOperation | client | Error code 400. Unsupported operation. |
| SQSServiceException | Base exception class for all service exceptions from SQS service. |