Package-level declarations
Types
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.
Contains information on the adapter, including the adapter ID, Name, Creation time, and feature types.
Contains information about adapters used when analyzing a document, with each adapter specified using an AdapterId and version
The dataset configuration options for a given version of an adapter. Can include an Amazon S3 bucket if specified.
Contains information on the metrics used to evalute the peformance of a given adapter version. Includes data for baseline model performance and individual adapter version perfromance.
Summary info for an adapter version. Contains information on the AdapterId, AdapterVersion, CreationTime, FeatureTypes, and Status.
Used to contain the information detected by an AnalyzeID operation.
Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.
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.
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).
Updating or deleting a resource can cause an inconsistent state.
A structure that holds information regarding a detected signature on a page.
Summary information about documents grouped by the same document type.
The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous operations.
Information about the input document.
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.
The evaluation metrics (F1 score, Precision, and Recall) for an adapter version.
Returns the kind of currency detected.
An object used to store information about the Value or Label detected by Amazon Textract.
The structure holding all the information returned by AnalyzeExpense
Breakdown of detected information, seperated into the catagories Type, LabelDetection, and ValueDetection
Shows the group that a certain key belongs to. This helps differentiate between names and addresses for different organizations, that can be hard to determine via JSON response.
An object used to store information about the Type detected by Amazon Textract.
Contains information extracted by an analysis operation after using StartLendingAnalysis.
Shows the results of the human in the loop evaluation. If there is no HumanLoopArn, the input did not trigger human review.
Sets up the human review workflow the document will be sent to if one of the conditions is met. You can also set certain attributes of the image before review.
Allows you to set attributes of the image. Currently, you can declare an image as free of personally identifiable information and adult content.
Indicates you have exceeded the maximum number of active human in the loop workflows available
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.
The structure that lists each document processed in an AnalyzeID operation.
Structure containing both the normalized type of the extracted information and the text associated with it. These are extracted as Type and Value respectively.
Amazon Textract experienced a service issue. Try your call again.
An invalid job identifier was passed to an asynchronous analysis operation.
Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.
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. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3
The results extracted for a lending document.
Holds the structured data returned by AnalyzeDocument for lending documents.
Holds the normalized key-value pairs returned by AnalyzeDocument, including the document type, detected text, and geometry.
Contains the detections for each page analyzed through the Analyze Lending API.
Contains information regarding DocumentGroups and UndetectedDocumentTypes.
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 structure that holds information about the different lines found in a document's tables.
A grouping of tables which contain LineItems, with each table identified by the table's LineItemGroupIndex.
Contains information relating to dates in a document, including the type of value, and the value.
The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of an asynchronous document operation.
Sets whether or not your output will go to a user created bucket. Used to set the name of the bucket, and the prefix on the output file.
The class assigned to a Page object detected in an input document. Contains information regarding the predicted type/class of a document's page and the page number that the Page object was detected on.
The X and Y coordinates of a point on a document page. The X and Y values that are 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.
Contains information regarding predicted values returned by Amazon Textract operations, including the predicted value and the confidence in the predicted value.
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.
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.
Returned when an operation tried to access a nonexistent resource.
Returned when a request cannot be completed as it would exceed a maximum service quota.
Information regarding a detected signature on a page.
Contains information about the pages of a document, defined by logical boundary.
Base class for all service related exceptions thrown by the Textract client
Amazon Textract is temporarily unable to process the request. Try your call again.
A structure containing information about an undetected signature on a page where it was expected but not found.
The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.
Indicates that a request was not valid. Check request for proper formatting.