List Alarm Mute Rules

cloudwatch_list_alarm_mute_rules

R Documentation

Lists alarm mute rules in your Amazon Web Services account and region¶

Description¶

Lists alarm mute rules in your Amazon Web Services account and region.

You can filter the results by alarm name to find all mute rules targeting a specific alarm, or by status to find rules that are scheduled, active, or expired.

This operation supports pagination for accounts with many mute rules. Use the MaxRecords and NextToken parameters to retrieve results in multiple calls.

Permissions

To list mute rules, you need the cloudwatch:ListAlarmMuteRules permission.

Usage¶

cloudwatch_list_alarm_mute_rules(AlarmName, Statuses, MaxRecords,
  NextToken)

Arguments¶

AlarmName

Filter results to show only mute rules that target the specified alarm name.

Statuses

Filter results to show only mute rules with the specified statuses. Valid values are SCHEDULED, ACTIVE, or EXPIRED.

MaxRecords

The maximum number of mute rules to return in one call. The default is 50.

NextToken

The token returned from a previous call to indicate where to continue retrieving results.

Value¶

A list with the following syntax:

list(
  AlarmMuteRuleSummaries = list(
    list(
      AlarmMuteRuleArn = "string",
      ExpireDate = as.POSIXct(
        "2015-01-01"
      ),
      Status = "SCHEDULED"|"ACTIVE"|"EXPIRED",
      MuteType = "string",
      LastUpdatedTimestamp = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_alarm_mute_rules(
  AlarmName = "string",
  Statuses = list(
    "SCHEDULED"|"ACTIVE"|"EXPIRED"
  ),
  MaxRecords = 123,
  NextToken = "string"
)