com.amazonaws.services.rekognition.model

Class GetPersonTrackingRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rekognition.model.GetPersonTrackingRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class GetPersonTrackingRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

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.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetPersonTrackingRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getJobId() The identifier for a job that tracks persons in a video.
java.lang.Integer	getMaxResults() Maximum number of results to return per paginated call.
java.lang.String	getNextToken() If the previous response was incomplete (because there are more persons to retrieve), Amazon Rekognition Video returns a pagination token in the response.
java.lang.String	getSortBy() Sort to use for elements in the Persons array.
int	hashCode()
void	setJobId(java.lang.String jobId) The identifier for a job that tracks persons in a video.
void	setMaxResults(java.lang.Integer maxResults) Maximum number of results to return per paginated call.
void	setNextToken(java.lang.String nextToken) If the previous response was incomplete (because there are more persons to retrieve), Amazon Rekognition Video returns a pagination token in the response.
void	setSortBy(PersonTrackingSortBy sortBy) Sort to use for elements in the Persons array.
void	setSortBy(java.lang.String sortBy) Sort to use for elements in the Persons array.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
GetPersonTrackingRequest	withJobId(java.lang.String jobId) The identifier for a job that tracks persons in a video.
GetPersonTrackingRequest	withMaxResults(java.lang.Integer maxResults) Maximum number of results to return per paginated call.
GetPersonTrackingRequest	withNextToken(java.lang.String nextToken) If the previous response was incomplete (because there are more persons to retrieve), Amazon Rekognition Video returns a pagination token in the response.
GetPersonTrackingRequest	withSortBy(PersonTrackingSortBy sortBy) Sort to use for elements in the Persons array.
GetPersonTrackingRequest	withSortBy(java.lang.String sortBy) Sort to use for elements in the Persons array.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetPersonTrackingRequest

public GetPersonTrackingRequest()

Method Detail

getJobId

public java.lang.String getJobId()

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

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

Returns:

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

setJobId

public void setJobId(java.lang.String jobId)

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

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

Parameters:

jobId -

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

withJobId

public GetPersonTrackingRequest withJobId(java.lang.String jobId)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

Parameters:

jobId -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxResults

public java.lang.Integer getMaxResults()

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.

Constraints:
Range: 1 -

Returns:

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.

setMaxResults

public void setMaxResults(java.lang.Integer maxResults)

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.

Constraints:
Range: 1 -

Parameters:

maxResults -

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.

withMaxResults

public GetPersonTrackingRequest withMaxResults(java.lang.Integer maxResults)

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 a reference to this object so that method calls can be chained together.

Constraints:
Range: 1 -

Parameters:

maxResults -

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:

A reference to this updated object so that method calls can be chained together.

getNextToken

public java.lang.String getNextToken()

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.

Constraints:
Length: - 255

Returns:

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.

setNextToken

public void setNextToken(java.lang.String nextToken)

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.

Constraints:
Length: - 255

Parameters:

nextToken -

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.

withNextToken

public GetPersonTrackingRequest withNextToken(java.lang.String nextToken)

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 a reference to this object so that method calls can be chained together.

Constraints:
Length: - 255

Parameters:

nextToken -

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:

A reference to this updated object so that method calls can be chained together.

getSortBy

public java.lang.String getSortBy()

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.

Constraints:
Allowed Values: INDEX, TIMESTAMP

Returns:

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.

See Also:

PersonTrackingSortBy

setSortBy

public void setSortBy(java.lang.String sortBy)

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.

Constraints:
Allowed Values: INDEX, TIMESTAMP

Parameters:

sortBy -

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.

See Also:

PersonTrackingSortBy

withSortBy

public GetPersonTrackingRequest withSortBy(java.lang.String sortBy)

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 a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: INDEX, TIMESTAMP

Parameters:

sortBy -

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:

A reference to this updated object so that method calls can be chained together.

See Also:

PersonTrackingSortBy

setSortBy

public void setSortBy(PersonTrackingSortBy sortBy)

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.

Constraints:
Allowed Values: INDEX, TIMESTAMP

Parameters:

sortBy -

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.

See Also:

PersonTrackingSortBy

withSortBy

public GetPersonTrackingRequest withSortBy(PersonTrackingSortBy sortBy)

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 a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: INDEX, TIMESTAMP

Parameters:

sortBy -

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:

A reference to this updated object so that method calls can be chained together.

See Also:

PersonTrackingSortBy

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object