Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Textract.GetDocumentTextDetection

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets 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). When the text detection 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 StartDocumentTextDetection. 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 GetDocumentTextDetection, and pass the job identifier (JobId) from the initial call to StartDocumentTextDetection.

GetDocumentTextDetection returns an array of Block objects.

Each document page has as an associated Block of type PAGE. Each PAGE Block object is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is a parent for each word that makes up the line. Words are represented by Block objects of type WORD.

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

For more information, see Document Text Detection.

Synopsis

Creating a Request

data GetDocumentTextDetection Source #

See: newGetDocumentTextDetection smart constructor.

Constructors

GetDocumentTextDetection'

Fields

maxResults :: Maybe Natural
The maximum number of results to return per paginated call. The largest value 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.
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.
jobId :: Text
A unique identifier for the text detection job. The JobId is returned from StartDocumentTextDetection. A JobId value is only valid for 7 days.

Instances

Instances details

ToJSON GetDocumentTextDetection Source #
Instance details Defined in Amazonka.Textract.GetDocumentTextDetection Methods toJSON :: GetDocumentTextDetection -> Value # toEncoding :: GetDocumentTextDetection -> Encoding # toJSONList :: [GetDocumentTextDetection] -> Value # toEncodingList :: [GetDocumentTextDetection] -> Encoding #
ToHeaders GetDocumentTextDetection Source #
Instance details Defined in Amazonka.Textract.GetDocumentTextDetection Methods toHeaders :: GetDocumentTextDetection -> [Header] #
ToPath GetDocumentTextDetection Source #
Instance details Defined in Amazonka.Textract.GetDocumentTextDetection Methods toPath :: GetDocumentTextDetection -> ByteString #
ToQuery GetDocumentTextDetection Source #
Instance details Defined in Amazonka.Textract.GetDocumentTextDetection Methods toQuery :: GetDocumentTextDetection -> QueryString #
AWSRequest GetDocumentTextDetection Source #
Instance details Defined in Amazonka.Textract.GetDocumentTextDetection Associated Types type AWSResponse GetDocumentTextDetection # Methods request :: (Service -> Service) -> GetDocumentTextDetection -> Request GetDocumentTextDetection # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetDocumentTextDetection -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDocumentTextDetection))) #
Generic GetDocumentTextDetection Source #
Instance details Defined in Amazonka.Textract.GetDocumentTextDetection Associated Types type Rep GetDocumentTextDetection :: Type -> Type # Methods from :: GetDocumentTextDetection -> Rep GetDocumentTextDetection x # to :: Rep GetDocumentTextDetection x -> GetDocumentTextDetection #
Read GetDocumentTextDetection Source #
Instance details Defined in Amazonka.Textract.GetDocumentTextDetection Methods readsPrec :: Int -> ReadS GetDocumentTextDetection # readList :: ReadS [GetDocumentTextDetection] # readPrec :: ReadPrec GetDocumentTextDetection # readListPrec :: ReadPrec [GetDocumentTextDetection] #
Show GetDocumentTextDetection Source #
Instance details Defined in Amazonka.Textract.GetDocumentTextDetection Methods showsPrec :: Int -> GetDocumentTextDetection -> ShowS # show :: GetDocumentTextDetection -> String # showList :: [GetDocumentTextDetection] -> ShowS #
NFData GetDocumentTextDetection Source #
Instance details Defined in Amazonka.Textract.GetDocumentTextDetection Methods rnf :: GetDocumentTextDetection -> () #
Eq GetDocumentTextDetection Source #
Instance details Defined in Amazonka.Textract.GetDocumentTextDetection Methods (==) :: GetDocumentTextDetection -> GetDocumentTextDetection -> Bool # (/=) :: GetDocumentTextDetection -> GetDocumentTextDetection -> Bool #
Hashable GetDocumentTextDetection Source #
Instance details Defined in Amazonka.Textract.GetDocumentTextDetection Methods hashWithSalt :: Int -> GetDocumentTextDetection -> Int # hash :: GetDocumentTextDetection -> Int #
type AWSResponse GetDocumentTextDetection Source #
Instance details Defined in Amazonka.Textract.GetDocumentTextDetection type AWSResponse GetDocumentTextDetection = GetDocumentTextDetectionResponse
type Rep GetDocumentTextDetection Source #
Instance details Defined in Amazonka.Textract.GetDocumentTextDetection type Rep GetDocumentTextDetection = D1 ('MetaData "GetDocumentTextDetection" "Amazonka.Textract.GetDocumentTextDetection" "amazonka-textract-2.0-6i5mJlqzS4xCepXxXFK6UK" 'False) (C1 ('MetaCons "GetDocumentTextDetection'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetDocumentTextDetection Source #

Arguments

:: Text	`$sel:jobId:GetDocumentTextDetection'`
-> GetDocumentTextDetection

Create a value of GetDocumentTextDetection 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:maxResults:GetDocumentTextDetection', getDocumentTextDetection_maxResults - The maximum number of results to return per paginated call. The largest value 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.

GetDocumentTextDetection, getDocumentTextDetection_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:jobId:GetDocumentTextDetection', getDocumentTextDetection_jobId - A unique identifier for the text detection job. The JobId is returned from StartDocumentTextDetection. A JobId value is only valid for 7 days.

Request Lenses

getDocumentTextDetection_maxResults :: Lens' GetDocumentTextDetection (Maybe Natural) Source #

The maximum number of results to return per paginated call. The largest value 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.

getDocumentTextDetection_nextToken :: Lens' GetDocumentTextDetection (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.

getDocumentTextDetection_jobId :: Lens' GetDocumentTextDetection Text Source #

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

Destructuring the Response

data GetDocumentTextDetectionResponse Source #

See: newGetDocumentTextDetectionResponse smart constructor.

Constructors

GetDocumentTextDetectionResponse'

Fields

blocks :: Maybe [Block]
The results of the text-detection operation.
detectDocumentTextModelVersion :: Maybe Text
documentMetadata :: Maybe DocumentMetadata
Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.
jobStatus :: Maybe JobStatus
The current status of the text detection job.
nextToken :: Maybe Text
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.
statusMessage :: Maybe Text
Returns if the detection job could not be completed. Contains explanation for what error occured.
warnings :: Maybe [Warning]
A list of warnings that occurred during the text-detection operation for the document.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetDocumentTextDetectionResponse Source #
Instance details Defined in Amazonka.Textract.GetDocumentTextDetection Associated Types type Rep GetDocumentTextDetectionResponse :: Type -> Type # Methods from :: GetDocumentTextDetectionResponse -> Rep GetDocumentTextDetectionResponse x # to :: Rep GetDocumentTextDetectionResponse x -> GetDocumentTextDetectionResponse #
Read GetDocumentTextDetectionResponse Source #
Instance details Defined in Amazonka.Textract.GetDocumentTextDetection Methods readsPrec :: Int -> ReadS GetDocumentTextDetectionResponse # readList :: ReadS [GetDocumentTextDetectionResponse] # readPrec :: ReadPrec GetDocumentTextDetectionResponse # readListPrec :: ReadPrec [GetDocumentTextDetectionResponse] #
Show GetDocumentTextDetectionResponse Source #
Instance details Defined in Amazonka.Textract.GetDocumentTextDetection Methods showsPrec :: Int -> GetDocumentTextDetectionResponse -> ShowS # show :: GetDocumentTextDetectionResponse -> String # showList :: [GetDocumentTextDetectionResponse] -> ShowS #
NFData GetDocumentTextDetectionResponse Source #
Instance details Defined in Amazonka.Textract.GetDocumentTextDetection Methods rnf :: GetDocumentTextDetectionResponse -> () #
Eq GetDocumentTextDetectionResponse Source #
Instance details Defined in Amazonka.Textract.GetDocumentTextDetection Methods (==) :: GetDocumentTextDetectionResponse -> GetDocumentTextDetectionResponse -> Bool # (/=) :: GetDocumentTextDetectionResponse -> GetDocumentTextDetectionResponse -> Bool #
type Rep GetDocumentTextDetectionResponse Source #
Instance details Defined in Amazonka.Textract.GetDocumentTextDetection type Rep GetDocumentTextDetectionResponse = D1 ('MetaData "GetDocumentTextDetectionResponse" "Amazonka.Textract.GetDocumentTextDetection" "amazonka-textract-2.0-6i5mJlqzS4xCepXxXFK6UK" 'False) (C1 ('MetaCons "GetDocumentTextDetectionResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "blocks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Block])) :: S1 ('MetaSel ('Just "detectDocumentTextModelVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "documentMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentMetadata)) :: S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)))) :: ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "warnings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Warning])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetDocumentTextDetectionResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetDocumentTextDetectionResponse'`
-> GetDocumentTextDetectionResponse

Create a value of GetDocumentTextDetectionResponse 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:

GetDocumentTextDetectionResponse, getDocumentTextDetectionResponse_blocks - The results of the text-detection operation.

$sel:detectDocumentTextModelVersion:GetDocumentTextDetectionResponse', getDocumentTextDetectionResponse_detectDocumentTextModelVersion -

$sel:documentMetadata:GetDocumentTextDetectionResponse', getDocumentTextDetectionResponse_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:jobStatus:GetDocumentTextDetectionResponse', getDocumentTextDetectionResponse_jobStatus - The current status of the text detection job.

GetDocumentTextDetection, getDocumentTextDetectionResponse_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:GetDocumentTextDetectionResponse', getDocumentTextDetectionResponse_statusMessage - Returns if the detection job could not be completed. Contains explanation for what error occured.

$sel:warnings:GetDocumentTextDetectionResponse', getDocumentTextDetectionResponse_warnings - A list of warnings that occurred during the text-detection operation for the document.

$sel:httpStatus:GetDocumentTextDetectionResponse', getDocumentTextDetectionResponse_httpStatus - The response's http status code.

Response Lenses

getDocumentTextDetectionResponse_blocks :: Lens' GetDocumentTextDetectionResponse (Maybe [Block]) Source #

The results of the text-detection operation.

getDocumentTextDetectionResponse_detectDocumentTextModelVersion :: Lens' GetDocumentTextDetectionResponse (Maybe Text) Source #

getDocumentTextDetectionResponse_documentMetadata :: Lens' GetDocumentTextDetectionResponse (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.

getDocumentTextDetectionResponse_jobStatus :: Lens' GetDocumentTextDetectionResponse (Maybe JobStatus) Source #

The current status of the text detection job.

getDocumentTextDetectionResponse_nextToken :: Lens' GetDocumentTextDetectionResponse (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.

getDocumentTextDetectionResponse_statusMessage :: Lens' GetDocumentTextDetectionResponse (Maybe Text) Source #

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

getDocumentTextDetectionResponse_warnings :: Lens' GetDocumentTextDetectionResponse (Maybe [Warning]) Source #

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

getDocumentTextDetectionResponse_httpStatus :: Lens' GetDocumentTextDetectionResponse Int Source #

The response's http status code.