Struct aws_sdk_rekognition::client::fluent_builders::StartFaceSearch

pub struct StartFaceSearch { /* private fields */ }

Fluent builder constructing a request to StartFaceSearch.

Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.

The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceSearch returns a job identifier (JobId) which you use to get the search results once the search has completed. When searching is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. 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 procedure-person-search-videos.

Implementations

impl StartFaceSearch

pub async fn send(
    self
) -> Result<StartFaceSearchOutput, SdkError<StartFaceSearchError>>

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 video(self, input: Video) -> Self

The video you want to search. The video must be stored in an Amazon S3 bucket.

pub fn set_video(self, input: Option<Video>) -> Self

The video you want to search. The video must be stored in an Amazon S3 bucket.

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

Idempotent token used to identify the start request. If you use the same token with multiple StartFaceSearch requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

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

Idempotent token used to identify the start request. If you use the same token with multiple StartFaceSearch requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

pub fn face_match_threshold(self, input: f32) -> Self

The minimum confidence in the person match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

pub fn set_face_match_threshold(self, input: Option<f32>) -> Self

The minimum confidence in the person match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

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

ID of the collection that contains the faces you want to search for.

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

ID of the collection that contains the faces you want to search for.

pub fn notification_channel(self, input: NotificationChannel) -> Self

The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.

pub fn set_notification_channel(
    self,
    input: Option<NotificationChannel>
) -> Self

The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.

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

An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

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

An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

Trait Implementations

impl Clone for StartFaceSearch

fn clone(&self) -> StartFaceSearch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartFaceSearch

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

Formats the value using the given formatter.