| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Rekognition.DetectFaces
Description
Detects faces within an image that is provided as input.
DetectFaces detects the 100 largest faces in the image. For each face
detected, the operation returns face details. These details include a
bounding box of the face, a confidence value (that the bounding box
contains a face), and a fixed set of attributes such as facial landmarks
(for example, coordinates of eye and mouth), presence of beard,
sunglasses, and so on.
The face-detection algorithm is most effective on frontal faces. For non-frontal or obscured faces, the algorithm might not detect the faces or might detect faces with lower confidence.
You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.
This is a stateless API operation. That is, the operation does not persist any data.
This operation requires permissions to perform the
rekognition:DetectFaces action.
Synopsis
- data DetectFaces = DetectFaces' {
- attributes :: Maybe [Attribute]
- image :: Image
- newDetectFaces :: Image -> DetectFaces
- detectFaces_attributes :: Lens' DetectFaces (Maybe [Attribute])
- detectFaces_image :: Lens' DetectFaces Image
- data DetectFacesResponse = DetectFacesResponse' {}
- newDetectFacesResponse :: Int -> DetectFacesResponse
- detectFacesResponse_orientationCorrection :: Lens' DetectFacesResponse (Maybe OrientationCorrection)
- detectFacesResponse_faceDetails :: Lens' DetectFacesResponse (Maybe [FaceDetail])
- detectFacesResponse_httpStatus :: Lens' DetectFacesResponse Int
Creating a Request
data DetectFaces Source #
See: newDetectFaces smart constructor.
Constructors
| DetectFaces' | |
Fields
| |
Instances
Arguments
| :: Image | |
| -> DetectFaces |
Create a value of DetectFaces with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributes:DetectFaces', detectFaces_attributes - An array of facial attributes 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).
$sel:image:DetectFaces', detectFaces_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 is not 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.
Request Lenses
detectFaces_attributes :: Lens' DetectFaces (Maybe [Attribute]) Source #
An array of facial attributes 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).
detectFaces_image :: Lens' DetectFaces Image Source #
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 is not 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.
Destructuring the Response
data DetectFacesResponse Source #
See: newDetectFacesResponse smart constructor.
Constructors
| DetectFacesResponse' | |
Fields
| |
Instances
newDetectFacesResponse Source #
Arguments
| :: Int | |
| -> DetectFacesResponse |
Create a value of DetectFacesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:orientationCorrection:DetectFacesResponse', detectFacesResponse_orientationCorrection - The value of OrientationCorrection is always null.
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.
Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.
$sel:faceDetails:DetectFacesResponse', detectFacesResponse_faceDetails - Details of each face found in the image.
$sel:httpStatus:DetectFacesResponse', detectFacesResponse_httpStatus - The response's http status code.
Response Lenses
detectFacesResponse_orientationCorrection :: Lens' DetectFacesResponse (Maybe OrientationCorrection) Source #
The value of OrientationCorrection is always null.
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.
Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.
detectFacesResponse_faceDetails :: Lens' DetectFacesResponse (Maybe [FaceDetail]) Source #
Details of each face found in the image.
detectFacesResponse_httpStatus :: Lens' DetectFacesResponse Int Source #
The response's http status code.