Glue / Client / get_ml_task_run

get_ml_task_run#

Glue.Client.get_ml_task_run(**kwargs)#

Gets details for a specific task run on a machine learning transform. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can check the stats of any task run by calling GetMLTaskRun with the TaskRunID and its parent transform’s TransformID.

Request Syntax

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

Parameters:

TransformId (string) –
[REQUIRED]

The unique identifier of the machine learning transform.
TaskRunId (string) –
[REQUIRED]

The unique identifier of the task run.

Return type:

dict

Returns:

Response Syntax

{
    'TransformId': 'string',
    'TaskRunId': 'string',
    'Status': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
    'LogGroupName': 'string',
    'Properties': {
        'TaskType': 'EVALUATION'|'LABELING_SET_GENERATION'|'IMPORT_LABELS'|'EXPORT_LABELS'|'FIND_MATCHES',
        'ImportLabelsTaskRunProperties': {
            'InputS3Path': 'string',
            'Replace': True|False
        },
        'ExportLabelsTaskRunProperties': {
            'OutputS3Path': 'string'
        },
        'LabelingSetGenerationTaskRunProperties': {
            'OutputS3Path': 'string'
        },
        'FindMatchesTaskRunProperties': {
            'JobId': 'string',
            'JobName': 'string',
            'JobRunId': 'string'
        }
    },
    'ErrorString': 'string',
    'StartedOn': datetime(2015, 1, 1),
    'LastModifiedOn': datetime(2015, 1, 1),
    'CompletedOn': datetime(2015, 1, 1),
    'ExecutionTime': 123
}

Response Structure

(dict) –
- TransformId (string) –
  
  The unique identifier of the task run.
- TaskRunId (string) –
  
  The unique run identifier associated with this run.
- Status (string) –
  
  The status for this task run.
- LogGroupName (string) –
  
  The names of the log groups that are associated with the task run.
- Properties (dict) –
  
  The list of properties that are associated with the task run.
  - TaskType (string) –
    
    The type of task run.
  - ImportLabelsTaskRunProperties (dict) –
    
    The configuration properties for an importing labels task run.
    - InputS3Path (string) –
      
      The Amazon Simple Storage Service (Amazon S3) path from where you will import the labels.
    - Replace (boolean) –
      
      Indicates whether to overwrite your existing labels.
  - ExportLabelsTaskRunProperties (dict) –
    
    The configuration properties for an exporting labels task run.
    - OutputS3Path (string) –
      
      The Amazon Simple Storage Service (Amazon S3) path where you will export the labels.
  - LabelingSetGenerationTaskRunProperties (dict) –
    
    The configuration properties for a labeling set generation task run.
    - OutputS3Path (string) –
      
      The Amazon Simple Storage Service (Amazon S3) path where you will generate the labeling set.
  - FindMatchesTaskRunProperties (dict) –
    
    The configuration properties for a find matches task run.
    - JobId (string) –
      
      The job ID for the Find Matches task run.
    - JobName (string) –
      
      The name assigned to the job for the Find Matches task run.
    - JobRunId (string) –
      
      The job run ID for the Find Matches task run.
- ErrorString (string) –
  
  The error strings that are associated with the task run.
- StartedOn (datetime) –
  
  The date and time when this task run started.
- LastModifiedOn (datetime) –
  
  The date and time when this task run was last modified.
- CompletedOn (datetime) –
  
  The date and time when this task run was completed.
- ExecutionTime (integer) –
  
  The amount of time (in seconds) that the task run consumed resources.

Exceptions

Glue.Client.exceptions.EntityNotFoundException
Glue.Client.exceptions.InvalidInputException
Glue.Client.exceptions.OperationTimeoutException
Glue.Client.exceptions.InternalServiceException