/AWS1/CL_TEX=>STARTDOCUMENTTEXTDETECTION()

About StartDocumentTextDetection

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.

StartDocumentTextDetection can analyze text in documents that are in JPEG, PNG, TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document.

StartTextDetection returns a job identifier (JobId) that you use to get the results of the operation. When text detection is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentTextDetection, and pass the job identifier (JobId) from the initial call to StartDocumentTextDetection.

For more information, see Document Text Detection.

Method Signature

IMPORTING

Required arguments:

IO_DOCUMENTLOCATION TYPE REF TO /AWS1/CL_TEXDOCUMENTLOCATION /AWS1/CL_TEXDOCUMENTLOCATION

The location of the document to be processed.

Optional arguments:

IV_CLIENTREQUESTTOKEN TYPE /AWS1/TEXCLIENTREQUESTTOKEN /AWS1/TEXCLIENTREQUESTTOKEN

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.

IV_JOBTAG TYPE /AWS1/TEXJOBTAG /AWS1/TEXJOBTAG

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

IO_NOTIFICATIONCHANNEL TYPE REF TO /AWS1/CL_TEXNOTIFCHANNEL /AWS1/CL_TEXNOTIFCHANNEL

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

IO_OUTPUTCONFIG TYPE REF TO /AWS1/CL_TEXOUTPUTCONFIG /AWS1/CL_TEXOUTPUTCONFIG

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.

IV_KMSKEYID TYPE /AWS1/TEXKMSKEYID /AWS1/TEXKMSKEYID

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.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_TEXSTARTDOCTEXTDETRSP /AWS1/CL_TEXSTARTDOCTEXTDETRSP