You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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
  submit_time_before: Time.now,
  submit_time_after: Time.now,
}

Provides information for filtering topic detection jobs. For more information, see .

Instance Attribute Summary collapse

Instance Attribute Details

#job_nameString

Returns:

  • (String)


911
912
913
914
915
916
917
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 911

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

#job_statusString

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

Returns:

  • (String)


911
912
913
914
915
916
917
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 911

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

#submit_time_afterTime

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)


911
912
913
914
915
916
917
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 911

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

#submit_time_beforeTime

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)


911
912
913
914
915
916
917
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 911

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