Struct aws_sdk_rekognition::operation::get_face_detection::builders::GetFaceDetectionFluentBuilder

pub struct GetFaceDetectionFluentBuilder { /* private fields */ }

Fluent builder constructing a request to GetFaceDetection.

Gets face detection results for a Amazon Rekognition Video analysis started by StartFaceDetection.

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

GetFaceDetection returns an array of detected faces (Faces) sorted by the time the faces were detected.

Use MaxResults parameter to limit the number of labels 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 GetFaceDetection and populate the NextToken request parameter with the token value returned from the previous call to GetFaceDetection.

Note that for the GetFaceDetection operation, the returned values for FaceOccluded and EyeDirection will always be "null".

Implementations

impl GetFaceDetectionFluentBuilder

pub fn as_input(&self) -> &GetFaceDetectionInputBuilder

Access the GetFaceDetection as a reference.

pub async fn send( self ) -> Result<GetFaceDetectionOutput, SdkError<GetFaceDetectionError, HttpResponse>>

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 customize( self ) -> CustomizableOperation<GetFaceDetectionOutput, GetFaceDetectionError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn into_paginator(self) -> GetFaceDetectionPaginator

Create a paginator for this request

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

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

Unique identifier for the face detection job. The JobId is returned from StartFaceDetection.

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

Unique identifier for the face detection job. The JobId is returned from StartFaceDetection.

pub fn get_job_id(&self) -> &Option<String>

Unique identifier for the face detection job. The JobId is returned from StartFaceDetection.

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 get_max_results(&self) -> &Option<i32>

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

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

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

pub fn get_next_token(&self) -> &Option<String>

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

Trait Implementations

impl Clone for GetFaceDetectionFluentBuilder

fn clone(&self) -> GetFaceDetectionFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetFaceDetectionFluentBuilder

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

Formats the value using the given formatter.