Class: Aws::Comprehend::Types::DocumentClassificationJobFilter

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

Overview

Provides information for filtering a list of document classification jobs. For more information, see the operation. You can provide only one filter parameter in each request.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#job_nameString

Filters on the name of the job.

Returns:

  • (String)


2784
2785
2786
2787
2788
2789
2790
2791
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2784

class DocumentClassificationJobFilter < Struct.new(
  :job_name,
  :job_status,
  :submit_time_before,
  :submit_time_after)
  SENSITIVE = []
  include Aws::Structure
end

#job_statusString

Filters the list based on job status. Returns only jobs with the specified status.

Returns:

  • (String)


2784
2785
2786
2787
2788
2789
2790
2791
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2784

class DocumentClassificationJobFilter < Struct.new(
  :job_name,
  :job_status,
  :submit_time_before,
  :submit_time_after)
  SENSITIVE = []
  include Aws::Structure
end

#submit_time_afterTime

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

Returns:

  • (Time)


2784
2785
2786
2787
2788
2789
2790
2791
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2784

class DocumentClassificationJobFilter < Struct.new(
  :job_name,
  :job_status,
  :submit_time_before,
  :submit_time_after)
  SENSITIVE = []
  include Aws::Structure
end

#submit_time_beforeTime

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

Returns:

  • (Time)


2784
2785
2786
2787
2788
2789
2790
2791
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2784

class DocumentClassificationJobFilter < Struct.new(
  :job_name,
  :job_status,
  :submit_time_before,
  :submit_time_after)
  SENSITIVE = []
  include Aws::Structure
end