CloudWatchLogs / Client / put_query_definition
put_query_definition#
- CloudWatchLogs.Client.put_query_definition(**kwargs)#
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 ofname
,queryString
, andlogGroupNames
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 thelogGroupNames
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.See also: AWS API Documentation
Request Syntax
response = client.put_query_definition( queryLanguage='CWLI'|'SQL'|'PPL', name='string', queryDefinitionId='string', logGroupNames=[ 'string', ], queryString='string', clientToken='string' )
- Parameters:
queryLanguage (string) – Specify the query language to use for this query. The options are Logs Insights QL, OpenSearch PPL, and OpenSearch SQL. For more information about the query languages that CloudWatch Logs supports, see Supported query languages.
name (string) –
[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 of DescribeQueryDefinitions.queryDefinitionId (string) –
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 DescribeQueryDefinitions 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 (list) –
Use this parameter to include specific log groups as part of your query definition. If your query uses the OpenSearch Service query language, you specify the log group names inside the
querystring
instead of here.If you are updating an existing query definition for the Logs Insights QL or OpenSearch Service PPL and you omit this parameter, then the updated definition will contain no log groups.
(string) –
queryString (string) –
[REQUIRED]
The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax.
clientToken (string) –
Used as an idempotency token, to avoid returning an exception if the service receives the same request twice because of a network error.
This field is autopopulated if not provided.
- Return type:
dict
- Returns:
Response Syntax
{ 'queryDefinitionId': 'string' }
Response Structure
(dict) –
queryDefinitionId (string) –
The ID of the query definition.
Exceptions
CloudWatchLogs.Client.exceptions.InvalidParameterException
CloudWatchLogs.Client.exceptions.LimitExceededException
CloudWatchLogs.Client.exceptions.ResourceNotFoundException
CloudWatchLogs.Client.exceptions.ServiceUnavailableException