@aws-sdk/client-cloudwatch 3.995.0 → 3.997.0

package/dist-types/commands/GetAlarmMuteRuleCommand.d.ts

@@ -0,0 +1,116 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient";
+import type { GetAlarmMuteRuleInput, GetAlarmMuteRuleOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetAlarmMuteRuleCommand}.
+ */
+export interface GetAlarmMuteRuleCommandInput extends GetAlarmMuteRuleInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetAlarmMuteRuleCommand}.
+ */
+export interface GetAlarmMuteRuleCommandOutput extends GetAlarmMuteRuleOutput, __MetadataBearer {
+}
+declare const GetAlarmMuteRuleCommand_base: {
+    new (input: GetAlarmMuteRuleCommandInput): import("@smithy/smithy-client").CommandImpl<GetAlarmMuteRuleCommandInput, GetAlarmMuteRuleCommandOutput, CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: GetAlarmMuteRuleCommandInput): import("@smithy/smithy-client").CommandImpl<GetAlarmMuteRuleCommandInput, GetAlarmMuteRuleCommandOutput, CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Retrieves details for a specific alarm mute rule.</p>
+ *          <p>This operation returns complete information about the mute rule, including its configuration, status, targeted alarms, and metadata.</p>
+ *          <p>The returned status indicates the current state of the mute rule:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <b>SCHEDULED</b>: The mute rule is configured and will become active in the future</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <b>ACTIVE</b>: The mute rule is currently muting alarm actions</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <b>EXPIRED</b>: The mute rule has passed its expiration date and will no longer become active</p>
+ *             </li>
+ *          </ul>
+ *          <p>
+ *             <b>Permissions</b>
+ *          </p>
+ *          <p>To retrieve details for a mute rule, you need the <code>cloudwatch:GetAlarmMuteRule</code> permission on the alarm mute rule resource.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CloudWatchClient, GetAlarmMuteRuleCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
+ * // const { CloudWatchClient, GetAlarmMuteRuleCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
+ * // import type { CloudWatchClientConfig } from "@aws-sdk/client-cloudwatch";
+ * const config = {}; // type is CloudWatchClientConfig
+ * const client = new CloudWatchClient(config);
+ * const input = { // GetAlarmMuteRuleInput
+ *   AlarmMuteRuleName: "STRING_VALUE", // required
+ * };
+ * const command = new GetAlarmMuteRuleCommand(input);
+ * const response = await client.send(command);
+ * // { // GetAlarmMuteRuleOutput
+ * //   Name: "STRING_VALUE",
+ * //   AlarmMuteRuleArn: "STRING_VALUE",
+ * //   Description: "STRING_VALUE",
+ * //   Rule: { // Rule
+ * //     Schedule: { // Schedule
+ * //       Expression: "STRING_VALUE", // required
+ * //       Duration: "STRING_VALUE", // required
+ * //       Timezone: "STRING_VALUE",
+ * //     },
+ * //   },
+ * //   MuteTargets: { // MuteTargets
+ * //     AlarmNames: [ // MuteTargetAlarmNameList // required
+ * //       "STRING_VALUE",
+ * //     ],
+ * //   },
+ * //   StartDate: new Date("TIMESTAMP"),
+ * //   ExpireDate: new Date("TIMESTAMP"),
+ * //   Status: "SCHEDULED" || "ACTIVE" || "EXPIRED",
+ * //   LastUpdatedTimestamp: new Date("TIMESTAMP"),
+ * //   MuteType: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param GetAlarmMuteRuleCommandInput - {@link GetAlarmMuteRuleCommandInput}
+ * @returns {@link GetAlarmMuteRuleCommandOutput}
+ * @see {@link GetAlarmMuteRuleCommandInput} for command's `input` shape.
+ * @see {@link GetAlarmMuteRuleCommandOutput} for command's `response` shape.
+ * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The named resource does not exist.</p>
+ *
+ * @throws {@link CloudWatchServiceException}
+ * <p>Base exception class for all service exceptions from CloudWatch service.</p>
+ *
+ *
+ * @public
+ */
+export declare class GetAlarmMuteRuleCommand extends GetAlarmMuteRuleCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetAlarmMuteRuleInput;
+            output: GetAlarmMuteRuleOutput;
+        };
+        sdk: {
+            input: GetAlarmMuteRuleCommandInput;
+            output: GetAlarmMuteRuleCommandOutput;
+        };
+    };
+}

package/dist-types/commands/ListAlarmMuteRulesCommand.d.ts

