IndexFacesRequest
Types
Properties
The ID of an existing collection to which you want to add the faces that are detected in the input images.
An array of facial attributes you want to be returned. A DEFAULT
subset of facial attributes - BoundingBox
, Confidence
, Pose
, Quality
, and Landmarks
- will always be returned. You can request for specific facial attributes (in addition to the default list) - by using ["DEFAULT", "FACE_OCCLUDED"]
or just ["FACE_OCCLUDED"]
. You can request for all facial attributes by using ["ALL"]
. Requesting more attributes may increase response time.
The ID you want to assign to all the faces detected in the image.
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.