Struct aws_sdk_textract::input::start_document_analysis_input::Builder

pub struct Builder { /* private fields */ }

A builder for StartDocumentAnalysisInput.

Implementations

impl Builder

pub fn document_location(self, input: DocumentLocation) -> Self

The location of the document to be processed.

Examples found in repository

src/client.rs (line 995)

        pub fn document_location(mut self, input: crate::model::DocumentLocation) -> Self {
            self.inner = self.inner.document_location(input);
            self
        }

pub fn set_document_location(self, input: Option<DocumentLocation>) -> Self

The location of the document to be processed.

Examples found in repository

src/client.rs (line 1003)

        pub fn set_document_location(
            mut self,
            input: std::option::Option<crate::model::DocumentLocation>,
        ) -> Self {
            self.inner = self.inner.set_document_location(input);
            self
        }

pub fn feature_types(self, input: FeatureType) -> Self

Appends an item to feature_types.

To override the contents of this collection use set_feature_types.

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

Examples found in repository

src/client.rs (line 1012)

        pub fn feature_types(mut self, input: crate::model::FeatureType) -> Self {
            self.inner = self.inner.feature_types(input);
            self
        }

pub fn set_feature_types(self, input: Option<Vec<FeatureType>>) -> Self

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

Examples found in repository

src/client.rs (line 1020)

        pub fn set_feature_types(
            mut self,
            input: std::option::Option<std::vec::Vec<crate::model::FeatureType>>,
        ) -> Self {
            self.inner = self.inner.set_feature_types(input);
            self
        }

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

The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.

Examples found in repository

src/client.rs (line 1025)

        pub fn client_request_token(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.client_request_token(input.into());
            self
        }

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

The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.

Examples found in repository

src/client.rs (line 1033)

        pub fn set_client_request_token(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_client_request_token(input);
            self
        }

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

An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).

Examples found in repository

src/client.rs (line 1038)

        pub fn job_tag(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.job_tag(input.into());
            self
        }

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

An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).

Examples found in repository

src/client.rs (line 1043)

        pub fn set_job_tag(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_job_tag(input);
            self
        }

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

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

Examples found in repository

src/client.rs (line 1048)

        pub fn notification_channel(mut self, input: crate::model::NotificationChannel) -> Self {
            self.inner = self.inner.notification_channel(input);
            self
        }

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

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

Examples found in repository

src/client.rs (line 1056)

        pub fn set_notification_channel(
            mut self,
            input: std::option::Option<crate::model::NotificationChannel>,
        ) -> Self {
            self.inner = self.inner.set_notification_channel(input);
            self
        }

pub fn output_config(self, input: OutputConfig) -> Self

Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save the results internally to be accessed by the GetDocumentAnalysis operation.

Examples found in repository

src/client.rs (line 1061)

        pub fn output_config(mut self, input: crate::model::OutputConfig) -> Self {
            self.inner = self.inner.output_config(input);
            self
        }

pub fn set_output_config(self, input: Option<OutputConfig>) -> Self

Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save the results internally to be accessed by the GetDocumentAnalysis operation.

Examples found in repository

src/client.rs (line 1069)

        pub fn set_output_config(
            mut self,
            input: std::option::Option<crate::model::OutputConfig>,
        ) -> Self {
            self.inner = self.inner.set_output_config(input);
            self
        }

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

The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.

Examples found in repository

src/client.rs (line 1074)

        pub fn kms_key_id(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.kms_key_id(input.into());
            self
        }

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

The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.

Examples found in repository

src/client.rs (line 1079)

        pub fn set_kms_key_id(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_kms_key_id(input);
            self
        }

pub fn queries_config(self, input: QueriesConfig) -> Self

Examples found in repository

src/client.rs (line 1084)

        pub fn queries_config(mut self, input: crate::model::QueriesConfig) -> Self {
            self.inner = self.inner.queries_config(input);
            self
        }

pub fn set_queries_config(self, input: Option<QueriesConfig>) -> Self

Examples found in repository

src/client.rs (line 1092)

        pub fn set_queries_config(
            mut self,
            input: std::option::Option<crate::model::QueriesConfig>,
        ) -> Self {
            self.inner = self.inner.set_queries_config(input);
            self
        }

pub fn build(self) -> Result<StartDocumentAnalysisInput, BuildError>

Consumes the builder and constructs a StartDocumentAnalysisInput.

Examples found in repository

src/client.rs (line 962)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::StartDocumentAnalysis,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::StartDocumentAnalysisError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// 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](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::StartDocumentAnalysisOutput,
            aws_smithy_http::result::SdkError<crate::error::StartDocumentAnalysisError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> 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 Builder