You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Rekognition::Types::StartPersonTrackingRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb

Overview

Note:

When making an API call, you may pass StartPersonTrackingRequest data as a 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

Instance Attribute Details

#client_request_tokenString

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.

Returns:

  • (String)


2945
2946
2947
2948
2949
2950
2951
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2945

class StartPersonTrackingRequest < Struct.new(
  :video,
  :client_request_token,
  :notification_channel,
  :job_tag)
  include Aws::Structure
end

#job_tagString

Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.

Returns:

  • (String)


2945
2946
2947
2948
2949
2950
2951
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2945

class StartPersonTrackingRequest < Struct.new(
  :video,
  :client_request_token,
  :notification_channel,
  :job_tag)
  include Aws::Structure
end

#notification_channelTypes::NotificationChannel

The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection operation to.



2945
2946
2947
2948
2949
2950
2951
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2945

class StartPersonTrackingRequest < Struct.new(
  :video,
  :client_request_token,
  :notification_channel,
  :job_tag)
  include Aws::Structure
end

#videoTypes::Video

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

Returns:



2945
2946
2947
2948
2949
2950
2951
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2945

class StartPersonTrackingRequest < Struct.new(
  :video,
  :client_request_token,
  :notification_channel,
  :job_tag)
  include Aws::Structure
end