class Aws::Textract::Types::StartDocumentAnalysisRequest

@note When making an API call, you may pass StartDocumentAnalysisRequest

data as a hash:

    {
      document_location: { # required
        s3_object: {
          bucket: "S3Bucket",
          name: "S3ObjectName",
          version: "S3ObjectVersion",
        },
      },
      feature_types: ["TABLES"], # required, accepts TABLES, FORMS
      client_request_token: "ClientRequestToken",
      job_tag: "JobTag",
      notification_channel: {
        sns_topic_arn: "SNSTopicArn", # required
        role_arn: "RoleArn", # required
      },
      output_config: {
        s3_bucket: "S3Bucket", # required
        s3_prefix: "S3ObjectName",
      },
      kms_key_id: "KMSKeyId",
    }

@!attribute [rw] document_location

The location of the document to be processed.
@return [Types::DocumentLocation]

@!attribute [rw] 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`).
@return [Array<String>]

@!attribute [rw] client_request_token

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][1].

[1]: https://docs.aws.amazon.com/textract/latest/dg/api-async.html
@return [String]

@!attribute [rw] job_tag

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).
@return [String]

@!attribute [rw] notification_channel

The Amazon SNS topic ARN that you want Amazon Textract to publish
the completion status of the operation to.
@return [Types::NotificationChannel]

@!attribute [rw] output_config

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.
@return [Types::OutputConfig]

@!attribute [rw] kms_key_id

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.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/StartDocumentAnalysisRequest AWS API Documentation

Constants

SENSITIVE