AWSSDK.Textract

Configuration for accessing Amazon Textract service

Default constructor

The constant used to lookup in the region hash the endpoint.

Gets the ServiceVersion property.

Gets the value of UserAgent property.

Common exception for the Textract service.

Construct instance of AmazonTextractException

Constructs a new instance of the AmazonTextractException class with serialized data.

The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0).

Service metadata for Amazon Textract service

Gets the value of the Service Id.

Gets the dictionary that gives mapping of renamed operations

Textract exception

Constructs a new AccessDeniedException with the specified error message.

Describes the error encountered.

Construct instance of AccessDeniedException

Constructs a new instance of the AccessDeniedException class with serialized data.

Container for the parameters to the AnalyzeDocument operation. Analyzes an input document for relationships between detected items. The types of information returned are as follows:

Words and lines that are related to nearby lines and words. 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.
Selectable elements such as checkboxes and radio buttons. A SELECTION_ELEMENT Block object contains information about a selectable element.
Lines and words of text. A LINE Block object contains one or more WORD Block objects.

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.

Gets and sets the property Document. The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPG or PNG format. If you are using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes field.

Gets and sets the property FeatureTypes. A list of the types of analysis to perform. Add TABLES to the list to return information about the tables detected in the input document. Add FORMS to return detected fields and the associated text. To perform both types of analysis, add TABLES and FORMS to FeatureTypes.

This is the response object from the AnalyzeDocument operation.

Gets and sets the property Blocks. The text that's detected and analyzed by AnalyzeDocument.

Gets and sets the property DocumentMetadata. Metadata about the analyzed document. An example is the number of pages.

Textract exception

Constructs a new BadDocumentException with the specified error message.

Describes the error encountered.

Construct instance of BadDocumentException

Constructs a new instance of the BadDocumentException class with serialized data.

A Block represents items that are recognized in a document within a group of pixels close to each other. The information returned in a Block depends on the type of operation. In document-text detection (for example DetectDocumentText), you get information about the detected words and lines of text. In text analysis (for example AnalyzeDocument), you can also get information about the fields, tables and selection elements that are detected in the document. An array of Block objects is returned by both synchronous and asynchronous operations. In synchronous operations, such as DetectDocumentText, the array of Block objects is the entire set of results. In asynchronous operations, such as GetDocumentAnalysis, the array is returned over one or more responses. For more information, see How Amazon Textract Works.

Gets and sets the property BlockType. The type of text that's recognized in a block. In text-detection operations, the following types are returned:

PAGE - Contains a list of the LINE Block objects that are detected on a document page.
WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
LINE - A string of tab-delimited, contiguous words that's detected on a document page.

In text analysis operations, the following types are returned:

PAGE - Contains a list of child Block objects that are detected on a document page.
KEY_VALUE_SET - Stores the KEY and VALUE Block objects for a field that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.
WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces that's detected on a document page.
LINE - A string of tab-delimited, contiguous words that's detected on a document page.
TABLE - A table that's detected on a document page. A table is any grid-based information with 2 or more rows or columns with a cell span of 1 row and 1 column each.
CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.
SELECTION_ELEMENT - A selectable element such as a radio button or checkbox that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.

Gets and sets the property ColumnIndex. The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.

Gets and sets the property ColumnSpan. The number of columns that a table cell spans. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

Gets and sets the property Confidence. The confidence that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.

Gets and sets the property EntityTypes. The type of entity. The following can be returned:

KEY - An identifier for a field on the document.
VALUE - The field text.

EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection.

Gets and sets the property Geometry. The location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial information.

Gets and sets the property Id. The identifier for the recognized text. The identifier is only unique for a single operation.

Gets and sets the property Page. The page in which a block was detected. Page is returned by asynchronous operations. Page values greater than 1 are only returned for multi-page documents that are in PDF format. A scanned image (JPG/PNG), even if it contains multiple document pages, is always considered to be a single-page document and the value of Page is always 1. Synchronous operations don't return Page as every input document is considered to be a single-page document.

Gets and sets the property Relationships. A list of child blocks of the current block. For example a LINE object has child blocks for each WORD block that's part of the line of text. There aren't Relationship objects in the list for relationships that don't exist, such as when the current block has no child blocks. The list size can be the following:

