retrieved_traces_graphs

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

Overview

Name	retrieved_traces_graphs
Type	Resource
Id	aws.xray.retrieved_traces_graphs

Fields

The following fields are returned by SELECT queries:

get_retrieved_traces_graph

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)
services	array	Retrieved services.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_retrieved_traces_graph	select	region		Retrieves a service graph for traces based on the specified RetrievalToken from the CloudWatch log group generated by Transaction Search. This API does not initiate a retrieval job. You must first execute StartTraceRetrieval to obtain the required RetrievalToken. The trace graph describes services that process incoming requests and any downstream services they call, which may include Amazon Web Services resources, external APIs, or databases. The response is empty until the RetrievalStatus is COMPLETE. Retry the request after the status changes from RUNNING or SCHEDULED to COMPLETE to access the full service graph. When CloudWatch log is the destination, this API can support cross-account observability and service graph retrieval across linked accounts. For retrieving graphs from X-Ray directly as opposed to the Transaction-Search Log group, see GetTraceGraph.

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

get_retrieved_traces_graph

Retrieves a service graph for traces based on the specified RetrievalToken from the CloudWatch log group generated by Transaction Search. This API does not initiate a retrieval job. You must first execute StartTraceRetrieval to obtain the required RetrievalToken. The trace graph describes services that process incoming requests and any downstream services they call, which may include Amazon Web Services resources, external APIs, or databases. The response is empty until the RetrievalStatus is COMPLETE. Retry the request after the status changes from RUNNING or SCHEDULED to COMPLETE to access the full service graph. When CloudWatch log is the destination, this API can support cross-account observability and service graph retrieval across linked accounts. For retrieving graphs from X-Ray directly as opposed to the Transaction-Search Log group, see GetTraceGraph.

SELECT
next_token,
retrieval_status,
services
FROM aws.xray.retrieved_traces_graphs
WHERE region = '{{ region }}' -- required
;