Values (p.awso.0.9.0.doc.awso.xray.Awso

Sourceval service : Awso.Service.t

Sourceval apiVersion : string

Sourceval endpointPrefix : string

Sourceval serviceFullName : string

Sourceval signatureVersion : string

Sourceval protocol : string

Sourceval globalEndpoint : string

Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t

Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t

Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t

Source

val structure_to_value_aux : 
  ('a * 'b option) list ->
  f:(('a * 'b) list -> 'c) ->
  [> `Structure of 'c ]

Source

val structure_to_value : 
  ('a * 'b option) list ->
  [> `Structure of ('a * 'b) list ]

Source

val structure_to_wrapped_value : 
  wrapper:'a ->
  response:'a ->
  ('b * 'c option) list ->
  [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]

Sourcemodule String_ : sig ... end

Sourcemodule RootCauseException : sig ... end

The exception associated with a root cause.

Sourcemodule NullableBoolean : sig ... end

Sourcemodule RootCauseExceptions : sig ... end

Sourcemodule NullableDouble : sig ... end

Sourcemodule ServiceNames : sig ... end

Sourcemodule ErrorRootCauseEntity : sig ... end

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

Sourcemodule FaultRootCauseEntity : sig ... end

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

Sourcemodule ResponseTimeRootCauseEntity : sig ... end

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

Sourcemodule AliasNames : sig ... end

Sourcemodule NullableLong : sig ... end

Sourcemodule Double : sig ... end

Sourcemodule Integer : sig ... end

Sourcemodule ServiceId : sig ... end

Sourcemodule ErrorRootCauseEntityPath : sig ... end

Sourcemodule FaultRootCauseEntityPath : sig ... end

Sourcemodule ResponseTimeRootCauseEntityPath : sig ... end

Sourcemodule Alias : sig ... end

An alias for an edge.

Sourcemodule ErrorStatistics : sig ... end

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

Sourcemodule FaultStatistics : sig ... end

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

Sourcemodule HistogramEntry : sig ... end

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.

Sourcemodule AnnotationValue : sig ... end

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

Sourcemodule ServiceIds : sig ... end

Sourcemodule ErrorRootCauseService : sig ... end

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

Sourcemodule FaultRootCauseService : sig ... end

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

Sourcemodule ResponseTimeRootCauseService : sig ... end

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

Sourcemodule TraceId : sig ... end

Sourcemodule AliasList : sig ... end

Sourcemodule EdgeStatistics : sig ... end

Response statistics for an edge.

Sourcemodule Histogram : sig ... end

Sourcemodule NullableInteger : sig ... end

Sourcemodule Timestamp : sig ... end

Sourcemodule SpanDocument : sig ... end

Sourcemodule SpanId : sig ... end

Sourcemodule ValueWithServiceIds : sig ... end

Information about a segment annotation.

Sourcemodule ErrorRootCauseServices : sig ... end

Sourcemodule FaultRootCauseServices : sig ... end

Sourcemodule ResponseTimeRootCauseServices : sig ... end

Sourcemodule AttributeKey : sig ... end

Sourcemodule AttributeValue : sig ... end

Sourcemodule CooldownWindowMinutes : sig ... end

Sourcemodule MaxRate : sig ... end

Sourcemodule TraceIdList : sig ... end

Sourcemodule Edge : sig ... end

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.

Sourcemodule SegmentDocument : sig ... end

Sourcemodule SegmentId : sig ... end

Sourcemodule Span : sig ... end

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.

Sourcemodule AnnotationKey : sig ... end

Sourcemodule ValuesWithServiceIds : sig ... end

Sourcemodule ErrorRootCause : sig ... end

The root cause of a trace summary error.

Sourcemodule FaultRootCause : sig ... end

The root cause information for a trace summary fault.

Sourcemodule ResponseTimeRootCause : sig ... end

The root cause information for a response time warning.

Sourcemodule AvailabilityZoneDetail : sig ... end

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

Sourcemodule InstanceIdDetail : sig ... end

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

Sourcemodule ResourceARNDetail : sig ... end

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

Sourcemodule TraceUser : sig ... end

Information about a user recorded in segment documents.

Sourcemodule AttributeMap : sig ... end

Sourcemodule FixedRate : sig ... end

Sourcemodule HTTPMethod : sig ... end

Sourcemodule Host : sig ... end

Sourcemodule Priority : sig ... end

Sourcemodule ReservoirSize : sig ... end

Sourcemodule ResourceARN : sig ... end

Sourcemodule RuleName : sig ... end

Sourcemodule SamplingRateBoost : sig ... end

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

Sourcemodule ServiceName : sig ... end

Sourcemodule ServiceType : sig ... end

Sourcemodule URLPath : sig ... end

Sourcemodule Version : sig ... end

Sourcemodule GraphLink : sig ... end

The relation between two services.

Sourcemodule EdgeList : sig ... end

Sourcemodule ServiceStatistics : sig ... end

Response statistics for a service.

Sourcemodule AnomalousService : sig ... end

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

Sourcemodule InsightCategory : sig ... end

Sourcemodule InsightImpactGraphEdge : sig ... end

The connection between two service in an insight impact graph.

Sourcemodule ProbabilisticRuleValue : sig ... end

The indexing rule configuration for probabilistic sampling.

Sourcemodule Segment : sig ... end

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.

Sourcemodule TagKey : sig ... end

Sourcemodule TagValue : sig ... end

Sourcemodule BackendConnectionErrors : sig ... end

Sourcemodule SpanList : sig ... end

Sourcemodule PolicyDocument : sig ... end

Sourcemodule PolicyName : sig ... end

Sourcemodule PolicyRevisionId : sig ... end

Sourcemodule Annotations : sig ... end

Sourcemodule ErrorRootCauses : sig ... end

Sourcemodule FaultRootCauses : sig ... end

Sourcemodule Http : sig ... end

Information about an HTTP request.

Sourcemodule ResponseTimeRootCauses : sig ... end

Sourcemodule TraceAvailabilityZones : sig ... end

Sourcemodule TraceInstanceIds : sig ... end

Sourcemodule TraceResourceARNs : sig ... end

Sourcemodule TraceUsers : sig ... end

Sourcemodule ForecastStatistics : sig ... end

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.

Sourcemodule SamplingBoost : sig ... end

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.

Sourcemodule AnomalyCount : sig ... end

Sourcemodule SampledAnomalyCount : sig ... end

Sourcemodule TotalCount : sig ... end

Sourcemodule BorrowCount : sig ... end

Sourcemodule ClientID : sig ... end

Sourcemodule RequestCount : sig ... end

Sourcemodule SampledCount : sig ... end

Sourcemodule SamplingRule : sig ... end

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.

Sourcemodule LinksList : sig ... end

Sourcemodule Service : sig ... end

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

Sourcemodule AnomalousServiceList : sig ... end

Sourcemodule GroupARN : sig ... end

Sourcemodule GroupName : sig ... end

Sourcemodule InsightCategoryList : sig ... end

Sourcemodule InsightId : sig ... end

Sourcemodule InsightState : sig ... end

Sourcemodule InsightSummaryText : sig ... end

Sourcemodule RequestImpactStatistics : sig ... end

Statistics that describe how the incident has impacted a service.

Sourcemodule InsightImpactGraphEdgeList : sig ... end

Sourcemodule EventSummaryText : sig ... end

Sourcemodule IndexingRuleValue : sig ... end

The indexing rule configuration.

Sourcemodule InsightsConfiguration : sig ... end

The structure containing configurations related to insights.

Sourcemodule SegmentList : sig ... end

Sourcemodule ErrorMessage : sig ... end

Sourcemodule AmazonResourceName : sig ... end

Sourcemodule ProbabilisticRuleValueUpdate : sig ... end

Update to the indexing rule configuration for probabilistic sampling.

Sourcemodule Tag : sig ... end

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.

Sourcemodule UnprocessedTraceSegment : sig ... end

Information about a segment that failed processing.

Sourcemodule TraceSegmentDocument : sig ... end

Sourcemodule TelemetryRecord : sig ... end

Sourcemodule EncryptionStatus : sig ... end

Sourcemodule EncryptionType : sig ... end

Sourcemodule RetrievedTrace : sig ... end

Retrieved collection of spans with matching trace IDs.

Sourcemodule ResourcePolicy : sig ... end

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.

Sourcemodule TraceSummary : sig ... end

Metadata generated from the segment documents in a trace.

Sourcemodule SamplingStrategyName : sig ... end

Sourcemodule TimeSeriesServiceStatistics : sig ... end

A list of TimeSeriesStatistic structures.

Sourcemodule SamplingTargetDocument : sig ... end

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.

Sourcemodule UnprocessedStatistics : sig ... end

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

Sourcemodule SamplingBoostStatisticsDocument : sig ... end

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.

Sourcemodule SamplingStatisticsDocument : sig ... end

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.

Sourcemodule SamplingStatisticSummary : sig ... end

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

Sourcemodule SamplingRuleRecord : sig ... end

A SamplingRule and its metadata.

Sourcemodule RetrievedService : sig ... end

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

Sourcemodule InsightSummary : sig ... end

Information that describes an insight.

Sourcemodule InsightImpactGraphService : sig ... end

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

Sourcemodule InsightEvent : sig ... end

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.

Sourcemodule IndexingRule : sig ... end

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

Sourcemodule GroupSummary : sig ... end

Details for a group without metadata.

Sourcemodule Trace : sig ... end

A collection of segment documents with matching trace IDs.

Sourcemodule InvalidRequestException : sig ... end

The request is missing required parameters or has invalid parameters.

Sourcemodule ThrottledException : sig ... end

The request exceeds the maximum number of requests per second.

Sourcemodule TraceSegmentDestination : sig ... end

Sourcemodule TraceSegmentDestinationStatus : sig ... end

Sourcemodule SamplingRuleUpdate : sig ... end

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

Sourcemodule ResourceNotFoundException : sig ... end

The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.

Sourcemodule IndexingRuleValueUpdate : sig ... end

Update to an indexing rule.

Sourcemodule Group : sig ... end

Details and metadata for a group.

Sourcemodule FilterExpression : sig ... end

Sourcemodule TagKeyList : sig ... end

Sourcemodule TooManyTagsException : sig ... end

You have exceeded the maximum number of tags you can apply to this resource.

Sourcemodule TagList : sig ... end

Sourcemodule RetrievalToken : sig ... end

Sourcemodule TraceIdListForRetrieval : sig ... end

Sourcemodule UnprocessedTraceSegmentList : sig ... end

Sourcemodule TraceSegmentDocumentList : sig ... end

Sourcemodule EC2InstanceId : sig ... end

Sourcemodule Hostname : sig ... end

Sourcemodule TelemetryRecordList : sig ... end

Sourcemodule InvalidPolicyRevisionIdException : sig ... end

A policy revision id was provided which does not match the latest policy revision. This exception is also if a policy revision id of 0 is provided via PutResourcePolicy and a policy with the same name already exists.

Sourcemodule LockoutPreventionException : sig ... end

The provided resource policy would prevent the caller of this request from calling PutResourcePolicy in the future.

Sourcemodule MalformedPolicyDocumentException : sig ... end

Invalid policy document provided in request.

Sourcemodule PolicyCountLimitExceededException : sig ... end

Exceeded the maximum number of resource policies for a target Amazon Web Services account.

Sourcemodule PolicySizeLimitExceededException : sig ... end

Exceeded the maximum size for a resource policy.

Sourcemodule Boolean : sig ... end

Sourcemodule EncryptionConfig : sig ... end

A configuration document that specifies encryption configuration settings.

Sourcemodule EncryptionKeyId : sig ... end

Sourcemodule RetrievalStatus : sig ... end

Sourcemodule TraceFormatType : sig ... end

Sourcemodule TraceSpanList : sig ... end

Sourcemodule ResourcePolicyList : sig ... end

Sourcemodule ResourcePolicyNextToken : sig ... end

Sourcemodule TraceSummaryList : sig ... end

Sourcemodule SamplingStrategy : sig ... end

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

Sourcemodule TimeRangeType : sig ... end

Sourcemodule ServiceList : sig ... end

Sourcemodule TimeSeriesServiceStatisticsList : sig ... end

Sourcemodule EntitySelectorExpression : sig ... end

Sourcemodule SamplingTargetDocumentList : sig ... end

Sourcemodule UnprocessedStatisticsList : sig ... end

Sourcemodule SamplingBoostStatisticsDocumentList : sig ... end

Sourcemodule SamplingStatisticsDocumentList : sig ... end

Sourcemodule SamplingStatisticSummaryList : sig ... end

Sourcemodule SamplingRuleRecordList : sig ... end

Sourcemodule RetrievedServicesList : sig ... end

Sourcemodule InsightSummaryList : sig ... end

Sourcemodule Token : sig ... end

Sourcemodule GetInsightSummariesMaxResults : sig ... end

Sourcemodule InsightStateList : sig ... end

Sourcemodule Insight : sig ... end

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

Sourcemodule InsightImpactGraphServiceList : sig ... end

Sourcemodule InsightEventList : sig ... end

Sourcemodule GetInsightEventsMaxResults : sig ... end

Sourcemodule IndexingRuleList : sig ... end

Sourcemodule GroupSummaryList : sig ... end

Sourcemodule GetGroupsNextToken : sig ... end

Sourcemodule RuleLimitExceededException : sig ... end

You have reached the maximum number of sampling rules.

Sourcemodule TraceList : sig ... end

Sourcemodule UnprocessedTraceIdList : sig ... end

Sourcemodule UpdateTraceSegmentDestinationResult : sig ... end

Modifies the destination of data sent to PutTraceSegments. The Transaction Search feature requires the CloudWatchLogs destination. For more information, see Transaction Search.

Sourcemodule UpdateTraceSegmentDestinationRequest : sig ... end

Modifies the destination of data sent to PutTraceSegments. The Transaction Search feature requires the CloudWatchLogs destination. For more information, see Transaction Search.

Sourcemodule UpdateSamplingRuleResult : sig ... end

Modifies a sampling rule's configuration.

Sourcemodule UpdateSamplingRuleRequest : sig ... end

Modifies a sampling rule's configuration.

Sourcemodule UpdateIndexingRuleResult : sig ... end

Modifies an indexing rule’s configuration. Indexing rules are used for determining the sampling rate for spans indexed from CloudWatch Logs. For more information, see Transaction Search.

Sourcemodule UpdateIndexingRuleRequest : sig ... end

Modifies an indexing rule’s configuration. Indexing rules are used for determining the sampling rate for spans indexed from CloudWatch Logs. For more information, see Transaction Search.

Sourcemodule UpdateGroupResult : sig ... end

Updates a group resource.

Sourcemodule UpdateGroupRequest : sig ... end

Updates a group resource.

Sourcemodule UntagResourceResponse : sig ... end

Removes tags from an Amazon Web Services X-Ray group or sampling rule. You cannot edit or delete system tags (those with an aws: prefix).

Sourcemodule UntagResourceRequest : sig ... end

Removes tags from an Amazon Web Services X-Ray group or sampling rule. You cannot edit or delete system tags (those with an aws: prefix).

Sourcemodule TagResourceResponse : sig ... end

Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.

Sourcemodule TagResourceRequest : sig ... end

Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.

Sourcemodule StartTraceRetrievalResult : sig ... end

Initiates a trace retrieval process using the specified time range and for the given trace IDs in the Transaction Search generated CloudWatch log group. For more information, see Transaction Search. API returns a RetrievalToken, which can be used with ListRetrievedTraces or GetRetrievedTracesGraph to fetch results. Retrievals will time out after 60 minutes. To execute long time ranges, consider segmenting into multiple retrievals. If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to retrieve data from a linked source account, as long as both accounts have transaction search enabled. For retrieving data from X-Ray directly as opposed to the Transaction-Search Log group, see BatchGetTraces.

Sourcemodule StartTraceRetrievalRequest : sig ... end

Initiates a trace retrieval process using the specified time range and for the given trace IDs in the Transaction Search generated CloudWatch log group. For more information, see Transaction Search. API returns a RetrievalToken, which can be used with ListRetrievedTraces or GetRetrievedTracesGraph to fetch results. Retrievals will time out after 60 minutes. To execute long time ranges, consider segmenting into multiple retrievals. If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to retrieve data from a linked source account, as long as both accounts have transaction search enabled. For retrieving data from X-Ray directly as opposed to the Transaction-Search Log group, see BatchGetTraces.

Sourcemodule PutTraceSegmentsResult : sig ... end

Uploads segment documents to Amazon Web Services X-Ray. A segment document can be a completed segment, an in-progress segment, or an array of subsegments. Segments must include the following fields. For the full segment document schema, see Amazon Web Services X-Ray Segment Documents in the Amazon Web Services X-Ray Developer Guide. Required segment document fields name - The name of the service that handled the request. id - A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal digits. trace_id - A unique identifier that connects all segments and subsegments originating from a single client request. start_time - Time the segment or subsegment was created, in floating point seconds in epoch time, accurate to milliseconds. For example, 1480615200.010 or 1.480615200010E9. end_time - Time the segment or subsegment was closed. For example, 1480615200.090 or 1.480615200090E9. Specify either an end_time or in_progress. in_progress - Set to true instead of specifying an end_time to record that a segment has been started, but is not complete. Send an in-progress segment when your application receives a request that will take a long time to serve, to trace that the request was received. When the response is sent, send the complete segment to overwrite the in-progress segment. A trace_id consists of three numbers separated by hyphens. For example, 1-58406520-a006649127e371903a2de979. For trace IDs created by an X-Ray SDK, or by Amazon Web Services services integrated with X-Ray, a trace ID includes: Trace ID Format The version number, for instance, 1. The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For example, 10:00AM December 2nd, 2016 PST in epoch time is 1480615200 seconds, or 58406520 in hexadecimal. A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits. Trace IDs created via OpenTelemetry have a different format based on the W3C Trace Context specification. A W3C trace ID must be formatted in the X-Ray trace ID format when sending to X-Ray. For example, a W3C trace ID 4efaaf4d1e8720b39541901950019ee5 should be formatted as 1-4efaaf4d-1e8720b39541901950019ee5 when sending to X-Ray. While X-Ray trace IDs include the original request timestamp in Unix epoch time, this is not required or validated.

Sourcemodule PutTraceSegmentsRequest : sig ... end

Uploads segment documents to Amazon Web Services X-Ray. A segment document can be a completed segment, an in-progress segment, or an array of subsegments. Segments must include the following fields. For the full segment document schema, see Amazon Web Services X-Ray Segment Documents in the Amazon Web Services X-Ray Developer Guide. Required segment document fields name - The name of the service that handled the request. id - A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal digits. trace_id - A unique identifier that connects all segments and subsegments originating from a single client request. start_time - Time the segment or subsegment was created, in floating point seconds in epoch time, accurate to milliseconds. For example, 1480615200.010 or 1.480615200010E9. end_time - Time the segment or subsegment was closed. For example, 1480615200.090 or 1.480615200090E9. Specify either an end_time or in_progress. in_progress - Set to true instead of specifying an end_time to record that a segment has been started, but is not complete. Send an in-progress segment when your application receives a request that will take a long time to serve, to trace that the request was received. When the response is sent, send the complete segment to overwrite the in-progress segment. A trace_id consists of three numbers separated by hyphens. For example, 1-58406520-a006649127e371903a2de979. For trace IDs created by an X-Ray SDK, or by Amazon Web Services services integrated with X-Ray, a trace ID includes: Trace ID Format The version number, for instance, 1. The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For example, 10:00AM December 2nd, 2016 PST in epoch time is 1480615200 seconds, or 58406520 in hexadecimal. A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits. Trace IDs created via OpenTelemetry have a different format based on the W3C Trace Context specification. A W3C trace ID must be formatted in the X-Ray trace ID format when sending to X-Ray. For example, a W3C trace ID 4efaaf4d1e8720b39541901950019ee5 should be formatted as 1-4efaaf4d-1e8720b39541901950019ee5 when sending to X-Ray. While X-Ray trace IDs include the original request timestamp in Unix epoch time, this is not required or validated.

Sourcemodule PutTelemetryRecordsResult : sig ... end

Used by the Amazon Web Services X-Ray daemon to upload telemetry.

Sourcemodule PutTelemetryRecordsRequest : sig ... end

Used by the Amazon Web Services X-Ray daemon to upload telemetry.

Sourcemodule PutResourcePolicyResult : sig ... end

Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access X-Ray. Each resource policy will be associated with a specific Amazon Web Services account. Each Amazon Web Services account can have a maximum of 5 resource policies, and each policy name must be unique within that account. The maximum size of each resource policy is 5KB.

Sourcemodule PutResourcePolicyRequest : sig ... end

Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access X-Ray. Each resource policy will be associated with a specific Amazon Web Services account. Each Amazon Web Services account can have a maximum of 5 resource policies, and each policy name must be unique within that account. The maximum size of each resource policy is 5KB.

Sourcemodule PutEncryptionConfigResult : sig ... end

Updates the encryption configuration for X-Ray data.

Sourcemodule PutEncryptionConfigRequest : sig ... end

Updates the encryption configuration for X-Ray data.

Sourcemodule ListTagsForResourceResponse : sig ... end

Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.

Sourcemodule ListTagsForResourceRequest : sig ... end

Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.

Sourcemodule ListRetrievedTracesResult : sig ... end

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.

Sourcemodule ListRetrievedTracesRequest : sig ... end

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.

Sourcemodule ListResourcePoliciesResult : sig ... end

Returns the list of resource policies in the target Amazon Web Services account.

Sourcemodule ListResourcePoliciesRequest : sig ... end

Returns the list of resource policies in the target Amazon Web Services account.

Sourcemodule GetTraceSummariesResult : sig ... end

Retrieves IDs and annotations for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to BatchGetTraces. A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come from a known user. For example, the following filter expression targets traces that pass through api.example.com: service("api.example.com") This filter expression finds traces that have an annotation named account with the value 12345: annotation.account = "12345" For a full list of indexed fields and keywords that you can use in filter expressions, see Use filter expressions in the Amazon Web Services X-Ray Developer Guide.

Sourcemodule GetTraceSummariesRequest : sig ... end

Retrieves IDs and annotations for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to BatchGetTraces. A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come from a known user. For example, the following filter expression targets traces that pass through api.example.com: service("api.example.com") This filter expression finds traces that have an annotation named account with the value 12345: annotation.account = "12345" For a full list of indexed fields and keywords that you can use in filter expressions, see Use filter expressions in the Amazon Web Services X-Ray Developer Guide.

Sourcemodule GetTraceSegmentDestinationResult : sig ... end

Retrieves the current destination of data sent to PutTraceSegments and OpenTelemetry protocol (OTLP) endpoint. The Transaction Search feature requires a CloudWatchLogs destination. For more information, see Transaction Search and OpenTelemetry.

Sourcemodule GetTraceSegmentDestinationRequest : sig ... end

Retrieves the current destination of data sent to PutTraceSegments and OpenTelemetry protocol (OTLP) endpoint. The Transaction Search feature requires a CloudWatchLogs destination. For more information, see Transaction Search and OpenTelemetry.

Sourcemodule GetTraceGraphResult : sig ... end

Retrieves a service graph for one or more specific trace IDs.

Sourcemodule GetTraceGraphRequest : sig ... end

Retrieves a service graph for one or more specific trace IDs.

Sourcemodule GetTimeSeriesServiceStatisticsResult : sig ... end

Get an aggregation of service statistics defined by a specific time range.

Sourcemodule GetTimeSeriesServiceStatisticsRequest : sig ... end

Get an aggregation of service statistics defined by a specific time range.

Sourcemodule GetServiceGraphResult : sig ... end

Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the Amazon Web Services X-Ray SDK. Downstream services can be other applications, Amazon Web Services resources, HTTP web APIs, or SQL databases.

Sourcemodule GetServiceGraphRequest : sig ... end

Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the Amazon Web Services X-Ray SDK. Downstream services can be other applications, Amazon Web Services resources, HTTP web APIs, or SQL databases.

Sourcemodule GetSamplingTargetsResult : sig ... end

Requests a sampling quota for rules that the service is using to sample requests.

Sourcemodule GetSamplingTargetsRequest : sig ... end

Requests a sampling quota for rules that the service is using to sample requests.

Sourcemodule GetSamplingStatisticSummariesResult : sig ... end

Retrieves information about recent sampling results for all sampling rules.

Sourcemodule GetSamplingStatisticSummariesRequest : sig ... end

Retrieves information about recent sampling results for all sampling rules.

Sourcemodule GetSamplingRulesResult : sig ... end

Retrieves all sampling rules.

Sourcemodule GetSamplingRulesRequest : sig ... end

Retrieves all sampling rules.

Sourcemodule GetRetrievedTracesGraphResult : sig ... end

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.

Sourcemodule GetRetrievedTracesGraphRequest : sig ... end

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.

Sourcemodule GetInsightSummariesResult : sig ... end

Retrieves the summaries of all insights in the specified group matching the provided filter values.

Sourcemodule GetInsightSummariesRequest : sig ... end

Retrieves the summaries of all insights in the specified group matching the provided filter values.

Sourcemodule GetInsightResult : sig ... end

Retrieves the summary information of an insight. This includes impact to clients and root cause services, the top anomalous services, the category, the state of the insight, and the start and end time of the insight.

Sourcemodule GetInsightRequest : sig ... end

Retrieves the summary information of an insight. This includes impact to clients and root cause services, the top anomalous services, the category, the state of the insight, and the start and end time of the insight.

Sourcemodule GetInsightImpactGraphResult : sig ... end

Retrieves a service graph structure filtered by the specified insight. The service graph is limited to only structural information. For a complete service graph, use this API with the GetServiceGraph API.

Sourcemodule GetInsightImpactGraphRequest : sig ... end

Retrieves a service graph structure filtered by the specified insight. The service graph is limited to only structural information. For a complete service graph, use this API with the GetServiceGraph API.

Sourcemodule GetInsightEventsResult : sig ... end

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

Sourcemodule GetInsightEventsRequest : sig ... end

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

Sourcemodule GetIndexingRulesResult : sig ... end

Retrieves 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. For more information, see Transaction Search.

Sourcemodule GetIndexingRulesRequest : sig ... end

Retrieves 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. For more information, see Transaction Search.

Sourcemodule GetGroupsResult : sig ... end

Retrieves all active group details.

Sourcemodule GetGroupsRequest : sig ... end

Retrieves all active group details.

Sourcemodule GetGroupResult : sig ... end

Retrieves group resource details.

Sourcemodule GetGroupRequest : sig ... end

Retrieves group resource details.

Sourcemodule GetEncryptionConfigResult : sig ... end

Retrieves the current encryption configuration for X-Ray data.

Sourcemodule GetEncryptionConfigRequest : sig ... end

Retrieves the current encryption configuration for X-Ray data.

Sourcemodule DeleteSamplingRuleResult : sig ... end

Deletes a sampling rule.

Sourcemodule DeleteSamplingRuleRequest : sig ... end

Deletes a sampling rule.

Sourcemodule DeleteResourcePolicyResult : sig ... end

Deletes a resource policy from the target Amazon Web Services account.

Sourcemodule DeleteResourcePolicyRequest : sig ... end

Deletes a resource policy from the target Amazon Web Services account.

Sourcemodule DeleteGroupResult : sig ... end

Deletes a group resource.

Sourcemodule DeleteGroupRequest : sig ... end

Deletes a group resource.

Sourcemodule CreateSamplingRuleResult : sig ... end

Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with GetSamplingRules, and evaluate each rule in ascending order of priority for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with GetSamplingTargets to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir.

Sourcemodule CreateSamplingRuleRequest : sig ... end

Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with GetSamplingRules, and evaluate each rule in ascending order of priority for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with GetSamplingTargets to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir.

Sourcemodule CreateGroupResult : sig ... end

Creates a group resource with a name and a filter expression.

Sourcemodule CreateGroupRequest : sig ... end

Creates a group resource with a name and a filter expression.

Sourcemodule CancelTraceRetrievalResult : sig ... end

Cancels an ongoing trace retrieval job initiated by StartTraceRetrieval using the provided RetrievalToken. A successful cancellation will return an HTTP 200 response.

Sourcemodule CancelTraceRetrievalRequest : sig ... end

Cancels an ongoing trace retrieval job initiated by StartTraceRetrieval using the provided RetrievalToken. A successful cancellation will return an HTTP 200 response.

Sourcemodule BatchGetTracesResult : sig ... end

You cannot find traces through this API if Transaction Search is enabled since trace is not indexed in X-Ray. Retrieves 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.

Sourcemodule BatchGetTracesRequest : sig ... end

You cannot find traces through this API if Transaction Search is enabled since trace is not indexed in X-Ray. Retrieves 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.