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.
Gets the results for an Amazon Textract asynchronous operation that detects text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.
You start asynchronous text detection by calling StartDocumentTextDetection,
which returns a job identifier (JobId). When the text detection operation finishes,
Amazon Textract publishes a completion status to the Amazon Simple Notification Service
(Amazon SNS) topic that's registered in the initial call to StartDocumentTextDetection.
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.
GetDocumentTextDetection returns an array of Block objects.
Each document page has as an associated Block of type PAGE. Each PAGE Block
object is the parent of LINE Block objects that represent the lines of detected
text on a page. A LINE Block object is a parent for each word that makes up
the line. Words are represented by Block objects of type WORD.
Use the MaxResults parameter to limit the number of blocks that are returned. If there
are more results than specified in MaxResults, the value of NextToken
in the operation response contains a pagination token for getting the next set of
results. To get the next page of results, call GetDocumentTextDetection, and
populate the NextToken request parameter with the token value that's returned
from the previous call to GetDocumentTextDetection.
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 BeginGetDocumentTextDetection and EndGetDocumentTextDetection.
Namespace: Amazon.Textract
Assembly: AWSSDK.Textract.dll
Version: 3.x.y.z
public virtual Task<GetDocumentTextDetectionResponse> GetDocumentTextDetectionAsync( GetDocumentTextDetectionRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the GetDocumentTextDetection 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. |
| InternalServerErrorException | Amazon Textract experienced a service issue. Try your call again. |
| InvalidJobIdException | An invalid job identifier was passed to an asynchronous analysis operation. |
| 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 |
| 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. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer