StartDocumentAnalysisCommand

Suggest an Edit

Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements.

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

StartDocumentAnalysis returns a job identifier (JobId) that you use to get the results of the operation. When text analysis 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 analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to StartDocumentAnalysis.

For more information, see Document Text Analysis .

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { TextractClient, StartDocumentAnalysisCommand } from "@aws-sdk/client-textract"; // ES Modules import
// const { TextractClient, StartDocumentAnalysisCommand } = require("@aws-sdk/client-textract"); // CommonJS import
const client = new TextractClient(config);
const input = { // StartDocumentAnalysisRequest
  DocumentLocation: { // DocumentLocation
    S3Object: { // S3Object
      Bucket: "STRING_VALUE",
      Name: "STRING_VALUE",
      Version: "STRING_VALUE",
    },
  },
  FeatureTypes: [ // FeatureTypes // required
    "TABLES" || "FORMS" || "QUERIES" || "SIGNATURES" || "LAYOUT",
  ],
  ClientRequestToken: "STRING_VALUE",
  JobTag: "STRING_VALUE",
  NotificationChannel: { // NotificationChannel
    SNSTopicArn: "STRING_VALUE", // required
    RoleArn: "STRING_VALUE", // required
  },
  OutputConfig: { // OutputConfig
    S3Bucket: "STRING_VALUE", // required
    S3Prefix: "STRING_VALUE",
  },
  KMSKeyId: "STRING_VALUE",
  QueriesConfig: { // QueriesConfig
    Queries: [ // Queries // required
      { // Query
        Text: "STRING_VALUE", // required
        Alias: "STRING_VALUE",
        Pages: [ // QueryPages
          "STRING_VALUE",
        ],
      },
    ],
  },
  AdaptersConfig: { // AdaptersConfig
    Adapters: [ // Adapters // required
      { // Adapter
        AdapterId: "STRING_VALUE", // required
        Pages: [ // AdapterPages
          "STRING_VALUE",
        ],
        Version: "STRING_VALUE", // required
      },
    ],
  },
};
const command = new StartDocumentAnalysisCommand(input);
const response = await client.send(command);
// { // StartDocumentAnalysisResponse
//   JobId: "STRING_VALUE",
// };

StartDocumentAnalysisCommand Input

See StartDocumentAnalysisCommandInput for more details

Parameter
Type
Description
DocumentLocation
Required
DocumentLocation | undefined

The location of the document to be processed.

FeatureTypes
Required
FeatureType[] | undefined

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

AdaptersConfig
AdaptersConfig | undefined

Specifies the adapter to be used when analyzing a document.

ClientRequestToken
string | undefined

The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis 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
string | undefined

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

KMSKeyId
string | undefined

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.

NotificationChannel
NotificationChannel | undefined

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

OutputConfig
OutputConfig | undefined

Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save the results internally to be accessed by the GetDocumentAnalysis operation.

QueriesConfig
QueriesConfig | undefined

StartDocumentAnalysisCommand Output

See StartDocumentAnalysisCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
JobId
string | undefined

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

Throws

Name
Fault
Details
AccessDeniedException
client

You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.

BadDocumentException
client

Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.

DocumentTooLargeException
client

The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files.

IdempotentParameterMismatchException
client

A ClientRequestToken input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.

InternalServerError
server

Amazon Textract experienced a service issue. Try your call again.

InvalidKMSKeyException
client

Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.

InvalidParameterException
client

An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

InvalidS3ObjectException
client

Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3  For troubleshooting information, see Troubleshooting Amazon S3 

LimitExceededException
client

An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (StartDocumentTextDetection, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit.

ProvisionedThroughputExceededException
client

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

ThrottlingException
server

Amazon Textract is temporarily unable to process the request. Try your call again.

UnsupportedDocumentException
client

The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.

TextractServiceException
Base exception class for all service exceptions from Textract service.