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

Inherits:

Struct

• Object
• Struct
• Aws::Textract::Types::GetDocumentAnalysisRequest

Includes:

Structure

Defined in:

lib/aws-sdk-textract/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #job_id ⇒ String

  A unique identifier for the text-detection job.

• #max_results ⇒ Integer

  The maximum number of results to return per paginated call.

• #next_token ⇒ String

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

Instance Attribute Details

#job_id ⇒ String

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)

# File 'lib/aws-sdk-textract/types.rb', line 1521

class GetDocumentAnalysisRequest < Struct.new(
  :job_id,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

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)

# File 'lib/aws-sdk-textract/types.rb', line 1521

class GetDocumentAnalysisRequest < Struct.new(
  :job_id,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

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)

# File 'lib/aws-sdk-textract/types.rb', line 1521

class GetDocumentAnalysisRequest < Struct.new(
  :job_id,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end