You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Rekognition::Types::GetFaceSearchResponse

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#job_statusString

The current status of the face search job.

Possible values:

  • IN_PROGRESS
  • SUCCEEDED
  • FAILED

Returns:

  • (String)

    The current status of the face search job.

#next_tokenString

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.

Returns:

  • (String)

    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.

#personsArray<Types::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.

Returns:

  • (Array<Types::PersonMatch>)

    An array of persons, , in the video whose face(s) match the face(s) in an Amazon Rekognition collection.

#status_messageString

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

Returns:

  • (String)

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

#video_metadataTypes::VideoMetadata

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

Returns: