Skip to contents

Starts the asynchronous detection of text in a document

Source: R/textract_operations.R
textract_start_document_text_detection.Rd

Starts the asynchronous detection of text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.

See https://www.paws-r-sdk.com/docs/textract_start_document_text_detection/ for full documentation.

Usage

textract_start_document_text_detection(
  DocumentLocation,
  ClientRequestToken = NULL,
  JobTag = NULL,
  NotificationChannel = NULL,
  OutputConfig = NULL,
  KMSKeyId = NULL
)

Arguments

DocumentLocation

[required] The location of the document to be processed.

ClientRequestToken

The idempotent token that's used to identify the start request. If you use the same token with multiple start_document_text_detection 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.

JobTag

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

NotificationChannel

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

OutputConfig

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.

KMSKeyId

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.