@@ -0,0 +1,100 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient";
+import type { ListAlarmMuteRulesInput, ListAlarmMuteRulesOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListAlarmMuteRulesCommand}.
+ */
+export interface ListAlarmMuteRulesCommandInput extends ListAlarmMuteRulesInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListAlarmMuteRulesCommand}.
+ */
+export interface ListAlarmMuteRulesCommandOutput extends ListAlarmMuteRulesOutput, __MetadataBearer {
+}
+declare const ListAlarmMuteRulesCommand_base: {
+    new (input: ListAlarmMuteRulesCommandInput): import("@smithy/smithy-client").CommandImpl<ListAlarmMuteRulesCommandInput, ListAlarmMuteRulesCommandOutput, CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [ListAlarmMuteRulesCommandInput]): import("@smithy/smithy-client").CommandImpl<ListAlarmMuteRulesCommandInput, ListAlarmMuteRulesCommandOutput, CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Lists alarm mute rules in your Amazon Web Services account and region.</p>
+ *          <p>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.</p>
+ *          <p>This operation supports pagination for accounts with many mute rules. Use the <code>MaxRecords</code> and <code>NextToken</code> parameters to retrieve results in multiple calls.</p>
+ *          <p>
+ *             <b>Permissions</b>
+ *          </p>
+ *          <p>To list mute rules, you need the <code>cloudwatch:ListAlarmMuteRules</code> permission.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CloudWatchClient, ListAlarmMuteRulesCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
+ * // const { CloudWatchClient, ListAlarmMuteRulesCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
+ * // import type { CloudWatchClientConfig } from "@aws-sdk/client-cloudwatch";
+ * const config = {}; // type is CloudWatchClientConfig
+ * const client = new CloudWatchClient(config);
+ * const input = { // ListAlarmMuteRulesInput
+ *   AlarmName: "STRING_VALUE",
+ *   Statuses: [ // AlarmMuteRuleStatuses
+ *     "SCHEDULED" || "ACTIVE" || "EXPIRED",
+ *   ],
+ *   MaxRecords: Number("int"),
+ *   NextToken: "STRING_VALUE",
+ * };
+ * const command = new ListAlarmMuteRulesCommand(input);
+ * const response = await client.send(command);
+ * // { // ListAlarmMuteRulesOutput
+ * //   AlarmMuteRuleSummaries: [ // AlarmMuteRuleSummaries
+ * //     { // AlarmMuteRuleSummary
+ * //       AlarmMuteRuleArn: "STRING_VALUE",
+ * //       ExpireDate: new Date("TIMESTAMP"),
+ * //       Status: "SCHEDULED" || "ACTIVE" || "EXPIRED",
+ * //       MuteType: "STRING_VALUE",
+ * //       LastUpdatedTimestamp: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListAlarmMuteRulesCommandInput - {@link ListAlarmMuteRulesCommandInput}
+ * @returns {@link ListAlarmMuteRulesCommandOutput}
+ * @see {@link ListAlarmMuteRulesCommandInput} for command's `input` shape.
+ * @see {@link ListAlarmMuteRulesCommandOutput} for command's `response` shape.
+ * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
+ *
+ * @throws {@link InvalidNextToken} (client fault)
+ *  <p>The next token specified is invalid.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The named resource does not exist.</p>
+ *
+ * @throws {@link CloudWatchServiceException}
+ * <p>Base exception class for all service exceptions from CloudWatch service.</p>
+ *
+ *
+ * @public
+ */
+export declare class ListAlarmMuteRulesCommand extends ListAlarmMuteRulesCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListAlarmMuteRulesInput;
+            output: ListAlarmMuteRulesOutput;
+        };
+        sdk: {
+            input: ListAlarmMuteRulesCommandInput;
+            output: ListAlarmMuteRulesCommandOutput;
+        };
+    };
+}

package/dist-types/commands/PutAlarmMuteRuleCommand.d.ts

