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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb

Instance Attribute Summary collapse

Instance Attribute Details

#job_status ⇒ String

The current status of the face search job.

Returns:

  • (String) 


1518
1519
1520
1521
1522
1523
1524
1525
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1518

class GetFaceSearchResponse < Struct.new(
  :job_status,
  :status_message,
  :next_token,
  :video_metadata,
  :persons)
  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) 


1518
1519
1520
1521
1522
1523
1524
1525
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1518

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

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



1518
1519
1520
1521
1522
1523
1524
1525
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1518

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

#status_message ⇒ String

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

Returns:

  • (String) 


1518
1519
1520
1521
1522
1523
1524
1525
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1518

class GetFaceSearchResponse < Struct.new(
  :job_status,
  :status_message,
  :next_token,
  :video_metadata,
  :persons)
  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:



1518
1519
1520
1521
1522
1523
1524
1525
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1518

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