Amazon Neptune Private Graph Endpoints API

openapi: 3.1.0
info:
  title: Amazon Neptune Neptune Analytics ?Action=AddTagsToResource ?Action=AddTagsToResource Private Graph Endpoints API
  description: Neptune Analytics is a memory-optimized graph database engine for analytics, providing optimized graph analytic algorithms, low-latency queries, and vector search capabilities within graph traversals. This API provides management operations for Neptune Analytics graph resources including creating, managing, and querying graph databases optimized for analytical workloads.
  version: '2023-11-29'
  contact:
    name: Amazon Web Services
    url: https://docs.aws.amazon.com/neptune-analytics/latest/userguide/what-is-neptune-analytics.html
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://neptune-graph.{region}.amazonaws.com
  description: Neptune Analytics control plane regional endpoint
  variables:
    region:
      default: us-east-1
      description: AWS region
security:
- aws_sigv4: []
tags:
- name: Private Graph Endpoints
  description: Operations for managing private graph endpoints in VPCs
paths:
  /privategraphendpoints/{graphIdentifier}:
    post:
      operationId: createPrivateGraphEndpoint
      summary: Amazon Neptune Create a Private Graph Endpoint
      description: Creates a private graph endpoint in a VPC for accessing a Neptune Analytics graph without going over the public internet.
      tags:
      - Private Graph Endpoints
      parameters:
      - name: graphIdentifier
        in: path
        required: true
        description: The unique identifier of the graph.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePrivateGraphEndpointInput'
      responses:
        '201':
          description: Private endpoint created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateGraphEndpointOutput'
              examples:
                createPrivateGraphEndpoint201Example:
                  summary: Default createPrivateGraphEndpoint 201 response
                  x-microcks-default: true
                  value:
                    vpcId: neptune-cluster-abc123
                    subnetIds:
                    - example-value
                    status: CREATING
                    vpcEndpointId: neptune-cluster-abc123
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      operationId: listPrivateGraphEndpoints
      summary: Amazon Neptune List Private Graph Endpoints
      description: Returns a list of private graph endpoints for a specific graph.
      tags:
      - Private Graph Endpoints
      parameters:
      - name: graphIdentifier
        in: path
        required: true
        schema:
          type: string
      - name: maxResults
        in: query
        schema:
          type: integer
      - name: nextToken
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Private endpoint list retrieved successfully.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /privategraphendpoints/{graphIdentifier}/{vpcId}:
    get:
      operationId: getPrivateGraphEndpoint
      summary: Amazon Neptune Get Private Graph Endpoint Details
      description: Returns details of a specific private graph endpoint.
      tags:
      - Private Graph Endpoints
      parameters:
      - name: graphIdentifier
        in: path
        required: true
        schema:
          type: string
      - name: vpcId
        in: path
        required: true
        description: The VPC ID of the private endpoint.
        schema:
          type: string
      responses:
        '200':
          description: Private endpoint details retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateGraphEndpointOutput'
              examples:
                getPrivateGraphEndpoint200Example:
                  summary: Default getPrivateGraphEndpoint 200 response
                  x-microcks-default: true
                  value:
                    vpcId: neptune-cluster-abc123
                    subnetIds:
                    - example-value
                    status: CREATING
                    vpcEndpointId: neptune-cluster-abc123
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deletePrivateGraphEndpoint
      summary: Amazon Neptune Delete a Private Graph Endpoint
      description: Deletes a private graph endpoint from a VPC.
      tags:
      - Private Graph Endpoints
      parameters:
      - name: graphIdentifier
        in: path
        required: true
        schema:
          type: string
      - name: vpcId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Private endpoint deleted successfully.
        '404':
          description: Private endpoint not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    CreatePrivateGraphEndpointInput:
      type: object
      properties:
        vpcId:
          type: string
          description: The VPC ID for the private endpoint.
        subnetIds:
          type: array
          description: The subnet IDs for the private endpoint.
          items:
            type: string
        vpcSecurityGroupIds:
          type: array
          description: The security group IDs for the private endpoint.
          items:
            type: string
    PrivateGraphEndpointOutput:
      type: object
      properties:
        vpcId:
          type: string
        subnetIds:
          type: array
          items:
            type: string
        status:
          type: string
          enum:
          - CREATING
          - AVAILABLE
          - DELETING
          - FAILED
        vpcEndpointId:
          type: string
  securitySchemes:
    aws_sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4 authentication