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:

' type: array items: $ref: '#/components/schemas/Tag' minItems: 0 maxItems: 200 summary: Amazon X-Ray Create 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' /CreateSamplingRule: post: operationId: CreateSamplingRule description: 'Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with GetSamplingRules, and evaluate each rule in ascending order of priority for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with GetSamplingTargets to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateSamplingRuleResult' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: ThrottledException content: application/json: schema: $ref: '#/components/schemas/ThrottledException' '482': description: RuleLimitExceededException content: application/json: schema: $ref: '#/components/schemas/RuleLimitExceededException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - SamplingRule properties: SamplingRule: 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.' 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/Priority' - description: The priority of the sampling rule. FixedRate: allOf: - $ref: '#/components/schemas/FixedRate' - description: 'The percentage of matching requests to instrument, after the reservoir is exhausted.' ReservoirSize: allOf: - $ref: '#/components/schemas/ReservoirSize' - 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.' 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. 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:

' type: array items: $ref: '#/components/schemas/Tag' minItems: 0 maxItems: 200 summary: Amazon X-Ray Create 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' /DeleteGroup: post: operationId: DeleteGroup description: Deletes a group resource. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteGroupResult' '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 Delete 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' /DeleteResourcePolicy: post: operationId: DeleteResourcePolicy description: Deletes a resource policy from the target Amazon Web Services account. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteResourcePolicyResult' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: InvalidPolicyRevisionIdException content: application/json: schema: $ref: '#/components/schemas/InvalidPolicyRevisionIdException' '482': description: ThrottledException content: application/json: schema: $ref: '#/components/schemas/ThrottledException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - PolicyName properties: PolicyName: description: The name of the resource policy to delete. type: string pattern: '[\w+=,.@-]+' minLength: 1 maxLength: 128 PolicyRevisionId: description: 'Specifies a specific policy revision to delete. Provide a PolicyRevisionId to ensure an atomic delete operation. If the provided revision id does not match the latest policy revision id, an InvalidPolicyRevisionIdException exception is returned. ' 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 to true 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:

Omit this key if you set Type to NONE.

' type: string minLength: 1 maxLength: 3000 Type: description: The type of encryption. Set to 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.

' type: string BypassPolicyLockoutCheck: description:

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

A trace_id consists of three numbers separated by hyphens. For example, 1-58406520-a006649127e371903a2de979. This includes:

Trace ID Format

' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PutTraceSegmentsResult' '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: - TraceSegmentDocuments properties: TraceSegmentDocuments: description: A string containing a JSON document defining one or more segments or subsegments. type: array items: $ref: '#/components/schemas/TraceSegmentDocument' summary: Amazon X-Ray Put Trace Segments 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' /TagResource: post: operationId: TagResource description: Applies tags to an existing Amazon Web Services X-Ray group or sampling rule. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TagResourceResponse' '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' '483': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - ResourceARN - Tags properties: ResourceARN: description: The Amazon Resource Number (ARN) of an X-Ray group or sampling rule. type: string minLength: 1 maxLength: 1011 Tags: description: '

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:

' type: array items: $ref: '#/components/schemas/Tag' minItems: 0 maxItems: 200 summary: Amazon X-Ray Tag 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' /UntagResource: post: operationId: UntagResource description: 'Removes tags from an Amazon Web Services X-Ray group or sampling rule. You cannot edit or delete system tags (those with an aws: prefix).' 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:

