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.
Container for the parameters to the GetFaceSearch operation. 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.
Namespace: Amazon.Rekognition.Model
Assembly: AWSSDK.Rekognition.dll
Version: 3.x.y.z
public class GetFaceSearchRequest : AmazonRekognitionRequest IAmazonWebServiceRequest
The GetFaceSearchRequest type exposes the following members
Name | Description | |
---|---|---|
GetFaceSearchRequest() |
Name | Type | Description | |
---|---|---|---|
JobId | System.String |
Gets and sets the property JobId.
The job identifer for the search request. You get the job identifier from an initial
call to |
|
MaxResults | System.Int32 |
Gets and sets the property 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. |
|
NextToken | System.String |
Gets and sets the property NextToken. 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. |
|
SortBy | Amazon.Rekognition.FaceSearchSortBy |
Gets and sets the property SortBy.
Sort to use for grouping faces in the response. Use |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5