Gets 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 (
). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to
. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is
. If so, call
, and pass the job identifier (
) from the initial call to
returns an array of Block
objects. The following types of information are returned:
- Words and lines that are related to nearby lines and words. 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: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value.
- Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a table.
- Selectable elements such as checkboxes and radio buttons. A SELECTION_ELEMENT Block object contains information about a selectable element.
- Lines and words of text. A LINE Block object contains one or more WORD Block objects.
parameter to limit the number of blocks returned. If there are more results than specified in
, the value of
in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call
, and populate the
request parameter with the token value that's returned from the previous call to
For more information, see Document Text Analysis
In the AWS.Tools.Textract module, this cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration.