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

SENSITIVE =

[]

Instance Attribute Summary

• #job_status ⇒ String

  Current status of the text detection job.

• #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_metadata ⇒ Types::VideoMetadata

  Information about a video that Amazon Rekognition analyzed.

Instance Attribute Details

#job_status ⇒ String

Current status of the text detection job.

Returns:

• (String)

# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3282

class GetTextDetectionResponse < Struct.new(
  :job_status,
  :status_message,
  :video_metadata,
  :text_detections,
  :next_token,
  :text_model_version)
  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.

Returns:

• (String)

# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3282

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

#status_message ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3282

class GetTextDetectionResponse < Struct.new(
  :job_status,
  :status_message,
  :video_metadata,
  :text_detections,
  :next_token,
  :text_model_version)
  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.

Returns:

• (Array<Types::TextDetectionResult>)

# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3282

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

#text_model_version ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3282

class GetTextDetectionResponse < Struct.new(
  :job_status,
  :status_message,
  :video_metadata,
  :text_detections,
  :next_token,
  :text_model_version)
  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:

• (Types::VideoMetadata)

# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3282

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