AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginStartDocumentTextDetection and EndStartDocumentTextDetection.
Namespace: Amazon.Textract
Assembly: AWSSDK.Textract.dll
Version: 3.x.y.z
public virtual Task<StartDocumentTextDetectionResponse> StartDocumentTextDetectionAsync( StartDocumentTextDetectionRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the StartDocumentTextDetection service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| AccessDeniedException | 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 | Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits. |
| DocumentTooLargeException | 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 | 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. |
| InternalServerErrorException | Amazon Textract experienced a service issue. Try your call again. |
| InvalidKMSKeyException | Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly. |
| InvalidParameterException | 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 | 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 | 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 | The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. |
| ThrottlingException | Amazon Textract is temporarily unable to process the request. Try your call again. |
| UnsupportedDocumentException | The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer