openapi: 3.0.0
info:
  version: 2020-12-01
  x-release: v4
  title: Amazon DevOps Guru Accounts Insights API
  description: <p> Amazon DevOps Guru is a fully managed service that helps you identify anomalous behavior in business critical operational applications. You specify the Amazon Web Services resources that you want DevOps Guru to cover, then the Amazon CloudWatch metrics and Amazon Web Services CloudTrail events related to those resources are analyzed. When anomalous behavior is detected, DevOps Guru creates an <i>insight</i> that includes recommendations, related events, and related metrics that can help you improve your operational applications. For more information, see <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/welcome.html">What is Amazon DevOps Guru</a>. </p> <p> You can specify 1 or 2 Amazon Simple Notification Service topics so you are notified every time a new insight is created. You can also enable DevOps Guru to generate an OpsItem in Amazon Web Services Systems Manager for each insight to help you manage and track your work addressing insights. </p> <p> To learn about the DevOps Guru workflow, see <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/welcome.html#how-it-works">How DevOps Guru works</a>. To learn about DevOps Guru concepts, see <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/concepts.html">Concepts in DevOps Guru</a>. </p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    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: devops-guru
  x-aws-signingName: devops-guru
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/devops-guru-2020-12-01.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://devops-guru.{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 Amazon DevOps Guru multi-region endpoint
- url: https://devops-guru.{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 Amazon DevOps Guru multi-region endpoint
- url: http://devops-guru.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon DevOps Guru endpoint for China (Beijing) and China (Ningxia)
- url: https://devops-guru.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon DevOps Guru endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Insights
paths:
  /insights/{Id}:
    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'
    delete:
      operationId: DeleteInsight
      description: Deletes the insight along with the associated anomalies, events and recommendations.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteInsightResponse'
        '480':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '481':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '482':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '483':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '484':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '485':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: Id
        in: path
        required: true
        description: The ID of the insight.
        schema:
          type: string
          pattern: ^[\w-]*$
          minLength: 1
          maxLength: 100
      tags:
      - Insights
    get:
      operationId: DescribeInsight
      description: ' Returns details about an insight that you specify using its ID. '
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeInsightResponse'
        '480':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '481':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '482':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '483':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '484':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: Id
        in: path
        required: true
        description: ' The ID of the insight. '
        schema:
          type: string
          pattern: ^[\w-]*$
          minLength: 1
          maxLength: 100
      - name: AccountId
        in: query
        required: false
        description: The ID of the member account in the organization.
        schema:
          type: string
          pattern: ^\d{12}$
          minLength: 12
          maxLength: 12
      tags:
      - Insights
  /insights:
    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: ListInsights
      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 (<code>ONGOING</code>, <code>CLOSED</code>, or <code>ANY</code>). '
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListInsightsResponse'
        '480':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '481':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '482':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '483':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      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:
              - StatusFilter
              properties:
                StatusFilter:
                  description: ' A filter used by <code>ListInsights</code> to specify which insights to return. '
                  type: object
                  properties:
                    Ongoing:
                      allOf:
                      - $ref: '#/components/schemas/ListInsightsOngoingStatusFilter'
                      - description: ' A <code>ListInsightsAnyStatusFilter</code> that specifies ongoing insights that are either <code>REACTIVE</code> or <code>PROACTIVE</code>. '
                    Closed:
                      allOf:
                      - $ref: '#/components/schemas/ListInsightsClosedStatusFilter'
                      - description: ' A <code>ListInsightsClosedStatusFilter</code> that specifies closed insights that are either <code>REACTIVE</code> or <code>PROACTIVE</code>. '
                    Any:
                      allOf:
                      - $ref: '#/components/schemas/ListInsightsAnyStatusFilter'
                      - description: ' A <code>ListInsightsAnyStatusFilter</code> that specifies insights of any status that are either <code>REACTIVE</code> or <code>PROACTIVE</code>. '
                MaxResults:
                  description: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.
                  type: integer
                  minimum: 1
                  maximum: 100
                NextToken:
                  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: string
                  pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
                  minLength: 36
                  maxLength: 36
      tags:
      - Insights
  /insights/search:
    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: SearchInsights
      description: <p> 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 (<code>ONGOING</code> or <code>CLOSED</code>), one or more severities (<code>LOW</code>, <code>MEDIUM</code>, and <code>HIGH</code>), and type (<code>REACTIVE</code> or <code>PROACTIVE</code>). </p> <p> Use the <code>Filters</code> parameter to specify status and severity search parameters. Use the <code>Type</code> parameter to specify <code>REACTIVE</code> or <code>PROACTIVE</code> in your search. </p>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchInsightsResponse'
        '480':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '481':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '482':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '483':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      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:
              - StartTimeRange
              - Type
              properties:
                StartTimeRange:
                  description: ' A time range used to specify when the behavior of an insight or anomaly started. '
                  type: object
                  properties:
                    FromTime:
                      allOf:
                      - $ref: '#/components/schemas/Timestamp'
                      - description: ' The start time of the time range. '
                    ToTime:
                      allOf:
                      - $ref: '#/components/schemas/Timestamp'
                      - description: ' The end time of the time range. '
                Filters:
                  description: Specifies values used to filter responses when searching for insights. You can use a <code>ResourceCollection</code>, <code>ServiceCollection</code>, array of severities, and an array of status values. Each filter type contains one or more values to search for. If you specify multiple filter types, the filter types are joined with an <code>AND</code>, and the request returns only results that match all of the specified filters.
                  type: object
                  properties:
                    Severities:
                      allOf:
                      - $ref: '#/components/schemas/InsightSeverities'
                      - description: ' An array of severity values used to search for insights. '
                    Statuses:
                      allOf:
                      - $ref: '#/components/schemas/InsightStatuses'
                      - description: ' An array of status values used to search for insights. '
                    ResourceCollection:
                      $ref: '#/components/schemas/ResourceCollection'
                    ServiceCollection:
                      allOf:
                      - $ref: '#/components/schemas/ServiceCollection'
                      - description: A collection of the names of Amazon Web Services services.
                MaxResults:
                  description: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.
                  type: integer
                  minimum: 1
                  maximum: 100
                NextToken:
                  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: string
                  pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
                  minLength: 36
                  maxLength: 36
                Type:
                  description: ' The type of insights you are searching for (<code>REACTIVE</code> or <code>PROACTIVE</code>). '
                  type: string
                  enum:
                  - REACTIVE
                  - PROACTIVE
      tags:
      - Insights
