Class: Aws::Comprehend::Types::DocumentClassifierFilter

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

{
  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,
}

Provides information for filtering a list of document classifiers. You can only specify one filtering parameter in a request. For more information, see the operation.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#document_classifier_nameString

The name that you assigned to the document classifier

Returns:

  • (String)


2058
2059
2060
2061
2062
2063
2064
2065
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2058

class DocumentClassifierFilter < Struct.new(
  :status,
  :document_classifier_name,
  :submit_time_before,
  :submit_time_after)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

Filters the list of classifiers based on status.

Returns:

  • (String)


2058
2059
2060
2061
2062
2063
2064
2065
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2058

class DocumentClassifierFilter < Struct.new(
  :status,
  :document_classifier_name,
  :submit_time_before,
  :submit_time_after)
  SENSITIVE = []
  include Aws::Structure
end

#submit_time_afterTime

Filters the list of classifiers based on the time that the classifier was submitted for processing. Returns only classifiers submitted after the specified time. Classifiers are returned in descending order, newest to oldest.

Returns:

  • (Time)


2058
2059
2060
2061
2062
2063
2064
2065
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2058

class DocumentClassifierFilter < Struct.new(
  :status,
  :document_classifier_name,
  :submit_time_before,
  :submit_time_after)
  SENSITIVE = []
  include Aws::Structure
end

#submit_time_beforeTime

Filters the list of classifiers based on the time that the classifier was submitted for processing. Returns only classifiers submitted before the specified time. Classifiers are returned in ascending order, oldest to newest.

Returns:

  • (Time)


2058
2059
2060
2061
2062
2063
2064
2065
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2058

class DocumentClassifierFilter < Struct.new(
  :status,
  :document_classifier_name,
  :submit_time_before,
  :submit_time_after)
  SENSITIVE = []
  include Aws::Structure
end