Amazon DocumentDB Documentdb Cluster Snapshot API

The Documentdb Cluster Snapshot API from Amazon DocumentDB — 2 operation(s) for documentdb cluster snapshot.

GitHub OpenAPI

Operations 4

POST /cluster-snapshot Create Cluster Snapshot #
DELETE /cluster-snapshot/{snapshotArn} Delete Cluster Snapshot #
GET /cluster-snapshot/{snapshotArn} Get Cluster Snapshot #
GET /cluster-snapshots List Cluster Snapshots #

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-cluster-snapshot-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-cluster-snapshot-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon DocumentDB with MongoDB compatibility Cluster Snapshot API
  version: '2014-10-31'
  description: Generated from AWS's published Smithy model for Amazon DocumentDB with MongoDB compatibility. 4 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://docdb-elastic.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /cluster-snapshot:
    post:
      operationId: CreateClusterSnapshot
      summary: Create Cluster Snapshot
      description: Creates a snapshot of an elastic cluster.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateClusterSnapshotOutput'
        '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'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '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/CreateClusterSnapshotInput'
      tags:
      - Cluster Snapshot
  /cluster-snapshot/{snapshotArn}:
    delete:
      operationId: DeleteClusterSnapshot
      summary: Delete Cluster Snapshot
      description: Delete an elastic cluster snapshot.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteClusterSnapshotOutput'
        '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'
        '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/DeleteClusterSnapshotInput'
      tags:
      - Cluster Snapshot
    get:
      operationId: GetClusterSnapshot
      summary: Get Cluster Snapshot
      description: Returns information about a specific elastic cluster snapshot
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetClusterSnapshotOutput'
        '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/GetClusterSnapshotInput'
      tags:
      - Cluster Snapshot
  /cluster-snapshots:
    get:
      operationId: ListClusterSnapshots
      summary: List Cluster Snapshots
      description: Returns information about snapshots for a specified elastic cluster.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListClusterSnapshotsOutput'
        '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/ListClusterSnapshotsInput'
      tags:
      - Cluster Snapshot
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: docdb-elastic
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
          description: An error message explaining why access was denied.
      required:
      - message
    ClusterSnapshot:
      type: object
      properties:
        subnetIds:
          type: array
          items:
            type: string
          description: The Amazon EC2 subnet IDs for the elastic cluster.
        snapshotName:
          type: string
          description: The name of the elastic cluster snapshot.
        snapshotArn:
          type: string
          description: The ARN identifier of the elastic cluster snapshot.
        snapshotCreationTime:
          type: string
          description: The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).
        clusterArn:
          type: string
          description: The ARN identifier of the elastic cluster.
        clusterCreationTime:
          type: string
          description: The time when the elastic cluster was created in Universal Coordinated Time (UTC).
        status:
          type: string
          description: The status of the elastic cluster snapshot.
        vpcSecurityGroupIds:
          type: array
          items:
            type: string
          description: A list of EC2 VPC security groups to associate with the elastic cluster.
        adminUserName:
          type: string
          description: The name of the elastic cluster administrator.
        kmsKeyId:
          type: string
          description: The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating
            a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead
            of the ARN as the KMS encryption key. If an encryption key is not specified here, Amazon DocumentDB uses the default
            encryption key that KMS creates for your account. Your account has a different default encryption key for each
            Amazon Region.
        snapshotType:
          type: string
          description: 'The type of cluster snapshots to be returned. You can specify one of the following values: automated
            - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.
            manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.'
      required:
      - subnetIds
      - snapshotName
      - snapshotArn
      - snapshotCreationTime
      - clusterArn
      - clusterCreationTime
      - status
      - vpcSecurityGroupIds
      - adminUserName
      - kmsKeyId
    ClusterSnapshotInList:
      type: object
      properties:
        snapshotName:
          type: string
          description: The name of the elastic cluster snapshot.
        snapshotArn:
          type: string
          description: The ARN identifier of the elastic cluster snapshot.
        clusterArn:
          type: string
          description: The ARN identifier of the elastic cluster.
        status:
          type: string
          description: The status of the elastic cluster snapshot.
        snapshotCreationTime:
          type: string
          description: The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).
      required:
      - snapshotName
      - snapshotArn
      - clusterArn
      - status
      - snapshotCreationTime
    ConflictException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The ID of the resource where there was an access conflict.
        resourceType:
          type: string
          description: The type of the resource where there was an access conflict.
      required:
      - message
      - resourceId
      - resourceType
    CreateClusterSnapshotInput:
      type: object
      properties:
        clusterArn:
          type: string
          description: The ARN identifier of the elastic cluster of which you want to create a snapshot.
        snapshotName:
          type: string
          description: The name of the new elastic cluster snapshot.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags to be assigned to the new elastic cluster snapshot.
      required:
      - clusterArn
      - snapshotName
    CreateClusterSnapshotOutput:
      type: object
      properties:
        snapshot:
          $ref: '#/components/schemas/ClusterSnapshot'
      required:
      - snapshot
    DeleteClusterSnapshotInput:
      type: object
      properties:
        snapshotArn:
          type: string
          description: The ARN identifier of the elastic cluster snapshot that is to be deleted.
      required:
      - snapshotArn
    DeleteClusterSnapshotOutput:
      type: object
      properties:
        snapshot:
          $ref: '#/components/schemas/ClusterSnapshot'
      required:
      - snapshot
    GetClusterSnapshotInput:
      type: object
      properties:
        snapshotArn:
          type: string
          description: The ARN identifier of the elastic cluster snapshot.
      required:
      - snapshotArn
    GetClusterSnapshotOutput:
      type: object
      properties:
        snapshot:
          $ref: '#/components/schemas/ClusterSnapshot'
      required:
      - snapshot
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ListClusterSnapshotsInput:
      type: object
      properties:
        clusterArn:
          type: string
          description: The ARN identifier of the elastic cluster.
        nextToken:
          type: string
          description: A pagination token provided by a previous request. If this parameter is specified, the response includes
            only records beyond this token, up to the value specified by max-results. If there is no more data in the responce,
            the nextToken will not be returned.
        maxResults:
          type: integer
          description: The maximum number of elastic cluster snapshot results to receive in the response.
        snapshotType:
          type: string
          description: 'The type of cluster snapshots to be returned. You can specify one of the following values: automated
            - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.
            manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.'
    ListClusterSnapshotsOutput:
      type: object
      properties:
        snapshots:
          type: array
          items:
            $ref: '#/components/schemas/ClusterSnapshotInList'
          description: A list of snapshots for a specified elastic cluster.
        nextToken:
          type: string
          description: A pagination token provided by a previous request. If this parameter is specified, the response includes
            only records beyond this token, up to the value specified by max-results. If there is no more data in the responce,
            the nextToken will not be returned.
    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
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
        retryAfterSeconds:
          type: integer
          description: The number of seconds to wait before retrying the operation.
      required:
      - message
    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-elastic/service/2022-11-28/docdb-elastic-2022-11-28.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)