Struct StartFaceSearchInput 

#[non_exhaustive]
pub struct StartFaceSearchInput {
    pub video: Option<Video>,
    pub client_request_token: Option<String>,
    pub face_match_threshold: Option<f32>,
    pub collection_id: Option<String>,
    pub notification_channel: Option<NotificationChannel>,
    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 you want to search. 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 StartFaceSearch requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

face_match_threshold: Option<f32>

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%.

collection_id: Option<String>

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

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 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.

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 StartFaceSearchInput

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

The video you want to search. 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 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) -> Option<f32>

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

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

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

pub fn builder() -> StartFaceSearchInputBuilder

Creates a new builder-style object to manufacture StartFaceSearchInput.

Trait Implementations

impl Clone for StartFaceSearchInput

fn clone(&self) -> StartFaceSearchInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StartFaceSearchInput

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

Formats the value using the given formatter.

impl PartialEq for StartFaceSearchInput

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for StartFaceSearchInput