Class: Aws::Comprehend::Types::ListDocumentClassificationJobsRequest

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

Overview

Note:

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

{
  filter: {
    job_name: "JobName",
    job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
    submit_time_before: Time.now,
    submit_time_after: Time.now,
  },
  next_token: "String",
  max_results: 1,
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ Types::DocumentClassificationJobFilter

Filters the jobs that are returned. You can filter jobs on their names, status, or the date and time that they were submitted. You can only set one filter at a time.

Returns:



3100
3101
3102
3103
3104
3105
3106
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3100

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

#max_results ⇒ Integer

The maximum number of results to return in each page. The default is 100.

Returns:

  • (Integer) 


3100
3101
3102
3103
3104
3105
3106
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3100

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

#next_token ⇒ String

Identifies the next page of results to return.

Returns:

  • (String) 


3100
3101
3102
3103
3104
3105
3106
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3100

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