Amazon DocumentDB Documentdb Tag API

The Documentdb Tag API from Amazon DocumentDB — 3 operation(s) for documentdb tag.

GitHub OpenAPI

Operations 6

POST /?Action=AddTagsToResource Add Tags To Resource #
POST /?Action=ListTagsForResource List Tags For Resource #
POST /?Action=RemoveTagsFromResource Remove Tags From Resource #
GET /tags/{resourceArn} List Tags For Resource #
POST /tags/{resourceArn} Tag Resource #
DELETE /tags/{resourceArn} Untag Resource #

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-documentdb:amazon-documentdb-tag-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-documentdb-tag-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon DocumentDB with MongoDB compatibility Tag API
  version: '2014-10-31'
  description: Generated from AWS's published Smithy model for Amazon DocumentDB with MongoDB compatibility. 6 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://rds.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /?Action=AddTagsToResource:
    post:
      operationId: AddTagsToResource
      summary: Add Tags To Resource
      description: Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting
        to track costs that are associated with Amazon DocumentDB resources or in a Condition statement in an Identity and
        Access Management (IAM) policy for Amazon DocumentDB.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                type: string
        '404':
          description: DBClusterNotFoundFault; DBInstanceNotFoundFault; DBSnapshotNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBClusterNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: AddTagsToResource
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/AddTagsToResourceMessage'
      tags:
      - Tag
  /?Action=ListTagsForResource:
    post:
      operationId: ListTagsForResource
      summary: List Tags For Resource
      description: Lists all tags on an Amazon DocumentDB resource.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/TagListMessage'
        '404':
          description: DBClusterNotFoundFault; DBInstanceNotFoundFault; DBSnapshotNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBClusterNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ListTagsForResource
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/ListTagsForResourceMessage'
      tags:
      - Tag
  /?Action=RemoveTagsFromResource:
    post:
      operationId: RemoveTagsFromResource
      summary: Remove Tags From Resource
      description: Removes metadata tags from an Amazon DocumentDB resource.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                type: string
        '404':
          description: DBClusterNotFoundFault; DBInstanceNotFoundFault; DBSnapshotNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBClusterNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: RemoveTagsFromResource
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/RemoveTagsFromResourceMessage'
      tags:
      - Tag
  /tags/{resourceArn}:
    get:
      operationId: ListTagsForResource
      summary: List Tags For Resource
      description: Lists all tags on a elastic cluster resource
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTagsForResourceResponse'
        '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/ListTagsForResourceRequest'
      tags:
      - Tag
      servers:
      - url: https://docdb-elastic.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
      security:
      - sigv4_docdb_elastic: []
    post:
      operationId: TagResource
      summary: Tag Resource
      description: Adds metadata tags to an elastic cluster resource
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagResourceResponse'
        '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/TagResourceRequest'
      tags:
      - Tag
      servers:
      - url: https://docdb-elastic.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
      security:
      - sigv4_docdb_elastic: []
    delete:
      operationId: UntagResource
      summary: Untag Resource
      description: Removes metadata tags from an elastic cluster resource
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UntagResourceResponse'
        '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/UntagResourceRequest'
      tags:
      - Tag
      servers:
      - url: https://docdb-elastic.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
      security:
      - sigv4_docdb_elastic: []
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: rds
    sigv4_docdb_elastic:
      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: docdb-elastic
  schemas:
    AddTagsToResourceMessage:
      type: object
      properties:
        ResourceName:
          type: string
          description: The Amazon DocumentDB resource that the tags are added to. This value is an Amazon Resource Name .
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags to be assigned to the Amazon DocumentDB resource.
      required:
      - ResourceName
      - Tags
    DBClusterNotFoundFault:
      type: object
      properties:
        message:
          type: string
    Filter:
      type: object
      properties:
        Name:
          type: string
          description: The name of the filter. Filter names are case sensitive.
        Values:
          type: array
          items:
            type: string
          description: One or more filter values. Filter values are case sensitive.
      required:
      - Name
      - Values
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ListTagsForResourceMessage:
      type: object
      properties:
        ResourceName:
          type: string
          description: The Amazon DocumentDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: This parameter is not currently supported.
      required:
      - ResourceName
    ListTagsForResourceRequest:
      type: object
      properties:
        resourceArn:
          type: string
          description: The ARN identifier of the elastic cluster resource.
      required:
      - resourceArn
    ListTagsForResourceResponse:
      type: object
      properties:
        tags:
          type: object
          additionalProperties:
            type: string
          description: The list of tags for the specified elastic cluster resource.
    RemoveTagsFromResourceMessage:
      type: object
      properties:
        ResourceName:
          type: string
          description: The Amazon DocumentDB resource that the tags are removed from. This value is an Amazon Resource Name
            (ARN).
        TagKeys:
          type: array
          items:
            type: string
          description: The tag key (name) of the tag to be removed.
      required:
      - ResourceName
      - TagKeys
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
          description: An error message describing the failure.
        resourceId:
          type: string
          description: The ID of the resource that could not be located.
        resourceType:
          type: string
          description: The type of the resource that could not be found.
      required:
      - message
      - resourceId
      - resourceType
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: 'The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and
            can''t be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white
            space, ''_'', ''.'', ''/'', ''='', ''+'', ''-'' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").'
        Value:
          type: string
          description: 'The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length
            and can''t be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits,
            white space, ''_'', ''.'', ''/'', ''='', ''+'', ''-'' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").'
    TagListMessage:
      type: object
      properties:
        TagList:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of one or more tags.
    TagResourceRequest:
      type: object
      properties:
        resourceArn:
          type: string
          description: The ARN identifier of the elastic cluster resource.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags that are assigned to the elastic cluster resource.
      required:
      - resourceArn
      - tags
    TagResourceResponse:
      type: object
      properties: {}
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
        retryAfterSeconds:
          type: integer
          description: The number of seconds to wait before retrying the operation.
      required:
      - message
    UntagResourceRequest:
      type: object
      properties:
        resourceArn:
          type: string
          description: The ARN identifier of the elastic cluster resource.
        tagKeys:
          type: array
          items:
            type: string
          description: The tag keys to be removed from the elastic cluster resource.
      required:
      - resourceArn
      - tagKeys
    UntagResourceResponse:
      type: object
      properties: {}
    ValidationException:
      type: object
      properties:
        message:
          type: string
          description: An error message describing the validation exception.
        reason:
          type: string
          description: The reason why the validation exception occurred (one of unknownOperation, cannotParse, fieldValidationFailed,
            or other).
        fieldList:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
          description: A list of the fields in which the validation exception occurred.
      required:
      - message
      - reason
    ValidationExceptionField:
      type: object
      properties:
        name:
          type: string
          description: The name of the field where the validation exception occurred.
        message:
          type: string
          description: An error message describing the validation exception in this field.
      required:
      - name
      - message
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/docdb/service/2014-10-31/docdb-2014-10-31.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)
  sources:
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/docdb/service/2014-10-31/docdb-2014-10-31.json
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/docdb-elastic/service/2022-11-28/docdb-elastic-2022-11-28.json