Amazon DevOps Guru Accounts API

openapi: 3.0.0
info:
  version: 2020-12-01
  x-release: v4
  title: Amazon DevOps Guru Accounts 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: Accounts
paths:
  /accounts/health:
    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'
    get:
      operationId: DescribeAccountHealth
      description: ' Returns the number of open reactive insights, the number of open proactive insights, and the number of metrics analyzed in your Amazon Web Services account. Use these numbers to gauge the health of operations in your Amazon Web Services account. '
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeAccountHealthResponse'
        '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: []
      tags:
      - Accounts
  /accounts/overview:
    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: DescribeAccountOverview
      description: ' For the time range passed in, returns the number of open reactive insight that were created, the number of open proactive insights that were created, and the Mean Time to Recover (MTTR) for all closed reactive insights. '
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeAccountOverviewResponse'
        '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: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - FromTime
              properties:
                FromTime:
                  description: ' The start of the time range passed in. The start time granularity is at the day level. The floor of the start time is used. Returned information occurred after this day. '
                  type: string
                  format: date-time
                ToTime:
                  description: ' The end of the time range passed in. The start time granularity is at the day level. The floor of the start time is used. Returned information occurred before this day. If this is not specified, then the current day is used. '
                  type: string
                  format: date-time
      tags:
      - Accounts
  /accounts/health/resource-collection/{ResourceCollectionType}:
    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'
    get:
      operationId: DescribeResourceCollectionHealth
      description: ' Returns the number of open proactive insights, open reactive insights, and the Mean Time to Recover (MTTR) for all closed insights in resource collections in your account. You specify the type of Amazon Web Services resources collection. 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. '
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeResourceCollectionHealthResponse'
        '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: ResourceCollectionType
        in: path
        required: true
        description: ' An Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources are defined. 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. '
        schema:
          type: string
          enum:
          - AWS_CLOUD_FORMATION
          - AWS_SERVICE
          - AWS_TAGS
      - name: NextToken
        in: query
        required: false
        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.
        schema:
          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:
      - Accounts
