Interface GetDocumentTextDetectionCommandOutput

The output of GetDocumentTextDetectionCommand.

interface GetDocumentTextDetectionCommandOutput {
    $metadata: ResponseMetadata;
    Blocks?: Block[];
    DetectDocumentTextModelVersion?: string;
    DocumentMetadata?: DocumentMetadata;
    JobStatus?: JobStatus;
    NextToken?: string;
    StatusMessage?: string;
    Warnings?: Warning[];
}

Hierarchy (view full)

Properties

$metadata Blocks? DetectDocumentTextModelVersion? DocumentMetadata? JobStatus? NextToken? StatusMessage? Warnings?

Properties

$metadata

$metadata: ResponseMetadata

Metadata pertaining to this request.

Optional Blocks

Blocks?: Block[]

The results of the text-detection operation.

Optional DetectDocumentTextModelVersion

DetectDocumentTextModelVersion?: string

Optional DocumentMetadata

DocumentMetadata?: DocumentMetadata

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

Optional JobStatus

JobStatus?: JobStatus

The current status of the text detection job.

Optional NextToken

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.

Optional StatusMessage

StatusMessage?: string

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

Optional Warnings

Warnings?: Warning[]

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

Settings

Member Visibility

Theme

On This Page