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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing StartQueryRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  log_group_name: "LogGroupName",
  log_group_names: ["LogGroupName"],
  start_time: 1, # required
  end_time: 1, # required
  query_string: "QueryString", # required
  limit: 1,
}

See Also:

Instance Attribute Summary collapse

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) —

    The end of the time range to query.

#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 1000.

Returns:

  • (Integer) —

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

#log_group_name ⇒ String

The log group on which to perform the query.

A StartQuery operation must include a logGroupNames or a logGroupName parameter, but not both.

Returns:

  • (String) —

    The log group on which to perform the query.

#log_group_names ⇒ Array<String>

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

A StartQuery operation must include a logGroupNames or a logGroupName parameter, but not both.

Returns:

  • (Array<String>) —

    The list of log groups to be queried.

#query_string ⇒ String

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

Returns:

  • (String) —

    The query string to use.

#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) —

    The beginning of the time range to query.