Class: Aws::Comprehend::Types::ListSentimentDetectionJobsRequest

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 ListSentimentDetectionJobsRequest 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::SentimentDetectionJobFilter

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.



3491
3492
3493
3494
3495
3496
3497
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3491

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


3491
3492
3493
3494
3495
3496
3497
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3491

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

#next_tokenString

Identifies the next page of results to return.

Returns:

  • (String)


3491
3492
3493
3494
3495
3496
3497
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3491

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