Skip to content

SQS  >  Operations  >  cancel_message_move_task

cancel_message_move_task

Operation

cancel_message_move_task async 

cancel_message_move_task(input: CancelMessageMoveTaskInput, plugins: list[Plugin] | None = None) -> CancelMessageMoveTaskOutput

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.

Note

  • 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.

Parameters:

Name Type Description Default
input CancelMessageMoveTaskInput

An instance of CancelMessageMoveTaskInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
CancelMessageMoveTaskOutput

An instance of CancelMessageMoveTaskOutput.

Input

CancelMessageMoveTaskInput dataclass

Dataclass for CancelMessageMoveTaskInput structure.

Attributes

task_handle class-attribute instance-attribute 
task_handle: str | None = None

An identifier associated with a message movement task.

Output

CancelMessageMoveTaskOutput dataclass

Dataclass for CancelMessageMoveTaskOutput structure.

Attributes

approximate_number_of_messages_moved class-attribute instance-attribute 
approximate_number_of_messages_moved: int = 0

The approximate number of messages already moved to the destination queue.