SageMaker / Paginator / ListLabelingJobs

ListLabelingJobs#

class SageMaker.Paginator.ListLabelingJobs#

paginator = client.get_paginator('list_labeling_jobs')

paginate(**kwargs)#

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

Request Syntax

response_iterator = paginator.paginate(
    CreationTimeAfter=datetime(2015, 1, 1),
    CreationTimeBefore=datetime(2015, 1, 1),
    LastModifiedTimeAfter=datetime(2015, 1, 1),
    LastModifiedTimeBefore=datetime(2015, 1, 1),
    NameContains='string',
    SortBy='Name'|'CreationTime'|'Status',
    SortOrder='Ascending'|'Descending',
    StatusEquals='Initializing'|'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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).
LastModifiedTimeAfter (datetime) – A filter that returns only labeling jobs modified after the specified time (timestamp).
LastModifiedTimeBefore (datetime) – A filter that returns only labeling jobs modified before the specified time (timestamp).
NameContains (string) – A string in the labeling job name. This filter returns only labeling jobs whose name 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.
StatusEquals (string) – A filter that retrieves only labeling jobs with a specific status.
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',
            'LabelingJobArn': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'LabelingJobStatus': 'Initializing'|'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped',
            'LabelCounters': {
                'TotalLabeled': 123,
                'HumanLabeled': 123,
                'MachineLabeled': 123,
                'FailedNonRetryableError': 123,
                'Unlabeled': 123
            },
            'WorkteamArn': 'string',
            'PreHumanTaskLambdaArn': 'string',
            'AnnotationConsolidationLambdaArn': 'string',
            'FailureReason': 'string',
            'LabelingJobOutput': {
                'OutputDatasetS3Uri': 'string',
                'FinalActiveLearningModelArn': 'string'
            },
            'InputConfig': {
                'DataSource': {
                    'S3DataSource': {
                        'ManifestS3Uri': 'string'
                    },
                    'SnsDataSource': {
                        'SnsTopicArn': 'string'
                    }
                },
                'DataAttributes': {
                    'ContentClassifiers': [
                        'FreeOfPersonallyIdentifiableInformation'|'FreeOfAdultContent',
                    ]
                }
            }
        },
    ],

}

Response Structure

(dict) –
- LabelingJobSummaryList (list) –
  
  An array of LabelingJobSummary objects, each describing a labeling job.
  - (dict) –
    
    Provides summary information about a labeling job.
    - LabelingJobName (string) –
      
      The name of the labeling job.
    - LabelingJobArn (string) –
      
      The Amazon Resource Name (ARN) assigned to the labeling job when it was created.
    - CreationTime (datetime) –
      
      The date and time that the job was created (timestamp).
    - LastModifiedTime (datetime) –
      
      The date and time that the job was last modified (timestamp).
    - LabelingJobStatus (string) –
      
      The current status of the labeling job.
    - LabelCounters (dict) –
      
      Counts showing the progress of the labeling job.
      - TotalLabeled (integer) –
        
        The total number of objects labeled.
      - HumanLabeled (integer) –
        
        The total number of objects labeled by a human worker.
      - MachineLabeled (integer) –
        
        The total number of objects labeled by automated data labeling.
      - FailedNonRetryableError (integer) –
        
        The total number of objects that could not be labeled due to an error.
      - Unlabeled (integer) –
        
        The total number of objects not yet labeled.
    - WorkteamArn (string) –
      
      The Amazon Resource Name (ARN) of the work team assigned to the job.
    - PreHumanTaskLambdaArn (string) –
      
      The Amazon Resource Name (ARN) of a Lambda function. The function is run before each data object is sent to a worker.
    - AnnotationConsolidationLambdaArn (string) –
      
      The Amazon Resource Name (ARN) of the Lambda function used to consolidate the annotations from individual workers into a label for a data object. For more information, see Annotation Consolidation.
    - FailureReason (string) –
      
      If the LabelingJobStatus field is Failed, this field contains a description of the error.
    - LabelingJobOutput (dict) –
      
      The location of the output produced by the labeling job.
      - OutputDatasetS3Uri (string) –
        
        The Amazon S3 bucket location of the manifest file for labeled data.
      - FinalActiveLearningModelArn (string) –
        
        The Amazon Resource Name (ARN) for the most recent SageMaker model trained as part of automated data labeling.
    - InputConfig (dict) –
      
      Input configuration for the labeling job.
      - DataSource (dict) –
        
        The location of the input data.
        
        S3DataSource (dict) –
        
        The Amazon S3 location of the input data objects.
        
        ManifestS3Uri (string) –
        
        The Amazon S3 location of the manifest file that describes the input data objects.
        
        The input manifest file referenced in ManifestS3Uri must contain one of the following keys: source-ref or source. The value of the keys are interpreted as follows:
        
        source-ref: The source of the object is the Amazon S3 object specified in the value. Use this value when the object is a binary object, such as an image.
        
        source: The source of the object is the value. Use this value when the object is a text value.
        
        If you are a new user of Ground Truth, it is recommended you review Use an Input Manifest File in the Amazon SageMaker Developer Guide to learn how to create an input manifest file.
        
        SnsDataSource (dict) –
        
        An Amazon SNS data source used for streaming labeling jobs. To learn more, see Send Data to a Streaming Labeling Job.
        
        SnsTopicArn (string) –
        
        The Amazon SNS input topic Amazon Resource Name (ARN). Specify the ARN of the input topic you will use to send new data objects to a streaming labeling job.
      - DataAttributes (dict) –
        
        Attributes of the data specified by the customer.
        
        ContentClassifiers (list) –
        
        Declares that your content is free of personally identifiable information or adult content. SageMaker may restrict the Amazon Mechanical Turk workers that can view your task based on this information.
        
        (string) –