Rekognition / Paginator / ListDatasetLabels

ListDatasetLabels

class Rekognition.Paginator.ListDatasetLabels

paginator = client.get_paginator('list_dataset_labels')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Rekognition.Client.list_dataset_labels().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DatasetArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• DatasetArn (string) –

  [REQUIRED]

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

• 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

{
    '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.