Module types 

Data structures used by operation inputs/outputs.

Modules

builders

Builders

error

Error types that AWS X-Ray can respond with.

Structs

Alias

An alias for an edge.

AnomalousService

The service within the service graph that has anomalously high fault rates.

AvailabilityZoneDetail

A list of Availability Zones corresponding to the segments in a trace.

BackendConnectionErrors

Edge

Information about a connection between two services. An edge can be a synchronous connection, such as typical call between client and service, or an asynchronous link, such as a Lambda function which retrieves an event from an SNS queue.

EdgeStatistics

Response statistics for an edge.

EncryptionConfig

A configuration document that specifies encryption configuration settings.

ErrorRootCause

The root cause of a trace summary error.

ErrorRootCauseEntity

A collection of segments and corresponding subsegments associated to a trace summary error.

ErrorRootCauseService

A collection of fields identifying the services in a trace summary error.

ErrorStatistics

Information about requests that failed with a 4xx Client Error status code.

FaultRootCause

The root cause information for a trace summary fault.

FaultRootCauseEntity

A collection of segments and corresponding subsegments associated to a trace summary fault error.

FaultRootCauseService

A collection of fields identifying the services in a trace summary fault.

FaultStatistics

Information about requests that failed with a 5xx Server Error status code.

ForecastStatistics

The predicted high and low fault count. This is used to determine if a service has become anomalous and if an insight should be created.

GraphLink

The relation between two services.

Group

Details and metadata for a group.

GroupSummary

Details for a group without metadata.

HistogramEntry

An entry in a histogram for a statistic. A histogram maps the range of observed values on the X axis, and the prevalence of each value on the Y axis.

Http

Information about an HTTP request.

IndexingRule

Rule used to determine the server-side sampling rate for spans ingested through the CloudWatchLogs destination and indexed by X-Ray.

Insight

When fault rates go outside of the expected range, X-Ray creates an insight. Insights tracks emergent issues within your applications.

InsightEvent

X-Ray reevaluates insights periodically until they are resolved, and records each intermediate state in an event. You can review incident events in the Impact Timeline on the Inspect page in the X-Ray console.

InsightImpactGraphEdge

The connection between two service in an insight impact graph.

InsightImpactGraphService

Information about an application that processed requests, users that made requests, or downstream services, resources, and applications that an application used.

InsightSummary

Information that describes an insight.

InsightsConfiguration

The structure containing configurations related to insights.

InstanceIdDetail

A list of EC2 instance IDs corresponding to the segments in a trace.

ProbabilisticRuleValue

The indexing rule configuration for probabilistic sampling.

ProbabilisticRuleValueUpdate

Update to the indexing rule configuration for probabilistic sampling.

RequestImpactStatistics

Statistics that describe how the incident has impacted a service.

ResourceArnDetail

A list of resources ARNs corresponding to the segments in a trace.

ResourcePolicy

A resource policy grants one or more Amazon Web Services services and accounts permissions to access X-Ray. Each resource policy is associated with a specific Amazon Web Services account.

ResponseTimeRootCause

The root cause information for a response time warning.

ResponseTimeRootCauseEntity

A collection of segments and corresponding subsegments associated to a response time warning.

ResponseTimeRootCauseService

A collection of fields identifying the service in a response time warning.

RetrievedService

Retrieved information about an application that processed requests, users that made requests, or downstream services, resources, and applications that an application used.

RetrievedTrace

Retrieved collection of spans with matching trace IDs.

RootCauseException

The exception associated with a root cause.

SamplingBoost

Temporary boost sampling rate. X-Ray calculates sampling boost for each service based on the recent sampling boost stats of all services that called GetSamplingTargets.

SamplingBoostStatisticsDocument

Request anomaly stats for a single rule from a service. Results are for the last 10 seconds unless the service has been assigned a longer reporting interval after a previous call to GetSamplingTargets.

SamplingRateBoost

Enable temporary sampling rate increases when you detect anomalies to improve visibility.

SamplingRule

A sampling rule that services use to decide whether to instrument a request. Rule fields can match properties of the service, or properties of a request. The service can ignore rules that don't match its properties.

SamplingRuleRecord

A SamplingRule and its metadata.

SamplingRuleUpdate

A document specifying changes to a sampling rule's configuration.

SamplingStatisticSummary

Aggregated request sampling data for a sampling rule across all services for a 10-second window.

SamplingStatisticsDocument

Request sampling results for a single rule from a service. Results are for the last 10 seconds unless the service has been assigned a longer reporting interval after a previous call to GetSamplingTargets.

SamplingStrategy

The name and value of a sampling rule to apply to a trace summary.

SamplingTargetDocument

Temporary changes to a sampling rule configuration. To meet the global sampling target for a rule, X-Ray calculates a new reservoir for each service based on the recent sampling results of all services that called GetSamplingTargets.

Segment

A segment from a trace that has been ingested by the X-Ray service. The segment can be compiled from documents uploaded with PutTraceSegments, or an inferred segment for a downstream service, generated from a subsegment sent by the service that called it.

For the full segment document schema, see Amazon Web Services X-Ray segment documents in the Amazon Web Services X-Ray Developer Guide.

Service

Information about an application that processed requests, users that made requests, or downstream services, resources, and applications that an application used.

ServiceId

ServiceStatistics

Response statistics for a service.

Span

A span from a trace that has been ingested by the X-Ray service. A span represents a unit of work or an operation performed by a service.

Tag

A map that contains tag keys and tag values to attach to an Amazon Web Services X-Ray group or sampling rule. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

The following restrictions apply to tags:

• Maximum number of user-applied tags per resource: 50

• Tag keys and values are case sensitive.

• Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use. You cannot edit or delete system tags.

TelemetryRecord

TimeSeriesServiceStatistics

A list of TimeSeriesStatistic structures.

Trace

A collection of segment documents with matching trace IDs.

TraceSummary

Metadata generated from the segment documents in a trace.

TraceUser

Information about a user recorded in segment documents.

UnprocessedStatistics

Sampling statistics from a call to GetSamplingTargets that X-Ray could not process.

UnprocessedTraceSegment

Information about a segment that failed processing.

ValueWithServiceIds

Information about a segment annotation.

Enums

AnnotationValue

Value of a segment annotation. Has one of three value types: Number, Boolean, or String.

EncryptionStatus

When writing a match expression against EncryptionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EncryptionType

When writing a match expression against EncryptionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

IndexingRuleValue

The indexing rule configuration.

IndexingRuleValueUpdate

Update to an indexing rule.

InsightCategory

When writing a match expression against InsightCategory, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

InsightState

When writing a match expression against InsightState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RetrievalStatus

When writing a match expression against RetrievalStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SamplingStrategyName

When writing a match expression against SamplingStrategyName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

TimeRangeType

When writing a match expression against TimeRangeType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

TraceFormatType

When writing a match expression against TraceFormatType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

TraceSegmentDestination

When writing a match expression against TraceSegmentDestination, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

TraceSegmentDestinationStatus

When writing a match expression against TraceSegmentDestinationStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.