retrieved_traces

Creates, updates, deletes, gets or lists a retrieved_traces resource.

Overview

Name	retrieved_traces
Type	Resource
Id	aws.xray.retrieved_traces

Fields

The following fields are returned by SELECT queries:

list_retrieved_traces

Name	Datatype	Description
next_token	string	Specify the pagination token returned by a previous request to retrieve the next page of indexes.
retrieval_status	string	Status of the retrieval. (SCHEDULED, RUNNING, COMPLETE, FAILED, CANCELLED, TIMEOUT)
trace_format	string	Format of the requested traces. (XRAY, OTEL)
traces	array	Full traces for the specified requests.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_retrieved_traces	select	region		Retrieves a list of traces for a given RetrievalToken from the CloudWatch log group generated by Transaction Search. For information on what each trace returns, see BatchGetTraces. This API does not initiate a retrieval process. To start a trace retrieval, use StartTraceRetrieval, which generates the required RetrievalToken. When the RetrievalStatus is not COMPLETE, the API will return an empty response. Retry the request once the retrieval has completed to access the full list of traces. For cross-account observability, this API can retrieve traces from linked accounts when CloudWatch log is set as the destination across relevant accounts. For more details, see CloudWatch cross-account observability. For retrieving data from X-Ray directly as opposed to the Transaction Search generated log group, see BatchGetTraces.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_retrieved_traces

Retrieves a list of traces for a given RetrievalToken from the CloudWatch log group generated by Transaction Search. For information on what each trace returns, see BatchGetTraces. This API does not initiate a retrieval process. To start a trace retrieval, use StartTraceRetrieval, which generates the required RetrievalToken. When the RetrievalStatus is not COMPLETE, the API will return an empty response. Retry the request once the retrieval has completed to access the full list of traces. For cross-account observability, this API can retrieve traces from linked accounts when CloudWatch log is set as the destination across relevant accounts. For more details, see CloudWatch cross-account observability. For retrieving data from X-Ray directly as opposed to the Transaction Search generated log group, see BatchGetTraces.

SELECT
next_token,
retrieval_status,
trace_format,
traces
FROM aws.xray.retrieved_traces
WHERE region = '{{ region }}' -- required
;