Amazon DevOps Guru Insights API

openapi: 3.1.0
info:
  title: Amazon DevOps Guru Insights API
  version: '2020-12-01'
  description: Generated from AWS's published Smithy model for Amazon DevOps Guru. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://devops-guru.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /insights/{Id}:
    delete:
      operationId: DeleteInsight
      summary: Delete Insight
      description: Deletes the insight along with the associated anomalies, events and recommendations.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteInsightResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteInsightRequest'
      tags:
      - Insights
    get:
      operationId: DescribeInsight
      summary: Describe Insight
      description: Returns details about an insight that you specify using its ID.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeInsightResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeInsightRequest'
      tags:
      - Insights
  /insights:
    post:
      operationId: ListInsights
      summary: List Insights
      description: Returns a list of insights in your Amazon Web Services account. You can specify which insights are returned
        by their start time and status (ONGOING, CLOSED, or ANY).
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListInsightsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListInsightsRequest'
      tags:
      - Insights
  /insights/search:
    post:
      operationId: SearchInsights
      summary: Search Insights
      description: Returns a list of insights in your Amazon Web Services account. You can specify which insights are returned
        by their start time, one or more statuses (ONGOING or CLOSED), one or more severities (LOW, MEDIUM, and HIGH), and
        type (REACTIVE or PROACTIVE). Use the Filters parameter to specify status and severity search parameters. Use the
        Type parameter to specify REACTIVE or PROACTIVE in your search.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchInsightsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchInsightsRequest'
      tags:
      - Insights
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: devops-guru
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    CloudFormationCollection:
      type: object
      properties:
        StackNames:
          type: array
          items:
            type: string
          description: An array of CloudFormation stack names.
    ConflictException:
      type: object
      properties:
        Message:
          type: string
        ResourceId:
          type: string
          description: The ID of the Amazon Web Services resource in which a conflict occurred.
        ResourceType:
          type: string
          description: The type of the Amazon Web Services resource in which a conflict occurred.
      required:
      - Message
      - ResourceId
      - ResourceType
    DeleteInsightRequest:
      type: object
      properties:
        Id:
          type: string
          description: The ID of the insight.
      required:
      - Id
    DeleteInsightResponse:
      type: object
      properties: {}
    DescribeInsightRequest:
      type: object
      properties:
        Id:
          type: string
          description: The ID of the insight.
        AccountId:
          type: string
          description: The ID of the member account in the organization.
      required:
      - Id
    DescribeInsightResponse:
      type: object
      properties:
        ProactiveInsight:
          $ref: '#/components/schemas/ProactiveInsight'
        ReactiveInsight:
          $ref: '#/components/schemas/ReactiveInsight'
    EndTimeRange:
      type: object
      properties:
        FromTime:
          type: string
          format: date-time
          description: The earliest end time in the time range.
        ToTime:
          type: string
          format: date-time
          description: The latest end time in the time range.
    InsightTimeRange:
      type: object
      properties:
        StartTime:
          type: string
          format: date-time
          description: The time when the behavior described in an insight started.
        EndTime:
          type: string
          format: date-time
          description: The time when the behavior described in an insight ended.
      required:
      - StartTime
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
        RetryAfterSeconds:
          type: integer
          description: The number of seconds after which the action that caused the internal server exception can be retried.
      required:
      - Message
    ListInsightsAnyStatusFilter:
      type: object
      properties:
        Type:
          type: string
          enum:
          - REACTIVE
          - PROACTIVE
          description: Use to filter for either REACTIVE or PROACTIVE insights.
        StartTimeRange:
          $ref: '#/components/schemas/StartTimeRange'
      required:
      - Type
      - StartTimeRange
    ListInsightsClosedStatusFilter:
      type: object
      properties:
        Type:
          type: string
          enum:
          - REACTIVE
          - PROACTIVE
          description: Use to filter for either REACTIVE or PROACTIVE insights.
        EndTimeRange:
          $ref: '#/components/schemas/EndTimeRange'
      required:
      - Type
      - EndTimeRange
    ListInsightsOngoingStatusFilter:
      type: object
      properties:
        Type:
          type: string
          enum:
          - REACTIVE
          - PROACTIVE
          description: Use to filter for either REACTIVE or PROACTIVE insights.
      required:
      - Type
    ListInsightsRequest:
      type: object
      properties:
        StatusFilter:
          $ref: '#/components/schemas/ListInsightsStatusFilter'
        MaxResults:
          type: integer
          description: The maximum number of results to return with a single call. To retrieve the remaining results, make
            another call with the returned nextToken value.
        NextToken:
          type: string
          description: The pagination token to use to retrieve the next page of results for this operation. If this value
            is null, it retrieves the first page.
      required:
      - StatusFilter
    ListInsightsResponse:
      type: object
      properties:
        ProactiveInsights:
          type: array
          items:
            $ref: '#/components/schemas/ProactiveInsightSummary'
          description: The returned list of proactive insights.
        ReactiveInsights:
          type: array
          items:
            $ref: '#/components/schemas/ReactiveInsightSummary'
          description: The returned list of reactive insights.
        NextToken:
          type: string
          description: The pagination token to use to retrieve the next page of results for this operation. If there are no
            more pages, this value is null.
    ListInsightsStatusFilter:
      type: object
      properties:
        Ongoing:
          $ref: '#/components/schemas/ListInsightsOngoingStatusFilter'
        Closed:
          $ref: '#/components/schemas/ListInsightsClosedStatusFilter'
        Any:
          $ref: '#/components/schemas/ListInsightsAnyStatusFilter'
    PredictionTimeRange:
      type: object
      properties:
        StartTime:
          type: string
          format: date-time
          description: The time range during which a metric limit is expected to be exceeded. This applies to proactive insights
            only.
        EndTime:
          type: string
          format: date-time
          description: The time when the behavior in a proactive insight is expected to end.
      required:
      - StartTime
    ProactiveInsight:
      type: object
      properties:
        Id:
          type: string
          description: The ID of the proactive insight.
        Name:
          type: string
          description: The name of the proactive insight.
        Severity:
          type: string
          enum:
          - LOW
          - MEDIUM
          - HIGH
          description: The severity of the insight. For more information, see Understanding insight severities in the Amazon
            DevOps Guru User Guide.
        Status:
          type: string
          enum:
          - ONGOING
          - CLOSED
          description: The status of the proactive insight.
        InsightTimeRange:
          $ref: '#/components/schemas/InsightTimeRange'
        PredictionTimeRange:
          $ref: '#/components/schemas/PredictionTimeRange'
        ResourceCollection:
          $ref: '#/components/schemas/ResourceCollection'
        SsmOpsItemId:
          type: string
          description: The ID of the Amazon Web Services System Manager OpsItem created for this insight. You must enable
            the creation of OpstItems insights before they are created for each insight.
        Description:
          type: string
          description: Describes the proactive insight.
    ProactiveInsightSummary:
      type: object
      properties:
        Id:
          type: string
          description: The ID of the proactive insight.
        Name:
          type: string
          description: The name of the proactive insight.
        Severity:
          type: string
          enum:
          - LOW
          - MEDIUM
          - HIGH
          description: The severity of the insight. For more information, see Understanding insight severities in the Amazon
            DevOps Guru User Guide.
        Status:
          type: string
          enum:
          - ONGOING
          - CLOSED
          description: The status of the proactive insight.
        InsightTimeRange:
          $ref: '#/components/schemas/InsightTimeRange'
        PredictionTimeRange:
          $ref: '#/components/schemas/PredictionTimeRange'
        ResourceCollection:
          $ref: '#/components/schemas/ResourceCollection'
        ServiceCollection:
          $ref: '#/components/schemas/ServiceCollection'
        AssociatedResourceArns:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of the Amazon Web Services resources that generated this insight.
    ReactiveInsight:
      type: object
      properties:
        Id:
          type: string
          description: The ID of a reactive insight.
        Name:
          type: string
          description: The name of a reactive insight.
        Severity:
          type: string
          enum:
          - LOW
          - MEDIUM
          - HIGH
          description: The severity of the insight. For more information, see Understanding insight severities in the Amazon
            DevOps Guru User Guide.
        Status:
          type: string
          enum:
          - ONGOING
          - CLOSED
          description: The status of a reactive insight.
        InsightTimeRange:
          $ref: '#/components/schemas/InsightTimeRange'
        ResourceCollection:
          $ref: '#/components/schemas/ResourceCollection'
        SsmOpsItemId:
          type: string
          description: The ID of the Amazon Web Services System Manager OpsItem created for this insight. You must enable
            the creation of OpstItems insights before they are created for each insight.
        Description:
          type: string
          description: Describes the reactive insight.
    ReactiveInsightSummary:
      type: object
      properties:
        Id:
          type: string
          description: The ID of a reactive summary.
        Name:
          type: string
          description: The name of a reactive insight.
        Severity:
          type: string
          enum:
          - LOW
          - MEDIUM
          - HIGH
          description: The severity of the insight. For more information, see Understanding insight severities in the Amazon
            DevOps Guru User Guide.
        Status:
          type: string
          enum:
          - ONGOING
          - CLOSED
          description: The status of a reactive insight.
        InsightTimeRange:
          $ref: '#/components/schemas/InsightTimeRange'
        ResourceCollection:
          $ref: '#/components/schemas/ResourceCollection'
        ServiceCollection:
          $ref: '#/components/schemas/ServiceCollection'
        AssociatedResourceArns:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of the Amazon Web Services resources that generated this insight.
    ResourceCollection:
      type: object
      properties:
        CloudFormation:
          $ref: '#/components/schemas/CloudFormationCollection'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/TagCollection'
          description: The Amazon Web Services tags that are used by resources in the resource collection. Tags help you identify
            and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can
            assign the same tag to resources from different services to indicate that the resources are related. For example,
            you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more
            information about using tags, see the Tagging best practices whitepaper. Each Amazon Web Services tag has two
            parts. A tag key (for example, CostCenter, En
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
        ResourceId:
          type: string
          description: The ID of the Amazon Web Services resource that could not be found.
        ResourceType:
          type: string
          description: The type of the Amazon Web Services resource that could not be found.
      required:
      - Message
      - ResourceId
      - ResourceType
    SearchInsightsFilters:
      type: object
      properties:
        Severities:
          type: array
          items:
            type: string
            enum:
            - LOW
            - MEDIUM
            - HIGH
          description: An array of severity values used to search for insights.
        Statuses:
          type: array
          items:
            type: string
            enum:
            - ONGOING
            - CLOSED
          description: An array of status values used to search for insights.
        ResourceCollection:
          $ref: '#/components/schemas/ResourceCollection'
        ServiceCollection:
          $ref: '#/components/schemas/ServiceCollection'
    SearchInsightsRequest:
      type: object
      properties:
        StartTimeRange:
          $ref: '#/components/schemas/StartTimeRange'
        Filters:
          $ref: '#/components/schemas/SearchInsightsFilters'
        MaxResults:
          type: integer
          description: The maximum number of results to return with a single call. To retrieve the remaining results, make
            another call with the returned nextToken value.
        NextToken:
          type: string
          description: The pagination token to use to retrieve the next page of results for this operation. If this value
            is null, it retrieves the first page.
        Type:
          type: string
          enum:
          - REACTIVE
          - PROACTIVE
          description: The type of insights you are searching for (REACTIVE or PROACTIVE).
      required:
      - StartTimeRange
      - Type
    SearchInsightsResponse:
      type: object
      properties:
        ProactiveInsights:
          type: array
          items:
            $ref: '#/components/schemas/ProactiveInsightSummary'
          description: The returned proactive insights.
        ReactiveInsights:
          type: array
          items:
            $ref: '#/components/schemas/ReactiveInsightSummary'
          description: The returned reactive insights.
        NextToken:
          type: string
          description: The pagination token to use to retrieve the next page of results for this operation. If there are no
            more pages, this value is null.
    ServiceCollection:
      type: object
      properties:
        ServiceNames:
          type: array
          items:
            type: string
            enum:
            - API_GATEWAY
            - APPLICATION_ELB
            - AUTO_SCALING_GROUP
            - CLOUD_FRONT
            - DYNAMO_DB
            - EC2
            - ECS
            - EKS
            - ELASTIC_BEANSTALK
            - ELASTI_CACHE
            - ELB
            - ES
            - KINESIS
            - LAMBDA
            - NAT_GATEWAY
            - NETWORK_ELB
            - RDS
            - REDSHIFT
            - ROUTE_53
            - S3
            - SAGE_MAKER
            - SNS
            - SQS
            - STEP_FUNCTIONS
            - SWF
          description: An array of strings that each specifies the name of an Amazon Web Services service.
    StartTimeRange:
      type: object
      properties:
        FromTime:
          type: string
          format: date-time
          description: The start time of the time range.
        ToTime:
          type: string
          format: date-time
          description: The end time of the time range.
    TagCollection:
      type: object
      properties:
        AppBoundaryKey:
          type: string
          description: 'An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps
            Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your
            DevOps Guru application and analysis boundary. The string used for a key in a tag that you use to define your
            resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application
            or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose.
            After you create a key, it is case-sensitive. '
        TagValues:
          type: array
          items:
            type: string
          description: The values in an Amazon Web Services tag collection. The tag's value is an optional field used to associate
            a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag's
            key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.
            You can specify a maximum of 256 characters for a tag value.
      required:
      - AppBoundaryKey
      - TagValues
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
        QuotaCode:
          type: string
          description: The code of the quota that was exceeded, causing the throttling exception.
        ServiceCode:
          type: string
          description: The code of the service that caused the throttling exception.
        RetryAfterSeconds:
          type: integer
          description: The number of seconds after which the action that caused the throttling exception can be retried.
      required:
      - Message
    ValidationException:
      type: object
      properties:
        Message:
          type: string
          description: A message that describes the validation exception.
        Reason:
          type: string
          enum:
          - UNKNOWN_OPERATION
          - CANNOT_PARSE
          - FIELD_VALIDATION_FAILED
          - OTHER
          - INVALID_PARAMETER_COMBINATION
          - PARAMETER_INCONSISTENT_WITH_SERVICE_STATE
          description: The reason the validation exception was thrown.
        Fields:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
      required:
      - Message
    ValidationExceptionField:
      type: object
      properties:
        Name:
          type: string
          description: The name of the field.
        Message:
          type: string
          description: The message associated with the validation exception with information to help determine its cause.
      required:
      - Name
      - Message
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/devops-guru/service/2020-12-01/devops-guru-2020-12-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)