ml_model_training_jobs

Creates, updates, deletes, gets or lists a ml_model_training_jobs resource.

Overview

Name	ml_model_training_jobs
Type	Resource
Id	aws.neptunedata.ml_model_training_jobs

Fields

The following fields are returned by SELECT queries:

get_ml_model_training_job

Name	Datatype	Description
id	string	The unique identifier of this model-training job.
hpo_job	object	The HPO job.
ml_models	array	A list of the configurations of the ML models being used.
model_transform_job	object	The model transform job.
processing_job	object	The data processing job.
status	string	The status of the model training job.

list_ml_model_training_jobs

Name	Datatype	Description
id	string	A page of the list of model training job IDs.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_ml_model_training_job	select	id, region	neptuneIamRoleArn	Retrieves information about a Neptune ML model training job. See Model training using the modeltraining command. 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:GetMLModelTrainingJobStatus IAM action in that cluster.
list_ml_model_training_jobs	select	region	maxItems, neptuneIamRoleArn	Lists Neptune ML model-training jobs. See Model training using the modeltraining command. 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:neptune-db:ListMLModelTrainingJobs IAM action in that cluster.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string	The unique identifier of the model-training job to retrieve.
region	string	AWS region (default: us-east-1)
maxItems	integer	The maximum number of items to return (from 1 to 1024; the default is 10).
neptuneIamRoleArn	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.

SELECT examples

get_ml_model_training_job

Retrieves information about a Neptune ML model training job. See Model training using the modeltraining command. 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:GetMLModelTrainingJobStatus IAM action in that cluster.

SELECT
id,
hpo_job,
ml_models,
model_transform_job,
processing_job,
status
FROM aws.neptunedata.ml_model_training_jobs
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
AND neptuneIamRoleArn = '{{ neptuneIamRoleArn }}'
;

list_ml_model_training_jobs

Lists Neptune ML model-training jobs. See Model training using the modeltraining command. 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:neptune-db:ListMLModelTrainingJobs IAM action in that cluster.

SELECT
id
FROM aws.neptunedata.ml_model_training_jobs
WHERE region = '{{ region }}' -- required
AND maxItems = '{{ maxItems }}'
AND neptuneIamRoleArn = '{{ neptuneIamRoleArn }}'
;