0 - The block has no child blocks.
1 - The block has child blocks.

Gets and sets the property RowIndex. The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.

Gets and sets the property RowSpan. The number of rows that a table spans. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

Gets and sets the property SelectionStatus. The selection status of a selectable element such as a radio button or checkbox.

Gets and sets the property Text. The word or line of text that's recognized by Amazon Textract.

The bounding box around the recognized text, key, value, table or table cell on a document page. The left (x-coordinate) and top (y-coordinate) are coordinates that represent the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0). The top and left values returned are ratios of the overall document page size. For example, if the input image is 700 x 200 pixels, and the top-left coordinate of the bounding box is 350 x 50 pixels, the API returns a left value of 0.5 (350/700) and a top value of 0.25 (50/200). The width and height values represent the dimensions of the bounding box as a ratio of the overall document page dimension. For example, if the document page size is 700 x 200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1.

Gets and sets the property Height. The height of the bounding box as a ratio of the overall document page height.

Gets and sets the property Left. The left coordinate of the bounding box as a ratio of overall document page width.

Gets and sets the property Top. The top coordinate of the bounding box as a ratio of overall document page height.

Gets and sets the property Width. The width of the bounding box as a ratio of the overall document page width.

Container for the parameters to the DetectDocumentText operation. Detects text in the input document. Amazon Textract can detect lines of text and the words that make up a line of text. The input document must be an image in JPG or PNG format. DetectDocumentText returns the detected text in 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. DetectDocumentText is a synchronous operation. To analyze documents asynchronously, use StartDocumentTextDetection. For more information, see Document Text Detection.

This is the response object from the DetectDocumentText operation.

Gets and sets the property Blocks. An array of Block objects containing the text detected in the document.

Gets and sets the property DocumentMetadata. Metadata about the document. Contains the number of pages that are detected in the document.

The input document, either as bytes or as an S3 object. You pass image bytes to an Amazon Textract API operation by using the Bytes property. For example, you would use the Bytes property to pass a document loaded from a local file system. Image bytes passed by using the Bytes property must be base64 encoded. Your code might not need to encode document file bytes if you're using an AWS SDK to call Amazon Textract API operations. You pass images stored in an S3 bucket to an Amazon Textract API operation by using the S3Object property. Documents stored in an S3 bucket don't need to be base64 encoded. The AWS Region for the S3 bucket that contains the S3 object must match the AWS Region that you use for Amazon Textract operations. If you use the AWS CLI to call Amazon Textract operations, passing image bytes using the Bytes property isn't supported. You must first upload the document to an Amazon S3 bucket, and then call the operation using the S3Object property. For Amazon Textract to process an S3 object, the user must have permission to access the S3 object.

Gets and sets the property Bytes. A blob of base-64 encoded documents bytes. The maximum size of a document that's provided in a blob of bytes is 5 MB. The document bytes must be in PNG or JPG format. If you are using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes field.

Gets and sets the property S3Object. Identifies an S3 object as the document source. The maximum size of a document stored in an S3 bucket is 5 MB.

The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous operations such as StartDocumentTextDetection. The input document can be an image file in JPG or PNG format. It can also be a file in PDF format.

Gets and sets the property S3Object. The Amazon S3 bucket that contains the input document.

Information about the input document.

Gets and sets the property Pages. The number of pages detected in the document.

Textract exception

Constructs a new DocumentTooLargeException with the specified error message.

Describes the error encountered.

Construct instance of DocumentTooLargeException

Constructs a new instance of the DocumentTooLargeException class with serialized data.

Information about where a recognized text, key, value, table, or table cell is located on a document page.

Gets and sets the property BoundingBox. An axis-aligned coarse representation of the location of the recognized text on the document page.

Gets and sets the property Polygon. Within the bounding box, a fine-grained polygon around the recognized text.

Container for the parameters to the GetDocumentAnalysis operation. 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:

Words and lines that are related to nearby lines and words. 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.
Selectable elements such as checkboxes and radio buttons. A SELECTION_ELEMENT Block object contains information about a selectable element.
Lines and words of text. A LINE Block object contains one or more WORD Block objects.

Use the MaxResults parameter to limit the number of blocks 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.

