Skip to content

Start Face Search

rekognition_start_face_search R Documentation

Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video

Description

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. start_face_search returns a job identifier (JobId) which you use to get the search results once the search has completed. When searching is finished, Amazon 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 get_face_search and pass the job identifier (JobId) from the initial call to start_face_search. For more information, see Searching stored videos for faces.

Usage

rekognition_start_face_search(Video, ClientRequestToken,
  FaceMatchThreshold, CollectionId, NotificationChannel, JobTag)

Arguments

Video

[required] The video you want to search. 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_search requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

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%. The default value is 80%.

CollectionId

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

NotificationChannel

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

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_search(
  Video = list(
    S3Object = list(
      Bucket = "string",
      Name = "string",
      Version = "string"
    )
  ),
  ClientRequestToken = "string",
  FaceMatchThreshold = 123.0,
  CollectionId = "string",
  NotificationChannel = list(
    SNSTopicArn = "string",
    RoleArn = "string"
  ),
  JobTag = "string"
)