:doc:`XRay <../../xray>` / Client / cancel_trace_retrieval

**********************
cancel_trace_retrieval
**********************



.. py:method:: XRay.Client.cancel_trace_retrieval(**kwargs)

  

  Cancels an ongoing trace retrieval job initiated by ``StartTraceRetrieval`` using the provided ``RetrievalToken``. A successful cancellation will return an HTTP 200 response.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/CancelTraceRetrieval>`_  


  **Request Syntax**
  ::

    response = client.cancel_trace_retrieval(
        RetrievalToken='string'
    )
    
  :type RetrievalToken: string
  :param RetrievalToken: **[REQUIRED]** 

    Retrieval token.

    

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

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`XRay.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`XRay.Client.exceptions.ThrottledException`

  
  *   :py:class:`XRay.Client.exceptions.ResourceNotFoundException`

  