#[non_exhaustive]pub struct StartLendingAnalysisInput {
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 Amazon S3 bucket that contains the document to be processed. It's used by asynchronous operations.
The input document can be an image file in JPEG or PNG format. It can also be a file in PDF format.
client_request_token: Option<String>
The idempotent token that you use to identify the start request. If you use the same token with multiple StartLendingAnalysis
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 to be 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 Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of an asynchronous document operation.
output_config: Option<OutputConfig>
Sets whether or not your output will go to a user created bucket. Used to set the name of the bucket, and the prefix on the output file.
OutputConfig
is an optional parameter which lets you adjust where your output will be placed. By default, Amazon Textract will store the results internally and can only be accessed by the Get API operations. With OutputConfig
enabled, you can set the name of the bucket the output will be sent to the file prefix of the results where you can download your results. Additionally, you can set the KMSKeyID
parameter to a customer master key (CMK) to encrypt your output. Without this parameter set Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3.
Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see Managing AI services opt-out policy.
For more information on data privacy, see the Data Privacy FAQ.
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§
source§impl StartLendingAnalysisInput
impl StartLendingAnalysisInput
sourcepub fn document_location(&self) -> Option<&DocumentLocation>
pub fn document_location(&self) -> Option<&DocumentLocation>
The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous operations.
The input document can be an image file in JPEG or PNG format. It can also be a file in PDF format.
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 StartLendingAnalysis
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 to be 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 Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of an asynchronous document operation.
sourcepub fn output_config(&self) -> Option<&OutputConfig>
pub fn output_config(&self) -> Option<&OutputConfig>
Sets whether or not your output will go to a user created bucket. Used to set the name of the bucket, and the prefix on the output file.
OutputConfig
is an optional parameter which lets you adjust where your output will be placed. By default, Amazon Textract will store the results internally and can only be accessed by the Get API operations. With OutputConfig
enabled, you can set the name of the bucket the output will be sent to the file prefix of the results where you can download your results. Additionally, you can set the KMSKeyID
parameter to a customer master key (CMK) to encrypt your output. Without this parameter set Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3.
Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see Managing AI services opt-out policy.
For more information on data privacy, see the Data Privacy FAQ.
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.
source§impl StartLendingAnalysisInput
impl StartLendingAnalysisInput
sourcepub fn builder() -> StartLendingAnalysisInputBuilder
pub fn builder() -> StartLendingAnalysisInputBuilder
Creates a new builder-style object to manufacture StartLendingAnalysisInput
.
Trait Implementations§
source§impl Clone for StartLendingAnalysisInput
impl Clone for StartLendingAnalysisInput
source§fn clone(&self) -> StartLendingAnalysisInput
fn clone(&self) -> StartLendingAnalysisInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for StartLendingAnalysisInput
impl Debug for StartLendingAnalysisInput
source§impl PartialEq for StartLendingAnalysisInput
impl PartialEq for StartLendingAnalysisInput
source§fn eq(&self, other: &StartLendingAnalysisInput) -> bool
fn eq(&self, other: &StartLendingAnalysisInput) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for StartLendingAnalysisInput
Auto Trait Implementations§
impl Freeze for StartLendingAnalysisInput
impl RefUnwindSafe for StartLendingAnalysisInput
impl Send for StartLendingAnalysisInput
impl Sync for StartLendingAnalysisInput
impl Unpin for StartLendingAnalysisInput
impl UnwindSafe for StartLendingAnalysisInput
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> 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 more