Amazon DevOps Guru Resource Collections API

The Resource Collections API from Amazon DevOps Guru — 2 operation(s) for resource collections.

GitHub OpenAPI

Operations 2

GET /resource-collections/{ResourceCollectionType} Get Resource Collection #
PUT /resource-collections Update Resource Collection #

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-resource-collections-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-resource-collections-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon DevOps Guru Resource Collections API
  version: '2020-12-01'
  description: Generated from AWS's published Smithy model for Amazon DevOps Guru. 2 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:
  /resource-collections/{ResourceCollectionType}:
    get:
      operationId: GetResourceCollection
      summary: Get Resource Collection
      description: Returns lists Amazon Web Services resources that are of the specified resource collection type. 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/GetResourceCollectionResponse'
        '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/GetResourceCollectionRequest'
      tags:
      - Resource Collections
  /resource-collections:
    put:
      operationId: UpdateResourceCollection
      summary: Update Resource Collection
      description: Updates the collection of resources that DevOps Guru analyzes. 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. This method also creates the IAM role required for you to use DevOps Guru.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateResourceCollectionResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '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/UpdateResourceCollectionRequest'
      tags:
      - Resource Collections
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
    CloudFormationCollectionFilter:
      type: object
      properties:
        StackNames:
          type: array
          items:
            type: string
          description: An array of CloudFormation stack names.
    ConflictException:
      type: object
      properties:
        Message:
          type: string
        ResourceId:
          type: string
          description: The ID of the Amazon Web Services resource in which a conflict occurred.
        ResourceType:
          type: string
          description: The type of the Amazon Web Services resource in which a conflict occurred.
      required:
      - Message
      - ResourceId
      - ResourceType
    GetResourceCollectionRequest:
      type: object
      properties:
        ResourceCollectionType:
          type: string
          enum:
          - AWS_CLOUD_FORMATION
          - AWS_SERVICE
          - AWS_TAGS
          description: The type of Amazon Web Services resource collections to return. The one valid value is CLOUD_FORMATION
            for 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
    GetResourceCollectionResponse:
      type: object
      properties:
        ResourceCollection:
          $ref: '#/components/schemas/ResourceCollectionFilter'
        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.
    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
    ResourceCollectionFilter:
      type: object
      properties:
        CloudFormation:
          $ref: '#/components/schemas/CloudFormationCollectionFilter'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/TagCollectionFilter'
          description: 'The Amazon Web Services tags used to filter the 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, '
    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
    TagCollectionFilter:
      type: object
      properties:
        AppBoundaryKey:
          type: string
          description: 'An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps
            Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your
            DevOps Guru application and analysis boundary. The string used for a key in a tag that you use to define your
            resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application
            or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose.
            After you create a key, it is case-sensitive. '
        TagValues:
          type: array
          items:
            type: string
          description: The values in an Amazon Web Services tag collection. The tag's value is an optional field used to associate
            a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag's
            key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.
            You can specify a maximum of 256 characters for a tag value.
      required:
      - AppBoundaryKey
      - TagValues
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
        QuotaCode:
          type: string
          description: The code of the quota that was exceeded, causing the throttling exception.
        ServiceCode:
          type: string
          description: The code of the service that caused the throttling exception.
        RetryAfterSeconds:
          type: integer
          description: The number of seconds after which the action that caused the throttling exception can be retried.
      required:
      - Message
    UpdateCloudFormationCollectionFilter:
      type: object
      properties:
        StackNames:
          type: array
          items:
            type: string
          description: An array of the names of the Amazon Web Services CloudFormation stacks to update. You can specify up
            to 500 Amazon Web Services CloudFormation stacks.
    UpdateResourceCollectionFilter:
      type: object
      properties:
        CloudFormation:
          $ref: '#/components/schemas/UpdateCloudFormationCollectionFilter'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/UpdateTagCollectionFilter'
          description: The updated Amazon Web Services tags used to filter the 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, Cost
    UpdateResourceCollectionRequest:
      type: object
      properties:
        Action:
          type: string
          enum:
          - ADD
          - REMOVE
          description: Specifies if the resource collection in the request is added or deleted to the resource collection.
        ResourceCollection:
          $ref: '#/components/schemas/UpdateResourceCollectionFilter'
      required:
      - Action
      - ResourceCollection
    UpdateResourceCollectionResponse:
      type: object
      properties: {}
    UpdateTagCollectionFilter:
      type: object
      properties:
        AppBoundaryKey:
          type: string
          description: 'An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps
            Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your
            DevOps Guru application and analysis boundary. The string used for a key in a tag that you use to define your
            resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application
            or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose.
            After you create a key, it is case-sensitive. '
        TagValues:
          type: array
          items:
            type: string
          description: The values in an Amazon Web Services tag collection. The tag's value is an optional field used to associate
            a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag's
            key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.
            You can specify a maximum of 256 characters for a tag value.
      required:
      - AppBoundaryKey
      - TagValues
    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)