AWS SDK Version 3 for .NET
API Reference

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 StartFaceSearch operation. Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.

The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceSearch returns a job identifier (JobId) which you use to get the search results once the search has completed. When searching is finished, Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call and pass the job identifier (JobId) from the initial call to StartFaceSearch. For more information, see collections-search-person.

Inheritance Hierarchy


Namespace: Amazon.Rekognition.Model
Assembly: AWSSDK.Rekognition.dll
Version: 3.x.y.z


public class StartFaceSearchRequest : AmazonRekognitionRequest

The StartFaceSearchRequest type exposes the following members


Public Method StartFaceSearchRequest()


Public Property ClientRequestToken System.String

Gets and sets the property ClientRequestToken.

Idempotent token used to identify the start request. If you use the same token with multiple StartFaceSearch requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

Public Property CollectionId System.String

Gets and sets the property CollectionId.

ID of the collection that contains the faces you want to search for.

Public Property FaceMatchThreshold System.Single

Gets and sets the property FaceMatchThreshold.

The minimum confidence in the person match to return. For example, don't return any matches where confidence in matches is less than 70%.

Public Property JobTag System.String

Gets and sets the property JobTag.

Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.

Public Property NotificationChannel Amazon.Rekognition.Model.NotificationChannel

Gets and sets the property NotificationChannel.

The ARN of the Amazon SNS topic to which you want Rekognition Video to publish the completion status of the search.

Public Property Video Amazon.Rekognition.Model.Video

Gets and sets the property Video.

The video you want to search. The video must be stored in an Amazon S3 bucket.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms