Class: Aws::Comprehend::Types::ListDocumentClassifiersRequest

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 ListDocumentClassifiersRequest data as a hash:

{
  filter: {
    status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
    document_classifier_name: "ComprehendArnName",
    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::DocumentClassifierFilter

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

Returns:



4364
4365
4366
4367
4368
4369
4370
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 4364

class ListDocumentClassifiersRequest < 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) 


4364
4365
4366
4367
4368
4369
4370
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 4364

class ListDocumentClassifiersRequest < 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) 


4364
4365
4366
4367
4368
4369
4370
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 4364

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