Skip to main content

ITextractAsynchronousJobRequest

Interface in AWS.Textract

Base request interface for Amazon Textract asynchronous jobs.

Ancestors

Properties

ClientRequestToken

property ClientRequestToken: string

Specify an idempotent token that you use to identify the start request.

If you use the same token with multiple requests, the same JobId is returned.

DocumentLocation

property DocumentLocation: ITextractDocumentLocation

Type: ITextractDocumentLocation

Specify the location on an input document.

JobTag

property JobTag: string

Specify an identifier to include in the completion notification published to the Amazon SNS topic.

KMSKeyId

property KMSKeyId: string

Specify the KMS key used to encrypt the results.

This can be either a Key ID or Key Alias format. When specified, the KMS key will be used for server-side encryption of the objects in the customer bucket. When not specified, the results will be encrypted using server-side using SSE-S3.

NotificationChannel

property NotificationChannel: ITextractNotificationChannel

Type: ITextractNotificationChannel

Specify an Amazon SNS topic that you want Amazon Textract to publish completion status notifications to.

OutputConfig

property OutputConfig: ITextractOutputConfig

Type: ITextractOutputConfig

Specify an Amazon S3 bucket as a destination for the output.

If not specified, Amazon Textract will save the results internally to be accessed by the relevant Get* operations.