components:
  schemas:
    InternalServerException: {}
    ListInsightsResponse:
      type: object
      properties:
        ProactiveInsights:
          allOf:
          - $ref: '#/components/schemas/ProactiveInsights'
          - description: ' The returned list of proactive insights. '
        ReactiveInsights:
          allOf:
          - $ref: '#/components/schemas/ReactiveInsights'
          - description: ' The returned list of reactive insights. '
        NextToken:
          allOf:
          - $ref: '#/components/schemas/UuidNextToken'
          - 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.
    PredictionTimeRange:
      type: object
      required:
      - StartTime
      properties:
        StartTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: ' The time range during which a metric limit is expected to be exceeded. This applies to proactive insights only. '
        EndTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: ' The time when the behavior in a proactive insight is expected to end. '
      description: ' The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur. '
    StartTimeRange:
      type: object
      properties:
        FromTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: ' The start time of the time range. '
        ToTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: ' The end time of the time range. '
      description: ' A time range used to specify when the behavior of an insight or anomaly started. '
    InsightName:
      type: string
      pattern: ^[\s\S]*$
      minLength: 1
      maxLength: 530
    InsightStatus:
      type: string
      enum:
      - ONGOING
      - CLOSED
    SsmOpsItemId:
      type: string
      pattern: ^.*$
      minLength: 1
      maxLength: 100
    ProactiveInsightSummary:
      type: object
      properties:
        Id:
          allOf:
          - $ref: '#/components/schemas/InsightId'
          - description: 'The ID of the proactive insight. '
        Name:
          allOf:
          - $ref: '#/components/schemas/InsightName'
          - description: 'The name of the proactive insight. '
        Severity:
          allOf:
          - $ref: '#/components/schemas/InsightSeverity'
          - description: The severity of the insight. For more information, see <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities">Understanding insight severities</a> in the <i>Amazon DevOps Guru User Guide</i>.
        Status:
          allOf:
          - $ref: '#/components/schemas/InsightStatus'
          - description: 'The status of the proactive insight. '
        InsightTimeRange:
          $ref: '#/components/schemas/InsightTimeRange'
        PredictionTimeRange:
          $ref: '#/components/schemas/PredictionTimeRange'
        ResourceCollection:
          $ref: '#/components/schemas/ResourceCollection'
        ServiceCollection:
          allOf:
          - $ref: '#/components/schemas/ServiceCollection'
          - description: A collection of the names of Amazon Web Services services.
        AssociatedResourceArns:
          allOf:
          - $ref: '#/components/schemas/AssociatedResourceArns'
          - description: The Amazon Resource Names (ARNs) of the Amazon Web Services resources that generated this insight.
      description: 'Details about a proactive insight. This object is returned by <code>DescribeInsight.</code> '
    SearchInsightsResponse:
      type: object
      properties:
        ProactiveInsights:
          allOf:
          - $ref: '#/components/schemas/ProactiveInsights'
          - description: ' The returned proactive insights. '
        ReactiveInsights:
          allOf:
          - $ref: '#/components/schemas/ReactiveInsights'
          - description: ' The returned reactive insights. '
        NextToken:
          allOf:
          - $ref: '#/components/schemas/UuidNextToken'
          - 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.
    ListInsightsClosedStatusFilter:
      type: object
      required:
      - Type
      - EndTimeRange
      properties:
        Type:
          allOf:
          - $ref: '#/components/schemas/InsightType'
          - description: ' Use to filter for either <code>REACTIVE</code> or <code>PROACTIVE</code> insights. '
        EndTimeRange:
          allOf:
          - $ref: '#/components/schemas/EndTimeRange'
          - description: ' A time range used to specify when the behavior of the filtered insights ended. '
      description: ' Used to filter for insights that have the status <code>CLOSED</code>. '
    InsightTimeRange:
      type: object
      required:
      - StartTime
      properties:
        StartTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: ' The time when the behavior described in an insight started. '
        EndTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: ' The time when the behavior described in an insight ended. '
      description: ' A time ranged that specifies when the observed behavior in an insight started and ended. '
    ServiceNames:
      type: array
      items:
        $ref: '#/components/schemas/ServiceName'
    StackNames:
      type: array
      items:
        $ref: '#/components/schemas/StackName'
    ValidationException: {}
    InsightStatuses:
      type: array
      items:
        $ref: '#/components/schemas/InsightStatus'
      minItems: 0
      maxItems: 2
    ReactiveInsightSummary:
      type: object
      properties:
        Id:
          allOf:
          - $ref: '#/components/schemas/InsightId'
          - description: ' The ID of a reactive summary. '
        Name:
          allOf:
          - $ref: '#/components/schemas/InsightName'
          - description: ' The name of a reactive insight. '
        Severity:
          allOf:
          - $ref: '#/components/schemas/InsightSeverity'
          - description: The severity of the insight. For more information, see <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities">Understanding insight severities</a> in the <i>Amazon DevOps Guru User Guide</i>.
        Status:
          allOf:
          - $ref: '#/components/schemas/InsightStatus'
          - description: ' The status of a reactive insight. '
        InsightTimeRange:
          $ref: '#/components/schemas/InsightTimeRange'
        ResourceCollection:
          $ref: '#/components/schemas/ResourceCollection'
        ServiceCollection:
          allOf:
          - $ref: '#/components/schemas/ServiceCollection'
          - description: A collection of the names of Amazon Web Services services.
        AssociatedResourceArns:
          allOf:
          - $ref: '#/components/schemas/AssociatedResourceArns'
          - description: The Amazon Resource Names (ARNs) of the Amazon Web Services resources that generated this insight.
      description: ' Information about a reactive insight. This object is returned by <code>DescribeInsight.</code> '
    InsightSeverities:
      type: array
      items:
        $ref: '#/components/schemas/InsightSeverity'
      minItems: 0
      maxItems: 3
    ThrottlingException: {}
    ListInsightsAnyStatusFilter:
      type: object
      required:
      - Type
      - StartTimeRange
      properties:
        Type:
          allOf:
          - $ref: '#/components/schemas/InsightType'
          - description: ' Use to filter for either <code>REACTIVE</code> or <code>PROACTIVE</code> insights. '
        StartTimeRange:
          allOf:
          - $ref: '#/components/schemas/StartTimeRange'
          - description: ' A time range used to specify when the behavior of the filtered insights started. '
      description: ' Used to filter for insights that have any status. '
    ReactiveInsight:
      type: object
      properties:
        Id:
          allOf:
          - $ref: '#/components/schemas/InsightId'
          - description: ' The ID of a reactive insight. '
        Name:
          allOf:
          - $ref: '#/components/schemas/InsightName'
          - description: ' The name of a reactive insight. '
        Severity:
          allOf:
          - $ref: '#/components/schemas/InsightSeverity'
          - description: The severity of the insight. For more information, see <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities">Understanding insight severities</a> in the <i>Amazon DevOps Guru User Guide</i>.
        Status:
          allOf:
          - $ref: '#/components/schemas/InsightStatus'
          - description: ' The status of a reactive insight. '
        InsightTimeRange:
          $ref: '#/components/schemas/InsightTimeRange'
        ResourceCollection:
          $ref: '#/components/schemas/ResourceCollection'
        SsmOpsItemId:
          allOf:
          - $ref: '#/components/schemas/SsmOpsItemId'
          - 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:
          allOf:
          - $ref: '#/components/schemas/InsightDescription'
          - description: Describes the reactive insight.
      description: ' Information about a reactive insight. This object is returned by <code>ListInsights</code>. '
    ServiceCollection:
      type: object
      properties:
        ServiceNames:
          allOf:
          - $ref: '#/components/schemas/ServiceNames'
          - description: An array of strings that each specifies the name of an Amazon Web Services service.
      description: A collection of the names of Amazon Web Services services.
    ServiceName:
      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
    UuidNextToken:
      type: string
      pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
      minLength: 36
      maxLength: 36
    ResourceArn:
      type: string
      minLength: 20
      maxLength: 2048
    InsightId:
      type: string
      pattern: ^[\w-]*$
      minLength: 1
      maxLength: 100
    InsightSeverity:
      type: string
      enum:
      - LOW
      - MEDIUM
      - HIGH
    InsightType:
      type: string
      enum:
      - REACTIVE
      - PROACTIVE
    AssociatedResourceArns:
      type: array
      items:
        $ref: '#/components/schemas/ResourceArn'
    AccessDeniedException: {}
    AppBoundaryKey:
      type: string
      pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
      minLength: 1
      maxLength: 128
    InsightDescription:
      type: string
    CloudFormationCollection:
      type: object
      properties:
        StackNames:
          allOf:
          - $ref: '#/components/schemas/StackNames'
          - description: ' An array of CloudFormation stack names. '
      description: ' Information about Amazon Web Services CloudFormation stacks. You can use up to 500 stacks to specify which Amazon Web Services resources in your account to analyze. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html">Stacks</a> in the <i>Amazon Web Services CloudFormation User Guide</i>. '
    ConflictException: {}
    DeleteInsightResponse:
      type: object
      properties: {}
    TagCollection:
      type: object
      required:
      - AppBoundaryKey
      - TagValues
      properties:
        AppBoundaryKey:
          allOf:
          - $ref: '#/components/schemas/AppBoundaryKey'
          - description: <p>An Amazon Web Services tag <i>key</i> 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 <i>key</i> make up your DevOps Guru application and analysis boundary.</p> <important> <p>The string used for a <i>key</i> in a tag that you use to define your resource coverage must begin with the prefix <code>Devops-guru-</code>. The tag <i>key</i> might be <code>DevOps-Guru-deployment-application</code> or <code>devops-guru-rds-application</code>. When you create a <i>key</i>, the case of characters in the <i>key</i> can be whatever you choose. After you create a <i>key</i>, it is case-sensitive. For example, DevOps Guru works with a <i>key</i> named <code>devops-guru-rds</code> and a <i>key</i> named <code>DevOps-Guru-RDS</code>, and these act as two different <i>keys</i>. Possible <i>key</i>/<i>value</i> pairs in your application might be <code>Devops-Guru-production-application/RDS</code> or <code>Devops-Guru-production-application/containers</code>.</p> </important>
        TagValues:
          allOf:
          - $ref: '#/components/schemas/TagValues'
          - description: <p>The values in an Amazon Web Services tag collection.</p> <p>The tag's <i>value</i> is an optional field used to associate a string with the tag <i>key</i> (for example, <code>111122223333</code>, <code>Production</code>, or a team name). The <i>key</i> and <i>value</i> are the tag's <i>key</i> pair. Omitting the tag <i>value</i> is the same as using an empty string. Like tag <i>keys</i>, tag <i>values</i> are case-sensitive. You can specify a maximum of 256 characters for a tag value.</p>
      description: <p>A collection of Amazon Web Services tags.</p> <p>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 <a href="https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html">Tagging best practices</a> whitepaper. </p> <p>Each Amazon Web Services tag has two parts. </p> <ul> <li> <p>A tag <i>key</i> (for example, <code>CostCenter</code>, <code>Environment</code>, <code>Project</code>, or <code>Secret</code>). Tag <i>keys</i> are case-sensitive.</p> </li> <li> <p>An optional field known as a tag <i>value</i> (for example, <code>111122223333</code>, <code>Production</code>, or a team name). Omitting the tag <i>value</i> is the same as using an empty string. Like tag <i>keys</i>, tag <i>values</i> are case-sensitive.</p> </li> </ul> <p>Together these are known as <i>key</i>-<i>value</i> pairs.</p> <important> <p>The string used for a <i>key</i> in a tag that you use to define your resource coverage must begin with the prefix <code>Devops-guru-</code>. The tag <i>key</i> might be <code>DevOps-Guru-deployment-application</code> or <code>devops-guru-rds-application</code>. When you create a <i>key</i>, the case of characters in the <i>key</i> can be whatever you choose. After you create a <i>key</i>, it is case-sensitive. For example, DevOps Guru works with a <i>key</i> named <code>devops-guru-rds</code> and a <i>key</i> named <code>DevOps-Guru-RDS</code>, and these act as two different <i>keys</i>. Possible <i>key</i>/<i>value</i> pairs in your application might be <code>Devops-Guru-production-application/RDS</code> or <code>Devops-Guru-production-application/containers</code>.</p> </important>
    ProactiveInsight:
      type: object
      properties:
        Id:
          allOf:
          - $ref: '#/components/schemas/InsightId'
          - description: 'The ID of the proactive insight. '
        Name:
          allOf:
          - $ref: '#/components/schemas/InsightName'
          - description: 'The name of the proactive insight. '
        Severity:
          allOf:
          - $ref: '#/components/schemas/InsightSeverity'
          - description: The severity of the insight. For more information, see <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities">Understanding insight severities</a> in the <i>Amazon DevOps Guru User Guide</i>.
        Status:
          allOf:
          - $ref: '#/components/schemas/InsightStatus'
          - description: 'The status of the proactive insight. '
        InsightTimeRange:
          $ref: '#/components/schemas/InsightTimeRange'
        PredictionTimeRange:
          $ref: '#/components/schemas/PredictionTimeRange'
        ResourceCollection:
          $ref: '#/components/schemas/ResourceCollection'
        SsmOpsItemId:
          allOf:
          - $ref: '#/components/schemas/SsmOpsItemId'
          - 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:
          allOf:
          - $ref: '#/components/schemas/InsightDescription'
          - description: Describes the proactive insight.
      description: Details about a proactive insight. This object is returned by <code>ListInsights</code>.
    TagValue:
      type: string
      pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*|\*)$
      minLength: 0
      maxLength: 256
    ProactiveInsights:
      type: array
      items:
        $ref: '#/components/schemas/ProactiveInsightSummary'
    Timestamp:
      type: string
      format: date-time
    ResourceCollection:
      type: object
      properties:
        CloudFormation:
          allOf:
          - $ref: '#/components/schemas/CloudFormationCollection'
          - description: ' An array of the names of Amazon Web Services CloudFormation stacks. The stacks define Amazon Web Services resources that DevOps Guru analyzes. You can specify up to 500 Amazon Web Services CloudFormation stacks. '
        Tags:
          allOf:
          - $ref: '#/components/schemas/TagCollections'
          - description: <p>The Amazon Web Services tags that are used by resources in the resource collection.</p> <p>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 <a href="https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html">Tagging best practices</a> whitepaper. </p> <p>Each Amazon Web Services tag has two parts. </p> <ul> <li> <p>A tag <i>key</i> (for example, <code>CostCenter</code>, <code>Environment</code>, <code>Project</code>, or <code>Secret</code>). Tag <i>keys</i> are case-sensitive.</p> </li> <li> <p>An optional field known as a tag <i>value</i> (for example, <code>111122223333</code>, <code>Production</code>, or a team name). Omitting the tag <i>value</i> is the same as using an empty string. Like tag <i>keys</i>, tag <i>values</i> are case-sensitive.</p> </li> </ul> <p>Together these are known as <i>key</i>-<i>value</i> pairs.</p> <important> <p>The string used for a <i>key</i> in a tag that you use to define your resource coverage must begin with the prefix <code>Devops-guru-</code>. The tag <i>key</i> might be <code>DevOps-Guru-deployment-application</code> or <code>devops-guru-rds-application</code>. When you create a <i>key</i>, the case of characters in the <i>key</i> can be whatever you choose. After you create a <i>key</i>, it is case-sensitive. For example, DevOps Guru works with a <i>key</i> named <code>devops-guru-rds</code> and a <i>key</i> named <code>DevOps-Guru-RDS</code>, and these act as two different <i>keys</i>. Possible <i>key</i>/<i>value</i> pairs in your application might be <code>Devops-Guru-production-application/RDS</code> or <code>Devops-Guru-production-application/containers</code>.</p> </important>
      description: ' A collection of Amazon Web Services resources supported by DevOps Guru. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag <i>key</i>. You can specify up to 500 Amazon Web Services CloudFormation stacks. '
    ResourceNotFoundException: {}
    StackName:
      type: string
      pattern: ^[a-zA-Z*]+[a-zA-Z0-9-]*$
      minLength: 1
      maxLength: 128
    DescribeInsightResponse:
      type: object
      properties:
        ProactiveInsight:
          allOf:
          - $ref: '#/components/schemas/ProactiveInsight'
          - description: ' A <code>ProactiveInsight</code> object that represents the requested insight. '
        ReactiveInsight:
          allOf:
          - $ref: '#/components/schemas/ReactiveInsight'
          - description: ' A <code>ReactiveInsight</code> object that represents the requested insight. '
    EndTimeRange:
      type: object
      properties:
        FromTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: ' The earliest end time in the time range. '
        ToTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: ' The latest end time in the time range. '
      description: ' A range of time that specifies when anomalous behavior in an anomaly or insight ended. '
    TagCollections:
      type: array
      items:
        $ref: '#/components/schemas/TagCollection'
    TagValues:
      type: array
      items:
        $ref: '#/components/schemas/TagValue'
    ReactiveInsights:
      type: array
      items:
        $ref: '#/components/schemas/ReactiveInsightSummary'
    ListInsightsOngoingStatusFilter:
      type: object
      required:
      - Type
      properties:
        Type:
          allOf:
          - $ref: '#/components/schemas/InsightType'
          - description: ' Use to filter for either <code>REACTIVE</code> or <code>PROACTIVE</code> insights. '
      description: ' Used to filter for insights that have the status <code>ONGOING</code>. '
  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/devops-guru/