SQS / Client / cancel_message_move_task

cancel_message_move_task#

SQS.Client.cancel_message_move_task(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.cancel_message_move_task(
    TaskHandle='string'
)
Parameters:

TaskHandle (string) –

[REQUIRED]

An identifier associated with a message movement task.

Return type:

dict

Returns:

Response Syntax

{
    'ApproximateNumberOfMessagesMoved': 123
}

Response Structure

  • (dict) –

    • ApproximateNumberOfMessagesMoved (integer) –

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

Exceptions

  • SQS.Client.exceptions.ResourceNotFoundException

  • SQS.Client.exceptions.RequestThrottled

  • SQS.Client.exceptions.InvalidAddress

  • SQS.Client.exceptions.InvalidSecurity

  • SQS.Client.exceptions.UnsupportedOperation