Network.AWS.Rekognition.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 and 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 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 example2 .

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

Creating a Request

indexFaces

Arguments

:: Text

ifCollectionId

-> Image

ifImage

-> IndexFaces

Creates a value of IndexFaces with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ifExternalImageId - ID you want to assign to all the faces detected in the image.
• ifDetectionAttributes - 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).
• ifCollectionId - The ID of an existing collection to which you want to add the faces that are detected in the input images.
• ifImage - The input image as bytes or an S3 object.

data IndexFaces

See: indexFaces smart constructor.

Instances

Eq IndexFaces

Methods

(==) :: IndexFaces -> IndexFaces -> Bool

(/=) :: IndexFaces -> IndexFaces -> Bool

Data IndexFaces

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> IndexFaces -> c IndexFaces

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c IndexFaces

toConstr :: IndexFaces -> Constr

dataTypeOf :: IndexFaces -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c IndexFaces)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c IndexFaces)

gmapT :: (forall b. Data b => b -> b) -> IndexFaces -> IndexFaces

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> IndexFaces -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> IndexFaces -> r

gmapQ :: (forall d. Data d => d -> u) -> IndexFaces -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> IndexFaces -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> IndexFaces -> m IndexFaces

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> IndexFaces -> m IndexFaces

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> IndexFaces -> m IndexFaces

Read IndexFaces

Methods

readsPrec :: Int -> ReadS IndexFaces

readList :: ReadS [IndexFaces]

readPrec :: ReadPrec IndexFaces

readListPrec :: ReadPrec [IndexFaces]

Show IndexFaces

Methods

showsPrec :: Int -> IndexFaces -> ShowS

show :: IndexFaces -> String

showList :: [IndexFaces] -> ShowS

Generic IndexFaces

Associated Types

type Rep IndexFaces :: * -> *

Methods

from :: IndexFaces -> Rep IndexFaces x

to :: Rep IndexFaces x -> IndexFaces

Hashable IndexFaces

Methods

hashWithSalt :: Int -> IndexFaces -> Int

hash :: IndexFaces -> Int

ToJSON IndexFaces

Methods

toJSON :: IndexFaces -> Value

toEncoding :: IndexFaces -> Encoding

toJSONList :: [IndexFaces] -> Value

toEncodingList :: [IndexFaces] -> Encoding

NFData IndexFaces

Methods

rnf :: IndexFaces -> ()

AWSRequest IndexFaces

Associated Types

type Rs IndexFaces :: *

Methods

request :: IndexFaces -> Request IndexFaces

response :: MonadResource m => Logger -> Service -> Proxy * IndexFaces -> ClientResponse -> m (Response IndexFaces)

ToQuery IndexFaces

Methods

toQuery :: IndexFaces -> QueryString

ToPath IndexFaces

Methods

toPath :: IndexFaces -> ByteString

ToHeaders IndexFaces

Methods

toHeaders :: IndexFaces -> [Header]

type Rep IndexFaces

type Rep IndexFaces = D1 (MetaData "IndexFaces" "Network.AWS.Rekognition.IndexFaces" "amazonka-rekognition-1.5.0-B4jtpxqOYsT3vpCV9vDK91" False) (C1 (MetaCons "IndexFaces'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ifExternalImageId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ifDetectionAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Attribute])))) ((:*:) (S1 (MetaSel (Just Symbol "_ifCollectionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_ifImage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Image)))))

type Rs IndexFaces

type Rs IndexFaces = IndexFacesResponse

Request Lenses

ifExternalImageId :: Lens' IndexFaces (Maybe Text)

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

ifDetectionAttributes :: Lens' IndexFaces [Attribute]

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

ifCollectionId :: Lens' IndexFaces Text

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

ifImage :: Lens' IndexFaces Image

The input image as bytes or an S3 object.

Destructuring the Response

indexFacesResponse

Arguments

:: Int

ifrsResponseStatus

-> IndexFacesResponse

Creates a value of IndexFacesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ifrsFaceRecords - An array of faces detected and added to the collection. For more information, see 'howitworks-index-faces' .
• ifrsOrientationCorrection - 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.
• ifrsResponseStatus - -- | The response status code.

data IndexFacesResponse

See: indexFacesResponse smart constructor.

Instances

Eq IndexFacesResponse

Methods

(==) :: IndexFacesResponse -> IndexFacesResponse -> Bool

(/=) :: IndexFacesResponse -> IndexFacesResponse -> Bool

Data IndexFacesResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> IndexFacesResponse -> c IndexFacesResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c IndexFacesResponse

toConstr :: IndexFacesResponse -> Constr

dataTypeOf :: IndexFacesResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c IndexFacesResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c IndexFacesResponse)

gmapT :: (forall b. Data b => b -> b) -> IndexFacesResponse -> IndexFacesResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> IndexFacesResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> IndexFacesResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> IndexFacesResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> IndexFacesResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> IndexFacesResponse -> m IndexFacesResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> IndexFacesResponse -> m IndexFacesResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> IndexFacesResponse -> m IndexFacesResponse

Read IndexFacesResponse

Methods

readsPrec :: Int -> ReadS IndexFacesResponse

readList :: ReadS [IndexFacesResponse]

readPrec :: ReadPrec IndexFacesResponse

readListPrec :: ReadPrec [IndexFacesResponse]

Show IndexFacesResponse

Methods

showsPrec :: Int -> IndexFacesResponse -> ShowS

show :: IndexFacesResponse -> String

showList :: [IndexFacesResponse] -> ShowS

Generic IndexFacesResponse

Associated Types

type Rep IndexFacesResponse :: * -> *

Methods

from :: IndexFacesResponse -> Rep IndexFacesResponse x

to :: Rep IndexFacesResponse x -> IndexFacesResponse

NFData IndexFacesResponse

Methods

rnf :: IndexFacesResponse -> ()

type Rep IndexFacesResponse

type Rep IndexFacesResponse = D1 (MetaData "IndexFacesResponse" "Network.AWS.Rekognition.IndexFaces" "amazonka-rekognition-1.5.0-B4jtpxqOYsT3vpCV9vDK91" False) (C1 (MetaCons "IndexFacesResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ifrsFaceRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [FaceRecord]))) ((:*:) (S1 (MetaSel (Just Symbol "_ifrsOrientationCorrection") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe OrientationCorrection))) (S1 (MetaSel (Just Symbol "_ifrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

ifrsFaceRecords :: Lens' IndexFacesResponse [FaceRecord]

An array of faces detected and added to the collection. For more information, see 'howitworks-index-faces' .

ifrsOrientationCorrection :: Lens' IndexFacesResponse (Maybe 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.

ifrsResponseStatus :: Lens' IndexFacesResponse Int

• - | The response status code.