Describe Queries

cloudwatchlogs_describe_queries

R Documentation

Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run recently in this account¶

Description¶

Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run recently in this account. You can request all queries or limit it to queries of a specific log group or queries with a certain status.

This operation includes both interactive queries started directly by users and automated queries executed by scheduled query configurations. Scheduled query executions appear in the results alongside manually initiated queries, providing visibility into all query activity in your account.

Usage¶

cloudwatchlogs_describe_queries(logGroupName, status, maxResults,
  nextToken, queryLanguage)

Arguments¶

logGroupName

Limits the returned queries to only those for the specified log group.

status

Limits the returned queries to only those that have the specified status. Valid values are Cancelled, Complete, Failed, Running, and Scheduled.

maxResults

Limits the number of returned queries to the specified number.

nextToken

The token for the next set of items to return. The token expires after 24 hours.

queryLanguage

Limits the returned queries to only the queries that use the specified query language.

Value¶

A list with the following syntax:

list(
  queries = list(
    list(
      queryLanguage = "CWLI"|"SQL"|"PPL",
      queryId = "string",
      queryString = "string",
      status = "Scheduled"|"Running"|"Complete"|"Failed"|"Cancelled"|"Timeout"|"Unknown",
      createTime = 123,
      logGroupName = "string",
      queryDuration = 123,
      bytesScanned = 123.0,
      userIdentity = "string"
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$describe_queries(
  logGroupName = "string",
  status = "Scheduled"|"Running"|"Complete"|"Failed"|"Cancelled"|"Timeout"|"Unknown",
  maxResults = 123,
  nextToken = "string",
  queryLanguage = "CWLI"|"SQL"|"PPL"
)