CloudWatch / Client / get_alarm_mute_rule

get_alarm_mute_rule¶

CloudWatch.Client.get_alarm_mute_rule(**kwargs)¶

Retrieves details for a specific alarm mute rule.

This operation returns complete information about the mute rule, including its configuration, status, targeted alarms, and metadata.

The returned status indicates the current state of the mute rule:

SCHEDULED: The mute rule is configured and will become active in the future
ACTIVE: The mute rule is currently muting alarm actions
EXPIRED: The mute rule has passed its expiration date and will no longer become active

Permissions

To retrieve details for a mute rule, you need the cloudwatch:GetAlarmMuteRule permission on the alarm mute rule resource.

Request Syntax

response = client.get_alarm_mute_rule(
    AlarmMuteRuleName='string'
)

Parameters:

AlarmMuteRuleName (string) –

[REQUIRED]

The name of the alarm mute rule to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'Name': 'string',
    'AlarmMuteRuleArn': 'string',
    'Description': 'string',
    'Rule': {
        'Schedule': {
            'Expression': 'string',
            'Duration': 'string',
            'Timezone': 'string'
        }
    },
    'MuteTargets': {
        'AlarmNames': [
            'string',
        ]
    },
    'StartDate': datetime(2015, 1, 1),
    'ExpireDate': datetime(2015, 1, 1),
    'Status': 'SCHEDULED'|'ACTIVE'|'EXPIRED',
    'LastUpdatedTimestamp': datetime(2015, 1, 1),
    'MuteType': 'string'
}

Response Structure

(dict) –
- Name (string) –
  
  The name of the alarm mute rule.
- AlarmMuteRuleArn (string) –
  
  The Amazon Resource Name (ARN) of the alarm mute rule.
- Description (string) –
  
  The description of the alarm mute rule.
- Rule (dict) –
  
  The configuration that defines when and how long alarms are muted.
  - Schedule (dict) –
    
    The schedule configuration that defines when the mute rule activates and how long it remains active.
    - Expression (string) –
      
      The schedule expression that defines when the mute rule activates. The expression must be between 1 and 256 characters in length.
      
      You can use one of two expression formats:
      - Cron expressions - For recurring mute windows. Format: cron(Minutes Hours Day-of-month Month Day-of-week) Examples:
        
        cron(0 2 * * *) - Activates daily at 2:00 AM
        
        cron(0 2 * * SUN) - Activates every Sunday at 2:00 AM for weekly system maintenance
        
        cron(0 1 1 * *) - Activates on the first day of each month at 1:00 AM for monthly database maintenance
        
        cron(0 18 * * FRI) - Activates every Friday at 6:00 PM
        
        cron(0 23 * * *) - Activates every day at 11:00 PM during nightly backup operations
      The characters *, -, and , are supported in all fields. English names can be used for the month (JAN-DEC) and day of week (SUN-SAT) fields.
      - At expressions - For one-time mute windows. Format: at(yyyy-MM-ddThh:mm) Examples:
        
        at(2024-05-10T14:00) - Activates once on May 10, 2024 at 2:00 PM during an active incident response session
        
        at(2024-12-23T00:00) - Activates once on December 23, 2024 at midnight during annual company shutdown
    - Duration (string) –
      
      The length of time that alarms remain muted when the schedule activates. The duration must be between 1 and 50 characters in length.
      
      Specify the duration using ISO 8601 duration format with a minimum of 1 minute ( PT1M) and maximum of 15 days ( P15D).
      
      Examples:
      - PT4H - 4 hours for weekly system maintenance
      - P2DT12H - 2 days and 12 hours for weekend muting from Friday 6:00 PM to Monday 6:00 AM
      - PT6H - 6 hours for monthly database maintenance
      - PT2H - 2 hours for nightly backup operations
      - P7D - 7 days for annual company shutdown
      The duration begins when the schedule expression time is reached. For recurring schedules, the duration applies to each occurrence.
    - Timezone (string) –
      
      The time zone to use when evaluating the schedule expression. The time zone must be between 1 and 50 characters in length.
      
      Specify the time zone using standard timezone identifiers (for example, America/New_York, Europe/London, or Asia/Tokyo).
      
      If you don’t specify a time zone, UTC is used by default. The time zone affects how cron and at expressions are interpreted, as well as start and expire dates you specify
      
      Examples:
      - America/New_York - Eastern Time (US)
      - America/Los_Angeles - Pacific Time (US)
      - Europe/London - British Time
      - Asia/Tokyo - Japan Standard Time
      - UTC - Coordinated Universal Time
- MuteTargets (dict) –
  
  Specifies which alarms this rule applies to.
  - AlarmNames (list) –
    
    The list of alarm names that this mute rule targets. You can specify up to 100 alarm names.
    
    Each alarm name must be between 1 and 255 characters in length. The alarm names must match existing alarms in your Amazon Web Services account and region.
    - (string) –
- StartDate (datetime) –
  
  The date and time when the mute rule becomes active. If not set, the rule is active immediately.
- ExpireDate (datetime) –
  
  The date and time when the mute rule expires and is no longer evaluated.
- Status (string) –
  
  The current status of the alarm mute rule. Valid values are SCHEDULED, ACTIVE, or EXPIRED.
- LastUpdatedTimestamp (datetime) –
  
  The date and time when the mute rule was last updated.
- MuteType (string) –
  
  Indicates whether the mute rule is one-time or recurring. Valid values are ONE_TIME or RECURRING.

Exceptions

CloudWatch.Client.exceptions.ResourceNotFoundException