' CreateSamplingRuleResult: type: object properties: SamplingRuleRecord: allOf: - $ref: '#/components/schemas/SamplingRuleRecord' - description: The saved rule definition and metadata. RuleName: type: string minLength: 1 maxLength: 32 String: type: string ResourceARN: type: string maxLength: 500 Priority: type: integer minimum: 1 maximum: 9999 FixedRate: type: number format: double minimum: 0 maximum: 1 ReservoirSize: type: integer minimum: 0 ServiceName: type: string maxLength: 64 ServiceType: type: string maxLength: 64 Host: type: string maxLength: 64 HTTPMethod: type: string maxLength: 10 URLPath: type: string maxLength: 128 Version: type: integer minimum: 1 AttributeMap: type: object maxProperties: 5 additionalProperties: $ref: '#/components/schemas/AttributeValue' RuleLimitExceededException: {} DeleteGroupResult: type: object properties: {} DeleteResourcePolicyResult: type: object properties: {} InvalidPolicyRevisionIdException: {} DeleteSamplingRuleResult: type: object properties: SamplingRuleRecord: allOf: - $ref: '#/components/schemas/SamplingRuleRecord' - description: The deleted rule definition and metadata. GetEncryptionConfigResult: type: object properties: EncryptionConfig: allOf: - $ref: '#/components/schemas/EncryptionConfig' - description: The encryption configuration document. GetGroupResult: type: object properties: Group: allOf: - $ref: '#/components/schemas/Group' - description: 'The group that was requested. Contains the name of the group, the ARN of the group, the filter expression, and the insight configuration assigned to the group.' GetGroupsResult: type: object properties: Groups: allOf: - $ref: '#/components/schemas/GroupSummaryList' - description: The collection of all active groups. NextToken: allOf: - $ref: '#/components/schemas/String' - description: Pagination token. GetInsightResult: type: object properties: Insight: allOf: - $ref: '#/components/schemas/Insight' - description: The summary information of an insight. GetInsightEventsResult: type: object properties: InsightEvents: allOf: - $ref: '#/components/schemas/InsightEventList' - description: 'A detailed description of the event. This includes the time of the event, client and root cause impact statistics, and the top anomalous service at the time of the event.' NextToken: allOf: - $ref: '#/components/schemas/Token' - description: Use this token to retrieve the next page of insight events. GetInsightImpactGraphResult: type: object properties: InsightId: allOf: - $ref: '#/components/schemas/InsightId' - description: The insight's unique identifier. StartTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The provided start time. EndTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: 'The provided end time. ' ServiceGraphStartTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: 'The time, in Unix seconds, at which the service graph started.' ServiceGraphEndTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: 'The time, in Unix seconds, at which the service graph ended.' Services: allOf: - $ref: '#/components/schemas/InsightImpactGraphServiceList' - description: The Amazon Web Services instrumented services related to the insight. NextToken: allOf: - $ref: '#/components/schemas/Token' - description: Pagination token. GetInsightSummariesResult: type: object properties: InsightSummaries: allOf: - $ref: '#/components/schemas/InsightSummaryList' - description: 'The summary of each insight within the group matching the provided filters. The summary contains the InsightID, start and end time, the root cause service, the root cause and client impact statistics, the top anomalous services, and the status of the insight.' NextToken: allOf: - $ref: '#/components/schemas/Token' - description: Pagination token. InsightState: type: string enum: - ACTIVE - CLOSED GetSamplingRulesResult: type: object properties: SamplingRuleRecords: allOf: - $ref: '#/components/schemas/SamplingRuleRecordList' - description: Rule definitions and metadata. NextToken: allOf: - $ref: '#/components/schemas/String' - description: Pagination token. GetSamplingStatisticSummariesResult: type: object properties: SamplingStatisticSummaries: allOf: - $ref: '#/components/schemas/SamplingStatisticSummaryList' - description: Information about the number of requests instrumented for each sampling rule. NextToken: allOf: - $ref: '#/components/schemas/String' - description: Pagination token. GetSamplingTargetsResult: type: object properties: SamplingTargetDocuments: allOf: - $ref: '#/components/schemas/SamplingTargetDocumentList' - description: Updated rules that the service should use to sample requests. LastRuleModification: allOf: - $ref: '#/components/schemas/Timestamp' - description: 'The last time a user changed the sampling rule configuration. If the sampling rule configuration changed since the service last retrieved it, the service should call GetSamplingRules to get the latest version.' UnprocessedStatistics: allOf: - $ref: '#/components/schemas/UnprocessedStatisticsList' - description: 'Information about SamplingStatisticsDocument that X-Ray could not process.' SamplingStatisticsDocument: type: object required: - RuleName - ClientID - Timestamp - RequestCount - SampledCount properties: RuleName: allOf: - $ref: '#/components/schemas/RuleName' - description: The name of the sampling rule. ClientID: allOf: - $ref: '#/components/schemas/ClientID' - description: A unique identifier for the service in hexadecimal. Timestamp: allOf: - $ref: '#/components/schemas/Timestamp' - description: The current time. RequestCount: allOf: - $ref: '#/components/schemas/RequestCount' - description: The number of requests that matched the rule. SampledCount: allOf: - $ref: '#/components/schemas/SampledCount' - description: The number of requests recorded. BorrowCount: allOf: - $ref: '#/components/schemas/BorrowCount' - description: The number of requests recorded with borrowed reservoir quota. description: 'Request sampling results for a single rule from a service. Results are for the last 10 seconds unless the service has been assigned a longer reporting interval after a previous call to GetSamplingTargets.' GetServiceGraphResult: type: object properties: StartTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The start of the time frame for which the graph was generated. EndTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The end of the time frame for which the graph was generated. Services: allOf: - $ref: '#/components/schemas/ServiceList' - description: The services that have processed a traced request during the specified time frame. ContainsOldGroupVersions: allOf: - $ref: '#/components/schemas/Boolean' - description: 'A flag indicating whether the group''s filter expression has been consistent, or if the returned service graph may show traces from an older version of the group''s filter expression.' NextToken: allOf: - $ref: '#/components/schemas/String' - description: Pagination token. GetTimeSeriesServiceStatisticsResult: type: object properties: TimeSeriesServiceStatistics: allOf: - $ref: '#/components/schemas/TimeSeriesServiceStatisticsList' - description: The collection of statistics. ContainsOldGroupVersions: allOf: - $ref: '#/components/schemas/Boolean' - description: 'A flag indicating whether or not a group''s filter expression has been consistent, or if a returned aggregation might show statistics from an older version of the group''s filter expression.' NextToken: allOf: - $ref: '#/components/schemas/String' - description: Pagination token. GetTraceGraphResult: type: object properties: Services: allOf: - $ref: '#/components/schemas/ServiceList' - description: The services that have processed one of the specified requests. NextToken: allOf: - $ref: '#/components/schemas/String' - description: Pagination token. GetTraceSummariesResult: type: object properties: TraceSummaries: allOf: - $ref: '#/components/schemas/TraceSummaryList' - description: Trace IDs and annotations for traces that were found in the specified time frame. ApproximateTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The start time of this page of results. TracesProcessedCount: allOf: - $ref: '#/components/schemas/NullableLong' - description: 'The total number of traces processed, including traces that did not match the specified filter expression.' NextToken: allOf: - $ref: '#/components/schemas/String' - description: 'If the requested time frame contained more than one page of results, you can use this token to retrieve the next page. The first page contains the most recent results, closest to the end of the time frame.' SamplingStrategyName: type: string enum: - PartialScan - FixedRate NullableDouble: type: number format: double ListResourcePoliciesResult: type: object properties: ResourcePolicies: allOf: - $ref: '#/components/schemas/ResourcePolicyList' - description: The list of resource policies in the target Amazon Web Services account. NextToken: allOf: - $ref: '#/components/schemas/ResourcePolicyNextToken' - description: Pagination token. Not currently supported. ListTagsForResourceResponse: type: object properties: Tags: allOf: - $ref: '#/components/schemas/TagList' - description: 'A list of tags, as key and value pairs, that is associated with the specified X-Ray group or sampling rule.' NextToken: allOf: - $ref: '#/components/schemas/String' - description: 'A pagination token. If multiple pages of results are returned, use the NextToken value returned with the current page of results to get the next page of results.' 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.

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 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:

