Rekognition / Paginator / ListCollections

ListCollections

class Rekognition.Paginator.ListCollections

paginator = client.get_paginator('list_collections')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

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

{
    'CollectionIds': [
        'string',
    ],
    'FaceModelVersions': [
        'string',
    ]
}

Response Structure

• (dict) –

  • CollectionIds (list) –

    An array of collection IDs.

    • (string) –

  • FaceModelVersions (list) –

    Version numbers of the face detection models associated with the collections in the array CollectionIds. For example, the value of FaceModelVersions[2] is the version number for the face detection model used by the collection in CollectionId[2].

    • (string) –