Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

DetectFacesCommand

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), pose, presence of facial occlusion, 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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { RekognitionClient, DetectFacesCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
// const { RekognitionClient, DetectFacesCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
const client = new RekognitionClient(config);
const input = { // DetectFacesRequest
  Image: { // Image
    Bytes: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
    S3Object: { // S3Object
      Bucket: "STRING_VALUE",
      Name: "STRING_VALUE",
      Version: "STRING_VALUE",
    },
  },
  Attributes: [ // Attributes
    "DEFAULT" || "ALL" || "AGE_RANGE" || "BEARD" || "EMOTIONS" || "EYE_DIRECTION" || "EYEGLASSES" || "EYES_OPEN" || "GENDER" || "MOUTH_OPEN" || "MUSTACHE" || "FACE_OCCLUDED" || "SMILE" || "SUNGLASSES",
  ],
};
const command = new DetectFacesCommand(input);
const response = await client.send(command);
// { // DetectFacesResponse
//   FaceDetails: [ // FaceDetailList
//     { // FaceDetail
//       BoundingBox: { // BoundingBox
//         Width: Number("float"),
//         Height: Number("float"),
//         Left: Number("float"),
//         Top: Number("float"),
//       },
//       AgeRange: { // AgeRange
//         Low: Number("int"),
//         High: Number("int"),
//       },
//       Smile: { // Smile
//         Value: true || false,
//         Confidence: Number("float"),
//       },
//       Eyeglasses: { // Eyeglasses
//         Value: true || false,
//         Confidence: Number("float"),
//       },
//       Sunglasses: { // Sunglasses
//         Value: true || false,
//         Confidence: Number("float"),
//       },
//       Gender: { // Gender
//         Value: "Male" || "Female",
//         Confidence: Number("float"),
//       },
//       Beard: { // Beard
//         Value: true || false,
//         Confidence: Number("float"),
//       },
//       Mustache: { // Mustache
//         Value: true || false,
//         Confidence: Number("float"),
//       },
//       EyesOpen: { // EyeOpen
//         Value: true || false,
//         Confidence: Number("float"),
//       },
//       MouthOpen: { // MouthOpen
//         Value: true || false,
//         Confidence: Number("float"),
//       },
//       Emotions: [ // Emotions
//         { // Emotion
//           Type: "HAPPY" || "SAD" || "ANGRY" || "CONFUSED" || "DISGUSTED" || "SURPRISED" || "CALM" || "UNKNOWN" || "FEAR",
//           Confidence: Number("float"),
//         },
//       ],
//       Landmarks: [ // Landmarks
//         { // Landmark
//           Type: "eyeLeft" || "eyeRight" || "nose" || "mouthLeft" || "mouthRight" || "leftEyeBrowLeft" || "leftEyeBrowRight" || "leftEyeBrowUp" || "rightEyeBrowLeft" || "rightEyeBrowRight" || "rightEyeBrowUp" || "leftEyeLeft" || "leftEyeRight" || "leftEyeUp" || "leftEyeDown" || "rightEyeLeft" || "rightEyeRight" || "rightEyeUp" || "rightEyeDown" || "noseLeft" || "noseRight" || "mouthUp" || "mouthDown" || "leftPupil" || "rightPupil" || "upperJawlineLeft" || "midJawlineLeft" || "chinBottom" || "midJawlineRight" || "upperJawlineRight",
//           X: Number("float"),
//           Y: Number("float"),
//         },
//       ],
//       Pose: { // Pose
//         Roll: Number("float"),
//         Yaw: Number("float"),
//         Pitch: Number("float"),
//       },
//       Quality: { // ImageQuality
//         Brightness: Number("float"),
//         Sharpness: Number("float"),
//       },
//       Confidence: Number("float"),
//       FaceOccluded: { // FaceOccluded
//         Value: true || false,
//         Confidence: Number("float"),
//       },
//       EyeDirection: { // EyeDirection
//         Yaw: Number("float"),
//         Pitch: Number("float"),
//         Confidence: Number("float"),
//       },
//     },
//   ],
//   OrientationCorrection: "ROTATE_0" || "ROTATE_90" || "ROTATE_180" || "ROTATE_270",
// };

Example Usage

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
// This operation detects faces in an image stored in an AWS S3 bucket.
const input = {
  "Image": {
    "S3Object": {
      "Bucket": "mybucket",
      "Name": "myphoto"
    }
  }
};
const command = new DetectFacesCommand(input);
const response = await client.send(command);
/* response ==
{
  "FaceDetails": [
    {
      "BoundingBox": {
        "Height": 0.18000000715255737,
        "Left": 0.5555555820465088,
        "Top": 0.33666667342185974,
        "Width": 0.23999999463558197
      },
      "Confidence": 100,
      "Landmarks": [
        {
          "Type": "eyeLeft",
          "X": 0.6394737362861633,
          "Y": 0.40819624066352844
        },
        {
          "Type": "eyeRight",
          "X": 0.7266660928726196,
          "Y": 0.41039225459098816
        },
        {
          "Type": "eyeRight",
          "X": 0.6912462115287781,
          "Y": 0.44240960478782654
        },
        {
          "Type": "mouthDown",
          "X": 0.6306198239326477,
          "Y": 0.46700039505958557
        },
        {
          "Type": "mouthUp",
          "X": 0.7215608954429626,
          "Y": 0.47114261984825134
        }
      ],
      "Pose": {
        "Pitch": 4.050806522369385,
        "Roll": 0.9950747489929199,
        "Yaw": 13.693790435791016
      },
      "Quality": {
        "Brightness": 37.60169982910156,
        "Sharpness": 80
      }
    }
  ],
  "OrientationCorrection": "ROTATE_0"
}
*\/
// example id: to-detect-faces-in-an-image-1481841782793
 
 
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

JavaScriptLn 1, Col 1

Errors: 0 Warnings: 0