Start Person Tracking

rekognition_start_person_tracking

R Documentation

Starts the asynchronous tracking of a person's path in a stored video

Description

Starts the asynchronous tracking of a person's path in a stored video.

Amazon Rekognition Video can track the path of people in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. start_person_tracking returns a job identifier (JobId) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

To get the results of the person detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call get_person_tracking and pass the job identifier (JobId) from the initial call to start_person_tracking.

Usage

rekognition_start_person_tracking(Video, ClientRequestToken,
  NotificationChannel, JobTag)

Arguments

Video

[required] The video in which you want to detect people. 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_person_tracking 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 you want Amazon Rekognition Video to publish the completion status of the people detection operation 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_person_tracking(
  Video = list(
    S3Object = list(
      Bucket = "string",
      Name = "string",
      Version = "string"
    )
  ),
  ClientRequestToken = "string",
  NotificationChannel = list(
    SNSTopicArn = "string",
    RoleArn = "string"
  ),
  JobTag = "string"
)