@@ -0,0 +1,105 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient";
+import type { PutAlarmMuteRuleInput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link PutAlarmMuteRuleCommand}.
+ */
+export interface PutAlarmMuteRuleCommandInput extends PutAlarmMuteRuleInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link PutAlarmMuteRuleCommand}.
+ */
+export interface PutAlarmMuteRuleCommandOutput extends __MetadataBearer {
+}
+declare const PutAlarmMuteRuleCommand_base: {
+    new (input: PutAlarmMuteRuleCommandInput): import("@smithy/smithy-client").CommandImpl<PutAlarmMuteRuleCommandInput, PutAlarmMuteRuleCommandOutput, CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: PutAlarmMuteRuleCommandInput): import("@smithy/smithy-client").CommandImpl<PutAlarmMuteRuleCommandInput, PutAlarmMuteRuleCommandOutput, CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Creates or updates an alarm mute rule.</p>
+ *          <p>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.</p>
+ *          <p>You can create mute rules with recurring schedules using <code>cron</code> expressions or one-time mute windows using <code>at</code> expressions. Each mute rule can target up to 100 specific alarms by name.</p>
+ *          <p>If you specify a rule name that already exists, this operation updates the existing rule with the new configuration.</p>
+ *          <p>
+ *             <b>Permissions</b>
+ *          </p>
+ *          <p>To create or update a mute rule, you must have the <code>cloudwatch:PutAlarmMuteRule</code> permission on two types of resources: the alarm mute rule resource itself, and each alarm that the rule targets.</p>
+ *          <p>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 <code>cloudwatch:PutAlarmMuteRule</code> on the alarm mute rule resource (<code>arn:aws:cloudwatch:[REGION]:123456789012:alarm-mute:*</code>), and another statement granting <code>cloudwatch:PutAlarmMuteRule</code> on the targeted alarm resources (<code>arn:aws:cloudwatch:[REGION]:123456789012:alarm:WebServerCPUAlarm</code> and <code>arn:aws:cloudwatch:[REGION]:123456789012:alarm:DatabaseConnectionAlarm</code>).</p>
+ *          <p>You can also use IAM policy conditions to allow targeting alarms based on resource tags. For example, you can restrict users to create/update mute rules to only target alarms that have a specific tag key-value pair, such as <code>Team=TeamA</code>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CloudWatchClient, PutAlarmMuteRuleCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
+ * // const { CloudWatchClient, PutAlarmMuteRuleCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
+ * // import type { CloudWatchClientConfig } from "@aws-sdk/client-cloudwatch";
+ * const config = {}; // type is CloudWatchClientConfig
+ * const client = new CloudWatchClient(config);
+ * const input = { // PutAlarmMuteRuleInput
+ *   Name: "STRING_VALUE", // required
+ *   Description: "STRING_VALUE",
+ *   Rule: { // Rule
+ *     Schedule: { // Schedule
+ *       Expression: "STRING_VALUE", // required
+ *       Duration: "STRING_VALUE", // required
+ *       Timezone: "STRING_VALUE",
+ *     },
+ *   },
+ *   MuteTargets: { // MuteTargets
+ *     AlarmNames: [ // MuteTargetAlarmNameList // required
+ *       "STRING_VALUE",
+ *     ],
+ *   },
+ *   Tags: [ // TagList
+ *     { // Tag
+ *       Key: "STRING_VALUE", // required
+ *       Value: "STRING_VALUE", // required
+ *     },
+ *   ],
+ *   StartDate: new Date("TIMESTAMP"),
+ *   ExpireDate: new Date("TIMESTAMP"),
+ * };
+ * const command = new PutAlarmMuteRuleCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param PutAlarmMuteRuleCommandInput - {@link PutAlarmMuteRuleCommandInput}
+ * @returns {@link PutAlarmMuteRuleCommandOutput}
+ * @see {@link PutAlarmMuteRuleCommandInput} for command's `input` shape.
+ * @see {@link PutAlarmMuteRuleCommandOutput} for command's `response` shape.
+ * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
+ *
+ * @throws {@link LimitExceededFault} (client fault)
+ *  <p>The quota for alarms for this customer has already been reached.</p>
+ *
+ * @throws {@link CloudWatchServiceException}
+ * <p>Base exception class for all service exceptions from CloudWatch service.</p>
+ *
+ *
+ * @public
+ */
+export declare class PutAlarmMuteRuleCommand extends PutAlarmMuteRuleCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: PutAlarmMuteRuleInput;
+            output: {};
+        };
+        sdk: {
+            input: PutAlarmMuteRuleCommandInput;
+            output: PutAlarmMuteRuleCommandOutput;
+        };
+    };
+}

package/dist-types/commands/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./DeleteAlarmMuteRuleCommand";
 export * from "./DeleteAlarmsCommand";
 export * from "./DeleteAnomalyDetectorCommand";
 export * from "./DeleteDashboardsCommand";
@@ -13,17 +14,20 @@ export * from "./DisableAlarmActionsCommand";
 export * from "./DisableInsightRulesCommand";
 export * from "./EnableAlarmActionsCommand";
 export * from "./EnableInsightRulesCommand";
+export * from "./GetAlarmMuteRuleCommand";
 export * from "./GetDashboardCommand";
 export * from "./GetInsightRuleReportCommand";
 export * from "./GetMetricDataCommand";
 export * from "./GetMetricStatisticsCommand";
 export * from "./GetMetricStreamCommand";
 export * from "./GetMetricWidgetImageCommand";
+export * from "./ListAlarmMuteRulesCommand";
 export * from "./ListDashboardsCommand";
 export * from "./ListManagedInsightRulesCommand";
 export * from "./ListMetricStreamsCommand";
 export * from "./ListMetricsCommand";
 export * from "./ListTagsForResourceCommand";
+export * from "./PutAlarmMuteRuleCommand";
 export * from "./PutAnomalyDetectorCommand";
 export * from "./PutCompositeAlarmCommand";
 export * from "./PutDashboardCommand";

package/dist-types/models/enums.d.ts

@@ -38,6 +38,19 @@ export declare const HistoryItemType: {
  * @public
  */
 export type HistoryItemType = (typeof HistoryItemType)[keyof typeof HistoryItemType];
+/**
+ * @public
+ * @enum
+ */
+export declare const AlarmMuteRuleStatus: {
+    readonly ACTIVE: "ACTIVE";
+    readonly EXPIRED: "EXPIRED";
+    readonly SCHEDULED: "SCHEDULED";
+};
+/**
+ * @public
+ */
+export type AlarmMuteRuleStatus = (typeof AlarmMuteRuleStatus)[keyof typeof AlarmMuteRuleStatus];
 /**
  * @public
  * @enum