Amazonka.Rekognition.GetFaceSearch

Gets the face search results for Amazon Rekognition Video face search started by StartFaceSearch. 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 StartFaceSearch which returns a job identifier (JobId). When the search operation finishes, Amazon 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 Searching Faces in a Collection in the Amazon Rekognition Developer Guide.

The search results are retured in an array, Persons, of PersonMatch 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.

GetFaceSearch only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide.

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

data GetFaceSearch

See: newGetFaceSearch smart constructor.

Constructors

GetFaceSearch'

Fields

• maxResults :: 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.

• nextToken :: Maybe Text

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

• sortBy :: 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.

• jobId :: Text

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

Instances

ToJSON GetFaceSearch

Defined in Amazonka.Rekognition.GetFaceSearch

Methods

toJSON :: GetFaceSearch -> Value

toEncoding :: GetFaceSearch -> Encoding

toJSONList :: [GetFaceSearch] -> Value

toEncodingList :: [GetFaceSearch] -> Encoding

ToHeaders GetFaceSearch

Defined in Amazonka.Rekognition.GetFaceSearch

Methods

toHeaders :: GetFaceSearch -> [Header]

ToPath GetFaceSearch

Defined in Amazonka.Rekognition.GetFaceSearch

Methods

toPath :: GetFaceSearch -> ByteString

ToQuery GetFaceSearch

Defined in Amazonka.Rekognition.GetFaceSearch

Methods

toQuery :: GetFaceSearch -> QueryString

AWSRequest GetFaceSearch

Defined in Amazonka.Rekognition.GetFaceSearch

Associated Types

type AWSResponse GetFaceSearch

Methods

request :: (Service -> Service) -> GetFaceSearch -> Request GetFaceSearch

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetFaceSearch -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetFaceSearch)))

Generic GetFaceSearch

Defined in Amazonka.Rekognition.GetFaceSearch

Associated Types

type Rep GetFaceSearch :: Type -> Type

Methods

from :: GetFaceSearch -> Rep GetFaceSearch x

to :: Rep GetFaceSearch x -> GetFaceSearch

Read GetFaceSearch

Defined in Amazonka.Rekognition.GetFaceSearch

Methods

readsPrec :: Int -> ReadS GetFaceSearch

readList :: ReadS [GetFaceSearch]

readPrec :: ReadPrec GetFaceSearch

readListPrec :: ReadPrec [GetFaceSearch]

Show GetFaceSearch

Defined in Amazonka.Rekognition.GetFaceSearch

Methods

showsPrec :: Int -> GetFaceSearch -> ShowS

show :: GetFaceSearch -> String

showList :: [GetFaceSearch] -> ShowS

NFData GetFaceSearch

Defined in Amazonka.Rekognition.GetFaceSearch

Methods

rnf :: GetFaceSearch -> ()

Eq GetFaceSearch

Defined in Amazonka.Rekognition.GetFaceSearch

Methods

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

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

Hashable GetFaceSearch

Defined in Amazonka.Rekognition.GetFaceSearch

Methods

hashWithSalt :: Int -> GetFaceSearch -> Int

hash :: GetFaceSearch -> Int

type AWSResponse GetFaceSearch

Defined in Amazonka.Rekognition.GetFaceSearch

type AWSResponse GetFaceSearch = GetFaceSearchResponse

type Rep GetFaceSearch

Defined in Amazonka.Rekognition.GetFaceSearch

type Rep GetFaceSearch = D1 ('MetaData "GetFaceSearch" "Amazonka.Rekognition.GetFaceSearch" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "GetFaceSearch'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FaceSearchSortBy)) :*: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetFaceSearch

Arguments

:: Text

$sel:jobId:GetFaceSearch'

-> GetFaceSearch

Create a value of GetFaceSearch 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:maxResults:GetFaceSearch', getFaceSearch_maxResults - 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.

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

$sel:sortBy:GetFaceSearch', getFaceSearch_sortBy - 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.

