Struct aws_sdk_rekognition::client::fluent_builders::GetTextDetection

pub struct GetTextDetection { /* private fields */ }

Fluent builder constructing a request to GetTextDetection.

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

Implementations

impl GetTextDetection

pub async fn send(
    self
) -> Result<GetTextDetectionOutput, SdkError<GetTextDetectionError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn into_paginator(self) -> GetTextDetectionPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn job_id(self, input: impl Into<String>) -> Self

Job identifier for the text detection operation for which you want results returned. You get the job identifer from an initial call to StartTextDetection.

pub fn set_job_id(self, input: Option<String>) -> Self

Job identifier for the text detection operation for which you want results returned. You get the job identifer from an initial call to StartTextDetection.

pub fn max_results(self, input: i32) -> Self

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

pub fn set_max_results(self, input: Option<i32>) -> Self

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

pub fn next_token(self, input: impl Into<String>) -> Self

If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of text.

pub fn set_next_token(self, input: Option<String>) -> Self

If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of text.

Trait Implementations

impl Clone for GetTextDetection

fn clone(&self) -> GetTextDetection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetTextDetection

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

Formats the value using the given formatter.