Skip to content

ListFacesRequest

Source code in docs_src/capo_rekognition/types/list_faces_request.py 
17
18
19
20
21
22
23
24
25
26
27
class ListFacesRequest(TypedDict, closed=True):
    collection_id: "capo_rekognition.types.collection_id.CollectionId"
    """<p>ID of the collection from which to list the faces.</p>"""
    next_token: NotRequired["capo_rekognition.types.pagination_token.PaginationToken"]
    """<p>If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.</p>"""
    max_results: NotRequired["capo_rekognition.types.page_size.PageSize"]
    """<p>Maximum number of faces to return.</p>"""
    user_id: NotRequired["capo_rekognition.types.user_id.UserId"]
    """<p>An array of user IDs to filter results with when listing faces in a collection.</p>"""
    face_ids: NotRequired["capo_rekognition.types.face_id_list.FaceIdList"]
    """<p>An array of face IDs to filter results with when listing faces in a collection.</p>"""

collection_id instance-attribute 

collection_id: CollectionId

ID of the collection from which to list the faces.

face_ids instance-attribute 

face_ids: NotRequired[FaceIdList]

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

max_results instance-attribute 

max_results: NotRequired[PageSize]

Maximum number of faces to return.

next_token instance-attribute 

next_token: NotRequired[PaginationToken]

If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.

user_id instance-attribute 

user_id: NotRequired[UserId]

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