pub struct StartDocumentAnalysisFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to StartDocumentAnalysis.
Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements.
StartDocumentAnalysis can analyze text in documents that are in JPEG, PNG, TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document.
StartDocumentAnalysis returns a job identifier (JobId) that you use to get the results of the operation. When text analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. 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 GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to StartDocumentAnalysis.
For more information, see Document Text Analysis.
Implementations§
Source§impl StartDocumentAnalysisFluentBuilder
impl StartDocumentAnalysisFluentBuilder
Sourcepub fn as_input(&self) -> &StartDocumentAnalysisInputBuilder
pub fn as_input(&self) -> &StartDocumentAnalysisInputBuilder
Access the StartDocumentAnalysis as a reference.
Sourcepub async fn send(
self,
) -> Result<StartDocumentAnalysisOutput, SdkError<StartDocumentAnalysisError, HttpResponse>>
pub async fn send( self, ) -> Result<StartDocumentAnalysisOutput, SdkError<StartDocumentAnalysisError, 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.
Sourcepub fn customize(
self,
) -> CustomizableOperation<StartDocumentAnalysisOutput, StartDocumentAnalysisError, Self>
pub fn customize( self, ) -> CustomizableOperation<StartDocumentAnalysisOutput, StartDocumentAnalysisError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn document_location(self, input: DocumentLocation) -> Self
pub fn document_location(self, input: DocumentLocation) -> Self
The location of the document to be processed.
Sourcepub fn set_document_location(self, input: Option<DocumentLocation>) -> Self
pub fn set_document_location(self, input: Option<DocumentLocation>) -> Self
The location of the document to be processed.
Sourcepub fn get_document_location(&self) -> &Option<DocumentLocation>
pub fn get_document_location(&self) -> &Option<DocumentLocation>
The location of the document to be processed.
Sourcepub fn feature_types(self, input: FeatureType) -> Self
pub fn feature_types(self, input: FeatureType) -> Self
Appends an item to FeatureTypes.
To override the contents of this collection use set_feature_types.
A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).
Sourcepub fn set_feature_types(self, input: Option<Vec<FeatureType>>) -> Self
pub fn set_feature_types(self, input: Option<Vec<FeatureType>>) -> Self
A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).
Sourcepub fn get_feature_types(&self) -> &Option<Vec<FeatureType>>
pub fn get_feature_types(&self) -> &Option<Vec<FeatureType>>
A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).
Sourcepub fn client_request_token(self, input: impl Into<String>) -> Self
pub fn client_request_token(self, input: impl Into<String>) -> Self
The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.
Sourcepub fn set_client_request_token(self, input: Option<String>) -> Self
pub fn set_client_request_token(self, input: Option<String>) -> Self
The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.
Sourcepub fn get_client_request_token(&self) -> &Option<String>
pub fn get_client_request_token(&self) -> &Option<String>
The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.
Sourcepub fn job_tag(self, input: impl Into<String>) -> Self
pub fn job_tag(self, input: impl Into<String>) -> Self
An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).
Sourcepub fn set_job_tag(self, input: Option<String>) -> Self
pub fn set_job_tag(self, input: Option<String>) -> Self
An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).
Sourcepub fn get_job_tag(&self) -> &Option<String>
pub fn get_job_tag(&self) -> &Option<String>
An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).
Sourcepub fn notification_channel(self, input: NotificationChannel) -> Self
pub fn notification_channel(self, input: NotificationChannel) -> Self
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
Sourcepub fn set_notification_channel(
self,
input: Option<NotificationChannel>,
) -> Self
pub fn set_notification_channel( self, input: Option<NotificationChannel>, ) -> Self
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
Sourcepub fn get_notification_channel(&self) -> &Option<NotificationChannel>
pub fn get_notification_channel(&self) -> &Option<NotificationChannel>
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
Sourcepub fn output_config(self, input: OutputConfig) -> Self
pub fn output_config(self, input: OutputConfig) -> Self
Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save the results internally to be accessed by the GetDocumentAnalysis operation.
Sourcepub fn set_output_config(self, input: Option<OutputConfig>) -> Self
pub fn set_output_config(self, input: Option<OutputConfig>) -> Self
Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save the results internally to be accessed by the GetDocumentAnalysis operation.
Sourcepub fn get_output_config(&self) -> &Option<OutputConfig>
pub fn get_output_config(&self) -> &Option<OutputConfig>
Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save the results internally to be accessed by the GetDocumentAnalysis operation.
Sourcepub fn kms_key_id(self, input: impl Into<String>) -> Self
pub fn kms_key_id(self, input: impl Into<String>) -> Self
The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.
Sourcepub fn set_kms_key_id(self, input: Option<String>) -> Self
pub fn set_kms_key_id(self, input: Option<String>) -> Self
The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.
Sourcepub fn get_kms_key_id(&self) -> &Option<String>
pub fn get_kms_key_id(&self) -> &Option<String>
The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.
Sourcepub fn queries_config(self, input: QueriesConfig) -> Self
pub fn queries_config(self, input: QueriesConfig) -> Self
Sourcepub fn set_queries_config(self, input: Option<QueriesConfig>) -> Self
pub fn set_queries_config(self, input: Option<QueriesConfig>) -> Self
Sourcepub fn get_queries_config(&self) -> &Option<QueriesConfig>
pub fn get_queries_config(&self) -> &Option<QueriesConfig>
Sourcepub fn adapters_config(self, input: AdaptersConfig) -> Self
pub fn adapters_config(self, input: AdaptersConfig) -> Self
Specifies the adapter to be used when analyzing a document.
Sourcepub fn set_adapters_config(self, input: Option<AdaptersConfig>) -> Self
pub fn set_adapters_config(self, input: Option<AdaptersConfig>) -> Self
Specifies the adapter to be used when analyzing a document.
Sourcepub fn get_adapters_config(&self) -> &Option<AdaptersConfig>
pub fn get_adapters_config(&self) -> &Option<AdaptersConfig>
Specifies the adapter to be used when analyzing a document.
Trait Implementations§
Source§impl Clone for StartDocumentAnalysisFluentBuilder
impl Clone for StartDocumentAnalysisFluentBuilder
Source§fn clone(&self) -> StartDocumentAnalysisFluentBuilder
fn clone(&self) -> StartDocumentAnalysisFluentBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for StartDocumentAnalysisFluentBuilder
impl !RefUnwindSafe for StartDocumentAnalysisFluentBuilder
impl Send for StartDocumentAnalysisFluentBuilder
impl Sync for StartDocumentAnalysisFluentBuilder
impl Unpin for StartDocumentAnalysisFluentBuilder
impl !UnwindSafe for StartDocumentAnalysisFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);