Skip to content

Get Alarm Mute Rule

cloudwatch_get_alarm_mute_rule R Documentation

Retrieves details for a specific alarm mute rule

Description

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.

Usage

cloudwatch_get_alarm_mute_rule(AlarmMuteRuleName)

Arguments

AlarmMuteRuleName

[required] The name of the alarm mute rule to retrieve.

Value

A list with the following syntax:

list(
  Name = "string",
  AlarmMuteRuleArn = "string",
  Description = "string",
  Rule = list(
    Schedule = list(
      Expression = "string",
      Duration = "string",
      Timezone = "string"
    )
  ),
  MuteTargets = list(
    AlarmNames = list(
      "string"
    )
  ),
  StartDate = as.POSIXct(
    "2015-01-01"
  ),
  ExpireDate = as.POSIXct(
    "2015-01-01"
  ),
  Status = "SCHEDULED"|"ACTIVE"|"EXPIRED",
  LastUpdatedTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  MuteType = "string"
)

Request syntax

svc$get_alarm_mute_rule(
  AlarmMuteRuleName = "string"
)