Amazon CloudWatch Cloudwatch Alarm Mute Rule API

openapi: 3.2.0
info:
  title: Amazon CloudWatch Alarm Mute Rule API
  version: '2010-08-01'
  description: Generated from AWS's published Smithy model for Amazon CloudWatch. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://monitoring.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Alarm Mute Rule
paths:
  /#DeleteAlarmMuteRule:
    post:
      operationId: DeleteAlarmMuteRule
      summary: Delete Alarm Mute Rule
      description: Deletes a specific alarm mute rule. When you delete a mute rule, any alarms that are currently being muted by that rule are immediately unmuted. If those alarms are in an ALARM state, their configured actions will trigger. This operation is idempotent. If you delete a mute rule that does not exist, the operation succeeds without returning an error. Permissions To delete a mute rule, you need the cloudwatch:DeleteAlarmMuteRule permission on the alarm mute rule resource.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                type: string
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GraniteServiceVersion20100801.DeleteAlarmMuteRule
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DeleteAlarmMuteRuleInput'
      tags:
      - Alarm Mute Rule
  /#GetAlarmMuteRule:
    post:
      operationId: GetAlarmMuteRule
      summary: 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.'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GetAlarmMuteRuleOutput'
        '404':
          description: ResourceNotFoundException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GraniteServiceVersion20100801.GetAlarmMuteRule
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/GetAlarmMuteRuleInput'
      tags:
      - Alarm Mute Rule
  /#ListAlarmMuteRules:
    post:
      operationId: ListAlarmMuteRules
      summary: List Alarm Mute Rules
      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.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ListAlarmMuteRulesOutput'
        '400':
          description: InvalidNextToken
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidNextToken'
        '404':
          description: ResourceNotFoundException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GraniteServiceVersion20100801.ListAlarmMuteRules
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ListAlarmMuteRulesInput'
      tags:
      - Alarm Mute Rule
  /#PutAlarmMuteRule:
    post:
      operationId: PutAlarmMuteRule
      summary: Put Alarm Mute Rule
      description: 'Creates or updates an alarm mute rule. Alarm mute rules automatically mute alarm actions during predefined time windows. When a mute rule is active, targeted alarms continue to evaluate metrics and transition between states, but their configured actions (such as Amazon SNS notifications or Auto Scaling actions) are muted. You can create mute rules with recurring schedules using cron expressions or one-time mute windows using at expressions. Each mute rule can target up to 100 specific alarms by name. If you specify a rule name that already exists, this operation updates the existing rule with the new configuration. Permissions To create or update a mute rule, you must have the cloudwatch:PutAlarmMuteRule permission on two types of resources: the alarm mute rule resource itself, and each alarm that the rule targets. For example, If you want to allow a user to create mute rules that target only specific alarms named "WebServerCPUAlarm" and "DatabaseConnectionAlarm", you would create an IAM policy with one statement granting cloudwatch:PutAlarmMuteRule on the alarm mute rule resource (arn:aws:cloudwatch:[REGION]:123456789012:alarm-mute-rule:*), and another statement granting cloudwatc'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                type: string
        '400':
          description: LimitExceededFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/LimitExceededFault'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GraniteServiceVersion20100801.PutAlarmMuteRule
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/PutAlarmMuteRuleInput'
      tags:
      - Alarm Mute Rule
components:
  schemas:
    MuteTargets:
      type: object
      properties:
        AlarmNames:
          type: array
          items:
            type: string
          description: 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.
      required:
      - AlarmNames
    AlarmMuteRuleSummary:
      type: object
      properties:
        AlarmMuteRuleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the alarm mute rule.
        ExpireDate:
          type: string
          format: date-time
          description: The date and time when the mute rule expires and is no longer evaluated. This field is only present if an expiration date was configured.
        Status:
          type: string
          enum:
          - SCHEDULED
          - ACTIVE
          - EXPIRED
          description: The current status of the alarm mute rule. Valid values are SCHEDULED, ACTIVE, or EXPIRED.
        MuteType:
          type: string
          description: Indicates whether the mute rule is one-time or recurring. Valid values are ONE_TIME or RECURRING.
        LastUpdatedTimestamp:
          type: string
          format: date-time
          description: The date and time when the mute rule was last updated.
    ListAlarmMuteRulesInput:
      type: object
      properties:
        AlarmName:
          type: string
          description: Filter results to show only mute rules that target the specified alarm name.
        Statuses:
          type: array
          items:
            type: string
            enum:
            - SCHEDULED
            - ACTIVE
            - EXPIRED
          description: Filter results to show only mute rules with the specified statuses. Valid values are SCHEDULED, ACTIVE, or EXPIRED.
        MaxRecords:
          type: integer
          description: The maximum number of mute rules to return in one call. The default is 50.
        NextToken:
          type: string
          description: The token returned from a previous call to indicate where to continue retrieving results.
    PutAlarmMuteRuleInput:
      type: object
      properties:
        Name:
          type: string
          description: The name of the alarm mute rule. This name must be unique within your Amazon Web Services account and region.
        Description:
          type: string
          description: A description of the alarm mute rule that helps you identify its purpose.
        Rule:
          $ref: '#/components/schemas/Rule'
        MuteTargets:
          $ref: '#/components/schemas/MuteTargets'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of key-value pairs to associate with the alarm mute rule. You can use tags to categorize and manage your mute rules.
        StartDate:
          type: string
          format: date-time
          description: 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.
        ExpireDate:
          type: string
          format: date-time
          description: 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.
      required:
      - Name
      - Rule
    ResourceNotFoundException:
      type: object
      properties:
        ResourceType:
          type: string
        ResourceId:
          type: string
        Message:
          type: string
    LimitExceededFault:
      type: object
      properties:
        message:
          type: string
    ListAlarmMuteRulesOutput:
      type: object
      properties:
        AlarmMuteRuleSummaries:
          type: array
          items:
            $ref: '#/components/schemas/AlarmMuteRuleSummary'
          description: A list of alarm mute rule summaries.
        NextToken:
          type: string
          description: The token to use when requesting the next set of results. If this field is absent, there are no more results to retrieve.
    InvalidNextToken:
      type: object
      properties:
        message:
          type: string
    GetAlarmMuteRuleInput:
      type: object
      properties:
        AlarmMuteRuleName:
          type: string
          description: The name of the alarm mute rule to retrieve.
      required:
      - AlarmMuteRuleName
    GetAlarmMuteRuleOutput:
      type: object
      properties:
        Name:
          type: string
          description: The name of the alarm mute rule.
        AlarmMuteRuleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the alarm mute rule.
        Description:
          type: string
          description: The description of the alarm mute rule.
        Rule:
          $ref: '#/components/schemas/Rule'
        MuteTargets:
          $ref: '#/components/schemas/MuteTargets'
        StartDate:
          type: string
          format: date-time
          description: The date and time when the mute rule becomes active. If not set, the rule is active immediately.
        ExpireDate:
          type: string
          format: date-time
          description: The date and time when the mute rule expires and is no longer evaluated.
        Status:
          type: string
          enum:
          - SCHEDULED
          - ACTIVE
          - EXPIRED
          description: The current status of the alarm mute rule. Valid values are SCHEDULED, ACTIVE, or EXPIRED.
        LastUpdatedTimestamp:
          type: string
          format: date-time
          description: The date and time when the mute rule was last updated.
        MuteType:
          type: string
          description: Indicates whether the mute rule is one-time or recurring. Valid values are ONE_TIME or RECURRING.
    Schedule:
      type: object
      properties:
        Expression:
          type: string
          description: '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 * * *) - Activ'
        Duration:
          type: string
          description: '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 recu'
        Timezone:
          type: string
          description: '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'
      required:
      - Expression
      - Duration
    DeleteAlarmMuteRuleInput:
      type: object
      properties:
        AlarmMuteRuleName:
          type: string
          description: The name of the alarm mute rule to delete.
      required:
      - AlarmMuteRuleName
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.
        Value:
          type: string
          description: The value for the specified tag key.
      required:
      - Key
      - Value
    Rule:
      type: object
      properties:
        Schedule:
          $ref: '#/components/schemas/Schedule'
      required:
      - Schedule
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: monitoring
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/cloudwatch/service/2010-08-01/cloudwatch-2010-08-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)