AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#job_statusString

The current status of the face search job.

Returns:

  • (String)


2480
2481
2482
2483
2484
2485
2486
2487
2488
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2480

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

#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)


2480
2481
2482
2483
2484
2485
2486
2487
2488
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2480

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

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



2480
2481
2482
2483
2484
2485
2486
2487
2488
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2480

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

#status_messageString

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

Returns:

  • (String)


2480
2481
2482
2483
2484
2485
2486
2487
2488
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2480

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

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



2480
2481
2482
2483
2484
2485
2486
2487
2488
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2480

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