v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1443187284.6 KB

Creates a new model transform job. See Use a trained model to generate new model artifacts.

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:StartMLModelTransformJob IAM action in that cluster.

post/ml/modeltransform

Request body

idstring

A unique identifier for the new job. The default is an autogenerated UUID.

dataProcessingJobIdstring

The job ID of a completed data-processing job. You must include either <code>dataProcessingJobId</code> and a <code>mlModelTrainingJobId</code>, or a <code>trainingJobName</code>.

mlModelTrainingJobIdstring

The job ID of a completed model-training job. You must include either <code>dataProcessingJobId</code> and a <code>mlModelTrainingJobId</code>, or a <code>trainingJobName</code>.

trainingJobNamestring

The name of a completed SageMaker training job. You must include either <code>dataProcessingJobId</code> and a <code>mlModelTrainingJobId</code>, or a <code>trainingJobName</code>.

modelTransformOutputS3Locationstring required

The location in Amazon S3 where the model artifacts are to be stored.

sagemakerIamRoleArnstring

The ARN of an IAM role for SageMaker execution. This must be listed in your DB cluster parameter group or an error will occur.

neptuneIamRoleArnstring

The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

baseProcessingInstanceTypestring

The type of ML instance used in preparing and managing training of ML models. This is an ML compute instance chosen based on memory requirements for processing the training data and model.

baseProcessingInstanceVolumeSizeInGBinteger

The disk volume size of the training instance in gigabytes. The default is 0. Both input data and the output model are stored on disk, so the volume size must be large enough to hold both data sets. If not specified or 0, Neptune ML selects a disk volume size based on the recommendation generated in the data processing step.

subnetsString[]

The IDs of the subnets in the Neptune VPC. The default is None.

securityGroupIdsString[]

The VPC security group IDs. The default is None.

volumeEncryptionKMSKeystring

The Amazon Key Management Service (KMS) key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instances that run the training job. The default is None.

s3OutputEncryptionKMSKeystring

The Amazon Key Management Service (KMS) key that SageMaker uses to encrypt the output of the processing job. The default is none.

Response

Success

idstring

The unique ID of the new model transform job.

arnstring

The ARN of the model transform job.

creationTimeInMillisinteger

The creation time of the model transform job, in milliseconds.