Amazon Web Services X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.
', 'operations' => [ 'BatchGetTraces' => '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.
Creates a group resource with a name and a filter expression.
', 'CreateSamplingRule' => '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.
', 'DeleteGroup' => 'Deletes a group resource.
', 'DeleteResourcePolicy' => 'Deletes a resource policy from the target Amazon Web Services account.
', 'DeleteSamplingRule' => 'Deletes a sampling rule.
', 'GetEncryptionConfig' => 'Retrieves the current encryption configuration for X-Ray data.
', 'GetGroup' => 'Retrieves group resource details.
', 'GetGroups' => 'Retrieves all active group details.
', 'GetInsight' => '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.
', 'GetInsightEvents' => '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.
', 'GetInsightImpactGraph' => '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.
', 'GetInsightSummaries' => 'Retrieves the summaries of all insights in the specified group matching the provided filter values.
', 'GetSamplingRules' => 'Retrieves all sampling rules.
', 'GetSamplingStatisticSummaries' => 'Retrieves information about recent sampling results for all sampling rules.
', 'GetSamplingTargets' => 'Requests a sampling quota for rules that the service is using to sample requests.
', 'GetServiceGraph' => '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.
', 'GetTimeSeriesServiceStatistics' => 'Get an aggregation of service statistics defined by a specific time range.
', 'GetTraceGraph' => 'Retrieves a service graph for one or more specific trace IDs.
', 'GetTraceSummaries' => '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 Using Filter Expressions in the Amazon Web Services X-Ray Developer Guide.
', 'ListResourcePolicies' => 'Returns the list of resource policies in the target Amazon Web Services account.
', 'ListTagsForResource' => 'Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.
', 'PutEncryptionConfig' => 'Updates the encryption configuration for X-Ray data.
', 'PutResourcePolicy' => '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.
', 'PutTelemetryRecords' => 'Used by the Amazon Web Services X-Ray daemon to upload telemetry.
', 'PutTraceSegments' => 'Uploads segment documents to Amazon Web Services X-Ray. The X-Ray SDK generates segment documents and sends them to the X-Ray daemon, which uploads them in batches. 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. This 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.
Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.
', 'UntagResource' => '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).
Updates a group resource.
', 'UpdateSamplingRule' => 'Modifies a sampling rule\'s configuration.
', ], 'shapes' => [ 'Alias' => [ 'base' => 'An alias for an edge.
', 'refs' => [ 'AliasList$member' => NULL, ], ], 'AliasList' => [ 'base' => NULL, 'refs' => [ 'Edge$Aliases' => 'Aliases for the edge.
', ], ], 'AliasNames' => [ 'base' => NULL, 'refs' => [ 'Alias$Names' => 'A list of names for the alias, including the canonical name.
', ], ], 'AmazonResourceName' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceRequest$ResourceARN' => 'The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
', 'ResourceNotFoundException$ResourceName' => NULL, 'TagResourceRequest$ResourceARN' => 'The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
', 'TooManyTagsException$ResourceName' => NULL, 'UntagResourceRequest$ResourceARN' => 'The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
', ], ], 'AnnotationKey' => [ 'base' => NULL, 'refs' => [ 'Annotations$key' => NULL, ], ], 'AnnotationValue' => [ 'base' => 'Value of a segment annotation. Has one of three value types: Number, Boolean, or String.
', 'refs' => [ 'ValueWithServiceIds$AnnotationValue' => 'Values of the annotation.
', ], ], 'Annotations' => [ 'base' => NULL, 'refs' => [ 'TraceSummary$Annotations' => 'Annotations from the trace\'s segment documents.
', ], ], 'AnomalousService' => [ 'base' => 'The service within the service graph that has anomalously high fault rates.
', 'refs' => [ 'AnomalousServiceList$member' => NULL, ], ], 'AnomalousServiceList' => [ 'base' => NULL, 'refs' => [ 'Insight$TopAnomalousServices' => 'The service within the insight that is most impacted by the incident.
', 'InsightEvent$TopAnomalousServices' => 'The service during the event that is most impacted by the incident.
', 'InsightSummary$TopAnomalousServices' => 'The service within the insight that is most impacted by the incident.
', ], ], 'AttributeKey' => [ 'base' => NULL, 'refs' => [ 'AttributeMap$key' => NULL, ], ], 'AttributeMap' => [ 'base' => NULL, 'refs' => [ 'SamplingRule$Attributes' => 'Matches attributes derived from the request.
', 'SamplingRuleUpdate$Attributes' => 'Matches attributes derived from the request.
', ], ], 'AttributeValue' => [ 'base' => NULL, 'refs' => [ 'AttributeMap$value' => NULL, ], ], 'AvailabilityZoneDetail' => [ 'base' => 'A list of Availability Zones corresponding to the segments in a trace.
', 'refs' => [ 'TraceAvailabilityZones$member' => NULL, ], ], 'BackendConnectionErrors' => [ 'base' => '', 'refs' => [ 'TelemetryRecord$BackendConnectionErrors' => '', ], ], 'BatchGetTracesRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetTracesResult' => [ 'base' => NULL, 'refs' => [], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'GetServiceGraphResult$ContainsOldGroupVersions' => 'A flag indicating whether the group\'s filter expression has been consistent, or if the returned service graph may show traces from an older version of the group\'s filter expression.
', 'GetTimeSeriesServiceStatisticsResult$ContainsOldGroupVersions' => 'A flag indicating whether or not a group\'s filter expression has been consistent, or if a returned aggregation might show statistics from an older version of the group\'s filter expression.
', 'PutResourcePolicyRequest$BypassPolicyLockoutCheck' => 'A flag to indicate whether to bypass the resource policy lockout safety check.
Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value to true indiscriminately.
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutResourcePolicy request.
The default value is false.
', ], ], 'BorrowCount' => [ 'base' => NULL, 'refs' => [ 'SamplingStatisticsDocument$BorrowCount' => 'The number of requests recorded with borrowed reservoir quota.
', ], ], 'ClientID' => [ 'base' => NULL, 'refs' => [ 'SamplingStatisticsDocument$ClientID' => 'A unique identifier for the service in hexadecimal.
', ], ], 'CreateGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateSamplingRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSamplingRuleResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourcePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourcePolicyResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSamplingRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSamplingRuleResult' => [ 'base' => NULL, 'refs' => [], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'HistogramEntry$Value' => 'The value of the entry.
', 'SamplingTargetDocument$FixedRate' => 'The percentage of matching requests to instrument, after the reservoir is exhausted.
', ], ], 'EC2InstanceId' => [ 'base' => NULL, 'refs' => [ 'PutTelemetryRecordsRequest$EC2InstanceId' => '', ], ], 'Edge' => [ 'base' => '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.
', 'refs' => [ 'EdgeList$member' => NULL, ], ], 'EdgeList' => [ 'base' => NULL, 'refs' => [ 'Service$Edges' => 'Connections to downstream services.
', ], ], 'EdgeStatistics' => [ 'base' => 'Response statistics for an edge.
', 'refs' => [ 'Edge$SummaryStatistics' => 'Response statistics for segments on the edge.
', 'TimeSeriesServiceStatistics$EdgeSummaryStatistics' => NULL, ], ], 'EncryptionConfig' => [ 'base' => 'A configuration document that specifies encryption configuration settings.
', 'refs' => [ 'GetEncryptionConfigResult$EncryptionConfig' => 'The encryption configuration document.
', 'PutEncryptionConfigResult$EncryptionConfig' => 'The new encryption configuration.
', ], ], 'EncryptionKeyId' => [ 'base' => NULL, 'refs' => [ 'PutEncryptionConfigRequest$KeyId' => 'An Amazon Web Services KMS key in one of the following formats:
Alias - The name of the key. For example, alias/MyKey.
Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Amazon Web Services X-Ray does not support asymmetric KMS keys.
ARN - The full Amazon Resource Name of the key ID or alias. For example, arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to specify a key in a different account.
Omit this key if you set Type to NONE.
The encryption status. While the status is UPDATING, X-Ray may encrypt data with a combination of the new and old settings.
The type of encryption. Set to KMS for encryption with KMS keys. Set to NONE for default encryption.
The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for default encryption.
A filter expression defining entities that will be aggregated for statistics. Supports ID, service, and edge functions. If no selector expression is specified, edge statistics are returned.
', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'InvalidPolicyRevisionIdException$Message' => NULL, 'InvalidRequestException$Message' => NULL, 'LockoutPreventionException$Message' => NULL, 'MalformedPolicyDocumentException$Message' => NULL, 'PolicyCountLimitExceededException$Message' => NULL, 'PolicySizeLimitExceededException$Message' => NULL, 'ResourceNotFoundException$Message' => NULL, 'RuleLimitExceededException$Message' => NULL, 'ThrottledException$Message' => NULL, 'TooManyTagsException$Message' => NULL, ], ], 'ErrorRootCause' => [ 'base' => 'The root cause of a trace summary error.
', 'refs' => [ 'ErrorRootCauses$member' => NULL, ], ], 'ErrorRootCauseEntity' => [ 'base' => 'A collection of segments and corresponding subsegments associated to a trace summary error.
', 'refs' => [ 'ErrorRootCauseEntityPath$member' => NULL, ], ], 'ErrorRootCauseEntityPath' => [ 'base' => NULL, 'refs' => [ 'ErrorRootCauseService$EntityPath' => 'The path of root cause entities found on the service.
', ], ], 'ErrorRootCauseService' => [ 'base' => 'A collection of fields identifying the services in a trace summary error.
', 'refs' => [ 'ErrorRootCauseServices$member' => NULL, ], ], 'ErrorRootCauseServices' => [ 'base' => NULL, 'refs' => [ 'ErrorRootCause$Services' => 'A list of services corresponding to an error. A service identifies a segment and it contains a name, account ID, type, and inferred flag.
', ], ], 'ErrorRootCauses' => [ 'base' => NULL, 'refs' => [ 'TraceSummary$ErrorRootCauses' => 'A collection of ErrorRootCause structures corresponding to the trace segments.
', ], ], 'ErrorStatistics' => [ 'base' => 'Information about requests that failed with a 4xx Client Error status code.
', 'refs' => [ 'EdgeStatistics$ErrorStatistics' => 'Information about requests that failed with a 4xx Client Error status code.
', 'ServiceStatistics$ErrorStatistics' => 'Information about requests that failed with a 4xx Client Error status code.
', ], ], 'EventSummaryText' => [ 'base' => NULL, 'refs' => [ 'InsightEvent$Summary' => 'A brief description of the event.
', ], ], 'FaultRootCause' => [ 'base' => 'The root cause information for a trace summary fault.
', 'refs' => [ 'FaultRootCauses$member' => NULL, ], ], 'FaultRootCauseEntity' => [ 'base' => 'A collection of segments and corresponding subsegments associated to a trace summary fault error.
', 'refs' => [ 'FaultRootCauseEntityPath$member' => NULL, ], ], 'FaultRootCauseEntityPath' => [ 'base' => NULL, 'refs' => [ 'FaultRootCauseService$EntityPath' => 'The path of root cause entities found on the service.
', ], ], 'FaultRootCauseService' => [ 'base' => 'A collection of fields identifying the services in a trace summary fault.
', 'refs' => [ 'FaultRootCauseServices$member' => NULL, ], ], 'FaultRootCauseServices' => [ 'base' => NULL, 'refs' => [ 'FaultRootCause$Services' => 'A list of corresponding services. A service identifies a segment and it contains a name, account ID, type, and inferred flag.
', ], ], 'FaultRootCauses' => [ 'base' => NULL, 'refs' => [ 'TraceSummary$FaultRootCauses' => 'A collection of FaultRootCause structures corresponding to the trace segments.
', ], ], 'FaultStatistics' => [ 'base' => 'Information about requests that failed with a 5xx Server Error status code.
', 'refs' => [ 'EdgeStatistics$FaultStatistics' => 'Information about requests that failed with a 5xx Server Error status code.
', 'ServiceStatistics$FaultStatistics' => 'Information about requests that failed with a 5xx Server Error status code.
', ], ], 'FilterExpression' => [ 'base' => NULL, 'refs' => [ 'CreateGroupRequest$FilterExpression' => 'The filter expression defining criteria by which to group traces.
', 'GetTraceSummariesRequest$FilterExpression' => 'Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.
', 'UpdateGroupRequest$FilterExpression' => 'The updated filter expression defining criteria by which to group traces.
', ], ], 'FixedRate' => [ 'base' => NULL, 'refs' => [ 'SamplingRule$FixedRate' => 'The percentage of matching requests to instrument, after the reservoir is exhausted.
', ], ], 'ForecastStatistics' => [ 'base' => '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.
', 'refs' => [ 'TimeSeriesServiceStatistics$ServiceForecastStatistics' => 'The forecasted high and low fault count values.
', ], ], 'GetEncryptionConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetEncryptionConfigResult' => [ 'base' => NULL, 'refs' => [], ], 'GetGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'GetGroupsNextToken' => [ 'base' => NULL, 'refs' => [ 'GetGroupsRequest$NextToken' => 'Pagination token.
', ], ], 'GetGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetGroupsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetInsightEventsMaxResults' => [ 'base' => NULL, 'refs' => [ 'GetInsightEventsRequest$MaxResults' => 'Used to retrieve at most the specified value of events.
', ], ], 'GetInsightEventsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetInsightEventsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetInsightImpactGraphRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetInsightImpactGraphResult' => [ 'base' => NULL, 'refs' => [], ], 'GetInsightRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetInsightResult' => [ 'base' => NULL, 'refs' => [], ], 'GetInsightSummariesMaxResults' => [ 'base' => NULL, 'refs' => [ 'GetInsightSummariesRequest$MaxResults' => 'The maximum number of results to display.
', ], ], 'GetInsightSummariesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetInsightSummariesResult' => [ 'base' => NULL, 'refs' => [], ], 'GetSamplingRulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSamplingRulesResult' => [ 'base' => NULL, 'refs' => [], ], 'GetSamplingStatisticSummariesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSamplingStatisticSummariesResult' => [ 'base' => NULL, 'refs' => [], ], 'GetSamplingTargetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSamplingTargetsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetServiceGraphRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetServiceGraphResult' => [ 'base' => NULL, 'refs' => [], ], 'GetTimeSeriesServiceStatisticsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTimeSeriesServiceStatisticsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetTraceGraphRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTraceGraphResult' => [ 'base' => NULL, 'refs' => [], ], 'GetTraceSummariesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTraceSummariesResult' => [ 'base' => NULL, 'refs' => [], ], 'Group' => [ 'base' => 'Details and metadata for a group.
', 'refs' => [ 'CreateGroupResult$Group' => 'The group that was created. Contains the name of the group that was created, the Amazon Resource Name (ARN) of the group that was generated based on the group name, the filter expression, and the insight configuration that was assigned to the group.
', 'GetGroupResult$Group' => 'The group that was requested. Contains the name of the group, the ARN of the group, the filter expression, and the insight configuration assigned to the group.
', 'UpdateGroupResult$Group' => 'The group that was updated. Contains the name of the group that was updated, the ARN of the group that was updated, the updated filter expression, and the updated insight configuration assigned to the group.
', ], ], 'GroupARN' => [ 'base' => NULL, 'refs' => [ 'DeleteGroupRequest$GroupARN' => 'The ARN of the group that was generated on creation.
', 'GetGroupRequest$GroupARN' => 'The ARN of the group that was generated on creation.
', 'GetInsightSummariesRequest$GroupARN' => 'The Amazon Resource Name (ARN) of the group. Required if the GroupName isn\'t provided.
', 'GetServiceGraphRequest$GroupARN' => 'The Amazon Resource Name (ARN) of a group based on which you want to generate a graph.
', 'GetTimeSeriesServiceStatisticsRequest$GroupARN' => 'The Amazon Resource Name (ARN) of the group for which to pull statistics from.
', 'Insight$GroupARN' => 'The Amazon Resource Name (ARN) of the group that the insight belongs to.
', 'InsightSummary$GroupARN' => 'The Amazon Resource Name (ARN) of the group that the insight belongs to.
', 'UpdateGroupRequest$GroupARN' => 'The ARN that was generated upon creation.
', ], ], 'GroupName' => [ 'base' => NULL, 'refs' => [ 'CreateGroupRequest$GroupName' => 'The case-sensitive name of the new group. Default is a reserved name and names must be unique.
', 'DeleteGroupRequest$GroupName' => 'The case-sensitive name of the group.
', 'GetGroupRequest$GroupName' => 'The case-sensitive name of the group.
', 'GetInsightSummariesRequest$GroupName' => 'The name of the group. Required if the GroupARN isn\'t provided.
', 'GetServiceGraphRequest$GroupName' => 'The name of a group based on which you want to generate a graph.
', 'GetTimeSeriesServiceStatisticsRequest$GroupName' => 'The case-sensitive name of the group for which to pull statistics from.
', 'Insight$GroupName' => 'The name of the group that the insight belongs to.
', 'InsightSummary$GroupName' => 'The name of the group that the insight belongs to.
', 'UpdateGroupRequest$GroupName' => 'The case-sensitive name of the group.
', ], ], 'GroupSummary' => [ 'base' => 'Details for a group without metadata.
', 'refs' => [ 'GroupSummaryList$member' => NULL, ], ], 'GroupSummaryList' => [ 'base' => NULL, 'refs' => [ 'GetGroupsResult$Groups' => 'The collection of all active groups.
', ], ], 'HTTPMethod' => [ 'base' => NULL, 'refs' => [ 'SamplingRule$HTTPMethod' => 'Matches the HTTP method of a request.
', 'SamplingRuleUpdate$HTTPMethod' => 'Matches the HTTP method of a request.
', ], ], 'Histogram' => [ 'base' => NULL, 'refs' => [ 'Edge$ResponseTimeHistogram' => 'A histogram that maps the spread of client response times on an edge. Only populated for synchronous edges.
', 'Edge$ReceivedEventAgeHistogram' => 'A histogram that maps the spread of event age when received by consumers. Age is calculated each time an event is received. Only populated when EdgeType is link.
A histogram that maps the spread of service durations.
', 'Service$ResponseTimeHistogram' => 'A histogram that maps the spread of service response times.
', 'TimeSeriesServiceStatistics$ResponseTimeHistogram' => 'The response time histogram for the selected entities.
', ], ], 'HistogramEntry' => [ 'base' => '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.
', 'refs' => [ 'Histogram$member' => NULL, ], ], 'Host' => [ 'base' => NULL, 'refs' => [ 'SamplingRule$Host' => 'Matches the hostname from a request URL.
', 'SamplingRuleUpdate$Host' => 'Matches the hostname from a request URL.
', ], ], 'Hostname' => [ 'base' => NULL, 'refs' => [ 'PutTelemetryRecordsRequest$Hostname' => '', ], ], 'Http' => [ 'base' => 'Information about an HTTP request.
', 'refs' => [ 'TraceSummary$Http' => 'Information about the HTTP request served by the trace.
', ], ], 'Insight' => [ 'base' => 'When fault rates go outside of the expected range, X-Ray creates an insight. Insights tracks emergent issues within your applications.
', 'refs' => [ 'GetInsightResult$Insight' => 'The summary information of an insight.
', ], ], 'InsightCategory' => [ 'base' => NULL, 'refs' => [ 'InsightCategoryList$member' => NULL, ], ], 'InsightCategoryList' => [ 'base' => NULL, 'refs' => [ 'Insight$Categories' => 'The categories that label and describe the type of insight.
', 'InsightSummary$Categories' => 'Categories The categories that label and describe the type of insight.
', ], ], 'InsightEvent' => [ 'base' => '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.
', 'refs' => [ 'InsightEventList$member' => NULL, ], ], 'InsightEventList' => [ 'base' => NULL, 'refs' => [ 'GetInsightEventsResult$InsightEvents' => 'A detailed description of the event. This includes the time of the event, client and root cause impact statistics, and the top anomalous service at the time of the event.
', ], ], 'InsightId' => [ 'base' => NULL, 'refs' => [ 'GetInsightEventsRequest$InsightId' => 'The insight\'s unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.
', 'GetInsightImpactGraphRequest$InsightId' => 'The insight\'s unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.
', 'GetInsightImpactGraphResult$InsightId' => 'The insight\'s unique identifier.
', 'GetInsightRequest$InsightId' => 'The insight\'s unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.
', 'Insight$InsightId' => 'The insights unique identifier.
', 'InsightSummary$InsightId' => 'The insights unique identifier.
', ], ], 'InsightImpactGraphEdge' => [ 'base' => 'The connection between two service in an insight impact graph.
', 'refs' => [ 'InsightImpactGraphEdgeList$member' => NULL, ], ], 'InsightImpactGraphEdgeList' => [ 'base' => NULL, 'refs' => [ 'InsightImpactGraphService$Edges' => 'Connections to downstream services.
', ], ], 'InsightImpactGraphService' => [ 'base' => 'Information about an application that processed requests, users that made requests, or downstream services, resources, and applications that an application used.
', 'refs' => [ 'InsightImpactGraphServiceList$member' => NULL, ], ], 'InsightImpactGraphServiceList' => [ 'base' => NULL, 'refs' => [ 'GetInsightImpactGraphResult$Services' => 'The Amazon Web Services instrumented services related to the insight.
', ], ], 'InsightState' => [ 'base' => NULL, 'refs' => [ 'Insight$State' => 'The current state of the insight.
', 'InsightStateList$member' => NULL, 'InsightSummary$State' => 'The current state of the insight.
', ], ], 'InsightStateList' => [ 'base' => NULL, 'refs' => [ 'GetInsightSummariesRequest$States' => 'The list of insight states.
', ], ], 'InsightSummary' => [ 'base' => 'Information that describes an insight.
', 'refs' => [ 'InsightSummaryList$member' => NULL, ], ], 'InsightSummaryList' => [ 'base' => NULL, 'refs' => [ 'GetInsightSummariesResult$InsightSummaries' => 'The summary of each insight within the group matching the provided filters. The summary contains the InsightID, start and end time, the root cause service, the root cause and client impact statistics, the top anomalous services, and the status of the insight.
', ], ], 'InsightSummaryText' => [ 'base' => NULL, 'refs' => [ 'Insight$Summary' => 'A brief description of the insight.
', 'InsightSummary$Summary' => 'A brief description of the insight.
', ], ], 'InsightsConfiguration' => [ 'base' => 'The structure containing configurations related to insights.
', 'refs' => [ 'CreateGroupRequest$InsightsConfiguration' => 'The structure containing configurations related to insights.
The InsightsEnabled boolean can be set to true to enable insights for the new group or false to disable insights for the new group.
The NotificationsEnabled boolean can be set to true to enable insights notifications for the new group. Notifications may only be enabled on a group with InsightsEnabled set to true.
The structure containing configurations related to insights.
The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.
The NotificationsEnabled boolean can be set to true to enable insights notifications through Amazon EventBridge for the group.
The structure containing configurations related to insights.
The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.
The NotificationsEnabled boolean can be set to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.
The structure containing configurations related to insights.
The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.
The NotificationsEnabled boolean can be set to true to enable insights notifications for the group. Notifications can only be enabled on a group with InsightsEnabled set to true.
A list of EC2 instance IDs corresponding to the segments in a trace.
', 'refs' => [ 'TraceInstanceIds$member' => NULL, ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'HistogramEntry$Count' => 'The prevalence of the entry.
', 'SamplingStatisticSummary$RequestCount' => 'The number of requests that matched the rule.
', 'SamplingStatisticSummary$BorrowCount' => 'The number of requests recorded with borrowed reservoir quota.
', 'SamplingStatisticSummary$SampledCount' => 'The number of requests recorded.
', 'TraceSummary$Revision' => 'The revision number of a trace.
', ], ], 'InvalidPolicyRevisionIdException' => [ 'base' => '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.
The request is missing required parameters or has invalid parameters.
', 'refs' => [], ], 'ListResourcePoliciesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResourcePoliciesResult' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'LockoutPreventionException' => [ 'base' => 'The provided resource policy would prevent the caller of this request from calling PutResourcePolicy in the future.
', 'refs' => [], ], 'MalformedPolicyDocumentException' => [ 'base' => 'Invalid policy document provided in request.
', 'refs' => [], ], 'NullableBoolean' => [ 'base' => NULL, 'refs' => [ 'AnnotationValue$BooleanValue' => 'Value for a Boolean annotation.
', 'ErrorRootCause$ClientImpacting' => 'A flag that denotes that the root cause impacts the trace client.
', 'ErrorRootCauseEntity$Remote' => 'A flag that denotes a remote subsegment.
', 'ErrorRootCauseService$Inferred' => 'A Boolean value indicating if the service is inferred from the trace.
', 'FaultRootCause$ClientImpacting' => 'A flag that denotes that the root cause impacts the trace client.
', 'FaultRootCauseEntity$Remote' => 'A flag that denotes a remote subsegment.
', 'FaultRootCauseService$Inferred' => 'A Boolean value indicating if the service is inferred from the trace.
', 'GetTimeSeriesServiceStatisticsRequest$ForecastStatistics' => 'The forecasted high and low fault count values. Forecast enabled requests require the EntitySelectorExpression ID be provided.
', 'GetTraceSummariesRequest$Sampling' => 'Set to true to get summaries for only a subset of available traces.
Set the InsightsEnabled value to true to enable insights or false to disable insights.
', 'InsightsConfiguration$NotificationsEnabled' => 'Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.
', 'ResponseTimeRootCause$ClientImpacting' => 'A flag that denotes that the root cause impacts the trace client.
', 'ResponseTimeRootCauseEntity$Remote' => 'A flag that denotes a remote subsegment.
', 'ResponseTimeRootCauseService$Inferred' => 'A Boolean value indicating if the service is inferred from the trace.
', 'Service$Root' => 'Indicates that the service was the first service to process a request.
', 'Trace$LimitExceeded' => 'LimitExceeded is set to true when the trace has exceeded the Trace document size limit. For more information about this limit and other X-Ray limits and quotas, see Amazon Web Services X-Ray endpoints and quotas.
The root segment document has a 500 series error.
', 'TraceSummary$HasError' => 'The root segment document has a 400 series error.
', 'TraceSummary$HasThrottle' => 'One or more of the segment documents has a 429 throttling error.
', 'TraceSummary$IsPartial' => 'One or more of the segment documents is in progress.
', ], ], 'NullableDouble' => [ 'base' => NULL, 'refs' => [ 'AnnotationValue$NumberValue' => 'Value for a Number annotation.
', 'EdgeStatistics$TotalResponseTime' => 'The aggregate response time of completed requests.
', 'ResponseTimeRootCauseEntity$Coverage' => 'The type and messages of the exceptions.
', 'SamplingRuleUpdate$FixedRate' => 'The percentage of matching requests to instrument, after the reservoir is exhausted.
', 'SamplingStrategy$Value' => 'The value of a sampling rule.
', 'ServiceStatistics$TotalResponseTime' => 'The aggregate response time of completed requests.
', 'Trace$Duration' => 'The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.
', 'TraceSummary$Duration' => 'The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.
', 'TraceSummary$ResponseTime' => 'The length of time in seconds between the start and end times of the root segment. If the service performs work asynchronously, the response time measures the time before the response is sent to the user, while the duration measures the amount of time before the last traced activity completes.
', ], ], 'NullableInteger' => [ 'base' => NULL, 'refs' => [ 'BackendConnectionErrors$TimeoutCount' => '', 'BackendConnectionErrors$ConnectionRefusedCount' => '', 'BackendConnectionErrors$HTTPCode4XXCount' => '', 'BackendConnectionErrors$HTTPCode5XXCount' => '', 'BackendConnectionErrors$UnknownHostCount' => '', 'BackendConnectionErrors$OtherCount' => '', 'Edge$ReferenceId' => 'Identifier of the edge. Unique within a service map.
', 'GetTimeSeriesServiceStatisticsRequest$Period' => 'Aggregation period in seconds.
', 'Http$HttpStatus' => 'The response status.
', 'InsightImpactGraphEdge$ReferenceId' => 'Identifier of the edge. Unique within a service map.
', 'InsightImpactGraphService$ReferenceId' => 'Identifier for the service. Unique within the service map.
', 'SamplingRuleUpdate$Priority' => 'The priority of the sampling rule.
', 'SamplingRuleUpdate$ReservoirSize' => 'A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.
', 'SamplingTargetDocument$ReservoirQuota' => 'The number of requests per second that X-Ray allocated for this service.
', 'SamplingTargetDocument$Interval' => 'The number of seconds for the service to wait before getting sampling targets again.
', 'Service$ReferenceId' => 'Identifier for the service. Unique within the service map.
', 'TelemetryRecord$SegmentsReceivedCount' => '', 'TelemetryRecord$SegmentsSentCount' => '', 'TelemetryRecord$SegmentsSpilloverCount' => '', 'TelemetryRecord$SegmentsRejectedCount' => '', ], ], 'NullableLong' => [ 'base' => NULL, 'refs' => [ 'EdgeStatistics$OkCount' => 'The number of requests that completed with a 2xx Success status code.
', 'EdgeStatistics$TotalCount' => 'The total number of completed requests.
', 'ErrorStatistics$ThrottleCount' => 'The number of requests that failed with a 419 throttling status code.
', 'ErrorStatistics$OtherCount' => 'The number of requests that failed with untracked 4xx Client Error status codes.
', 'ErrorStatistics$TotalCount' => 'The total number of requests that failed with a 4xx Client Error status code.
', 'FaultStatistics$OtherCount' => 'The number of requests that failed with untracked 5xx Server Error status codes.
', 'FaultStatistics$TotalCount' => 'The total number of requests that failed with a 5xx Server Error status code.
', 'ForecastStatistics$FaultCountHigh' => 'The upper limit of fault counts for a service.
', 'ForecastStatistics$FaultCountLow' => 'The lower limit of fault counts for a service.
', 'GetTraceSummariesResult$TracesProcessedCount' => 'The total number of traces processed, including traces that did not match the specified filter expression.
', 'RequestImpactStatistics$FaultCount' => 'The number of requests that have resulted in a fault,
', 'RequestImpactStatistics$OkCount' => 'The number of successful requests.
', 'RequestImpactStatistics$TotalCount' => 'The total number of requests to the service.
', 'ServiceStatistics$OkCount' => 'The number of requests that completed with a 2xx Success status code.
', 'ServiceStatistics$TotalCount' => 'The total number of completed requests.
', ], ], 'PolicyCountLimitExceededException' => [ 'base' => 'Exceeded the maximum number of resource policies for a target Amazon Web Services account.
', 'refs' => [], ], 'PolicyDocument' => [ 'base' => NULL, 'refs' => [ 'PutResourcePolicyRequest$PolicyDocument' => 'The resource policy document, which can be up to 5kb in size.
', 'ResourcePolicy$PolicyDocument' => 'The resource policy document, which can be up to 5kb in size.
', ], ], 'PolicyName' => [ 'base' => NULL, 'refs' => [ 'DeleteResourcePolicyRequest$PolicyName' => 'The name of the resource policy to delete.
', 'PutResourcePolicyRequest$PolicyName' => 'The name of the resource policy. Must be unique within a specific Amazon Web Services account.
', 'ResourcePolicy$PolicyName' => 'The name of the resource policy. Must be unique within a specific Amazon Web Services account.
', ], ], 'PolicyRevisionId' => [ 'base' => NULL, 'refs' => [ 'DeleteResourcePolicyRequest$PolicyRevisionId' => 'Specifies a specific policy revision to delete. Provide a PolicyRevisionId to ensure an atomic delete operation. If the provided revision id does not match the latest policy revision id, an InvalidPolicyRevisionIdException exception is returned.
Specifies a specific policy revision, to ensure an atomic create operation. By default the resource policy is created if it does not exist, or updated with an incremented revision id. The revision id is unique to each policy in the account.
If the policy revision id does not match the latest revision id, the operation will fail with an InvalidPolicyRevisionIdException exception. You can also provide a PolicyRevisionId of 0. In this case, the operation will fail with an InvalidPolicyRevisionIdException exception if a resource policy with the same name already exists.
Returns the current policy revision id for this policy name.
', ], ], 'PolicySizeLimitExceededException' => [ 'base' => 'Exceeded the maximum size for a resource policy.
', 'refs' => [], ], 'Priority' => [ 'base' => NULL, 'refs' => [ 'SamplingRule$Priority' => 'The priority of the sampling rule.
', ], ], 'PutEncryptionConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutEncryptionConfigResult' => [ 'base' => NULL, 'refs' => [], ], 'PutResourcePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutResourcePolicyResult' => [ 'base' => NULL, 'refs' => [], ], 'PutTelemetryRecordsRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutTelemetryRecordsResult' => [ 'base' => NULL, 'refs' => [], ], 'PutTraceSegmentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutTraceSegmentsResult' => [ 'base' => NULL, 'refs' => [], ], 'RequestCount' => [ 'base' => NULL, 'refs' => [ 'SamplingStatisticsDocument$RequestCount' => 'The number of requests that matched the rule.
', ], ], 'RequestImpactStatistics' => [ 'base' => 'Statistics that describe how the incident has impacted a service.
', 'refs' => [ 'Insight$ClientRequestImpactStatistics' => 'The impact statistics of the client side service. This includes the number of requests to the client service and whether the requests were faults or okay.
', 'Insight$RootCauseServiceRequestImpactStatistics' => 'The impact statistics of the root cause service. This includes the number of requests to the client service and whether the requests were faults or okay.
', 'InsightEvent$ClientRequestImpactStatistics' => 'The impact statistics of the client side service. This includes the number of requests to the client service and whether the requests were faults or okay.
', 'InsightEvent$RootCauseServiceRequestImpactStatistics' => 'The impact statistics of the root cause service. This includes the number of requests to the client service and whether the requests were faults or okay.
', 'InsightSummary$ClientRequestImpactStatistics' => 'The impact statistics of the client side service. This includes the number of requests to the client service and whether the requests were faults or okay.
', 'InsightSummary$RootCauseServiceRequestImpactStatistics' => 'The impact statistics of the root cause service. This includes the number of requests to the client service and whether the requests were faults or okay.
', ], ], 'ReservoirSize' => [ 'base' => NULL, 'refs' => [ 'SamplingRule$ReservoirSize' => 'A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.
', ], ], 'ResourceARN' => [ 'base' => NULL, 'refs' => [ 'PutTelemetryRecordsRequest$ResourceARN' => '', 'SamplingRule$ResourceARN' => 'Matches the ARN of the Amazon Web Services resource on which the service runs.
', 'SamplingRuleUpdate$ResourceARN' => 'Matches the ARN of the Amazon Web Services resource on which the service runs.
', ], ], 'ResourceARNDetail' => [ 'base' => 'A list of resources ARNs corresponding to the segments in a trace.
', 'refs' => [ 'TraceResourceARNs$member' => NULL, ], ], 'ResourceNotFoundException' => [ 'base' => 'The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
', 'refs' => [], ], 'ResourcePolicy' => [ 'base' => '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.
', 'refs' => [ 'PutResourcePolicyResult$ResourcePolicy' => 'The resource policy document, as provided in the PutResourcePolicyRequest.
The list of resource policies in the target Amazon Web Services account.
', ], ], 'ResourcePolicyNextToken' => [ 'base' => NULL, 'refs' => [ 'ListResourcePoliciesRequest$NextToken' => 'Not currently supported.
', 'ListResourcePoliciesResult$NextToken' => 'Pagination token. Not currently supported.
', ], ], 'ResponseTimeRootCause' => [ 'base' => 'The root cause information for a response time warning.
', 'refs' => [ 'ResponseTimeRootCauses$member' => NULL, ], ], 'ResponseTimeRootCauseEntity' => [ 'base' => 'A collection of segments and corresponding subsegments associated to a response time warning.
', 'refs' => [ 'ResponseTimeRootCauseEntityPath$member' => NULL, ], ], 'ResponseTimeRootCauseEntityPath' => [ 'base' => NULL, 'refs' => [ 'ResponseTimeRootCauseService$EntityPath' => 'The path of root cause entities found on the service.
', ], ], 'ResponseTimeRootCauseService' => [ 'base' => 'A collection of fields identifying the service in a response time warning.
', 'refs' => [ 'ResponseTimeRootCauseServices$member' => NULL, ], ], 'ResponseTimeRootCauseServices' => [ 'base' => NULL, 'refs' => [ 'ResponseTimeRootCause$Services' => 'A list of corresponding services. A service identifies a segment and contains a name, account ID, type, and inferred flag.
', ], ], 'ResponseTimeRootCauses' => [ 'base' => NULL, 'refs' => [ 'TraceSummary$ResponseTimeRootCauses' => 'A collection of ResponseTimeRootCause structures corresponding to the trace segments.
', ], ], 'RootCauseException' => [ 'base' => 'The exception associated with a root cause.
', 'refs' => [ 'RootCauseExceptions$member' => NULL, ], ], 'RootCauseExceptions' => [ 'base' => NULL, 'refs' => [ 'ErrorRootCauseEntity$Exceptions' => 'The types and messages of the exceptions.
', 'FaultRootCauseEntity$Exceptions' => 'The types and messages of the exceptions.
', ], ], 'RuleLimitExceededException' => [ 'base' => 'You have reached the maximum number of sampling rules.
', 'refs' => [], ], 'RuleName' => [ 'base' => NULL, 'refs' => [ 'SamplingRule$RuleName' => 'The name of the sampling rule. Specify a rule by either name or ARN, but not both.
', 'SamplingRuleUpdate$RuleName' => 'The name of the sampling rule. Specify a rule by either name or ARN, but not both.
', 'SamplingStatisticsDocument$RuleName' => 'The name of the sampling rule.
', ], ], 'SampledCount' => [ 'base' => NULL, 'refs' => [ 'SamplingStatisticsDocument$SampledCount' => 'The number of requests recorded.
', ], ], 'SamplingRule' => [ 'base' => '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.
', 'refs' => [ 'CreateSamplingRuleRequest$SamplingRule' => 'The rule definition.
', 'SamplingRuleRecord$SamplingRule' => 'The sampling rule.
', ], ], 'SamplingRuleRecord' => [ 'base' => 'A SamplingRule and its metadata.
', 'refs' => [ 'CreateSamplingRuleResult$SamplingRuleRecord' => 'The saved rule definition and metadata.
', 'DeleteSamplingRuleResult$SamplingRuleRecord' => 'The deleted rule definition and metadata.
', 'SamplingRuleRecordList$member' => NULL, 'UpdateSamplingRuleResult$SamplingRuleRecord' => 'The updated rule definition and metadata.
', ], ], 'SamplingRuleRecordList' => [ 'base' => NULL, 'refs' => [ 'GetSamplingRulesResult$SamplingRuleRecords' => 'Rule definitions and metadata.
', ], ], 'SamplingRuleUpdate' => [ 'base' => 'A document specifying changes to a sampling rule\'s configuration.
', 'refs' => [ 'UpdateSamplingRuleRequest$SamplingRuleUpdate' => 'The rule and fields to change.
', ], ], 'SamplingStatisticSummary' => [ 'base' => 'Aggregated request sampling data for a sampling rule across all services for a 10-second window.
', 'refs' => [ 'SamplingStatisticSummaryList$member' => NULL, ], ], 'SamplingStatisticSummaryList' => [ 'base' => NULL, 'refs' => [ 'GetSamplingStatisticSummariesResult$SamplingStatisticSummaries' => 'Information about the number of requests instrumented for each sampling rule.
', ], ], 'SamplingStatisticsDocument' => [ 'base' => '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.
', 'refs' => [ 'SamplingStatisticsDocumentList$member' => NULL, ], ], 'SamplingStatisticsDocumentList' => [ 'base' => NULL, 'refs' => [ 'GetSamplingTargetsRequest$SamplingStatisticsDocuments' => 'Information about rules that the service is using to sample requests.
', ], ], 'SamplingStrategy' => [ 'base' => 'The name and value of a sampling rule to apply to a trace summary.
', 'refs' => [ 'GetTraceSummariesRequest$SamplingStrategy' => 'A parameter to indicate whether to enable sampling on trace summaries. Input parameters are Name and Value.
', ], ], 'SamplingStrategyName' => [ 'base' => NULL, 'refs' => [ 'SamplingStrategy$Name' => 'The name of a sampling rule.
', ], ], 'SamplingTargetDocument' => [ 'base' => '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.
', 'refs' => [ 'SamplingTargetDocumentList$member' => NULL, ], ], 'SamplingTargetDocumentList' => [ 'base' => NULL, 'refs' => [ 'GetSamplingTargetsResult$SamplingTargetDocuments' => 'Updated rules that the service should use to sample requests.
', ], ], 'Segment' => [ 'base' => '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.
', 'refs' => [ 'SegmentList$member' => NULL, ], ], 'SegmentDocument' => [ 'base' => NULL, 'refs' => [ 'Segment$Document' => 'The segment document.
', ], ], 'SegmentId' => [ 'base' => NULL, 'refs' => [ 'Segment$Id' => 'The segment\'s ID.
', ], ], 'SegmentList' => [ 'base' => NULL, 'refs' => [ 'Trace$Segments' => 'Segment documents for the segments and subsegments that comprise the trace.
', ], ], 'Service' => [ 'base' => 'Information about an application that processed requests, users that made requests, or downstream services, resources, and applications that an application used.
', 'refs' => [ 'ServiceList$member' => NULL, ], ], 'ServiceId' => [ 'base' => '', 'refs' => [ 'AnomalousService$ServiceId' => NULL, 'Insight$RootCauseServiceId' => NULL, 'InsightSummary$RootCauseServiceId' => NULL, 'ServiceIds$member' => NULL, 'TraceSummary$EntryPoint' => 'The root of a trace.
', ], ], 'ServiceIds' => [ 'base' => NULL, 'refs' => [ 'TraceSummary$ServiceIds' => 'Service IDs from the trace\'s segment documents.
', 'TraceUser$ServiceIds' => 'Services that the user\'s request hit.
', 'ValueWithServiceIds$ServiceIds' => 'Services to which the annotation applies.
', ], ], 'ServiceList' => [ 'base' => NULL, 'refs' => [ 'GetServiceGraphResult$Services' => 'The services that have processed a traced request during the specified time frame.
', 'GetTraceGraphResult$Services' => 'The services that have processed one of the specified requests.
', ], ], 'ServiceName' => [ 'base' => NULL, 'refs' => [ 'SamplingRule$ServiceName' => 'Matches the name that the service uses to identify itself in segments.
Matches the name that the service uses to identify itself in segments.
A collection of associated service names.
', 'FaultRootCauseService$Names' => 'A collection of associated service names.
', 'InsightImpactGraphService$Names' => 'A list of names for the service, including the canonical name.
', 'ResponseTimeRootCauseService$Names' => 'A collection of associated service names.
', 'Service$Names' => 'A list of names for the service, including the canonical name.
', 'ServiceId$Names' => '', ], ], 'ServiceStatistics' => [ 'base' => 'Response statistics for a service.
', 'refs' => [ 'Service$SummaryStatistics' => 'Aggregated statistics for the service.
', 'TimeSeriesServiceStatistics$ServiceSummaryStatistics' => NULL, ], ], 'ServiceType' => [ 'base' => NULL, 'refs' => [ 'SamplingRule$ServiceType' => 'Matches the origin that the service uses to identify its type in segments.
Matches the origin that the service uses to identify its type in segments.
The canonical name of the alias.
', 'Alias$Type' => 'The type of the alias.
', 'AliasNames$member' => NULL, 'AnnotationValue$StringValue' => 'Value for a String annotation.
', 'AvailabilityZoneDetail$Name' => 'The name of a corresponding Availability Zone.
', 'BatchGetTracesRequest$NextToken' => 'Pagination token.
', 'BatchGetTracesResult$NextToken' => 'Pagination token.
', 'DeleteSamplingRuleRequest$RuleName' => 'The name of the sampling rule. Specify a rule by either name or ARN, but not both.
', 'DeleteSamplingRuleRequest$RuleARN' => 'The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
', 'Edge$EdgeType' => 'Describes an asynchronous connection, with a value of link.
The ID of the KMS key used for encryption, if applicable.
', 'ErrorRootCauseEntity$Name' => 'The name of the entity.
', 'ErrorRootCauseService$Name' => 'The service name.
', 'ErrorRootCauseService$Type' => 'The type associated to the service.
', 'ErrorRootCauseService$AccountId' => 'The account ID associated to the service.
', 'FaultRootCauseEntity$Name' => 'The name of the entity.
', 'FaultRootCauseService$Name' => 'The service name.
', 'FaultRootCauseService$Type' => 'The type associated to the service.
', 'FaultRootCauseService$AccountId' => 'The account ID associated to the service.
', 'GetGroupsResult$NextToken' => 'Pagination token.
', 'GetSamplingRulesRequest$NextToken' => 'Pagination token.
', 'GetSamplingRulesResult$NextToken' => 'Pagination token.
', 'GetSamplingStatisticSummariesRequest$NextToken' => 'Pagination token.
', 'GetSamplingStatisticSummariesResult$NextToken' => 'Pagination token.
', 'GetServiceGraphRequest$NextToken' => 'Pagination token.
', 'GetServiceGraphResult$NextToken' => 'Pagination token.
', 'GetTimeSeriesServiceStatisticsRequest$NextToken' => 'Pagination token.
', 'GetTimeSeriesServiceStatisticsResult$NextToken' => 'Pagination token.
', 'GetTraceGraphRequest$NextToken' => 'Pagination token.
', 'GetTraceGraphResult$NextToken' => 'Pagination token.
', 'GetTraceSummariesRequest$NextToken' => 'Specify the pagination token returned by a previous request to retrieve the next page of results.
', 'GetTraceSummariesResult$NextToken' => 'If the requested time frame contained more than one page of results, you can use this token to retrieve the next page. The first page contains the most recent results, closest to the end of the time frame.
', 'Group$GroupName' => 'The unique case-sensitive name of the group.
', 'Group$GroupARN' => 'The Amazon Resource Name (ARN) of the group generated based on the GroupName.
', 'Group$FilterExpression' => 'The filter expression defining the parameters to include traces.
', 'GroupSummary$GroupName' => 'The unique case-sensitive name of the group.
', 'GroupSummary$GroupARN' => 'The ARN of the group generated based on the GroupName.
', 'GroupSummary$FilterExpression' => 'The filter expression defining the parameters to include traces.
', 'Http$HttpURL' => 'The request URL.
', 'Http$HttpMethod' => 'The request method.
', 'Http$UserAgent' => 'The request\'s user agent string.
', 'Http$ClientIp' => 'The IP address of the requestor.
', 'InsightImpactGraphService$Type' => 'Identifier for the service. Unique within the service map.
Amazon Web Services Resource - The type of an Amazon Web Services resource. For example, AWS::EC2::Instance for an application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used.
Amazon Web Services Service - The type of an Amazon Web Services service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn\'t target a specific table.
Amazon Web Services Service - The type of an Amazon Web Services service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn\'t target a specific table.
remote - A downstream service of indeterminate type.
The canonical name of the service.
', 'InsightImpactGraphService$AccountId' => 'Identifier of the Amazon Web Services account in which the service runs.
', 'InstanceIdDetail$Id' => 'The ID of a corresponding EC2 instance.
', 'ListTagsForResourceRequest$NextToken' => 'A pagination token. If multiple pages of results are returned, use the NextToken value returned with the current page of results as the value of this parameter to get the next page of results.
A pagination token. If multiple pages of results are returned, use the NextToken value returned with the current page of results to get the next page of results.
The ARN of a corresponding resource.
', 'ResponseTimeRootCauseEntity$Name' => 'The name of the entity.
', 'ResponseTimeRootCauseService$Name' => 'The service name.
', 'ResponseTimeRootCauseService$Type' => 'The type associated to the service.
', 'ResponseTimeRootCauseService$AccountId' => 'The account ID associated to the service.
', 'RootCauseException$Name' => 'The name of the exception.
', 'RootCauseException$Message' => 'The message of the exception.
', 'SamplingRule$RuleARN' => 'The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
', 'SamplingRuleUpdate$RuleARN' => 'The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
', 'SamplingStatisticSummary$RuleName' => 'The name of the sampling rule.
', 'SamplingTargetDocument$RuleName' => 'The name of the sampling rule.
', 'Service$Name' => 'The canonical name of the service.
', 'Service$AccountId' => 'Identifier of the Amazon Web Services account in which the service runs.
', 'Service$Type' => 'The type of service.
Amazon Web Services Resource - The type of an Amazon Web Services resource. For example, AWS::EC2::Instance for an application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used.
Amazon Web Services Service - The type of an Amazon Web Services service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn\'t target a specific table.
client - Represents the clients that sent requests to a root service.
remote - A downstream service of indeterminate type.
The service\'s state.
', 'ServiceId$Name' => '', 'ServiceId$AccountId' => '', 'ServiceId$Type' => '', 'ServiceNames$member' => NULL, 'TraceUser$UserName' => 'The user\'s name.
', 'UnprocessedStatistics$RuleName' => 'The name of the sampling rule.
', 'UnprocessedStatistics$ErrorCode' => 'The error code.
', 'UnprocessedStatistics$Message' => 'The error message.
', 'UnprocessedTraceSegment$Id' => 'The segment\'s ID.
', 'UnprocessedTraceSegment$ErrorCode' => 'The error that caused processing to fail.
', 'UnprocessedTraceSegment$Message' => 'The error message.
', ], ], 'Tag' => [ 'base' => '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.
A tag key, such as Stage or Name. A tag key cannot be empty. The key can be a maximum of 128 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
Keys for one or more tags that you want to remove from an X-Ray group or sampling rule.
', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'CreateGroupRequest$Tags' => 'A map that contains one or more tag keys and tag values to attach to an X-Ray group. 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
Maximum tag key length: 128 Unicode characters
Maximum tag value length: 256 Unicode characters
Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @
Tag keys and values are case sensitive.
Don\'t use aws: as a prefix for keys; it\'s reserved for Amazon Web Services use.
A map that contains one or more tag keys and tag values to attach to an X-Ray 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
Maximum tag key length: 128 Unicode characters
Maximum tag value length: 256 Unicode characters
Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @
Tag keys and values are case sensitive.
Don\'t use aws: as a prefix for keys; it\'s reserved for Amazon Web Services use.
A list of tags, as key and value pairs, that is associated with the specified X-Ray group or sampling rule.
', 'TagResourceRequest$Tags' => 'A map that contains one or more tag keys and tag values to attach to an 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
Maximum tag key length: 128 Unicode characters
Maximum tag value length: 256 Unicode characters
Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @
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.
An optional tag value, such as Production or test-only. The value can be a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
The request exceeds the maximum number of requests per second.
', 'refs' => [], ], 'TimeRangeType' => [ 'base' => NULL, 'refs' => [ 'GetTraceSummariesRequest$TimeRangeType' => 'A parameter to indicate whether to query trace summaries by TraceId or Event time.
', ], ], 'TimeSeriesServiceStatistics' => [ 'base' => 'A list of TimeSeriesStatistic structures.
', 'refs' => [ 'TimeSeriesServiceStatisticsList$member' => NULL, ], ], 'TimeSeriesServiceStatisticsList' => [ 'base' => NULL, 'refs' => [ 'GetTimeSeriesServiceStatisticsResult$TimeSeriesServiceStatistics' => 'The collection of statistics.
', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'Edge$StartTime' => 'The start time of the first segment on the edge.
', 'Edge$EndTime' => 'The end time of the last segment on the edge.
', 'GetInsightImpactGraphRequest$StartTime' => 'The estimated start time of the insight, in Unix time seconds. The StartTime is inclusive of the value provided and can\'t be more than 30 days old.
', 'GetInsightImpactGraphRequest$EndTime' => 'The estimated end time of the insight, in Unix time seconds. The EndTime is exclusive of the value provided. The time range between the start time and end time can\'t be more than six hours.
', 'GetInsightImpactGraphResult$StartTime' => 'The provided start time.
', 'GetInsightImpactGraphResult$EndTime' => 'The provided end time.
', 'GetInsightImpactGraphResult$ServiceGraphStartTime' => 'The time, in Unix seconds, at which the service graph started.
', 'GetInsightImpactGraphResult$ServiceGraphEndTime' => 'The time, in Unix seconds, at which the service graph ended.
', 'GetInsightSummariesRequest$StartTime' => 'The beginning of the time frame in which the insights started. The start time can\'t be more than 30 days old.
', 'GetInsightSummariesRequest$EndTime' => 'The end of the time frame in which the insights ended. The end time can\'t be more than 30 days old.
', 'GetSamplingTargetsResult$LastRuleModification' => 'The last time a user changed the sampling rule configuration. If the sampling rule configuration changed since the service last retrieved it, the service should call GetSamplingRules to get the latest version.
', 'GetServiceGraphRequest$StartTime' => 'The start of the time frame for which to generate a graph.
', 'GetServiceGraphRequest$EndTime' => 'The end of the timeframe for which to generate a graph.
', 'GetServiceGraphResult$StartTime' => 'The start of the time frame for which the graph was generated.
', 'GetServiceGraphResult$EndTime' => 'The end of the time frame for which the graph was generated.
', 'GetTimeSeriesServiceStatisticsRequest$StartTime' => 'The start of the time frame for which to aggregate statistics.
', 'GetTimeSeriesServiceStatisticsRequest$EndTime' => 'The end of the time frame for which to aggregate statistics.
', 'GetTraceSummariesRequest$StartTime' => 'The start of the time frame for which to retrieve traces.
', 'GetTraceSummariesRequest$EndTime' => 'The end of the time frame for which to retrieve traces.
', 'GetTraceSummariesResult$ApproximateTime' => 'The start time of this page of results.
', 'Insight$StartTime' => 'The time, in Unix seconds, at which the insight began.
', 'Insight$EndTime' => 'The time, in Unix seconds, at which the insight ended.
', 'InsightEvent$EventTime' => 'The time, in Unix seconds, at which the event was recorded.
', 'InsightSummary$StartTime' => 'The time, in Unix seconds, at which the insight began.
', 'InsightSummary$EndTime' => 'The time, in Unix seconds, at which the insight ended.
', 'InsightSummary$LastUpdateTime' => 'The time, in Unix seconds, that the insight was last updated.
', 'ResourcePolicy$LastUpdatedTime' => 'When the policy was last updated, in Unix time seconds.
', 'SamplingRuleRecord$CreatedAt' => 'When the rule was created.
', 'SamplingRuleRecord$ModifiedAt' => 'When the rule was last modified.
', 'SamplingStatisticSummary$Timestamp' => 'The start time of the reporting window.
', 'SamplingStatisticsDocument$Timestamp' => 'The current time.
', 'SamplingTargetDocument$ReservoirQuotaTTL' => 'When the reservoir quota expires.
', 'Service$StartTime' => 'The start time of the first segment that the service generated.
', 'Service$EndTime' => 'The end time of the last segment that the service generated.
', 'TelemetryRecord$Timestamp' => '', 'TimeSeriesServiceStatistics$Timestamp' => 'Timestamp of the window for which statistics are aggregated.
', 'TraceSummary$MatchedEventTime' => 'The matched time stamp of a defined event.
', ], ], 'Token' => [ 'base' => NULL, 'refs' => [ 'GetInsightEventsRequest$NextToken' => 'Specify the pagination token returned by a previous request to retrieve the next page of events.
', 'GetInsightEventsResult$NextToken' => 'Use this token to retrieve the next page of insight events.
', 'GetInsightImpactGraphRequest$NextToken' => 'Specify the pagination token returned by a previous request to retrieve the next page of results.
', 'GetInsightImpactGraphResult$NextToken' => 'Pagination token.
', 'GetInsightSummariesRequest$NextToken' => 'Pagination token.
', 'GetInsightSummariesResult$NextToken' => 'Pagination token.
', ], ], 'TooManyTagsException' => [ 'base' => 'You have exceeded the maximum number of tags you can apply to this resource.
', 'refs' => [], ], 'Trace' => [ 'base' => 'A collection of segment documents with matching trace IDs.
', 'refs' => [ 'TraceList$member' => NULL, ], ], 'TraceAvailabilityZones' => [ 'base' => NULL, 'refs' => [ 'TraceSummary$AvailabilityZones' => 'A list of Availability Zones for any zone corresponding to the trace segments.
', ], ], 'TraceId' => [ 'base' => NULL, 'refs' => [ 'Trace$Id' => 'The unique identifier for the request that generated the trace\'s segments and subsegments.
', 'TraceIdList$member' => NULL, 'TraceSummary$Id' => 'The unique identifier for the request that generated the trace\'s segments and subsegments.
', 'UnprocessedTraceIdList$member' => NULL, ], ], 'TraceIdList' => [ 'base' => NULL, 'refs' => [ 'BatchGetTracesRequest$TraceIds' => 'Specify the trace IDs of requests for which to retrieve segments.
', 'GetTraceGraphRequest$TraceIds' => 'Trace IDs of requests for which to generate a service graph.
', ], ], 'TraceInstanceIds' => [ 'base' => NULL, 'refs' => [ 'TraceSummary$InstanceIds' => 'A list of EC2 instance IDs for any instance corresponding to the trace segments.
', ], ], 'TraceList' => [ 'base' => NULL, 'refs' => [ 'BatchGetTracesResult$Traces' => 'Full traces for the specified requests.
', ], ], 'TraceResourceARNs' => [ 'base' => NULL, 'refs' => [ 'TraceSummary$ResourceARNs' => 'A list of resource ARNs for any resource corresponding to the trace segments.
', ], ], 'TraceSegmentDocument' => [ 'base' => NULL, 'refs' => [ 'TraceSegmentDocumentList$member' => NULL, ], ], 'TraceSegmentDocumentList' => [ 'base' => NULL, 'refs' => [ 'PutTraceSegmentsRequest$TraceSegmentDocuments' => 'A string containing a JSON document defining one or more segments or subsegments.
', ], ], 'TraceSummary' => [ 'base' => 'Metadata generated from the segment documents in a trace.
', 'refs' => [ 'TraceSummaryList$member' => NULL, ], ], 'TraceSummaryList' => [ 'base' => NULL, 'refs' => [ 'GetTraceSummariesResult$TraceSummaries' => 'Trace IDs and annotations for traces that were found in the specified time frame.
', ], ], 'TraceUser' => [ 'base' => 'Information about a user recorded in segment documents.
', 'refs' => [ 'TraceUsers$member' => NULL, ], ], 'TraceUsers' => [ 'base' => NULL, 'refs' => [ 'TraceSummary$Users' => 'Users from the trace\'s segment documents.
', ], ], 'URLPath' => [ 'base' => NULL, 'refs' => [ 'SamplingRule$URLPath' => 'Matches the path from a request URL.
', 'SamplingRuleUpdate$URLPath' => 'Matches the path from a request URL.
', ], ], 'UnprocessedStatistics' => [ 'base' => 'Sampling statistics from a call to GetSamplingTargets that X-Ray could not process.
', 'refs' => [ 'UnprocessedStatisticsList$member' => NULL, ], ], 'UnprocessedStatisticsList' => [ 'base' => NULL, 'refs' => [ 'GetSamplingTargetsResult$UnprocessedStatistics' => 'Information about SamplingStatisticsDocument that X-Ray could not process.
', ], ], 'UnprocessedTraceIdList' => [ 'base' => NULL, 'refs' => [ 'BatchGetTracesResult$UnprocessedTraceIds' => 'Trace IDs of requests that haven\'t been processed.
', ], ], 'UnprocessedTraceSegment' => [ 'base' => 'Information about a segment that failed processing.
', 'refs' => [ 'UnprocessedTraceSegmentList$member' => NULL, ], ], 'UnprocessedTraceSegmentList' => [ 'base' => NULL, 'refs' => [ 'PutTraceSegmentsResult$UnprocessedTraceSegments' => 'Segments that failed processing.
', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSamplingRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSamplingRuleResult' => [ 'base' => NULL, 'refs' => [], ], 'ValueWithServiceIds' => [ 'base' => 'Information about a segment annotation.
', 'refs' => [ 'ValuesWithServiceIds$member' => NULL, ], ], 'ValuesWithServiceIds' => [ 'base' => NULL, 'refs' => [ 'Annotations$value' => NULL, ], ], 'Version' => [ 'base' => NULL, 'refs' => [ 'SamplingRule$Version' => 'The version of the sampling rule format (1).