Struct SearchUsersByImageInput 

#[non_exhaustive]
pub struct SearchUsersByImageInput {
    pub collection_id: Option<String>,
    pub image: Option<Image>,
    pub user_match_threshold: Option<f32>,
    pub max_users: Option<i32>,
    pub quality_filter: Option<QualityFilter>,
}

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.

collection_id: Option<String>

The ID of an existing collection containing the UserID.

image: Option<Image>

Provides the input image either as bytes or an S3 object.

You pass image bytes to an Amazon Rekognition API operation by using the Bytes property. For example, you would use the Bytes property to pass an image loaded from a local file system. Image bytes passed by using the Bytes property must be base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to call Amazon Rekognition API operations.

For more information, see Analyzing an Image Loaded from a Local File System in the Amazon Rekognition Developer Guide.

You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the S3Object property. Images stored in an S3 bucket do not need to be base64-encoded.

The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes using the Bytes property is not supported. You must first upload the image to an Amazon S3 bucket and then call the operation using the S3Object property.

For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition Developer Guide.

user_match_threshold: Option<f32>

Specifies the minimum confidence in the UserID match to return. Default value is 80.

max_users: Option<i32>

Maximum number of UserIDs to return.

quality_filter: Option<QualityFilter>

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. The default value is NONE.

Implementations

impl SearchUsersByImageInput

pub fn collection_id(&self) -> Option<&str>

The ID of an existing collection containing the UserID.

pub fn image(&self) -> Option<&Image>

Provides the input image either as bytes or an S3 object.

You pass image bytes to an Amazon Rekognition API operation by using the Bytes property. For example, you would use the Bytes property to pass an image loaded from a local file system. Image bytes passed by using the Bytes property must be base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to call Amazon Rekognition API operations.

For more information, see Analyzing an Image Loaded from a Local File System in the Amazon Rekognition Developer Guide.

You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the S3Object property. Images stored in an S3 bucket do not need to be base64-encoded.

The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes using the Bytes property is not supported. You must first upload the image to an Amazon S3 bucket and then call the operation using the S3Object property.

For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition Developer Guide.

pub fn user_match_threshold(&self) -> Option<f32>

Specifies the minimum confidence in the UserID match to return. Default value is 80.

pub fn max_users(&self) -> Option<i32>

Maximum number of UserIDs to return.

pub fn quality_filter(&self) -> Option<&QualityFilter>

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. The default value is NONE.

impl SearchUsersByImageInput

pub fn builder() -> SearchUsersByImageInputBuilder

Creates a new builder-style object to manufacture SearchUsersByImageInput.

Trait Implementations

impl Clone for SearchUsersByImageInput

fn clone(&self) -> SearchUsersByImageInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchUsersByImageInput

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

Formats the value using the given formatter.

impl PartialEq for SearchUsersByImageInput

fn eq(&self, other: &SearchUsersByImageInput) -> 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 SearchUsersByImageInput