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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the face search results for Rekognition Video face search started by . The search returns faces in a collection that match the faces of persons detected in a video. It also includes the time(s) that faces are matched in the video.

Face search in a video is an asynchronous operation. You start face search by calling to which returns a job identifier (JobId ). When the search operation finishes, Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceSearch . To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED . If so, call GetFaceSearch and pass the job identifier (JobId ) from the initial call to StartFaceSearch . For more information, see collections .

The search results are retured in an array, Persons , of objects. EachPersonMatch element contains details about the matching faces in the input collection, person information (facial attributes, bounding boxes, and person identifer) for the matched person, and the time the person was matched in the video.

By default, the Persons array is sorted by the time, in milliseconds from the start of the video, persons are matched. You can also sort by persons by specifying INDEX for the SORTBY input parameter.

Creating a Request

getFaceSearch Source #

Arguments

:: Text	`gfsJobId`
-> GetFaceSearch

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

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

gfsNextToken - If the previous response was incomplete (because there is more search results to retrieve), Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.
gfsMaxResults - Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
gfsSortBy - Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.
gfsJobId - The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch .

data GetFaceSearch Source #

See: getFaceSearch smart constructor.

Instances

Eq GetFaceSearch Source #
Instance details Defined in Network.AWS.Rekognition.GetFaceSearch Methods (==) :: GetFaceSearch -> GetFaceSearch -> Bool # (/=) :: GetFaceSearch -> GetFaceSearch -> Bool #
Data GetFaceSearch Source #
Instance details Defined in Network.AWS.Rekognition.GetFaceSearch Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetFaceSearch -> c GetFaceSearch # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetFaceSearch # toConstr :: GetFaceSearch -> Constr # dataTypeOf :: GetFaceSearch -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GetFaceSearch) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetFaceSearch) # gmapT :: (forall b. Data b => b -> b) -> GetFaceSearch -> GetFaceSearch # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetFaceSearch -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetFaceSearch -> r # gmapQ :: (forall d. Data d => d -> u) -> GetFaceSearch -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GetFaceSearch -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetFaceSearch -> m GetFaceSearch # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetFaceSearch -> m GetFaceSearch # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetFaceSearch -> m GetFaceSearch #
Read GetFaceSearch Source #
Instance details Defined in Network.AWS.Rekognition.GetFaceSearch Methods readsPrec :: Int -> ReadS GetFaceSearch # readList :: ReadS [GetFaceSearch] # readPrec :: ReadPrec GetFaceSearch # readListPrec :: ReadPrec [GetFaceSearch] #
Show GetFaceSearch Source #
Instance details Defined in Network.AWS.Rekognition.GetFaceSearch Methods showsPrec :: Int -> GetFaceSearch -> ShowS # show :: GetFaceSearch -> String # showList :: [GetFaceSearch] -> ShowS #
Generic GetFaceSearch Source #
Instance details Defined in Network.AWS.Rekognition.GetFaceSearch Associated Types type Rep GetFaceSearch :: Type -> Type # Methods from :: GetFaceSearch -> Rep GetFaceSearch x # to :: Rep GetFaceSearch x -> GetFaceSearch #
Hashable GetFaceSearch Source #
Instance details Defined in Network.AWS.Rekognition.GetFaceSearch Methods hashWithSalt :: Int -> GetFaceSearch -> Int # hash :: GetFaceSearch -> Int #
ToJSON GetFaceSearch Source #
Instance details Defined in Network.AWS.Rekognition.GetFaceSearch Methods toJSON :: GetFaceSearch -> Value # toEncoding :: GetFaceSearch -> Encoding # toJSONList :: [GetFaceSearch] -> Value # toEncodingList :: [GetFaceSearch] -> Encoding #
AWSRequest GetFaceSearch Source #
Instance details Defined in Network.AWS.Rekognition.GetFaceSearch Associated Types type Rs GetFaceSearch :: Type # Methods request :: GetFaceSearch -> Request GetFaceSearch # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy GetFaceSearch -> ClientResponse -> m (Response GetFaceSearch) #
ToHeaders GetFaceSearch Source #
Instance details Defined in Network.AWS.Rekognition.GetFaceSearch Methods toHeaders :: GetFaceSearch -> [Header] #
ToPath GetFaceSearch Source #
Instance details Defined in Network.AWS.Rekognition.GetFaceSearch Methods toPath :: GetFaceSearch -> ByteString #
ToQuery GetFaceSearch Source #
Instance details Defined in Network.AWS.Rekognition.GetFaceSearch Methods toQuery :: GetFaceSearch -> QueryString #
NFData GetFaceSearch Source #
Instance details Defined in Network.AWS.Rekognition.GetFaceSearch Methods rnf :: GetFaceSearch -> () #
type Rep GetFaceSearch Source #
Instance details Defined in Network.AWS.Rekognition.GetFaceSearch type Rep GetFaceSearch = D1 (MetaData "GetFaceSearch" "Network.AWS.Rekognition.GetFaceSearch" "amazonka-rekognition-1.6.1-ELwOF0LSGWFp8S3Ef6QMe" False) (C1 (MetaCons "GetFaceSearch'" PrefixI True) ((S1 (MetaSel (Just "_gfsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_gfsMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) :: (S1 (MetaSel (Just "_gfsSortBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe FaceSearchSortBy)) :*: S1 (MetaSel (Just "_gfsJobId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs GetFaceSearch Source #
Instance details Defined in Network.AWS.Rekognition.GetFaceSearch type Rs GetFaceSearch = GetFaceSearchResponse

Request Lenses

gfsNextToken :: Lens' GetFaceSearch (Maybe Text) Source #

If the previous response was incomplete (because there is more search results to retrieve), Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.

gfsMaxResults :: Lens' GetFaceSearch (Maybe Natural) Source #

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

gfsSortBy :: Lens' GetFaceSearch (Maybe FaceSearchSortBy) Source #

Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

gfsJobId :: Lens' GetFaceSearch Text Source #

The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch .

Destructuring the Response

getFaceSearchResponse Source #

Arguments

:: Int	`gfsrsResponseStatus`
-> GetFaceSearchResponse

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

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

gfsrsNextToken - If the response is truncated, Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of search results.
gfsrsVideoMetadata - Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Rekognition Video operation.
gfsrsStatusMessage - If the job fails, StatusMessage provides a descriptive error message.
gfsrsJobStatus - The current status of the face search job.
gfsrsPersons - An array of persons, , in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call to StartFaceSearch . Each Persons element includes a time the person was matched, face match details (FaceMatches ) for matching faces in the collection, and person information (Person ) for the matched person.
gfsrsResponseStatus - -- | The response status code.

data GetFaceSearchResponse Source #

See: getFaceSearchResponse smart constructor.

Instances

Eq GetFaceSearchResponse Source #
Instance details Defined in Network.AWS.Rekognition.GetFaceSearch Methods (==) :: GetFaceSearchResponse -> GetFaceSearchResponse -> Bool # (/=) :: GetFaceSearchResponse -> GetFaceSearchResponse -> Bool #
Data GetFaceSearchResponse Source #
Instance details Defined in Network.AWS.Rekognition.GetFaceSearch Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetFaceSearchResponse -> c GetFaceSearchResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetFaceSearchResponse # toConstr :: GetFaceSearchResponse -> Constr # dataTypeOf :: GetFaceSearchResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GetFaceSearchResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetFaceSearchResponse) # gmapT :: (forall b. Data b => b -> b) -> GetFaceSearchResponse -> GetFaceSearchResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetFaceSearchResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetFaceSearchResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> GetFaceSearchResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GetFaceSearchResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetFaceSearchResponse -> m GetFaceSearchResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetFaceSearchResponse -> m GetFaceSearchResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetFaceSearchResponse -> m GetFaceSearchResponse #
Read GetFaceSearchResponse Source #
Instance details Defined in Network.AWS.Rekognition.GetFaceSearch Methods readsPrec :: Int -> ReadS GetFaceSearchResponse # readList :: ReadS [GetFaceSearchResponse] # readPrec :: ReadPrec GetFaceSearchResponse # readListPrec :: ReadPrec [GetFaceSearchResponse] #
Show GetFaceSearchResponse Source #
Instance details Defined in Network.AWS.Rekognition.GetFaceSearch Methods showsPrec :: Int -> GetFaceSearchResponse -> ShowS # show :: GetFaceSearchResponse -> String # showList :: [GetFaceSearchResponse] -> ShowS #
Generic GetFaceSearchResponse Source #
Instance details Defined in Network.AWS.Rekognition.GetFaceSearch Associated Types type Rep GetFaceSearchResponse :: Type -> Type # Methods from :: GetFaceSearchResponse -> Rep GetFaceSearchResponse x # to :: Rep GetFaceSearchResponse x -> GetFaceSearchResponse #
NFData GetFaceSearchResponse Source #
Instance details Defined in Network.AWS.Rekognition.GetFaceSearch Methods rnf :: GetFaceSearchResponse -> () #
type Rep GetFaceSearchResponse Source #
Instance details Defined in Network.AWS.Rekognition.GetFaceSearch type Rep GetFaceSearchResponse = D1 (MetaData "GetFaceSearchResponse" "Network.AWS.Rekognition.GetFaceSearch" "amazonka-rekognition-1.6.1-ELwOF0LSGWFp8S3Ef6QMe" False) (C1 (MetaCons "GetFaceSearchResponse'" PrefixI True) ((S1 (MetaSel (Just "_gfsrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_gfsrsVideoMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VideoMetadata)) :: S1 (MetaSel (Just "_gfsrsStatusMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 (MetaSel (Just "_gfsrsJobStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VideoJobStatus)) :: (S1 (MetaSel (Just "_gfsrsPersons") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [PersonMatch])) :*: S1 (MetaSel (Just "_gfsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

gfsrsNextToken :: Lens' GetFaceSearchResponse (Maybe Text) Source #

If the response is truncated, Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of search results.

gfsrsVideoMetadata :: Lens' GetFaceSearchResponse (Maybe VideoMetadata) Source #

Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Rekognition Video operation.

gfsrsStatusMessage :: Lens' GetFaceSearchResponse (Maybe Text) Source #

If the job fails, StatusMessage provides a descriptive error message.

gfsrsJobStatus :: Lens' GetFaceSearchResponse (Maybe VideoJobStatus) Source #

The current status of the face search job.

gfsrsPersons :: Lens' GetFaceSearchResponse [PersonMatch] Source #

An array of persons, , in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call to StartFaceSearch . Each Persons element includes a time the person was matched, face match details (FaceMatches ) for matching faces in the collection, and person information (Person ) for the matched person.

gfsrsResponseStatus :: Lens' GetFaceSearchResponse Int Source #

- | The response status code.