Copyright	(c) 2013-2021 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

Amazonka.Rekognition.SearchFaces

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

For a given input face ID, searches for matching faces in the collection the face belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with faces in the specified collection.

You can also search faces without indexing faces by using the SearchFacesByImage operation.

The operation 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 that is found. Along with the metadata, the response also includes a confidence value for each face match, indicating the confidence that the specific face matches the input face.

For an example, see Searching for a Face Using Its Face ID in the Amazon Rekognition Developer Guide.

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

Synopsis

data SearchFaces = SearchFaces' {
- faceMatchThreshold :: Maybe Double
- maxFaces :: Maybe Natural
- collectionId :: Text
- faceId :: Text
}
newSearchFaces :: Text -> Text -> SearchFaces
searchFaces_faceMatchThreshold :: Lens' SearchFaces (Maybe Double)
searchFaces_maxFaces :: Lens' SearchFaces (Maybe Natural)
searchFaces_collectionId :: Lens' SearchFaces Text
searchFaces_faceId :: Lens' SearchFaces Text
data SearchFacesResponse = SearchFacesResponse' {
- faceMatches :: Maybe [FaceMatch]
- faceModelVersion :: Maybe Text
- searchedFaceId :: Maybe Text
- httpStatus :: Int
}
newSearchFacesResponse :: Int -> SearchFacesResponse
searchFacesResponse_faceMatches :: Lens' SearchFacesResponse (Maybe [FaceMatch])
searchFacesResponse_faceModelVersion :: Lens' SearchFacesResponse (Maybe Text)
searchFacesResponse_searchedFaceId :: Lens' SearchFacesResponse (Maybe Text)
searchFacesResponse_httpStatus :: Lens' SearchFacesResponse Int

Creating a Request

data SearchFaces Source #

See: newSearchFaces smart constructor.

Constructors

SearchFaces'

Fields

faceMatchThreshold :: Maybe Double
Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.
maxFaces :: Maybe Natural
Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.
collectionId :: Text
ID of the collection the face belongs to.
faceId :: Text
ID of a face to find matches for in the collection.

Instances

Instances details

