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

Description Usage Arguments Value Request syntax

View source: R/cloudwatchlogs_operations.R

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.

For more information, see CloudWatch Logs Insights Query Syntax.

Queries time out after 15 minutes of execution. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries.

Usage

1
2
cloudwatchlogs_start_query(logGroupName, logGroupNames, startTime,
  endTime, queryString, limit)

Arguments

logGroupName

The log group on which to perform the query.

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

logGroupNames

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

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

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.

Value

A list with the following syntax:

1
2
3
list(
  queryId = "string"
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
svc$start_query(
  logGroupName = "string",
  logGroupNames = list(
    "string"
  ),
  startTime = 123,
  endTime = 123,
  queryString = "string",
  limit = 123
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.