Class: Aws::Comprehend::Types::ListKeyPhrasesDetectionJobsRequest

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filterTypes::KeyPhrasesDetectionJobFilter

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



4743
4744
4745
4746
4747
4748
4749
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 4743

class ListKeyPhrasesDetectionJobsRequest < Struct.new(
  :filter,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

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

Returns:

  • (Integer)


4743
4744
4745
4746
4747
4748
4749
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 4743

class ListKeyPhrasesDetectionJobsRequest < Struct.new(
  :filter,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

Identifies the next page of results to return.

Returns:

  • (String)


4743
4744
4745
4746
4747
4748
4749
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 4743

class ListKeyPhrasesDetectionJobsRequest < Struct.new(
  :filter,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end