AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Textract::Types::GetDocumentAnalysisRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetDocumentAnalysisRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  job_id: "JobId", # required
  max_results: 1,
  next_token: "PaginationToken",
}

Instance Attribute Summary collapse

Instance Attribute Details

#job_idString

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

Returns:

  • (String)

    A unique identifier for the text-detection job.

#max_resultsInteger

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.

Returns:

  • (Integer)

    The maximum number of results to return per paginated call.

#next_tokenString

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.

Returns:

  • (String)

    If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response.