NeptuneData / Client / cancel_ml_model_training_job
cancel_ml_model_training_job#
- NeptuneData.Client.cancel_ml_model_training_job(**kwargs)#
Cancels a Neptune ML model training job. See Model training using the modeltraining command.
See also: AWS API Documentation
Request Syntax
response = client.cancel_ml_model_training_job( id='string', neptuneIamRoleArn='string', clean=True|False )
- Parameters:
id (string) –
[REQUIRED]
The unique identifier of the model-training job to be canceled.
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.
clean (boolean) – If set to
TRUE
, this flag specifies that all Amazon S3 artifacts should be deleted when the job is stopped. The default isFALSE
.
- Return type:
dict
- Returns:
Response Syntax
{ 'status': 'string' }
Response Structure
(dict) –
status (string) –
The status of the cancellation.
Exceptions
NeptuneData.Client.exceptions.UnsupportedOperationException
NeptuneData.Client.exceptions.BadRequestException
NeptuneData.Client.exceptions.MLResourceNotFoundException
NeptuneData.Client.exceptions.InvalidParameterException
NeptuneData.Client.exceptions.ClientTimeoutException
NeptuneData.Client.exceptions.PreconditionsFailedException
NeptuneData.Client.exceptions.ConstraintViolationException
NeptuneData.Client.exceptions.InvalidArgumentException
NeptuneData.Client.exceptions.MissingParameterException
NeptuneData.Client.exceptions.IllegalArgumentException
NeptuneData.Client.exceptions.TooManyRequestsException