Class: Aws::Comprehend::Types::TopicsDetectionJobFilter

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 TopicsDetectionJobFilter 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 topic detection jobs. For more information, see .

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#job_name ⇒ String

Returns:

  • (String) 


6943
6944
6945
6946
6947
6948
6949
6950
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6943

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

#job_status ⇒ String

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

Returns:

  • (String) 


6943
6944
6945
6946
6947
6948
6949
6950
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6943

class TopicsDetectionJobFilter < 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. Only returns jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest.

Returns:

  • (Time) 


6943
6944
6945
6946
6947
6948
6949
6950
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6943

class TopicsDetectionJobFilter < 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. Only returns jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest.

Returns:

  • (Time) 


6943
6944
6945
6946
6947
6948
6949
6950
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6943

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