Struct aws_sdk_textract::client::fluent_builders::StartDocumentTextDetection

pub struct StartDocumentTextDetection { /* private fields */ }

Fluent builder constructing a request to StartDocumentTextDetection.

Starts the asynchronous detection of text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.

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

StartTextDetection returns a job identifier (JobId) that you use to get the results of the operation. When text detection 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 detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentTextDetection, and pass the job identifier (JobId) from the initial call to StartDocumentTextDetection.

For more information, see Document Text Detection.

Implementations

impl StartDocumentTextDetection

pub async fn customize(
    self
) -> Result<CustomizableOperation<StartDocumentTextDetection, AwsResponseRetryClassifier>, SdkError<StartDocumentTextDetectionError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<StartDocumentTextDetectionOutput, SdkError<StartDocumentTextDetectionError>>

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 client_request_token(self, input: 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, 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 with the GetDocumentTextDetection 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 with the GetDocumentTextDetection 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.

Trait Implementations

impl Clone for StartDocumentTextDetection

fn clone(&self) -> StartDocumentTextDetection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartDocumentTextDetection

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

Formats the value using the given formatter.