Skip to content

QueryDefinition

Source code in docs_src/capo_cloudwatch_logs/types/query_definition.py
class QueryDefinition(TypedDict, closed=True):
    query_language: NotRequired[
        "capo_cloudwatch_logs.types.query_language.QueryLanguage"
    ]
    """<p>The query language used for this query. For more information about the query languages that CloudWatch Logs supports, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData_Languages.html">Supported query languages</a>.</p>"""
    query_definition_id: NotRequired["capo_cloudwatch_logs.types.query_id.QueryId"]
    """<p>The unique ID of the query definition.</p>"""
    name: NotRequired[
        "capo_cloudwatch_logs.types.query_definition_name.QueryDefinitionName"
    ]
    """<p>The name of the query definition.</p>"""
    query_string: NotRequired[
        "capo_cloudwatch_logs.types.query_definition_string.QueryDefinitionString"
    ]
    """<p>The query string to use for this definition. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html">CloudWatch Logs Insights Query Syntax</a>.</p>"""
    last_modified: NotRequired["capo_cloudwatch_logs.types.timestamp.Timestamp"]
    """<p>The date that the query definition was most recently modified.</p>"""
    log_group_names: NotRequired[
        "capo_cloudwatch_logs.types.log_group_names.LogGroupNames"
    ]
    """<p>If this query definition contains a list of log groups that it is limited to, that list appears here.</p>"""
    parameters: NotRequired[
        "capo_cloudwatch_logs.types.query_parameter_list.QueryParameterList"
    ]
    """<p>If this query definition contains a list of query parameters that define placeholder variables for the query string, that list appears here.</p>"""

last_modified instance-attribute

last_modified: NotRequired[Timestamp]

The date that the query definition was most recently modified.

log_group_names instance-attribute

log_group_names: NotRequired[LogGroupNames]

If this query definition contains a list of log groups that it is limited to, that list appears here.

name instance-attribute

name: NotRequired[QueryDefinitionName]

The name of the query definition.

parameters instance-attribute

parameters: NotRequired[QueryParameterList]

If this query definition contains a list of query parameters that define placeholder variables for the query string, that list appears here.

query_definition_id instance-attribute

query_definition_id: NotRequired[QueryId]

The unique ID of the query definition.

query_language instance-attribute

query_language: NotRequired[QueryLanguage]

The query language used for this query. For more information about the query languages that CloudWatch Logs supports, see Supported query languages.

query_string instance-attribute

query_string: NotRequired[QueryDefinitionString]

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