Amazon Neptune open Cypher API

openapi: 3.1.0
info:
  title: Amazon Neptune Open Cypher API
  version: '2014-10-31'
  description: Generated from AWS's published Smithy model for Amazon Neptune. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://neptune-db.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /opencypher/status/{queryId}:
    delete:
      operationId: CancelOpenCypherQuery
      summary: Cancel Open Cypher Query
      description: Cancels a specified openCypher query. See Neptune openCypher status endpoint for more information. When
        invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the
        request must have a policy attached that allows the neptune-db:CancelQuery IAM action in that cluster.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelOpenCypherQueryOutput'
        '400':
          description: BadRequestException; ConstraintViolationException; IllegalArgumentException; InvalidArgumentException;
            InvalidNumericDataException; InvalidParameterException; MissingParameterException; ParsingException; PreconditionsFailedException;
            UnsupportedOperationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '408':
          description: ClientTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientTimeoutException'
        '500':
          description: ConcurrentModificationException; FailureByQueryException; TimeLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelOpenCypherQueryInput'
      tags:
      - Open Cypher
    get:
      operationId: GetOpenCypherQueryStatus
      summary: Get Open Cypher Query Status
      description: Retrieves the status of a specified openCypher query. When invoking this operation in a Neptune cluster
        that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows
        the neptune-db:GetQueryStatus IAM action in that cluster. Note that the neptune-db:QueryLanguage:OpenCypher IAM condition
        key can be used in the policy document to restrict the use of openCypher queries (see Condition keys available in
        Neptune IAM data-access policy statements).
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOpenCypherQueryStatusOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NeptuneDbAccessDeniedException'
        '400':
          description: BadRequestException; ConstraintViolationException; IllegalArgumentException; InvalidArgumentException;
            InvalidNumericDataException; InvalidParameterException; MissingParameterException; ParsingException; PreconditionsFailedException;
            ReadOnlyViolationException; UnsupportedOperationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '408':
          description: ClientTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientTimeoutException'
        '500':
          description: ConcurrentModificationException; FailureByQueryException; TimeLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetOpenCypherQueryStatusInput'
      tags:
      - Open Cypher
  /opencypher/explain:
    post:
      operationId: ExecuteOpenCypherExplainQuery
      summary: Execute Open Cypher Explain Query
      description: Executes an openCypher explain request. See The openCypher explain feature for more information. When invoking
        this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must
        have a policy attached that allows the neptune-db:ReadDataViaQuery IAM action in that cluster. Note that the neptune-db:QueryLanguage:OpenCypher
        IAM condition key can be used in the policy document to restrict the use of openCypher queries (see Condition keys
        available in Neptune IAM data-access policy statements).
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecuteOpenCypherExplainQueryOutput'
        '400':
          description: BadRequestException; ConstraintViolationException; IllegalArgumentException; InvalidArgumentException;
            InvalidNumericDataException; InvalidParameterException; MalformedQueryException; MissingParameterException; ParsingException;
            PreconditionsFailedException; QueryLimitException; QueryTooLargeException; UnsupportedOperationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: CancelledByMaintenanceException; CancelledByUserException; ConcurrentModificationException; FailureByQueryException;
            MemoryLimitExceededException; QueryLimitExceededException; TimeLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelledByMaintenanceException'
        '408':
          description: ClientTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientTimeoutException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecuteOpenCypherExplainQueryInput'
      tags:
      - Open Cypher
  /opencypher:
    post:
      operationId: ExecuteOpenCypherQuery
      summary: Execute Open Cypher Query
      description: 'Executes an openCypher query. See Accessing the Neptune Graph with openCypher for more information. Neptune
        supports building graph applications using openCypher, which is currently one of the most popular query languages
        among developers working with graph databases. Developers, business analysts, and data scientists like openCypher''s
        declarative, SQL-inspired syntax because it provides a familiar structure in which to querying property graphs. The
        openCypher language was originally developed by Neo4j, then open-sourced in 2015 and contributed to the openCypher
        project under an Apache 2 open-source license. Note that when invoking this operation in a Neptune cluster that has
        IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows one of
        the following IAM actions in that cluster, depending on the query: neptune-db:ReadDataViaQuery neptune-db:WriteDataViaQuery
        neptune-db:DeleteDataViaQuery Note also that the neptune-db:QueryLanguage:OpenCypher IAM condition key can be used
        in the policy document to restrict the use of openCypher queries (see Condition keys available in Neptune IAM data-access
        policy statements).'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecuteOpenCypherQueryOutput'
        '400':
          description: BadRequestException; ConstraintViolationException; IllegalArgumentException; InvalidArgumentException;
            InvalidNumericDataException; InvalidParameterException; MalformedQueryException; MissingParameterException; ParsingException;
            PreconditionsFailedException; QueryLimitException; QueryTooLargeException; UnsupportedOperationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: CancelledByMaintenanceException; CancelledByUserException; ConcurrentModificationException; FailureByQueryException;
            MemoryLimitExceededException; QueryLimitExceededException; TimeLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelledByMaintenanceException'
        '408':
          description: ClientTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientTimeoutException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecuteOpenCypherQueryInput'
      tags:
      - Open Cypher
  /opencypher/status:
    get:
      operationId: ListOpenCypherQueries
      summary: List Open Cypher Queries
      description: Lists active openCypher queries. See Neptune openCypher status endpoint for more information. When invoking
        this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must
        have a policy attached that allows the neptune-db:GetQueryStatus IAM action in that cluster. Note that the neptune-db:QueryLanguage:OpenCypher
        IAM condition key can be used in the policy document to restrict the use of openCypher queries (see Condition keys
        available in Neptune IAM data-access policy statements).
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListOpenCypherQueriesOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NeptuneDbAccessDeniedException'
        '400':
          description: BadRequestException; ConstraintViolationException; IllegalArgumentException; InvalidArgumentException;
            InvalidNumericDataException; InvalidParameterException; MissingParameterException; ParsingException; PreconditionsFailedException;
            ReadOnlyViolationException; UnsupportedOperationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '408':
          description: ClientTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientTimeoutException'
        '500':
          description: ConcurrentModificationException; FailureByQueryException; TimeLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListOpenCypherQueriesInput'
      tags:
      - Open Cypher
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: neptune-db
  schemas:
    BadRequestException:
      type: object
      properties:
        detailedMessage:
          type: string
          description: A detailed message describing the problem.
        requestId:
          type: string
          description: The ID of the bad request.
        code:
          type: string
          description: The HTTP status code returned with the exception.
      required:
      - detailedMessage
      - requestId
      - code
    CancelOpenCypherQueryInput:
      type: object
      properties:
        queryId:
          type: string
          description: The unique ID of the openCypher query to cancel.
        silent:
          type: boolean
          description: If set to TRUE, causes the cancelation of the openCypher query to happen silently.
      required:
      - queryId
    CancelOpenCypherQueryOutput:
      type: object
      properties:
        status:
          type: string
          description: The cancellation status of the openCypher query.
        payload:
          type: boolean
          description: The cancelation payload for the openCypher query.
    CancelledByMaintenanceException:
      type: object
      properties:
        detailedMessage:
          type: string
          description: A detailed message describing the problem.
        requestId:
          type: string
          description: The ID of the request in question.
        code:
          type: string
          description: The HTTP status code returned with the exception.
      required:
      - detailedMessage
      - requestId
      - code
    ClientTimeoutException:
      type: object
      properties:
        detailedMessage:
          type: string
          description: A detailed message describing the problem.
        requestId:
          type: string
          description: The ID of the request in question.
        code:
          type: string
          description: The HTTP status code returned with the exception.
      required:
      - detailedMessage
      - requestId
      - code
    ConcurrentModificationException:
      type: object
      properties:
        detailedMessage:
          type: string
          description: A detailed message describing the problem.
        requestId:
          type: string
          description: The ID of the request in question.
        code:
          type: string
          description: The HTTP status code returned with the exception.
      required:
      - detailedMessage
      - requestId
      - code
    ExecuteOpenCypherExplainQueryInput:
      type: object
      properties:
        openCypherQuery:
          type: string
          description: The openCypher query string.
        parameters:
          type: string
          description: The openCypher query parameters.
        explainMode:
          type: string
          enum:
          - static
          - dynamic
          - details
          description: 'The openCypher explain mode. Can be one of: static, dynamic, or details.'
      required:
      - openCypherQuery
      - explainMode
    ExecuteOpenCypherExplainQueryOutput:
      type: object
      properties:
        results:
          type: string
          description: A text blob containing the openCypher explain results.
      required:
      - results
    ExecuteOpenCypherQueryInput:
      type: object
      properties:
        openCypherQuery:
          type: string
          description: The openCypher query string to be executed.
        parameters:
          type: string
          description: The openCypher query parameters for query execution. See Examples of openCypher parameterized queries
            for more information.
      required:
      - openCypherQuery
    ExecuteOpenCypherQueryOutput:
      type: object
      properties:
        results:
          type: object
          description: The openCypherquery results.
      required:
      - results
    GetOpenCypherQueryStatusInput:
      type: object
      properties:
        queryId:
          type: string
          description: The unique ID of the openCypher query for which to retrieve the query status.
      required:
      - queryId
    GetOpenCypherQueryStatusOutput:
      type: object
      properties:
        queryId:
          type: string
          description: The unique ID of the query for which status is being returned.
        queryString:
          type: string
          description: The openCypher query string.
        queryEvalStats:
          $ref: '#/components/schemas/QueryEvalStats'
    GremlinQueryStatus:
      type: object
      properties:
        queryId:
          type: string
          description: The ID of the Gremlin query.
        queryString:
          type: string
          description: The query string of the Gremlin query.
        queryEvalStats:
          $ref: '#/components/schemas/QueryEvalStats'
    ListOpenCypherQueriesInput:
      type: object
      properties:
        includeWaiting:
          type: boolean
          description: When set to TRUE and other parameters are not present, causes status information to be returned for
            waiting queries as well as for running queries.
    ListOpenCypherQueriesOutput:
      type: object
      properties:
        acceptedQueryCount:
          type: integer
          description: The number of queries that have been accepted but not yet completed, including queries in the queue.
        runningQueryCount:
          type: integer
          description: The number of currently running openCypher queries.
        queries:
          type: array
          items:
            $ref: '#/components/schemas/GremlinQueryStatus'
          description: A list of current openCypher queries.
    NeptuneDbAccessDeniedException:
      type: object
      properties:
        detailedMessage:
          type: string
          description: A detailed message describing the problem.
        requestId:
          type: string
          description: The ID of the request in question.
        code:
          type: string
          description: The HTTP status code returned with the exception.
      required:
      - detailedMessage
      - requestId
      - code
    QueryEvalStats:
      type: object
      properties:
        waited:
          type: integer
          description: Indicates how long the query waited, in milliseconds.
        elapsed:
          type: integer
          description: The number of milliseconds the query has been running so far.
        cancelled:
          type: boolean
          description: Set to TRUE if the query was cancelled, or FALSE otherwise.
        subqueries:
          type: object
          description: The number of subqueries in this query.
    TooManyRequestsException:
      type: object
      properties:
        detailedMessage:
          type: string
          description: A detailed message describing the problem.
        requestId:
          type: string
          description: The ID of the request that could not be processed for this reason.
        code:
          type: string
          description: The HTTP status code returned with the exception.
      required:
      - detailedMessage
      - requestId
      - code
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/neptunedata/service/2023-08-01/neptunedata-2023-08-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)