Gets and sets the property JobId. A unique identifier for the text-detection job. The JobId is returned from StartDocumentAnalysis.

Gets and sets the property MaxResults. The maximum number of results to return per paginated call. The largest value that you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.

Gets and sets the property NextToken. If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.

This is the response object from the GetDocumentAnalysis operation.

Gets and sets the property Blocks. The results of the text analysis operation.

Gets and sets the property DocumentMetadata. Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.

Gets and sets the property JobStatus. The current status of the text detection job.

Gets and sets the property NextToken. If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text detection results.

Gets and sets the property StatusMessage. The current status of an asynchronous document analysis operation.

Gets and sets the property Warnings. A list of warnings that occurred during the document analysis operation.

Container for the parameters to the GetDocumentTextDetection operation. 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.

Gets and sets the property JobId. A unique identifier for the text detection job. The JobId is returned from StartDocumentTextDetection.

Gets and sets the property MaxResults. The maximum number of results to return per paginated call. The largest value you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.

This is the response object from the GetDocumentTextDetection operation.

Gets and sets the property Blocks. The results of the text-detection operation.

Gets and sets the property JobStatus. The current status of the text detection job.

Gets and sets the property StatusMessage. The current status of an asynchronous document text-detection operation.

Gets and sets the property Warnings. A list of warnings that occurred during the document text-detection operation.

Textract exception

Constructs a new IdempotentParameterMismatchException with the specified error message.

Describes the error encountered.

Construct instance of IdempotentParameterMismatchException

Constructs a new instance of the IdempotentParameterMismatchException class with serialized data.

Textract exception

Constructs a new InternalServerErrorException with the specified error message.

Describes the error encountered.

Construct instance of InternalServerErrorException

Constructs a new instance of the InternalServerErrorException class with serialized data.

AnalyzeDocument Request Marshaller

Marshaller the request object to the HTTP request.

Gets the singleton.

Response Unmarshaller for AnalyzeDocument operation

Unmarshaller the response from the service to the response class.

Unmarshaller error response to exception.

Gets the singleton.

Response Unmarshaller for Block Object

Unmarshaller the response from the service to the response class.

Gets the singleton.

Response Unmarshaller for BoundingBox Object

Unmarshaller the response from the service to the response class.

Gets the singleton.

DetectDocumentText Request Marshaller

Marshaller the request object to the HTTP request.

Gets the singleton.

Response Unmarshaller for DetectDocumentText operation

Unmarshaller the response from the service to the response class.

Unmarshaller error response to exception.

Gets the singleton.

DocumentLocation Marshaller

Unmarshaller the response from the service to the response class.

Singleton Marshaller.

Document Marshaller

Unmarshaller the response from the service to the response class.

Singleton Marshaller.

Response Unmarshaller for DocumentMetadata Object

Unmarshaller the response from the service to the response class.

Gets the singleton.

Response Unmarshaller for Geometry Object

Unmarshaller the response from the service to the response class.

Gets the singleton.

GetDocumentAnalysis Request Marshaller

Marshaller the request object to the HTTP request.

Gets the singleton.

Response Unmarshaller for GetDocumentAnalysis operation

Unmarshaller the response from the service to the response class.

Unmarshaller error response to exception.

Gets the singleton.

GetDocumentTextDetection Request Marshaller

Marshaller the request object to the HTTP request.

Gets the singleton.

Response Unmarshaller for GetDocumentTextDetection operation

Unmarshaller the response from the service to the response class.

Unmarshaller error response to exception.

Gets the singleton.

NotificationChannel Marshaller

Unmarshaller the response from the service to the response class.

Singleton Marshaller.

Response Unmarshaller for Point Object

Unmarshaller the response from the service to the response class.

Gets the singleton.

Response Unmarshaller for Relationship Object

Unmarshaller the response from the service to the response class.

Gets the singleton.

S3Object Marshaller

Unmarshaller the response from the service to the response class.

Singleton Marshaller.

StartDocumentAnalysis Request Marshaller

Marshaller the request object to the HTTP request.

Gets the singleton.

Response Unmarshaller for StartDocumentAnalysis operation

Unmarshaller the response from the service to the response class.

Unmarshaller error response to exception.

Gets the singleton.

