You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Rekognition::Types::StartPersonTrackingRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Rekognition::Types::StartPersonTrackingRequest
- Defined in:
- (unknown)
Overview
When passing StartPersonTrackingRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
video: { # required
s3_object: {
bucket: "S3Bucket",
name: "S3ObjectName",
version: "S3ObjectVersion",
},
},
client_request_token: "ClientRequestToken",
notification_channel: {
sns_topic_arn: "SNSTopicArn", # required
role_arn: "RoleArn", # required
},
job_tag: "JobTag",
}
Instance Attribute Summary collapse
-
#client_request_token ⇒ String
Idempotent token used to identify the start request.
-
#job_tag ⇒ String
An identifier you specify that\'s returned in the completion notification that\'s published to your Amazon Simple Notification Service topic.
-
#notification_channel ⇒ Types::NotificationChannel
The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection operation to.
-
#video ⇒ Types::Video
The video in which you want to detect people.
Instance Attribute Details
#client_request_token ⇒ String
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.
#job_tag ⇒ String
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.
#notification_channel ⇒ Types::NotificationChannel
The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection operation to.
#video ⇒ Types::Video
The video in which you want to detect people. The video must be stored in an Amazon S3 bucket.