openapi: 3.1.0 info: title: Amazon Neptune Neptune Analytics 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 - name: Graphs description: Operations for managing Neptune Analytics graph resources - name: Import Tasks description: Operations for importing data into graphs - name: Private Graph Endpoints description: Operations for managing private graph endpoints in VPCs paths: /graphs: post: operationId: createGraph summary: Amazon Neptune Create a Neptune Analytics Graph description: >- Creates a new Neptune Analytics graph resource. The graph is a memory-optimized database instance optimized for analytical workloads with support for openCypher queries and vector search. tags: - Graphs requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateGraphInput' responses: '201': description: Graph created successfully. content: application/json: schema: $ref: '#/components/schemas/GraphOutput' examples: createGraph201Example: summary: Default createGraph 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 '400': description: Bad request - invalid parameters. '409': description: A graph with the specified name already exists. x-microcks-operation: delay: 0 dispatcher: FALLBACK get: operationId: listGraphs summary: Amazon Neptune List Neptune Analytics Graphs description: >- Returns a list of Neptune Analytics graph resources in the account. tags: - Graphs parameters: - name: maxResults in: query description: Maximum number of results to return. schema: type: integer minimum: 1 maximum: 100 - name: nextToken in: query description: Pagination token from a previous request. schema: type: string responses: '200': description: Graph list retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/ListGraphsOutput' examples: listGraphs200Example: summary: Default listGraphs 200 response x-microcks-default: true value: graphs: - id: neptune-cluster-abc123 name: my-neptune-cluster arn: arn:aws:neptune:us-east-1:123456789012:db:neptune-cluster-1 status: available provisionedMemory: 1 nextToken: example-value x-microcks-operation: delay: 0 dispatcher: FALLBACK /graphs/{graphIdentifier}: get: operationId: getGraph summary: Amazon Neptune Get Neptune Analytics Graph Details description: >- Returns detailed information about a specific Neptune Analytics graph resource. tags: - Graphs parameters: - name: graphIdentifier in: path required: true description: The unique identifier of the graph. schema: type: string responses: '200': description: Graph details retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/GraphOutput' examples: getGraph200Example: summary: Default getGraph 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 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 '404': description: Graph not found. x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: operationId: updateGraph summary: Amazon Neptune Update a Neptune Analytics Graph description: >- Updates the configuration of an existing Neptune Analytics graph, such as provisioned memory or deletion protection settings. tags: - Graphs parameters: - name: graphIdentifier in: path required: true description: The unique identifier of the graph. schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateGraphInput' responses: '200': description: Graph updated successfully. content: application/json: schema: $ref: '#/components/schemas/GraphOutput' examples: updateGraph200Example: summary: Default updateGraph 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 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 '404': description: Graph not found. x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: operationId: deleteGraph summary: Amazon Neptune Delete a Neptune Analytics Graph description: >- Deletes a Neptune Analytics graph resource. The graph must not have deletion protection enabled. tags: - Graphs parameters: - name: graphIdentifier in: path required: true description: The unique identifier of the graph to delete. schema: type: string - name: skipSnapshot in: query required: true description: Whether to skip creating a final snapshot before deletion. schema: type: boolean responses: '200': description: Graph deleted successfully. content: application/json: schema: $ref: '#/components/schemas/GraphOutput' examples: deleteGraph200Example: summary: Default deleteGraph 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 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 '404': description: Graph not found. '409': description: Graph has deletion protection enabled. x-microcks-operation: delay: 0 dispatcher: FALLBACK /graphs/{graphIdentifier}/reset: put: operationId: resetGraph summary: Amazon Neptune Reset a Neptune Analytics Graph description: >- Empties the data from a Neptune Analytics graph, removing all nodes and edges while preserving the graph resource and its configuration. tags: - Graphs parameters: - name: graphIdentifier in: path required: true description: The unique identifier of the graph to reset. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - performCleanData properties: performCleanData: type: boolean description: Must be set to true to confirm the reset. responses: '200': description: Graph reset initiated successfully. content: application/json: schema: $ref: '#/components/schemas/GraphOutput' examples: resetGraph200Example: summary: Default resetGraph 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 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 '404': description: Graph not found. x-microcks-operation: delay: 0 dispatcher: FALLBACK /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 /importtasks: post: operationId: createGraphUsingImportTask summary: Amazon Neptune Create a Graph Using an Import Task description: >- Creates a new Neptune Analytics graph and populates it with data from an Amazon S3 source in a single operation. tags: - Import Tasks requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateGraphUsingImportTaskInput' responses: '201': description: Import task created successfully. content: application/json: schema: $ref: '#/components/schemas/ImportTaskOutput' examples: createGraphUsingImportTask201Example: summary: Default createGraphUsingImportTask 201 response x-microcks-default: true value: graphId: neptune-cluster-abc123 taskId: neptune-cluster-abc123 source: example-value format: example-value roleArn: arn:aws:neptune:us-east-1:123456789012:db:neptune-cluster-1 status: INITIALIZING importOptions: {} importTaskDetails: status: available startTime: '2025-03-15T14:30:00Z' timeElapsedSeconds: 1 progressPercentage: 1 errorCount: 1 x-microcks-operation: delay: 0 dispatcher: FALLBACK get: operationId: listImportTasks summary: Amazon Neptune List Import Tasks description: >- Returns a list of import tasks in the account. tags: - Import Tasks parameters: - name: maxResults in: query schema: type: integer - name: nextToken in: query schema: type: string responses: '200': description: Import task list retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/ListImportTasksOutput' examples: listImportTasks200Example: summary: Default listImportTasks 200 response x-microcks-default: true value: tasks: - graphId: neptune-cluster-abc123 taskId: neptune-cluster-abc123 source: example-value format: example-value roleArn: arn:aws:neptune:us-east-1:123456789012:db:neptune-cluster-1 nextToken: example-value x-microcks-operation: delay: 0 dispatcher: FALLBACK /importtasks/{taskIdentifier}: get: operationId: getImportTask summary: Amazon Neptune Get Import Task Details description: >- Returns detailed information about a specific import task. tags: - Import Tasks parameters: - name: taskIdentifier in: path required: true description: The unique identifier of the import task. schema: type: string responses: '200': description: Import task details retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/ImportTaskOutput' examples: getImportTask200Example: summary: Default getImportTask 200 response x-microcks-default: true value: graphId: neptune-cluster-abc123 taskId: neptune-cluster-abc123 source: example-value format: example-value roleArn: arn:aws:neptune:us-east-1:123456789012:db:neptune-cluster-1 status: INITIALIZING importOptions: {} importTaskDetails: status: available startTime: '2025-03-15T14:30:00Z' timeElapsedSeconds: 1 progressPercentage: 1 errorCount: 1 '404': description: Import task not found. x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: operationId: cancelImportTask summary: Amazon Neptune Cancel an Import Task description: >- Cancels a running import task. tags: - Import Tasks parameters: - name: taskIdentifier in: path required: true description: The unique identifier of the import task to cancel. schema: type: string responses: '200': description: Import task cancelled successfully. '404': description: Import task not found. x-microcks-operation: delay: 0 dispatcher: FALLBACK /privategraphendpoints/{graphIdentifier}: post: operationId: createPrivateGraphEndpoint summary: Amazon Neptune Create a Private Graph Endpoint description: >- Creates a private graph endpoint in a VPC for accessing a Neptune Analytics graph without going over the public internet. tags: - Private Graph Endpoints parameters: - name: graphIdentifier in: path required: true description: The unique identifier of the graph. schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreatePrivateGraphEndpointInput' responses: '201': description: Private endpoint created successfully. content: application/json: schema: $ref: '#/components/schemas/PrivateGraphEndpointOutput' examples: createPrivateGraphEndpoint201Example: summary: Default createPrivateGraphEndpoint 201 response x-microcks-default: true value: vpcId: neptune-cluster-abc123 subnetIds: - example-value status: CREATING vpcEndpointId: neptune-cluster-abc123 x-microcks-operation: delay: 0 dispatcher: FALLBACK get: operationId: listPrivateGraphEndpoints summary: Amazon Neptune List Private Graph Endpoints description: >- Returns a list of private graph endpoints for a specific graph. tags: - Private Graph Endpoints parameters: - name: graphIdentifier in: path required: true schema: type: string - name: maxResults in: query schema: type: integer - name: nextToken in: query schema: type: string responses: '200': description: Private endpoint list retrieved successfully. x-microcks-operation: delay: 0 dispatcher: FALLBACK /privategraphendpoints/{graphIdentifier}/{vpcId}: get: operationId: getPrivateGraphEndpoint summary: Amazon Neptune Get Private Graph Endpoint Details description: >- Returns details of a specific private graph endpoint. tags: - Private Graph Endpoints parameters: - name: graphIdentifier in: path required: true schema: type: string - name: vpcId in: path required: true description: The VPC ID of the private endpoint. schema: type: string responses: '200': description: Private endpoint details retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/PrivateGraphEndpointOutput' examples: getPrivateGraphEndpoint200Example: summary: Default getPrivateGraphEndpoint 200 response x-microcks-default: true value: vpcId: neptune-cluster-abc123 subnetIds: - example-value status: CREATING vpcEndpointId: neptune-cluster-abc123 x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: operationId: deletePrivateGraphEndpoint summary: Amazon Neptune Delete a Private Graph Endpoint description: >- Deletes a private graph endpoint from a VPC. tags: - Private Graph Endpoints parameters: - name: graphIdentifier in: path required: true schema: type: string - name: vpcId in: path required: true schema: type: string responses: '200': description: Private endpoint deleted successfully. '404': description: Private endpoint not found. x-microcks-operation: delay: 0 dispatcher: FALLBACK components: securitySchemes: aws_sigv4: type: apiKey name: Authorization in: header description: AWS Signature Version 4 authentication schemas: CreateGraphInput: type: object required: - graphName - provisionedMemory properties: graphName: type: string description: The name of the graph (1-63 alphanumeric characters or hyphens). minLength: 1 maxLength: 63 provisionedMemory: type: integer description: The provisioned memory size in Neptune Capacity Units (NCUs). tags: type: object additionalProperties: type: string description: Tags to assign to the graph. publicConnectivity: type: boolean description: Whether the graph can be reached over the internet. default: false kmsKeyIdentifier: type: string description: KMS key identifier for encryption at rest. vectorSearchConfiguration: type: object description: Vector search configuration for the graph. properties: dimension: type: integer description: The number of dimensions for vector embeddings. replicaCount: type: integer description: The number of read replicas. default: 0 deletionProtection: type: boolean description: Whether deletion protection is enabled. default: false UpdateGraphInput: type: object properties: provisionedMemory: type: integer description: The new provisioned memory size in NCUs. deletionProtection: type: boolean description: Whether deletion protection is enabled. publicConnectivity: type: boolean 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 ListGraphsOutput: type: object properties: graphs: type: array items: type: object properties: id: type: string name: type: string arn: type: string status: type: string provisionedMemory: type: integer publicConnectivity: type: boolean endpoint: type: string replicaCount: type: integer deletionProtection: type: boolean nextToken: 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 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 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 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 CreateGraphUsingImportTaskInput: type: object required: - graphName - source - roleArn properties: graphName: type: string description: The name of the graph to create. source: type: string description: S3 URI of the source data to import. roleArn: type: string description: IAM role ARN with S3 access. provisionedMemory: type: integer format: type: string description: The format of the source data. enum: - CSV - OPEN_CYPHER - PARQUET - NTRIPLES tags: type: object additionalProperties: type: string deletionProtection: type: boolean publicConnectivity: type: boolean kmsKeyIdentifier: type: string vectorSearchConfiguration: type: object properties: dimension: type: integer replicaCount: type: integer importOptions: type: object description: Additional import configuration options. ImportTaskOutput: type: object properties: graphId: type: string taskId: type: string source: type: string format: type: string roleArn: type: string status: type: string enum: - INITIALIZING - EXPORTING - ANALYZING_DATA - IMPORTING - REPROVISIONING - ROLLING_BACK - SUCCEEDED - FAILED - CANCELLING - CANCELLED importOptions: type: object importTaskDetails: type: object properties: status: type: string startTime: type: string format: date-time timeElapsedSeconds: type: integer progressPercentage: type: integer errorCount: type: integer errorDetails: type: string statementCount: type: integer dictionaryEntryCount: type: integer ListImportTasksOutput: type: object properties: tasks: type: array items: type: object properties: graphId: type: string taskId: type: string source: type: string format: type: string roleArn: type: string status: type: string nextToken: type: string CreatePrivateGraphEndpointInput: type: object properties: vpcId: type: string description: The VPC ID for the private endpoint. subnetIds: type: array description: The subnet IDs for the private endpoint. items: type: string vpcSecurityGroupIds: type: array description: The security group IDs for the private endpoint. items: type: string PrivateGraphEndpointOutput: type: object properties: vpcId: type: string subnetIds: type: array items: type: string status: type: string enum: - CREATING - AVAILABLE - DELETING - FAILED vpcEndpointId: type: string