StartDocumentTextDetection Request Marshaller

Marshaller the request object to the HTTP request.

Gets the singleton.

Response Unmarshaller for StartDocumentTextDetection operation

Unmarshaller the response from the service to the response class.

Unmarshaller error response to exception.

Gets the singleton.

Response Unmarshaller for Warning Object

Unmarshaller the response from the service to the response class.

Gets the singleton.

Textract exception

Constructs a new InvalidJobIdException with the specified error message.

Describes the error encountered.

Construct instance of InvalidJobIdException

Constructs a new instance of the InvalidJobIdException class with serialized data.

Textract exception

Constructs a new InvalidParameterException with the specified error message.

Describes the error encountered.

Construct instance of InvalidParameterException

Constructs a new instance of the InvalidParameterException class with serialized data.

Textract exception

Constructs a new InvalidS3ObjectException with the specified error message.

Describes the error encountered.

Construct instance of InvalidS3ObjectException

Constructs a new instance of the InvalidS3ObjectException class with serialized data.

Textract exception

Constructs a new LimitExceededException with the specified error message.

Describes the error encountered.

Construct instance of LimitExceededException

Constructs a new instance of the LimitExceededException class with serialized data.

The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of an asynchronous document operation, such as StartDocumentTextDetection.

Gets and sets the property RoleArn. The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.

Gets and sets the property SNSTopicArn. The Amazon SNS topic that Amazon Textract posts the completion status to.

The X and Y coordinates of a point on a document page. The X and Y values returned are ratios of the overall document page size. For example, if the input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the document page. An array of Point objects, Polygon, is returned by DetectDocumentText. Polygon represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Textract Developer Guide.

Gets and sets the property X. The value of the X coordinate for a point on a Polygon.

Gets and sets the property Y. The value of the Y coordinate for a point on a Polygon.

Textract exception

Constructs a new ProvisionedThroughputExceededException with the specified error message.

Describes the error encountered.

Construct instance of ProvisionedThroughputExceededException

Constructs a new instance of the ProvisionedThroughputExceededException class with serialized data.

Information about how blocks are related to each other. A Block object contains 0 or more Relation objects in a list, Relationships. For more information, see Block. The Type element provides the type of the relationship for all blocks in the IDs array.

Gets and sets the property Ids. An array of IDs for related blocks. You can get the type of the relationship from the Type element.

Gets and sets the property Type. The type of relationship that the blocks in the IDs array have with the current block. The relationship can be VALUE or CHILD.

The S3 bucket name and file name that identifies the document. The AWS Region for the S3 bucket that contains the document must match the Region that you use for Amazon Textract operations. For Amazon Textract to process a file in an S3 bucket, the user must have permission to access the S3 bucket and file.

Gets and sets the property Bucket. The name of the S3 bucket.

Gets and sets the property Name. The file name of the input document. It must be an image file (.JPG or .PNG format). Asynchronous operations also support PDF files.

Gets and sets the property Version. If the bucket has versioning enabled, you can specify the object version.

Container for the parameters to the StartDocumentAnalysis operation. Starts asynchronous analysis of an input document for relationships between detected items such as key and value pairs, tables, and selection elements. StartDocumentAnalysis can analyze text in documents that are in JPG, PNG, 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.

Gets and sets the property ClientRequestToken. 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.

Gets and sets the property DocumentLocation. The location of the document to be processed.

Gets and sets the property FeatureTypes. 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 fields and the associated text. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All selectable elements (SELECTION_ELEMENT) that are detected are returned, whatever the value of FeatureTypes.

Gets and sets the property JobTag. An identifier you specify that's included in the completion notification that's published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document, such as a tax form or a receipt, that the completion notification corresponds to.

Gets and sets the property NotificationChannel. The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

This is the response object from the StartDocumentAnalysis operation.

Gets and sets the property JobId. The identifier for the document text detection job. Use JobId to identify the job in a subsequent call to GetDocumentAnalysis.

Container for the parameters to the StartDocumentTextDetection operation. 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 JPG, PNG, 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.

Gets and sets the property ClientRequestToken. The idempotent token that's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once.

Gets and sets the property DocumentLocation. The location of the document to be processed.

Gets and sets the property NotificationChannel. The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

