Amazon MemoryDB Snapshots API

The Snapshots API from Amazon MemoryDB — 2 operation(s) for snapshots.

GitHub OpenAPI

Operations 4

POST /#CreateSnapshot Create Snapshot #
POST /#DeleteSnapshot Delete Snapshot #
POST /#DescribeSnapshots Describe Snapshots #
POST /#CopySnapshot Copy Snapshot #

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-memorydb:amazon-memorydb-snapshots-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-memorydb-snapshots-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon MemoryDB Snapshots API
  version: '2021-01-01'
  description: Generated from AWS's published Smithy model for Amazon MemoryDB. 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://memory-db.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateSnapshot:
    post:
      operationId: CreateSnapshot
      summary: Create Snapshot
      description: Creates a copy of an entire cluster at a specific moment in time.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateSnapshotResponse'
        '404':
          description: ClusterNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ClusterNotFoundFault'
        '400':
          description: InvalidClusterStateFault; InvalidParameterCombinationException; InvalidParameterValueException; ServiceLinkedRoleNotFoundFault;
            SnapshotAlreadyExistsFault; SnapshotQuotaExceededFault; TagQuotaPerResourceExceeded
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidClusterStateFault'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonMemoryDB.CreateSnapshot
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateSnapshotRequest'
      tags:
      - Snapshots
  /#DeleteSnapshot:
    post:
      operationId: DeleteSnapshot
      summary: Delete Snapshot
      description: Deletes an existing snapshot. When you receive a successful response from this operation, MemoryDB immediately
        begins deleting the snapshot; you cannot cancel or revert this operation.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteSnapshotResponse'
        '400':
          description: InvalidParameterCombinationException; InvalidParameterValueException; InvalidSnapshotStateFault; ServiceLinkedRoleNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterCombinationException'
        '404':
          description: SnapshotNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SnapshotNotFoundFault'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonMemoryDB.DeleteSnapshot
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteSnapshotRequest'
      tags:
      - Snapshots
  /#DescribeSnapshots:
    post:
      operationId: DescribeSnapshots
      summary: Describe Snapshots
      description: Returns information about cluster snapshots. By default, DescribeSnapshots lists all of your snapshots;
        it can optionally describe a single snapshot, or just the snapshots associated with a particular cluster.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeSnapshotsResponse'
        '400':
          description: InvalidParameterCombinationException; InvalidParameterValueException; ServiceLinkedRoleNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterCombinationException'
        '404':
          description: SnapshotNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SnapshotNotFoundFault'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonMemoryDB.DescribeSnapshots
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeSnapshotsRequest'
      tags:
      - Snapshots
  /#CopySnapshot:
    post:
      operationId: CopySnapshot
      summary: Copy Snapshot
      description: Makes a copy of an existing snapshot.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CopySnapshotResponse'
        '400':
          description: InvalidParameterCombinationException; InvalidParameterValueException; InvalidSnapshotStateFault; ServiceLinkedRoleNotFoundFault;
            SnapshotAlreadyExistsFault; SnapshotQuotaExceededFault; TagQuotaPerResourceExceeded
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterCombinationException'
        '404':
          description: SnapshotNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SnapshotNotFoundFault'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonMemoryDB.CopySnapshot
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CopySnapshotRequest'
      tags:
      - Snapshots
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: memorydb
  schemas:
    ClusterConfiguration:
      type: object
      properties:
        Name:
          type: string
          description: The name of the cluster
        Description:
          type: string
          description: The description of the cluster configuration
        NodeType:
          type: string
          description: The node type used for the cluster
        Engine:
          type: string
          description: The name of the engine used by the cluster configuration.
        EngineVersion:
          type: string
          description: The Redis OSS engine version used by the cluster
        MaintenanceWindow:
          type: string
          description: The specified maintenance window for the cluster
        TopicArn:
          type: string
          description: The Amazon Resource Name (ARN) of the SNS notification topic for the cluster
        Port:
          type: integer
          description: The port used by the cluster
        ParameterGroupName:
          type: string
          description: The name of parameter group used by the cluster
        SubnetGroupName:
          type: string
          description: The name of the subnet group used by the cluster
        VpcId:
          type: string
          description: The ID of the VPC the cluster belongs to
        SnapshotRetentionLimit:
          type: integer
          description: The snapshot retention limit set by the cluster
        SnapshotWindow:
          type: string
          description: The snapshot window set by the cluster
        NumShards:
          type: integer
          description: The number of shards in the cluster
        Shards:
          type: array
          items:
            $ref: '#/components/schemas/ShardDetail'
          description: The list of shards in the cluster
        MultiRegionParameterGroupName:
          type: string
          description: The name of the multi-Region parameter group associated with the cluster configuration.
        MultiRegionClusterName:
          type: string
          description: The name for the multi-Region cluster associated with the cluster configuration.
    ClusterNotFoundFault:
      type: object
      properties:
        message:
          type: string
    CopySnapshotRequest:
      type: object
      properties:
        SourceSnapshotName:
          type: string
          description: The name of an existing snapshot from which to make a copy.
        TargetSnapshotName:
          type: string
          description: A name for the snapshot copy. MemoryDB does not permit overwriting a snapshot, therefore this name
            must be unique within its context - MemoryDB or an Amazon S3 bucket if exporting.
        TargetBucket:
          type: string
          description: 'The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting
            a snapshot for external access. When using this parameter to export a snapshot, be sure MemoryDB has the needed
            permissions to this S3 bucket. For more information, see Step 2: Grant MemoryDB Access to Your Amazon S3 Bucket.'
        KmsKeyId:
          type: string
          description: The ID of the KMS key used to encrypt the target snapshot.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied
            by a tag value, although null is accepted.
      required:
      - SourceSnapshotName
      - TargetSnapshotName
    CopySnapshotResponse:
      type: object
      properties:
        Snapshot:
          $ref: '#/components/schemas/Snapshot'
    CreateSnapshotRequest:
      type: object
      properties:
        ClusterName:
          type: string
          description: The snapshot is created from this cluster.
        SnapshotName:
          type: string
          description: A name for the snapshot being created.
        KmsKeyId:
          type: string
          description: The ID of the KMS key used to encrypt the snapshot.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied
            by a tag value, although null is accepted.
      required:
      - ClusterName
      - SnapshotName
    CreateSnapshotResponse:
      type: object
      properties:
        Snapshot:
          $ref: '#/components/schemas/Snapshot'
    DeleteSnapshotRequest:
      type: object
      properties:
        SnapshotName:
          type: string
          description: The name of the snapshot to delete.
      required:
      - SnapshotName
    DeleteSnapshotResponse:
      type: object
      properties:
        Snapshot:
          $ref: '#/components/schemas/Snapshot'
    DescribeSnapshotsRequest:
      type: object
      properties:
        ClusterName:
          type: string
          description: A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with
            that specific cluster are described.
        SnapshotName:
          type: string
          description: A user-supplied name of the snapshot. If this parameter is specified, only this named snapshot is described.
        Source:
          type: string
          description: If set to system, the output shows snapshots that were automatically created by MemoryDB. If set to
            user the output shows snapshots that were manually created. If omitted, the output shows both automatically and
            manually created snapshots.
        NextToken:
          type: string
          description: An optional argument to pass in case the total number of records exceeds the value of MaxResults. If
            nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for
            each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
        MaxResults:
          type: integer
          description: The maximum number of records to include in the response. If more records exist than the specified
            MaxResults value, a token is included in the response so that the remaining results can be retrieved.
        ShowDetail:
          type: boolean
          description: A Boolean value which if true, the shard configuration is included in the snapshot description.
    DescribeSnapshotsResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: An optional argument to pass in case the total number of records exceeds the value of MaxResults. If
            nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for
            each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
        Snapshots:
          type: array
          items:
            $ref: '#/components/schemas/Snapshot'
          description: A list of snapshots. Each item in the list contains detailed information about one snapshot.
    InvalidClusterStateFault:
      type: object
      properties:
        message:
          type: string
    InvalidParameterCombinationException:
      type: object
      properties:
        message:
          type: string
    ShardConfiguration:
      type: object
      properties:
        Slots:
          type: string
          description: A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383.
            The string is in the format startkey-endkey.
        ReplicaCount:
          type: integer
          description: The number of read replica nodes in this shard.
    ShardDetail:
      type: object
      properties:
        Name:
          type: string
          description: The name of the shard
        Configuration:
          $ref: '#/components/schemas/ShardConfiguration'
        Size:
          type: string
          description: The size of the shard's snapshot
        SnapshotCreationTime:
          type: string
          format: date-time
          description: The date and time that the shard's snapshot was created
    Snapshot:
      type: object
      properties:
        Name:
          type: string
          description: The name of the snapshot
        Status:
          type: string
          description: 'The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.'
        Source:
          type: string
          description: Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
        KmsKeyId:
          type: string
          description: The ID of the KMS key used to encrypt the snapshot.
        ARN:
          type: string
          description: The ARN (Amazon Resource Name) of the snapshot.
        ClusterConfiguration:
          $ref: '#/components/schemas/ClusterConfiguration'
        DataTiering:
          type: string
          enum:
          - 'true'
          - 'false'
          description: Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter
            must be set when using r6gd nodes. For more information, see Data tiering.
    SnapshotNotFoundFault:
      type: object
      properties:
        message:
          type: string
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The key for the tag. May not be null.
        Value:
          type: string
          description: The tag's value. May be null.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/memorydb/service/2021-01-01/memorydb-2021-01-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)