Skip to content

GetFaceSearchRequest

Source code in docs_src/capo_rekognition/types/get_face_search_request.py 
16
17
18
19
20
21
22
23
24
class GetFaceSearchRequest(TypedDict, closed=True):
    job_id: "capo_rekognition.types.job_id.JobId"
    """<p>The job identifer for the search request. You get the job identifier from an initial call to <code>StartFaceSearch</code>.</p>"""
    max_results: NotRequired["capo_rekognition.types.max_results.MaxResults"]
    """<p>Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.</p>"""
    next_token: NotRequired["capo_rekognition.types.pagination_token.PaginationToken"]
    """<p>If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results. </p>"""
    sort_by: NotRequired["capo_rekognition.types.face_search_sort_by.FaceSearchSortBy"]
    """<p>Sort to use for grouping faces in the response. Use <code>TIMESTAMP</code> to group faces by the time that they are recognized. Use <code>INDEX</code> to sort by recognized faces. </p>"""

job_id instance-attribute 

job_id: JobId

The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.

max_results instance-attribute 

max_results: NotRequired[MaxResults]

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

next_token instance-attribute 

next_token: NotRequired[PaginationToken]

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

sort_by instance-attribute 

sort_by: NotRequired[FaceSearchSortBy]

Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.