/AWS1/CL_REK=>GETPERSONTRACKING()
¶
About GetPersonTracking¶
Gets the path tracking results of a Amazon Rekognition Video analysis started by StartPersonTracking.
The person path tracking operation is started by a call to StartPersonTracking
which returns a job identifier (JobId
). When the operation finishes, Amazon Rekognition Video publishes a completion status to
the Amazon Simple Notification Service topic registered in the initial call to StartPersonTracking
.
To get the results of the person path tracking operation, first check
that the status value published to the Amazon SNS topic is SUCCEEDED
.
If so, call GetPersonTracking and pass the job identifier
(JobId
) from the initial call to StartPersonTracking
.
GetPersonTracking
returns an array, Persons
, of tracked persons and the time(s) their
paths were tracked in the video.
GetPersonTracking
only returns the default
facial attributes (BoundingBox
, Confidence
,
Landmarks
, Pose
, and Quality
). The other facial attributes listed
in the Face
object of the following response syntax are not returned.
For more information, see FaceDetail in the Amazon Rekognition Developer Guide.
By default, the array is sorted by the time(s) a person's path is tracked in the video.
You can sort by tracked persons by specifying INDEX
for the SortBy
input parameter.
Use the MaxResults
parameter to limit the number of items returned. If there are more results than
specified in MaxResults
, the value of NextToken
in the operation response contains a pagination token for getting the next set
of results. To get the next page of results, call GetPersonTracking
and populate the NextToken
request parameter with the token
value returned from the previous call to GetPersonTracking
.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_JOBID
TYPE /AWS1/REKJOBID
/AWS1/REKJOBID
¶
The identifier for a job that tracks persons in a video. You get the
JobId
from a call toStartPersonTracking
.
Optional arguments:¶
IV_MAXRESULTS
TYPE /AWS1/REKMAXRESULTS
/AWS1/REKMAXRESULTS
¶
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.
IV_NEXTTOKEN
TYPE /AWS1/REKPAGINATIONTOKEN
/AWS1/REKPAGINATIONTOKEN
¶
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.
IV_SORTBY
TYPE /AWS1/REKPERSONTRACKINGSORTBY
/AWS1/REKPERSONTRACKINGSORTBY
¶
Sort to use for elements in the
Persons
array. UseTIMESTAMP
to sort array elements by the time persons are detected. UseINDEX
to sort by the tracked persons. If you sort byINDEX
, the array elements for each person are sorted by detection confidence. The default sort is byTIMESTAMP
.