cloudwatchlogs_start_query: Schedules a query of a log group using CloudWatch Logs...

View source: R/cloudwatchlogs_operations.R

cloudwatchlogs_start_queryR Documentation

Schedules a query of a log group using CloudWatch Logs Insights

Description

Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query and the query string to use.

See https://www.paws-r-sdk.com/docs/cloudwatchlogs_start_query/ for full documentation.

Usage

cloudwatchlogs_start_query(
  logGroupName = NULL,
  logGroupNames = NULL,
  logGroupIdentifiers = NULL,
  startTime,
  endTime,
  queryString,
  limit = NULL
)

Arguments

logGroupName

The log group on which to perform the query.

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

logGroupNames

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

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

logGroupIdentifiers

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, the ARN can't end with an asterisk (*).

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

startTime

[required] 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⁠.

endTime

[required] 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⁠.

queryString

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

limit

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.


paws.management documentation built on Sept. 12, 2023, 1:06 a.m.