Struct aws_sdk_rekognition::operation::start_text_detection::StartTextDetectionInput

#[non_exhaustive]
pub struct StartTextDetectionInput {
    pub video: Option<Video>,
    pub client_request_token: Option<String>,
    pub notification_channel: Option<NotificationChannel>,
    pub job_tag: Option<String>,
    pub filters: Option<StartTextDetectionFilters>,
}

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.

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.

client_request_token: Option<String>

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.

notification_channel: Option<NotificationChannel>

The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see Calling Amazon Rekognition Video operations. 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.

job_tag: Option<String>

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.

filters: Option<StartTextDetectionFilters>

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

Implementations

impl StartTextDetectionInput

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 client_request_token(&self) -> Option<&str>

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) -> Option<&NotificationChannel>

The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see Calling Amazon Rekognition Video operations. 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) -> Option<&str>

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) -> Option<&StartTextDetectionFilters>

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

impl StartTextDetectionInput

pub fn builder() -> StartTextDetectionInputBuilder

Creates a new builder-style object to manufacture StartTextDetectionInput.

Trait Implementations

impl Clone for StartTextDetectionInput

fn clone(&self) -> StartTextDetectionInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartTextDetectionInput

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

Formats the value using the given formatter.

impl PartialEq<StartTextDetectionInput> for StartTextDetectionInput

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for StartTextDetectionInput