libZSservicesZSamazonka-textractZSamazonka-textract
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Textract.GetDocumentAnalysis

Description

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 (JobId). 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 StartDocumentAnalysis. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to StartDocumentAnalysis.

GetDocumentAnalysis returns an array of Block objects. The following types of information are returned:

  • 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: 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.
  • Lines and words of text. A LINE Block object contains one or more WORD Block objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of the StartDocumentAnalysis FeatureTypes input parameter).

Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block object contains information about a selection element, including the selection status.

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

For more information, see Document Text Analysis.

Synopsis

Creating a Request

data GetDocumentAnalysis Source #

See: newGetDocumentAnalysis smart constructor.

Constructors

GetDocumentAnalysis' 

Fields

  • nextToken :: Maybe Text

    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.

  • maxResults :: Maybe Natural

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

  • jobId :: Text

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

Instances

Instances details
Eq GetDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

Read GetDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

Show GetDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

Generic GetDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

Associated Types

type Rep GetDocumentAnalysis :: Type -> Type #

NFData GetDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

Methods

rnf :: GetDocumentAnalysis -> () #

Hashable GetDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

ToJSON GetDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

AWSRequest GetDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

Associated Types

type AWSResponse GetDocumentAnalysis #

ToHeaders GetDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

ToPath GetDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

ToQuery GetDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

type Rep GetDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

type Rep GetDocumentAnalysis = D1 ('MetaData "GetDocumentAnalysis" "Amazonka.Textract.GetDocumentAnalysis" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "GetDocumentAnalysis'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse GetDocumentAnalysis Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

newGetDocumentAnalysis Source #

Create a value of GetDocumentAnalysis with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:GetDocumentAnalysis', getDocumentAnalysis_nextToken - 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.

$sel:maxResults:GetDocumentAnalysis', getDocumentAnalysis_maxResults - The maximum number of results to return per paginated call. The largest value that you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.

$sel:jobId:GetDocumentAnalysis', getDocumentAnalysis_jobId - A unique identifier for the text-detection job. The JobId is returned from StartDocumentAnalysis. A JobId value is only valid for 7 days.

Request Lenses

getDocumentAnalysis_nextToken :: Lens' GetDocumentAnalysis (Maybe Text) Source #

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.

getDocumentAnalysis_maxResults :: Lens' GetDocumentAnalysis (Maybe Natural) Source #

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

getDocumentAnalysis_jobId :: Lens' GetDocumentAnalysis Text Source #

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

Destructuring the Response

data GetDocumentAnalysisResponse Source #

See: newGetDocumentAnalysisResponse smart constructor.

Constructors

GetDocumentAnalysisResponse' 

Fields

Instances

Instances details
Eq GetDocumentAnalysisResponse Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

Read GetDocumentAnalysisResponse Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

Show GetDocumentAnalysisResponse Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

Generic GetDocumentAnalysisResponse Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

Associated Types

type Rep GetDocumentAnalysisResponse :: Type -> Type #

NFData GetDocumentAnalysisResponse Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

type Rep GetDocumentAnalysisResponse Source # 
Instance details

Defined in Amazonka.Textract.GetDocumentAnalysis

type Rep GetDocumentAnalysisResponse = D1 ('MetaData "GetDocumentAnalysisResponse" "Amazonka.Textract.GetDocumentAnalysis" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "GetDocumentAnalysisResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "documentMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentMetadata)) :*: S1 ('MetaSel ('Just "blocks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Block]))) :*: (S1 ('MetaSel ('Just "analyzeDocumentModelVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "warnings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Warning])))) :*: ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetDocumentAnalysisResponse Source #

Create a value of GetDocumentAnalysisResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentMetadata:GetDocumentAnalysisResponse', getDocumentAnalysisResponse_documentMetadata - Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.

$sel:blocks:GetDocumentAnalysisResponse', getDocumentAnalysisResponse_blocks - The results of the text-analysis operation.

$sel:analyzeDocumentModelVersion:GetDocumentAnalysisResponse', getDocumentAnalysisResponse_analyzeDocumentModelVersion -

$sel:warnings:GetDocumentAnalysisResponse', getDocumentAnalysisResponse_warnings - A list of warnings that occurred during the document-analysis operation.

$sel:nextToken:GetDocumentAnalysis', getDocumentAnalysisResponse_nextToken - 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.

$sel:statusMessage:GetDocumentAnalysisResponse', getDocumentAnalysisResponse_statusMessage - Returns if the detection job could not be completed. Contains explanation for what error occured.

$sel:jobStatus:GetDocumentAnalysisResponse', getDocumentAnalysisResponse_jobStatus - The current status of the text detection job.

$sel:httpStatus:GetDocumentAnalysisResponse', getDocumentAnalysisResponse_httpStatus - The response's http status code.

Response Lenses

getDocumentAnalysisResponse_documentMetadata :: Lens' GetDocumentAnalysisResponse (Maybe DocumentMetadata) Source #

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

getDocumentAnalysisResponse_blocks :: Lens' GetDocumentAnalysisResponse (Maybe [Block]) Source #

The results of the text-analysis operation.

getDocumentAnalysisResponse_warnings :: Lens' GetDocumentAnalysisResponse (Maybe [Warning]) Source #

A list of warnings that occurred during the document-analysis operation.

getDocumentAnalysisResponse_nextToken :: Lens' GetDocumentAnalysisResponse (Maybe Text) Source #

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.

getDocumentAnalysisResponse_statusMessage :: Lens' GetDocumentAnalysisResponse (Maybe Text) Source #

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