Skip to content

PutAlarmMuteRuleInput

Source code in docs_src/capo_cloudwatch/types/put_alarm_mute_rule_input.py
class PutAlarmMuteRuleInput(TypedDict, closed=True):
    name: NotRequired["capo_cloudwatch.types.name.Name"]
    """<p>The name of the alarm mute rule. This name must be unique within your Amazon Web Services account and region.</p>"""
    description: NotRequired["capo_cloudwatch.types.alarm_description.AlarmDescription"]
    """<p>A description of the alarm mute rule that helps you identify its purpose.</p>"""
    rule: NotRequired["capo_cloudwatch.types.rule.Rule"]
    """<p>The configuration that defines when and how long alarms should be muted.</p>"""
    mute_targets: NotRequired["capo_cloudwatch.types.mute_targets.MuteTargets"]
    """<p>Specifies which alarms this rule applies to.</p>"""
    tags: NotRequired["capo_cloudwatch.types.tag_list.TagList"]
    """<p>A list of key-value pairs to associate with the alarm mute rule. You can use tags to categorize and manage your mute rules.</p>"""
    start_date: NotRequired["capo_cloudwatch.types.timestamp.Timestamp"]
    """<p>The date and time after which the mute rule takes effect, specified as a timestamp in ISO 8601 format (for example, <code>2026-04-15T08:00:00Z</code>). If not specified, the mute rule takes effect immediately upon creation and the mutes are applied as per the schedule expression.</p>"""
    expire_date: NotRequired["capo_cloudwatch.types.timestamp.Timestamp"]
    """<p>The date and time when the mute rule expires and is no longer evaluated, specified as a timestamp in ISO 8601 format (for example, <code>2026-12-31T23:59:59Z</code>). After this time, the rule status becomes EXPIRED and will no longer mute the targeted alarms.</p>"""

description instance-attribute

description: NotRequired[AlarmDescription]

A description of the alarm mute rule that helps you identify its purpose.

expire_date instance-attribute

expire_date: NotRequired[Timestamp]

The date and time when the mute rule expires and is no longer evaluated, specified as a timestamp in ISO 8601 format (for example, 2026-12-31T23:59:59Z). After this time, the rule status becomes EXPIRED and will no longer mute the targeted alarms.

mute_targets instance-attribute

mute_targets: NotRequired[MuteTargets]

Specifies which alarms this rule applies to.

name instance-attribute

name: NotRequired[Name]

The name of the alarm mute rule. This name must be unique within your Amazon Web Services account and region.

rule instance-attribute

rule: NotRequired[Rule]

The configuration that defines when and how long alarms should be muted.

start_date instance-attribute

start_date: NotRequired[Timestamp]

The date and time after which the mute rule takes effect, specified as a timestamp in ISO 8601 format (for example, 2026-04-15T08:00:00Z). If not specified, the mute rule takes effect immediately upon creation and the mutes are applied as per the schedule expression.

tags instance-attribute

tags: NotRequired[TagList]

A list of key-value pairs to associate with the alarm mute rule. You can use tags to categorize and manage your mute rules.