:doc:`Rekognition <../../rekognition>` / Paginator / ListDatasetLabels

*****************
ListDatasetLabels
*****************



.. py:class:: Rekognition.Paginator.ListDatasetLabels

  ::

    
    paginator = client.get_paginator('list_dataset_labels')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`Rekognition.Client.list_dataset_labels`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          DatasetArn='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type DatasetArn: string
    :param DatasetArn: **[REQUIRED]** 

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

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

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

      
      ::

        {
            'DatasetLabelDescriptions': [
                {
                    'LabelName': 'string',
                    'LabelStats': {
                        'EntryCount': 123,
                        'BoundingBoxCount': 123
                    }
                },
            ],
            
        }
        
      **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.

                
          
        
      
    