Amazon DevOps Guru Recommendations API

The Recommendations API from Amazon DevOps Guru — 1 operation(s) for recommendations.

GitHub OpenAPI

Operations 1

POST /recommendations List Recommendations #

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-recommendations-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-recommendations-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon DevOps Guru Recommendations API
  version: '2020-12-01'
  description: Generated from AWS's published Smithy model for Amazon DevOps Guru. 1 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:
  /recommendations:
    post:
      operationId: ListRecommendations
      summary: List Recommendations
      description: Returns a list of a specified insight's recommendations. Each recommendation includes a list of related
        metrics and a list of related events.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListRecommendationsResponse'
        '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/ListRecommendationsRequest'
      tags:
      - Recommendations
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
    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
    ListRecommendationsRequest:
      type: object
      properties:
        InsightId:
          type: string
          description: The ID of the requested insight.
        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.
        Locale:
          type: string
          enum:
          - DE_DE
          - EN_US
          - EN_GB
          - ES_ES
          - FR_FR
          - IT_IT
          - JA_JP
          - KO_KR
          - PT_BR
          - ZH_CN
          - ZH_TW
          description: A locale that specifies the language to use for recommendations.
        AccountId:
          type: string
          description: The ID of the Amazon Web Services account.
      required:
      - InsightId
    ListRecommendationsResponse:
      type: object
      properties:
        Recommendations:
          type: array
          items:
            $ref: '#/components/schemas/Recommendation'
          description: An array of the requested recommendations.
        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.
    Recommendation:
      type: object
      properties:
        Description:
          type: string
          description: A description of the problem.
        Link:
          type: string
          description: A hyperlink to information to help you address the problem.
        Name:
          type: string
          description: The name of the recommendation.
        Reason:
          type: string
          description: The reason DevOps Guru flagged the anomalous behavior as a problem.
        RelatedEvents:
          type: array
          items:
            $ref: '#/components/schemas/RecommendationRelatedEvent'
          description: Events that are related to the problem. Use these events to learn more about what's happening and to
            help address the issue.
        RelatedAnomalies:
          type: array
          items:
            $ref: '#/components/schemas/RecommendationRelatedAnomaly'
          description: Anomalies that are related to the problem. Use these Anomalies to learn more about what's happening
            and to help address the issue.
        Category:
          type: string
          description: The category type of the recommendation.
    RecommendationRelatedAnomaly:
      type: object
      properties:
        Resources:
          type: array
          items:
            $ref: '#/components/schemas/RecommendationRelatedAnomalyResource'
          description: An array of objects that represent resources in which DevOps Guru detected anomalous behavior. Each
            object contains the name and type of the resource.
        SourceDetails:
          type: array
          items:
            $ref: '#/components/schemas/RecommendationRelatedAnomalySourceDetail'
          description: Information about where the anomalous behavior related the recommendation was found. For example, details
            in Amazon CloudWatch metrics.
        AnomalyId:
          type: string
          description: The ID of an anomaly that generated the insight with this recommendation.
    RecommendationRelatedAnomalyResource:
      type: object
      properties:
        Name:
          type: string
          description: The name of the resource.
        Type:
          type: string
          description: The type of the resource. Resource types take the same form that is used by Amazon Web Services CloudFormation
            resource type identifiers, service-provider::service-name::data-type-name. For example, AWS::RDS::DBCluster. For
            more information, see Amazon Web Services resource and property types reference in the Amazon Web Services CloudFormation
            User Guide.
    RecommendationRelatedAnomalySourceDetail:
      type: object
      properties:
        CloudWatchMetrics:
          type: array
          items:
            $ref: '#/components/schemas/RecommendationRelatedCloudWatchMetricsSourceDetail'
          description: An array of CloudWatchMetricsDetail objects that contains information about the analyzed metrics that
            displayed anomalous behavior.
    RecommendationRelatedCloudWatchMetricsSourceDetail:
      type: object
      properties:
        MetricName:
          type: string
          description: The name of the CloudWatch metric.
        Namespace:
          type: string
          description: The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.
    RecommendationRelatedEvent:
      type: object
      properties:
        Name:
          type: string
          description: The name of the event. This corresponds to the Name field in an Event object.
        Resources:
          type: array
          items:
            $ref: '#/components/schemas/RecommendationRelatedEventResource'
          description: A ResourceCollection object that contains arrays of the names of Amazon Web Services CloudFormation
            stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.
    RecommendationRelatedEventResource:
      type: object
      properties:
        Name:
          type: string
          description: The name of the resource that emitted the event. This corresponds to the Name field in an EventResource
            object.
        Type:
          type: string
          description: The type of the resource that emitted the event. This corresponds to the Type field in an EventResource
            object.
    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
    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)