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 type of encryption. Set to KMS to use your own key for encryption. Set to NONE for default encryption.

The new encryption configuration.

The response's http status code.

Pagination token.

The Amazon Resource Name (ARN) of a group based on which you want to generate a graph.

The name of a group based on which you want to generate a graph.

The start of the time frame for which to generate a graph.

The end of the timeframe for which to generate a graph.

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.

The start of the time frame for which the graph was generated.

Pagination token.

The end of the time frame for which the graph was generated.

The services that have processed a traced request during the specified time frame.

The response's http status code.

Information about rules that the service is using to sample requests.

Information about SamplingStatisticsDocument that X-Ray could not process.

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.

Updated rules that the service should use to sample requests.

The response's http status code.

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.

The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.

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.

A list of tags, as key and value pairs, that is associated with the specified X-Ray group or sampling rule.

The response's http status code.

Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.

Specify the pagination token returned by a previous request to retrieve the next page of results.

A parameter to indicate whether to query trace summaries by TraceId or Event time.

A parameter to indicate whether to enable sampling on trace summaries. Input parameters are Name and Value.

Set to true to get summaries for only a subset of available traces.

The start of the time frame for which to retrieve traces.

The end of the time frame for which to retrieve traces.

The total number of traces processed, including traces that did not match the specified filter expression.

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.

The start time of this page of results.

Trace IDs and annotations for traces that were found in the specified time frame.

The response's http status code.

A string containing a JSON document defining one or more segments or subsegments.

Segments that failed processing.

The response's http status code.

Pagination token.

Specify the trace IDs of requests for which to retrieve segments.

Pagination token.

Full traces for the specified requests.

Trace IDs of requests that haven't been processed.

The response's http status code.

The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.

The summary information of an insight.

The response's http status code.

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.

Aggregation period in seconds.

The forecasted high and low fault count values. Forecast enabled requests require the EntitySelectorExpression ID be provided.

Pagination token.

The Amazon Resource Name (ARN) of the group for which to pull statistics from.

The case-sensitive name of the group for which to pull statistics from.

The start of the time frame for which to aggregate statistics.

The end of the time frame for which to aggregate statistics.

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.

The collection of statistics.

Pagination token.

The response's http status code.

The encryption configuration document.

The response's http status code.

Specify the pagination token returned by a previous request to retrieve the next page of results.

The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.

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.

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.

The time, in Unix seconds, at which the service graph started.

The provided start time.

The insight's unique identifier.

Pagination token.

The provided end time.

The time, in Unix seconds, at which the service graph ended.

The Amazon Web Services instrumented services related to the insight.

The response's http status code.

The rule and fields to change.

The updated rule definition and metadata.

The response's http status code.

The name of the sampling rule. Specify a rule by either name or ARN, but not both.

The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

The deleted rule definition and metadata.

The response's http status code.

Specify the pagination token returned by a previous request to retrieve the next page of events.

Used to retrieve at most the specified value of events.

The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.

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.

Use this token to retrieve the next page of insight events.

The response's http status code.

Pagination token.

The collection of all active groups.

Pagination token.

The response's http status code.

The list of insight states.

Pagination token.

The Amazon Resource Name (ARN) of the group. Required if the GroupName isn't provided.

The name of the group. Required if the GroupARN isn't provided.

The maximum number of results to display.

The beginning of the time frame in which the insights started. The start time can't be more than 30 days old.

The end of the time frame in which the insights ended. The end time can't be more than 30 days old.

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.

Pagination token.

The response's http status code.

The response's http status code.

Pagination token.

Rule definitions and metadata.

Pagination token.

The response's http status code.

The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.

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.

The response's http status code.

Pagination token.

Trace IDs of requests for which to generate a service graph.

Pagination token.

The services that have processed one of the specified requests.

The response's http status code.

The filter expression defining criteria by which to group traces.

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 NotifcationsEnabled 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.

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.

The case-sensitive name of the new group. Default is a reserved name and names must be unique.

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.

The response's http status code.

The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.

Keys for one or more tags that you want to remove from an X-Ray group or sampling rule.

The response's http status code.

The ARN of the group that was generated on creation.

The case-sensitive name of the group.

The response's http status code.

The updated filter expression defining criteria by which to group traces.

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 NotifcationsEnabled 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.

The ARN that was generated upon creation.

The case-sensitive name of the 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.

The response's http status code.

The ARN of the group that was generated on creation.

The case-sensitive name of the 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.

The response's http status code.

Pagination token.

Information about the number of requests instrumented for each sampling rule.

Pagination token.

The response's http status code.

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.

The rule definition.

The saved rule definition and metadata.

The response's http status code.

A list of names for the alias, including the canonical name.

The canonical name of the alias.

The type of the alias.

Value for a Number annotation.

Value for a String annotation.

Value for a Boolean annotation.

Undocumented member.

The name of a corresponding Availability Zone.

The start time of the first segment on the edge.

Aliases for the edge.

A histogram that maps the spread of client response times on an edge.

Identifier of the edge. Unique within a service map.

The end time of the last segment on the edge.

Response statistics for segments on the edge.

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

The number of requests that completed with a 2xx Success status code.

The aggregate response time of completed requests.

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

The total number of completed requests.

The encryption status. While the status is UPDATING, X-Ray may encrypt data with a combination of the new and old settings.

The ID of the KMS key used for encryption, if applicable.

The type of encryption. Set to KMS for encryption with KMS keys. Set to NONE for default encryption.

A flag that denotes that the root cause impacts the trace client.

A list of services corresponding to an error. A service identifies a segment and it contains a name, account ID, type, and inferred flag.

The types and messages of the exceptions.

A flag that denotes a remote subsegment.

The name of the entity.

The path of root cause entities found on the service.

The account ID associated to the service.

A collection of associated service names.

The service name.

A Boolean value indicating if the service is inferred from the trace.

The type associated to the service.

The number of requests that failed with untracked 4xx Client Error status codes.

The number of requests that failed with a 419 throttling status code.

The total number of requests that failed with a 4xx Client Error status code.

A flag that denotes that the root cause impacts the trace client.

A list of corresponding services. A service identifies a segment and it contains a name, account ID, type, and inferred flag.

The types and messages of the exceptions.

A flag that denotes a remote subsegment.

The name of the entity.

The path of root cause entities found on the service.

The account ID associated to the service.

A collection of associated service names.

The service name.

A Boolean value indicating if the service is inferred from the trace.

The type associated to the service.

The number of requests that failed with untracked 5xx Server Error status codes.

The total number of requests that failed with a 5xx Server Error status code.

The lower limit of fault counts for a service.

The upper limit of fault counts for a service.

The filter expression defining the parameters to include traces.

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 Amazon Resource Name (ARN) of the group generated based on the GroupName.

The unique case-sensitive name of the group.

The filter expression defining the parameters to include traces.

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 ARN of the group generated based on the GroupName.

The unique case-sensitive name of the group.

The prevalence of the entry.

The value of the entry.

The request method.

The response status.

The IP address of the requestor.

The request's user agent string.

The request URL.

A brief description of the insight.

The current state of the insight.

The time, in Unix seconds, at which the insight began.

The insights unique identifier.

The categories that label and describe the type of insight.

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.

The service within the insight that is most impacted by the incident.

Undocumented member.

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.

The time, in Unix seconds, at which the insight ended.

The Amazon Resource Name (ARN) of the group that the insight belongs to.

The name of the group that the insight belongs to.

A brief description of the event.

The time, in Unix seconds, at which the event was recorded.

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.

The service during the event that is most impacted by the incident.

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.

Identifier of the edge. Unique within a service map.

Identifier for the service. Unique within the service map.

Identifier of the Amazon Web Services account in which the service runs.

A list of names for the service, including the canonical name.

The canonical name of the service.

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.

Connections to downstream services.

A brief description of the insight.

The current state of the insight.

The time, in Unix seconds, at which the insight began.

The insights unique identifier.

Categories The categories that label and describe the type of insight.

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.

The service within the insight that is most impacted by the incident.

Undocumented member.

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.

The time, in Unix seconds, at which the insight ended.

The Amazon Resource Name (ARN) of the group that the insight belongs to.

The name of the group that the insight belongs to.

The time, in Unix seconds, that the insight was last updated.

Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.

Set the InsightsEnabled value to true to enable insights or false to disable insights.

The ID of a corresponding EC2 instance.

The number of successful requests.

The number of requests that have resulted in a fault,

The total number of requests to the service.

The ARN of a corresponding resource.

A flag that denotes that the root cause impacts the trace client.

