Struct aws_sdk_rekognition::client::fluent_builders::StartFaceDetection

pub struct StartFaceDetection { /* private fields */ }

Fluent builder constructing a request to StartFaceDetection.

Starts asynchronous detection of faces in a stored video.

Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceDetection returns a job identifier (JobId) that you use to get the results of the operation. When face detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. 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.

For more information, see Detecting Faces in a Stored Video in the Amazon Rekognition Developer Guide.

Implementations

impl StartFaceDetection

pub async fn send(
    self
) -> Result<StartFaceDetectionOutput, SdkError<StartFaceDetectionError>>

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 in which you want to detect faces. The video must be stored in an Amazon S3 bucket.

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

The video in which you want to detect faces. 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 StartFaceDetection 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 StartFaceDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

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 face detection operation. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

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 face detection operation. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

pub fn face_attributes(self, input: FaceAttributes) -> Self

The face attributes you want returned.

DEFAULT - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks.

ALL - All facial attributes are returned.

pub fn set_face_attributes(self, input: Option<FaceAttributes>) -> Self

The face attributes you want returned.

DEFAULT - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks.

ALL - All facial attributes are returned.

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 StartFaceDetection

fn clone(&self) -> StartFaceDetection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartFaceDetection

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

Formats the value using the given formatter.