Network.AWS.Rekognition.GetFaceSearch

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

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

See: getFaceSearch smart constructor.

Instances

Eq GetFaceSearch

Methods

(==) :: GetFaceSearch -> GetFaceSearch -> Bool

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

Data 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

Methods

readsPrec :: Int -> ReadS GetFaceSearch

readList :: ReadS [GetFaceSearch]

readPrec :: ReadPrec GetFaceSearch

readListPrec :: ReadPrec [GetFaceSearch]

Show GetFaceSearch

Methods

showsPrec :: Int -> GetFaceSearch -> ShowS

show :: GetFaceSearch -> String

showList :: [GetFaceSearch] -> ShowS

Generic GetFaceSearch

Associated Types

type Rep GetFaceSearch :: * -> *

Methods

from :: GetFaceSearch -> Rep GetFaceSearch x

to :: Rep GetFaceSearch x -> GetFaceSearch

Hashable GetFaceSearch

Methods

hashWithSalt :: Int -> GetFaceSearch -> Int

hash :: GetFaceSearch -> Int

ToJSON GetFaceSearch

Methods

toJSON :: GetFaceSearch -> Value

toEncoding :: GetFaceSearch -> Encoding

toJSONList :: [GetFaceSearch] -> Value

toEncodingList :: [GetFaceSearch] -> Encoding

NFData GetFaceSearch

Methods

rnf :: GetFaceSearch -> ()

AWSRequest GetFaceSearch

Associated Types

type Rs GetFaceSearch :: *

Methods

request :: GetFaceSearch -> Request GetFaceSearch

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

ToHeaders GetFaceSearch

Methods

toHeaders :: GetFaceSearch -> [Header]

ToPath GetFaceSearch

Methods

toPath :: GetFaceSearch -> ByteString

ToQuery GetFaceSearch

Methods

toQuery :: GetFaceSearch -> QueryString

type Rep GetFaceSearch

type Rep GetFaceSearch = D1 * (MetaData "GetFaceSearch" "Network.AWS.Rekognition.GetFaceSearch" "amazonka-rekognition-1.6.0-3jgXZy5HWud2mYhTRx5OTT" False) (C1 * (MetaCons "GetFaceSearch'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_gfsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gfsMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gfsSortBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe FaceSearchSortBy))) (S1 * (MetaSel (Just Symbol "_gfsJobId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))

type Rs GetFaceSearch

type Rs GetFaceSearch = GetFaceSearchResponse

Request Lenses

gfsNextToken :: Lens' GetFaceSearch (Maybe Text)

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)

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)

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

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

Destructuring the Response

getFaceSearchResponse

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

See: getFaceSearchResponse smart constructor.

Instances

Eq GetFaceSearchResponse

Methods

(==) :: GetFaceSearchResponse -> GetFaceSearchResponse -> Bool

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

Data GetFaceSearchResponse

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

Methods

readsPrec :: Int -> ReadS GetFaceSearchResponse

readList :: ReadS [GetFaceSearchResponse]

readPrec :: ReadPrec GetFaceSearchResponse

readListPrec :: ReadPrec [GetFaceSearchResponse]

Show GetFaceSearchResponse

Methods

showsPrec :: Int -> GetFaceSearchResponse -> ShowS

show :: GetFaceSearchResponse -> String

showList :: [GetFaceSearchResponse] -> ShowS

Generic GetFaceSearchResponse

Associated Types

type Rep GetFaceSearchResponse :: * -> *

Methods

from :: GetFaceSearchResponse -> Rep GetFaceSearchResponse x

to :: Rep GetFaceSearchResponse x -> GetFaceSearchResponse

NFData GetFaceSearchResponse

Methods

rnf :: GetFaceSearchResponse -> ()

type Rep GetFaceSearchResponse

type Rep GetFaceSearchResponse = D1 * (MetaData "GetFaceSearchResponse" "Network.AWS.Rekognition.GetFaceSearch" "amazonka-rekognition-1.6.0-3jgXZy5HWud2mYhTRx5OTT" False) (C1 * (MetaCons "GetFaceSearchResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_gfsrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gfsrsVideoMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe VideoMetadata))) (S1 * (MetaSel (Just Symbol "_gfsrsStatusMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gfsrsJobStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe VideoJobStatus))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gfsrsPersons") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [PersonMatch]))) (S1 * (MetaSel (Just Symbol "_gfsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))))

Response Lenses

gfsrsNextToken :: Lens' GetFaceSearchResponse (Maybe Text)

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)

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)

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

gfsrsJobStatus :: Lens' GetFaceSearchResponse (Maybe VideoJobStatus)

The current status of the face search job.

gfsrsPersons :: Lens' GetFaceSearchResponse [PersonMatch]

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

• - | The response status code.