Struct aws_sdk_textract::client::fluent_builders::GetLendingAnalysisSummary

pub struct GetLendingAnalysisSummary { /* private fields */ }

Fluent builder constructing a request to GetLendingAnalysisSummary.

Gets summarized results for the StartLendingAnalysis operation, which analyzes text in a lending document. The returned summary consists of information about documents grouped together by a common document type. Information like detected signatures, page numbers, and split documents is returned with respect to the type of grouped document.

You start asynchronous text analysis by calling StartLendingAnalysis, which returns a job identifier (JobId). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartLendingAnalysis.

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 GetLendingAnalysisSummary, and pass the job identifier (JobId) from the initial call to StartLendingAnalysis.

Implementations

impl GetLendingAnalysisSummary

pub async fn customize(
    self
) -> Result<CustomizableOperation<GetLendingAnalysisSummary, AwsResponseRetryClassifier>, SdkError<GetLendingAnalysisSummaryError>>

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<GetLendingAnalysisSummaryOutput, SdkError<GetLendingAnalysisSummaryError>>

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

A unique identifier for the lending or text-detection job. The JobId is returned from StartLendingAnalysis. A JobId value is only valid for 7 days.

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

A unique identifier for the lending or text-detection job. The JobId is returned from StartLendingAnalysis. A JobId value is only valid for 7 days.

Trait Implementations

impl Clone for GetLendingAnalysisSummary

fn clone(&self) -> GetLendingAnalysisSummary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetLendingAnalysisSummary

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

Formats the value using the given formatter.