aws_sdk_textract/client/
get_lending_analysis_summary.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetLendingAnalysisSummary`](crate::operation::get_lending_analysis_summary::builders::GetLendingAnalysisSummaryFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`job_id(impl Into<String>)`](crate::operation::get_lending_analysis_summary::builders::GetLendingAnalysisSummaryFluentBuilder::job_id) / [`set_job_id(Option<String>)`](crate::operation::get_lending_analysis_summary::builders::GetLendingAnalysisSummaryFluentBuilder::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 StartLendingAnalysis. A <code>JobId</code> value is only valid for 7 days.</p><br>
7    /// - On success, responds with [`GetLendingAnalysisSummaryOutput`](crate::operation::get_lending_analysis_summary::GetLendingAnalysisSummaryOutput) with field(s):
8    ///   - [`document_metadata(Option<DocumentMetadata>)`](crate::operation::get_lending_analysis_summary::GetLendingAnalysisSummaryOutput::document_metadata): <p>Information about the input document.</p>
9    ///   - [`job_status(Option<JobStatus>)`](crate::operation::get_lending_analysis_summary::GetLendingAnalysisSummaryOutput::job_status): <p>The current status of the lending analysis job.</p>
10    ///   - [`summary(Option<LendingSummary>)`](crate::operation::get_lending_analysis_summary::GetLendingAnalysisSummaryOutput::summary): <p>Contains summary information for documents grouped by type.</p>
11    ///   - [`warnings(Option<Vec::<Warning>>)`](crate::operation::get_lending_analysis_summary::GetLendingAnalysisSummaryOutput::warnings): <p>A list of warnings that occurred during the lending analysis operation.</p>
12    ///   - [`status_message(Option<String>)`](crate::operation::get_lending_analysis_summary::GetLendingAnalysisSummaryOutput::status_message): <p>Returns if the lending analysis could not be completed. Contains explanation for what error occurred.</p>
13    ///   - [`analyze_lending_model_version(Option<String>)`](crate::operation::get_lending_analysis_summary::GetLendingAnalysisSummaryOutput::analyze_lending_model_version): <p>The current model version of the Analyze Lending API.</p>
14    /// - On failure, responds with [`SdkError<GetLendingAnalysisSummaryError>`](crate::operation::get_lending_analysis_summary::GetLendingAnalysisSummaryError)
15    pub fn get_lending_analysis_summary(&self) -> crate::operation::get_lending_analysis_summary::builders::GetLendingAnalysisSummaryFluentBuilder {
16        crate::operation::get_lending_analysis_summary::builders::GetLendingAnalysisSummaryFluentBuilder::new(self.handle.clone())
17    }
18}
aws_sdk_textract/client/get_lending_analysis_summary.rs

aws_sdk_textract/client/
get_lending_analysis_summary.rs
