Struct aws_sdk_textract::client::fluent_builders::StartDocumentAnalysis

pub struct StartDocumentAnalysis { /* private fields */ }

Fluent builder constructing a request to StartDocumentAnalysis.

Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements.

StartDocumentAnalysis can analyze text in documents that are in JPEG, PNG, TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document.

StartDocumentAnalysis returns a job identifier (JobId) that you use to get the results of the operation. When text analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to StartDocumentAnalysis.

For more information, see Document Text Analysis.

Implementations

impl StartDocumentAnalysis

pub async fn send(
    self
) -> Result<StartDocumentAnalysisOutput, SdkError<StartDocumentAnalysisError>>

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 document_location(self, input: DocumentLocation) -> Self

The location of the document to be processed.

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

The location of the document to be processed.

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

Appends an item to FeatureTypes.

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

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

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.

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.

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

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

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.

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.

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.

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.

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.

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.

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

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

Trait Implementations

impl Clone for StartDocumentAnalysis

fn clone(&self) -> StartDocumentAnalysis

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartDocumentAnalysis

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

Formats the value using the given formatter.