Amazon DevOps Guru Accounts API

The Accounts API from Amazon DevOps Guru — 3 operation(s) for accounts.

GitHub OpenAPI
Business capability
Observability Management BC-4220.20

Operations 3

GET /accounts/health Describe Account Health #
POST /accounts/overview Describe Account Overview #
GET /accounts/health/resource-collection/{ResourceCollectionType} Describe Resource Collection Health #

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-devops-guru:amazon-devops-guru-accounts-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-devops-guru-accounts-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon DevOps Guru Accounts API
  version: '2020-12-01'
  description: Generated from AWS's published Smithy model for Amazon DevOps Guru. 3 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:
  /accounts/health:
    get:
      operationId: DescribeAccountHealth
      summary: Describe Account Health
      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'
        '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/DescribeAccountHealthRequest'
      tags:
      - Accounts
  /accounts/overview:
    post:
      operationId: DescribeAccountOverview
      summary: Describe Account Overview
      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'
        '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/DescribeAccountOverviewRequest'
      tags:
      - Accounts
  /accounts/health/resource-collection/{ResourceCollectionType}:
    get:
      operationId: DescribeResourceCollectionHealth
      summary: Describe Resource Collection Health
      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
        key. You can specify up to 500 Amazon Web Services CloudFormation stacks.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeResourceCollectionHealthResponse'
        '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/DescribeResourceCollectionHealthRequest'
      tags:
      - Accounts
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
    CloudFormationHealth:
      type: object
      properties:
        StackName:
          type: string
          description: The name of the CloudFormation stack.
        Insight:
          $ref: '#/components/schemas/InsightHealth'
        AnalyzedResourceCount:
          type: integer
          description: Number of resources that DevOps Guru is monitoring in your account that are specified by an Amazon
            Web Services CloudFormation stack.
    DescribeAccountHealthRequest:
      type: object
      properties: {}
    DescribeAccountHealthResponse:
      type: object
      properties:
        OpenReactiveInsights:
          type: integer
          description: An integer that specifies the number of open reactive insights in your Amazon Web Services account.
        OpenProactiveInsights:
          type: integer
          description: An integer that specifies the number of open proactive insights in your Amazon Web Services account.
        MetricsAnalyzed:
          type: integer
          description: An integer that specifies the number of metrics that have been analyzed in your Amazon Web Services
            account.
        ResourceHours:
          type: integer
          description: The number of Amazon DevOps Guru resource analysis hours billed to the current Amazon Web Services
            account in the last hour.
        AnalyzedResourceCount:
          type: integer
          description: Number of resources that DevOps Guru is monitoring in your Amazon Web Services account.
      required:
      - OpenReactiveInsights
      - OpenProactiveInsights
      - MetricsAnalyzed
      - ResourceHours
    DescribeAccountOverviewRequest:
      type: object
      properties:
        FromTime:
          type: string
          format: date-time
          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.
        ToTime:
          type: string
          format: date-time
          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.
      required:
      - FromTime
    DescribeAccountOverviewResponse:
      type: object
      properties:
        ReactiveInsights:
          type: integer
          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:
          type: integer
          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:
          type: integer
          description: The Mean Time to Recover (MTTR) for all closed insights that were created during the time range passed
            in.
      required:
      - ReactiveInsights
      - ProactiveInsights
      - MeanTimeToRecoverInMilliseconds
    DescribeResourceCollectionHealthRequest:
      type: object
      properties:
        ResourceCollectionType:
          type: string
          enum:
          - AWS_CLOUD_FORMATION
          - AWS_SERVICE
          - AWS_TAGS
          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 key. You can specify up to 500 Amazon Web Services CloudFormation stacks.
        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:
      - ResourceCollectionType
    DescribeResourceCollectionHealthResponse:
      type: object
      properties:
        CloudFormation:
          type: array
          items:
            $ref: '#/components/schemas/CloudFormationHealth'
          description: The returned CloudFormationHealthOverview object that contains an InsightHealthOverview object with
            the requested system health information.
        Service:
          type: array
          items:
            $ref: '#/components/schemas/ServiceHealth'
          description: An array of ServiceHealth objects that describes the health of the Amazon Web Services services associated
            with the resources in the collection.
        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.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/TagHealth'
          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
    InsightHealth:
      type: object
      properties:
        OpenProactiveInsights:
          type: integer
          description: The number of open proactive insights.
        OpenReactiveInsights:
          type: integer
          description: The number of open reactive insights.
        MeanTimeToRecoverInMilliseconds:
          type: integer
          description: The Meant Time to Recover (MTTR) for the insight.
    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
    ServiceHealth:
      type: object
      properties:
        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
          description: The name of the Amazon Web Services service.
        Insight:
          $ref: '#/components/schemas/ServiceInsightHealth'
        AnalyzedResourceCount:
          type: integer
          description: Number of resources that DevOps Guru is monitoring in an analyzed Amazon Web Services service.
    ServiceInsightHealth:
      type: object
      properties:
        OpenProactiveInsights:
          type: integer
          description: The number of open proactive insights in the Amazon Web Services service
        OpenReactiveInsights:
          type: integer
          description: The number of open reactive insights in the Amazon Web Services service
    TagHealth:
      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. '
        TagValue:
          type: string
          description: The value in an Amazon Web Services tag. 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.
        Insight:
          $ref: '#/components/schemas/InsightHealth'
        AnalyzedResourceCount:
          type: integer
          description: Number of resources that DevOps Guru is monitoring in your account that are specified by an Amazon
            Web Services tag.
    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)