Struct aws_sdk_textract::client::fluent_builders::StartExpenseAnalysis

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

Fluent builder constructing a request to StartExpenseAnalysis.

Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names.

StartExpenseAnalysis can analyze text in documents that are in JPEG, PNG, and PDF format. The documents must be stored in an Amazon S3 bucket. Use the DocumentLocation parameter to specify the name of your S3 bucket and the name of the document in that bucket.

StartExpenseAnalysis returns a job identifier (JobId) that you will provide to GetExpenseAnalysis to retrieve the results of the operation. When the analysis of the input invoices/receipts is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you provide to the NotificationChannel. To obtain the results of the invoice and receipt analysis operation, ensure that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetExpenseAnalysis, and pass the job identifier (JobId) that was returned by your call to StartExpenseAnalysis.

For more information, see Analyzing Invoices and Receipts.

Implementations

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

pub async fn send(
    self
) -> Result<StartExpenseAnalysisOutput, SdkError<StartExpenseAnalysisError>> where
    R::Policy: SmithyRetryPolicy<StartExpenseAnalysisInputOperationOutputAlias, StartExpenseAnalysisOutput, StartExpenseAnalysisError, StartExpenseAnalysisInputOperationRetryAlias>, 

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

The idempotent token that's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection 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's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection 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, inp: impl Into<String>) -> Self

An identifier 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 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, inp: 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, inp: 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 GetExpenseAnalysis 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 GetExpenseAnalysis operation.

pub fn kms_key_id(self, inp: 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.

Trait Implementations

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

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

Formats the value using the given formatter.