SageMaker / Client / list_labeling_jobs_for_workteam

list_labeling_jobs_for_workteam#

SageMaker.Client.list_labeling_jobs_for_workteam(**kwargs)#

Gets a list of labeling jobs assigned to a specified work team.

See also: AWS API Documentation

Request Syntax

response = client.list_labeling_jobs_for_workteam(
    WorkteamArn='string',
    MaxResults=123,
    NextToken='string',
    CreationTimeAfter=datetime(2015, 1, 1),
    CreationTimeBefore=datetime(2015, 1, 1),
    JobReferenceCodeContains='string',
    SortBy='CreationTime',
    SortOrder='Ascending'|'Descending'
)
Parameters:

  • WorkteamArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the work team for which you want to see labeling jobs for.

  • MaxResults (integer) – The maximum number of labeling jobs to return in each page of the response.

  • NextToken (string) – If the result of the previous ListLabelingJobsForWorkteam request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

  • CreationTimeAfter (datetime) – A filter that returns only labeling jobs created after the specified time (timestamp).

  • CreationTimeBefore (datetime) – A filter that returns only labeling jobs created before the specified time (timestamp).

  • JobReferenceCodeContains (string) – A filter the limits jobs to only the ones whose job reference code contains the specified string.

  • SortBy (string) – The field to sort results by. The default is CreationTime.

  • SortOrder (string) – The sort order for results. The default is Ascending.

Return type:

dict

Returns:

Response Syntax

{
    'LabelingJobSummaryList': [
        {
            'LabelingJobName': 'string',
            'JobReferenceCode': 'string',
            'WorkRequesterAccountId': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LabelCounters': {
                'HumanLabeled': 123,
                'PendingHuman': 123,
                'Total': 123
            },
            'NumberOfHumanWorkersPerDataObject': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • LabelingJobSummaryList (list) –

      An array of LabelingJobSummary objects, each describing a labeling job.

      • (dict) –

        Provides summary information for a work team.

        • LabelingJobName (string) –

          The name of the labeling job that the work team is assigned to.

        • JobReferenceCode (string) –

          A unique identifier for a labeling job. You can use this to refer to a specific labeling job.

        • WorkRequesterAccountId (string) –

          The Amazon Web Services account ID of the account used to start the labeling job.

        • CreationTime (datetime) –

          The date and time that the labeling job was created.

        • LabelCounters (dict) –

          Provides information about the progress of a labeling job.

          • HumanLabeled (integer) –

            The total number of data objects labeled by a human worker.

          • PendingHuman (integer) –

            The total number of data objects that need to be labeled by a human worker.

          • Total (integer) –

            The total number of tasks in the labeling job.

        • NumberOfHumanWorkersPerDataObject (integer) –

          The configured number of workers per data object.

    • NextToken (string) –

      If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.

Exceptions

  • SageMaker.Client.exceptions.ResourceNotFound