GetFaceSearch (smaws-clients.Smaws_Client

Module Smaws_Client_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.

val error_to_string : 
  [ Smaws_Lib.Protocols.AwsJson.error
  | `AccessDeniedException of Types.access_denied_exception
  | `InternalServerError of Types.internal_server_error
  | `InvalidPaginationTokenException of
    Types.invalid_pagination_token_exception
  | `InvalidParameterException of Types.invalid_parameter_exception
  | `ProvisionedThroughputExceededException of
    Types.provisioned_throughput_exceeded_exception
  | `ResourceNotFoundException of Types.resource_not_found_exception
  | `ThrottlingException of Types.throttling_exception ] ->
  string

val request : 
  'http_type Smaws_Lib.Context.t ->
  Types.get_face_search_request ->
  (Types.get_face_search_response,
    [> Smaws_Lib.Protocols.AwsJson.error
    | `AccessDeniedException of Types.access_denied_exception
    | `InternalServerError of Types.internal_server_error
    | `InvalidPaginationTokenException of
      Types.invalid_pagination_token_exception
    | `InvalidParameterException of Types.invalid_parameter_exception
    | `ProvisionedThroughputExceededException of
      Types.provisioned_throughput_exceeded_exception
    | `ResourceNotFoundException of Types.resource_not_found_exception
    | `ThrottlingException of Types.throttling_exception ])
    Stdlib.result

val request_with_metadata : 
  'http_type Smaws_Lib.Context.t ->
  Types.get_face_search_request ->
  (Types.get_face_search_response Smaws_Lib.Response.t,
    [> Smaws_Lib.Protocols.AwsJson.error
    | `AccessDeniedException of Types.access_denied_exception
    | `InternalServerError of Types.internal_server_error
    | `InvalidPaginationTokenException of
      Types.invalid_pagination_token_exception
    | `InvalidParameterException of Types.invalid_parameter_exception
    | `ProvisionedThroughputExceededException of
      Types.provisioned_throughput_exceeded_exception
    | `ResourceNotFoundException of Types.resource_not_found_exception
    | `ThrottlingException of Types.throttling_exception ]
    * Smaws_Lib.Response.metadata)
    Stdlib.result