Rekognition / Client / list_users

list_users#

Rekognition.Client.list_users(**kwargs)#

Returns metadata of the User such as UserID in the specified collection. Anonymous User (to reserve faces without any identity) is not returned as part of this request. The results are sorted by system generated primary key ID. If the response is truncated, NextToken is returned in the response that can be used in the subsequent request to retrieve the next set of identities.

See also: AWS API Documentation

Request Syntax

response = client.list_users(
    CollectionId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • CollectionId (string) –

    [REQUIRED]

    The ID of an existing collection.

  • MaxResults (integer) – Maximum number of UsersID to return.

  • NextToken (string) – Pagingation token to receive the next set of UsersID.

Return type:

dict

Returns:

Response Syntax

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

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.

    • NextToken (string) –

      A pagination token to be used with the subsequent request if the response is truncated.

Exceptions