Struct aws_sdk_rekognition::client::fluent_builders::GetFaceSearch

pub struct GetFaceSearch { /* private fields */ }

Fluent builder constructing a request to GetFaceSearch.

Gets the face search results for Amazon Rekognition Video face search started by StartFaceSearch. The search returns faces in a collection that match the faces of persons detected in a video. It also includes the time(s) that faces are matched in the video.

Face search in a video is an asynchronous operation. You start face search by calling to StartFaceSearch which returns a job identifier (JobId). When the search operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceSearch. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier (JobId) from the initial call to StartFaceSearch.

For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.

The search results are retured in an array, Persons, of PersonMatch objects. EachPersonMatch element contains details about the matching faces in the input collection, person information (facial attributes, bounding boxes, and person identifer) for the matched person, and the time the person was matched in the video.

GetFaceSearch 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 Persons array is sorted by the time, in milliseconds from the start of the video, persons are matched. You can also sort by persons by specifying INDEX for the SORTBY input parameter.

Implementations

impl GetFaceSearch

pub async fn customize(
    self
) -> Result<CustomizableOperation<GetFaceSearch, AwsResponseRetryClassifier>, SdkError<GetFaceSearchError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<GetFaceSearchOutput, SdkError<GetFaceSearchError>>

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

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 job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.

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

The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.

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 is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.

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

If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.

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

Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

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

Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

Trait Implementations

impl Clone for GetFaceSearch

fn clone(&self) -> GetFaceSearch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetFaceSearch

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

Formats the value using the given formatter.