Amazon Neptune Neptune Storage API

openapi: 3.1.0
info:
  title: Amazon Neptune Storage API
  version: '2014-10-31'
  description: Generated from AWS's published Smithy model for Amazon Neptune. 4 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:
  /storage/indexes/rebuilds/{rebuildId}:
    get:
      operationId: GetIndexRebuildStatus
      summary: Get Index Rebuild Status
      description: Retrieves the status of an index rebuild operation. 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:GetIndexRebuildStatus IAM action in that cluster.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetIndexRebuildStatusOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NeptuneDbAccessDeniedException'
        '408':
          description: ClientTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientTimeoutException'
        '400':
          description: ConstraintViolationException; IllegalArgumentException; InvalidArgumentException; InvalidParameterException;
            PreconditionsFailedException; UnsupportedOperationException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConstraintViolationException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '405':
          description: MethodNotAllowedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MethodNotAllowedException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetIndexRebuildStatusInput'
      tags:
      - Storage
  /storage/info:
    get:
      operationId: GetStorageInfo
      summary: Get Storage Info
      description: 'Retrieves storage information for the Neptune database instance, including approximate total storage used
        and per-category size and entry counts. Storage categories include: Quad indexes - the indexes that store graph data,
        for both RDF (SPARQL) and Property Graph (Gremlin/openCypher) models. Dictionaries - the term dictionaries, including
        total dictionary storage and the portion used by blob (large value) entries. Undo logs - the undo logs, reported as
        a total size and the number of entries in the undo log list. Streams - the change-log streams. Schema - the schema.
        DFE statistics - the DFE engine statistics. System metadata - internal system metadata. 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:GetStorageInfo IAM action in that cluster.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetStorageOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NeptuneDbAccessDeniedException'
        '408':
          description: ClientTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientTimeoutException'
        '400':
          description: ConstraintViolationException; IllegalArgumentException; InvalidArgumentException; InvalidParameterException;
            PreconditionsFailedException; UnsupportedOperationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConstraintViolationException'
        '500':
          description: InternalFailureException; ServerShutdownException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '405':
          description: MethodNotAllowedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MethodNotAllowedException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              type: string
      tags:
      - Storage
  /storage/indexes/rebuilds:
    get:
      operationId: ListIndexRebuilds
      summary: List Index Rebuilds
      description: Retrieves a list of all index rebuild operation identifiers. 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:ListIndexRebuilds IAM action in that cluster.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListIndexRebuildsOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NeptuneDbAccessDeniedException'
        '408':
          description: ClientTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientTimeoutException'
        '400':
          description: ConstraintViolationException; IllegalArgumentException; InvalidArgumentException; InvalidParameterException;
            PreconditionsFailedException; UnsupportedOperationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConstraintViolationException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '405':
          description: MethodNotAllowedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MethodNotAllowedException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              type: string
      tags:
      - Storage
    post:
      operationId: StartIndexRebuild
      summary: Start Index Rebuild
      description: Initiates an index rebuild operation to optimize storage and improve query performance. The rebuild operation
        reorganizes index to reclaim space and improve efficiency. 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:StartIndexRebuild IAM action in that cluster.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartIndexRebuildOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NeptuneDbAccessDeniedException'
        '408':
          description: ClientTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientTimeoutException'
        '500':
          description: ConcurrentModificationException; InternalFailureException; MemoryLimitExceededException; ServerShutdownException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
        '400':
          description: ConstraintViolationException; IllegalArgumentException; InvalidArgumentException; InvalidParameterException;
            PreconditionsFailedException; ReadOnlyViolationException; UnsupportedOperationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConstraintViolationException'
        '405':
          description: MethodNotAllowedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MethodNotAllowedException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NeptuneDbResourceNotFoundException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartIndexRebuildInput'
      tags:
      - Storage
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:
    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
    ConstraintViolationException:
      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
    DictionariesInfo:
      type: object
      properties:
        total:
          $ref: '#/components/schemas/StorageMetrics'
        blobs:
          $ref: '#/components/schemas/StorageMetrics'
    GetIndexRebuildStatusInput:
      type: object
      properties:
        rebuildId:
          type: string
          description: The unique identifier of the index rebuild job returned by the StartIndexRebuild operation.
      required:
      - rebuildId
    GetIndexRebuildStatusOutput:
      type: object
      properties:
        status:
          type: string
          enum:
          - PREPARING
          - REBUILDING
          - COMPLETED
          - FAILED
          - CANCELLED
          - CANCELLING
          description: 'The current status of the rebuild operation. See RebuildStatus for possible values: PREPARING, REBUILDING,
            COMPLETED, FAILED, CANCELLING or CANCELLED.'
        scope:
          type: string
          enum:
          - ALL
          - QUADS
          - DICTIONARIES
          description: 'The scope of the rebuild operation. See Scope for possible values: ALL, QUADS, or DICTIONARIES.'
        concurrency:
          type: integer
          description: The concurrency in effect for this rebuild, as echoed from the original StartIndexRebuild request.
        writeBufferSize:
          type: string
          enum:
          - LOW
          - MEDIUM
          - HIGH
          description: The WriteBufferSize in effect for this rebuild, as echoed from the original StartIndexRebuild request.
        startTime:
          type: string
          description: The ISO-8601 timestamp indicating when the index rebuild operation started.
        progressPercentage:
          type: integer
          description: The percentage of the index rebuild operation that has been completed, expressed as an integer from
            0 to 100.
        estimatedEndTime:
          type: string
          description: The estimated ISO-8601 timestamp for when the index rebuild operation will complete. The estimate may
            change as the operation progresses.
        endTime:
          type: string
          description: The ISO-8601 timestamp indicating when the index rebuild operation completed. This field is only present
            when the operation has completed (status is COMPLETED, FAILED, or CANCELLED).
        failureReason:
          type: string
          description: The reason for the failure, if the rebuild operation failed. This field is only populated when the
            status is FAILED.
      required:
      - status
      - scope
      - concurrency
      - writeBufferSize
      - startTime
      - progressPercentage
    GetStorageOutput:
      type: object
      properties:
        totalStorageBytesUsed:
          type: integer
          description: The approximate total amount of storage used by the Neptune database instance, in bytes.
        quads:
          $ref: '#/components/schemas/QuadsIndexesInfo'
        dictionaries:
          $ref: '#/components/schemas/DictionariesInfo'
        undoLogs:
          $ref: '#/components/schemas/UndoLogsMetrics'
        streams:
          $ref: '#/components/schemas/StorageMetrics'
        dfeStatistics:
          $ref: '#/components/schemas/StorageMetrics'
        schema:
          $ref: '#/components/schemas/StorageMetrics'
        internals:
          $ref: '#/components/schemas/StorageMetrics'
    InternalFailureException:
      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
    ListIndexRebuildsOutput:
      type: object
      properties:
        rebuildIds:
          type: array
          items:
            type: string
          description: A list of unique identifiers for index rebuild operations. Use each ID with the GetIndexRebuildStatus
            operation to retrieve detailed status information.
      required:
      - rebuildIds
    MethodNotAllowedException:
      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
    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
    NeptuneDbResourceNotFoundException:
      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
    QuadsIndexesInfo:
      type: object
      properties:
        RDF:
          $ref: '#/components/schemas/QuadsInfo'
        PG:
          $ref: '#/components/schemas/QuadsInfo'
    QuadsInfo:
      type: object
      properties:
        SPOG:
          $ref: '#/components/schemas/StorageMetrics'
        POGS:
          $ref: '#/components/schemas/StorageMetrics'
        GPSO:
          $ref: '#/components/schemas/StorageMetrics'
        OSGP:
          $ref: '#/components/schemas/StorageMetrics'
        PZSOG:
          $ref: '#/components/schemas/StorageMetrics'
    StartIndexRebuildInput:
      type: object
      properties:
        scope:
          type: string
          enum:
          - ALL
          - QUADS
          - DICTIONARIES
          description: 'Specifies the scope of the rebuild operation. Possible values are: ALL - Rebuild all (quads and dictionaries).
            This is the default if not specified. QUADS - Rebuild only the quad indexes. DICTIONARIES - Rebuild only the dictionaries.'
        concurrency:
          type: integer
          description: The number of concurrent indexes to rebuild in parallel. If not specified, defaults to 1. Valid values
            are between 1 and the number of vCPUs available on the writer instance. If the value exceeds the available vCPUs,
            it is capped at the maximum instead of returning an InvalidParameterException. The effective (capped) value is
            returned in the response. Higher concurrency can shorten the overall rebuild, but also increases CPU and I/O load
            during the operation.
        writeBufferSize:
          type: string
          enum:
          - LOW
          - MEDIUM
          - HIGH
          description: 'Controls the buffer size used for tracking concurrent write operations during the index rebuild. If
            your database has high write traffic during the rebuild, a larger buffer prevents the operation from failing due
            to buffer overflow. Possible values are: LOW - Suitable for databases with light to moderate write activity. This
            is the default. MEDIUM - Recommended for databases with sustained write traffic or bulk loading. HIGH - Use when
            rebuilding indexes during heavy write workloads or continuous bulk data ingestion. If your rebuild fails and you
            are actively writing data to the database, retr'
        clientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you
            don't specify a client token, the SDK automatically generates one.
    StartIndexRebuildOutput:
      type: object
      properties:
        status:
          type: string
          enum:
          - PREPARING
          - REBUILDING
          - COMPLETED
          - FAILED
          - CANCELLED
          - CANCELLING
          description: The current status of the rebuild operation. See RebuildStatus for possible values.
        rebuildId:
          type: string
          description: The unique identifier for the index rebuild job. Use this ID with the GetIndexRebuildStatus operation
            to check the progress of the rebuild.
        scope:
          type: string
          enum:
          - ALL
          - QUADS
          - DICTIONARIES
          description: 'The scope of the rebuild operation that was requested. See Scope for possible values: ALL, QUADS,
            or DICTIONARIES.'
        concurrency:
          type: integer
          description: The effective concurrency used for this rebuild. This is the value supplied in the request, capped
            at the number of vCPUs on the writer instance.
        writeBufferSize:
          type: string
          enum:
          - LOW
          - MEDIUM
          - HIGH
          description: The WriteBufferSize applied to this rebuild. See the WriteBufferSize enum for possible values.
      required:
      - status
      - rebuildId
      - scope
      - concurrency
      - writeBufferSize
    StorageMetrics:
      type: object
      properties:
        sizeInBytes:
          type: integer
          description: Storage size in bytes.
        count:
          type: integer
          description: The number of entries.
      required:
      - sizeInBytes
      - count
    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
    UndoLogsMetrics:
      type: object
      properties:
        sizeInBytes:
          type: integer
          description: The total size of the undo logs in bytes.
        listSize:
          type: integer
          description: The number of entries in the undo log list.
      required:
      - sizeInBytes
      - listSize
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)