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_id ⇒ String

Job identifier for the face search operation for which you want to obtain results. The job identifer is returned by an initial call to StartFaceSearch.

Returns:

  • (String) 


3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3779

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

#job_status ⇒ String

The current status of the face search job.

Returns:

  • (String) 


3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3779

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

#job_tag ⇒ String

A job identifier specified in the call to StartFaceSearch and returned in the job completion notification sent to your Amazon Simple Notification Service topic.

Returns:

  • (String) 


3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3779

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


3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3779

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



3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3779

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

#status_message ⇒ String

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

Returns:

  • (String) 


3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3779

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

#video ⇒ Types::Video

Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use Video to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.

Returns:



3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3779

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



3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3779

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