Amazon Neptune Graph Snapshots API

openapi: 3.1.0
info:
  title: Amazon Neptune Neptune Analytics ?Action=AddTagsToResource ?Action=AddTagsToResource Graph 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: Graph Snapshots
  description: Operations for managing graph snapshots
paths:
  /snapshots:
    post:
      operationId: createGraphSnapshot
      summary: Amazon Neptune Create a Graph Snapshot
      description: Creates a snapshot of a Neptune Analytics graph for backup purposes.
      tags:
      - Graph Snapshots
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGraphSnapshotInput'
      responses:
        '201':
          description: Snapshot created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphSnapshotOutput'
              examples:
                createGraphSnapshot201Example:
                  summary: Default createGraphSnapshot 201 response
                  x-microcks-default: true
                  value:
                    id: neptune-cluster-abc123
                    name: my-neptune-cluster
                    arn: arn:aws:neptune:us-east-1:123456789012:db:neptune-cluster-1
                    sourceGraphId: neptune-cluster-abc123
                    snapshotCreateTime: '2025-03-15T14:30:00Z'
                    status: CREATING
                    kmsKeyIdentifier: neptune-cluster-abc123
        '404':
          description: Source graph not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      operationId: listGraphSnapshots
      summary: Amazon Neptune List Graph Snapshots
      description: Returns a list of graph snapshots in the account.
      tags:
      - Graph Snapshots
      parameters:
      - name: graphIdentifier
        in: query
        description: Filter snapshots by source graph identifier.
        schema:
          type: string
      - name: maxResults
        in: query
        schema:
          type: integer
          minimum: 1
          maximum: 100
      - name: nextToken
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Snapshot list retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListGraphSnapshotsOutput'
              examples:
                listGraphSnapshots200Example:
                  summary: Default listGraphSnapshots 200 response
                  x-microcks-default: true
                  value:
                    graphSnapshots:
                    - id: neptune-cluster-abc123
                      name: my-neptune-cluster
                      arn: arn:aws:neptune:us-east-1:123456789012:db:neptune-cluster-1
                      sourceGraphId: neptune-cluster-abc123
                      snapshotCreateTime: '2025-03-15T14:30:00Z'
                    nextToken: example-value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /snapshots/{snapshotIdentifier}:
    get:
      operationId: getGraphSnapshot
      summary: Amazon Neptune Get Graph Snapshot Details
      description: Returns detailed information about a specific graph snapshot.
      tags:
      - Graph Snapshots
      parameters:
      - name: snapshotIdentifier
        in: path
        required: true
        description: The unique identifier of the snapshot.
        schema:
          type: string
      responses:
        '200':
          description: Snapshot details retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphSnapshotOutput'
              examples:
                getGraphSnapshot200Example:
                  summary: Default getGraphSnapshot 200 response
                  x-microcks-default: true
                  value:
                    id: neptune-cluster-abc123
                    name: my-neptune-cluster
                    arn: arn:aws:neptune:us-east-1:123456789012:db:neptune-cluster-1
                    sourceGraphId: neptune-cluster-abc123
                    snapshotCreateTime: '2025-03-15T14:30:00Z'
                    status: CREATING
                    kmsKeyIdentifier: neptune-cluster-abc123
        '404':
          description: Snapshot not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteGraphSnapshot
      summary: Amazon Neptune Delete a Graph Snapshot
      description: Deletes a Neptune Analytics graph snapshot.
      tags:
      - Graph Snapshots
      parameters:
      - name: snapshotIdentifier
        in: path
        required: true
        description: The unique identifier of the snapshot to delete.
        schema:
          type: string
      responses:
        '200':
          description: Snapshot deleted successfully.
        '404':
          description: Snapshot not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /snapshots/{snapshotIdentifier}/restore:
    post:
      operationId: restoreGraphFromSnapshot
      summary: Amazon Neptune Restore a Graph from a Snapshot
      description: Creates a new Neptune Analytics graph by restoring from an existing snapshot.
      tags:
      - Graph Snapshots
      parameters:
      - name: snapshotIdentifier
        in: path
        required: true
        description: The identifier of the snapshot to restore from.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestoreGraphFromSnapshotInput'
      responses:
        '201':
          description: Graph restore initiated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphOutput'
              examples:
                restoreGraphFromSnapshot201Example:
                  summary: Default restoreGraphFromSnapshot 201 response
                  x-microcks-default: true
                  value:
                    id: neptune-cluster-abc123
                    name: my-neptune-cluster
                    arn: arn:aws:neptune:us-east-1:123456789012:db:neptune-cluster-1
                    status: CREATING
                    statusReason: available
                    createTime: '2025-03-15T14:30:00Z'
                    provisionedMemory: 1
                    endpoint: neptune-cluster-1.cluster-xyz.us-east-1.neptune.amazonaws.com
                    publicConnectivity: true
                    vectorSearchConfiguration:
                      dimension: 1
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    RestoreGraphFromSnapshotInput:
      type: object
      required:
      - graphName
      properties:
        graphName:
          type: string
          description: The name of the restored graph.
        provisionedMemory:
          type: integer
        deletionProtection:
          type: boolean
        tags:
          type: object
          additionalProperties:
            type: string
        replicaCount:
          type: integer
        publicConnectivity:
          type: boolean
    GraphSnapshotOutput:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        arn:
          type: string
        sourceGraphId:
          type: string
        snapshotCreateTime:
          type: string
          format: date-time
        status:
          type: string
          enum:
          - CREATING
          - AVAILABLE
          - DELETING
          - FAILED
        kmsKeyIdentifier:
          type: string
    GraphOutput:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the graph.
        name:
          type: string
          description: The name of the graph.
        arn:
          type: string
          description: The ARN of the graph.
        status:
          type: string
          description: The current status of the graph.
          enum:
          - CREATING
          - AVAILABLE
          - DELETING
          - RESETTING
          - UPDATING
          - SNAPSHOTTING
          - FAILED
          - IMPORTING
        statusReason:
          type: string
        createTime:
          type: string
          format: date-time
        provisionedMemory:
          type: integer
        endpoint:
          type: string
          description: The DNS endpoint for the graph.
        publicConnectivity:
          type: boolean
        vectorSearchConfiguration:
          type: object
          properties:
            dimension:
              type: integer
        replicaCount:
          type: integer
        kmsKeyIdentifier:
          type: string
        sourceSnapshotId:
          type: string
        deletionProtection:
          type: boolean
        buildNumber:
          type: string
    CreateGraphSnapshotInput:
      type: object
      required:
      - graphIdentifier
      - snapshotName
      properties:
        graphIdentifier:
          type: string
          description: The identifier of the graph to snapshot.
        snapshotName:
          type: string
          description: The name of the snapshot.
        tags:
          type: object
          additionalProperties:
            type: string
    ListGraphSnapshotsOutput:
      type: object
      properties:
        graphSnapshots:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
              arn:
                type: string
              sourceGraphId:
                type: string
              snapshotCreateTime:
                type: string
                format: date-time
              status:
                type: string
        nextToken:
          type: string
  securitySchemes:
    aws_sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4 authentication