interface GetTextDetectionResponse {
    JobId?: string;
    JobStatus?: VideoJobStatus;
    JobTag?: string;
    NextToken?: string;
    StatusMessage?: string;
    TextDetections?: TextDetectionResult[];
    TextModelVersion?: string;
    Video?: Video;
    VideoMetadata?: VideoMetadata;
}

Hierarchy (view full)

Properties

JobId?: 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.

JobStatus?: VideoJobStatus

Current status of the text detection job.

JobTag?: 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.

NextToken?: 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.

StatusMessage?: string

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

TextDetections?: 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.

TextModelVersion?: string

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

Video?: 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.

VideoMetadata?: VideoMetadata

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