| Class | Description |
|---|---|
| Adapter |
An adapter selected for use when analyzing documents.
|
| AdapterOverview |
Contains information on the adapter, including the adapter ID, Name, Creation time, and feature types.
|
| AdaptersConfig |
Contains information about adapters used when analyzing a document, with each adapter specified using an AdapterId
and version
|
| AdapterVersionDatasetConfig |
The dataset configuration options for a given version of an adapter.
|
| AdapterVersionEvaluationMetric |
Contains information on the metrics used to evalute the peformance of a given adapter version.
|
| AdapterVersionOverview |
Summary info for an adapter version.
|
| AnalyzeDocumentRequest | |
| AnalyzeDocumentResult | |
| AnalyzeExpenseRequest | |
| AnalyzeExpenseResult | |
| AnalyzeIDDetections |
Used to contain the information detected by an AnalyzeID operation.
|
| AnalyzeIDRequest | |
| AnalyzeIDResult | |
| Block |
A
Block represents items that are recognized in a document within a group of pixels close to each other. |
| BoundingBox |
The bounding box around the detected page, text, key-value pair, table, table cell, or selection element on a
document page.
|
| CreateAdapterRequest | |
| CreateAdapterResult | |
| CreateAdapterVersionRequest | |
| CreateAdapterVersionResult | |
| DeleteAdapterRequest | |
| DeleteAdapterResult | |
| DeleteAdapterVersionRequest | |
| DeleteAdapterVersionResult | |
| DetectDocumentTextRequest | |
| DetectDocumentTextResult | |
| DetectedSignature |
A structure that holds information regarding a detected signature on a page.
|
| Document |
The input document, either as bytes or as an S3 object.
|
| DocumentGroup |
Summary information about documents grouped by the same document type.
|
| DocumentLocation |
The Amazon S3 bucket that contains the document to be processed.
|
| DocumentMetadata |
Information about the input document.
|
| EvaluationMetric |
The evaluation metrics (F1 score, Precision, and Recall) for an adapter version.
|
| ExpenseCurrency |
Returns the kind of currency detected.
|
| ExpenseDetection |
An object used to store information about the Value or Label detected by Amazon Textract.
|
| ExpenseDocument |
The structure holding all the information returned by AnalyzeExpense
|
| ExpenseField |
Breakdown of detected information, seperated into the catagories Type, LabelDetection, and ValueDetection
|
| ExpenseGroupProperty |
Shows the group that a certain key belongs to.
|
| ExpenseType |
An object used to store information about the Type detected by Amazon Textract.
|
| Extraction |
Contains information extracted by an analysis operation after using StartLendingAnalysis.
|
| Geometry |
Information about where the following items are located on a document page: detected page, text, key-value pairs,
tables, table cells, and selection elements.
|
| GetAdapterRequest | |
| GetAdapterResult | |
| GetAdapterVersionRequest | |
| GetAdapterVersionResult | |
| GetDocumentAnalysisRequest | |
| GetDocumentAnalysisResult | |
| GetDocumentTextDetectionRequest | |
| GetDocumentTextDetectionResult | |
| GetExpenseAnalysisRequest | |
| GetExpenseAnalysisResult | |
| GetLendingAnalysisRequest | |
| GetLendingAnalysisResult | |
| GetLendingAnalysisSummaryRequest | |
| GetLendingAnalysisSummaryResult | |
| HumanLoopActivationOutput |
Shows the results of the human in the loop evaluation.
|
| HumanLoopConfig |
Sets up the human review workflow the document will be sent to if one of the conditions is met.
|
| HumanLoopDataAttributes |
Allows you to set attributes of the image.
|
| IdentityDocument |
The structure that lists each document processed in an AnalyzeID operation.
|
| IdentityDocumentField |
Structure containing both the normalized type of the extracted information and the text associated with it.
|
| LendingDetection |
The results extracted for a lending document.
|
| LendingDocument |
Holds the structured data returned by AnalyzeDocument for lending documents.
|
| LendingField |
Holds the normalized key-value pairs returned by AnalyzeDocument, including the document type, detected text, and
geometry.
|
| LendingResult |
Contains the detections for each page analyzed through the Analyze Lending API.
|
| LendingSummary |
Contains information regarding DocumentGroups and UndetectedDocumentTypes.
|
| LineItemFields |
A structure that holds information about the different lines found in a document's tables.
|
| LineItemGroup |
A grouping of tables which contain LineItems, with each table identified by the table's
LineItemGroupIndex. |
| ListAdaptersRequest | |
| ListAdaptersResult | |
| ListAdapterVersionsRequest | |
| ListAdapterVersionsResult | |
| ListTagsForResourceRequest | |
| ListTagsForResourceResult | |
| NormalizedValue |
Contains information relating to dates in a document, including the type of value, and the value.
|
| NotificationChannel |
The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of
an asynchronous document operation.
|
| OutputConfig |
Sets whether or not your output will go to a user created bucket.
|
| PageClassification |
The class assigned to a Page object detected in an input document.
|
| Point |
The X and Y coordinates of a point on a document page.
|
| Prediction |
Contains information regarding predicted values returned by Amazon Textract operations, including the predicted value
and the confidence in the predicted value.
|
| QueriesConfig |
|
| Query |
Each query contains the question you want to ask in the Text and the alias you want to associate.
|
| Relationship |
Information about how blocks are related to each other.
|
| S3Object |
The S3 bucket name and file name that identifies the document.
|
| SignatureDetection |
Information regarding a detected signature on a page.
|
| SplitDocument |
Contains information about the pages of a document, defined by logical boundary.
|
| StartDocumentAnalysisRequest | |
| StartDocumentAnalysisResult | |
| StartDocumentTextDetectionRequest | |
| StartDocumentTextDetectionResult | |
| StartExpenseAnalysisRequest | |
| StartExpenseAnalysisResult | |
| StartLendingAnalysisRequest | |
| StartLendingAnalysisResult | |
| TagResourceRequest | |
| TagResourceResult | |
| UndetectedSignature |
A structure containing information about an undetected signature on a page where it was expected but not found.
|
| UntagResourceRequest | |
| UntagResourceResult | |
| UpdateAdapterRequest | |
| UpdateAdapterResult | |
| Warning |
A warning about an issue that occurred during asynchronous text analysis (StartDocumentAnalysis) or
asynchronous document text detection (StartDocumentTextDetection).
|
| Enum | Description |
|---|---|
| AdapterVersionStatus | |
| AutoUpdate | |
| BlockType | |
| ContentClassifier | |
| EntityType | |
| FeatureType | |
| JobStatus | |
| RelationshipType | |
| SelectionStatus | |
| TextType | |
| ValueType |
| Exception | Description |
|---|---|
| AccessDeniedException |
You aren't authorized to perform the action.
|
| AmazonTextractException |
Base exception for all service exceptions thrown by Amazon Textract
|
| BadDocumentException |
Amazon Textract isn't able to read the document.
|
| ConflictException |
Updating or deleting a resource can cause an inconsistent state.
|
| DocumentTooLargeException |
The document can't be processed because it's too large.
|
| HumanLoopQuotaExceededException |
Indicates you have exceeded the maximum number of active human in the loop workflows available
|
| IdempotentParameterMismatchException |
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. |
| InternalServerErrorException |
Amazon Textract experienced a service issue.
|
| 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.
|
| InvalidS3ObjectException |
Amazon Textract is unable to access the S3 object that's specified in the request.
|
| LimitExceededException |
An Amazon Textract service limit was exceeded.
|
| ProvisionedThroughputExceededException |
The number of requests exceeded your throughput limit.
|
| ResourceNotFoundException |
Returned when an operation tried to access a nonexistent resource.
|
| ServiceQuotaExceededException |
Returned when a request cannot be completed as it would exceed a maximum service quota.
|
| ThrottlingException |
Amazon Textract is temporarily unable to process the request.
|
| UnsupportedDocumentException |
The format of the input document isn't supported.
|
| ValidationException |
Indicates that a request was not valid.
|