Class: Aws::Textract::Types::GetDocumentTextDetectionRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb

Overview

Note:

When making an API call, you may pass GetDocumentTextDetectionRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#job_idString

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

Returns:

  • (String)


633
634
635
636
637
638
639
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 633

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

#max_resultsInteger

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.

Returns:

  • (Integer)


633
634
635
636
637
638
639
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 633

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

#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)


633
634
635
636
637
638
639
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 633

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