API version 2018-06-27 of the Amazon Textract SDK configuration.

An invalid job identifier was passed to GetDocumentAnalysis or to GetDocumentAnalysis.

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.

Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.

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 format of the input document isn't supported. Documents for synchronous operations can be in PNG or JPEG format. Documents for asynchronous operations can also be in PDF format.

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

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.

Amazon Textract is temporarily unable to process the request. Try your call again.

Amazon Textract experienced a service issue. Try your call again.

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.

Indicates you have exceeded the maximum number of active human in the loop workflows available

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.

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.

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 object depends on the type of operation. In text detection for documents (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.

See: newBlock smart constructor.

Create a value of Block with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:columnSpan:Block', block_columnSpan - The number of columns that a table cell spans. Currently this value is always 1, even if the number of columns spanned is greater than 1. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

$sel:text:Block', block_text - The word or line of text that's recognized by Amazon Textract.

$sel:entityTypes:Block', block_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.

$sel:columnIndex:Block', block_columnIndex - The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.

$sel:page:Block', block_page - The page on which a block was detected. Page is returned by asynchronous operations. Page values greater than 1 are only returned for multipage documents that are in PDF format. A scanned image (JPEG/PNG), even if it contains multiple document pages, is considered to be a single-page document. The value of Page is always 1. Synchronous operations don't return Page because every input document is considered to be a single-page document.

$sel:rowSpan:Block', block_rowSpan - The number of rows that a table cell spans. Currently this value is always 1, even if the number of rows spanned is greater than 1. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

$sel:selectionStatus:Block', block_selectionStatus - The selection status of a selection element, such as an option button or check box.

$sel:rowIndex:Block', block_rowIndex - The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.

$sel:confidence:Block', block_confidence - The confidence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.

$sel:relationships:Block', block_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.

$sel:geometry:Block', block_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.

$sel:textType:Block', block_textType - The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.

$sel:id:Block', block_id - The identifier for the recognized text. The identifier is only unique for a single operation.

$sel:blockType:Block', block_blockType - The type of text item that's recognized. In operations for text detection, 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 are 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 linked text 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 that's 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 are detected on a document page.
• TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one 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 selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.

The number of columns that a table cell spans. Currently this value is always 1, even if the number of columns spanned is greater than 1. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

The word or line of text that's recognized by Amazon Textract.

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.

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

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

The number of rows that a table cell spans. Currently this value is always 1, even if the number of rows spanned is greater than 1. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

The selection status of a selection element, such as an option button or check box.

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

The confidence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.

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.

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.

The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.

The identifier for the recognized text. The identifier is only unique for a single operation.

The type of text item that's recognized. In operations for text detection, 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 are 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 linked text 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 that's 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 are detected on a document page.
• TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one 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 selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.

The bounding box around the detected page, text, key-value pair, table, table cell, or selection element 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.

See: newBoundingBox smart constructor.

Create a value of BoundingBox with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:height:BoundingBox', boundingBox_height - The height of the bounding box as a ratio of the overall document page height.

$sel:left:BoundingBox', boundingBox_left - The left coordinate of the bounding box as a ratio of overall document page width.

$sel:width:BoundingBox', boundingBox_width - The width of the bounding box as a ratio of the overall document page width.

$sel:top:BoundingBox', boundingBox_top - The top coordinate of the bounding box as a ratio of overall document page height.

The height of the bounding box as a ratio of the overall document page height.

The left coordinate of the bounding box as a ratio of overall document page width.

The width of the bounding box as a ratio of the overall document page width.

The top coordinate of the bounding box as a ratio of overall document page height.

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.

See: newDocument smart constructor.