Rekognition / Paginator / ListFaces

ListFaces

class Rekognition.Paginator.ListFaces

paginator = client.get_paginator('list_faces')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• CollectionId (string) –

  [REQUIRED]

  ID of the collection from which to list the faces.

• UserId (string) – An array of user IDs to filter results with when listing faces in a collection.

• FaceIds (list) –

  An array of face IDs to filter results with when listing faces in a collection.

  • (string) –

• 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

{
    'Faces': [
        {
            'FaceId': 'string',
            'BoundingBox': {
                'Width': ...,
                'Height': ...,
                'Left': ...,
                'Top': ...
            },
            'ImageId': 'string',
            'ExternalImageId': 'string',
            'Confidence': ...,
            'IndexFacesModelVersion': 'string',
            'UserId': 'string'
        },
    ],
    'FaceModelVersion': 'string'
}

Response Structure

• (dict) –

  • Faces (list) –

    An array of Face objects.

    • (dict) –

      Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned.

      • FaceId (string) –

        Unique identifier that Amazon Rekognition assigns to the face.

      • BoundingBox (dict) –

        Bounding box of the face.

        • Width (float) –

          Width of the bounding box as a ratio of the overall image width.

        • Height (float) –

          Height of the bounding box as a ratio of the overall image height.

        • Left (float) –

          Left coordinate of the bounding box as a ratio of overall image width.

        • Top (float) –

          Top coordinate of the bounding box as a ratio of overall image height.

      • ImageId (string) –

        Unique identifier that Amazon Rekognition assigns to the input image.

      • ExternalImageId (string) –

        Identifier that you assign to all the faces in the input image.

      • Confidence (float) –

        Confidence level that the bounding box contains a face (and not a different object such as a tree).

      • IndexFacesModelVersion (string) –

        The version of the face detect and storage model that was used when indexing the face vector.

      • UserId (string) –

        Unique identifier assigned to the user.

  • FaceModelVersion (string) –

    Version number of the face detection model associated with the input collection ( CollectionId).