openapi: 3.0.0
info:
version: '2016-04-12'
x-release: v4
title: AWS X-Ray
description: Amazon Web Services X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.
x-logo:
url: 'https://twitter.com/awscloud/profile_image?size=original'
backgroundColor: '#FFFFFF'
termsOfService: 'https://aws.amazon.com/service-terms/'
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: 'https://github.com/mermade/aws2openapi'
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: 'http://www.apache.org/licenses/'
x-providerName: amazonaws.com
x-serviceName: xray
x-origin:
- contentType: application/json
url: 'https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/xray-2016-04-12.normal.json'
converter:
url: 'https://github.com/mermade/aws2openapi'
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: 'https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct'
x-apisguru-categories:
- cloud
x-preferred: true
externalDocs:
description: Amazon Web Services documentation
url: 'https://docs.aws.amazon.com/xray/'
servers:
- url: 'http://xray.{region}.amazonaws.com'
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS X-Ray multi-region endpoint
- url: 'https://xray.{region}.amazonaws.com'
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS X-Ray multi-region endpoint
- url: 'http://xray.{region}.amazonaws.com.cn'
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS X-Ray endpoint for China (Beijing) and China (Ningxia)
- url: 'https://xray.{region}.amazonaws.com.cn'
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS X-Ray endpoint for China (Beijing) and China (Ningxia)
paths:
/Traces:
post:
operationId: BatchGetTraces
description: 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.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BatchGetTracesResult'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ThrottledException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottledException'
parameters:
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- TraceIds
properties:
TraceIds:
description: Specify the trace IDs of requests for which to retrieve segments.
type: array
items:
$ref: '#/components/schemas/TraceId'
NextToken:
description: Pagination token.
type: string
summary: Amazon X-Ray Batch Get Traces
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/CreateGroup:
post:
operationId: CreateGroup
description: 'Creates a group resource with a name and a filter expression. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateGroupResult'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ThrottledException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottledException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- GroupName
properties:
GroupName:
description: The case-sensitive name of the new group. Default is a reserved name and names must be unique.
type: string
minLength: 1
maxLength: 32
FilterExpression:
description: The filter expression defining criteria by which to group traces.
type: string
InsightsConfiguration:
description: The structure containing configurations related to insights.
type: object
properties:
InsightsEnabled:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: Set the InsightsEnabled value to true to enable insights or false to disable insights.
NotificationsEnabled:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.
Tags:
description: '
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.
name that the service uses to identify itself in segments.
ServiceType:
allOf:
- $ref: '#/components/schemas/ServiceType'
- description: Matches the origin that the service uses to identify its type in segments.
Host:
allOf:
- $ref: '#/components/schemas/Host'
- description: Matches the hostname from a request URL.
HTTPMethod:
allOf:
- $ref: '#/components/schemas/HTTPMethod'
- description: Matches the HTTP method of a request.
URLPath:
allOf:
- $ref: '#/components/schemas/URLPath'
- description: Matches the path from a request URL.
Version:
allOf:
- $ref: '#/components/schemas/Version'
- description: The version of the sampling rule format (1).
Attributes:
allOf:
- $ref: '#/components/schemas/AttributeMap'
- description: Matches attributes derived from the request.
Tags:
description: '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.
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. '
type: string
summary: Amazon X-Ray Delete Resource Policy
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/DeleteSamplingRule:
post:
operationId: DeleteSamplingRule
description: Deletes a sampling rule.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteSamplingRuleResult'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ThrottledException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottledException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
RuleName:
description: 'The name of the sampling rule. Specify a rule by either name or ARN, but not both.'
type: string
RuleARN:
description: 'The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.'
type: string
summary: Amazon X-Ray Delete Sampling Rule
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/EncryptionConfig:
post:
operationId: GetEncryptionConfig
description: Retrieves the current encryption configuration for X-Ray data.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetEncryptionConfigResult'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ThrottledException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottledException'
parameters: []
summary: Amazon X-Ray Get Encryption Config
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/GetGroup:
post:
operationId: GetGroup
description: Retrieves group resource details.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetGroupResult'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ThrottledException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottledException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
GroupName:
description: The case-sensitive name of the group.
type: string
minLength: 1
maxLength: 32
GroupARN:
description: The ARN of the group that was generated on creation.
type: string
minLength: 1
maxLength: 400
summary: Amazon X-Ray Get Group
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/Groups:
post:
operationId: GetGroups
description: Retrieves all active group details.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetGroupsResult'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ThrottledException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottledException'
parameters:
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
NextToken:
description: Pagination token.
type: string
minLength: 1
maxLength: 100
summary: Amazon X-Ray Get Groups
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/Insight:
post:
operationId: GetInsight
description: '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.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetInsightResult'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ThrottledException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottledException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- InsightId
properties:
InsightId:
description: The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.
type: string
pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}'
summary: Amazon X-Ray Get Insight
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/InsightEvents:
post:
operationId: GetInsightEvents
description: '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.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetInsightEventsResult'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ThrottledException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottledException'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- InsightId
properties:
InsightId:
description: The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.
type: string
pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}'
MaxResults:
description: Used to retrieve at most the specified value of events.
type: integer
minimum: 1
maximum: 50
NextToken:
description: 'Specify the pagination token returned by a previous request to retrieve the next page of events. '
type: string
minLength: 1
maxLength: 2000
summary: Amazon X-Ray Get Insight Events
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/InsightImpactGraph:
post:
operationId: GetInsightImpactGraph
description: '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.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetInsightImpactGraphResult'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ThrottledException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottledException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- InsightId
- StartTime
- EndTime
properties:
InsightId:
description: The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.
type: string
pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}'
StartTime:
description: '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.'
type: string
format: date-time
EndTime:
description: '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. '
type: string
format: date-time
NextToken:
description: 'Specify the pagination token returned by a previous request to retrieve the next page of results. '
type: string
minLength: 1
maxLength: 2000
summary: Amazon X-Ray Get Insight Impact Graph
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/InsightSummaries:
post:
operationId: GetInsightSummaries
description: Retrieves the summaries of all insights in the specified group matching the provided filter values.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetInsightSummariesResult'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ThrottledException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottledException'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- StartTime
- EndTime
properties:
States:
description: 'The list of insight states. '
type: array
items:
$ref: '#/components/schemas/InsightState'
minItems: 0
maxItems: 1
GroupARN:
description: The Amazon Resource Name (ARN) of the group. Required if the GroupName isn't provided.
type: string
minLength: 1
maxLength: 400
GroupName:
description: The name of the group. Required if the GroupARN isn't provided.
type: string
minLength: 1
maxLength: 32
StartTime:
description: The beginning of the time frame in which the insights started. The start time can't be more than 30 days old.
type: string
format: date-time
EndTime:
description: The end of the time frame in which the insights ended. The end time can't be more than 30 days old.
type: string
format: date-time
MaxResults:
description: The maximum number of results to display.
type: integer
minimum: 1
maximum: 100
NextToken:
description: Pagination token.
type: string
minLength: 1
maxLength: 2000
summary: Amazon X-Ray Get Insight Summaries
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/GetSamplingRules:
post:
operationId: GetSamplingRules
description: Retrieves all sampling rules.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetSamplingRulesResult'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ThrottledException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottledException'
parameters:
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
NextToken:
description: Pagination token.
type: string
summary: Amazon X-Ray Get Sampling Rules
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/SamplingStatisticSummaries:
post:
operationId: GetSamplingStatisticSummaries
description: Retrieves information about recent sampling results for all sampling rules.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetSamplingStatisticSummariesResult'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ThrottledException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottledException'
parameters:
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
NextToken:
description: Pagination token.
type: string
summary: Amazon X-Ray Get Sampling Statistic Summaries
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/SamplingTargets:
post:
operationId: GetSamplingTargets
description: 'Requests a sampling quota for rules that the service is using to sample requests. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetSamplingTargetsResult'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ThrottledException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottledException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- SamplingStatisticsDocuments
properties:
SamplingStatisticsDocuments:
description: Information about rules that the service is using to sample requests.
type: array
items:
$ref: '#/components/schemas/SamplingStatisticsDocument'
maxItems: 25
summary: Amazon X-Ray Get Sampling Targets
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/ServiceGraph:
post:
operationId: GetServiceGraph
description: '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.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetServiceGraphResult'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ThrottledException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottledException'
parameters:
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- StartTime
- EndTime
properties:
StartTime:
description: The start of the time frame for which to generate a graph.
type: string
format: date-time
EndTime:
description: The end of the timeframe for which to generate a graph.
type: string
format: date-time
GroupName:
description: The name of a group based on which you want to generate a graph.
type: string
minLength: 1
maxLength: 32
GroupARN:
description: The Amazon Resource Name (ARN) of a group based on which you want to generate a graph.
type: string
minLength: 1
maxLength: 400
NextToken:
description: Pagination token.
type: string
summary: Amazon X-Ray Get Service Graph
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/TimeSeriesServiceStatistics:
post:
operationId: GetTimeSeriesServiceStatistics
description: Get an aggregation of service statistics defined by a specific time range.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesServiceStatisticsResult'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ThrottledException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottledException'
parameters:
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- StartTime
- EndTime
properties:
StartTime:
description: The start of the time frame for which to aggregate statistics.
type: string
format: date-time
EndTime:
description: The end of the time frame for which to aggregate statistics.
type: string
format: date-time
GroupName:
description: The case-sensitive name of the group for which to pull statistics from.
type: string
minLength: 1
maxLength: 32
GroupARN:
description: The Amazon Resource Name (ARN) of the group for which to pull statistics from.
type: string
minLength: 1
maxLength: 400
EntitySelectorExpression:
description: '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. '
type: string
minLength: 1
maxLength: 500
Period:
description: Aggregation period in seconds.
type: integer
ForecastStatistics:
description: The forecasted high and low fault count values. Forecast enabled requests require the EntitySelectorExpression ID be provided.
type: boolean
NextToken:
description: Pagination token.
type: string
summary: Amazon X-Ray Get Time Series Service Statistics
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/TraceGraph:
post:
operationId: GetTraceGraph
description: Retrieves a service graph for one or more specific trace IDs.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetTraceGraphResult'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ThrottledException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottledException'
parameters:
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- TraceIds
properties:
TraceIds:
description: Trace IDs of requests for which to generate a service graph.
type: array
items:
$ref: '#/components/schemas/TraceId'
NextToken:
description: Pagination token.
type: string
summary: Amazon X-Ray Get Trace Graph
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/TraceSummaries:
post:
operationId: GetTraceSummaries
description: '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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetTraceSummariesResult' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: ThrottledException content: application/json: schema: $ref: '#/components/schemas/ThrottledException' parameters: - name: NextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object required: - StartTime - EndTime properties: StartTime: description: The start of the time frame for which to retrieve traces. type: string format: date-time EndTime: description: The end of the time frame for which to retrieve traces. type: string format: date-time TimeRangeType: description: A parameter to indicate whether to query trace summaries by TraceId or Event time. type: string enum: - TraceId - Event Sampling: description: Set totrue to get summaries for only a subset of available traces.
type: boolean
SamplingStrategy:
description: The name and value of a sampling rule to apply to a trace summary.
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/SamplingStrategyName'
- description: The name of a sampling rule.
Value:
allOf:
- $ref: '#/components/schemas/NullableDouble'
- description: The value of a sampling rule.
FilterExpression:
description: Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.
type: string
NextToken:
description: Specify the pagination token returned by a previous request to retrieve the next page of results.
type: string
summary: Amazon X-Ray Get Trace Summaries
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/ListResourcePolicies:
post:
operationId: ListResourcePolicies
description: Returns the list of resource policies in the target Amazon Web Services account.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListResourcePoliciesResult'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ThrottledException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottledException'
parameters:
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
NextToken:
description: Not currently supported.
type: string
minLength: 1
maxLength: 100
summary: Amazon X-Ray List Resource Policies
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/ListTagsForResource:
post:
operationId: ListTagsForResource
description: Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListTagsForResourceResponse'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ThrottledException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottledException'
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
parameters:
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- ResourceARN
properties:
ResourceARN:
description: The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
type: string
minLength: 1
maxLength: 1011
NextToken:
description: '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.'
type: string
summary: Amazon X-Ray List Tags for Resource
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/PutEncryptionConfig:
post:
operationId: PutEncryptionConfig
description: Updates the encryption configuration for X-Ray data.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PutEncryptionConfigResult'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ThrottledException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottledException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- Type
properties:
KeyId:
description: '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.
KMS to use your own key for encryption. Set to NONE for default encryption.
type: string
enum:
- NONE
- KMS
summary: Amazon X-Ray Put Encryption Config
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/PutResourcePolicy:
post:
operationId: PutResourcePolicy
description: ' 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. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PutResourcePolicyResult'
'480':
description: MalformedPolicyDocumentException
content:
application/json:
schema:
$ref: '#/components/schemas/MalformedPolicyDocumentException'
'481':
description: LockoutPreventionException
content:
application/json:
schema:
$ref: '#/components/schemas/LockoutPreventionException'
'482':
description: InvalidPolicyRevisionIdException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidPolicyRevisionIdException'
'483':
description: PolicySizeLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/PolicySizeLimitExceededException'
'484':
description: PolicyCountLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/PolicyCountLimitExceededException'
'485':
description: ThrottledException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottledException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- PolicyName
- PolicyDocument
properties:
PolicyName:
description: The name of the resource policy. Must be unique within a specific Amazon Web Services account.
type: string
pattern: '[\w+=,.@-]+'
minLength: 1
maxLength: 128
PolicyDocument:
description: 'The resource policy document, which can be up to 5kb in size.'
type: string
PolicyRevisionId:
description: '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.
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.
type: boolean summary: Amazon X-Ray Put Resource Policy parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /TelemetryRecords: post: operationId: PutTelemetryRecords description: Used by the Amazon Web Services X-Ray daemon to upload telemetry. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PutTelemetryRecordsResult' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: ThrottledException content: application/json: schema: $ref: '#/components/schemas/ThrottledException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - TelemetryRecords properties: TelemetryRecords: description: type: array items: $ref: '#/components/schemas/TelemetryRecord' EC2InstanceId: description: type: string maxLength: 20 Hostname: description: type: string maxLength: 255 ResourceARN: description: type: string maxLength: 500 summary: Amazon X-Ray Put Telemetry Records parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /TraceSegments: post: operationId: PutTraceSegments description: '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.
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.
aws: prefix).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UntagResourceResponse'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ThrottledException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottledException'
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- ResourceARN
- TagKeys
properties:
ResourceARN:
description: The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
type: string
minLength: 1
maxLength: 1011
TagKeys:
description: Keys for one or more tags that you want to remove from an X-Ray group or sampling rule.
type: array
items:
$ref: '#/components/schemas/TagKey'
minItems: 0
maxItems: 200
summary: Amazon X-Ray Untag Resource
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/UpdateGroup:
post:
operationId: UpdateGroup
description: Updates a group resource.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateGroupResult'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ThrottledException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottledException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
GroupName:
description: The case-sensitive name of the group.
type: string
minLength: 1
maxLength: 32
GroupARN:
description: The ARN that was generated upon creation.
type: string
minLength: 1
maxLength: 400
FilterExpression:
description: The updated filter expression defining criteria by which to group traces.
type: string
InsightsConfiguration:
description: The structure containing configurations related to insights.
type: object
properties:
InsightsEnabled:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: Set the InsightsEnabled value to true to enable insights or false to disable insights.
NotificationsEnabled:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.
summary: Amazon X-Ray Update Group
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/UpdateSamplingRule:
post:
operationId: UpdateSamplingRule
description: Modifies a sampling rule's configuration.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSamplingRuleResult'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ThrottledException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottledException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- SamplingRuleUpdate
properties:
SamplingRuleUpdate:
description: A document specifying changes to a sampling rule's configuration.
type: object
properties:
RuleName:
allOf:
- $ref: '#/components/schemas/RuleName'
- description: 'The name of the sampling rule. Specify a rule by either name or ARN, but not both.'
RuleARN:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.'
ResourceARN:
allOf:
- $ref: '#/components/schemas/ResourceARN'
- description: Matches the ARN of the Amazon Web Services resource on which the service runs.
Priority:
allOf:
- $ref: '#/components/schemas/NullableInteger'
- description: The priority of the sampling rule.
FixedRate:
allOf:
- $ref: '#/components/schemas/NullableDouble'
- description: 'The percentage of matching requests to instrument, after the reservoir is exhausted.'
ReservoirSize:
allOf:
- $ref: '#/components/schemas/NullableInteger'
- description: '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.'
Host:
allOf:
- $ref: '#/components/schemas/Host'
- description: Matches the hostname from a request URL.
ServiceName:
allOf:
- $ref: '#/components/schemas/ServiceName'
- description: Matches the name that the service uses to identify itself in segments.
ServiceType:
allOf:
- $ref: '#/components/schemas/ServiceType'
- description: Matches the origin that the service uses to identify its type in segments.
HTTPMethod:
allOf:
- $ref: '#/components/schemas/HTTPMethod'
- description: Matches the HTTP method of a request.
URLPath:
allOf:
- $ref: '#/components/schemas/URLPath'
- description: Matches the path from a request URL.
Attributes:
allOf:
- $ref: '#/components/schemas/AttributeMap'
- description: Matches attributes derived from the request.
summary: Amazon X-Ray Update Sampling Rule
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
components:
parameters:
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
schemas:
BatchGetTracesResult:
type: object
properties:
Traces:
allOf:
- $ref: '#/components/schemas/TraceList'
- description: Full traces for the specified requests.
UnprocessedTraceIds:
allOf:
- $ref: '#/components/schemas/UnprocessedTraceIdList'
- description: Trace IDs of requests that haven't been processed.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: Pagination token.
TraceId:
type: string
minLength: 1
maxLength: 35
InvalidRequestException: {}
ThrottledException: {}
CreateGroupResult:
type: object
properties:
Group:
allOf:
- $ref: '#/components/schemas/Group'
- description: '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.'
NullableBoolean:
type: boolean
Tag:
type: object
required:
- Key
- Value
properties:
Key:
allOf:
- $ref: '#/components/schemas/TagKey'
- description: '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: + - = . _ : / '
Value:
allOf:
- $ref: '#/components/schemas/TagValue'
- description: '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: + - = . _ : / '
description: '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.
NextToken value returned with the current page of results to get the next page of results.'
ResourceNotFoundException: {}
PutEncryptionConfigResult:
type: object
properties:
EncryptionConfig:
allOf:
- $ref: '#/components/schemas/EncryptionConfig'
- description: The new encryption configuration.
PutResourcePolicyResult:
type: object
properties:
ResourcePolicy:
allOf:
- $ref: '#/components/schemas/ResourcePolicy'
- description: 'The resource policy document, as provided in the PutResourcePolicyRequest.'
MalformedPolicyDocumentException: {}
LockoutPreventionException: {}
PolicySizeLimitExceededException: {}
PolicyCountLimitExceededException: {}
PutTelemetryRecordsResult:
type: object
properties: {}
TelemetryRecord:
type: object
required:
- Timestamp
properties:
Timestamp:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description:
SegmentsReceivedCount:
allOf:
- $ref: '#/components/schemas/NullableInteger'
- description:
SegmentsSentCount:
allOf:
- $ref: '#/components/schemas/NullableInteger'
- description:
SegmentsSpilloverCount:
allOf:
- $ref: '#/components/schemas/NullableInteger'
- description:
SegmentsRejectedCount:
allOf:
- $ref: '#/components/schemas/NullableInteger'
- description:
BackendConnectionErrors:
allOf:
- $ref: '#/components/schemas/BackendConnectionErrors'
- description:
description:
PutTraceSegmentsResult:
type: object
properties:
UnprocessedTraceSegments:
allOf:
- $ref: '#/components/schemas/UnprocessedTraceSegmentList'
- description: Segments that failed processing.
TraceSegmentDocument:
type: string
TagResourceResponse:
type: object
properties: {}
TooManyTagsException: {}
UntagResourceResponse:
type: object
properties: {}
TagKey:
type: string
minLength: 1
maxLength: 128
UpdateGroupResult:
type: object
properties:
Group:
allOf:
- $ref: '#/components/schemas/Group'
- description: '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.'
UpdateSamplingRuleResult:
type: object
properties:
SamplingRuleRecord:
allOf:
- $ref: '#/components/schemas/SamplingRuleRecord'
- description: The updated rule definition and metadata.
NullableInteger:
type: integer
AliasNames:
type: array
items:
$ref: '#/components/schemas/String'
Alias:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/String'
- description: The canonical name of the alias.
Names:
allOf:
- $ref: '#/components/schemas/AliasNames'
- description: 'A list of names for the alias, including the canonical name.'
Type:
allOf:
- $ref: '#/components/schemas/String'
- description: The type of the alias.
description: An alias for an edge.
AliasList:
type: array
items:
$ref: '#/components/schemas/Alias'
AmazonResourceName:
type: string
minLength: 1
maxLength: 1011
AnnotationKey:
type: string
AnnotationValue:
type: object
properties:
NumberValue:
allOf:
- $ref: '#/components/schemas/NullableDouble'
- description: Value for a Number annotation.
BooleanValue:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: Value for a Boolean annotation.
StringValue:
allOf:
- $ref: '#/components/schemas/String'
- description: Value for a String annotation.
description: 'Value of a segment annotation. Has one of three value types: Number, Boolean, or String.'
ValuesWithServiceIds:
type: array
items:
$ref: '#/components/schemas/ValueWithServiceIds'
Annotations:
type: object
additionalProperties:
$ref: '#/components/schemas/ValuesWithServiceIds'
ServiceId:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/String'
- description:
Names:
allOf:
- $ref: '#/components/schemas/ServiceNames'
- description:
AccountId:
allOf:
- $ref: '#/components/schemas/String'
- description:
Type:
allOf:
- $ref: '#/components/schemas/String'
- description:
description:
AnomalousService:
type: object
properties:
ServiceId:
$ref: '#/components/schemas/ServiceId'
description: 'The service within the service graph that has anomalously high fault rates. '
AnomalousServiceList:
type: array
items:
$ref: '#/components/schemas/AnomalousService'
AttributeKey:
type: string
minLength: 1
maxLength: 32
AttributeValue:
type: string
minLength: 1
maxLength: 32
AvailabilityZoneDetail:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of a corresponding Availability Zone.
description: A list of Availability Zones corresponding to the segments in a trace.
BackendConnectionErrors:
type: object
properties:
TimeoutCount:
allOf:
- $ref: '#/components/schemas/NullableInteger'
- description:
ConnectionRefusedCount:
allOf:
- $ref: '#/components/schemas/NullableInteger'
- description:
HTTPCode4XXCount:
allOf:
- $ref: '#/components/schemas/NullableInteger'
- description:
HTTPCode5XXCount:
allOf:
- $ref: '#/components/schemas/NullableInteger'
- description:
UnknownHostCount:
allOf:
- $ref: '#/components/schemas/NullableInteger'
- description:
OtherCount:
allOf:
- $ref: '#/components/schemas/NullableInteger'
- description:
description:
TraceIdList:
type: array
items:
$ref: '#/components/schemas/TraceId'
BatchGetTracesRequest:
type: object
required:
- TraceIds
title: BatchGetTracesRequest
properties:
TraceIds:
allOf:
- $ref: '#/components/schemas/TraceIdList'
- description: Specify the trace IDs of requests for which to retrieve segments.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: Pagination token.
TraceList:
type: array
items:
$ref: '#/components/schemas/Trace'
UnprocessedTraceIdList:
type: array
items:
$ref: '#/components/schemas/TraceId'
Boolean:
type: boolean
BorrowCount:
type: integer
minimum: 0
ClientID:
type: string
minLength: 24
maxLength: 24
GroupName:
type: string
minLength: 1
maxLength: 32
FilterExpression:
type: string
InsightsConfiguration:
type: object
properties:
InsightsEnabled:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: Set the InsightsEnabled value to true to enable insights or false to disable insights.
NotificationsEnabled:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.
description: The structure containing configurations related to insights.
TagList:
type: array
items:
$ref: '#/components/schemas/Tag'
minItems: 0
maxItems: 200
CreateGroupRequest:
type: object
required:
- GroupName
title: CreateGroupRequest
properties:
GroupName:
allOf:
- $ref: '#/components/schemas/GroupName'
- description: The case-sensitive name of the new group. Default is a reserved name and names must be unique.
FilterExpression:
allOf:
- $ref: '#/components/schemas/FilterExpression'
- description: The filter expression defining criteria by which to group traces.
InsightsConfiguration:
allOf:
- $ref: '#/components/schemas/InsightsConfiguration'
- description: 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.
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 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.
name that the service uses to identify itself in segments.
ServiceType:
allOf:
- $ref: '#/components/schemas/ServiceType'
- description: Matches the origin that the service uses to identify its type in segments.
Host:
allOf:
- $ref: '#/components/schemas/Host'
- description: Matches the hostname from a request URL.
HTTPMethod:
allOf:
- $ref: '#/components/schemas/HTTPMethod'
- description: Matches the HTTP method of a request.
URLPath:
allOf:
- $ref: '#/components/schemas/URLPath'
- description: Matches the path from a request URL.
Version:
allOf:
- $ref: '#/components/schemas/Version'
- description: The version of the sampling rule format (1).
Attributes:
allOf:
- $ref: '#/components/schemas/AttributeMap'
- description: Matches attributes derived from the request.
description: '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.'
CreateSamplingRuleRequest:
type: object
required:
- SamplingRule
title: CreateSamplingRuleRequest
properties:
SamplingRule:
allOf:
- $ref: '#/components/schemas/SamplingRule'
- description: The rule definition.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: '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.
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. '
DeleteSamplingRuleRequest:
type: object
title: DeleteSamplingRuleRequest
properties:
RuleName:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The name of the sampling rule. Specify a rule by either name or ARN, but not both.'
RuleARN:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.'
Double:
type: number
format: double
EC2InstanceId:
type: string
maxLength: 20
Timestamp:
type: string
format: date-time
EdgeStatistics:
type: object
properties:
OkCount:
allOf:
- $ref: '#/components/schemas/NullableLong'
- description: The number of requests that completed with a 2xx Success status code.
ErrorStatistics:
allOf:
- $ref: '#/components/schemas/ErrorStatistics'
- description: Information about requests that failed with a 4xx Client Error status code.
FaultStatistics:
allOf:
- $ref: '#/components/schemas/FaultStatistics'
- description: Information about requests that failed with a 5xx Server Error status code.
TotalCount:
allOf:
- $ref: '#/components/schemas/NullableLong'
- description: The total number of completed requests.
TotalResponseTime:
allOf:
- $ref: '#/components/schemas/NullableDouble'
- description: The aggregate response time of completed requests.
description: Response statistics for an edge.
Histogram:
type: array
items:
$ref: '#/components/schemas/HistogramEntry'
Edge:
type: object
properties:
ReferenceId:
allOf:
- $ref: '#/components/schemas/NullableInteger'
- description: Identifier of the edge. Unique within a service map.
StartTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The start time of the first segment on the edge.
EndTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The end time of the last segment on the edge.
SummaryStatistics:
allOf:
- $ref: '#/components/schemas/EdgeStatistics'
- description: Response statistics for segments on the edge.
ResponseTimeHistogram:
allOf:
- $ref: '#/components/schemas/Histogram'
- description: A histogram that maps the spread of client response times on an edge. Only populated for synchronous edges.
Aliases:
allOf:
- $ref: '#/components/schemas/AliasList'
- description: Aliases for the edge.
EdgeType:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Describes an asynchronous connection, with a value of link.'
ReceivedEventAgeHistogram:
allOf:
- $ref: '#/components/schemas/Histogram'
- description: 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.
description: '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.'
EdgeList:
type: array
items:
$ref: '#/components/schemas/Edge'
NullableLong:
type: integer
ErrorStatistics:
type: object
properties:
ThrottleCount:
allOf:
- $ref: '#/components/schemas/NullableLong'
- description: The number of requests that failed with a 419 throttling status code.
OtherCount:
allOf:
- $ref: '#/components/schemas/NullableLong'
- description: The number of requests that failed with untracked 4xx Client Error status codes.
TotalCount:
allOf:
- $ref: '#/components/schemas/NullableLong'
- description: The total number of requests that failed with a 4xx Client Error status code.
description: Information about requests that failed with a 4xx Client Error status code.
FaultStatistics:
type: object
properties:
OtherCount:
allOf:
- $ref: '#/components/schemas/NullableLong'
- description: The number of requests that failed with untracked 5xx Server Error status codes.
TotalCount:
allOf:
- $ref: '#/components/schemas/NullableLong'
- description: The total number of requests that failed with a 5xx Server Error status code.
description: Information about requests that failed with a 5xx Server Error status code.
EncryptionStatus:
type: string
enum:
- UPDATING
- ACTIVE
EncryptionType:
type: string
enum:
- NONE
- KMS
EncryptionConfig:
type: object
properties:
KeyId:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The ID of the KMS key used for encryption, if applicable.'
Status:
allOf:
- $ref: '#/components/schemas/EncryptionStatus'
- description: 'The encryption status. While the status is UPDATING, X-Ray may encrypt data with a combination of the new and old settings.'
Type:
allOf:
- $ref: '#/components/schemas/EncryptionType'
- description: The type of encryption. Set to KMS for encryption with KMS keys. Set to NONE for default encryption.
description: A configuration document that specifies encryption configuration settings.
EncryptionKeyId:
type: string
minLength: 1
maxLength: 3000
EntitySelectorExpression:
type: string
minLength: 1
maxLength: 500
ErrorRootCauseServices:
type: array
items:
$ref: '#/components/schemas/ErrorRootCauseService'
ErrorRootCause:
type: object
properties:
Services:
allOf:
- $ref: '#/components/schemas/ErrorRootCauseServices'
- description: 'A list of services corresponding to an error. A service identifies a segment and it contains a name, account ID, type, and inferred flag.'
ClientImpacting:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: A flag that denotes that the root cause impacts the trace client.
description: The root cause of a trace summary error.
RootCauseExceptions:
type: array
items:
$ref: '#/components/schemas/RootCauseException'
ErrorRootCauseEntity:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the entity.
Exceptions:
allOf:
- $ref: '#/components/schemas/RootCauseExceptions'
- description: The types and messages of the exceptions.
Remote:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: A flag that denotes a remote subsegment.
description: A collection of segments and corresponding subsegments associated to a trace summary error.
ErrorRootCauseEntityPath:
type: array
items:
$ref: '#/components/schemas/ErrorRootCauseEntity'
ServiceNames:
type: array
items:
$ref: '#/components/schemas/String'
ErrorRootCauseService:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/String'
- description: The service name.
Names:
allOf:
- $ref: '#/components/schemas/ServiceNames'
- description: A collection of associated service names.
Type:
allOf:
- $ref: '#/components/schemas/String'
- description: The type associated to the service.
AccountId:
allOf:
- $ref: '#/components/schemas/String'
- description: The account ID associated to the service.
EntityPath:
allOf:
- $ref: '#/components/schemas/ErrorRootCauseEntityPath'
- description: 'The path of root cause entities found on the service. '
Inferred:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: A Boolean value indicating if the service is inferred from the trace.
description: A collection of fields identifying the services in a trace summary error.
ErrorRootCauses:
type: array
items:
$ref: '#/components/schemas/ErrorRootCause'
EventSummaryText:
type: string
FaultRootCauseServices:
type: array
items:
$ref: '#/components/schemas/FaultRootCauseService'
FaultRootCause:
type: object
properties:
Services:
allOf:
- $ref: '#/components/schemas/FaultRootCauseServices'
- description: 'A list of corresponding services. A service identifies a segment and it contains a name, account ID, type, and inferred flag.'
ClientImpacting:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: A flag that denotes that the root cause impacts the trace client.
description: The root cause information for a trace summary fault.
FaultRootCauseEntity:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the entity.
Exceptions:
allOf:
- $ref: '#/components/schemas/RootCauseExceptions'
- description: The types and messages of the exceptions.
Remote:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: A flag that denotes a remote subsegment.
description: A collection of segments and corresponding subsegments associated to a trace summary fault error.
FaultRootCauseEntityPath:
type: array
items:
$ref: '#/components/schemas/FaultRootCauseEntity'
FaultRootCauseService:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/String'
- description: The service name.
Names:
allOf:
- $ref: '#/components/schemas/ServiceNames'
- description: A collection of associated service names.
Type:
allOf:
- $ref: '#/components/schemas/String'
- description: The type associated to the service.
AccountId:
allOf:
- $ref: '#/components/schemas/String'
- description: The account ID associated to the service.
EntityPath:
allOf:
- $ref: '#/components/schemas/FaultRootCauseEntityPath'
- description: 'The path of root cause entities found on the service. '
Inferred:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: A Boolean value indicating if the service is inferred from the trace.
description: A collection of fields identifying the services in a trace summary fault.
FaultRootCauses:
type: array
items:
$ref: '#/components/schemas/FaultRootCause'
ForecastStatistics:
type: object
properties:
FaultCountHigh:
allOf:
- $ref: '#/components/schemas/NullableLong'
- description: The upper limit of fault counts for a service.
FaultCountLow:
allOf:
- $ref: '#/components/schemas/NullableLong'
- description: The lower limit of fault counts for a service.
description: 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.
GetEncryptionConfigRequest:
type: object
title: GetEncryptionConfigRequest
properties: {}
GetGroupRequest:
type: object
title: GetGroupRequest
properties:
GroupName:
allOf:
- $ref: '#/components/schemas/GroupName'
- description: The case-sensitive name of the group.
GroupARN:
allOf:
- $ref: '#/components/schemas/GroupARN'
- description: The ARN of the group that was generated on creation.
GetGroupsNextToken:
type: string
minLength: 1
maxLength: 100
GetGroupsRequest:
type: object
title: GetGroupsRequest
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/GetGroupsNextToken'
- description: Pagination token.
GroupSummaryList:
type: array
items:
$ref: '#/components/schemas/GroupSummary'
GetInsightEventsMaxResults:
type: integer
minimum: 1
maximum: 50
InsightId:
type: string
pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}'
Token:
type: string
minLength: 1
maxLength: 2000
GetInsightEventsRequest:
type: object
required:
- InsightId
title: GetInsightEventsRequest
properties:
InsightId:
allOf:
- $ref: '#/components/schemas/InsightId'
- description: The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.
MaxResults:
allOf:
- $ref: '#/components/schemas/GetInsightEventsMaxResults'
- description: Used to retrieve at most the specified value of events.
NextToken:
allOf:
- $ref: '#/components/schemas/Token'
- description: 'Specify the pagination token returned by a previous request to retrieve the next page of events. '
InsightEventList:
type: array
items:
$ref: '#/components/schemas/InsightEvent'
GetInsightImpactGraphRequest:
type: object
required:
- InsightId
- StartTime
- EndTime
title: GetInsightImpactGraphRequest
properties:
InsightId:
allOf:
- $ref: '#/components/schemas/InsightId'
- description: The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.
StartTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: '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.'
EndTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: '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. '
NextToken:
allOf:
- $ref: '#/components/schemas/Token'
- description: 'Specify the pagination token returned by a previous request to retrieve the next page of results. '
InsightImpactGraphServiceList:
type: array
items:
$ref: '#/components/schemas/InsightImpactGraphService'
GetInsightRequest:
type: object
required:
- InsightId
title: GetInsightRequest
properties:
InsightId:
allOf:
- $ref: '#/components/schemas/InsightId'
- description: The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.
Insight:
type: object
properties:
InsightId:
allOf:
- $ref: '#/components/schemas/InsightId'
- description: 'The insights unique identifier. '
GroupARN:
allOf:
- $ref: '#/components/schemas/GroupARN'
- description: The Amazon Resource Name (ARN) of the group that the insight belongs to.
GroupName:
allOf:
- $ref: '#/components/schemas/GroupName'
- description: The name of the group that the insight belongs to.
RootCauseServiceId:
$ref: '#/components/schemas/ServiceId'
Categories:
allOf:
- $ref: '#/components/schemas/InsightCategoryList'
- description: The categories that label and describe the type of insight.
State:
allOf:
- $ref: '#/components/schemas/InsightState'
- description: The current state of the insight.
StartTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The time, in Unix seconds, at which the insight began.'
EndTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The time, in Unix seconds, at which the insight ended.'
Summary:
allOf:
- $ref: '#/components/schemas/InsightSummaryText'
- description: A brief description of the insight.
ClientRequestImpactStatistics:
allOf:
- $ref: '#/components/schemas/RequestImpactStatistics'
- description: 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.
RootCauseServiceRequestImpactStatistics:
allOf:
- $ref: '#/components/schemas/RequestImpactStatistics'
- description: 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.
TopAnomalousServices:
allOf:
- $ref: '#/components/schemas/AnomalousServiceList'
- description: The service within the insight that is most impacted by the incident.
description: 'When fault rates go outside of the expected range, X-Ray creates an insight. Insights tracks emergent issues within your applications.'
GetInsightSummariesMaxResults:
type: integer
minimum: 1
maximum: 100
InsightStateList:
type: array
items:
$ref: '#/components/schemas/InsightState'
minItems: 0
maxItems: 1
GetInsightSummariesRequest:
type: object
required:
- StartTime
- EndTime
title: GetInsightSummariesRequest
properties:
States:
allOf:
- $ref: '#/components/schemas/InsightStateList'
- description: 'The list of insight states. '
GroupARN:
allOf:
- $ref: '#/components/schemas/GroupARN'
- description: The Amazon Resource Name (ARN) of the group. Required if the GroupName isn't provided.
GroupName:
allOf:
- $ref: '#/components/schemas/GroupName'
- description: The name of the group. Required if the GroupARN isn't provided.
StartTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The beginning of the time frame in which the insights started. The start time can't be more than 30 days old.
EndTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The end of the time frame in which the insights ended. The end time can't be more than 30 days old.
MaxResults:
allOf:
- $ref: '#/components/schemas/GetInsightSummariesMaxResults'
- description: The maximum number of results to display.
NextToken:
allOf:
- $ref: '#/components/schemas/Token'
- description: Pagination token.
InsightSummaryList:
type: array
items:
$ref: '#/components/schemas/InsightSummary'
GetSamplingRulesRequest:
type: object
title: GetSamplingRulesRequest
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: Pagination token.
SamplingRuleRecordList:
type: array
items:
$ref: '#/components/schemas/SamplingRuleRecord'
GetSamplingStatisticSummariesRequest:
type: object
title: GetSamplingStatisticSummariesRequest
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: Pagination token.
SamplingStatisticSummaryList:
type: array
items:
$ref: '#/components/schemas/SamplingStatisticSummary'
SamplingStatisticsDocumentList:
type: array
items:
$ref: '#/components/schemas/SamplingStatisticsDocument'
maxItems: 25
GetSamplingTargetsRequest:
type: object
required:
- SamplingStatisticsDocuments
title: GetSamplingTargetsRequest
properties:
SamplingStatisticsDocuments:
allOf:
- $ref: '#/components/schemas/SamplingStatisticsDocumentList'
- description: Information about rules that the service is using to sample requests.
SamplingTargetDocumentList:
type: array
items:
$ref: '#/components/schemas/SamplingTargetDocument'
UnprocessedStatisticsList:
type: array
items:
$ref: '#/components/schemas/UnprocessedStatistics'
GetServiceGraphRequest:
type: object
required:
- StartTime
- EndTime
title: GetServiceGraphRequest
properties:
StartTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The start of the time frame for which to generate a graph.
EndTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The end of the timeframe for which to generate a graph.
GroupName:
allOf:
- $ref: '#/components/schemas/GroupName'
- description: The name of a group based on which you want to generate a graph.
GroupARN:
allOf:
- $ref: '#/components/schemas/GroupARN'
- description: The Amazon Resource Name (ARN) of a group based on which you want to generate a graph.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: Pagination token.
ServiceList:
type: array
items:
$ref: '#/components/schemas/Service'
GetTimeSeriesServiceStatisticsRequest:
type: object
required:
- StartTime
- EndTime
title: GetTimeSeriesServiceStatisticsRequest
properties:
StartTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The start of the time frame for which to aggregate statistics.
EndTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The end of the time frame for which to aggregate statistics.
GroupName:
allOf:
- $ref: '#/components/schemas/GroupName'
- description: The case-sensitive name of the group for which to pull statistics from.
GroupARN:
allOf:
- $ref: '#/components/schemas/GroupARN'
- description: The Amazon Resource Name (ARN) of the group for which to pull statistics from.
EntitySelectorExpression:
allOf:
- $ref: '#/components/schemas/EntitySelectorExpression'
- description: '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. '
Period:
allOf:
- $ref: '#/components/schemas/NullableInteger'
- description: Aggregation period in seconds.
ForecastStatistics:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: The forecasted high and low fault count values. Forecast enabled requests require the EntitySelectorExpression ID be provided.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: Pagination token.
TimeSeriesServiceStatisticsList:
type: array
items:
$ref: '#/components/schemas/TimeSeriesServiceStatistics'
GetTraceGraphRequest:
type: object
required:
- TraceIds
title: GetTraceGraphRequest
properties:
TraceIds:
allOf:
- $ref: '#/components/schemas/TraceIdList'
- description: Trace IDs of requests for which to generate a service graph.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: Pagination token.
TimeRangeType:
type: string
enum:
- TraceId
- Event
SamplingStrategy:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/SamplingStrategyName'
- description: The name of a sampling rule.
Value:
allOf:
- $ref: '#/components/schemas/NullableDouble'
- description: The value of a sampling rule.
description: The name and value of a sampling rule to apply to a trace summary.
GetTraceSummariesRequest:
type: object
required:
- StartTime
- EndTime
title: GetTraceSummariesRequest
properties:
StartTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The start of the time frame for which to retrieve traces.
EndTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The end of the time frame for which to retrieve traces.
TimeRangeType:
allOf:
- $ref: '#/components/schemas/TimeRangeType'
- description: A parameter to indicate whether to query trace summaries by TraceId or Event time.
Sampling:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: Set to true to get summaries for only a subset of available traces.
SamplingStrategy:
allOf:
- $ref: '#/components/schemas/SamplingStrategy'
- description: A parameter to indicate whether to enable sampling on trace summaries. Input parameters are Name and Value.
FilterExpression:
allOf:
- $ref: '#/components/schemas/FilterExpression'
- description: Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: Specify the pagination token returned by a previous request to retrieve the next page of results.
TraceSummaryList:
type: array
items:
$ref: '#/components/schemas/TraceSummary'
GroupSummary:
type: object
properties:
GroupName:
allOf:
- $ref: '#/components/schemas/String'
- description: The unique case-sensitive name of the group.
GroupARN:
allOf:
- $ref: '#/components/schemas/String'
- description: The ARN of the group generated based on the GroupName.
FilterExpression:
allOf:
- $ref: '#/components/schemas/String'
- description: The filter expression defining the parameters to include traces.
InsightsConfiguration:
allOf:
- $ref: '#/components/schemas/InsightsConfiguration'
- description: 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.
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.
NextToken value returned with the current page of results as the value of this parameter to
get the next page of results.'
PolicyDocument:
type: string
PutEncryptionConfigRequest:
type: object
required:
- Type
title: PutEncryptionConfigRequest
properties:
KeyId:
allOf:
- $ref: '#/components/schemas/EncryptionKeyId'
- description: '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.
KMS to use your own key for encryption. Set to NONE for default encryption.
PutResourcePolicyRequest:
type: object
required:
- PolicyName
- PolicyDocument
title: PutResourcePolicyRequest
properties:
PolicyName:
allOf:
- $ref: '#/components/schemas/PolicyName'
- description: The name of the resource policy. Must be unique within a specific Amazon Web Services account.
PolicyDocument:
allOf:
- $ref: '#/components/schemas/PolicyDocument'
- description: 'The resource policy document, which can be up to 5kb in size.'
PolicyRevisionId:
allOf:
- $ref: '#/components/schemas/PolicyRevisionId'
- description: '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.
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.
ResourcePolicy: type: object properties: PolicyName: allOf: - $ref: '#/components/schemas/PolicyName' - description: The name of the resource policy. Must be unique within a specific Amazon Web Services account. PolicyDocument: allOf: - $ref: '#/components/schemas/PolicyDocument' - description: 'The resource policy document, which can be up to 5kb in size.' PolicyRevisionId: allOf: - $ref: '#/components/schemas/PolicyRevisionId' - description: Returns the current policy revision id for this policy name. LastUpdatedTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: 'When the policy was last updated, in Unix time seconds.' description: 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. TelemetryRecordList: type: array items: $ref: '#/components/schemas/TelemetryRecord' PutTelemetryRecordsRequest: type: object required: - TelemetryRecords title: PutTelemetryRecordsRequest properties: TelemetryRecords: allOf: - $ref: '#/components/schemas/TelemetryRecordList' - description: EC2InstanceId: allOf: - $ref: '#/components/schemas/EC2InstanceId' - description: Hostname: allOf: - $ref: '#/components/schemas/Hostname' - description: ResourceARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: TraceSegmentDocumentList: type: array items: $ref: '#/components/schemas/TraceSegmentDocument' PutTraceSegmentsRequest: type: object required: - TraceSegmentDocuments title: PutTraceSegmentsRequest properties: TraceSegmentDocuments: allOf: - $ref: '#/components/schemas/TraceSegmentDocumentList' - description: A string containing a JSON document defining one or more segments or subsegments. UnprocessedTraceSegmentList: type: array items: $ref: '#/components/schemas/UnprocessedTraceSegment' RequestCount: type: integer minimum: 0 ResourceARNDetail: type: object properties: ARN: allOf: - $ref: '#/components/schemas/String' - description: The ARN of a corresponding resource. description: A list of resources ARNs corresponding to the segments in a trace. ResponseTimeRootCauseServices: type: array items: $ref: '#/components/schemas/ResponseTimeRootCauseService' ResponseTimeRootCause: type: object properties: Services: allOf: - $ref: '#/components/schemas/ResponseTimeRootCauseServices' - description: 'A list of corresponding services. A service identifies a segment and contains a name, account ID, type, and inferred flag.' ClientImpacting: allOf: - $ref: '#/components/schemas/NullableBoolean' - description: A flag that denotes that the root cause impacts the trace client. description: The root cause information for a response time warning. ResponseTimeRootCauseEntity: type: object properties: Name: allOf: - $ref: '#/components/schemas/String' - description: The name of the entity. Coverage: allOf: - $ref: '#/components/schemas/NullableDouble' - description: The type and messages of the exceptions. Remote: allOf: - $ref: '#/components/schemas/NullableBoolean' - description: A flag that denotes a remote subsegment. description: A collection of segments and corresponding subsegments associated to a response time warning. ResponseTimeRootCauseEntityPath: type: array items: $ref: '#/components/schemas/ResponseTimeRootCauseEntity' ResponseTimeRootCauseService: type: object properties: Name: allOf: - $ref: '#/components/schemas/String' - description: The service name. Names: allOf: - $ref: '#/components/schemas/ServiceNames' - description: A collection of associated service names. Type: allOf: - $ref: '#/components/schemas/String' - description: The type associated to the service. AccountId: allOf: - $ref: '#/components/schemas/String' - description: The account ID associated to the service. EntityPath: allOf: - $ref: '#/components/schemas/ResponseTimeRootCauseEntityPath' - description: 'The path of root cause entities found on the service. ' Inferred: allOf: - $ref: '#/components/schemas/NullableBoolean' - description: A Boolean value indicating if the service is inferred from the trace. description: A collection of fields identifying the service in a response time warning. ResponseTimeRootCauses: type: array items: $ref: '#/components/schemas/ResponseTimeRootCause' RootCauseException: type: object properties: Name: allOf: - $ref: '#/components/schemas/String' - description: The name of the exception. Message: allOf: - $ref: '#/components/schemas/String' - description: The message of the exception. description: The exception associated with a root cause. SampledCount: type: integer minimum: 0 SamplingRuleUpdate: type: object properties: RuleName: allOf: - $ref: '#/components/schemas/RuleName' - description: 'The name of the sampling rule. Specify a rule by either name or ARN, but not both.' RuleARN: allOf: - $ref: '#/components/schemas/String' - description: 'The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.' ResourceARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: Matches the ARN of the Amazon Web Services resource on which the service runs. Priority: allOf: - $ref: '#/components/schemas/NullableInteger' - description: The priority of the sampling rule. FixedRate: allOf: - $ref: '#/components/schemas/NullableDouble' - description: 'The percentage of matching requests to instrument, after the reservoir is exhausted.' ReservoirSize: allOf: - $ref: '#/components/schemas/NullableInteger' - description: '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.' Host: allOf: - $ref: '#/components/schemas/Host' - description: Matches the hostname from a request URL. ServiceName: allOf: - $ref: '#/components/schemas/ServiceName' - description: Matches thename that the service uses to identify itself in segments.
ServiceType:
allOf:
- $ref: '#/components/schemas/ServiceType'
- description: Matches the origin that the service uses to identify its type in segments.
HTTPMethod:
allOf:
- $ref: '#/components/schemas/HTTPMethod'
- description: Matches the HTTP method of a request.
URLPath:
allOf:
- $ref: '#/components/schemas/URLPath'
- description: Matches the path from a request URL.
Attributes:
allOf:
- $ref: '#/components/schemas/AttributeMap'
- description: Matches attributes derived from the request.
description: A document specifying changes to a sampling rule's configuration.
SamplingStatisticSummary:
type: object
properties:
RuleName:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the sampling rule.
Timestamp:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The start time of the reporting window.
RequestCount:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of requests that matched the rule.
BorrowCount:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of requests recorded with borrowed reservoir quota.
SampledCount:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of requests recorded.
description: Aggregated request sampling data for a sampling rule across all services for a 10-second window.
SamplingTargetDocument:
type: object
properties:
RuleName:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the sampling rule.
FixedRate:
allOf:
- $ref: '#/components/schemas/Double'
- description: 'The percentage of matching requests to instrument, after the reservoir is exhausted.'
ReservoirQuota:
allOf:
- $ref: '#/components/schemas/NullableInteger'
- description: The number of requests per second that X-Ray allocated for this service.
ReservoirQuotaTTL:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: When the reservoir quota expires.
Interval:
allOf:
- $ref: '#/components/schemas/NullableInteger'
- description: The number of seconds for the service to wait before getting sampling targets again.
description: '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.'
SegmentId:
type: string
SegmentDocument:
type: string
minLength: 1
Segment:
type: object
properties:
Id:
allOf:
- $ref: '#/components/schemas/SegmentId'
- description: The segment's ID.
Document:
allOf:
- $ref: '#/components/schemas/SegmentDocument'
- description: The segment document.
description: '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.
' SegmentList: type: array items: $ref: '#/components/schemas/Segment' ServiceStatistics: type: object properties: OkCount: allOf: - $ref: '#/components/schemas/NullableLong' - description: The number of requests that completed with a 2xx Success status code. ErrorStatistics: allOf: - $ref: '#/components/schemas/ErrorStatistics' - description: Information about requests that failed with a 4xx Client Error status code. FaultStatistics: allOf: - $ref: '#/components/schemas/FaultStatistics' - description: Information about requests that failed with a 5xx Server Error status code. TotalCount: allOf: - $ref: '#/components/schemas/NullableLong' - description: The total number of completed requests. TotalResponseTime: allOf: - $ref: '#/components/schemas/NullableDouble' - description: The aggregate response time of completed requests. description: Response statistics for a service. Service: type: object properties: ReferenceId: allOf: - $ref: '#/components/schemas/NullableInteger' - description: Identifier for the service. Unique within the service map. Name: allOf: - $ref: '#/components/schemas/String' - description: The canonical name of the service. Names: allOf: - $ref: '#/components/schemas/ServiceNames' - description: 'A list of names for the service, including the canonical name.' Root: allOf: - $ref: '#/components/schemas/NullableBoolean' - description: Indicates that the service was the first service to process a request. AccountId: allOf: - $ref: '#/components/schemas/String' - description: Identifier of the Amazon Web Services account in which the service runs. Type: allOf: - $ref: '#/components/schemas/String' - description: '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.
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.
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.'
Segments:
allOf:
- $ref: '#/components/schemas/SegmentList'
- description: Segment documents for the segments and subsegments that comprise the trace.
description: A collection of segment documents with matching trace IDs.
TraceAvailabilityZones:
type: array
items:
$ref: '#/components/schemas/AvailabilityZoneDetail'
TraceInstanceIds:
type: array
items:
$ref: '#/components/schemas/InstanceIdDetail'
TraceResourceARNs:
type: array
items:
$ref: '#/components/schemas/ResourceARNDetail'
TraceUsers:
type: array
items:
$ref: '#/components/schemas/TraceUser'
TraceSummary:
type: object
properties:
Id:
allOf:
- $ref: '#/components/schemas/TraceId'
- description: The unique identifier for the request that generated the trace's segments and subsegments.
Duration:
allOf:
- $ref: '#/components/schemas/NullableDouble'
- description: The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.
ResponseTime:
allOf:
- $ref: '#/components/schemas/NullableDouble'
- description: '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.'
HasFault:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: The root segment document has a 500 series error.
HasError:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: The root segment document has a 400 series error.
HasThrottle:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: One or more of the segment documents has a 429 throttling error.
IsPartial:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: One or more of the segment documents is in progress.
Http:
allOf:
- $ref: '#/components/schemas/Http'
- description: Information about the HTTP request served by the trace.
Annotations:
allOf:
- $ref: '#/components/schemas/Annotations'
- description: Annotations from the trace's segment documents.
Users:
allOf:
- $ref: '#/components/schemas/TraceUsers'
- description: Users from the trace's segment documents.
ServiceIds:
allOf:
- $ref: '#/components/schemas/ServiceIds'
- description: Service IDs from the trace's segment documents.
ResourceARNs:
allOf:
- $ref: '#/components/schemas/TraceResourceARNs'
- description: A list of resource ARNs for any resource corresponding to the trace segments.
InstanceIds:
allOf:
- $ref: '#/components/schemas/TraceInstanceIds'
- description: A list of EC2 instance IDs for any instance corresponding to the trace segments.
AvailabilityZones:
allOf:
- $ref: '#/components/schemas/TraceAvailabilityZones'
- description: A list of Availability Zones for any zone corresponding to the trace segments.
EntryPoint:
allOf:
- $ref: '#/components/schemas/ServiceId'
- description: The root of a trace.
FaultRootCauses:
allOf:
- $ref: '#/components/schemas/FaultRootCauses'
- description: A collection of FaultRootCause structures corresponding to the trace segments.
ErrorRootCauses:
allOf:
- $ref: '#/components/schemas/ErrorRootCauses'
- description: A collection of ErrorRootCause structures corresponding to the trace segments.
ResponseTimeRootCauses:
allOf:
- $ref: '#/components/schemas/ResponseTimeRootCauses'
- description: A collection of ResponseTimeRootCause structures corresponding to the trace segments.
Revision:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The revision number of a trace.
MatchedEventTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The matched time stamp of a defined event.
description: Metadata generated from the segment documents in a trace.
TraceUser:
type: object
properties:
UserName:
allOf:
- $ref: '#/components/schemas/String'
- description: The user's name.
ServiceIds:
allOf:
- $ref: '#/components/schemas/ServiceIds'
- description: Services that the user's request hit.
description: Information about a user recorded in segment documents.
UnprocessedStatistics:
type: object
properties:
RuleName:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the sampling rule.
ErrorCode:
allOf:
- $ref: '#/components/schemas/String'
- description: The error code.
Message:
allOf:
- $ref: '#/components/schemas/String'
- description: The error message.
description: 'Sampling statistics from a call to GetSamplingTargets that X-Ray could not process.'
UnprocessedTraceSegment:
type: object
properties:
Id:
allOf:
- $ref: '#/components/schemas/String'
- description: The segment's ID.
ErrorCode:
allOf:
- $ref: '#/components/schemas/String'
- description: The error that caused processing to fail.
Message:
allOf:
- $ref: '#/components/schemas/String'
- description: The error message.
description: Information about a segment that failed processing.
UntagResourceRequest:
type: object
required:
- ResourceARN
- TagKeys
title: UntagResourceRequest
properties:
ResourceARN:
allOf:
- $ref: '#/components/schemas/AmazonResourceName'
- description: The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
TagKeys:
allOf:
- $ref: '#/components/schemas/TagKeyList'
- description: Keys for one or more tags that you want to remove from an X-Ray group or sampling rule.
UpdateGroupRequest:
type: object
title: UpdateGroupRequest
properties:
GroupName:
allOf:
- $ref: '#/components/schemas/GroupName'
- description: The case-sensitive name of the group.
GroupARN:
allOf:
- $ref: '#/components/schemas/GroupARN'
- description: The ARN that was generated upon creation.
FilterExpression:
allOf:
- $ref: '#/components/schemas/FilterExpression'
- description: The updated filter expression defining criteria by which to group traces.
InsightsConfiguration:
allOf:
- $ref: '#/components/schemas/InsightsConfiguration'
- description: 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.