SageMaker / Paginator / ListLabelingJobsForWorkteam

ListLabelingJobsForWorkteam

class SageMaker.Paginator.ListLabelingJobsForWorkteam

paginator = client.get_paginator('list_labeling_jobs_for_workteam')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SageMaker.Client.list_labeling_jobs_for_workteam().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    WorkteamArn='string',
    CreationTimeAfter=datetime(2015, 1, 1),
    CreationTimeBefore=datetime(2015, 1, 1),
    JobReferenceCodeContains='string',
    SortBy='CreationTime',
    SortOrder='Ascending'|'Descending',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• WorkteamArn (string) –

  [REQUIRED]

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

• 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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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
        },
    ],

}

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.