AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::CloudWatchLogs::Types::DescribeQueriesRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb

Overview

Note:

When making an API call, you may pass DescribeQueriesRequest data as a hash:

{
  log_group_name: "LogGroupName",
  status: "Scheduled", # accepts Scheduled, Running, Complete, Failed, Cancelled, Timeout, Unknown
  max_results: 1,
  next_token: "NextToken",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#log_group_nameString

Limits the returned queries to only those for the specified log group.

Returns:

  • (String)


772
773
774
775
776
777
778
779
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 772

class DescribeQueriesRequest < Struct.new(
  :log_group_name,
  :status,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

Limits the number of returned queries to the specified number.

Returns:

  • (Integer)


772
773
774
775
776
777
778
779
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 772

class DescribeQueriesRequest < Struct.new(
  :log_group_name,
  :status,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The token for the next set of items to return. The token expires after 24 hours.

Returns:

  • (String)


772
773
774
775
776
777
778
779
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 772

class DescribeQueriesRequest < Struct.new(
  :log_group_name,
  :status,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

Limits the returned queries to only those that have the specified status. Valid values are Cancelled, Complete, Failed, Running, and Scheduled.

Returns:

  • (String)


772
773
774
775
776
777
778
779
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 772

class DescribeQueriesRequest < Struct.new(
  :log_group_name,
  :status,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end