#[non_exhaustive]pub struct StartDocumentTextDetectionInput {
pub document_location: Option<DocumentLocation>,
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>,
}
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.
client_request_token: Option<String>
The idempotent token that's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection
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 with the GetDocumentTextDetection 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.
Implementations
sourceimpl StartDocumentTextDetectionInput
impl StartDocumentTextDetectionInput
sourcepub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<StartDocumentTextDetection, AwsErrorRetryPolicy>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<StartDocumentTextDetection, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<StartDocumentTextDetection
>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture StartDocumentTextDetectionInput
sourceimpl StartDocumentTextDetectionInput
impl StartDocumentTextDetectionInput
sourcepub fn document_location(&self) -> Option<&DocumentLocation>
pub fn document_location(&self) -> Option<&DocumentLocation>
The location of the document to be processed.
sourcepub fn client_request_token(&self) -> Option<&str>
pub fn client_request_token(&self) -> Option<&str>
The idempotent token that's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection
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 with the GetDocumentTextDetection 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.
Trait Implementations
sourceimpl Clone for StartDocumentTextDetectionInput
impl Clone for StartDocumentTextDetectionInput
sourcefn clone(&self) -> StartDocumentTextDetectionInput
fn clone(&self) -> StartDocumentTextDetectionInput
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 PartialEq<StartDocumentTextDetectionInput> for StartDocumentTextDetectionInput
impl PartialEq<StartDocumentTextDetectionInput> for StartDocumentTextDetectionInput
sourcefn eq(&self, other: &StartDocumentTextDetectionInput) -> bool
fn eq(&self, other: &StartDocumentTextDetectionInput) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &StartDocumentTextDetectionInput) -> bool
fn ne(&self, other: &StartDocumentTextDetectionInput) -> bool
This method tests for !=
.
impl StructuralPartialEq for StartDocumentTextDetectionInput
Auto Trait Implementations
impl RefUnwindSafe for StartDocumentTextDetectionInput
impl Send for StartDocumentTextDetectionInput
impl Sync for StartDocumentTextDetectionInput
impl Unpin for StartDocumentTextDetectionInput
impl UnwindSafe for StartDocumentTextDetectionInput
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