AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetPersonTrackingRequest as input to an Aws::Client method, you can use a vanilla 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)

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

#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)

    Maximum number of results to return per paginated call.

#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)

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

#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.

Possible values:

  • INDEX
  • TIMESTAMP

Returns:

  • (String)

    Sort to use for elements in the Persons array.