A list of corresponding services. A service identifies a segment and contains a name, account ID, type, and inferred flag.

A flag that denotes a remote subsegment.

The type and messages of the exceptions.

The name of the entity.

The path of root cause entities found on the service.

The account ID associated to the service.

A collection of associated service names.

The service name.

A Boolean value indicating if the service is inferred from the trace.

The type associated to the service.

The name of the exception.

The message of the exception.

The name of the sampling rule. Specify a rule by either name or ARN, but not both.

Matches attributes derived from the request.

The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

Matches the ARN of the Amazon Web Services resource on which the service runs.

The priority of the sampling rule.

The percentage of matching requests to instrument, after the reservoir is exhausted.

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.

Matches the name that the service uses to identify itself in segments.

Matches the origin that the service uses to identify its type in segments.

Matches the hostname from a request URL.

Matches the HTTP method of a request.

Matches the path from a request URL.

The version of the sampling rule format (1).

When the rule was last modified.

The sampling rule.

When the rule was created.

Matches the HTTP method of a request.

The priority of the sampling rule.

The name of the sampling rule. Specify a rule by either name or ARN, but not both.

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.

The percentage of matching requests to instrument, after the reservoir is exhausted.

Matches the ARN of the Amazon Web Services resource on which the service runs.

Matches attributes derived from the request.

Matches the name that the service uses to identify itself in segments.

Matches the origin that the service uses to identify its type in segments.

Matches the hostname from a request URL.

The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

Matches the path from a request URL.

The number of requests that matched the rule.

The number of requests recorded with borrowed reservoir quota.

The name of the sampling rule.

The start time of the reporting window.

The number of requests recorded.

The number of requests recorded with borrowed reservoir quota.

The name of the sampling rule.

A unique identifier for the service in hexadecimal.

The current time.

The number of requests that matched the rule.

The number of requests recorded.

The value of a sampling rule.

The name of a sampling rule.

The number of requests per second that X-Ray allocated for this service.

The name of the sampling rule.

The percentage of matching requests to instrument, after the reservoir is exhausted.

The number of seconds for the service to wait before getting sampling targets again.

When the reservoir quota expires.

The segment document.

The segment's ID.

The service's state.

The start time of the first segment that the service generated.

Indicates that the service was the first service to process a request.

A histogram that maps the spread of service response times.

A histogram that maps the spread of service durations.

Identifier for the service. Unique within the service map.

Identifier of the Amazon Web Services account in which the service runs.

A list of names for the service, including the canonical name.

The canonical name of the service.

The end time of the last segment that the service generated.

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.

Connections to downstream services.

Aggregated statistics for the service.

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

The number of requests that completed with a 2xx Success status code.

The aggregate response time of completed requests.

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

The total number of completed requests.

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: + - = . _ : /

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: + - = . _ : /

Undocumented member.

The response time histogram for the selected entities.

Undocumented member.

The forecasted high and low fault count values.

Timestamp of the window for which statistics are aggregated.

LimitExceeded is set to true when the trace has exceeded one of the defined quotas. For more information about quotas, see Amazon Web Services X-Ray endpoints and quotas.

The unique identifier for the request that generated the trace's segments and subsegments.

Segment documents for the segments and subsegments that comprise the trace.

The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.

Annotations from the trace's segment documents.

One or more of the segment documents has a 429 throttling error.

Users from the trace's segment documents.

The root of a trace.

The root segment document has a 500 series error.

Service IDs from the trace's segment documents.

The matched time stamp of a defined event.

One or more of the segment documents is in progress.

A collection of ErrorRootCause structures corresponding to the trace segments.

A list of resource ARNs for any resource corresponding to the trace segments.

A list of Availability Zones for any zone corresponding to the trace segments.

A list of EC2 instance IDs for any instance corresponding to the trace segments.

A collection of ResponseTimeRootCause structures corresponding to the trace segments.

The root segment document has a 400 series error.

The unique identifier for the request that generated the trace's segments and subsegments.

Information about the HTTP request served by the trace.

The revision number of a trace.

The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.

A collection of FaultRootCause structures corresponding to the trace segments.

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.

Services that the user's request hit.

The user's name.

The name of the sampling rule.

The error code.

The error message.

The error that caused processing to fail.

The segment's ID.

The error message.

Services to which the annotation applies.

Values of the annotation.