:doc:`SageMaker <../../sagemaker>` / Client / list_labeling_jobs

******************
list_labeling_jobs
******************



.. py:method:: SageMaker.Client.list_labeling_jobs(**kwargs)

  

  Gets a list of labeling jobs.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListLabelingJobs>`_  


  **Request Syntax**
  ::

    response = client.list_labeling_jobs(
        CreationTimeAfter=datetime(2015, 1, 1),
        CreationTimeBefore=datetime(2015, 1, 1),
        LastModifiedTimeAfter=datetime(2015, 1, 1),
        LastModifiedTimeBefore=datetime(2015, 1, 1),
        MaxResults=123,
        NextToken='string',
        NameContains='string',
        SortBy='Name'|'CreationTime'|'Status',
        SortOrder='Ascending'|'Descending',
        StatusEquals='Initializing'|'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped'
    )
    
  :type CreationTimeAfter: datetime
  :param CreationTimeAfter: 

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

    

  
  :type CreationTimeBefore: datetime
  :param CreationTimeBefore: 

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

    

  
  :type LastModifiedTimeAfter: datetime
  :param LastModifiedTimeAfter: 

    A filter that returns only labeling jobs modified after the specified time (timestamp).

    

  
  :type LastModifiedTimeBefore: datetime
  :param LastModifiedTimeBefore: 

    A filter that returns only labeling jobs modified before the specified time (timestamp).

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of labeling jobs to return in each page of the response.

    

  
  :type NextToken: string
  :param NextToken: 

    If the result of the previous ``ListLabelingJobs`` request was truncated, the response includes a ``NextToken``. To retrieve the next set of labeling jobs, use the token in the next request.

    

  
  :type NameContains: string
  :param NameContains: 

    A string in the labeling job name. This filter returns only labeling jobs whose name contains the specified string.

    

  
  :type SortBy: string
  :param SortBy: 

    The field to sort results by. The default is ``CreationTime``.

    

  
  :type SortOrder: string
  :param SortOrder: 

    The sort order for results. The default is ``Ascending``.

    

  
  :type StatusEquals: string
  :param StatusEquals: 

    A filter that retrieves only labeling jobs with a specific status.

    

  
  
  :rtype: 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',
                          ]
                      }
                  }
              },
          ],
          'NextToken': 'string'
      }
      
    **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 <https://docs.aws.amazon.com/sagemaker/latest/dg/sms-annotation-consolidation.html>`__.

            
          

          - **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 <https://docs.aws.amazon.com/sagemaker/latest/dg/sms-input-data-input-manifest.html>`__ 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 <https://docs.aws.amazon.com/sagemaker/latest/dg/sms-streaming-labeling-job.html#sms-streaming-how-it-works-send-data>`__.

                
                

                - **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) --* 
            
          
        
      
    
      

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

        
  