Class: Aws::Rekognition::Types::GetTextDetectionResponse

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_idString

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.

Returns:

  • (String)


4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 4227

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_statusString

Current status of the text detection job.

Returns:

  • (String)


4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 4227

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_tagString

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

Returns:

  • (String)


4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 4227

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_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 text.

Returns:

  • (String)


4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 4227

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_messageString

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

Returns:

  • (String)


4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 4227

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

Returns:



4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 4227

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_versionString

Version number of the text detection model that was used to detect text.

Returns:

  • (String)


4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 4227

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

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



4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 4227

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



4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 4227

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