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

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

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 GetPersonTrackingRequest data as a hash:

{
  job_id: "JobId", # required
  max_results: 1,
  next_token: "PaginationToken",
  sort_by: "INDEX", # accepts INDEX, TIMESTAMP
}

Instance Attribute Summary collapse

Instance Attribute Details

#job_idString

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

Returns:

  • (String)


1646
1647
1648
1649
1650
1651
1652
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1646

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

#max_resultsInteger

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)


1646
1647
1648
1649
1650
1651
1652
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1646

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

#next_tokenString

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)


1646
1647
1648
1649
1650
1651
1652
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1646

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

#sort_byString

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)


1646
1647
1648
1649
1650
1651
1652
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1646

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