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.

Starts asynchronous detection of faces in a stored video.

Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceDetection returns a job identifier (JobId) that you use to get the results of the operation. When face detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. 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.

For more information, see Detecting faces in a stored video in the Amazon Rekognition Developer Guide.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to StartFaceDetectionAsync.

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

Syntax

C#
public virtual StartFaceDetectionResponse StartFaceDetection(
         StartFaceDetectionRequest request
)

Parameters

request
Type: Amazon.Rekognition.Model.StartFaceDetectionRequest

Container for the necessary parameters to execute the StartFaceDetection service method.

Return Value


The response from the StartFaceDetection service method, as returned by Rekognition.

Exceptions

ExceptionCondition
AccessDeniedException You are not authorized to perform the action.
IdempotentParameterMismatchException A ClientRequestToken input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.
InternalServerErrorException Amazon Rekognition experienced a service issue. Try your call again.
InvalidParameterException Input parameter violated a constraint. Validate your parameter before calling the API operation again.
InvalidS3ObjectException Amazon Rekognition is unable to access the S3 object specified in the request.
LimitExceededException An Amazon Rekognition service limit was exceeded. For example, if you start too many jobs concurrently, subsequent calls to start operations (ex: StartLabelDetection) will raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Rekognition service limit.
ProvisionedThroughputExceededException The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.
ThrottlingException Amazon Rekognition is temporarily unable to process the request. Try your call again.
VideoTooLargeException The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum duration is 6 hours.

Version Information

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

See Also