ListDatasetEntries

class Rekognition.Paginator.ListDatasetEntries

paginator = client.get_paginator('list_dataset_entries')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DatasetArn='string',
    ContainsLabels=[
        'string',
    ],
    Labeled=True|False,
    SourceRefContains='string',
    HasErrors=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

• DatasetArn (string) --

  [REQUIRED]

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

• ContainsLabels (list) --

  Specifies a label filter for the response. The response includes an entry only if one or more of the labels in ContainsLabels exist in the entry.

  • (string) --
• Labeled (boolean) -- Specify true to get only the JSON Lines where the image is labeled. Specify false to get only the JSON Lines where the image isn't labeled. If you don't specify Labeled , ListDatasetEntries returns JSON Lines for labeled and unlabeled images.
• SourceRefContains (string) -- If specified, ListDatasetEntries only returns JSON Lines where the value of SourceRefContains is part of the source-ref field. The source-ref field contains the Amazon S3 location of the image. You can use SouceRefContains for tasks such as getting the JSON Line for a single image, or gettting JSON Lines for all images within a specific folder.
• HasErrors (boolean) -- Specifies an error filter for the response. Specify True to only include entries that have errors.
• 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

{
    'DatasetEntries': [
        'string',
    ],

}

Response Structure

• (dict) --

  • DatasetEntries (list) --

    A list of entries (images) in the dataset.

    • (string) --