Glue / Client / get_ml_task_runs

get_ml_task_runs#

Glue.Client.get_ml_task_runs(**kwargs)#

Gets a list of runs for 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 get a sortable, filterable list of machine learning task runs by calling GetMLTaskRuns with their parent transform’s TransformID and other optional parameters as documented in this section.

This operation returns a list of historic runs and must be paginated.

See also: AWS API Documentation

Request Syntax

response = client.get_ml_task_runs(
    TransformId='string',
    NextToken='string',
    MaxResults=123,
    Filter={
        'TaskRunType': 'EVALUATION'|'LABELING_SET_GENERATION'|'IMPORT_LABELS'|'EXPORT_LABELS'|'FIND_MATCHES',
        'Status': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
        'StartedBefore': datetime(2015, 1, 1),
        'StartedAfter': datetime(2015, 1, 1)
    },
    Sort={
        'Column': 'TASK_RUN_TYPE'|'STATUS'|'STARTED',
        'SortDirection': 'DESCENDING'|'ASCENDING'
    }
)
Parameters:

  • TransformId (string) –

    [REQUIRED]

    The unique identifier of the machine learning transform.

  • NextToken (string) – A token for pagination of the results. The default is empty.

  • MaxResults (integer) – The maximum number of results to return.

  • Filter (dict) –

    The filter criteria, in the TaskRunFilterCriteria structure, for the task run.

    • TaskRunType (string) –

      The type of task run.

    • Status (string) –

      The current status of the task run.

    • StartedBefore (datetime) –

      Filter on task runs started before this date.

    • StartedAfter (datetime) –

      Filter on task runs started after this date.

  • Sort (dict) –

    The sorting criteria, in the TaskRunSortCriteria structure, for the task run.

    • Column (string) – [REQUIRED]

      The column to be used to sort the list of task runs for the machine learning transform.

    • SortDirection (string) – [REQUIRED]

      The sort direction to be used to sort the list of task runs for the machine learning transform.

Return type:

dict

Returns:

Response Syntax

{
    'TaskRuns': [
        {
            '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
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • TaskRuns (list) –

      A list of task runs that are associated with the transform.

      • (dict) –

        The sampling parameters that are associated with the machine learning transform.

        • TransformId (string) –

          The unique identifier for the transform.

        • TaskRunId (string) –

          The unique identifier for this task run.

        • Status (string) –

          The current status of the requested task run.

        • LogGroupName (string) –

          The names of the log group for secure logging, associated with this task run.

        • Properties (dict) –

          Specifies configuration properties associated with this 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 list of error strings associated with this task run.

        • StartedOn (datetime) –

          The date and time that this task run started.

        • LastModifiedOn (datetime) –

          The last point in time that the requested task run was updated.

        • CompletedOn (datetime) –

          The last point in time that the requested task run was completed.

        • ExecutionTime (integer) –

          The amount of time (in seconds) that the task run consumed resources.

    • NextToken (string) –

      A pagination token, if more results are available.

Exceptions