:doc:`SQS <../../sqs>` / Client / cancel_message_move_task

************************
cancel_message_move_task
************************



.. py:method:: 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) <https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html>`__ 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 <https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/CancelMessageMoveTask>`_  


  **Request Syntax**
  ::

    response = client.cancel_message_move_task(
        TaskHandle='string'
    )
    
  :type TaskHandle: string
  :param TaskHandle: **[REQUIRED]** 

    An identifier associated with a message movement task.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'ApproximateNumberOfMessagesMoved': 123
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ApproximateNumberOfMessagesMoved** *(integer) --* 

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

        
  
  **Exceptions**
  
  *   :py:class:`SQS.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`SQS.Client.exceptions.RequestThrottled`

  
  *   :py:class:`SQS.Client.exceptions.InvalidAddress`

  
  *   :py:class:`SQS.Client.exceptions.InvalidSecurity`

  
  *   :py:class:`SQS.Client.exceptions.UnsupportedOperation`

  