Struct aws_sdk_rekognition::operation::start_face_detection::StartFaceDetectionInput

#[non_exhaustive]
pub struct StartFaceDetectionInput {
    pub video: Option<Video>,
    pub client_request_token: Option<String>,
    pub notification_channel: Option<NotificationChannel>,
    pub face_attributes: Option<FaceAttributes>,
    pub job_tag: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

video: Option<Video>

The video in which you want to detect faces. The video must be stored in an Amazon S3 bucket.

client_request_token: Option<String>

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.

notification_channel: Option<NotificationChannel>

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.

face_attributes: Option<FaceAttributes>

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.

job_tag: Option<String>

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.

Implementations

impl StartFaceDetectionInput

pub fn video(&self) -> Option<&Video>

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) -> Option<&str>

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) -> Option<&NotificationChannel>

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) -> Option<&FaceAttributes>

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) -> Option<&str>

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.

impl StartFaceDetectionInput

pub fn builder() -> StartFaceDetectionInputBuilder

Creates a new builder-style object to manufacture StartFaceDetectionInput.

Trait Implementations

impl Clone for StartFaceDetectionInput

fn clone(&self) -> StartFaceDetectionInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartFaceDetectionInput

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

Formats the value using the given formatter.

impl PartialEq for StartFaceDetectionInput

fn eq(&self, other: &StartFaceDetectionInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StartFaceDetectionInput