openapi: 3.1.0
info:
  title: Amazon Neptune Data API
  description: >-
    Amazon Neptune Data API provides SDK support for more than 40 data
    operations including data loading, query execution, data inquiry, and
    machine learning. It supports Gremlin and openCypher query languages
    and provides programmatic access to Neptune graph data through AWS SDKs.
  version: '2023-08-01'
  contact:
    name: Amazon Web Services
    url: https://docs.aws.amazon.com/neptune/latest/userguide/data-api.html
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://neptune-db.{region}.amazonaws.com
  description: Amazon Neptune Data API regional endpoint
  variables:
    region:
      default: us-east-1
      description: AWS region
security:
- aws_sigv4: []
tags:
- name: Gremlin
  description: Execute Gremlin graph traversal queries
- name: Loader
  description: Bulk data loading operations
- name: ML
  description: Machine learning operations
- name: openCypher
  description: Execute openCypher graph queries
- name: SPARQL
  description: Execute SPARQL queries against RDF data
- name: Status
  description: Query engine status and statistics
- name: Streams
  description: Change data capture stream operations
paths:
  /gremlin:
    post:
      operationId: executeGremlinQuery
      summary: Amazon Neptune Execute a Gremlin Query via the Data API
      description: >-
        Executes a Gremlin query against the Neptune graph database using the
        Data API. The query is submitted as a JSON payload and results are
        returned synchronously.
      tags:
      - Gremlin
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecuteGremlinQueryInput'
      responses:
        '200':
          description: Query executed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecuteGremlinQueryOutput'
              examples:
                executeGremlinQuery200Example:
                  summary: Default executeGremlinQuery 200 response
                  x-microcks-default: true
                  value:
                    requestId: neptune-cluster-abc123
                    status:
                      message: example-value
                      code: 1
                    result:
                      data: example-value
        '400':
          description: Bad request - malformed query or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                executeGremlinQuery400Example:
                  summary: Default executeGremlinQuery 400 response
                  x-microcks-default: true
                  value:
                    requestId: neptune-cluster-abc123
                    code: example-value
                    detailedMessage: example-value
        '408':
          description: Query timed out.
        '500':
          description: Internal server error.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /gremlin/explain:
    post:
      operationId: executeGremlinExplainQuery
      summary: Amazon Neptune Get the Execution Plan for a Gremlin Query
      description: >-
        Executes a Gremlin explain query against the Neptune graph database.
        Returns the query execution plan without actually running the query
        against the data.
      tags:
      - Gremlin
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecuteGremlinQueryInput'
      responses:
        '200':
          description: Explain query executed successfully.
          content:
            text/plain:
              schema:
                type: string
                description: The Gremlin query execution plan as text.
        '400':
          description: Bad request - malformed query.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /gremlin/profile:
    post:
      operationId: executeGremlinProfileQuery
      summary: Amazon Neptune Profile a Gremlin Query Execution
      description: >-
        Executes a Gremlin profile query against the Neptune graph database.
        Returns the query execution plan along with actual runtime statistics
        including execution time and intermediate result counts.
      tags:
      - Gremlin
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecuteGremlinProfileInput'
      responses:
        '200':
          description: Profile query executed successfully.
          content:
            text/plain:
              schema:
                type: string
                description: The Gremlin query profile with runtime statistics.
        '400':
          description: Bad request - malformed query.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /gremlin/status:
    get:
      operationId: getGremlinQueryStatus
      summary: Amazon Neptune Get the Status of Gremlin Queries
      description: >-
        Gets the status of running and waiting Gremlin queries. Returns a list
        of active queries with their query IDs and statuses.
      tags:
      - Gremlin
      responses:
        '200':
          description: Query status retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GremlinQueryStatusOutput'
              examples:
                getGremlinQueryStatus200Example:
                  summary: Default getGremlinQueryStatus 200 response
                  x-microcks-default: true
                  value:
                    acceptedQueryCount: 1
                    runningQueryCount: 1
                    queries:
                    - {}
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /gremlin/status/{queryId}:
    get:
      operationId: getGremlinQueryStatusById
      summary: Amazon Neptune Get the Status of a Specific Gremlin Query
      description: >-
        Gets the status of a specific Gremlin query by its query ID.
      tags:
      - Gremlin
      parameters:
      - name: queryId
        in: path
        required: true
        description: The unique identifier of the Gremlin query.
        schema:
          type: string
      responses:
        '200':
          description: Query status retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GremlinQueryStatus'
              examples:
                getGremlinQueryStatusById200Example:
                  summary: Default getGremlinQueryStatusById 200 response
                  x-microcks-default: true
                  value:
                    queryId: neptune-cluster-abc123
                    queryString: example-value
                    queryEvalStats:
                      waited: 1
                      elapsed: 1
                      cancelled: true
        '404':
          description: Query not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: cancelGremlinQuery
      summary: Amazon Neptune Cancel a Running Gremlin Query
      description: >-
        Cancels a running Gremlin query by its query ID.
      tags:
      - Gremlin
      parameters:
      - name: queryId
        in: path
        required: true
        description: The unique identifier of the Gremlin query to cancel.
        schema:
          type: string
      responses:
        '200':
          description: Query cancelled successfully.
        '404':
          description: Query not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /opencypher:
    post:
      operationId: executeOpenCypherQuery
      summary: Amazon Neptune Execute an OpenCypher Query via the Data API
      description: >-
        Executes an openCypher query against the Neptune property graph
        database using the Data API. Returns the results in JSON format.
      tags:
      - openCypher
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecuteOpenCypherQueryInput'
      responses:
        '200':
          description: Query executed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecuteOpenCypherQueryOutput'
              examples:
                executeOpenCypherQuery200Example:
                  summary: Default executeOpenCypherQuery 200 response
                  x-microcks-default: true
                  value:
                    results:
                    - {}
        '400':
          description: Bad request - malformed query or invalid parameters.
        '500':
          description: Internal server error.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /opencypher/explain:
    post:
      operationId: executeOpenCypherExplainQuery
      summary: Amazon Neptune Get the Execution Plan for an OpenCypher Query
      description: >-
        Executes an openCypher explain query. Returns the query execution
        plan without actually running the query against the data.
      tags:
      - openCypher
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecuteOpenCypherExplainInput'
      responses:
        '200':
          description: Explain plan returned successfully.
          content:
            text/plain:
              schema:
                type: string
        '400':
          description: Bad request - malformed query.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /opencypher/status:
    get:
      operationId: getOpenCypherQueryStatus
      summary: Amazon Neptune Get the Status of OpenCypher Queries
      description: >-
        Gets the status of running and waiting openCypher queries.
      tags:
      - openCypher
      responses:
        '200':
          description: Query status retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenCypherQueryStatusOutput'
              examples:
                getOpenCypherQueryStatus200Example:
                  summary: Default getOpenCypherQueryStatus 200 response
                  x-microcks-default: true
                  value:
                    acceptedQueryCount: 1
                    runningQueryCount: 1
                    queries:
                    - queryId: neptune-cluster-abc123
                      queryString: example-value
                      queryEvalStats: {}
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /opencypher/status/{queryId}:
    get:
      operationId: getOpenCypherQueryStatusById
      summary: Amazon Neptune Get the Status of a Specific OpenCypher Query
      description: >-
        Gets the status of a specific openCypher query by its query ID.
      tags:
      - openCypher
      parameters:
      - name: queryId
        in: path
        required: true
        description: The unique identifier of the openCypher query.
        schema:
          type: string
      responses:
        '200':
          description: Query status retrieved successfully.
        '404':
          description: Query not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: cancelOpenCypherQuery
      summary: Amazon Neptune Cancel a Running OpenCypher Query
      description: >-
        Cancels a running openCypher query by its query ID.
      tags:
      - openCypher
      parameters:
      - name: queryId
        in: path
        required: true
        description: The unique identifier of the openCypher query to cancel.
        schema:
          type: string
      responses:
        '200':
          description: Query cancelled successfully.
        '404':
          description: Query not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /sparql:
    post:
      operationId: executeSparqlQuery
      summary: Amazon Neptune Execute a SPARQL Query via the Data API
      description: >-
        Executes a SPARQL query against the Neptune RDF graph database using
        the Data API. Supports SELECT, ASK, CONSTRUCT, and DESCRIBE queries.
      tags:
      - SPARQL
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExecuteSparqlQueryInput'
      responses:
        '200':
          description: Query executed successfully.
          content:
            application/sparql-results+json:
              schema:
                $ref: '#/components/schemas/SparqlQueryOutput'
        '400':
          description: Bad request - malformed query.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /sparql/status:
    get:
      operationId: getSparqlQueryStatus
      summary: Amazon Neptune Get the Status of SPARQL Queries
      description: >-
        Gets the status of running and waiting SPARQL queries.
      tags:
      - SPARQL
      responses:
        '200':
          description: Query status retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  acceptedQueryCount:
                    type: integer
                  runningQueryCount:
                    type: integer
                  queries:
                    type: array
                    items:
                      type: object
              examples:
                getSparqlQueryStatus200Example:
                  summary: Default getSparqlQueryStatus 200 response
                  x-microcks-default: true
                  value:
                    acceptedQueryCount: 1
                    runningQueryCount: 1
                    queries:
                    - {}
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /status:
    get:
      operationId: getEngineStatus
      summary: Amazon Neptune Get Neptune Engine Status
      description: >-
        Returns the status of the Neptune DB instance including engine version,
        cluster role, and instance health information.
      tags:
      - Status
      responses:
        '200':
          description: Engine status retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EngineStatusOutput'
              examples:
                getEngineStatus200Example:
                  summary: Default getEngineStatus 200 response
                  x-microcks-default: true
                  value:
                    status: available
                    startTime: example-value
                    dbEngineVersion: 1.3.2.0
                    role: example-value
                    dfeQueryEngine: example-value
                    gremlin:
                      version: 1.3.2.0
                    sparql:
                      version: 1.3.2.0
                    opencypher:
                      version: 1.3.2.0
                    labMode: {}
                    features: {}
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /propertygraph/statistics:
    get:
      operationId: getPropertygraphStatistics
      summary: Amazon Neptune Get Property Graph Statistics
      description: >-
        Returns statistics for the property graph data stored in the Neptune
        database, including node and edge counts and label distributions.
      tags:
      - Status
      responses:
        '200':
          description: Statistics retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertygraphStatisticsOutput'
              examples:
                getPropertygraphStatistics200Example:
                  summary: Default getPropertygraphStatistics 200 response
                  x-microcks-default: true
                  value:
                    status: available
                    payload:
                      graphStatistics:
                        numNodes: 1
                        numEdges: 1
                        numNodeLabels: 1
                        numEdgeLabels: 1
                        numNodeProperties: 1
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: managePropertygraphStatistics
      summary: Amazon Neptune Manage Property Graph Statistics
      description: >-
        Starts or deletes statistics generation for the property graph data.
      tags:
      - Status
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                mode:
                  type: string
                  enum:
                  - disableAutoCompute
                  - enableAutoCompute
                  - refresh
      responses:
        '200':
          description: Statistics operation completed successfully.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /sparql/statistics:
    get:
      operationId: getSparqlStatistics
      summary: Amazon Neptune Get SPARQL RDF Statistics
      description: >-
        Returns statistics for the RDF data stored in the Neptune database,
        including triple counts and predicate distributions.
      tags:
      - Status
      responses:
        '200':
          description: Statistics retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SparqlStatisticsOutput'
              examples:
                getSparqlStatistics200Example:
                  summary: Default getSparqlStatistics 200 response
                  x-microcks-default: true
                  value:
                    status: available
                    payload:
                      graphStatistics:
                        numStatements: 1
                        numDistinctSubjects: 1
                        numDistinctPredicates: 1
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: manageSparqlStatistics
      summary: Amazon Neptune Manage SPARQL RDF Statistics
      description: >-
        Starts or deletes statistics generation for the RDF data.
      tags:
      - Status
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                mode:
                  type: string
                  enum:
                  - disableAutoCompute
                  - enableAutoCompute
                  - refresh
      responses:
        '200':
          description: Statistics operation completed successfully.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /loader:
    post:
      operationId: startLoaderJob
      summary: Amazon Neptune Start a Bulk Loader Job
      description: >-
        Initiates a bulk data loading job from Amazon S3 into the Neptune
        database. Supports CSV for property graphs and multiple RDF formats.
      tags:
      - Loader
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartLoaderJobInput'
      responses:
        '200':
          description: Loader job started successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartLoaderJobOutput'
              examples:
                startLoaderJob200Example:
                  summary: Default startLoaderJob 200 response
                  x-microcks-default: true
                  value:
                    status: available
                    payload:
                      loadId: neptune-cluster-abc123
        '400':
          description: Bad request - invalid parameters.
        '500':
          description: Internal server error.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      operationId: listLoaderJobs
      summary: Amazon Neptune List Bulk Loader Jobs
      description: >-
        Returns a list of Neptune bulk loader job IDs. Neptune tracks the
        most recent 1,024 bulk load jobs.
      tags:
      - Loader
      parameters:
      - name: limit
        in: query
        description: Maximum number of load IDs to return.
        schema:
          type: integer
      - name: includeQueuedLoads
        in: query
        description: Whether to include queued loads in the response.
        schema:
          type: boolean
      responses:
        '200':
          description: Loader job list retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  payload:
                    type: object
                    properties:
                      loadIds:
                        type: array
                        items:
                          type: string
              examples:
                listLoaderJobs200Example:
                  summary: Default listLoaderJobs 200 response
                  x-microcks-default: true
                  value:
                    status: available
                    payload:
                      loadIds:
                      - example-value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /loader/{loadId}:
    get:
      operationId: getLoaderJobStatus
      summary: Amazon Neptune Get the Status of a Bulk Loader Job
      description: >-
        Returns the status of a specific bulk loader job including overall
        progress and any error details.
      tags:
      - Loader
      parameters:
      - name: loadId
        in: path
        required: true
        description: The unique identifier of the load job.
        schema:
          type: string
      - name: details
        in: query
        description: Whether to include detailed status information.
        schema:
          type: boolean
      - name: errors
        in: query
        description: Whether to include error details.
        schema:
          type: boolean
      - name: page
        in: query
        description: Error page number to retrieve.
        schema:
          type: integer
      - name: errorsPerPage
        in: query
        description: Number of errors per page.
        schema:
          type: integer
      responses:
        '200':
          description: Loader job status retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoaderJobStatusOutput'
              examples:
                getLoaderJobStatus200Example:
                  summary: Default getLoaderJobStatus 200 response
                  x-microcks-default: true
                  value:
                    status: available
                    payload:
                      feedCount:
                      - {}
                      overallStatus:
                        fullUri: example-value
                        runNumber: 1
                        retryNumber: 1
                        status: available
                        totalTimeSpent: 1
        '404':
          description: Load job not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: cancelLoaderJob
      summary: Amazon Neptune Cancel a Bulk Loader Job
      description: >-
        Cancels an in-progress bulk loader job by its load ID.
      tags:
      - Loader
      parameters:
      - name: loadId
        in: path
        required: true
        description: The unique identifier of the load job to cancel.
        schema:
          type: string
      responses:
        '200':
          description: Loader job cancelled successfully.
        '404':
          description: Load job not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /propertygraph/stream:
    get:
      operationId: getPropertygraphStream
      summary: Amazon Neptune Get Property Graph Change Stream Records
      description: >-
        Gets a stream of change-log entries for property graph data. Each
        entry records a mutation (add, remove) made to the graph data.
      tags:
      - Streams
      parameters:
      - name: limit
        in: query
        description: Maximum number of records to return (1-100000, default 10).
        schema:
          type: integer
          minimum: 1
          maximum: 100000
          default: 10
      - name: iteratorType
        in: query
        description: >-
          The stream position to start reading from.
        schema:
          type: string
          enum:
          - AT_SEQUENCE_NUMBER
          - AFTER_SEQUENCE_NUMBER
          - TRIM_HORIZON
          - LATEST
      - name: commitNum
        in: query
        description: The commit number to start from.
        schema:
          type: integer
      - name: opNum
        in: query
        description: The operation sequence number within the commit.
        schema:
          type: integer
      responses:
        '200':
          description: Stream records retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertygraphStreamOutput'
              examples:
                getPropertygraphStream200Example:
                  summary: Default getPropertygraphStream 200 response
                  x-microcks-default: true
                  value:
                    lastEventId:
                      commitNum: 1
                      opNum: 1
                    lastTrxTimestampInMillis: 1
                    format: PG_JSON
                    records:
                    - {}
                    totalRecords: 1
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /sparql/stream:
    get:
      operationId: getSparqlStream
      summary: Amazon Neptune Get SPARQL RDF Change Stream Records
      description: >-
        Gets a stream of change-log entries for RDF data. Each entry records
        a mutation (add, remove) made to the RDF triples.
      tags:
      - Streams
      parameters:
      - name: limit
        in: query
        description: Maximum number of records to return (1-100000, default 10).
        schema:
          type: integer
          minimum: 1
          maximum: 100000
          default: 10
      - name: iteratorType
        in: query
        description: The stream position to start reading from.
        schema:
          type: string
          enum:
          - AT_SEQUENCE_NUMBER
          - AFTER_SEQUENCE_NUMBER
          - TRIM_HORIZON
          - LATEST
      - name: commitNum
        in: query
        description: The commit number to start from.
        schema:
          type: integer
      - name: opNum
        in: query
        description: The operation sequence number within the commit.
        schema:
          type: integer
      responses:
        '200':
          description: Stream records retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SparqlStreamOutput'
              examples:
                getSparqlStream200Example:
                  summary: Default getSparqlStream 200 response
                  x-microcks-default: true
                  value:
                    lastEventId:
                      commitNum: 1
                      opNum: 1
                    lastTrxTimestampInMillis: 1
                    format: NQUADS
                    records:
                    - commitTimestampInMillis: 1
                      eventId:
                        commitNum: {}
                        opNum: {}
                      data:
                        stmt: {}
                      op: ADD
                      isLastOp: true
                    totalRecords: 1
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ml/dataprocessing:
    post:
      operationId: startMLDataProcessingJob
      summary: Amazon Neptune Start an ML Data Processing Job
      description: >-
        Creates a new Neptune ML data processing job that prepares graph data
        for model training using Amazon SageMaker.
      tags:
      - ML
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartMLDataProcessingJobInput'
      responses:
        '200':
          description: Data processing job started successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
              examples:
                startMLDataProcessingJob200Example:
                  summary: Default startMLDataProcessingJob 200 response
                  x-microcks-default: true
                  value:
                    id: neptune-cluster-abc123
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      operationId: listMLDataProcessingJobs
      summary: Amazon Neptune List ML Data Processing Jobs
      description: >-
        Returns a list of active Neptune ML data processing job IDs.
      tags:
      - ML
      parameters:
      - name: maxItems
        in: query
        description: Maximum number of items to return (default 10, max 1024).
        schema:
          type: integer
          default: 10
          maximum: 1024
      - name: neptuneIamRoleArn
        in: query
        description: The ARN of the IAM role for Neptune access.
        schema:
          type: string
      responses:
        '200':
          description: Data processing job list retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ids:
                    type: array
                    items:
                      type: string
              examples:
                listMLDataProcessingJobs200Example:
                  summary: Default listMLDataProcessingJobs 200 response
                  x-microcks-default: true
                  value:
                    ids:
                    - example-value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ml/dataprocessing/{jobId}:
    get:
      operationId: getMLDataProcessingJobStatus
      summary: Amazon Neptune Get ML Data Processing Job Status
      description: >-
        Returns the status of a Neptune ML data processing job.
      tags:
      - ML
      parameters:
      - name: jobId
        in: path
        required: true
        description: The unique identifier of the data processing job.
        schema:
          type: string
      - name: neptuneIamRoleArn
        in: query
        description: The ARN of the IAM role for Neptune access.
        schema:
          type: string
      responses:
        '200':
          description: Job status retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MLJobStatusOutput'
              examples:
                getMLDataProcessingJobStatus200Example:
                  summary: Default getMLDataProcessingJobStatus 200 response
                  x-microcks-default: true
                  value:
                    status: available
                    id: neptune-cluster-abc123
                    processingJob:
                      name: my-neptune-cluster
                      arn: arn:aws:neptune:us-east-1:123456789012:db:neptune-cluster-1
                      status: available
                      outputLocation: example-value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: cancelMLDataProcessingJob
      summary: Amazon Neptune Cancel an ML Data Processing Job
      description: >-
        Cancels a running Neptune ML data processing job.
      tags:
      - ML
      parameters:
      - name: jobId
        in: path
        required: true
        description: The unique identifier of the data processing job.
        schema:
          type: string
      - name: clean
        in: query
        description: Whether to delete all S3 artifacts when cancelling.
        schema:
          type: boolean
          default: false
      - name: neptuneIamRoleArn
        in: query
        description: The ARN of the IAM role for Neptune access.
        schema:
          type: string
      responses:
        '200':
          description: Job cancelled successfully.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ml/modeltraining:
    post:
      operationId: startMLModelTrainingJob
      summary: Amazon Neptune Start an ML Model Training Job
      description: >-
        Creates a new Neptune ML model training job using Amazon SageMaker.
      tags:
      - ML
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartMLModelTrainingJobInput'
      responses:
        '200':
          description: Model training job started successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
              examples:
                startMLModelTrainingJob200Example:
                  summary: Default startMLModelTrainingJob 200 response
                  x-microcks-default: true
                  value:
                    id: neptune-cluster-abc123
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      operationId: listMLModelTrainingJobs
      summary: Amazon Neptune List ML Model Training Jobs
      description: >-
        Returns a list of active Neptune ML model training job IDs.
      tags:
      - ML
      parameters:
      - name: maxItems
        in: query
        schema:
          type: integer
          default: 10
          maximum: 1024
      - name: neptuneIamRoleArn
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Model training job list retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ids:
                    type: array
                    items:
                      type: string
              examples:
                listMLModelTrainingJobs200Example:
                  summary: Default listMLModelTrainingJobs 200 response
                  x-microcks-default: true
                  value:
                    ids:
                    - example-value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ml/modeltraining/{jobId}:
    get:
      operationId: getMLModelTrainingJobStatus
      summary: Amazon Neptune Get ML Model Training Job Status
      description: >-
        Returns the status of a Neptune ML model training job.
      tags:
      - ML
      parameters:
      - name: jobId
        in: path
        required: true
        schema:
          type: string
      - name: neptuneIamRoleArn
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Job status retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MLJobStatusOutput'
              examples:
                getMLModelTrainingJobStatus200Example:
                  summary: Default getMLModelTrainingJobStatus 200 response
                  x-microcks-default: true
                  value:
                    status: available
                    id: neptune-cluster-abc123
                    processingJob:
                      name: my-neptune-cluster
                      arn: arn:aws:neptune:us-east-1:123456789012:db:neptune-cluster-1
                      status: available
                      outputLocation: example-value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: cancelMLModelTrainingJob
      summary: Amazon Neptune Cancel an ML Model Training Job
      description: >-
        Cancels a running Neptune ML model training job.
      tags:
      - ML
      parameters:
      - name: jobId
        in: path
        required: true
        schema:
          type: string
      - name: clean
        in: query
        schema:
          type: boolean
          default: false
      - name: neptuneIamRoleArn
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Job cancelled successfully.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ml/modeltransform:
    post:
      operationId: startMLModelTransformJob
      summary: Amazon Neptune Start an ML Model Transform Job
      description: >-
        Creates a new Neptune ML model transform job that generates model
        artifacts for inference.
      tags:
      - ML
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartMLModelTransformJobInput'
      responses:
        '200':
          description: Model transform job started successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
              examples:
                startMLModelTransformJob200Example:
                  summary: Default startMLModelTransformJob 200 response
                  x-microcks-default: true
                  value:
                    id: neptune-cluster-abc123
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      operationId: listMLModelTransformJobs
      summary: Amazon Neptune List ML Model Transform Jobs
      description: >-
        Returns a list of active Neptune ML model transform job IDs.
      tags:
      - ML
      parameters:
      - name: maxItems
        in: query
        schema:
          type: integer
          default: 10
          maximum: 1024
      - name: neptuneIamRoleArn
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Model transform job list retrieved successfully.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ml/modeltransform/{jobId}:
    get:
      operationId: getMLModelTransformJobStatus
      summary: Amazon Neptune Get ML Model Transform Job Status
      description: >-
        Returns the status of a Neptune ML model transform job.
      tags:
      - ML
      parameters:
      - name: jobId
        in: path
        required: true
        schema:
          type: string
      - name: neptuneIamRoleArn
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Job status retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MLJobStatusOutput'
              examples:
                getMLModelTransformJobStatus200Example:
                  summary: Default getMLModelTransformJobStatus 200 response
                  x-microcks-default: true
                  value:
                    status: available
                    id: neptune-cluster-abc123
                    processingJob:
                      name: my-neptune-cluster
                      arn: arn:aws:neptune:us-east-1:123456789012:db:neptune-cluster-1
                      status: available
                      outputLocation: example-value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: cancelMLModelTransformJob
      summary: Amazon Neptune Cancel an ML Model Transform Job
      description: >-
        Cancels a running Neptune ML model transform job.
      tags:
      - ML
      parameters:
      - name: jobId
        in: path
        required: true
        schema:
          type: string
      - name: clean
        in: query
        schema:
          type: boolean
          default: false
      - name: neptuneIamRoleArn
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Job cancelled successfully.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ml/endpoints:
    post:
      operationId: createMLEndpoint
      summary: Amazon Neptune Create an ML Inference Endpoint
      description: >-
        Creates a new Neptune ML inference endpoint backed by Amazon SageMaker.
      tags:
      - ML
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateMLEndpointInput'
      responses:
        '200':
          description: Inference endpoint created successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
              examples:
                createMLEndpoint200Example:
                  summary: Default createMLEndpoint 200 response
                  x-microcks-default: true
                  value:
                    id: neptune-cluster-abc123
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      operationId: listMLEndpoints
      summary: Amazon Neptune List ML Inference Endpoints
      description: >-
        Returns a list of active Neptune ML inference endpoint IDs.
      tags:
      - ML
      parameters:
      - name: maxItems
        in: query
        schema:
          type: integer
          default: 10
          maximum: 1024
      - name: neptuneIamRoleArn
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Endpoint list retrieved successfully.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ml/endpoints/{endpointId}:
    get:
      operationId: getMLEndpointStatus
      summary: Amazon Neptune Get ML Inference Endpoint Status
      description: >-
        Returns the status of a Neptune ML inference endpoint.
      tags:
      - ML
      parameters:
      - name: endpointId
        in: path
        required: true
        schema:
          type: string
      - name: neptuneIamRoleArn
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Endpoint status retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MLEndpointStatusOutput'
              examples:
                getMLEndpointStatus200Example:
                  summary: Default getMLEndpointStatus 200 response
                  x-microcks-default: true
                  value:
                    status: available
                    id: neptune-cluster-abc123
                    endpoint:
                      name: my-neptune-cluster
                      arn: arn:aws:neptune:us-east-1:123456789012:db:neptune-cluster-1
                      status: available
                    endpointConfig: {}
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteMLEndpoint
      summary: Amazon Neptune Delete an ML Inference Endpoint
      description: >-
        Deletes a Neptune ML inference endpoint.
      tags:
      - ML
      parameters:
      - name: endpointId
        in: path
        required: true
        schema:
          type: string
      - name: clean
        in: query
        schema:
          type: boolean
          default: false
      - name: neptuneIamRoleArn
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Endpoint deleted successfully.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  securitySchemes:
    aws_sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4 authentication
  schemas:
    ErrorResponse:
      type: object
      properties:
        requestId:
          type: string
        code:
          type: string
        detailedMessage:
          type: string
    ExecuteGremlinQueryInput:
      type: object
      required:
      - gremlin
      properties:
        gremlin:
          type: string
          description: The Gremlin traversal query string to execute.
    ExecuteGremlinQueryOutput:
      type: object
      properties:
        requestId:
          type: string
        status:
          type: object
          properties:
            message:
              type: string
            code:
              type: integer
        result:
          type: object
          properties:
            data:
              description: The query result data.
    ExecuteGremlinProfileInput:
      type: object
      required:
      - gremlin
      properties:
        gremlin:
          type: string
          description: The Gremlin traversal query string to profile.
        results:
          type: boolean
          description: Whether to include results in the profile output.
        chop:
          type: integer
          description: Maximum length of result string per entry.
        serializer:
          type: string
          description: The serialization format for results.
        indexOps:
          type: boolean
          description: Whether to include index operation details.
    GremlinQueryStatusOutput:
      type: object
      properties:
        acceptedQueryCount:
          type: integer
        runningQueryCount:
          type: integer
        queries:
          type: array
          items:
            $ref: '#/components/schemas/GremlinQueryStatus'
    GremlinQueryStatus:
      type: object
      properties:
        queryId:
          type: string
        queryString:
          type: string
        queryEvalStats:
          type: object
          properties:
            waited:
              type: integer
            elapsed:
              type: integer
            cancelled:
              type: boolean
    ExecuteOpenCypherQueryInput:
      type: object
      required:
      - query
      properties:
        query:
          type: string
          description: The openCypher query string to execute.
        parameters:
          type: string
          description: >-
            The openCypher query parameters as a JSON-serialized string.
    ExecuteOpenCypherQueryOutput:
      type: object
      properties:
        results:
          type: array
          items:
            type: object
          description: The query result rows.
    ExecuteOpenCypherExplainInput:
      type: object
      required:
      - query
      properties:
        query:
          type: string
          description: The openCypher query to explain.
        parameters:
          type: string
        explainMode:
          type: string
          enum:
          - static
          - dynamic
          - details
          description: The explain mode (static, dynamic, or details).
    OpenCypherQueryStatusOutput:
      type: object
      properties:
        acceptedQueryCount:
          type: integer
        runningQueryCount:
          type: integer
        queries:
          type: array
          items:
            type: object
            properties:
              queryId:
                type: string
              queryString:
                type: string
              queryEvalStats:
                type: object
    ExecuteSparqlQueryInput:
      type: object
      properties:
        query:
          type: string
          description: The SPARQL query string (for SELECT, ASK, CONSTRUCT, DESCRIBE).
        update:
          type: string
          description: The SPARQL update string (for INSERT, DELETE operations).
    SparqlQueryOutput:
      type: object
      properties:
        head:
          type: object
          properties:
            vars:
              type: array
              items:
                type: string
        results:
          type: object
          properties:
            bindings:
              type: array
              items:
                type: object
    EngineStatusOutput:
      type: object
      properties:
        status:
          type: string
          description: The status of the Neptune engine (healthy, recovery, etc.).
        startTime:
          type: string
          description: The start time of the engine.
        dbEngineVersion:
          type: string
          description: The Neptune engine version.
        role:
          type: string
          description: The cluster role (writer or reader).
        dfeQueryEngine:
          type: string
          description: The DFE query engine status (enabled or viaQueryHint).
        gremlin:
          type: object
          properties:
            version:
              type: string
        sparql:
          type: object
          properties:
            version:
              type: string
        opencypher:
          type: object
          properties:
            version:
              type: string
        labMode:
          type: object
          additionalProperties:
            type: string
        features:
          type: object
          additionalProperties:
            type: object
    PropertygraphStatisticsOutput:
      type: object
      properties:
        status:
          type: string
        payload:
          type: object
          properties:
            graphStatistics:
              type: object
              properties:
                numNodes:
                  type: integer
                numEdges:
                  type: integer
                numNodeLabels:
                  type: integer
                numEdgeLabels:
                  type: integer
                numNodeProperties:
                  type: integer
                numEdgeProperties:
                  type: integer
    SparqlStatisticsOutput:
      type: object
      properties:
        status:
          type: string
        payload:
          type: object
          properties:
            graphStatistics:
              type: object
              properties:
                numStatements:
                  type: integer
                numDistinctSubjects:
                  type: integer
                numDistinctPredicates:
                  type: integer
    StartLoaderJobInput:
      type: object
      required:
      - source
      - format
      - iamRoleArn
      - region
      properties:
        source:
          type: string
          description: >-
            Amazon S3 URI identifying files or folders to load (s3://bucket/key).
        format:
          type: string
          description: The data format of the files to load.
          enum:
          - csv
          - opencypher
          - ntriples
          - nquads
          - rdfxml
          - turtle
        iamRoleArn:
          type: string
          description: The ARN of the IAM role with S3 access.
        region:
          type: string
          description: The AWS Region of the S3 bucket.
        mode:
          type: string
          description: The load mode.
          enum:
          - NEW
          - RESUME
          - AUTO
          default: AUTO
        failOnError:
          type: string
          description: Whether to stop the load job on error.
          enum:
          - 'TRUE'
          - 'FALSE'
          default: 'TRUE'
        parallelism:
          type: string
          description: The degree of parallelism for loading.
          enum:
          - LOW
          - MEDIUM
          - HIGH
          - OVERSUBSCRIBE
          default: HIGH
        parserConfiguration:
          type: object
          description: Optional parser configuration settings.
          properties:
            baseUri:
              type: string
            namedGraphUri:
              type: string
            allowEmptyStrings:
              type: boolean
        updateSingleCardinalityProperties:
          type: string
          description: Whether to update existing single-cardinality properties.
          enum:
          - 'TRUE'
          - 'FALSE'
          default: 'FALSE'
        queueRequest:
          type: string
          description: Whether to queue the request if a load is already running.
          enum:
          - 'TRUE'
          - 'FALSE'
          default: 'FALSE'
        dependencies:
          type: array
          description: Load job IDs that must complete before this job runs.
          items:
            type: string
        userProvidedEdgeIds:
          type: string
          description: For openCypher format, whether edge IDs are provided.
          enum:
          - 'TRUE'
          - 'FALSE'
    StartLoaderJobOutput:
      type: object
      properties:
        status:
          type: string
        payload:
          type: object
          properties:
            loadId:
              type: string
              description: The unique identifier for the load job.
    LoaderJobStatusOutput:
      type: object
      properties:
        status:
          type: string
        payload:
          type: object
          properties:
            feedCount:
              type: array
              items:
                type: object
            overallStatus:
              type: object
              properties:
                fullUri:
                  type: string
                runNumber:
                  type: integer
                retryNumber:
                  type: integer
                status:
                  type: string
                totalTimeSpent:
                  type: integer
                startTime:
                  type: integer
                totalRecords:
                  type: integer
                totalDuplicates:
                  type: integer
                parsingErrors:
                  type: integer
                datatypeMismatchErrors:
                  type: integer
                insertErrors:
                  type: integer
    PropertygraphStreamOutput:
      type: object
      properties:
        lastEventId:
          type: object
          properties:
            commitNum:
              type: integer
            opNum:
              type: integer
        lastTrxTimestampInMillis:
          type: integer
          description: Timestamp of the last transaction in milliseconds.
        format:
          type: string
          enum:
          - PG_JSON
        records:
          type: array
          items:
            $ref: '#/components/schemas/PropertygraphStreamRecord'
        totalRecords:
          type: integer
    PropertygraphStreamRecord:
      type: object
      properties:
        commitTimestampInMillis:
          type: integer
        eventId:
          type: object
          properties:
            commitNum:
              type: integer
            opNum:
              type: integer
        data:
          type: object
          properties:
            id:
              type: string
            type:
              type: string
              description: >-
                The type of the element (v=vertex, vl=vertex label,
                vp=vertex property, e=edge, ep=edge property).
            key:
              type: string
            value:
              type: object
              properties:
                value:
                  description: The property value.
                dataType:
                  type: string
            from:
              type: string
              description: Source vertex ID (for edges only).
            to:
              type: string
              description: Target vertex ID (for edges only).
        op:
          type: string
          enum:
          - ADD
          - REMOVE
        isLastOp:
          type: boolean
    SparqlStreamOutput:
      type: object
      properties:
        lastEventId:
          type: object
          properties:
            commitNum:
              type: integer
            opNum:
              type: integer
        lastTrxTimestampInMillis:
          type: integer
        format:
          type: string
          enum:
          - NQUADS
        records:
          type: array
          items:
            type: object
            properties:
              commitTimestampInMillis:
                type: integer
              eventId:
                type: object
                properties:
                  commitNum:
                    type: integer
                  opNum:
                    type: integer
              data:
                type: object
                properties:
                  stmt:
                    type: string
                    description: The N-Quads statement.
              op:
                type: string
                enum:
                - ADD
                - REMOVE
              isLastOp:
                type: boolean
        totalRecords:
          type: integer
    StartMLDataProcessingJobInput:
      type: object
      required:
      - inputDataS3Location
      - processedDataS3Location
      properties:
        id:
          type: string
          description: Unique identifier for the job (auto-generated if omitted).
        inputDataS3Location:
          type: string
          description: S3 URI for input data.
        processedDataS3Location:
          type: string
          description: S3 URI for output results.
        previousDataProcessingJobId:
          type: string
          description: Job ID of a previous job for incremental processing.
        sagemakerIamRoleArn:
          type: string
          description: IAM role ARN for SageMaker execution.
        neptuneIamRoleArn:
          type: string
          description: IAM role ARN for Neptune access.
        processingInstanceType:
          type: string
          description: ML instance type (default auto-selected ml.r5 type).
        processingInstanceVolumeSizeInGB:
          type: integer
          description: Disk volume size in GB (default 0 = auto-selected).
        processingTimeOutInSeconds:
          type: integer
          description: Timeout in seconds (default 86400).
        modelType:
          type: string
          description: Model type selection.
          enum:
          - heterogeneous
          - kge
        configFileName:
          type: string
          description: Data specification file name.
          default: training-data-configuration.json
        subnets:
          type: array
          items:
            type: string
          description: Subnet IDs in Neptune VPC.
        securityGroupIds:
          type: array
          items:
            type: string
          description: VPC security group IDs.
        volumeEncryptionKMSKey:
          type: string
        s3OutputEncryptionKMSKey:
          type: string
        enableInterContainerTrafficEncryption:
          type: boolean
          default: true
    StartMLModelTrainingJobInput:
      type: object
      required:
      - dataProcessingJobId
      - trainModelS3Location
      properties:
        id:
          type: string
        dataProcessingJobId:
          type: string
          description: Job ID of the completed data processing job.
        trainModelS3Location:
          type: string
          description: S3 location for model artifacts.
        previousModelTrainingJobId:
          type: string
        sagemakerIamRoleArn:
          type: string
        neptuneIamRoleArn:
          type: string
        modelName:
          type: string
          description: The model type to use.
          enum:
          - rgcn
          - transe
          - distmult
          - rotate
          - custom
        baseProcessingInstanceType:
          type: string
        trainingInstanceType:
          type: string
          default: ml.p3.2xlarge
        trainingInstanceVolumeSizeInGB:
          type: integer
        trainingTimeOutInSeconds:
          type: integer
          default: 86400
        maxHPONumberOfTrainingJobs:
          type: integer
          default: 2
        maxHPOParallelTrainingJobs:
          type: integer
          default: 2
        subnets:
          type: array
          items:
            type: string
        securityGroupIds:
          type: array
          items:
            type: string
        volumeEncryptionKMSKey:
          type: string
        s3OutputEncryptionKMSKey:
          type: string
        enableInterContainerTrafficEncryption:
          type: boolean
          default: true
        enableManagedSpotTraining:
          type: boolean
          default: false
        customModelTrainingParameters:
          type: object
          properties:
            sourceS3DirectoryPath:
              type: string
            trainingEntryPointScript:
              type: string
            transformEntryPointScript:
              type: string
    StartMLModelTransformJobInput:
      type: object
      required:
      - modelTransformOutputS3Location
      properties:
        id:
          type: string
        dataProcessingJobId:
          type: string
        mlModelTrainingJobId:
          type: string
        trainingJobName:
          type: string
        modelTransformOutputS3Location:
          type: string
          description: S3 location for transform output.
        sagemakerIamRoleArn:
          type: string
        neptuneIamRoleArn:
          type: string
        baseProcessingInstanceType:
          type: string
        baseProcessingInstanceVolumeSizeInGB:
          type: integer
        subnets:
          type: array
          items:
            type: string
        securityGroupIds:
          type: array
          items:
            type: string
        volumeEncryptionKMSKey:
          type: string
        s3OutputEncryptionKMSKey:
          type: string
        enableInterContainerTrafficEncryption:
          type: boolean
          default: true
        customModelTransformParameters:
          type: object
          properties:
            sourceS3DirectoryPath:
              type: string
            transformEntryPointScript:
              type: string
    CreateMLEndpointInput:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the endpoint.
        mlModelTrainingJobId:
          type: string
          description: Job ID from a completed training job.
        mlModelTransformJobId:
          type: string
          description: Job ID from a completed transform job.
        update:
          type: boolean
          description: Whether this is an update request.
          default: false
        neptuneIamRoleArn:
          type: string
        modelName:
          type: string
          enum:
          - rgcn
          - kge
          - transe
          - distmult
          - rotate
        instanceType:
          type: string
          default: ml.m5.xlarge
        instanceCount:
          type: integer
          default: 1
        volumeEncryptionKMSKey:
          type: string
    MLJobStatusOutput:
      type: object
      properties:
        status:
          type: string
        id:
          type: string
        processingJob:
          type: object
          properties:
            name:
              type: string
            arn:
              type: string
            status:
              type: string
            outputLocation:
              type: string
    MLEndpointStatusOutput:
      type: object
      properties:
        status:
          type: string
        id:
          type: string
        endpoint:
          type: object
          properties:
            name:
              type: string
            arn:
              type: string
            status:
              type: string
        endpointConfig:
          type: object