Menu
Amazon Rekognition
Developer Guide

IndexFaces

Detects faces in the input image and adds them to the specified collection.

Amazon Rekognition does not save the actual faces detected. Instead, the underlying detection algorithm first detects the faces in the input image, and for each face extracts facial features into a feature vector, and stores it in the back-end database. Amazon Rekognition uses feature vectors when performing face match and search operations using the SearchFaces and SearchFacesByImage operations.

If you provide the optional externalImageID for the input image you provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this external image ID to create a client-side index to associate the faces with each image. You can then use the index to find all faces in an image.

In response, the operation returns an array of metadata for all detected faces. This includes, the bounding box of the detected face, confidence value (indicating the bounding box contains a face), a face ID assigned by the service for each face that is detected and stored, and an image ID assigned by the service for the input image. If you request all facial attributes (using the detectionAttributes parameter, Amazon Rekognition returns detailed facial attributes such as facial landmarks (for example, location of eye and mount) and other facial attributes such gender. If you provide the same image, specify the same collection, and use the same external ID in the IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata.

For an example, see Example 2: Storing Faces.

This operation requires permissions to perform the rekognition:IndexFaces action.

Request Syntax

Copy
{ "CollectionId": "string", "DetectionAttributes": [ "string" ], "ExternalImageId": "string", "Image": { "Bytes": blob, "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } } }

Request Parameters

The request accepts the following data in JSON format.

CollectionId

The ID of an existing collection to which you want to add the faces that are detected in the input images.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [a-zA-Z0-9_.\-]+

Required: Yes

DetectionAttributes

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 will take 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).

Type: Array of strings

Valid Values: DEFAULT | ALL

Required: No

ExternalImageId

ID you want to assign to all the faces detected in the image.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [a-zA-Z0-9_.\-:]+

Required: No

Image

The input image as bytes or an S3 object.

Type: Image object

Required: Yes

Response Syntax

Copy
{ "FaceRecords": [ { "Face": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Confidence": number, "ExternalImageId": "string", "FaceId": "string", "ImageId": "string" }, "FaceDetail": { "AgeRange": { "High": number, "Low": number }, "Beard": { "Confidence": number, "Value": boolean }, "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Confidence": number, "Emotions": [ { "Confidence": number, "Type": "string" } ], "Eyeglasses": { "Confidence": number, "Value": boolean }, "EyesOpen": { "Confidence": number, "Value": boolean }, "Gender": { "Confidence": number, "Value": "string" }, "Landmarks": [ { "Type": "string", "X": number, "Y": number } ], "MouthOpen": { "Confidence": number, "Value": boolean }, "Mustache": { "Confidence": number, "Value": boolean }, "Pose": { "Pitch": number, "Roll": number, "Yaw": number }, "Quality": { "Brightness": number, "Sharpness": number }, "Smile": { "Confidence": number, "Value": boolean }, "Sunglasses": { "Confidence": number, "Value": boolean } } } ], "OrientationCorrection": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

FaceRecords

An array of faces detected and added to the collection. For more information, see Storing Faces in a Face Collection: The IndexFaces Operation.

Type: Array of FaceRecord objects

OrientationCorrection

The orientation of the input image (counterclockwise direction). If your application displays the image, you can use this value to correct image orientation. The bounding box coordinates returned in FaceRecords represent face locations before the image orientation is corrected.

Note

If the input image is in jpeg format, it might contain exchangeable image (Exif) metadata. If so, and the Exif metadata populates the orientation field, the value of OrientationCorrection is null and the bounding box coordinates in FaceRecords represent face locations after Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Type: String

Valid Values: ROTATE_0 | ROTATE_90 | ROTATE_180 | ROTATE_270

Errors

AccessDeniedException

You are not authorized to perform the action.

HTTP Status Code: 400

ImageTooLargeException

The input image size exceeds the allowed limit. For more information, see Limits in Amazon Rekognition.

HTTP Status Code: 400

InternalServerError

Amazon Rekognition experienced a service issue. Try your call again.

HTTP Status Code: 500

InvalidImageFormatException

The provided image format is not supported.

HTTP Status Code: 400

InvalidParameterException

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

HTTP Status Code: 400

InvalidS3ObjectException

Amazon Rekognition is unable to access the S3 object specified in the request.

HTTP Status Code: 400

ProvisionedThroughputExceededException

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

HTTP Status Code: 400

ResourceNotFoundException

Collection specified in the request is not found.

HTTP Status Code: 400

ThrottlingException

Amazon Rekognition is temporarily unable to process the request. Try your call again.

HTTP Status Code: 500

Example

Example Request

The following example shows a request that adds an image (people.jpg) stored in an Amazon S3 bucket (examplephotos) to a collection (examplemyphotos).

Sample Request

Copy
POST https://rekognition.us-west-2.amazonaws.com/ HTTP/1.1 Host: rekognition.us-west-2.amazonaws.com Accept-Encoding: identity Content-Length: 107 X-Amz-Target: RekognitionService.IndexFaces X-Amz-Date: 20170105T162002Z User-Agent: aws-cli/1.11.25 Python/2.7.9 Windows/8 botocore/1.4.82 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=XXXXXXXX/20170105/us-west-2/rekognition/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=XXXXXXXX { "Image":{ "S3Object":{ "Bucket":"example-photos", "Name":"people.jpg" } }, "CollectionId":"examplemyphotos" }

Sample Response

Copy
HTTP/1.1 200 OK Content-Type: application/x-amz-json-1.1 Date: Thu, 05 Jan 2017 16:20:04 GMT x-amzn-RequestId: cfe5d2f3-d362-11e6-988e-1194c13fd971 Content-Length: 1889 Connection: keep-alive { "FaceRecords":[ { "Face":{ "BoundingBox":{ "Height":0.22206704318523407, "Left":0.503333330154419, "Top":0.21229049563407898, "Width":0.17666666209697723 }, "Confidence":99.9996566772461, "FaceId":"11111111-2222-3333-4444-555555555555", "ImageId":"11111111-2222-3333-4444-555555555555" }, "FaceDetail":{ "BoundingBox":{ "Height":0.22206704318523407, "Left":0.503333330154419, "Top":0.21229049563407898, "Width":0.17666666209697723 }, "Confidence":99.9996566772461, "Landmarks":[ { "Type":"eyeLeft", "X":0.5582929253578186, "Y":0.327402263879776 }, { "Type":"eyeRight", "X":0.6097898483276367, "Y":0.28622597455978394 }, { "Type":"nose", "X":0.6182368993759155, "Y":0.34145522117614746 }, { "Type":"mouthLeft", "X":0.5820220708847046, "Y":0.40035346150398254 }, { "Type":"mouthRight", "X":0.6310185194015503, "Y":0.35822394490242004 } ], "Pose":{ "Pitch":-8.25561237335205, "Roll":-34.76542663574219, "Yaw":30.61958122253418 }, "Quality":{ "Brightness":45.9112663269043, "Sharpness":50.0 } } }, { "Face":{ "BoundingBox":{ "Height":0.22067038714885712, "Left":0.402222216129303, "Top":0.3393854796886444, "Width":0.17555555701255798 }, "Confidence":99.9998779296875, "FaceId":"11111111-2222-3333-4444-555555555555", "ImageId":"11111111-2222-3333-4444-555555555555" }, "FaceDetail":{ "BoundingBox":{ "Height":0.22067038714885712, "Left":0.402222216129303, "Top":0.3393854796886444, "Width":0.17555555701255798 }, "Confidence":99.9998779296875, "Landmarks":[ { "Type":"eyeLeft", "X":0.46082764863967896, "Y":0.4488079249858856 }, { "Type":"eyeRight", "X":0.509974479675293, "Y":0.4110442101955414 }, { "Type":"nose", "X":0.5182068943977356, "Y":0.4580079913139343 }, { "Type":"mouthLeft", "X":0.49137336015701294, "Y":0.5153146386146545 }, { "Type":"mouthRight", "X":0.52939772605896, "Y":0.4874058663845062 } ], "Pose":{ "Pitch":-12.197214126586914, "Roll":-33.81959533691406, "Yaw":32.57762908935547 }, "Quality":{ "Brightness":32.43154525756836, "Sharpness":40.0 } } } ], "OrientationCorrection":"ROTATE_0" }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: