XRay / Client / cancel_trace_retrieval

cancel_trace_retrieval¶

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.

Request Syntax

response = client.cancel_trace_retrieval(
    RetrievalToken='string'
)

Parameters:

RetrievalToken (string) –

[REQUIRED]

Retrieval token.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

Exceptions

XRay.Client.exceptions.InvalidRequestException
XRay.Client.exceptions.ThrottledException
XRay.Client.exceptions.ResourceNotFoundException