AWS CLI Command Reference

[ aws . cloudwatch ]

get-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.

See also: AWS API Documentation

Synopsis

  get-alarm-mute-rule
--alarm-mute-rule-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--alarm-mute-rule-name (string) [required]

The name of the alarm mute rule to retrieve.

Constraints:

  • min: 1
  • max: 255

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

Name -> (string)

The name of the alarm mute rule.

Constraints:

  • min: 1
  • max: 255

AlarmMuteRuleArn -> (string)

The Amazon Resource Name (ARN) of the alarm mute rule.

Constraints:

  • min: 1
  • max: 1600

Description -> (string)

The description of the alarm mute rule.

Constraints:

  • min: 0
  • max: 1024

Rule -> (structure)

The configuration that defines when and how long alarms are muted.

Schedule -> (structure) [required]

The schedule configuration that defines when the mute rule activates and how long it remains active.

Expression -> (string) [required]

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

Constraints:

  • min: 1
  • max: 256

Duration -> (string) [required]

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.

Constraints:

  • min: 1
  • max: 50

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

Constraints:

  • min: 1
  • max: 50

MuteTargets -> (structure)

Specifies which alarms this rule applies to.

AlarmNames -> (list) [required]

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.

Constraints:

  • max: 100

(string)

Constraints:

  • min: 1
  • max: 255

StartDate -> (timestamp)

The date and time when the mute rule becomes active. If not set, the rule is active immediately.

ExpireDate -> (timestamp)

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 .

Possible values:

  • SCHEDULED
  • ACTIVE
  • EXPIRED

LastUpdatedTimestamp -> (timestamp)

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 .
© Copyright 2026, Amazon Web Services. Created using Sphinx.