NeptuneData / Client / cancel_ml_model_transform_job

cancel_ml_model_transform_job#

NeptuneData.Client.cancel_ml_model_transform_job(**kwargs)#

Cancels a specified 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:CancelMLModelTransformJob IAM action in that cluster.

See also: AWS API Documentation

Request Syntax

response = client.cancel_ml_model_transform_job(
    id='string',
    neptuneIamRoleArn='string',
    clean=True|False
)
Parameters:
  • id (string) –

    [REQUIRED]

    The unique ID of the model transform 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 this flag is set to TRUE, all Neptune ML S3 artifacts should be deleted when the job is stopped. The default is FALSE.

Return type:

dict

Returns:

Response Syntax

{
    'status': 'string'
}

Response Structure

  • (dict) –

    • status (string) –

      the status of the cancelation.

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