Amazon Neptune Snapshots API

openapi: 3.1.0
info:
  title: Amazon Neptune Neptune Analytics ?Action=AddTagsToResource ?Action=AddTagsToResource Snapshots API
  description: Neptune Analytics is a memory-optimized graph database engine for analytics, providing optimized graph analytic algorithms, low-latency queries, and vector search capabilities within graph traversals. This API provides management operations for Neptune Analytics graph resources including creating, managing, and querying graph databases optimized for analytical workloads.
  version: '2023-11-29'
  contact:
    name: Amazon Web Services
    url: https://docs.aws.amazon.com/neptune-analytics/latest/userguide/what-is-neptune-analytics.html
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://neptune-graph.{region}.amazonaws.com
  description: Neptune Analytics control plane regional endpoint
  variables:
    region:
      default: us-east-1
      description: AWS region
security:
- aws_sigv4: []
tags:
- name: Snapshots
  description: Operations for managing cluster snapshots
paths:
  /?Action=CreateDBClusterSnapshot:
    post:
      operationId: createDBClusterSnapshot
      summary: Amazon Neptune Create a Snapshot of a Neptune DB Cluster
      description: Creates a snapshot of a DB cluster. Manual snapshots can be used to restore a DB cluster to a specific state.
      tags:
      - Snapshots
      parameters:
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - CreateDBClusterSnapshot
      - name: DBClusterIdentifier
        in: query
        required: true
        description: The identifier of the DB cluster to create a snapshot for.
        schema:
          type: string
      - name: DBClusterSnapshotIdentifier
        in: query
        required: true
        description: The identifier for the DB cluster snapshot.
        schema:
          type: string
      - name: Version
        in: query
        required: true
        schema:
          type: string
          default: '2014-10-31'
      responses:
        '200':
          description: DB cluster snapshot created successfully.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/DBClusterSnapshot'
              examples:
                createDBClusterSnapshot200Example:
                  summary: Default createDBClusterSnapshot 200 response
                  x-microcks-default: true
                  value:
                    DBClusterSnapshotIdentifier: neptune-cluster-abc123
                    DBClusterIdentifier: neptune-cluster-abc123
                    SnapshotCreateTime: '2025-03-15T14:30:00Z'
                    Engine: example-value
                    EngineVersion: 1.3.2.0
                    Status: available
                    AllocatedStorage: 1
                    VpcId: neptune-cluster-abc123
                    Port: 1
                    StorageEncrypted: true
        '404':
          description: The specified DB cluster was not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=DescribeDBClusterSnapshots:
    get:
      operationId: describeDBClusterSnapshots
      summary: Amazon Neptune Describe Neptune DB Cluster Snapshots
      description: Returns information about DB cluster snapshots. If a specific snapshot identifier is supplied, details for that snapshot are returned.
      tags:
      - Snapshots
      parameters:
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - DescribeDBClusterSnapshots
      - name: DBClusterSnapshotIdentifier
        in: query
        description: The identifier of a specific snapshot to describe.
        schema:
          type: string
      - name: DBClusterIdentifier
        in: query
        description: The identifier of the cluster to filter snapshots by.
        schema:
          type: string
      - name: MaxRecords
        in: query
        description: Maximum number of records to include in the response.
        schema:
          type: integer
      - name: Marker
        in: query
        description: Pagination token from a previous request.
        schema:
          type: string
      - name: Version
        in: query
        required: true
        schema:
          type: string
          default: '2014-10-31'
      responses:
        '200':
          description: Successful response with snapshot details.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/DescribeDBClusterSnapshotsResponse'
              examples:
                describeDBClusterSnapshots200Example:
                  summary: Default describeDBClusterSnapshots 200 response
                  x-microcks-default: true
                  value:
                    DBClusterSnapshots:
                    - {}
                    Marker: example-value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=DeleteDBClusterSnapshot:
    post:
      operationId: deleteDBClusterSnapshot
      summary: Amazon Neptune Delete a Neptune DB Cluster Snapshot
      description: Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
      tags:
      - Snapshots
      parameters:
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - DeleteDBClusterSnapshot
      - name: DBClusterSnapshotIdentifier
        in: query
        required: true
        description: The identifier of the cluster snapshot to delete.
        schema:
          type: string
      - name: Version
        in: query
        required: true
        schema:
          type: string
          default: '2014-10-31'
      responses:
        '200':
          description: DB cluster snapshot deleted successfully.
        '404':
          description: The specified snapshot was not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=RestoreDBClusterFromSnapshot:
    post:
      operationId: restoreDBClusterFromSnapshot
      summary: Amazon Neptune Restore a Neptune DB Cluster from a Snapshot
      description: Creates a new DB cluster from a DB snapshot or DB cluster snapshot. The new DB cluster is created from the source snapshot with a default configuration.
      tags:
      - Snapshots
      parameters:
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - RestoreDBClusterFromSnapshot
      - name: Version
        in: query
        required: true
        schema:
          type: string
          default: '2014-10-31'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RestoreDBClusterFromSnapshotRequest'
      responses:
        '200':
          description: DB cluster restore initiated successfully.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/DBCluster'
              examples:
                restoreDBClusterFromSnapshot200Example:
                  summary: Default restoreDBClusterFromSnapshot 200 response
                  x-microcks-default: true
                  value:
                    DBClusterIdentifier: neptune-cluster-abc123
                    DBClusterArn: arn:aws:neptune:us-east-1:123456789012:db:neptune-cluster-1
                    Status: available
                    Engine: example-value
                    EngineVersion: 1.3.2.0
                    Endpoint: neptune-cluster-1.cluster-xyz.us-east-1.neptune.amazonaws.com
                    ReaderEndpoint: neptune-cluster-1.cluster-xyz.us-east-1.neptune.amazonaws.com
                    Port: 1
                    MasterUsername: my-neptune-cluster
                    DBClusterParameterGroup: example-value
        '404':
          description: The specified snapshot was not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    DescribeDBClusterSnapshotsResponse:
      type: object
      properties:
        DBClusterSnapshots:
          type: array
          items:
            $ref: '#/components/schemas/DBClusterSnapshot'
        Marker:
          type: string
    DBClusterMember:
      type: object
      description: A member instance of a Neptune DB cluster.
      properties:
        DBInstanceIdentifier:
          type: string
          description: The instance identifier.
        IsClusterWriter:
          type: boolean
          description: Whether the instance is the primary (writer) instance.
        DBClusterParameterGroupStatus:
          type: string
          description: The status of the parameter group for this member.
        PromotionTier:
          type: integer
          description: Failover priority for the instance.
    DBCluster:
      type: object
      description: Contains the details of an Amazon Neptune DB cluster.
      properties:
        DBClusterIdentifier:
          type: string
          description: The user-supplied DB cluster identifier.
        DBClusterArn:
          type: string
          description: The Amazon Resource Name (ARN) for the DB cluster.
        Status:
          type: string
          description: Current state of the cluster.
        Engine:
          type: string
          description: The database engine (neptune).
        EngineVersion:
          type: string
          description: The version of the database engine.
        Endpoint:
          type: string
          description: The connection endpoint for the primary instance.
        ReaderEndpoint:
          type: string
          description: The reader endpoint for read replicas.
        Port:
          type: integer
          description: The port that the DB cluster listens on.
        MasterUsername:
          type: string
          description: The master username for the cluster.
        DBClusterParameterGroup:
          type: string
          description: The name of the DB cluster parameter group.
        DBSubnetGroup:
          type: string
          description: The DB subnet group associated with the cluster.
        AllocatedStorage:
          type: integer
          description: The allocated storage size in gigabytes.
        ClusterCreateTime:
          type: string
          format: date-time
          description: The time when the DB cluster was created.
        PreferredBackupWindow:
          type: string
          description: The daily time range for automated backups.
        PreferredMaintenanceWindow:
          type: string
          description: The weekly time range for system maintenance.
        MultiAZ:
          type: boolean
          description: Whether the cluster is Multi-AZ enabled.
        StorageEncrypted:
          type: boolean
          description: Whether the cluster storage is encrypted.
        KmsKeyId:
          type: string
          description: The KMS key identifier for encrypted clusters.
        DeletionProtection:
          type: boolean
          description: Whether deletion protection is enabled.
        IAMDatabaseAuthenticationEnabled:
          type: boolean
          description: Whether IAM database authentication is enabled.
        DBClusterMembers:
          type: array
          description: The list of instances in the cluster.
          items:
            $ref: '#/components/schemas/DBClusterMember'
        AssociatedRoles:
          type: array
          description: IAM roles associated with the cluster.
          items:
            $ref: '#/components/schemas/DBClusterRole'
    RestoreDBClusterFromSnapshotRequest:
      type: object
      required:
      - DBClusterIdentifier
      - SnapshotIdentifier
      - Engine
      properties:
        DBClusterIdentifier:
          type: string
          description: The name of the new DB cluster.
        SnapshotIdentifier:
          type: string
          description: The identifier of the snapshot to restore from.
        Engine:
          type: string
          description: The database engine to use.
          default: neptune
        EngineVersion:
          type: string
        Port:
          type: integer
        DBSubnetGroupName:
          type: string
        VpcSecurityGroupIds:
          type: array
          items:
            type: string
        DeletionProtection:
          type: boolean
        IAMDatabaseAuthenticationEnabled:
          type: boolean
    DBClusterRole:
      type: object
      description: An IAM role associated with a Neptune DB cluster.
      properties:
        RoleArn:
          type: string
          description: The ARN of the IAM role.
        Status:
          type: string
          description: The status of the association (active, pending, error).
    DBClusterSnapshot:
      type: object
      description: Contains the details of a Neptune DB cluster snapshot.
      properties:
        DBClusterSnapshotIdentifier:
          type: string
          description: The identifier of the cluster snapshot.
        DBClusterIdentifier:
          type: string
          description: The cluster identifier of the source cluster.
        SnapshotCreateTime:
          type: string
          format: date-time
        Engine:
          type: string
        EngineVersion:
          type: string
        Status:
          type: string
          description: The status of the snapshot.
        AllocatedStorage:
          type: integer
        VpcId:
          type: string
        Port:
          type: integer
        StorageEncrypted:
          type: boolean
        KmsKeyId:
          type: string
        DBClusterSnapshotArn:
          type: string
        SnapshotType:
          type: string
          description: The type of the snapshot (manual or automated).
  securitySchemes:
    aws_sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4 authentication