Amazon X-Ray InsightImpactGraph API

openapi: 3.0.0
info:
  version: '2016-04-12'
  x-release: v4
  title: AWS X-Ray CreateGroup InsightImpactGraph API
  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
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)
security:
- hmac: []
tags:
- name: InsightImpactGraph
paths:
  /InsightImpactGraph:
    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'
    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
      tags:
      - InsightImpactGraph
components:
  schemas:
    String:
      type: string
    NullableInteger:
      type: integer
    ServiceNames:
      type: array
      items:
        $ref: '#/components/schemas/String'
    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.
    Token:
      type: string
      minLength: 1
      maxLength: 2000
    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}'
    ThrottledException: {}
    InvalidRequestException: {}
    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: <p>Identifier for the service. Unique within the service map.</p> <ul> <li> <p>Amazon Web Services Resource - The type of an Amazon Web Services resource. For example, AWS::EC2::Instance for an application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used. </p> </li> <li> <p>Amazon Web Services Service - The type of an Amazon Web Services service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't target a specific table. </p> </li> <li> <p>Amazon Web Services Service - The type of an Amazon Web Services service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't target a specific table. </p> </li> <li> <p>remote - A downstream service of indeterminate type.</p> </li> </ul>
        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. '
    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.
    InsightImpactGraphServiceList:
      type: array
      items:
        $ref: '#/components/schemas/InsightImpactGraphService'
    Timestamp:
      type: string
      format: date-time
    InsightImpactGraphEdgeList:
      type: array
      items:
        $ref: '#/components/schemas/InsightImpactGraphEdge'
  parameters:
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      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-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-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      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
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/xray/