Struct aws_sdk_rekognition::client::fluent_builders::StartTextDetection

pub struct StartTextDetection<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Fluent builder constructing a request to StartTextDetection.

Starts asynchronous detection of text in a stored video.

Amazon Rekognition Video can detect text in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartTextDetection returns a job identifier (JobId) which you use to get the results of the operation. When text detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

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 to StartTextDetection.

Implementations

impl<C, M, R> StartTextDetection<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<StartTextDetectionOutput, SdkError<StartTextDetectionError>> where
    R::Policy: SmithyRetryPolicy<StartTextDetectionInputOperationOutputAlias, StartTextDetectionOutput, StartTextDetectionError, StartTextDetectionInputOperationRetryAlias>, 

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 video(self, input: Video) -> Self

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 set_video(self, input: Option<Video>) -> Self

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 client_request_token(self, input: impl Into<String>) -> Self

Idempotent token used to identify the start request. If you use the same token with multiple StartTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentaly started more than once.

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

Idempotent token used to identify the start request. If you use the same token with multiple StartTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentaly started more than once.

pub fn notification_channel(self, input: NotificationChannel) -> Self

The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see api-video. Note that the Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic. For more information, see Giving access to multiple Amazon SNS topics.

pub fn set_notification_channel(
    self,
    input: Option<NotificationChannel>
) -> Self

The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see api-video. Note that the Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic. For more information, see Giving access to multiple Amazon SNS topics.

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

An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

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

An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

pub fn filters(self, input: StartTextDetectionFilters) -> Self

Optional parameters that let you set criteria the text must meet to be included in your response.

pub fn set_filters(self, input: Option<StartTextDetectionFilters>) -> Self

Optional parameters that let you set criteria the text must meet to be included in your response.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for StartTextDetection<C, M, R>

fn clone(&self) -> StartTextDetection<C, M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for StartTextDetection<C, M, R>

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

Formats the value using the given formatter.