Skip to content

Start Face Detection

rekognition_start_face_detection R Documentation

Starts asynchronous detection of faces in a stored video

Description

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. start_face_detection 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 get_face_detection and pass the job identifier (JobId) from the initial call to start_face_detection.

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

Usage

rekognition_start_face_detection(Video, ClientRequestToken,
  NotificationChannel, FaceAttributes, JobTag)

Arguments

Video

[required] The video in which you want to detect faces. The video must be stored in an Amazon S3 bucket.

ClientRequestToken

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

NotificationChannel

The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the face detection operation. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

FaceAttributes

The face attributes you want returned.

DEFAULT - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks.

ALL - All facial attributes are returned.

JobTag

An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

Value

A list with the following syntax: 

list(
  JobId = "string"
)

Request syntax

svc$start_face_detection(
  Video = list(
    S3Object = list(
      Bucket = "string",
      Name = "string",
      Version = "string"
    )
  ),
  ClientRequestToken = "string",
  NotificationChannel = list(
    SNSTopicArn = "string",
    RoleArn = "string"
  ),
  FaceAttributes = "DEFAULT"|"ALL",
  JobTag = "string"
)