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

Inherits:

Struct

• Object
• Struct
• Aws::Comprehend::Types::DocumentClassifierFilter

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #document_classifier_name ⇒ String

  The name that you assigned to the document classifier.

• #status ⇒ String

  Filters the list of classifiers based on status.

• #submit_time_after ⇒ Time

  Filters the list of classifiers based on the time that the classifier was submitted for processing.

• #submit_time_before ⇒ Time

  Filters the list of classifiers based on the time that the classifier was submitted for processing.

Instance Attribute Details

#document_classifier_name ⇒ String

The name that you assigned to the document classifier

Returns:

• (String)

# 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

#status ⇒ String

Filters the list of classifiers based on status.

Returns:

• (String)

# 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_after ⇒ Time

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)

# 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_before ⇒ Time

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)

# 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