/AWS1/CL_CWL=>STARTQUERY()
¶
About StartQuery¶
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 StartQuery
, the query results are stored by CloudWatch Logs.
You can use GetQueryResults to retrieve
the results of a query, using the queryId
that StartQuery
returns.
If you have associated a KMS key with the query results in this account, then StartQuery 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 StartQuery
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.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_STARTTIME
TYPE /AWS1/CWLTIMESTAMP
/AWS1/CWLTIMESTAMP
¶
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
.
IV_ENDTIME
TYPE /AWS1/CWLTIMESTAMP
/AWS1/CWLTIMESTAMP
¶
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
.
IV_QUERYSTRING
TYPE /AWS1/CWLQUERYSTRING
/AWS1/CWLQUERYSTRING
¶
The query string to use. For more information, see CloudWatch Logs Insights Query Syntax.
Optional arguments:¶
IV_LOGGROUPNAME
TYPE /AWS1/CWLLOGGROUPNAME
/AWS1/CWLLOGGROUPNAME
¶
The log group on which to perform the query.
A
StartQuery
operation must include exactly one of the following parameters:logGroupName
,logGroupNames
, orlogGroupIdentifiers
.
IT_LOGGROUPNAMES
TYPE /AWS1/CL_CWLLOGGROUPNAMES_W=>TT_LOGGROUPNAMES
TT_LOGGROUPNAMES
¶
The list of log groups to be queried. You can include up to 50 log groups.
A
StartQuery
operation must include exactly one of the following parameters:logGroupName
,logGroupNames
, orlogGroupIdentifiers
.
IT_LOGGROUPIDENTIFIERS
TYPE /AWS1/CL_CWLLOGGROUPIDS_W=>TT_LOGGROUPIDENTIFIERS
TT_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
StartQuery
operation must include exactly one of the following parameters:logGroupName
,logGroupNames
, orlogGroupIdentifiers
.
IV_LIMIT
TYPE /AWS1/CWLEVENTSLIMIT
/AWS1/CWLEVENTSLIMIT
¶
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.