AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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_statusString

Current status of the text detection job.

Returns:

  • (String)


2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2822

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


2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2822

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

#status_messageString

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

Returns:

  • (String)


2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2822

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



2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2822

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

#text_model_versionString

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

Returns:

  • (String)


2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2822

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



2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2822

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