Class: Aws::Rekognition::Types::GetFaceSearchResponse
- Inherits:
-
Struct
- Object
- Struct
- Aws::Rekognition::Types::GetFaceSearchResponse
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-rekognition/types.rb
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#job_id ⇒ String
Job identifier for the face search operation for which you want to obtain results.
-
#job_status ⇒ String
The current status of the face search job.
-
#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.
-
#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 ⇒ Types::Video
Video file stored in an Amazon S3 bucket.
-
#video_metadata ⇒ Types::VideoMetadata
Information about a video that Amazon Rekognition analyzed.
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.
3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 |
# File 'lib/aws-sdk-rekognition/types.rb', line 3714 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.
3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 |
# File 'lib/aws-sdk-rekognition/types.rb', line 3714 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.
3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 |
# File 'lib/aws-sdk-rekognition/types.rb', line 3714 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.
3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 |
# File 'lib/aws-sdk-rekognition/types.rb', line 3714 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.
3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 |
# File 'lib/aws-sdk-rekognition/types.rb', line 3714 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.
3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 |
# File 'lib/aws-sdk-rekognition/types.rb', line 3714 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.
3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 |
# File 'lib/aws-sdk-rekognition/types.rb', line 3714 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.
3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 |
# File 'lib/aws-sdk-rekognition/types.rb', line 3714 class GetFaceSearchResponse < Struct.new( :job_status, :status_message, :next_token, :video_metadata, :persons, :job_id, :video, :job_tag) SENSITIVE = [] include Aws::Structure end |