Network.AWS.Rekognition.SearchFacesByImage

For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection.

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 Amazon CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

The response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match found. Along with the metadata, the response also includes a similarity indicating how similar the face is to the input face. In the response, the operation also returns the bounding box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition used for the input image.

For an example, see 'search-face-with-image-procedure' .

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

Creating a Request

searchFacesByImage

Arguments

:: Text

sfbiCollectionId

-> Image

sfbiImage

-> SearchFacesByImage

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

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

• sfbiFaceMatchThreshold - (Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%.
• sfbiMaxFaces - Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.
• sfbiCollectionId - ID of the collection to search.
• sfbiImage - 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.

data SearchFacesByImage

See: searchFacesByImage smart constructor.

Instances

Eq SearchFacesByImage

Defined in Network.AWS.Rekognition.SearchFacesByImage

Methods

(==) :: SearchFacesByImage -> SearchFacesByImage -> Bool

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

Data SearchFacesByImage

Defined in Network.AWS.Rekognition.SearchFacesByImage

Methods

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

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

toConstr :: SearchFacesByImage -> Constr

dataTypeOf :: SearchFacesByImage -> DataType

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

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

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

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

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

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

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

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

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

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

Read SearchFacesByImage

Defined in Network.AWS.Rekognition.SearchFacesByImage

Methods

readsPrec :: Int -> ReadS SearchFacesByImage

readList :: ReadS [SearchFacesByImage]

readPrec :: ReadPrec SearchFacesByImage

readListPrec :: ReadPrec [SearchFacesByImage]

Show SearchFacesByImage

Defined in Network.AWS.Rekognition.SearchFacesByImage

Methods

showsPrec :: Int -> SearchFacesByImage -> ShowS

show :: SearchFacesByImage -> String

showList :: [SearchFacesByImage] -> ShowS

Generic SearchFacesByImage

Defined in Network.AWS.Rekognition.SearchFacesByImage

Associated Types

type Rep SearchFacesByImage :: Type -> Type

Methods

from :: SearchFacesByImage -> Rep SearchFacesByImage x

to :: Rep SearchFacesByImage x -> SearchFacesByImage

Hashable SearchFacesByImage

Defined in Network.AWS.Rekognition.SearchFacesByImage

Methods

hashWithSalt :: Int -> SearchFacesByImage -> Int

hash :: SearchFacesByImage -> Int

ToJSON SearchFacesByImage

Defined in Network.AWS.Rekognition.SearchFacesByImage

Methods

toJSON :: SearchFacesByImage -> Value

toEncoding :: SearchFacesByImage -> Encoding

toJSONList :: [SearchFacesByImage] -> Value

toEncodingList :: [SearchFacesByImage] -> Encoding

AWSRequest SearchFacesByImage

Defined in Network.AWS.Rekognition.SearchFacesByImage

Associated Types

type Rs SearchFacesByImage :: Type

Methods

request :: SearchFacesByImage -> Request SearchFacesByImage

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy SearchFacesByImage -> ClientResponse -> m (Response SearchFacesByImage)

ToHeaders SearchFacesByImage

Defined in Network.AWS.Rekognition.SearchFacesByImage

Methods

toHeaders :: SearchFacesByImage -> [Header]

ToPath SearchFacesByImage

Defined in Network.AWS.Rekognition.SearchFacesByImage

Methods

toPath :: SearchFacesByImage -> ByteString

ToQuery SearchFacesByImage

Defined in Network.AWS.Rekognition.SearchFacesByImage

Methods

toQuery :: SearchFacesByImage -> QueryString

NFData SearchFacesByImage

Defined in Network.AWS.Rekognition.SearchFacesByImage

Methods

rnf :: SearchFacesByImage -> ()

type Rep SearchFacesByImage

Defined in Network.AWS.Rekognition.SearchFacesByImage

type Rep SearchFacesByImage = D1 (MetaData "SearchFacesByImage" "Network.AWS.Rekognition.SearchFacesByImage" "amazonka-rekognition-1.6.1-ELwOF0LSGWFp8S3Ef6QMe" False) (C1 (MetaCons "SearchFacesByImage'" PrefixI True) ((S1 (MetaSel (Just "_sfbiFaceMatchThreshold") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Double)) :*: S1 (MetaSel (Just "_sfbiMaxFaces") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) :*: (S1 (MetaSel (Just "_sfbiCollectionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_sfbiImage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Image))))

type Rs SearchFacesByImage

Defined in Network.AWS.Rekognition.SearchFacesByImage

type Rs SearchFacesByImage = SearchFacesByImageResponse

Request Lenses

sfbiFaceMatchThreshold :: Lens' SearchFacesByImage (Maybe Double)

(Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%.

sfbiMaxFaces :: Lens' SearchFacesByImage (Maybe Natural)

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

sfbiCollectionId :: Lens' SearchFacesByImage Text

ID of the collection to search.

sfbiImage :: Lens' SearchFacesByImage 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.

Destructuring the Response

searchFacesByImageResponse

Arguments

:: Int

sfbirsResponseStatus

-> SearchFacesByImageResponse

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

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

• sfbirsFaceMatches - An array of faces that match the input face, along with the confidence in the match.
• sfbirsFaceModelVersion - Version number of the face detection model associated with the input collection (CollectionId ).
• sfbirsSearchedFaceBoundingBox - The bounding box around the face in the input image that Amazon Rekognition used for the search.
• sfbirsSearchedFaceConfidence - The level of confidence that the searchedFaceBoundingBox , contains a face.
• sfbirsResponseStatus - -- | The response status code.

data SearchFacesByImageResponse

See: searchFacesByImageResponse smart constructor.

Instances

Eq SearchFacesByImageResponse

Defined in Network.AWS.Rekognition.SearchFacesByImage

Methods

(==) :: SearchFacesByImageResponse -> SearchFacesByImageResponse -> Bool

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

Data SearchFacesByImageResponse

Defined in Network.AWS.Rekognition.SearchFacesByImage

Methods

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

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

toConstr :: SearchFacesByImageResponse -> Constr

dataTypeOf :: SearchFacesByImageResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read SearchFacesByImageResponse

Defined in Network.AWS.Rekognition.SearchFacesByImage

Methods

readsPrec :: Int -> ReadS SearchFacesByImageResponse

readList :: ReadS [SearchFacesByImageResponse]

readPrec :: ReadPrec SearchFacesByImageResponse

readListPrec :: ReadPrec [SearchFacesByImageResponse]

Show SearchFacesByImageResponse

Defined in Network.AWS.Rekognition.SearchFacesByImage

Methods

showsPrec :: Int -> SearchFacesByImageResponse -> ShowS

show :: SearchFacesByImageResponse -> String

showList :: [SearchFacesByImageResponse] -> ShowS

Generic SearchFacesByImageResponse

Defined in Network.AWS.Rekognition.SearchFacesByImage

Associated Types

type Rep SearchFacesByImageResponse :: Type -> Type

Methods

from :: SearchFacesByImageResponse -> Rep SearchFacesByImageResponse x

to :: Rep SearchFacesByImageResponse x -> SearchFacesByImageResponse

NFData SearchFacesByImageResponse

Defined in Network.AWS.Rekognition.SearchFacesByImage

Methods

rnf :: SearchFacesByImageResponse -> ()

type Rep SearchFacesByImageResponse

Defined in Network.AWS.Rekognition.SearchFacesByImage

type Rep SearchFacesByImageResponse = D1 (MetaData "SearchFacesByImageResponse" "Network.AWS.Rekognition.SearchFacesByImage" "amazonka-rekognition-1.6.1-ELwOF0LSGWFp8S3Ef6QMe" False) (C1 (MetaCons "SearchFacesByImageResponse'" PrefixI True) ((S1 (MetaSel (Just "_sfbirsFaceMatches") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [FaceMatch])) :*: S1 (MetaSel (Just "_sfbirsFaceModelVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_sfbirsSearchedFaceBoundingBox") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe BoundingBox)) :*: (S1 (MetaSel (Just "_sfbirsSearchedFaceConfidence") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Double)) :*: S1 (MetaSel (Just "_sfbirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

sfbirsFaceMatches :: Lens' SearchFacesByImageResponse [FaceMatch]

An array of faces that match the input face, along with the confidence in the match.

sfbirsFaceModelVersion :: Lens' SearchFacesByImageResponse (Maybe Text)

Version number of the face detection model associated with the input collection (CollectionId ).

sfbirsSearchedFaceBoundingBox :: Lens' SearchFacesByImageResponse (Maybe BoundingBox)

The bounding box around the face in the input image that Amazon Rekognition used for the search.

sfbirsSearchedFaceConfidence :: Lens' SearchFacesByImageResponse (Maybe Double)

The level of confidence that the searchedFaceBoundingBox , contains a face.

sfbirsResponseStatus :: Lens' SearchFacesByImageResponse Int

• - | The response status code.