Class: Aws::Rekognition::Types::GetPersonTrackingRequest

Inherits:

Struct

• Object
• Struct
• Aws::Rekognition::Types::GetPersonTrackingRequest

Defined in:

gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #job_id ⇒ String

  The identifier for a job that tracks persons in a video.

• #max_results ⇒ Integer

  Maximum number of results to return per paginated call.

• #next_token ⇒ String

  If the previous response was incomplete (because there are more persons to retrieve), Amazon Rekognition Video returns a pagination token in the response.

• #sort_by ⇒ String

  Sort to use for elements in the Persons array.

Instance Attribute Details

#job_id ⇒ String

The identifier for a job that tracks persons in a video. You get the JobId from a call to StartPersonTracking.

Returns:

• (String)

# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3095

class GetPersonTrackingRequest < Struct.new(
  :job_id,
  :max_results,
  :next_token,
  :sort_by)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

Returns:

• (Integer)

# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3095

class GetPersonTrackingRequest < Struct.new(
  :job_id,
  :max_results,
  :next_token,
  :sort_by)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

If the previous response was incomplete (because there are more persons to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of persons.

Returns:

• (String)

# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3095

class GetPersonTrackingRequest < Struct.new(
  :job_id,
  :max_results,
  :next_token,
  :sort_by)
  SENSITIVE = []
  include Aws::Structure
end

#sort_by ⇒ String

Sort to use for elements in the Persons array. Use TIMESTAMP to sort array elements by the time persons are detected. Use INDEX to sort by the tracked persons. If you sort by INDEX, the array elements for each person are sorted by detection confidence. The default sort is by TIMESTAMP.

Returns:

• (String)

# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3095

class GetPersonTrackingRequest < Struct.new(
  :job_id,
  :max_results,
  :next_token,
  :sort_by)
  SENSITIVE = []
  include Aws::Structure
end