$sel:jobId:GetFaceSearch', getFaceSearch_jobId - The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.

Request Lenses

getFaceSearch_maxResults :: 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.

getFaceSearch_nextToken :: Lens' GetFaceSearch (Maybe Text)

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

getFaceSearch_sortBy :: 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.

getFaceSearch_jobId :: Lens' GetFaceSearch Text

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

Destructuring the Response

data GetFaceSearchResponse

See: newGetFaceSearchResponse smart constructor.

Constructors

GetFaceSearchResponse'

Fields

• jobStatus :: Maybe VideoJobStatus

  The current status of the face search job.

• nextToken :: Maybe Text

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

• persons :: Maybe [PersonMatch]

  An array of persons, PersonMatch, 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.

• statusMessage :: Maybe Text

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

• videoMetadata :: Maybe VideoMetadata

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetFaceSearchResponse

Defined in Amazonka.Rekognition.GetFaceSearch

Associated Types

type Rep GetFaceSearchResponse :: Type -> Type

Methods

from :: GetFaceSearchResponse -> Rep GetFaceSearchResponse x

to :: Rep GetFaceSearchResponse x -> GetFaceSearchResponse

Read GetFaceSearchResponse

Defined in Amazonka.Rekognition.GetFaceSearch

Methods

readsPrec :: Int -> ReadS GetFaceSearchResponse

readList :: ReadS [GetFaceSearchResponse]

readPrec :: ReadPrec GetFaceSearchResponse

readListPrec :: ReadPrec [GetFaceSearchResponse]

Show GetFaceSearchResponse

Defined in Amazonka.Rekognition.GetFaceSearch

Methods

showsPrec :: Int -> GetFaceSearchResponse -> ShowS

show :: GetFaceSearchResponse -> String

showList :: [GetFaceSearchResponse] -> ShowS

NFData GetFaceSearchResponse

Defined in Amazonka.Rekognition.GetFaceSearch

Methods

rnf :: GetFaceSearchResponse -> ()

Eq GetFaceSearchResponse

Defined in Amazonka.Rekognition.GetFaceSearch

Methods

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

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

type Rep GetFaceSearchResponse

Defined in Amazonka.Rekognition.GetFaceSearch

type Rep GetFaceSearchResponse = D1 ('MetaData "GetFaceSearchResponse" "Amazonka.Rekognition.GetFaceSearch" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "GetFaceSearchResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VideoJobStatus)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "persons") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PersonMatch])))) :*: (S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "videoMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VideoMetadata)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetFaceSearchResponse

Arguments

:: Int

$sel:httpStatus:GetFaceSearchResponse'

-> GetFaceSearchResponse

Create a value of GetFaceSearchResponse 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:jobStatus:GetFaceSearchResponse', getFaceSearchResponse_jobStatus - The current status of the face search job.

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

$sel:persons:GetFaceSearchResponse', getFaceSearchResponse_persons - An array of persons, PersonMatch, 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.

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

$sel:videoMetadata:GetFaceSearchResponse', getFaceSearchResponse_videoMetadata - Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.

$sel:httpStatus:GetFaceSearchResponse', getFaceSearchResponse_httpStatus - The response's http status code.

Response Lenses

getFaceSearchResponse_jobStatus :: Lens' GetFaceSearchResponse (Maybe VideoJobStatus)

The current status of the face search job.

getFaceSearchResponse_nextToken :: Lens' GetFaceSearchResponse (Maybe Text)

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

getFaceSearchResponse_persons :: Lens' GetFaceSearchResponse (Maybe [PersonMatch])

An array of persons, PersonMatch, 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.

getFaceSearchResponse_statusMessage :: Lens' GetFaceSearchResponse (Maybe Text)

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

getFaceSearchResponse_videoMetadata :: Lens' GetFaceSearchResponse (Maybe VideoMetadata)

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

getFaceSearchResponse_httpStatus :: Lens' GetFaceSearchResponse Int

The response's http status code.