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

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

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

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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#job_name ⇒ String

Filters on the name of the job.

Returns:

  • (String) 


2193
2194
2195
2196
2197
2198
2199
2200
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2193

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

#job_status ⇒ String

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

Returns:

  • (String) 


2193
2194
2195
2196
2197
2198
2199
2200
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2193

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

#submit_time_after ⇒ Time

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) 


2193
2194
2195
2196
2197
2198
2199
2200
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2193

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

#submit_time_before ⇒ Time

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) 


2193
2194
2195
2196
2197
2198
2199
2200
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2193

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