Amazon Neptune Model Transform API

openapi: 3.2.0
info:
  title: Amazon Neptune Neptune ML Model Transform API
  description: Neptune ML enables machine learning on graph data using graph neural networks. It provides APIs for data processing, model training, model transform, and inference endpoint management powered by Amazon SageMaker. The ML API endpoints are available on the Neptune DB instance HTTP endpoint under the /ml path prefix.
  version: '2024-01-01'
  contact:
    name: Amazon Web Services
    url: https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning.html
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://{cluster-endpoint}:8182
  description: Neptune ML REST endpoint
  variables:
    cluster-endpoint:
      default: your-cluster-endpoint.region.neptune.amazonaws.com
      description: The cluster endpoint DNS name for your Neptune DB cluster
security:
- aws_sigv4: []
tags:
- name: Model Transform
  description: ML model transform job operations
paths:
  /ml/modeltransform:
    post:
      operationId: createModelTransformJob
      summary: Amazon Neptune Create an ML Model Transform Job
      description: Creates a new Neptune ML model transform job that generates model artifacts for inference. The transform job creates the embeddings and other artifacts needed to deploy the model to an inference endpoint.
      tags:
      - Model Transform
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateModelTransformJobRequest'
      responses:
        '200':
          description: Model transform job created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobCreatedResponse'
              examples:
                createModelTransformJob200Example:
                  summary: Default createModelTransformJob 200 response
                  x-microcks-default: true
                  value:
                    id: neptune-cluster-abc123
        '400':
          description: Bad request - invalid parameters.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      operationId: listModelTransformJobs
      summary: Amazon Neptune List Active Model Transform Jobs
      description: Returns a list of active Neptune ML model transform job IDs.
      tags:
      - Model Transform
      parameters:
      - name: maxItems
        in: query
        schema:
          type: integer
          default: 10
          maximum: 1024
      - name: neptuneIamRoleArn
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Job list retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobListResponse'
              examples:
                listModelTransformJobs200Example:
                  summary: Default listModelTransformJobs 200 response
                  x-microcks-default: true
                  value:
                    ids:
                    - example-value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ml/modeltransform/{id}:
    get:
      operationId: getModelTransformJobStatus
      summary: Amazon Neptune Get Model Transform Job Status
      description: Returns the status of a Neptune ML model transform job.
      tags:
      - Model Transform
      parameters:
      - name: id
        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/JobStatusResponse'
              examples:
                getModelTransformJobStatus200Example:
                  summary: Default getModelTransformJobStatus 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
                      failureReason: example-value
        '404':
          description: Job not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: stopModelTransformJob
      summary: Amazon Neptune Stop a Model Transform Job
      description: Stops a running Neptune ML model transform job.
      tags:
      - Model Transform
      parameters:
      - name: id
        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 stopped successfully.
        '404':
          description: Job not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    JobCreatedResponse:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the created job.
    JobStatusResponse:
      type: object
      properties:
        status:
          type: string
          description: The current status of the job.
        id:
          type: string
          description: The job identifier.
        processingJob:
          type: object
          properties:
            name:
              type: string
            arn:
              type: string
            status:
              type: string
            outputLocation:
              type: string
            failureReason:
              type: string
            cloudwatchLogUrl:
              type: string
    JobListResponse:
      type: object
      properties:
        ids:
          type: array
          description: List of job IDs.
          items:
            type: string
    CreateModelTransformJobRequest:
      type: object
      required:
      - modelTransformOutputS3Location
      properties:
        id:
          type: string
        dataProcessingJobId:
          type: string
          description: Job ID of the completed data processing job.
        mlModelTrainingJobId:
          type: string
          description: Job ID of the completed model training job.
        trainingJobName:
          type: string
          description: Name of a completed SageMaker training job.
        modelTransformOutputS3Location:
          type: string
          description: S3 location for transform output artifacts.
        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
  securitySchemes:
    aws_sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4 authentication via IAM