Skip to content

aws.rekognition.get_text_detection

Example SQL Queries

SELECT * FROM
aws.rekognition.get_text_detection
WHERE
"job_id" = 'VALUE';

Description

Gets the text detection results of a Amazon Rekognition Video analysis started by StartTextDetection.

Text detection with Amazon Rekognition Video is an asynchronous operation. You start text detection by calling StartTextDetection which returns a job identifier (JobId) When the text detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartTextDetection. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetTextDetection and pass the job identifier (JobId) from the initial call of StartLabelDetection.

GetTextDetection returns an array of detected text (TextDetections) sorted by the time the text was detected, up to 100 words per frame of video.

Each element of the array includes the detected text, the precentage confidence in the acuracy of the detected text, the time the text was detected, bounding box information for where the text was located, and unique identifiers for words and their lines.

Use MaxResults parameter to limit the number of text detections returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetTextDetection and populate the NextToken request parameter with the token value returned from the previous call to GetTextDetection.

Table Definition

Column NameColumn Data Type
job_id Required Input Column

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.

VARCHAR
max_results Input Column

Maximum number of results to return per paginated call. The largest value you can specify is 1000.

BIGINT
next_token Input Column

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.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
job_status

Current status of the text detection job.

VARCHAR
job_tag

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

VARCHAR
status_message

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

VARCHAR
text_detections

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.

STRUCT(
"timestamp" BIGINT,
"text_detection" STRUCT(
"detected_text" VARCHAR,
"type" VARCHAR,
"id" BIGINT,
"parent_id" BIGINT,
"confidence" DOUBLE,
"geometry" STRUCT(
"bounding_box" STRUCT(
"width" DOUBLE,
"height" DOUBLE,
"left" DOUBLE,
"top" DOUBLE
),
"polygon" STRUCT(
"x" DOUBLE,
"y" DOUBLE
)[]
)
)
)[]
Show child fields
text_detections[]
Show child fields
text_detections[].text_detection

Details about text detected in a video.

Show child fields
text_detections[].text_detection.confidence

The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy of the geometry points around the detected text.

text_detections[].text_detection.detected_text

The word or line of text recognized by Amazon Rekognition.

text_detections[].text_detection.geometry

The location of the detected text on the image. Includes an axis aligned coarse bounding box surrounding the text and a finer grain polygon for more accurate spatial information.

Show child fields
text_detections[].text_detection.geometry.bounding_box

An axis-aligned coarse representation of the detected item's location on the image.

Show child fields
text_detections[].text_detection.geometry.bounding_box.height

Height of the bounding box as a ratio of the overall image height.

text_detections[].text_detection.geometry.bounding_box.left

Left coordinate of the bounding box as a ratio of overall image width.

text_detections[].text_detection.geometry.bounding_box.top

Top coordinate of the bounding box as a ratio of overall image height.

text_detections[].text_detection.geometry.bounding_box.width

Width of the bounding box as a ratio of the overall image width.

text_detections[].text_detection.geometry.polygon[]
Show child fields
text_detections[].text_detection.geometry.polygon[].x

The value of the X coordinate for a point on a Polygon.

text_detections[].text_detection.geometry.polygon[].y

The value of the Y coordinate for a point on a Polygon.

text_detections[].text_detection.id

The identifier for the detected text. The identifier is only unique for a single call to DetectText.

text_detections[].text_detection.parent_id

The Parent identifier for the detected text identified by the value of ID. If the type of detected text is LINE, the value of ParentId is Null.

text_detections[].text_detection.type

The type of text that was detected.

text_detections[].timestamp

The time, in milliseconds from the start of the video, that the text was detected. Note that Timestamp is not guaranteed to be accurate to the individual frame where the text first appears.

text_model_version

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

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

STRUCT(
"s3_object" STRUCT(
"bucket" VARCHAR,
"name" VARCHAR,
"version" VARCHAR
)
)
Show child fields
video.s3_object

The Amazon S3 bucket name and file name for the video.

Show child fields
video.s3_object.bucket

Name of the S3 bucket.

video.s3_object.name

S3 object key name.

video.s3_object.version

If the bucket is versioning enabled, you can specify the object version.

video_metadata

Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.

STRUCT(
"codec" VARCHAR,
"duration_millis" BIGINT,
"format" VARCHAR,
"frame_rate" DOUBLE,
"frame_height" BIGINT,
"frame_width" BIGINT,
"color_range" VARCHAR
)
Show child fields
video_metadata.codec

Type of compression used in the analyzed video.

video_metadata.color_range

A description of the range of luminance values in a video, either LIMITED (16 to 235) or FULL (0 to 255).

video_metadata.duration_millis

Length of the video in milliseconds.

video_metadata.format

Format of the analyzed video. Possible values are MP4, MOV and AVI.

video_metadata.frame_height

Vertical pixel dimension of the video.

video_metadata.frame_rate

Number of frames per second in the video.

video_metadata.frame_width

Horizontal pixel dimension of the video.