Container for the parameters to the GetFaceDetection operation. Gets face detection results for a Amazon Rekognition Video analysis started by StartFaceDetection.
Face detection with Amazon Rekognition Video is an asynchronous operation. You start
face detection by calling StartFaceDetection which returns a job identifier
(JobId). When the face detection operation finishes, Amazon Rekognition Video
publishes a completion status to the Amazon Simple Notification Service topic registered
in the initial call to StartFaceDetection. To get the results of the face detection
operation, first check that the status value published to the Amazon SNS topic is
SUCCEEDED. If so, call GetFaceDetection and pass the job identifier
(JobId) from the initial call to StartFaceDetection.
GetFaceDetection returns an array of detected faces (Faces) sorted
by the time the faces were detected.
Use MaxResults parameter to limit the number of labels returned. If there are more
results than specified in MaxResults, the value of NextToken in the
operation response contains a pagination token for getting the next set of results.
To get the next page of results, call GetFaceDetection and populate the NextToken
request parameter with the token value returned from the previous call to GetFaceDetection.
Note that for the GetFaceDetection operation, the returned values for FaceOccluded
and EyeDirection will always be "null".
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.Rekognition.AmazonRekognitionRequest
Amazon.Rekognition.Model.GetFaceDetectionRequest
Namespace: Amazon.Rekognition.Model
Assembly: AWSSDK.Rekognition.dll
Version: 3.x.y.z
Syntax
public class GetFaceDetectionRequest : AmazonRekognitionRequest IAmazonWebServiceRequest
The GetFaceDetectionRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
GetFaceDetectionRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
JobId | System.String |
Gets and sets the property JobId.
Unique identifier for the face detection job. The |
|
|
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 are more faces to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces. |
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5