Glue / Client / cancel_ml_task_run

cancel_ml_task_run

Glue.Client.cancel_ml_task_run(**kwargs)

Cancels (stops) a task run. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can cancel a machine learning task run at any time by calling CancelMLTaskRun with a task run’s parent transform’s TransformID and the task run’s TaskRunId.

See also: AWS API Documentation

Request Syntax

response = client.cancel_ml_task_run(
    TransformId='string',
    TaskRunId='string'
)

Parameters:

• TransformId (string) –

  [REQUIRED]

  The unique identifier of the machine learning transform.

• TaskRunId (string) –

  [REQUIRED]

  A unique identifier for the task run.

Return type:

dict

Returns:

Response Syntax

{
    'TransformId': 'string',
    'TaskRunId': 'string',
    'Status': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT'
}

Response Structure

• (dict) –

  • TransformId (string) –

    The unique identifier of the machine learning transform.

  • TaskRunId (string) –

    The unique identifier for the task run.

  • Status (string) –

    The status for this run.

Exceptions

• Glue.Client.exceptions.EntityNotFoundException

• Glue.Client.exceptions.InvalidInputException

• Glue.Client.exceptions.OperationTimeoutException

• Glue.Client.exceptions.InternalServiceException