AWS SDK Version 3 for .NET
API Reference

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.

Analyzes an input document for relationships between detected items.

The types of information returned are as follows:

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.

You can choose which type of analysis to perform by specifying the FeatureTypes list.

The output is returned in a list of Block objects.

AnalyzeDocument is a synchronous operation. To analyze documents asynchronously, use StartDocumentAnalysis.

For more information, see Document Text Analysis.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to AnalyzeDocumentAsync.

Namespace: Amazon.Textract
Assembly: AWSSDK.Textract.dll
Version: 3.x.y.z

Syntax

C#
public virtual AnalyzeDocumentResponse AnalyzeDocument(
         AnalyzeDocumentRequest request
)

Parameters

request
Type: Amazon.Textract.Model.AnalyzeDocumentRequest

Container for the necessary parameters to execute the AnalyzeDocument service method.

Return Value


The response from the AnalyzeDocument service method, as returned by Textract.

Exceptions

ExceptionCondition
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.
HumanLoopQuotaExceededException Indicates you have exceeded the maximum number of active human in the loop workflows available
InternalServerErrorException Amazon Textract experienced a service issue. Try your call again.
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.
UnsupportedDocumentException The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

See Also