Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . textract ]



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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--document-location <value>
[--client-request-token <value>]
[--job-tag <value>]
[--notification-channel <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--document-location (structure)

The location of the document to be processed.

S3Object -> (structure)

The Amazon S3 bucket that contains the input document.

Bucket -> (string)

The name of the S3 bucket.

Name -> (string)

The file name of the input document. Synchronous operations can use image files that are in JPEG or PNG format. Asynchronous operations also support PDF format files.

Version -> (string)

If the bucket has versioning enabled, you can specify the object version.

Shorthand Syntax:


JSON Syntax:

  "S3Object": {
    "Bucket": "string",
    "Name": "string",
    "Version": "string"

--client-request-token (string)

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 .

--job-tag (string)

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

--notification-channel (structure)

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

SNSTopicArn -> (string)

The Amazon SNS topic that Amazon Textract posts the completion status to.

RoleArn -> (string)

The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.

Shorthand Syntax:


JSON Syntax:

  "SNSTopicArn": "string",
  "RoleArn": "string"

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


To start detecting text in a multi-page document

The following start-document-text-detection example shows how to start asynchronous detection of text in a multi-page document.

aws textract start-document-text-detection --document-location '{"S3Object":{"Bucket":"reescheastv","Name":"doctest.png"}}' --notification-channel "SNSTopicArn=topicARN,RoleArn=roleARN"

The command returns output similar to the following.

    "JobId": "57849a3dc627d4df74123dca269d69f7b89329c870c65bb16c9fd63409d200b9"

For more information, see Detecting and Analyzing Text in Multi-Page Documents in the Amazon Textract Developers Guide


JobId -> (string)

The identifier of the text detection job for the document. Use JobId to identify the job in a subsequent call to GetDocumentTextDetection . A JobId value is only valid for 7 days.