AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Gets the face search results for Amazon Rekognition Video face search started by StartFaceSearch. The search returns faces in a collection that match the faces of persons detected in a video. It also includes the time(s) that faces are matched in the video.
Face search in a video is an asynchronous operation. You start face search by calling
to StartFaceSearch which returns a job identifier (JobId). When the
search operation finishes, Amazon Rekognition Video publishes a completion status
to the Amazon Simple Notification Service topic registered in the initial call to
StartFaceSearch. To get the search results, first check that the status value
published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceSearch
and pass the job identifier (JobId) from the initial call to StartFaceSearch.
For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.
The search results are retured in an array, Persons, of PersonMatch
objects. EachPersonMatch element contains details about the matching faces
in the input collection, person information (facial attributes, bounding boxes, and
person identifer) for the matched person, and the time the person was matched in the
video.
GetFaceSearch only returns the default facial attributes (BoundingBox,
Confidence, Landmarks, Pose, and Quality). The other facial
attributes listed in the Face object of the following response syntax are not
returned. For more information, see FaceDetail in the Amazon Rekognition Developer
Guide.
By default, the Persons array is sorted by the time, in milliseconds from the
start of the video, persons are matched. You can also sort by persons by specifying
INDEX for the SORTBY input parameter.
For .NET Core this operation is only available in asynchronous form. Please refer to GetFaceSearchAsync.
Namespace: Amazon.Rekognition
Assembly: AWSSDK.Rekognition.dll
Version: 3.x.y.z
public virtual GetFaceSearchResponse GetFaceSearch( GetFaceSearchRequest request )
Container for the necessary parameters to execute the GetFaceSearch service method.
| Exception | Condition |
|---|---|
| AccessDeniedException | You are not authorized to perform the action. |
| InternalServerErrorException | Amazon Rekognition experienced a service issue. Try your call again. |
| InvalidPaginationTokenException | Pagination token in the request is not valid. |
| InvalidParameterException | Input parameter violated a constraint. Validate your parameter before calling the API operation again. |
| ProvisionedThroughputExceededException | The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition. |
| ResourceNotFoundException | The resource specified in the request cannot be found. |
| ThrottlingException | Amazon Rekognition is temporarily unable to process the request. Try your call again. |
.NET Framework:
Supported in: 4.5 and newer, 3.5