Skip to content

ScheduledQueryConfiguration

Source code in docs_src/capo_cloudwatch/types/scheduled_query_configuration.py
class ScheduledQueryConfiguration(TypedDict, closed=True):
    query_string: NotRequired["capo_cloudwatch.types.query_string.QueryString"]
    """<p>The CloudWatch Logs query to execute on each scheduled run. Length constraints: maximum of 10,000 characters.</p>"""
    log_group_identifiers: NotRequired[
        "capo_cloudwatch.types.log_group_identifiers.LogGroupIdentifiers"
    ]
    """<p>The log groups to query. Each entry can be a log group name or ARN. Use the ARN form when querying log groups in a different account (for example, when running cross-account queries from a monitoring account). The list must contain between 1 and 50 entries.</p>"""
    query_arn: NotRequired[
        "capo_cloudwatch.types.amazon_resource_name.AmazonResourceName"
    ]
    """<p>The Amazon Resource Name (ARN) of the CloudWatch Logs scheduled query that the alarm uses. This field is populated in <code>DescribeAlarms</code> responses.</p>"""
    scheduled_query_role_arn: NotRequired[
        "capo_cloudwatch.types.amazon_resource_name.AmazonResourceName"
    ]
    """<p>The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes when executing the scheduled query against the configured log groups.</p>"""
    schedule_configuration: NotRequired[
        "capo_cloudwatch.types.schedule_configuration.ScheduleConfiguration"
    ]
    """<p>The schedule and time-range offset configuration for the underlying scheduled query.</p>"""
    aggregation_expression: NotRequired[
        "capo_cloudwatch.types.aggregation_expression.AggregationExpression"
    ]
    """<p>The expression that defines how to aggregate query results into one or more scalar values for alarm evaluation. For example, <code>count(*)</code> or <code>avg(latency) by host | sort desc</code>. Length constraints: minimum 1 character, maximum 2048 characters.</p>"""
    tags: NotRequired["capo_cloudwatch.types.tag_list.TagList"]
    """<p>A list of key-value pairs to associate with the underlying scheduled query resource.</p>"""

aggregation_expression instance-attribute

aggregation_expression: NotRequired[AggregationExpression]

The expression that defines how to aggregate query results into one or more scalar values for alarm evaluation. For example, count(*) or avg(latency) by host | sort desc. Length constraints: minimum 1 character, maximum 2048 characters.

log_group_identifiers instance-attribute

log_group_identifiers: NotRequired[LogGroupIdentifiers]

The log groups to query. Each entry can be a log group name or ARN. Use the ARN form when querying log groups in a different account (for example, when running cross-account queries from a monitoring account). The list must contain between 1 and 50 entries.

query_arn instance-attribute

query_arn: NotRequired[AmazonResourceName]

The Amazon Resource Name (ARN) of the CloudWatch Logs scheduled query that the alarm uses. This field is populated in DescribeAlarms responses.

query_string instance-attribute

query_string: NotRequired[QueryString]

The CloudWatch Logs query to execute on each scheduled run. Length constraints: maximum of 10,000 characters.

schedule_configuration instance-attribute

schedule_configuration: NotRequired[ScheduleConfiguration]

The schedule and time-range offset configuration for the underlying scheduled query.

scheduled_query_role_arn instance-attribute

scheduled_query_role_arn: NotRequired[AmazonResourceName]

The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes when executing the scheduled query against the configured log groups.

tags instance-attribute

tags: NotRequired[TagList]

A list of key-value pairs to associate with the underlying scheduled query resource.