Struct rusoto_rekognition::IndexFacesRequest
source · [−]pub struct IndexFacesRequest {
pub collection_id: String,
pub detection_attributes: Option<Vec<String>>,
pub external_image_id: Option<String>,
pub image: Image,
pub max_faces: Option<i64>,
pub quality_filter: Option<String>,
}
Fields
collection_id: String
The ID of an existing collection to which you want to add the faces that are detected in the input images.
detection_attributes: Option<Vec<String>>
An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes
or if you specify ["DEFAULT"]
, the API returns the following subset of facial attributes: BoundingBox
, Confidence
, Pose
, Quality
, and Landmarks
. If you provide ["ALL"]
, all facial attributes are returned, but the operation takes longer to complete.
If you provide both, ["ALL", "DEFAULT"]
, the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).
external_image_id: Option<String>
The ID you want to assign to all the faces detected in the image.
image: Image
The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes isn't supported.
If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes
field. For more information, see Images in the Amazon Rekognition developer guide.
max_faces: Option<i64>
The maximum number of faces to index. The value of MaxFaces
must be greater than or equal to 1. IndexFaces
returns no more than 100 detected faces in an image, even if you specify a larger value for MaxFaces
.
If IndexFaces
detects more faces than the value of MaxFaces
, the faces with the lowest quality are filtered out first. If there are still more faces than the value of MaxFaces
, the faces with the smallest bounding boxes are filtered out (up to the number that's needed to satisfy the value of MaxFaces
). Information about the unindexed faces is available in the UnindexedFaces
array.
The faces that are returned by IndexFaces
are sorted by the largest face bounding box size to the smallest size, in descending order.
MaxFaces
can be used with a collection associated with any version of the face model.
quality_filter: Option<String>
A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't indexed. If you specify AUTO
, Amazon Rekognition chooses the quality bar. If you specify LOW
, MEDIUM
, or HIGH
, filtering removes all faces that don’t meet the chosen quality bar. The default value is AUTO
. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify NONE
, no filtering is performed.
To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.
Trait Implementations
sourceimpl Clone for IndexFacesRequest
impl Clone for IndexFacesRequest
sourcefn clone(&self) -> IndexFacesRequest
fn clone(&self) -> IndexFacesRequest
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for IndexFacesRequest
impl Debug for IndexFacesRequest
sourceimpl Default for IndexFacesRequest
impl Default for IndexFacesRequest
sourcefn default() -> IndexFacesRequest
fn default() -> IndexFacesRequest
Returns the “default value” for a type. Read more
sourceimpl PartialEq<IndexFacesRequest> for IndexFacesRequest
impl PartialEq<IndexFacesRequest> for IndexFacesRequest
sourcefn eq(&self, other: &IndexFacesRequest) -> bool
fn eq(&self, other: &IndexFacesRequest) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &IndexFacesRequest) -> bool
fn ne(&self, other: &IndexFacesRequest) -> bool
This method tests for !=
.
sourceimpl Serialize for IndexFacesRequest
impl Serialize for IndexFacesRequest
impl StructuralPartialEq for IndexFacesRequest
Auto Trait Implementations
impl RefUnwindSafe for IndexFacesRequest
impl Send for IndexFacesRequest
impl Sync for IndexFacesRequest
impl Unpin for IndexFacesRequest
impl UnwindSafe for IndexFacesRequest
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more