Struct aws_sdk_textract::input::StartDocumentAnalysisInput
source · [−]#[non_exhaustive]pub struct StartDocumentAnalysisInput {
pub document_location: Option<DocumentLocation>,
pub feature_types: Option<Vec<FeatureType>>,
pub client_request_token: Option<String>,
pub job_tag: Option<String>,
pub notification_channel: Option<NotificationChannel>,
pub output_config: Option<OutputConfig>,
pub kms_key_id: Option<String>,
pub queries_config: Option<QueriesConfig>,
}
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.document_location: Option<DocumentLocation>
The location of the document to be processed.
feature_types: 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
).
client_request_token: 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.
job_tag: 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).
notification_channel: Option<NotificationChannel>
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
output_config: 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.
kms_key_id: 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.
queries_config: Option<QueriesConfig>
Implementations
sourceimpl StartDocumentAnalysisInput
impl StartDocumentAnalysisInput
sourcepub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<StartDocumentAnalysis, AwsErrorRetryPolicy>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<StartDocumentAnalysis, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<StartDocumentAnalysis
>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture StartDocumentAnalysisInput
sourceimpl StartDocumentAnalysisInput
impl StartDocumentAnalysisInput
sourcepub fn document_location(&self) -> Option<&DocumentLocation>
pub fn document_location(&self) -> Option<&DocumentLocation>
The location of the document to be processed.
sourcepub fn feature_types(&self) -> Option<&[FeatureType]>
pub fn feature_types(&self) -> Option<&[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) -> Option<&str>
pub fn client_request_token(&self) -> Option<&str>
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) -> Option<&str>
pub fn job_tag(&self) -> Option<&str>
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) -> Option<&NotificationChannel>
pub fn 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) -> Option<&OutputConfig>
pub fn 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) -> Option<&str>
pub fn kms_key_id(&self) -> Option<&str>
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) -> Option<&QueriesConfig>
pub fn queries_config(&self) -> Option<&QueriesConfig>
Trait Implementations
sourceimpl Clone for StartDocumentAnalysisInput
impl Clone for StartDocumentAnalysisInput
sourcefn clone(&self) -> StartDocumentAnalysisInput
fn clone(&self) -> StartDocumentAnalysisInput
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for StartDocumentAnalysisInput
impl Debug for StartDocumentAnalysisInput
sourceimpl PartialEq<StartDocumentAnalysisInput> for StartDocumentAnalysisInput
impl PartialEq<StartDocumentAnalysisInput> for StartDocumentAnalysisInput
sourcefn eq(&self, other: &StartDocumentAnalysisInput) -> bool
fn eq(&self, other: &StartDocumentAnalysisInput) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &StartDocumentAnalysisInput) -> bool
fn ne(&self, other: &StartDocumentAnalysisInput) -> bool
This method tests for !=
.
impl StructuralPartialEq for StartDocumentAnalysisInput
Auto Trait Implementations
impl RefUnwindSafe for StartDocumentAnalysisInput
impl Send for StartDocumentAnalysisInput
impl Sync for StartDocumentAnalysisInput
impl Unpin for StartDocumentAnalysisInput
impl UnwindSafe for StartDocumentAnalysisInput
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more