Put Query Definition
cloudwatchlogs_put_query_definition | R Documentation |
Creates or updates a query definition for CloudWatch Logs Insights¶
Description¶
Creates or updates a query definition for CloudWatch Logs Insights. For more information, see Analyzing Log Data with CloudWatch Logs Insights.
To update a query definition, specify its queryDefinitionId
in your
request. The values of name
, queryString
, and logGroupNames
are
changed to the values that you specify in your update operation. No
current values are retained from the current query definition. For
example, imagine updating a current query definition that includes log
groups. If you don't specify the logGroupNames
parameter in your
update operation, the query definition changes to contain no log groups.
You must have the logs:PutQueryDefinition
permission to be able to
perform this operation.
Usage¶
cloudwatchlogs_put_query_definition(name, queryDefinitionId,
logGroupNames, queryString, clientToken)
Arguments¶
name
[required] A name for the query definition. If you are saving numerous query definitions, we recommend that you name them. This way, you can find the ones you want by using the first part of the name as a filter in the
queryDefinitionNamePrefix
parameter ofdescribe_query_definitions
.queryDefinitionId
If you are updating a query definition, use this parameter to specify the ID of the query definition that you want to update. You can use
describe_query_definitions
to retrieve the IDs of your saved query definitions.If you are creating a query definition, do not specify this parameter. CloudWatch generates a unique ID for the new query definition and include it in the response to this operation.
logGroupNames
Use this parameter to include specific log groups as part of your query definition.
If you are updating a query definition and you omit this parameter, then the updated definition will contain no log groups.
queryString
[required] The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax.
clientToken
Used as an idempotency token, to avoid returning an exception if the service receives the same request twice because of a network error.
Value¶
A list with the following syntax: