Struct rusoto_textract::StartDocumentAnalysisRequest

pub struct StartDocumentAnalysisRequest {
    pub client_request_token: Option<String>,
    pub document_location: DocumentLocation,
    pub feature_types: Vec<String>,
    pub job_tag: Option<String>,
    pub kms_key_id: Option<String>,
    pub notification_channel: Option<NotificationChannel>,
    pub output_config: Option<OutputConfig>,
}

Fields

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.

document_location: DocumentLocation

The location of the document to be processed.

feature_types: Vec<String>

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).

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).

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.

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.

Trait Implementations

impl Clone for StartDocumentAnalysisRequest

fn clone(&self) -> StartDocumentAnalysisRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartDocumentAnalysisRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for StartDocumentAnalysisRequest

fn default() -> StartDocumentAnalysisRequest

Returns the “default value” for a type.

impl PartialEq<StartDocumentAnalysisRequest> for StartDocumentAnalysisRequest

fn eq(&self, other: &StartDocumentAnalysisRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &StartDocumentAnalysisRequest) -> bool

This method tests for !=.

impl Serialize for StartDocumentAnalysisRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StartDocumentAnalysisRequest