Class: Aws::Comprehend::Types::EventsDetectionJobFilter

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 EventsDetectionJobFilter 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 event detection jobs.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#job_name ⇒ String

Filters on the name of the events detection job.

Returns:

  • (String) 


3238
3239
3240
3241
3242
3243
3244
3245
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3238

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

#job_status ⇒ String

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

Returns:

  • (String) 


3238
3239
3240
3241
3242
3243
3244
3245
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3238

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


3238
3239
3240
3241
3242
3243
3244
3245
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3238

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


3238
3239
3240
3241
3242
3243
3244
3245
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3238

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