Class: Aws::CloudWatchLogs::Types::StartQueryRequest

Inherits:

Struct

• Object
• Struct
• Aws::CloudWatchLogs::Types::StartQueryRequest

Includes:

Structure

Defined in:

lib/aws-sdk-cloudwatchlogs/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #end_time ⇒ Integer

  The end of the time range to query.

• #limit ⇒ Integer

  The maximum number of log events to return in the query.

• #log_group_identifiers ⇒ Array<String>

  The list of log groups to query.

• #log_group_name ⇒ String

  The log group on which to perform the query.

• #log_group_names ⇒ Array<String>

  The list of log groups to be queried.

• #query_string ⇒ String

  The query string to use.

• #start_time ⇒ Integer

  The beginning of the time range to query.

Instance Attribute Details

#end_time ⇒ Integer

The end of the time range to query. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since ‘January 1, 1970, 00:00:00 UTC`.

Returns:

• (Integer)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 6544

class StartQueryRequest < Struct.new(
  :log_group_name,
  :log_group_names,
  :log_group_identifiers,
  :start_time,
  :end_time,
  :query_string,
  :limit)
  SENSITIVE = []
  include Aws::Structure
end

#limit ⇒ Integer

The maximum number of log events to return in the query. If the query string uses the ‘fields` command, only the specified fields and their values are returned. The default is 10,000.

Returns:

• (Integer)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 6544

class StartQueryRequest < Struct.new(
  :log_group_name,
  :log_group_names,
  :log_group_identifiers,
  :start_time,
  :end_time,
  :query_string,
  :limit)
  SENSITIVE = []
  include Aws::Structure
end

#log_group_identifiers ⇒ Array<String>

The list of log groups to query. You can include up to 50 log groups.

You can specify them by the log group name or ARN. If a log group that you’re querying is in a source account and you’re using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account.

If you specify an ARN, use the format arn:aws:logs:region:account-id:log-group:log_group_name Don’t include an * at the end.

A ‘StartQuery` operation must include exactly one of the following parameters: `logGroupName`, `logGroupNames`, or `logGroupIdentifiers`.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 6544

class StartQueryRequest < Struct.new(
  :log_group_name,
  :log_group_names,
  :log_group_identifiers,
  :start_time,
  :end_time,
  :query_string,
  :limit)
  SENSITIVE = []
  include Aws::Structure
end

#log_group_name ⇒ String

The log group on which to perform the query.

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 6544

class StartQueryRequest < Struct.new(
  :log_group_name,
  :log_group_names,
  :log_group_identifiers,
  :start_time,
  :end_time,
  :query_string,
  :limit)
  SENSITIVE = []
  include Aws::Structure
end

#log_group_names ⇒ Array<String>

The list of log groups to be queried. You can include up to 50 log groups.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 6544

class StartQueryRequest < Struct.new(
  :log_group_name,
  :log_group_names,
  :log_group_identifiers,
  :start_time,
  :end_time,
  :query_string,
  :limit)
  SENSITIVE = []
  include Aws::Structure
end

#query_string ⇒ String

The query string to use. For more information, see [CloudWatch Logs Insights Query Syntax].

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 6544

class StartQueryRequest < Struct.new(
  :log_group_name,
  :log_group_names,
  :log_group_identifiers,
  :start_time,
  :end_time,
  :query_string,
  :limit)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Integer

The beginning of the time range to query. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since ‘January 1, 1970, 00:00:00 UTC`.

Returns:

• (Integer)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 6544

class StartQueryRequest < Struct.new(
  :log_group_name,
  :log_group_names,
  :log_group_identifiers,
  :start_time,
  :end_time,
  :query_string,
  :limit)
  SENSITIVE = []
  include Aws::Structure
end