Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.Rekognition.SearchFacesByImage

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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 Source #

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 Source #

See: searchFacesByImage smart constructor.

Instances

Eq SearchFacesByImage Source #
Methods (==) :: SearchFacesByImage -> SearchFacesByImage -> Bool # (/=) :: SearchFacesByImage -> SearchFacesByImage -> Bool #
Data SearchFacesByImage Source #
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 Source #
Methods readsPrec :: Int -> ReadS SearchFacesByImage # readList :: ReadS [SearchFacesByImage] # readPrec :: ReadPrec SearchFacesByImage # readListPrec :: ReadPrec [SearchFacesByImage] #
Show SearchFacesByImage Source #
Methods showsPrec :: Int -> SearchFacesByImage -> ShowS # show :: SearchFacesByImage -> String # showList :: [SearchFacesByImage] -> ShowS #
Generic SearchFacesByImage Source #
Associated Types type Rep SearchFacesByImage :: * -> * # Methods from :: SearchFacesByImage -> Rep SearchFacesByImage x # to :: Rep SearchFacesByImage x -> SearchFacesByImage #
Hashable SearchFacesByImage Source #
Methods hashWithSalt :: Int -> SearchFacesByImage -> Int # hash :: SearchFacesByImage -> Int #
ToJSON SearchFacesByImage Source #
Methods toJSON :: SearchFacesByImage -> Value # toEncoding :: SearchFacesByImage -> Encoding # toJSONList :: [SearchFacesByImage] -> Value # toEncodingList :: [SearchFacesByImage] -> Encoding #
NFData SearchFacesByImage Source #
Methods rnf :: SearchFacesByImage -> () #
AWSRequest SearchFacesByImage Source #
Associated Types type Rs SearchFacesByImage :: * # Methods request :: SearchFacesByImage -> Request SearchFacesByImage # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * SearchFacesByImage -> ClientResponse -> m (Response SearchFacesByImage) #
ToHeaders SearchFacesByImage Source #
Methods toHeaders :: SearchFacesByImage -> [Header] #
ToPath SearchFacesByImage Source #
Methods toPath :: SearchFacesByImage -> ByteString #
ToQuery SearchFacesByImage Source #
Methods toQuery :: SearchFacesByImage -> QueryString #
type Rep SearchFacesByImage Source #
type Rep SearchFacesByImage = D1 * (MetaData "SearchFacesByImage" "Network.AWS.Rekognition.SearchFacesByImage" "amazonka-rekognition-1.6.0-3jgXZy5HWud2mYhTRx5OTT" False) (C1 * (MetaCons "SearchFacesByImage'" PrefixI True) ((::) ((::) (S1 * (MetaSel (Just Symbol "_sfbiFaceMatchThreshold") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Double))) (S1 * (MetaSel (Just Symbol "_sfbiMaxFaces") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat)))) ((::) (S1 * (MetaSel (Just Symbol "_sfbiCollectionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_sfbiImage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Image)))))
type Rs SearchFacesByImage Source #
type Rs SearchFacesByImage = SearchFacesByImageResponse

Request Lenses

sfbiFaceMatchThreshold :: Lens' SearchFacesByImage (Maybe Double) Source #

(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) Source #

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 Source #

ID of the collection to search.

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

Destructuring the Response

searchFacesByImageResponse Source #

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 Source #

See: searchFacesByImageResponse smart constructor.

Instances

Eq SearchFacesByImageResponse Source #
Methods (==) :: SearchFacesByImageResponse -> SearchFacesByImageResponse -> Bool # (/=) :: SearchFacesByImageResponse -> SearchFacesByImageResponse -> Bool #
Data SearchFacesByImageResponse Source #
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 Source #
Methods readsPrec :: Int -> ReadS SearchFacesByImageResponse # readList :: ReadS [SearchFacesByImageResponse] # readPrec :: ReadPrec SearchFacesByImageResponse # readListPrec :: ReadPrec [SearchFacesByImageResponse] #
Show SearchFacesByImageResponse Source #
Methods showsPrec :: Int -> SearchFacesByImageResponse -> ShowS # show :: SearchFacesByImageResponse -> String # showList :: [SearchFacesByImageResponse] -> ShowS #
Generic SearchFacesByImageResponse Source #
Associated Types type Rep SearchFacesByImageResponse :: * -> * # Methods from :: SearchFacesByImageResponse -> Rep SearchFacesByImageResponse x # to :: Rep SearchFacesByImageResponse x -> SearchFacesByImageResponse #
NFData SearchFacesByImageResponse Source #
Methods rnf :: SearchFacesByImageResponse -> () #
type Rep SearchFacesByImageResponse Source #
type Rep SearchFacesByImageResponse = D1 * (MetaData "SearchFacesByImageResponse" "Network.AWS.Rekognition.SearchFacesByImage" "amazonka-rekognition-1.6.0-3jgXZy5HWud2mYhTRx5OTT" False) (C1 * (MetaCons "SearchFacesByImageResponse'" PrefixI True) ((::) ((::) (S1 * (MetaSel (Just Symbol "_sfbirsFaceMatches") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [FaceMatch]))) (S1 * (MetaSel (Just Symbol "_sfbirsFaceModelVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((::) (S1 * (MetaSel (Just Symbol "_sfbirsSearchedFaceBoundingBox") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe BoundingBox))) ((::) (S1 * (MetaSel (Just Symbol "_sfbirsSearchedFaceConfidence") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Double))) (S1 * (MetaSel (Just Symbol "_sfbirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))))

Response Lenses

sfbirsFaceMatches :: Lens' SearchFacesByImageResponse [FaceMatch] Source #

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

sfbirsFaceModelVersion :: Lens' SearchFacesByImageResponse (Maybe Text) Source #

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

sfbirsSearchedFaceBoundingBox :: Lens' SearchFacesByImageResponse (Maybe BoundingBox) Source #

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

sfbirsSearchedFaceConfidence :: Lens' SearchFacesByImageResponse (Maybe Double) Source #

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

sfbirsResponseStatus :: Lens' SearchFacesByImageResponse Int Source #

- | The response status code.