' Group: 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 Amazon Resource Name (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.

description: Details and metadata for a group. SamplingRule: type: object required: - ResourceARN - Priority - FixedRate - ReservoirSize - ServiceName - ServiceType - Host - HTTPMethod - URLPath - Version 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/Priority' - description: The priority of the sampling rule. FixedRate: allOf: - $ref: '#/components/schemas/FixedRate' - description: 'The percentage of matching requests to instrument, after the reservoir is exhausted.' ReservoirSize: allOf: - $ref: '#/components/schemas/ReservoirSize' - 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.' 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. 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:

' SamplingRuleRecord: type: object properties: SamplingRule: allOf: - $ref: '#/components/schemas/SamplingRule' - description: The sampling rule. CreatedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: When the rule was created. ModifiedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: When the rule was last modified. description: 'A SamplingRule and its metadata.' GroupARN: type: string minLength: 1 maxLength: 400 DeleteGroupRequest: type: object title: DeleteGroupRequest 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. PolicyName: type: string pattern: '[\w+=,.@-]+' minLength: 1 maxLength: 128 PolicyRevisionId: type: string DeleteResourcePolicyRequest: type: object required: - PolicyName title: DeleteResourcePolicyRequest properties: PolicyName: allOf: - $ref: '#/components/schemas/PolicyName' - description: The name of the resource policy to delete. PolicyRevisionId: allOf: - $ref: '#/components/schemas/PolicyRevisionId' - description: 'Specifies a specific policy revision to delete. Provide a PolicyRevisionId to ensure an atomic delete operation. If the provided revision id does not match the latest policy revision id, an InvalidPolicyRevisionIdException exception is returned. ' 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.