This is the response object from the StartDocumentTextDetection operation.

Gets and sets the property JobId. The identifier for the document text-detection job. Use JobId to identify the job in a subsequent call to GetDocumentTextDetection.

Textract exception

Constructs a new ThrottlingException with the specified error message.

Describes the error encountered.

Construct instance of ThrottlingException

Constructs a new instance of the ThrottlingException class with serialized data.

Textract exception

Constructs a new UnsupportedDocumentException with the specified error message.

Describes the error encountered.

Construct instance of UnsupportedDocumentException

Constructs a new instance of the UnsupportedDocumentException class with serialized data.

A warning about an issue that occurred during asynchronous text analysis (StartDocumentAnalysis) or asynchronous document-text detection (StartDocumentTextDetection).

Gets and sets the property ErrorCode. The error code for the warning.

Gets and sets the property Pages. A list of the pages that the warning applies to.

Base class for Textract operation requests.

Constants used for properties of type BlockType.

Constant CELL for BlockType

Constant KEY_VALUE_SET for BlockType

Constant LINE for BlockType

Constant PAGE for BlockType

Constant SELECTION_ELEMENT for BlockType

Constant TABLE for BlockType

Constant WORD for BlockType

This constant constructor does not need to be called if the constant you are attempting to use is already defined as a static instance of this class. This constructor should be used to construct constants that are not defined as statics, for instance if attempting to use a feature that is newer than the current version of the SDK.

Finds the constant for the unique value.

The unique value for the constant The constant for the unique value

Utility method to convert strings to the constant class.

The string value to convert to the constant class.

Constants used for properties of type EntityType.

Constant KEY for EntityType

Constant VALUE for EntityType

Finds the constant for the unique value.

The unique value for the constant The constant for the unique value

Utility method to convert strings to the constant class.

The string value to convert to the constant class.

Constants used for properties of type FeatureType.

Constant FORMS for FeatureType

Constant TABLES for FeatureType

Finds the constant for the unique value.

The unique value for the constant The constant for the unique value

Utility method to convert strings to the constant class.

The string value to convert to the constant class.

Constants used for properties of type JobStatus.

Constant FAILED for JobStatus

Constant IN_PROGRESS for JobStatus

Constant PARTIAL_SUCCESS for JobStatus

Constant SUCCEEDED for JobStatus

Finds the constant for the unique value.

The unique value for the constant The constant for the unique value

Utility method to convert strings to the constant class.

The string value to convert to the constant class.

Constants used for properties of type RelationshipType.

Constant CHILD for RelationshipType

Constant VALUE for RelationshipType

Finds the constant for the unique value.

The unique value for the constant The constant for the unique value

Utility method to convert strings to the constant class.

The string value to convert to the constant class.

Constants used for properties of type SelectionStatus.

Constant NOT_SELECTED for SelectionStatus

Constant SELECTED for SelectionStatus

Finds the constant for the unique value.

The unique value for the constant The constant for the unique value

Utility method to convert strings to the constant class.

The string value to convert to the constant class.

Implementation for accessing Textract Amazon Textract detects and analyzes text in documents and converts it into machine-readable text. This is the API reference documentation for Amazon Textract.

Constructs AmazonTextractClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.


             <?xml version="1.0" encoding="utf-8" ?>
             <configuration>
                 <appSettings>
                     <add key="AWSProfileName" value="AWS Default"/>
                 </appSettings>
             </configuration>


             <?xml version="1.0" encoding="utf-8" ?>
             <configuration>
                 <appSettings>
                     <add key="AWSProfileName" value="AWS Default"/>
                 </appSettings>
             </configuration>

The region to connect.


             <?xml version="1.0" encoding="utf-8" ?>
             <configuration>
                 <appSettings>
                     <add key="AWSProfileName" value="AWS Default"/>
                 </appSettings>
             </configuration>

The AmazonTextractClient Configuration Object

Constructs AmazonTextractClient with AWS Credentials

AWS Credentials

Constructs AmazonTextractClient with AWS Credentials

AWS Credentials The region to connect.

Constructs AmazonTextractClient with AWS Credentials and an AmazonTextractClient Configuration object.

AWS Credentials The AmazonTextractClient Configuration Object

Constructs AmazonTextractClient with AWS Access Key ID and AWS Secret Key

AWS Access Key ID AWS Secret Access Key

Constructs AmazonTextractClient with AWS Access Key ID and AWS Secret Key

AWS Access Key ID AWS Secret Access Key The region to connect.

Constructs AmazonTextractClient with AWS Access Key ID, AWS Secret Key and an AmazonTextractClient Configuration object.

AWS Access Key ID AWS Secret Access Key The AmazonTextractClient Configuration Object

Constructs AmazonTextractClient with AWS Access Key ID and AWS Secret Key

AWS Access Key ID AWS Secret Access Key AWS Session Token

Constructs AmazonTextractClient with AWS Access Key ID and AWS Secret Key

AWS Access Key ID AWS Secret Access Key AWS Session Token The region to connect.

Constructs AmazonTextractClient with AWS Access Key ID, AWS Secret Key and an AmazonTextractClient Configuration object.

AWS Access Key ID AWS Secret Access Key AWS Session Token The AmazonTextractClient Configuration Object

Creates the signer for the service.

Capture metadata for the service.

Disposes the service client.

Analyzes an input document for relationships between detected items. The types of information returned are as follows:

Words and lines that are related to nearby lines and words. 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.
Selectable elements such as checkboxes and radio buttons. A SELECTION_ELEMENT Block object contains information about a selectable element.
Lines and words of text. A LINE Block object contains one or more WORD Block objects.

Container for the necessary parameters to execute the AnalyzeDocument service method. The response from the AnalyzeDocument service method, as returned by Textract. You aren't authorized to perform the action. Amazon Textract isn't able to read the document. The document can't be processed because it's too large. The maximum document size for synchronous operations 5 MB. The maximum document size for asynchronous operations is 500 MB for PDF format files. Amazon Textract experienced a service issue. Try your call again. 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. Amazon Textract is unable to access the S3 object that's specified in the request. The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. Amazon Textract is temporarily unable to process the request. Try your call again. The format of the input document isn't supported. Amazon Textract supports documents that are .png or .jpg format. REST API Reference for AnalyzeDocument Operation

Initiates the asynchronous execution of the AnalyzeDocument operation.

Container for the necessary parameters to execute the AnalyzeDocument operation. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The task object representing the asynchronous operation. REST API Reference for AnalyzeDocument Operation

Detects text in the input document. Amazon Textract can detect lines of text and the words that make up a line of text. The input document must be an image in JPG or PNG format. DetectDocumentText returns the detected text in 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. DetectDocumentText is a synchronous operation. To analyze documents asynchronously, use StartDocumentTextDetection. For more information, see Document Text Detection.

Container for the necessary parameters to execute the DetectDocumentText service method. The response from the DetectDocumentText service method, as returned by Textract. You aren't authorized to perform the action. Amazon Textract isn't able to read the document. The document can't be processed because it's too large. The maximum document size for synchronous operations 5 MB. The maximum document size for asynchronous operations is 500 MB for PDF format files. Amazon Textract experienced a service issue. Try your call again. 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. Amazon Textract is unable to access the S3 object that's specified in the request. The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. Amazon Textract is temporarily unable to process the request. Try your call again. The format of the input document isn't supported. Amazon Textract supports documents that are .png or .jpg format. REST API Reference for DetectDocumentText Operation

Initiates the asynchronous execution of the DetectDocumentText operation.

Container for the necessary parameters to execute the DetectDocumentText operation. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The task object representing the asynchronous operation. REST API Reference for DetectDocumentText Operation

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:

Words and lines that are related to nearby lines and words. 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.
Selectable elements such as checkboxes and radio buttons. A SELECTION_ELEMENT Block object contains information about a selectable element.
Lines and words of text. A LINE Block object contains one or more WORD Block objects.

Container for the necessary parameters to execute the GetDocumentAnalysis service method. The response from the GetDocumentAnalysis service method, as returned by Textract. You aren't authorized to perform the action. Amazon Textract experienced a service issue. Try your call again. An invalid job identifier was passed to GetDocumentAnalysis or to GetDocumentAnalysis. 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. The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. Amazon Textract is temporarily unable to process the request. Try your call again. REST API Reference for GetDocumentAnalysis Operation

