Class: Aws::Rekognition::Types::GetTextDetectionResponse
- Inherits:
-
Struct
- Object
- Struct
- Aws::Rekognition::Types::GetTextDetectionResponse
- Defined in:
- gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#job_id ⇒ String
Job identifier for the text detection operation for which you want to obtain results.
-
#job_status ⇒ String
Current status of the text detection job.
-
#job_tag ⇒ String
A job identifier specified in the call to StartTextDetection 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 text.
-
#status_message ⇒ String
If the job fails,
StatusMessage
provides a descriptive error message. -
#text_detections ⇒ Array<Types::TextDetectionResult>
An array of text detected in the video.
-
#text_model_version ⇒ String
Version number of the text detection model that was used to detect text.
-
#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 text detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartTextDetection.
4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 |
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 4177 class GetTextDetectionResponse < Struct.new( :job_status, :status_message, :video_metadata, :text_detections, :next_token, :text_model_version, :job_id, :video, :job_tag) SENSITIVE = [] include Aws::Structure end |
#job_status ⇒ String
Current status of the text detection job.
4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 |
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 4177 class GetTextDetectionResponse < Struct.new( :job_status, :status_message, :video_metadata, :text_detections, :next_token, :text_model_version, :job_id, :video, :job_tag) SENSITIVE = [] include Aws::Structure end |
#job_tag ⇒ String
A job identifier specified in the call to StartTextDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.
4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 |
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 4177 class GetTextDetectionResponse < Struct.new( :job_status, :status_message, :video_metadata, :text_detections, :next_token, :text_model_version, :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 text.
4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 |
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 4177 class GetTextDetectionResponse < Struct.new( :job_status, :status_message, :video_metadata, :text_detections, :next_token, :text_model_version, :job_id, :video, :job_tag) SENSITIVE = [] include Aws::Structure end |
#status_message ⇒ String
If the job fails, StatusMessage
provides a descriptive error
message.
4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 |
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 4177 class GetTextDetectionResponse < Struct.new( :job_status, :status_message, :video_metadata, :text_detections, :next_token, :text_model_version, :job_id, :video, :job_tag) SENSITIVE = [] include Aws::Structure end |
#text_detections ⇒ Array<Types::TextDetectionResult>
An array of text detected in the video. Each element contains the detected text, the time in milliseconds from the start of the video that the text was detected, and where it was detected on the screen.
4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 |
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 4177 class GetTextDetectionResponse < Struct.new( :job_status, :status_message, :video_metadata, :text_detections, :next_token, :text_model_version, :job_id, :video, :job_tag) SENSITIVE = [] include Aws::Structure end |
#text_model_version ⇒ String
Version number of the text detection model that was used to detect text.
4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 |
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 4177 class GetTextDetectionResponse < Struct.new( :job_status, :status_message, :video_metadata, :text_detections, :next_token, :text_model_version, :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.
4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 |
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 4177 class GetTextDetectionResponse < Struct.new( :job_status, :status_message, :video_metadata, :text_detections, :next_token, :text_model_version, :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.
4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 |
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 4177 class GetTextDetectionResponse < Struct.new( :job_status, :status_message, :video_metadata, :text_detections, :next_token, :text_model_version, :job_id, :video, :job_tag) SENSITIVE = [] include Aws::Structure end |