description: Details for a group without metadata. HistogramEntry: type: object properties: Value: allOf: - $ref: '#/components/schemas/Double' - description: The value of the entry. Count: allOf: - $ref: '#/components/schemas/Integer' - description: The prevalence of the entry. description: 'An entry in a histogram for a statistic. A histogram maps the range of observed values on the X axis, and the prevalence of each value on the Y axis.' Integer: type: integer Hostname: type: string maxLength: 255 Http: type: object properties: HttpURL: allOf: - $ref: '#/components/schemas/String' - description: The request URL. HttpStatus: allOf: - $ref: '#/components/schemas/NullableInteger' - description: The response status. HttpMethod: allOf: - $ref: '#/components/schemas/String' - description: The request method. UserAgent: allOf: - $ref: '#/components/schemas/String' - description: The request's user agent string. ClientIp: allOf: - $ref: '#/components/schemas/String' - description: The IP address of the requestor. description: Information about an HTTP request. InsightCategoryList: type: array items: $ref: '#/components/schemas/InsightCategory' InsightSummaryText: type: string RequestImpactStatistics: type: object properties: FaultCount: allOf: - $ref: '#/components/schemas/NullableLong' - description: 'The number of requests that have resulted in a fault,' OkCount: allOf: - $ref: '#/components/schemas/NullableLong' - description: The number of successful requests. TotalCount: allOf: - $ref: '#/components/schemas/NullableLong' - description: The total number of requests to the service. description: Statistics that describe how the incident has impacted a service. InsightCategory: type: string enum: - FAULT InsightEvent: type: object properties: Summary: allOf: - $ref: '#/components/schemas/EventSummaryText' - description: A brief description of the event. EventTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: 'The time, in Unix seconds, at which the event was recorded.' 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 during the event that is most impacted by the incident. description: 'X-Ray reevaluates insights periodically until they are resolved, and records each intermediate state in an event. You can review incident events in the Impact Timeline on the Inspect page in the X-Ray console.' InsightImpactGraphEdge: type: object properties: ReferenceId: allOf: - $ref: '#/components/schemas/NullableInteger' - description: Identifier of the edge. Unique within a service map. description: The connection between two service in an insight impact graph. InsightImpactGraphEdgeList: type: array items: $ref: '#/components/schemas/InsightImpactGraphEdge' InsightImpactGraphService: type: object properties: ReferenceId: allOf: - $ref: '#/components/schemas/NullableInteger' - description: Identifier for the service. Unique within the service map. Type: allOf: - $ref: '#/components/schemas/String' - 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.' AccountId: allOf: - $ref: '#/components/schemas/String' - description: Identifier of the Amazon Web Services account in which the service runs. Edges: allOf: - $ref: '#/components/schemas/InsightImpactGraphEdgeList' - description: Connections to downstream services. description: 'Information about an application that processed requests, users that made requests, or downstream services, resources, and applications that an application used. ' InsightSummary: 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: ' Categories 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. LastUpdateTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: 'The time, in Unix seconds, that the insight was last updated.' description: Information that describes an insight. InstanceIdDetail: type: object properties: Id: allOf: - $ref: '#/components/schemas/String' - description: The ID of a corresponding EC2 instance. description: 'A list of EC2 instance IDs corresponding to the segments in a trace. ' ResourcePolicyNextToken: type: string minLength: 1 maxLength: 100 ListResourcePoliciesRequest: type: object title: ListResourcePoliciesRequest properties: NextToken: allOf: - $ref: '#/components/schemas/ResourcePolicyNextToken' - description: Not currently supported. ResourcePolicyList: type: array items: $ref: '#/components/schemas/ResourcePolicy' ListTagsForResourceRequest: type: object required: - ResourceARN title: ListTagsForResourceRequest properties: ResourceARN: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: The Amazon Resource Number (ARN) of an X-Ray group or sampling rule. NextToken: allOf: - $ref: '#/components/schemas/String' - 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.' 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:

Omit this key if you set Type to NONE.

' Type: allOf: - $ref: '#/components/schemas/EncryptionType' - description: The type of encryption. Set to 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.

' BypassPolicyLockoutCheck: allOf: - $ref: '#/components/schemas/Boolean' - description:

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

' State: allOf: - $ref: '#/components/schemas/String' - description: The service's state. StartTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The start time of the first segment that the service generated. EndTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The end time of the last segment that the service generated. Edges: allOf: - $ref: '#/components/schemas/EdgeList' - description: Connections to downstream services. SummaryStatistics: allOf: - $ref: '#/components/schemas/ServiceStatistics' - description: Aggregated statistics for the service. DurationHistogram: allOf: - $ref: '#/components/schemas/Histogram' - description: A histogram that maps the spread of service durations. ResponseTimeHistogram: allOf: - $ref: '#/components/schemas/Histogram' - description: A histogram that maps the spread of service response times. description: 'Information about an application that processed requests, users that made requests, or downstream services, resources, and applications that an application used.' ServiceIds: type: array items: $ref: '#/components/schemas/ServiceId' TagValue: type: string minLength: 0 maxLength: 256 TagKeyList: type: array items: $ref: '#/components/schemas/TagKey' minItems: 0 maxItems: 200 TagResourceRequest: type: object required: - ResourceARN - Tags title: TagResourceRequest properties: ResourceARN: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: The Amazon Resource Number (ARN) of an X-Ray group or sampling rule. 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 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:

' TimeSeriesServiceStatistics: type: object properties: Timestamp: allOf: - $ref: '#/components/schemas/Timestamp' - description: Timestamp of the window for which statistics are aggregated. EdgeSummaryStatistics: $ref: '#/components/schemas/EdgeStatistics' ServiceSummaryStatistics: $ref: '#/components/schemas/ServiceStatistics' ServiceForecastStatistics: allOf: - $ref: '#/components/schemas/ForecastStatistics' - description: The forecasted high and low fault count values. ResponseTimeHistogram: allOf: - $ref: '#/components/schemas/Histogram' - description: The response time histogram for the selected entities. description: A list of TimeSeriesStatistic structures. Trace: 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. LimitExceeded: allOf: - $ref: '#/components/schemas/NullableBoolean' - description: 'LimitExceeded is set to true when the trace has exceeded the Trace document size limit. For more information about this limit and other X-Ray limits and quotas, see Amazon Web Services X-Ray endpoints and quotas.' 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.

UpdateSamplingRuleRequest: type: object required: - SamplingRuleUpdate title: UpdateSamplingRuleRequest properties: SamplingRuleUpdate: allOf: - $ref: '#/components/schemas/SamplingRuleUpdate' - description: The rule and fields to change. ValueWithServiceIds: type: object properties: AnnotationValue: allOf: - $ref: '#/components/schemas/AnnotationValue' - description: Values of the annotation. ServiceIds: allOf: - $ref: '#/components/schemas/ServiceIds' - description: Services to which the annotation applies. description: Information about a segment annotation. security: - hmac: []