# AWS X-Ray API Reference

> AWS X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.

- [Welcome](https://docs.aws.amazon.com/xray/latest/api/Welcome.md)
- [Common Parameters](https://docs.aws.amazon.com/xray/latest/api/CommonParameters.md)
- [Common Error Types](https://docs.aws.amazon.com/xray/latest/api/CommonErrors.md)

## [Actions](https://docs.aws.amazon.com/xray/latest/api/API_Operations.md)

- [BatchGetTraces](https://docs.aws.amazon.com/xray/latest/api/API_BatchGetTraces.md)
- [CancelTraceRetrieval](https://docs.aws.amazon.com/xray/latest/api/API_CancelTraceRetrieval.md): Cancels an ongoing trace retrieval job initiated by StartTraceRetrieval using the provided RetrievalToken.
- [CreateGroup](https://docs.aws.amazon.com/xray/latest/api/API_CreateGroup.md): Creates a group resource with a name and a filter expression.
- [CreateSamplingRule](https://docs.aws.amazon.com/xray/latest/api/API_CreateSamplingRule.md): Creates a rule to control sampling behavior for instrumented applications.
- [DeleteGroup](https://docs.aws.amazon.com/xray/latest/api/API_DeleteGroup.md): Deletes a group resource.
- [DeleteResourcePolicy](https://docs.aws.amazon.com/xray/latest/api/API_DeleteResourcePolicy.md): Deletes a resource policy from the target AWS account.
- [DeleteSamplingRule](https://docs.aws.amazon.com/xray/latest/api/API_DeleteSamplingRule.md): Deletes a sampling rule.
- [GetEncryptionConfig](https://docs.aws.amazon.com/xray/latest/api/API_GetEncryptionConfig.md): Retrieves the current encryption configuration for X-Ray data.
- [GetGroup](https://docs.aws.amazon.com/xray/latest/api/API_GetGroup.md): Retrieves group resource details.
- [GetGroups](https://docs.aws.amazon.com/xray/latest/api/API_GetGroups.md): Retrieves all active group details.
- [GetIndexingRules](https://docs.aws.amazon.com/xray/latest/api/API_GetIndexingRules.md): Retrieves all indexing rules.
- [GetInsight](https://docs.aws.amazon.com/xray/latest/api/API_GetInsight.md): Retrieves the summary information of an insight.
- [GetInsightEvents](https://docs.aws.amazon.com/xray/latest/api/API_GetInsightEvents.md): X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event.
- [GetInsightImpactGraph](https://docs.aws.amazon.com/xray/latest/api/API_GetInsightImpactGraph.md): Retrieves a service graph structure filtered by the specified insight.
- [GetInsightSummaries](https://docs.aws.amazon.com/xray/latest/api/API_GetInsightSummaries.md): Retrieves the summaries of all insights in the specified group matching the provided filter values.
- [GetRetrievedTracesGraph](https://docs.aws.amazon.com/xray/latest/api/API_GetRetrievedTracesGraph.md): Retrieves a service graph for traces based on the specified RetrievalToken from the CloudWatch log group generated by Transaction Search.
- [GetSamplingRules](https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingRules.md): Retrieves all sampling rules.
- [GetSamplingStatisticSummaries](https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingStatisticSummaries.md): Retrieves information about recent sampling results for all sampling rules.
- [GetSamplingTargets](https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.md): Requests a sampling quota for rules that the service is using to sample requests.
- [GetServiceGraph](https://docs.aws.amazon.com/xray/latest/api/API_GetServiceGraph.md): Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result.
- [GetTimeSeriesServiceStatistics](https://docs.aws.amazon.com/xray/latest/api/API_GetTimeSeriesServiceStatistics.md): Get an aggregation of service statistics defined by a specific time range.
- [GetTraceGraph](https://docs.aws.amazon.com/xray/latest/api/API_GetTraceGraph.md): Retrieves a service graph for one or more specific trace IDs.
- [GetTraceSegmentDestination](https://docs.aws.amazon.com/xray/latest/api/API_GetTraceSegmentDestination.md): Retrieves the current destination of data sent to PutTraceSegments and OpenTelemetry protocol (OTLP) endpoint.
- [GetTraceSummaries](https://docs.aws.amazon.com/xray/latest/api/API_GetTraceSummaries.md): Retrieves IDs and annotations for traces available for a specified time frame using an optional filter.
- [ListResourcePolicies](https://docs.aws.amazon.com/xray/latest/api/API_ListResourcePolicies.md): Returns the list of resource policies in the target AWS account.
- [ListRetrievedTraces](https://docs.aws.amazon.com/xray/latest/api/API_ListRetrievedTraces.md): Retrieves a list of traces for a given RetrievalToken from the CloudWatch log group generated by Transaction Search.
- [ListTagsForResource](https://docs.aws.amazon.com/xray/latest/api/API_ListTagsForResource.md): Returns a list of tags that are applied to the specified AWS X-Ray group or sampling rule.
- [PutEncryptionConfig](https://docs.aws.amazon.com/xray/latest/api/API_PutEncryptionConfig.md): Updates the encryption configuration for X-Ray data.
- [PutResourcePolicy](https://docs.aws.amazon.com/xray/latest/api/API_PutResourcePolicy.md): Sets the resource policy to grant one or more AWS services and accounts permissions to access X-Ray.
- [PutTelemetryRecords](https://docs.aws.amazon.com/xray/latest/api/API_PutTelemetryRecords.md): Used by the AWS X-Ray daemon to upload telemetry.
- [PutTraceSegments](https://docs.aws.amazon.com/xray/latest/api/API_PutTraceSegments.md): Uploads segment documents to AWS X-Ray.
- [StartTraceRetrieval](https://docs.aws.amazon.com/xray/latest/api/API_StartTraceRetrieval.md): Initiates a trace retrieval process using the specified time range and for the given trace IDs in the Transaction Search generated CloudWatch log group.
- [TagResource](https://docs.aws.amazon.com/xray/latest/api/API_TagResource.md): Applies tags to an existing AWS X-Ray group or sampling rule.
- [UntagResource](https://docs.aws.amazon.com/xray/latest/api/API_UntagResource.md): Removes tags from an AWS X-Ray group or sampling rule.
- [UpdateGroup](https://docs.aws.amazon.com/xray/latest/api/API_UpdateGroup.md): Updates a group resource.
- [UpdateIndexingRule](https://docs.aws.amazon.com/xray/latest/api/API_UpdateIndexingRule.md): Modifies an indexing rule’s configuration.
- [UpdateSamplingRule](https://docs.aws.amazon.com/xray/latest/api/API_UpdateSamplingRule.md): Modifies a sampling rule's configuration.
- [UpdateTraceSegmentDestination](https://docs.aws.amazon.com/xray/latest/api/API_UpdateTraceSegmentDestination.md): Modifies the destination of data sent to PutTraceSegments.


## [Data Types](https://docs.aws.amazon.com/xray/latest/api/API_Types.md)

- [Alias](https://docs.aws.amazon.com/xray/latest/api/API_Alias.md): An alias for an edge.
- [AnnotationValue](https://docs.aws.amazon.com/xray/latest/api/API_AnnotationValue.md): Value of a segment annotation.
- [AnomalousService](https://docs.aws.amazon.com/xray/latest/api/API_AnomalousService.md): The service within the service graph that has anomalously high fault rates.
- [AvailabilityZoneDetail](https://docs.aws.amazon.com/xray/latest/api/API_AvailabilityZoneDetail.md): A list of Availability Zones corresponding to the segments in a trace.
- [BackendConnectionErrors](https://docs.aws.amazon.com/xray/latest/api/API_BackendConnectionErrors.md)
- [Edge](https://docs.aws.amazon.com/xray/latest/api/API_Edge.md): Information about a connection between two services.
- [EdgeStatistics](https://docs.aws.amazon.com/xray/latest/api/API_EdgeStatistics.md): Response statistics for an edge.
- [EncryptionConfig](https://docs.aws.amazon.com/xray/latest/api/API_EncryptionConfig.md): A configuration document that specifies encryption configuration settings.
- [ErrorRootCause](https://docs.aws.amazon.com/xray/latest/api/API_ErrorRootCause.md): The root cause of a trace summary error.
- [ErrorRootCauseEntity](https://docs.aws.amazon.com/xray/latest/api/API_ErrorRootCauseEntity.md): A collection of segments and corresponding subsegments associated to a trace summary error.
- [ErrorRootCauseService](https://docs.aws.amazon.com/xray/latest/api/API_ErrorRootCauseService.md): A collection of fields identifying the services in a trace summary error.
- [ErrorStatistics](https://docs.aws.amazon.com/xray/latest/api/API_ErrorStatistics.md): Information about requests that failed with a 4xx Client Error status code.
- [FaultRootCause](https://docs.aws.amazon.com/xray/latest/api/API_FaultRootCause.md): The root cause information for a trace summary fault.
- [FaultRootCauseEntity](https://docs.aws.amazon.com/xray/latest/api/API_FaultRootCauseEntity.md): A collection of segments and corresponding subsegments associated to a trace summary fault error.
- [FaultRootCauseService](https://docs.aws.amazon.com/xray/latest/api/API_FaultRootCauseService.md): A collection of fields identifying the services in a trace summary fault.
- [FaultStatistics](https://docs.aws.amazon.com/xray/latest/api/API_FaultStatistics.md): Information about requests that failed with a 5xx Server Error status code.
- [ForecastStatistics](https://docs.aws.amazon.com/xray/latest/api/API_ForecastStatistics.md): The predicted high and low fault count.
- [GraphLink](https://docs.aws.amazon.com/xray/latest/api/API_GraphLink.md): The relation between two services.
- [Group](https://docs.aws.amazon.com/xray/latest/api/API_Group.md): Details and metadata for a group.
- [GroupSummary](https://docs.aws.amazon.com/xray/latest/api/API_GroupSummary.md): Details for a group without metadata.
- [HistogramEntry](https://docs.aws.amazon.com/xray/latest/api/API_HistogramEntry.md): An entry in a histogram for a statistic.
- [Http](https://docs.aws.amazon.com/xray/latest/api/API_Http.md): Information about an HTTP request.
- [IndexingRule](https://docs.aws.amazon.com/xray/latest/api/API_IndexingRule.md): Rule used to determine the server-side sampling rate for spans ingested through the CloudWatchLogs destination and indexed by X-Ray.
- [IndexingRuleValue](https://docs.aws.amazon.com/xray/latest/api/API_IndexingRuleValue.md): The indexing rule configuration.
- [IndexingRuleValueUpdate](https://docs.aws.amazon.com/xray/latest/api/API_IndexingRuleValueUpdate.md): Update to an indexing rule.
- [Insight](https://docs.aws.amazon.com/xray/latest/api/API_Insight.md): When fault rates go outside of the expected range, X-Ray creates an insight.
- [InsightEvent](https://docs.aws.amazon.com/xray/latest/api/API_InsightEvent.md): X-Ray reevaluates insights periodically until they are resolved, and records each intermediate state in an event.
- [InsightImpactGraphEdge](https://docs.aws.amazon.com/xray/latest/api/API_InsightImpactGraphEdge.md): The connection between two service in an insight impact graph.
- [InsightImpactGraphService](https://docs.aws.amazon.com/xray/latest/api/API_InsightImpactGraphService.md): Information about an application that processed requests, users that made requests, or downstream services, resources, and applications that an application used.
- [InsightsConfiguration](https://docs.aws.amazon.com/xray/latest/api/API_InsightsConfiguration.md): The structure containing configurations related to insights.
- [InsightSummary](https://docs.aws.amazon.com/xray/latest/api/API_InsightSummary.md): Information that describes an insight.
- [InstanceIdDetail](https://docs.aws.amazon.com/xray/latest/api/API_InstanceIdDetail.md): A list of EC2 instance IDs corresponding to the segments in a trace.
- [ProbabilisticRuleValue](https://docs.aws.amazon.com/xray/latest/api/API_ProbabilisticRuleValue.md): The indexing rule configuration for probabilistic sampling.
- [ProbabilisticRuleValueUpdate](https://docs.aws.amazon.com/xray/latest/api/API_ProbabilisticRuleValueUpdate.md): Update to the indexing rule configuration for probabilistic sampling.
- [RequestImpactStatistics](https://docs.aws.amazon.com/xray/latest/api/API_RequestImpactStatistics.md): Statistics that describe how the incident has impacted a service.
- [ResourceARNDetail](https://docs.aws.amazon.com/xray/latest/api/API_ResourceARNDetail.md): A list of resources ARNs corresponding to the segments in a trace.
- [ResourcePolicy](https://docs.aws.amazon.com/xray/latest/api/API_ResourcePolicy.md): A resource policy grants one or more AWS services and accounts permissions to access X-Ray.
- [ResponseTimeRootCause](https://docs.aws.amazon.com/xray/latest/api/API_ResponseTimeRootCause.md): The root cause information for a response time warning.
- [ResponseTimeRootCauseEntity](https://docs.aws.amazon.com/xray/latest/api/API_ResponseTimeRootCauseEntity.md): A collection of segments and corresponding subsegments associated to a response time warning.
- [ResponseTimeRootCauseService](https://docs.aws.amazon.com/xray/latest/api/API_ResponseTimeRootCauseService.md): A collection of fields identifying the service in a response time warning.
- [RetrievedService](https://docs.aws.amazon.com/xray/latest/api/API_RetrievedService.md): Retrieved information about an application that processed requests, users that made requests, or downstream services, resources, and applications that an application used.
- [RetrievedTrace](https://docs.aws.amazon.com/xray/latest/api/API_RetrievedTrace.md): Retrieved collection of spans with matching trace IDs.
- [RootCauseException](https://docs.aws.amazon.com/xray/latest/api/API_RootCauseException.md): The exception associated with a root cause.
- [SamplingBoost](https://docs.aws.amazon.com/xray/latest/api/API_SamplingBoost.md): Temporary boost sampling rate.
- [SamplingBoostStatisticsDocument](https://docs.aws.amazon.com/xray/latest/api/API_SamplingBoostStatisticsDocument.md): Request anomaly stats for a single rule from a service.
- [SamplingRateBoost](https://docs.aws.amazon.com/xray/latest/api/API_SamplingRateBoost.md): Enable temporary sampling rate increases when you detect anomalies to improve visibility.
- [SamplingRule](https://docs.aws.amazon.com/xray/latest/api/API_SamplingRule.md): A sampling rule that services use to decide whether to instrument a request.
- [SamplingRuleRecord](https://docs.aws.amazon.com/xray/latest/api/API_SamplingRuleRecord.md): A SamplingRule and its metadata.
- [SamplingRuleUpdate](https://docs.aws.amazon.com/xray/latest/api/API_SamplingRuleUpdate.md): A document specifying changes to a sampling rule's configuration.
- [SamplingStatisticsDocument](https://docs.aws.amazon.com/xray/latest/api/API_SamplingStatisticsDocument.md): Request sampling results for a single rule from a service.
- [SamplingStatisticSummary](https://docs.aws.amazon.com/xray/latest/api/API_SamplingStatisticSummary.md): Aggregated request sampling data for a sampling rule across all services for a 10-second window.
- [SamplingStrategy](https://docs.aws.amazon.com/xray/latest/api/API_SamplingStrategy.md): The name and value of a sampling rule to apply to a trace summary.
- [SamplingTargetDocument](https://docs.aws.amazon.com/xray/latest/api/API_SamplingTargetDocument.md): Temporary changes to a sampling rule configuration.
- [Segment](https://docs.aws.amazon.com/xray/latest/api/API_Segment.md): A segment from a trace that has been ingested by the X-Ray service.
- [Service](https://docs.aws.amazon.com/xray/latest/api/API_Service.md): Information about an application that processed requests, users that made requests, or downstream services, resources, and applications that an application used.
- [ServiceId](https://docs.aws.amazon.com/xray/latest/api/API_ServiceId.md)
- [ServiceStatistics](https://docs.aws.amazon.com/xray/latest/api/API_ServiceStatistics.md): Response statistics for a service.
- [Span](https://docs.aws.amazon.com/xray/latest/api/API_Span.md): A span from a trace that has been ingested by the X-Ray service.
- [Tag](https://docs.aws.amazon.com/xray/latest/api/API_Tag.md): A map that contains tag keys and tag values to attach to an AWS X-Ray group or sampling rule.
- [TelemetryRecord](https://docs.aws.amazon.com/xray/latest/api/API_TelemetryRecord.md)
- [TimeSeriesServiceStatistics](https://docs.aws.amazon.com/xray/latest/api/API_TimeSeriesServiceStatistics.md): A list of TimeSeriesStatistic structures.
- [Trace](https://docs.aws.amazon.com/xray/latest/api/API_Trace.md): A collection of segment documents with matching trace IDs.
- [TraceSummary](https://docs.aws.amazon.com/xray/latest/api/API_TraceSummary.md): Metadata generated from the segment documents in a trace.
- [TraceUser](https://docs.aws.amazon.com/xray/latest/api/API_TraceUser.md): Information about a user recorded in segment documents.
- [UnprocessedStatistics](https://docs.aws.amazon.com/xray/latest/api/API_UnprocessedStatistics.md): Sampling statistics from a call to GetSamplingTargets that X-Ray could not process.
- [UnprocessedTraceSegment](https://docs.aws.amazon.com/xray/latest/api/API_UnprocessedTraceSegment.md): Information about a segment that failed processing.
- [ValueWithServiceIds](https://docs.aws.amazon.com/xray/latest/api/API_ValueWithServiceIds.md): Information about a segment annotation.


## Full content

The entire guide is also available as a single markdown file, useful for feeding the full guide to an LLM in one pass:

- [Complete guide (single file)](https://docs.aws.amazon.com/xray/latest/api/full.md)