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 analyzes text in a document.
You start asynchronous text analysis by calling StartDocumentAnalysis, which
returns a job identifier (JobId). When the text analysis 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 StartDocumentAnalysis.
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 GetDocumentAnalysis,
and pass the job identifier (JobId) from the initial call to StartDocumentAnalysis.
GetDocumentAnalysis returns an array of Block objects. The following
types of information are returned:
Form data (key-value pairs). The related information is returned in two Block
objects, each of type KEY_VALUE_SET: a KEY Block object and a VALUE
Block object. For example, Name: Ana Silva Carolina contains a key and
value. Name: is the key. Ana Silva Carolina is the value.
Table and table cell data. A TABLE Block object contains information about
a detected table. A CELL Block object is returned for each cell in a table.
Lines and words of text. A LINE Block object contains one or more WORD Block
objects. All lines and words that are detected in the document are returned (including
text that doesn't have a relationship with the value of the StartDocumentAnalysis
FeatureTypes input parameter).
Query. A QUERY Block object contains the query text, alias and link to the associated Query results block object.
Query Results. A QUERY_RESULT Block object contains the answer to the query and an ID that connects it to the query asked. This Block also contains a confidence score.
While processing a document with queries, look out for INVALID_REQUEST_PARAMETERS
output. This indicates that either the per page query limit has been exceeded or that
the operation is trying to query a page in the document which doesn’t exist.
Selection elements such as check boxes and option buttons (radio buttons) can be detected
in form data and in tables. A SELECTION_ELEMENT Block object contains information
about a selection element, including the selection status.
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 GetDocumentAnalysis, and populate
the NextToken request parameter with the token value that's returned from the
previous call to GetDocumentAnalysis.
For more information, see Document Text Analysis.
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 BeginGetDocumentAnalysis and EndGetDocumentAnalysis.
Namespace: Amazon.Textract
Assembly: AWSSDK.Textract.dll
Version: 3.x.y.z
public virtual Task<GetDocumentAnalysisResponse> GetDocumentAnalysisAsync( GetDocumentAnalysisRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the GetDocumentAnalysis 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