Module Values.StartPersonTrackingRequestSource

End of support notice: On October 31, 2025, AWS will discontinue support for Amazon Rekognition People Pathing. After October 31, 2025, you will no longer be able to use the Rekognition People Pathing capability. For more information, visit this blog post. 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. StartPersonTracking 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 GetPersonTracking and pass the job identifier (JobId) from the initial call to StartPersonTracking.

Sourcetype nonrec t = {
  1. video : Video.t;
    (*

    The video in which you want to detect people. The video must be stored in an Amazon S3 bucket.

    *)
  2. clientRequestToken : ClientRequestToken.t option;
    (*

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

    *)
  3. notificationChannel : NotificationChannel.t option;
    (*

    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.

    *)
  4. jobTag : JobTag.t option;
    (*

    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.

    *)
}
Sourceval context_ : string
Sourceval make : ?clientRequestToken:??? -> ?notificationChannel:??? -> ?jobTag:??? -> video:Video.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `String of ClientRequestToken.t | `Structure of (string * [> `String of SNSTopicArn.t | `Structure of (string * [> `String of S3Bucket.t ]) list ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t