Struct aws_sdk_textract::operation::get_lending_analysis::builders::GetLendingAnalysisFluentBuilder

pub struct GetLendingAnalysisFluentBuilder { /* private fields */ }

Fluent builder constructing a request to GetLendingAnalysis.

Gets the results for an Amazon Textract asynchronous operation that analyzes text in a lending 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 GetLendingAnalysis, and pass the job identifier (JobId) from the initial call to StartLendingAnalysis.

Implementations

impl GetLendingAnalysisFluentBuilder

pub fn as_input(&self) -> &GetLendingAnalysisInputBuilder

Access the GetLendingAnalysis as a reference.

pub async fn send( self ) -> Result<GetLendingAnalysisOutput, SdkError<GetLendingAnalysisError, HttpResponse>>

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 customize( self ) -> CustomizableOperation<GetLendingAnalysisOutput, GetLendingAnalysisError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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.

pub fn get_job_id(&self) -> &Option<String>

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 max_results(self, input: i32) -> Self

The maximum number of results to return per paginated call. The largest value that you can specify is 30. If you specify a value greater than 30, a maximum of 30 results is returned. The default value is 30.

pub fn set_max_results(self, input: Option<i32>) -> Self

The maximum number of results to return per paginated call. The largest value that you can specify is 30. If you specify a value greater than 30, a maximum of 30 results is returned. The default value is 30.

pub fn get_max_results(&self) -> &Option<i32>

The maximum number of results to return per paginated call. The largest value that you can specify is 30. If you specify a value greater than 30, a maximum of 30 results is returned. The default value is 30.

pub fn next_token(self, input: impl Into<String>) -> Self

If the previous response was incomplete, Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of lending results.

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

If the previous response was incomplete, Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of lending results.

pub fn get_next_token(&self) -> &Option<String>

If the previous response was incomplete, Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of lending results.

Trait Implementations

impl Clone for GetLendingAnalysisFluentBuilder

fn clone(&self) -> GetLendingAnalysisFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetLendingAnalysisFluentBuilder

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

Formats the value using the given formatter.