:doc:`Braket <../../braket>` / Client / cancel_quantum_task

*******************
cancel_quantum_task
*******************



.. py:method:: Braket.Client.cancel_quantum_task(**kwargs)

  

  Cancels the specified task.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/CancelQuantumTask>`_  


  **Request Syntax**
  ::

    response = client.cancel_quantum_task(
        quantumTaskArn='string',
        clientToken='string'
    )
    
  :type quantumTaskArn: string
  :param quantumTaskArn: **[REQUIRED]** 

    The ARN of the quantum task to cancel.

    

  
  :type clientToken: string
  :param clientToken: **[REQUIRED]** 

    The client token associated with the cancellation request.

    This field is autopopulated if not provided.

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

    
    ::

      {
          'quantumTaskArn': 'string',
          'cancellationStatus': 'CANCELLING'|'CANCELLED'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **quantumTaskArn** *(string) --* 

        The ARN of the quantum task.

        
      

      - **cancellationStatus** *(string) --* 

        The status of the quantum task.

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

  
  *   :py:class:`Braket.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Braket.Client.exceptions.ConflictException`

  
  *   :py:class:`Braket.Client.exceptions.ThrottlingException`

  
  *   :py:class:`Braket.Client.exceptions.InternalServiceException`

  
  *   :py:class:`Braket.Client.exceptions.ValidationException`

  