Data retrieval APIs for AWS X-Ray
AWS X-Ray provides the following APIs for data retrieval.
| Actions | Description | Access level |
|---|---|---|
| BatchGetTraceSummaryById | Retrieve metadata for a list of traces specified by ID | Read |
| BatchGetTraces | Retrieve a list of traces specified by ID. Each trace is a collection of segment documents that originates from a single request. Use GetTraceSummaries to get a list of trace IDs | List |
| CancelTraceRetrieval | Cancel an ongoing trace retrieval job initiated by StartTraceRetrieval using the provided RetrievalToken. A successful cancellation will return an HTTP 200 response | Read |
| GetDistinctTraceGraphs | Retrieve distinct service graphs for one or more specific trace IDs | Read |
| GetEncryptionConfig | Retrieve the current encryption configuration for X-Ray data | Read |
| GetGroup | Retrieve group resource details | Read |
| GetGroups | Retrieve all active group details | Read |
| GetIndexingRules | Retrieve all indexing rules. Indexing rules are used to determine the server-side sampling rate for spans ingested through the CloudWatchLogs destination and indexed by X-Ray | Read |
| GetInsight | Retrieve the details of a specific insight | Read |
| GetInsightEvents | Retrieve the events of a specific insight | Read |
| GetInsightImpactGraph | Retrieve the part of the service graph which is impacted for a specific insight | Read |
| GetInsightSummaries | Retrieve the summary of all insights for a group and time range with optional filters | Read |
| GetRetrievedTracesGraph | Retrieve a service graph for traces based on the specified RetrievalToken from the Transaction Search CloudWatch log group | Read |
| GetSamplingRules | Retrieve all sampling rules | Read |
| GetSamplingStatisticSummaries | Retrieve information about recent sampling results for all sampling rules | Read |
| GetSamplingTargets | Request a sampling quota for rules that the service is using to sample requests | Read |
| GetServiceGraph | Retrieve a document that describes services that process incoming requests, and downstream services that they call as a result | Read |
| GetTimeSeriesServiceStatistics | Retrieve an aggregation of service statistics defined by a specific time range bucketed into time intervals | Read |
| GetTraceGraph | Retrieve a service graph for one or more specific trace IDs | Read |
| GetTraceSegmentDestination | Retrieve the current destination of data sent to PutTraceSegments and OpenTelemetry API | Read |
| GetTraceSummaries | Retrieve IDs and metadata for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to BatchGetTraces | Read |
| ListResourcePolicies | List resource policies | List |
| ListRetrievedTraces | Retrieve a list of traces for a given RetrievalToken from the Transaction Search CloudWatch log group | List |
| ListTagsForResource | List tags for an X-Ray resource | List |
| StartTraceRetrieval | Initiate a trace retrieval process using the specified time range and for the given trace IDs on the Transaction Search CloudWatch log group | Read |
