aws textract25 CLI commands available for Amazon Textract.
| Command | API Operation | Sample |
|---|---|---|
analyze-documentAnalyzes an input document for relationships between detected items. The types of information returned are as follows: Form data (key-value pairs). 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 | AnalyzeDocument | |
analyze-expenseAnalyzeExpense synchronously analyzes an input document for financially related relationships between text. Information is returned as ExpenseDocuments and seperated as follows: LineItemGroups- A data set containing LineItems which store information about the lines of text, such as an item purch | AnalyzeExpense | |
analyze-idAnalyzes identity documents for relevant information. This information is extracted and returned as IdentityDocumentFields, which records both the normalized field and value of the extracted text. Unlike other Amazon Textract operations, AnalyzeID doesn't return any Geometry data. | AnalyzeID | |
create-adapterCreates an adapter, which can be fine-tuned for enhanced performance on user provided documents. Takes an AdapterName and FeatureType. Currently the only supported feature type is QUERIES. You can also provide a Description, Tags, and a ClientRequestToken. You can choose whether or not the adapter s | CreateAdapter | |
create-adapter-versionCreates a new version of an adapter. Operates on a provided AdapterId and a specified dataset provided via the DatasetConfig argument. Requires that you specify an Amazon S3 bucket with the OutputConfig argument. You can provide an optional KMSKeyId, an optional ClientRequestToken, and optional tags | CreateAdapterVersion | |
delete-adapterDeletes an Amazon Textract adapter. Takes an AdapterId and deletes the adapter specified by the ID. | DeleteAdapter | |
delete-adapter-versionDeletes an Amazon Textract adapter version. Requires that you specify both an AdapterId and a AdapterVersion. Deletes the adapter version specified by the AdapterId and the AdapterVersion. | DeleteAdapterVersion | |
detect-document-textDetects 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 in one of the following image formats: JPEG, PNG, PDF, or TIFF. DetectDocumentText returns the detected text in an array of Block objects. Each document | DetectDocumentText | |
get-adapterGets configuration information for an adapter specified by an AdapterId, returning information on AdapterName, Description, CreationTime, AutoUpdate status, and FeatureTypes. | GetAdapter | |
get-adapter-versionGets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and EvaluationMetrics. | GetAdapterVersion | |
get-document-analysisGets 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 | GetDocumentAnalysis | |
get-document-text-detectionGets 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). Whe | GetDocumentTextDetection | |
get-expense-analysisGets the results for an Amazon Textract asynchronous operation that analyzes invoices and receipts. Amazon Textract finds contact information, items purchased, and vendor name, from input invoices and receipts. You start asynchronous invoice/receipt analysis by calling StartExpenseAnalysis, which re | GetExpenseAnalysis | |
get-lending-analysisGets the results for an Amazon Textract asynchronous operation that analyzes text in a lending document. You start asynchronous text analysis by calling StartLendingAnalysis, which returns a job identifier (JobId). When the text analysis operation finishes, Amazon Textract publishes a completion st | GetLendingAnalysis | |
get-lending-analysis-summaryGets summarized results for the StartLendingAnalysis operation, which analyzes text in a lending document. The returned summary consists of information about documents grouped together by a common document type. Information like detected signatures, page numbers, and split documents is returned with | GetLendingAnalysisSummary | |
list-adapter-versionsList all version of an adapter that meet the specified filtration criteria. | ListAdapterVersions | |
list-adaptersLists all adapters that match the specified filtration criteria. | ListAdapters | |
list-tags-for-resourceLists all tags for an Amazon Textract resource. | ListTagsForResource | |
start-document-analysisStarts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements. StartDocumentAnalysis can analyze text in documents that are in JPEG, PNG, TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. U | StartDocumentAnalysis | |
start-document-text-detectionStarts 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 JPEG, PNG, TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. Use Doc | StartDocumentTextDetection | |
start-expense-analysisStarts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names. StartExpenseAnalysis can analyze text in documents that are in JPEG, PNG, and PDF format. The documents must be stored in an Amazon S3 bucket. Use the DocumentLocation para | StartExpenseAnalysis | |
start-lending-analysisStarts the classification and analysis of an input document. StartLendingAnalysis initiates the classification and analysis of a packet of lending documents. StartLendingAnalysis operates on a document file located in an Amazon S3 bucket. StartLendingAnalysis can analyze text in documents that are | StartLendingAnalysis | |
tag-resourceAdds one or more tags to the specified resource. | TagResource | |
untag-resourceRemoves any tags with the specified keys from the specified resource. | UntagResource | |
update-adapterUpdate the configuration for an adapter. FeatureTypes configurations cannot be updated. At least one new parameter must be specified as an argument. | UpdateAdapter |
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterOur bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterTextract