aws-sdk-textract 1.31.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 [`GetDocumentAnalysis`](crate::operation::get_document_analysis::builders::GetDocumentAnalysisFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`job_id(impl Into<String>)`](crate::operation::get_document_analysis::builders::GetDocumentAnalysisFluentBuilder::job_id) / [`set_job_id(Option<String>)`](crate::operation::get_document_analysis::builders::GetDocumentAnalysisFluentBuilder::set_job_id):<br>required: **true**<br><p>A unique identifier for the text-detection job. The <code>JobId</code> is returned from <code>StartDocumentAnalysis</code>. A <code>JobId</code> value is only valid for 7 days.</p><br>
    ///   - [`max_results(i32)`](crate::operation::get_document_analysis::builders::GetDocumentAnalysisFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_document_analysis::builders::GetDocumentAnalysisFluentBuilder::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 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::get_document_analysis::builders::GetDocumentAnalysisFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_document_analysis::builders::GetDocumentAnalysisFluentBuilder::set_next_token):<br>required: **false**<br><p>If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.</p><br>
    /// - On success, responds with [`GetDocumentAnalysisOutput`](crate::operation::get_document_analysis::GetDocumentAnalysisOutput) with field(s):
    ///   - [`document_metadata(Option<DocumentMetadata>)`](crate::operation::get_document_analysis::GetDocumentAnalysisOutput::document_metadata): <p>Information about a document that Amazon Textract processed. <code>DocumentMetadata</code> is returned in every page of paginated responses from an Amazon Textract video operation.</p>
    ///   - [`job_status(Option<JobStatus>)`](crate::operation::get_document_analysis::GetDocumentAnalysisOutput::job_status): <p>The current status of the text detection job.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::get_document_analysis::GetDocumentAnalysisOutput::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 text detection results.</p>
    ///   - [`blocks(Option<Vec::<Block>>)`](crate::operation::get_document_analysis::GetDocumentAnalysisOutput::blocks): <p>The results of the text-analysis operation.</p>
    ///   - [`warnings(Option<Vec::<Warning>>)`](crate::operation::get_document_analysis::GetDocumentAnalysisOutput::warnings): <p>A list of warnings that occurred during the document-analysis operation.</p>
    ///   - [`status_message(Option<String>)`](crate::operation::get_document_analysis::GetDocumentAnalysisOutput::status_message): <p>Returns if the detection job could not be completed. Contains explanation for what error occured.</p>
    ///   - [`analyze_document_model_version(Option<String>)`](crate::operation::get_document_analysis::GetDocumentAnalysisOutput::analyze_document_model_version): <p></p>
    /// - On failure, responds with [`SdkError<GetDocumentAnalysisError>`](crate::operation::get_document_analysis::GetDocumentAnalysisError)
    pub fn get_document_analysis(&self) -> crate::operation::get_document_analysis::builders::GetDocumentAnalysisFluentBuilder {
        crate::operation::get_document_analysis::builders::GetDocumentAnalysisFluentBuilder::new(self.handle.clone())
    }
}