components:
  schemas:
    InternalServerException: {}
    ResourceHours:
      type: integer
    TagHealths:
      type: array
      items:
        $ref: '#/components/schemas/TagHealth'
    NumReactiveInsights:
      type: integer
    ServiceHealths:
      type: array
      items:
        $ref: '#/components/schemas/ServiceHealth'
    TagHealth:
      type: object
      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>
        TagValue:
          allOf:
          - $ref: '#/components/schemas/TagValue'
          - description: <p>The value in an Amazon Web Services tag.</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>
        Insight:
          allOf:
          - $ref: '#/components/schemas/InsightHealth'
          - description: 'Information about the health of the Amazon Web Services resources in your account that are specified by an Amazon Web Services tag, including the number of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights. '
        AnalyzedResourceCount:
          allOf:
          - $ref: '#/components/schemas/AnalyzedResourceCount'
          - description: ' Number of resources that DevOps Guru is monitoring in your account that are specified by an Amazon Web Services tag. '
      description: ' Information about the health of Amazon Web Services resources in your account that are specified by an Amazon Web Services tag <i>key</i>. '
    ValidationException: {}
    CloudFormationHealths:
      type: array
      items:
        $ref: '#/components/schemas/CloudFormationHealth'
    ServiceInsightHealth:
      type: object
      properties:
        OpenProactiveInsights:
          allOf:
          - $ref: '#/components/schemas/NumOpenProactiveInsights'
          - description: The number of open proactive insights in the Amazon Web Services service
        OpenReactiveInsights:
          allOf:
          - $ref: '#/components/schemas/NumOpenReactiveInsights'
          - description: The number of open reactive insights in the Amazon Web Services service
      description: Contains the number of open proactive and reactive insights in an analyzed Amazon Web Services service.
    NumMetricsAnalyzed:
      type: integer
    ThrottlingException: {}
    DescribeResourceCollectionHealthResponse:
      type: object
      properties:
        CloudFormation:
          allOf:
          - $ref: '#/components/schemas/CloudFormationHealths'
          - description: ' The returned <code>CloudFormationHealthOverview</code> object that contains an <code>InsightHealthOverview</code> object with the requested system health information. '
        Service:
          allOf:
          - $ref: '#/components/schemas/ServiceHealths'
          - description: An array of <code>ServiceHealth</code> objects that describes the health of the Amazon Web Services services associated with the resources in the collection.
        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.
        Tags:
          allOf:
          - $ref: '#/components/schemas/TagHealths'
          - 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>
    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
    CloudFormationHealth:
      type: object
      properties:
        StackName:
          allOf:
          - $ref: '#/components/schemas/StackName'
          - description: ' The name of the CloudFormation stack. '
        Insight:
          allOf:
          - $ref: '#/components/schemas/InsightHealth'
          - description: ' Information about the health of the Amazon Web Services resources in your account that are specified by an Amazon Web Services CloudFormation stack, including the number of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights. '
        AnalyzedResourceCount:
          allOf:
          - $ref: '#/components/schemas/AnalyzedResourceCount'
          - description: ' Number of resources that DevOps Guru is monitoring in your account that are specified by an Amazon Web Services CloudFormation stack. '
      description: ' Information about the health of Amazon Web Services resources in your account that are specified by an Amazon Web Services CloudFormation stack. '
    MeanTimeToRecoverInMilliseconds:
      type: integer
    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
    DescribeAccountOverviewResponse:
      type: object
      required:
      - ReactiveInsights
      - ProactiveInsights
      - MeanTimeToRecoverInMilliseconds
      properties:
        ReactiveInsights:
          allOf:
          - $ref: '#/components/schemas/NumReactiveInsights'
          - description: ' An integer that specifies the number of open reactive insights in your Amazon Web Services account that were created during the time range passed in. '
        ProactiveInsights:
          allOf:
          - $ref: '#/components/schemas/NumProactiveInsights'
          - description: ' An integer that specifies the number of open proactive insights in your Amazon Web Services account that were created during the time range passed in. '
        MeanTimeToRecoverInMilliseconds:
          allOf:
          - $ref: '#/components/schemas/MeanTimeToRecoverInMilliseconds'
          - description: ' The Mean Time to Recover (MTTR) for all closed insights that were created during the time range passed in. '
    AccessDeniedException: {}
    AppBoundaryKey:
      type: string
      pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
      minLength: 1
      maxLength: 128
    NumOpenReactiveInsights:
      type: integer
    AnalyzedResourceCount:
      type: integer
    NumOpenProactiveInsights:
      type: integer
    ServiceHealth:
      type: object
      properties:
        ServiceName:
          allOf:
          - $ref: '#/components/schemas/ServiceName'
          - description: The name of the Amazon Web Services service.
        Insight:
          allOf:
          - $ref: '#/components/schemas/ServiceInsightHealth'
          - description: Represents the health of an Amazon Web Services service. This is a <code>ServiceInsightHealth</code> that contains the number of open proactive and reactive insights for this service.
        AnalyzedResourceCount:
          allOf:
          - $ref: '#/components/schemas/AnalyzedResourceCount'
          - description: ' Number of resources that DevOps Guru is monitoring in an analyzed Amazon Web Services service. '
      description: Represents the health of an Amazon Web Services service.
    NumProactiveInsights:
      type: integer
    TagValue:
      type: string
      pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*|\*)$
      minLength: 0
      maxLength: 256
    StackName:
      type: string
      pattern: ^[a-zA-Z*]+[a-zA-Z0-9-]*$
      minLength: 1
      maxLength: 128
    DescribeAccountHealthResponse:
      type: object
      required:
      - OpenReactiveInsights
      - OpenProactiveInsights
      - MetricsAnalyzed
      - ResourceHours
      properties:
        OpenReactiveInsights:
          allOf:
          - $ref: '#/components/schemas/NumOpenReactiveInsights'
          - description: ' An integer that specifies the number of open reactive insights in your Amazon Web Services account. '
        OpenProactiveInsights:
          allOf:
          - $ref: '#/components/schemas/NumOpenProactiveInsights'
          - description: ' An integer that specifies the number of open proactive insights in your Amazon Web Services account. '
        MetricsAnalyzed:
          allOf:
          - $ref: '#/components/schemas/NumMetricsAnalyzed'
          - description: ' An integer that specifies the number of metrics that have been analyzed in your Amazon Web Services account. '
        ResourceHours:
          allOf:
          - $ref: '#/components/schemas/ResourceHours'
          - description: 'The number of Amazon DevOps Guru resource analysis hours billed to the current Amazon Web Services account in the last hour. '
        AnalyzedResourceCount:
          allOf:
          - $ref: '#/components/schemas/AnalyzedResourceCount'
          - description: ' Number of resources that DevOps Guru is monitoring in your Amazon Web Services account. '
    InsightHealth:
      type: object
      properties:
        OpenProactiveInsights:
          allOf:
          - $ref: '#/components/schemas/NumOpenProactiveInsights'
          - description: ' The number of open proactive insights. '
        OpenReactiveInsights:
          allOf:
          - $ref: '#/components/schemas/NumOpenReactiveInsights'
          - description: ' The number of open reactive insights. '
        MeanTimeToRecoverInMilliseconds:
          allOf:
          - $ref: '#/components/schemas/MeanTimeToRecoverInMilliseconds'
          - description: ' The Meant Time to Recover (MTTR) for the insight. '
      description: ' Information about the number of open reactive and proactive insights that can be used to gauge the health of your system. '
  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/