Start Celebrity Recognition

rekognition_start_celebrity_recognition

R Documentation

Starts asynchronous recognition of celebrities in a stored video

Description

Starts asynchronous recognition of celebrities in a stored video.

Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. start_celebrity_recognition returns a job identifier (JobId) which you use to get the results of the analysis. When celebrity recognition analysis 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 celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call get_celebrity_recognition and pass the job identifier (JobId) from the initial call to start_celebrity_recognition.

For more information, see Recognizing celebrities in the Amazon Rekognition Developer Guide.

Usage

rekognition_start_celebrity_recognition(Video, ClientRequestToken,
  NotificationChannel, JobTag)

Arguments

Video

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

NotificationChannel

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

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