Struct aws_sdk_textract::input::StartDocumentAnalysisInput

source ·

#[non_exhaustive]
pub struct StartDocumentAnalysisInput { /* private fields */ }

Implementations§

source §

impl StartDocumentAnalysisInput

source

pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<StartDocumentAnalysis, AwsResponseRetryClassifier>, BuildError>

Consumes the builder and constructs an Operation<StartDocumentAnalysis>

Examples found in repository ?

src/client.rs (line 964)

        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
        }

source

pub fn builder() -> Builder

Creates a new builder-style object to manufacture StartDocumentAnalysisInput.

source §

impl StartDocumentAnalysisInput

source

pub fn document_location(&self) -> Option<&DocumentLocation>

The location of the document to be processed.

source

pub fn feature_types(&self) -> Option<&[FeatureType]>

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

source

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

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.

source

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

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

source

pub fn notification_channel(&self) -> Option<&NotificationChannel>

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

source

pub fn output_config(&self) -> Option<&OutputConfig>

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.

source

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

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.

source