AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to DeleteAlarmsAsync.

Namespace: Amazon.CloudWatch
Assembly: AWSSDK.CloudWatch.dll
Version: 3.x.y.z

Syntax

C#
public abstract DeleteAlarmsResponse DeleteAlarms(
         DeleteAlarmsRequest request
)

Parameters

request
Type: Amazon.CloudWatch.Model.DeleteAlarmsRequest

Container for the necessary parameters to execute the DeleteAlarms service method.

Return Value


The response from the DeleteAlarms service method, as returned by CloudWatch.

Exceptions

ExceptionCondition
ResourceNotFoundException The named resource does not exist.

Examples

This example shows how to delete an alarm.

Delete alarm example

var client = new AmazonCloudWatchClient();

var request = new DeleteAlarmsRequest
{
  AlarmNames = new List<string>() { "t1.microCPUUtilization" }
};

client.DeleteAlarms(request);
      

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

See Also