Start Query

cloudwatchlogs_start_query

R 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.

For more information, see CloudWatch Logs Insights Query Syntax.

After you run a query using start_query, the query results are stored by CloudWatch Logs. You can use get_query_results to retrieve the results of a query, using the queryId that start_query returns.

If you have associated a KMS key with the query results in this account, then start_query uses that key to encrypt the results when it stores them. If no key is associated with query results, the query results are encrypted with the default CloudWatch Logs encryption method.

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

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start a query in a linked source account. For more information, see CloudWatch cross-account observability. For a cross-account start_query operation, the query definition must be defined in the monitoring account.

You can have up to 30 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards.

Usage¶

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

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.

Value¶

A list with the following syntax:

list(
  queryId = "string"
)

Request syntax¶

svc$start_query(
  logGroupName = "string",
  logGroupNames = list(
    "string"
  ),
  logGroupIdentifiers = list(
    "string"
  ),
  startTime = 123,
  endTime = 123,
  queryString = "string",
  limit = 123
)