Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Class DeleteAlarmsCommandProtected

Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation.

If you specify an incorrect alarm name or make any other error in the operation, no alarms are deleted. To confirm that alarms were deleted successfully, you can use the DescribeAlarms operation after using DeleteAlarms.

It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.

To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to false.

Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

Example

Use a bare-bones client and the command you need to make an API call.

import { CloudWatchClient, DeleteAlarmsCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
// const { CloudWatchClient, DeleteAlarmsCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
const client = new CloudWatchClient(config);
const input = { // DeleteAlarmsInput
AlarmNames: [ // AlarmNames // required
"STRING_VALUE",
],
};
const command = new DeleteAlarmsCommand(input);
const response = await client.send(command);
// {};

Param

DeleteAlarmsCommandInput

Returns

DeleteAlarmsCommandOutput

See

Throws

ResourceNotFound (client fault)

The named resource does not exist.

Throws

CloudWatchServiceException

Base exception class for all service exceptions from CloudWatch service.

Hierarchy

Constructors

Properties

middlewareStack: MiddlewareStack<DeleteAlarmsCommandInput, DeleteAlarmsCommandOutput>

Methods