Eq SearchFaces Source #
Instance details Defined in Amazonka.Rekognition.SearchFaces Methods (==) :: SearchFaces -> SearchFaces -> Bool # (/=) :: SearchFaces -> SearchFaces -> Bool #
Read SearchFaces Source #
Instance details Defined in Amazonka.Rekognition.SearchFaces Methods readsPrec :: Int -> ReadS SearchFaces # readList :: ReadS [SearchFaces] # readPrec :: ReadPrec SearchFaces # readListPrec :: ReadPrec [SearchFaces] #
Show SearchFaces Source #
Instance details Defined in Amazonka.Rekognition.SearchFaces Methods showsPrec :: Int -> SearchFaces -> ShowS # show :: SearchFaces -> String # showList :: [SearchFaces] -> ShowS #
Generic SearchFaces Source #
Instance details Defined in Amazonka.Rekognition.SearchFaces Associated Types type Rep SearchFaces :: Type -> Type # Methods from :: SearchFaces -> Rep SearchFaces x # to :: Rep SearchFaces x -> SearchFaces #
NFData SearchFaces Source #
Instance details Defined in Amazonka.Rekognition.SearchFaces Methods rnf :: SearchFaces -> () #
Hashable SearchFaces Source #
Instance details Defined in Amazonka.Rekognition.SearchFaces Methods hashWithSalt :: Int -> SearchFaces -> Int # hash :: SearchFaces -> Int #
ToJSON SearchFaces Source #
Instance details Defined in Amazonka.Rekognition.SearchFaces Methods toJSON :: SearchFaces -> Value # toEncoding :: SearchFaces -> Encoding # toJSONList :: [SearchFaces] -> Value # toEncodingList :: [SearchFaces] -> Encoding #
AWSRequest SearchFaces Source #
Instance details Defined in Amazonka.Rekognition.SearchFaces Associated Types type AWSResponse SearchFaces # Methods request :: SearchFaces -> Request SearchFaces # response :: MonadResource m => Logger -> Service -> Proxy SearchFaces -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SearchFaces))) #
ToHeaders SearchFaces Source #
Instance details Defined in Amazonka.Rekognition.SearchFaces Methods toHeaders :: SearchFaces -> [Header] #
ToPath SearchFaces Source #
Instance details Defined in Amazonka.Rekognition.SearchFaces Methods toPath :: SearchFaces -> ByteString #
ToQuery SearchFaces Source #
Instance details Defined in Amazonka.Rekognition.SearchFaces Methods toQuery :: SearchFaces -> QueryString #
type Rep SearchFaces Source #
Instance details Defined in Amazonka.Rekognition.SearchFaces type Rep SearchFaces = D1 ('MetaData "SearchFaces" "Amazonka.Rekognition.SearchFaces" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "SearchFaces'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "faceMatchThreshold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :: S1 ('MetaSel ('Just "maxFaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "collectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "faceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse SearchFaces Source #
Instance details Defined in Amazonka.Rekognition.SearchFaces type AWSResponse SearchFaces = SearchFacesResponse

newSearchFaces Source #

Arguments

:: Text	`$sel:collectionId:SearchFaces'`
-> Text	`$sel:faceId:SearchFaces'`
-> SearchFaces

Create a value of SearchFaces with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:faceMatchThreshold:SearchFaces', searchFaces_faceMatchThreshold - Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

$sel:maxFaces:SearchFaces', searchFaces_maxFaces - Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

$sel:collectionId:SearchFaces', searchFaces_collectionId - ID of the collection the face belongs to.

$sel:faceId:SearchFaces', searchFaces_faceId - ID of a face to find matches for in the collection.

Request Lenses

searchFaces_faceMatchThreshold :: Lens' SearchFaces (Maybe Double) Source #

Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

searchFaces_maxFaces :: Lens' SearchFaces (Maybe Natural) Source #

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

searchFaces_collectionId :: Lens' SearchFaces Text Source #

ID of the collection the face belongs to.

searchFaces_faceId :: Lens' SearchFaces Text Source #

ID of a face to find matches for in the collection.

Destructuring the Response

data SearchFacesResponse Source #

See: newSearchFacesResponse smart constructor.

Constructors

SearchFacesResponse'
Fields faceMatches :: Maybe [FaceMatch] An array of faces that matched the input face, along with the confidence in the match. faceModelVersion :: Maybe Text Version number of the face detection model associated with the input collection (`CollectionId`). searchedFaceId :: Maybe Text ID of the face that was searched for matches in a collection. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq SearchFacesResponse Source #
Instance details Defined in Amazonka.Rekognition.SearchFaces Methods (==) :: SearchFacesResponse -> SearchFacesResponse -> Bool # (/=) :: SearchFacesResponse -> SearchFacesResponse -> Bool #
Read SearchFacesResponse Source #
Instance details Defined in Amazonka.Rekognition.SearchFaces Methods readsPrec :: Int -> ReadS SearchFacesResponse # readList :: ReadS [SearchFacesResponse] # readPrec :: ReadPrec SearchFacesResponse # readListPrec :: ReadPrec [SearchFacesResponse] #
Show SearchFacesResponse Source #
Instance details Defined in Amazonka.Rekognition.SearchFaces Methods showsPrec :: Int -> SearchFacesResponse -> ShowS # show :: SearchFacesResponse -> String # showList :: [SearchFacesResponse] -> ShowS #
Generic SearchFacesResponse Source #
Instance details Defined in Amazonka.Rekognition.SearchFaces Associated Types type Rep SearchFacesResponse :: Type -> Type # Methods from :: SearchFacesResponse -> Rep SearchFacesResponse x # to :: Rep SearchFacesResponse x -> SearchFacesResponse #
NFData SearchFacesResponse Source #
Instance details Defined in Amazonka.Rekognition.SearchFaces Methods rnf :: SearchFacesResponse -> () #
type Rep SearchFacesResponse Source #
Instance details Defined in Amazonka.Rekognition.SearchFaces type Rep SearchFacesResponse = D1 ('MetaData "SearchFacesResponse" "Amazonka.Rekognition.SearchFaces" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "SearchFacesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "faceMatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FaceMatch])) :: S1 ('MetaSel ('Just "faceModelVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "searchedFaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSearchFacesResponse Source #

Arguments

:: Int	`$sel:httpStatus:SearchFacesResponse'`
-> SearchFacesResponse

Create a value of SearchFacesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:faceMatches:SearchFacesResponse', searchFacesResponse_faceMatches - An array of faces that matched the input face, along with the confidence in the match.

$sel:faceModelVersion:SearchFacesResponse', searchFacesResponse_faceModelVersion - Version number of the face detection model associated with the input collection (CollectionId).

$sel:searchedFaceId:SearchFacesResponse', searchFacesResponse_searchedFaceId - ID of the face that was searched for matches in a collection.

$sel:httpStatus:SearchFacesResponse', searchFacesResponse_httpStatus - The response's http status code.

Response Lenses

searchFacesResponse_faceMatches :: Lens' SearchFacesResponse (Maybe [FaceMatch]) Source #

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

searchFacesResponse_faceModelVersion :: Lens' SearchFacesResponse (Maybe Text) Source #

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

searchFacesResponse_searchedFaceId :: Lens' SearchFacesResponse (Maybe Text) Source #

ID of the face that was searched for matches in a collection.

searchFacesResponse_httpStatus :: Lens' SearchFacesResponse Int Source #

The response's http status code.