:doc:`Rekognition <../../rekognition>` / Client / list_dataset_labels

*******************
list_dataset_labels
*******************



.. py:method:: Rekognition.Client.list_dataset_labels(**kwargs)

  

  .. note::

    

    This operation applies only to Amazon Rekognition Custom Labels.

    

   

  Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see `Labeling images <https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/md-labeling-images.html>`__.

   

  Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images in the *Amazon Rekognition Custom Labels Developer Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/ListDatasetLabels>`_  


  **Request Syntax**
  ::

    response = client.list_dataset_labels(
        DatasetArn='string',
        NextToken='string',
        MaxResults=123
    )
    
  :type DatasetArn: string
  :param DatasetArn: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the dataset that you want to use.

    

  
  :type NextToken: string
  :param NextToken: 

    If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'DatasetLabelDescriptions': [
              {
                  'LabelName': 'string',
                  'LabelStats': {
                      'EntryCount': 123,
                      'BoundingBoxCount': 123
                  }
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **DatasetLabelDescriptions** *(list) --* 

        A list of the labels in the dataset.

        
        

        - *(dict) --* 

          Describes a dataset label. For more information, see  ListDatasetLabels.

          
          

          - **LabelName** *(string) --* 

            The name of the label.

            
          

          - **LabelStats** *(dict) --* 

            Statistics about the label.

            
            

            - **EntryCount** *(integer) --* 

              The total number of images that use the label.

              
            

            - **BoundingBoxCount** *(integer) --* 

              The total number of images that have the label assigned to a bounding box.

              
        
      
    
      

      - **NextToken** *(string) --* 

        If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

        
  
  **Exceptions**
  
  *   :py:class:`Rekognition.Client.exceptions.InternalServerError`

  
  *   :py:class:`Rekognition.Client.exceptions.ThrottlingException`

  
  *   :py:class:`Rekognition.Client.exceptions.ProvisionedThroughputExceededException`

  
  *   :py:class:`Rekognition.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`Rekognition.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Rekognition.Client.exceptions.ResourceInUseException`

  
  *   :py:class:`Rekognition.Client.exceptions.InvalidPaginationTokenException`

  
  *   :py:class:`Rekognition.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`Rekognition.Client.exceptions.ResourceNotReadyException`

  