Amazon CloudWatch Logs

{'logGroupNames': ['string']}

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.

See also: AWS API Documentation

Request Syntax

client.start_query(
    logGroupName='string',
    logGroupNames=[
        'string',
    ],
    startTime=123,
    endTime=123,
    queryString='string',
    limit=123
)

type logGroupName

string

param logGroupName

The log group on which to perform the query.

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

type logGroupNames

list

param logGroupNames

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.

• (string) --

type startTime

integer

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

type endTime

integer

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

type queryString

string

param queryString

[REQUIRED]

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

type limit

integer

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

rtype

dict

returns

Response Syntax

{
    'queryId': 'string'
}

Response Structure

• (dict) --

  • queryId (string) --

    The unique ID of the query.