aws_sdk_textract/client/
get_document_text_detection.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 [`GetDocumentTextDetection`](crate::operation::get_document_text_detection::builders::GetDocumentTextDetectionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`job_id(impl Into<String>)`](crate::operation::get_document_text_detection::builders::GetDocumentTextDetectionFluentBuilder::job_id) / [`set_job_id(Option<String>)`](crate::operation::get_document_text_detection::builders::GetDocumentTextDetectionFluentBuilder::set_job_id):<br>required: **true**<br><p>A unique identifier for the text detection job. The <code>JobId</code> is returned from <code>StartDocumentTextDetection</code>. A <code>JobId</code> value is only valid for 7 days.</p><br>
7    ///   - [`max_results(i32)`](crate::operation::get_document_text_detection::builders::GetDocumentTextDetectionFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_document_text_detection::builders::GetDocumentTextDetectionFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return per paginated call. The largest value 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>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::get_document_text_detection::builders::GetDocumentTextDetectionFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_document_text_detection::builders::GetDocumentTextDetectionFluentBuilder::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>
9    /// - On success, responds with [`GetDocumentTextDetectionOutput`](crate::operation::get_document_text_detection::GetDocumentTextDetectionOutput) with field(s):
10    ///   - [`document_metadata(Option<DocumentMetadata>)`](crate::operation::get_document_text_detection::GetDocumentTextDetectionOutput::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>
11    ///   - [`job_status(Option<JobStatus>)`](crate::operation::get_document_text_detection::GetDocumentTextDetectionOutput::job_status): <p>The current status of the text detection job.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::get_document_text_detection::GetDocumentTextDetectionOutput::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>
13    ///   - [`blocks(Option<Vec::<Block>>)`](crate::operation::get_document_text_detection::GetDocumentTextDetectionOutput::blocks): <p>The results of the text-detection operation.</p>
14    ///   - [`warnings(Option<Vec::<Warning>>)`](crate::operation::get_document_text_detection::GetDocumentTextDetectionOutput::warnings): <p>A list of warnings that occurred during the text-detection operation for the document.</p>
15    ///   - [`status_message(Option<String>)`](crate::operation::get_document_text_detection::GetDocumentTextDetectionOutput::status_message): <p>Returns if the detection job could not be completed. Contains explanation for what error occured.</p>
16    ///   - [`detect_document_text_model_version(Option<String>)`](crate::operation::get_document_text_detection::GetDocumentTextDetectionOutput::detect_document_text_model_version): <p></p>
17    /// - On failure, responds with [`SdkError<GetDocumentTextDetectionError>`](crate::operation::get_document_text_detection::GetDocumentTextDetectionError)
18    pub fn get_document_text_detection(&self) -> crate::operation::get_document_text_detection::builders::GetDocumentTextDetectionFluentBuilder {
19        crate::operation::get_document_text_detection::builders::GetDocumentTextDetectionFluentBuilder::new(self.handle.clone())
20    }
21}
aws_sdk_textract/client/get_document_text_detection.rs

aws_sdk_textract/client/
get_document_text_detection.rs
