aws-sdk-textract 1.30.0

AWS SDK for Amazon Textract
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetLendingAnalysis`](crate::operation::get_lending_analysis::builders::GetLendingAnalysisFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`job_id(impl Into<String>)`](crate::operation::get_lending_analysis::builders::GetLendingAnalysisFluentBuilder::job_id) / [`set_job_id(Option<String>)`](crate::operation::get_lending_analysis::builders::GetLendingAnalysisFluentBuilder::set_job_id):<br>required: **true**<br><p>A unique identifier for the lending or text-detection job. The <code>JobId</code> is returned from <code>StartLendingAnalysis</code>. A <code>JobId</code> value is only valid for 7 days.</p><br>
    ///   - [`max_results(i32)`](crate::operation::get_lending_analysis::builders::GetLendingAnalysisFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_lending_analysis::builders::GetLendingAnalysisFluentBuilder::set_max_results):<br>required: **false**<br><p>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.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::get_lending_analysis::builders::GetLendingAnalysisFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_lending_analysis::builders::GetLendingAnalysisFluentBuilder::set_next_token):<br>required: **false**<br><p>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.</p><br>
    /// - On success, responds with [`GetLendingAnalysisOutput`](crate::operation::get_lending_analysis::GetLendingAnalysisOutput) with field(s):
    ///   - [`document_metadata(Option<DocumentMetadata>)`](crate::operation::get_lending_analysis::GetLendingAnalysisOutput::document_metadata): <p>Information about the input document.</p>
    ///   - [`job_status(Option<JobStatus>)`](crate::operation::get_lending_analysis::GetLendingAnalysisOutput::job_status): <p>The current status of the lending analysis job.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::get_lending_analysis::GetLendingAnalysisOutput::next_token): <p>If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of lending results.</p>
    ///   - [`results(Option<Vec::<LendingResult>>)`](crate::operation::get_lending_analysis::GetLendingAnalysisOutput::results): <p>Holds the information returned by one of AmazonTextract's document analysis operations for the pinstripe.</p>
    ///   - [`warnings(Option<Vec::<Warning>>)`](crate::operation::get_lending_analysis::GetLendingAnalysisOutput::warnings): <p>A list of warnings that occurred during the lending analysis operation.</p>
    ///   - [`status_message(Option<String>)`](crate::operation::get_lending_analysis::GetLendingAnalysisOutput::status_message): <p>Returns if the lending analysis job could not be completed. Contains explanation for what error occurred.</p>
    ///   - [`analyze_lending_model_version(Option<String>)`](crate::operation::get_lending_analysis::GetLendingAnalysisOutput::analyze_lending_model_version): <p>The current model version of the Analyze Lending API.</p>
    /// - On failure, responds with [`SdkError<GetLendingAnalysisError>`](crate::operation::get_lending_analysis::GetLendingAnalysisError)
    pub fn get_lending_analysis(&self) -> crate::operation::get_lending_analysis::builders::GetLendingAnalysisFluentBuilder {
        crate::operation::get_lending_analysis::builders::GetLendingAnalysisFluentBuilder::new(self.handle.clone())
    }
}