Struct aws_sdk_rekognition::client::fluent_builders::GetPersonTracking

pub struct GetPersonTracking { /* private fields */ }

Fluent builder constructing a request to 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.

Implementations

impl GetPersonTracking

pub async fn send(
    self
) -> Result<GetPersonTrackingOutput, SdkError<GetPersonTrackingError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn into_paginator(self) -> GetPersonTrackingPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn job_id(self, input: impl Into<String>) -> Self

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

pub fn set_job_id(self, input: Option<String>) -> Self

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

pub fn max_results(self, input: i32) -> Self

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.

pub fn set_max_results(self, input: Option<i32>) -> Self

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.

pub fn next_token(self, input: impl Into<String>) -> Self

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.

pub fn set_next_token(self, input: Option<String>) -> Self

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.

pub fn sort_by(self, input: PersonTrackingSortBy) -> Self

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.

pub fn set_sort_by(self, input: Option<PersonTrackingSortBy>) -> Self

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.

Trait Implementations

impl Clone for GetPersonTracking

fn clone(&self) -> GetPersonTracking

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetPersonTracking

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.