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

Class: Aws::Comprehend::Types::ListTopicsDetectionJobsRequest

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

{
  filter: {
    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,
  },
  next_token: "String",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#filterTypes::TopicsDetectionJobFilter

Filters the jobs that are returned. Jobs can be filtered on their name, status, or the date and time that they were submitted. You can set only one filter at a time.



1466
1467
1468
1469
1470
1471
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1466

class ListTopicsDetectionJobsRequest < Struct.new(
  :filter,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return in each page. The default is 100.

Returns:

  • (Integer)


1466
1467
1468
1469
1470
1471
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1466

class ListTopicsDetectionJobsRequest < Struct.new(
  :filter,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_tokenString

Identifies the next page of results to return.

Returns:

  • (String)


1466
1467
1468
1469
1470
1471
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1466

class ListTopicsDetectionJobsRequest < Struct.new(
  :filter,
  :next_token,
  :max_results)
  include Aws::Structure
end