Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . textract ]

get-expense-analysis

Description

Gets 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 returns a job identifier (JobId ). Upon completion of the invoice/receipt analysis, Amazon Textract publishes the completion status to the Amazon Simple Notification Service (Amazon SNS) topic. This topic must be registered in the initial call to StartExpenseAnalysis . To get the results of the invoice/receipt analysis operation, first ensure that the status value published to the Amazon SNS topic is SUCCEEDED . If so, call GetExpenseAnalysis , and pass the job identifier (JobId ) from the initial call to StartExpenseAnalysis .

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 GetExpenseAnalysis , and populate the NextToken request parameter with the token value that's returned from the previous call to GetExpenseAnalysis .

For more information, see Analyzing Invoices and Receipts .

See also: AWS API Documentation

Synopsis

  get-expense-analysis
--job-id <value>
[--max-results <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--job-id (string)

A unique identifier for the text detection job. The JobId is returned from StartExpenseAnalysis . A JobId value is only valid for 7 days.

--max-results (integer)

The maximum number of results to return per paginated call. The largest value you can specify is 20. If you specify a value greater than 20, a maximum of 20 results is returned. The default value is 20.

--next-token (string)

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.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

DocumentMetadata -> (structure)

Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract operation.

Pages -> (integer)

The number of pages that are detected in the document.

JobStatus -> (string)

The current status of the text detection job.

NextToken -> (string)

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.

ExpenseDocuments -> (list)

The expenses detected by Amazon Textract.

(structure)

The structure holding all the information returned by AnalyzeExpense

ExpenseIndex -> (integer)

Denotes which invoice or receipt in the document the information is coming from. First document will be 1, the second 2, and so on.

SummaryFields -> (list)

Any information found outside of a table by Amazon Textract.

(structure)

Breakdown of detected information, seperated into the catagories Type, LabelDetection, and ValueDetection

Type -> (structure)

The implied label of a detected element. Present alongside LabelDetection for explicit elements.

Text -> (string)

The word or line of text detected by Amazon Textract.

Confidence -> (float)

The confidence of accuracy, as a percentage.

LabelDetection -> (structure)

The explicitly stated label of a detected element.

Text -> (string)

The word or line of text recognized by Amazon Textract

Geometry -> (structure)

Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.

BoundingBox -> (structure)

An axis-aligned coarse representation of the location of the recognized item on the document page.

Width -> (float)

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

Height -> (float)

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

Left -> (float)

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

Top -> (float)

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

Polygon -> (list)

Within the bounding box, a fine-grained polygon around the recognized item.

(structure)

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.

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.

X -> (float)

The value of the X coordinate for a point on a Polygon .

Y -> (float)

The value of the Y coordinate for a point on a Polygon .

Confidence -> (float)

The confidence in detection, as a percentage

ValueDetection -> (structure)

The value of a detected element. Present in explicit and implicit elements.

Text -> (string)

The word or line of text recognized by Amazon Textract

Geometry -> (structure)

Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.

BoundingBox -> (structure)

An axis-aligned coarse representation of the location of the recognized item on the document page.

Width -> (float)

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

Height -> (float)

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

Left -> (float)

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

Top -> (float)

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

Polygon -> (list)

Within the bounding box, a fine-grained polygon around the recognized item.

(structure)

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.

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.

X -> (float)

The value of the X coordinate for a point on a Polygon .

Y -> (float)

The value of the Y coordinate for a point on a Polygon .

Confidence -> (float)

The confidence in detection, as a percentage

PageNumber -> (integer)

The page number the value was detected on.

LineItemGroups -> (list)

Information detected on each table of a document, seperated into LineItems .

(structure)

A grouping of tables which contain LineItems, with each table identified by the table's LineItemGroupIndex .

LineItemGroupIndex -> (integer)

The number used to identify a specific table in a document. The first table encountered will have a LineItemGroupIndex of 1, the second 2, etc.

LineItems -> (list)

The breakdown of information on a particular line of a table.

(structure)

A structure that holds information about the different lines found in a document's tables.

LineItemExpenseFields -> (list)

ExpenseFields used to show information from detected lines on a table.

(structure)

Breakdown of detected information, seperated into the catagories Type, LabelDetection, and ValueDetection

Type -> (structure)

The implied label of a detected element. Present alongside LabelDetection for explicit elements.

Text -> (string)

The word or line of text detected by Amazon Textract.

Confidence -> (float)

The confidence of accuracy, as a percentage.

LabelDetection -> (structure)

The explicitly stated label of a detected element.

Text -> (string)

The word or line of text recognized by Amazon Textract

Geometry -> (structure)

Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.

BoundingBox -> (structure)

An axis-aligned coarse representation of the location of the recognized item on the document page.

Width -> (float)

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

Height -> (float)

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

Left -> (float)

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

Top -> (float)

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

Polygon -> (list)

Within the bounding box, a fine-grained polygon around the recognized item.

(structure)

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.

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.

X -> (float)

The value of the X coordinate for a point on a Polygon .

Y -> (float)

The value of the Y coordinate for a point on a Polygon .

Confidence -> (float)

The confidence in detection, as a percentage

ValueDetection -> (structure)

The value of a detected element. Present in explicit and implicit elements.

Text -> (string)

The word or line of text recognized by Amazon Textract

Geometry -> (structure)

Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.

BoundingBox -> (structure)

An axis-aligned coarse representation of the location of the recognized item on the document page.

Width -> (float)

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

Height -> (float)

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

Left -> (float)

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

Top -> (float)

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

Polygon -> (list)

Within the bounding box, a fine-grained polygon around the recognized item.

(structure)

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.

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.

X -> (float)

The value of the X coordinate for a point on a Polygon .

Y -> (float)

The value of the Y coordinate for a point on a Polygon .

Confidence -> (float)

The confidence in detection, as a percentage

PageNumber -> (integer)

The page number the value was detected on.

Warnings -> (list)

A list of warnings that occurred during the text-detection operation for the document.

(structure)

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

ErrorCode -> (string)

The error code for the warning.

Pages -> (list)

A list of the pages that the warning applies to.

(integer)

StatusMessage -> (string)

Returns if the detection job could not be completed. Contains explanation for what error occured.

AnalyzeExpenseModelVersion -> (string)

The current model version of AnalyzeExpense.