Rekognition / Paginator / ListUsers

ListUsers

class Rekognition.Paginator.ListUsers

paginator = client.get_paginator('list_users')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• CollectionId (string) –

  [REQUIRED]

  The ID of an existing collection.

• 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

{
    'Users': [
        {
            'UserId': 'string',
            'UserStatus': 'ACTIVE'|'UPDATING'|'CREATING'|'CREATED'
        },
    ],

}

Response Structure

• (dict) –

  • Users (list) –

    List of UsersID associated with the specified collection.

    • (dict) –

      Metadata of the user stored in a collection.

      • UserId (string) –

        A provided ID for the User. Unique within the collection.

      • UserStatus (string) –

        Communicates if the UserID has been updated with latest set of faces to be associated with the UserID.