Initiates the asynchronous execution of the GetDocumentAnalysis operation.

Container for the necessary parameters to execute the GetDocumentAnalysis operation. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The task object representing the asynchronous operation. REST API Reference for GetDocumentAnalysis Operation

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.

Container for the necessary parameters to execute the GetDocumentTextDetection service method. The response from the GetDocumentTextDetection service method, as returned by Textract. You aren't authorized to perform the action. Amazon Textract experienced a service issue. Try your call again. An invalid job identifier was passed to GetDocumentAnalysis or to GetDocumentAnalysis. 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. The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. Amazon Textract is temporarily unable to process the request. Try your call again. REST API Reference for GetDocumentTextDetection Operation

Initiates the asynchronous execution of the GetDocumentTextDetection operation.

Container for the necessary parameters to execute the GetDocumentTextDetection operation. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The task object representing the asynchronous operation. REST API Reference for GetDocumentTextDetection Operation

Starts asynchronous analysis of an input document for relationships between detected items such as key and value pairs, tables, and selection elements. StartDocumentAnalysis can analyze text in documents that are in JPG, PNG, 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.

Container for the necessary parameters to execute the StartDocumentAnalysis service method. The response from the StartDocumentAnalysis service method, as returned by Textract. You aren't authorized to perform the action. Amazon Textract isn't able to read the document. The document can't be processed because it's too large. The maximum document size for synchronous operations 5 MB. The maximum document size for asynchronous operations is 500 MB for PDF format files. 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. Amazon Textract experienced a service issue. Try your call again. 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. Amazon Textract is unable to access the S3 object that's specified in the request. 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. The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. Amazon Textract is temporarily unable to process the request. Try your call again. The format of the input document isn't supported. Amazon Textract supports documents that are .png or .jpg format. REST API Reference for StartDocumentAnalysis Operation

Initiates the asynchronous execution of the StartDocumentAnalysis operation.

Container for the necessary parameters to execute the StartDocumentAnalysis operation. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The task object representing the asynchronous operation. REST API Reference for StartDocumentAnalysis Operation

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 JPG, PNG, 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.

Container for the necessary parameters to execute the StartDocumentTextDetection service method. The response from the StartDocumentTextDetection service method, as returned by Textract. You aren't authorized to perform the action. Amazon Textract isn't able to read the document. The document can't be processed because it's too large. The maximum document size for synchronous operations 5 MB. The maximum document size for asynchronous operations is 500 MB for PDF format files. 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. Amazon Textract experienced a service issue. Try your call again. 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. Amazon Textract is unable to access the S3 object that's specified in the request. 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. The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. Amazon Textract is temporarily unable to process the request. Try your call again. The format of the input document isn't supported. Amazon Textract supports documents that are .png or .jpg format. REST API Reference for StartDocumentTextDetection Operation

Initiates the asynchronous execution of the StartDocumentTextDetection operation.

Container for the necessary parameters to execute the StartDocumentTextDetection operation. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The task object representing the asynchronous operation. REST API Reference for StartDocumentTextDetection Operation

Interface for accessing Textract Amazon Textract detects and analyzes text in documents and converts it into machine-readable text. This is the API reference documentation for Amazon Textract.

Analyzes an input document for relationships between detected items. The types of information returned are as follows:

Words and lines that are related to nearby lines and words. 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.
Selectable elements such as checkboxes and radio buttons. A SELECTION_ELEMENT Block object contains information about a selectable element.
Lines and words of text. A LINE Block object contains one or more WORD Block objects.

Initiates the asynchronous execution of the AnalyzeDocument operation.

Initiates the asynchronous execution of the DetectDocumentText operation.

Words and lines that are related to nearby lines and words. 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.
Selectable elements such as checkboxes and radio buttons. A SELECTION_ELEMENT Block object contains information about a selectable element.
Lines and words of text. A LINE Block object contains one or more WORD Block objects.

Initiates the asynchronous execution of the GetDocumentAnalysis operation.

Initiates the asynchronous execution of the GetDocumentTextDetection operation.

Initiates the asynchronous execution of the StartDocumentAnalysis operation.

Initiates the asynchronous execution of the StartDocumentTextDetection operation.