Skip to content

Starts the asynchronous detection of text in a document

Description

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.

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

start_document_text_detection 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 get_document_text_detection, and pass the job identifier (JobId) from the initial call to start_document_text_detection.

For more information, see Document Text Detection.

Usage

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

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.

Value

A list with the following syntax:

list(
  JobId = "string"
)

Request syntax

svc$start_document_text_detection(
  DocumentLocation = list(
    S3Object = list(
      Bucket = "string",
      Name = "string",
      Version = "string"
    )
  ),
  ClientRequestToken = "string",
  JobTag = "string",
  NotificationChannel = list(
    SNSTopicArn = "string",
    RoleArn = "string"
  ),
  OutputConfig = list(
    S3Bucket = "string",
    S3Prefix = "string"
  ),
  KMSKeyId = "string"
)