Struct GetTextDetectionOutput

#[non_exhaustive]
pub struct GetTextDetectionOutput {
    pub job_status: Option<VideoJobStatus>,
    pub status_message: Option<String>,
    pub video_metadata: Option<VideoMetadata>,
    pub text_detections: Option<Vec<TextDetectionResult>>,
    pub next_token: Option<String>,
    pub text_model_version: Option<String>,
    pub job_id: Option<String>,
    pub video: Option<Video>,
    pub job_tag: Option<String>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

job_status: Option<VideoJobStatus>

Current status of the text detection job.

status_message: Option<String>

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

video_metadata: Option<VideoMetadata>

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

text_detections: Option<Vec<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.

next_token: Option<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.

text_model_version: Option<String>

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

job_id: Option<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.

video: Option<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.

job_tag: Option<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.

Implementations

impl GetTextDetectionOutput

pub fn job_status(&self) -> Option<&VideoJobStatus>

Current status of the text detection job.

pub fn status_message(&self) -> Option<&str>

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

pub fn video_metadata(&self) -> Option<&VideoMetadata>

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

pub fn text_detections(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .text_detections.is_none().

pub fn next_token(&self) -> Option<&str>

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.

pub fn text_model_version(&self) -> Option<&str>

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

pub fn job_id(&self) -> Option<&str>

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.

pub fn video(&self) -> Option<&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.

pub fn job_tag(&self) -> Option<&str>

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

impl GetTextDetectionOutput

pub fn builder() -> GetTextDetectionOutputBuilder

Creates a new builder-style object to manufacture GetTextDetectionOutput.

Trait Implementations

impl Clone for GetTextDetectionOutput

fn clone(&self) -> GetTextDetectionOutput

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetTextDetectionOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for GetTextDetectionOutput

fn eq(&self, other: &GetTextDetectionOutput) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for GetTextDetectionOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for GetTextDetectionOutput