Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . neptunedata ]

start-ml-model-transform-job

Description

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.

See also: AWS API Documentation

Synopsis

  start-ml-model-transform-job
[--id <value>]
[--data-processing-job-id <value>]
[--ml-model-training-job-id <value>]
[--training-job-name <value>]
--model-transform-output-s3-location <value>
[--sagemaker-iam-role-arn <value>]
[--neptune-iam-role-arn <value>]
[--custom-model-transform-parameters <value>]
[--base-processing-instance-type <value>]
[--base-processing-instance-volume-size-in-gb <value>]
[--subnets <value>]
[--security-group-ids <value>]
[--volume-encryption-kms-key <value>]
[--s3-output-encryption-kms-key <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--id (string)

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

--data-processing-job-id (string)

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

--ml-model-training-job-id (string)

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

--training-job-name (string)

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

--model-transform-output-s3-location (string)

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

--sagemaker-iam-role-arn (string)

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

--neptune-iam-role-arn (string)

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.

--custom-model-transform-parameters (structure)

Configuration information for a model transform using a custom model. The customModelTransformParameters object contains the following fields, which must have values compatible with the saved model parameters from the training job:

sourceS3DirectoryPath -> (string)

The path to the Amazon S3 location where the Python module implementing your model is located. This must point to a valid existing Amazon S3 location that contains, at a minimum, a training script, a transform script, and a model-hpo-configuration.json file.

transformEntryPointScript -> (string)

The name of the entry point in your module of a script that should be run after the best model from the hyperparameter search has been identified, to compute the model artifacts necessary for model deployment. It should be able to run with no command-line arguments. The default is transform.py .

Shorthand Syntax:

sourceS3DirectoryPath=string,transformEntryPointScript=string

JSON Syntax:

{
  "sourceS3DirectoryPath": "string",
  "transformEntryPointScript": "string"
}

--base-processing-instance-type (string)

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.

--base-processing-instance-volume-size-in-gb (integer)

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.

--subnets (list)

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

(string)

Syntax:

"string" "string" ...

--security-group-ids (list)

The VPC security group IDs. The default is None.

(string)

Syntax:

"string" "string" ...

--volume-encryption-kms-key (string)

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.

--s3-output-encryption-kms-key (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

id -> (string)

The unique ID of the new model transform job.

arn -> (string)

The ARN of the model transform job.

creationTimeInMillis -> (long)

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