Skip to content

/AWS1/CL_TEXGETDOCTXTDETECTRSP

GetDocumentTextDetectionResponse

CONSTRUCTOR

IMPORTING

Optional arguments:

IO_DOCUMENTMETADATA TYPE REF TO /AWS1/CL_TEXDOCUMENTMETADATA /AWS1/CL_TEXDOCUMENTMETADATA

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

IV_JOBSTATUS TYPE /AWS1/TEXJOBSTATUS /AWS1/TEXJOBSTATUS

The current status of the text detection job.

IV_NEXTTOKEN TYPE /AWS1/TEXPAGINATIONTOKEN /AWS1/TEXPAGINATIONTOKEN

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.

IT_BLOCKS TYPE /AWS1/CL_TEXBLOCK=>TT_BLOCKLIST TT_BLOCKLIST

The results of the text-detection operation.

IT_WARNINGS TYPE /AWS1/CL_TEXWARNING=>TT_WARNINGS TT_WARNINGS

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

IV_STATUSMESSAGE TYPE /AWS1/TEXSTATUSMESSAGE /AWS1/TEXSTATUSMESSAGE

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

IV_DETECTDOCTEXTMODELVERSION TYPE /AWS1/TEXSTRING /AWS1/TEXSTRING


Queryable Attributes

DocumentMetadata

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

Accessible with the following methods

Method Description
GET_DOCUMENTMETADATA() Getter for DOCUMENTMETADATA

JobStatus

The current status of the text detection job.

Accessible with the following methods

Method Description
GET_JOBSTATUS() Getter for JOBSTATUS, with configurable default
ASK_JOBSTATUS() Getter for JOBSTATUS w/ exceptions if field has no value
HAS_JOBSTATUS() Determine if JOBSTATUS has a value

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.

Accessible with the following methods

Method Description
GET_NEXTTOKEN() Getter for NEXTTOKEN, with configurable default
ASK_NEXTTOKEN() Getter for NEXTTOKEN w/ exceptions if field has no value
HAS_NEXTTOKEN() Determine if NEXTTOKEN has a value

Blocks

The results of the text-detection operation.

Accessible with the following methods

Method Description
GET_BLOCKS() Getter for BLOCKS, with configurable default
ASK_BLOCKS() Getter for BLOCKS w/ exceptions if field has no value
HAS_BLOCKS() Determine if BLOCKS has a value

Warnings

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

Accessible with the following methods

Method Description
GET_WARNINGS() Getter for WARNINGS, with configurable default
ASK_WARNINGS() Getter for WARNINGS w/ exceptions if field has no value
HAS_WARNINGS() Determine if WARNINGS has a value

StatusMessage

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

Accessible with the following methods

Method Description
GET_STATUSMESSAGE() Getter for STATUSMESSAGE, with configurable default
ASK_STATUSMESSAGE() Getter for STATUSMESSAGE w/ exceptions if field has no value
HAS_STATUSMESSAGE() Determine if STATUSMESSAGE has a value

DetectDocumentTextModelVersion

Accessible with the following methods

Method Description
GET_DETECTDOCTEXTMODELVRS() Getter for DETECTDOCTEXTMODELVERSION, with configurable defa
ASK_DETECTDOCTEXTMODELVRS() Getter for DETECTDOCTEXTMODELVERSION w/ exceptions if field
HAS_DETECTDOCTEXTMODELVRS() Determine if DETECTDOCTEXTMODELVERSION has a value