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

Inherits:

Struct

• Object
• Struct
• Aws::Rekognition::Types::GetFaceSearchResponse

Defined in:

gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #job_status ⇒ String

  The current status of the face search job.

• #next_token ⇒ 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.

• #persons ⇒ Array<Types::PersonMatch>

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

• #status_message ⇒ String

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

• #video_metadata ⇒ Types::VideoMetadata

  Information about a video that Amazon Rekognition analyzed.

Instance Attribute Details

#job_status ⇒ String

The current status of the face search job.

Returns:

• (String)

# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3300

class GetFaceSearchResponse < Struct.new(
  :job_status,
  :status_message,
  :next_token,
  :video_metadata,
  :persons)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ 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.

Returns:

• (String)

# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3300

class GetFaceSearchResponse < Struct.new(
  :job_status,
  :status_message,
  :next_token,
  :video_metadata,
  :persons)
  SENSITIVE = []
  include Aws::Structure
end

#persons ⇒ Array<Types::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.

Returns:

• (Array<Types::PersonMatch>)

# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3300

class GetFaceSearchResponse < Struct.new(
  :job_status,
  :status_message,
  :next_token,
  :video_metadata,
  :persons)
  SENSITIVE = []
  include Aws::Structure
end

#status_message ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3300

class GetFaceSearchResponse < Struct.new(
  :job_status,
  :status_message,
  :next_token,
  :video_metadata,
  :persons)
  SENSITIVE = []
  include Aws::Structure
end

#video_metadata ⇒ Types::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:

• (Types::VideoMetadata)

# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3300

class GetFaceSearchResponse < Struct.new(
  :job_status,
  :status_message,
  :next_token,
  :video_metadata,
  :persons)
  SENSITIVE = []
  include Aws::Structure
end