class Aws::Textract::Types::StartDocumentTextDetectionRequest

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

data as a hash:

    {
      document_location: { # required
        s3_object: {
          bucket: "S3Bucket",
          name: "S3ObjectName",
          version: "S3ObjectVersion",
        },
      },
      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] client_request_token

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][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 with
the GetDocumentTextDetection 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/StartDocumentTextDetectionRequest AWS API Documentation

Constants

SENSITIVE