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.

Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.

Note:

For PCL this operation is only available in asynchronous form. Please refer to DescribeAlarmsForMetricAsync.

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

Syntax

C#
public virtual DescribeAlarmsForMetricResponse DescribeAlarmsForMetric(
         DescribeAlarmsForMetricRequest request
)
Parameters
request
Type: Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest

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

Return Value
The response from the DescribeAlarmsForMetric service method, as returned by CloudWatch.

Examples

This example shows how to get information about all alarms for a metric.

Get metric alarms example

var client = new AmazonCloudWatchClient();

var dimension = new Dimension
{
  Name = "AutoScalingGroupName",
  Value = "awseb-e-kkbEXAMPLE-stack-AutoScalingGroup-F4TAUEXAMPLE"
};

var request = new DescribeAlarmsForMetricRequest
{
  Dimensions = new List() { dimension },
  MetricName = "NetworkOut",
  Namespace = "AWS/EC2"
};

var response = client.DescribeAlarmsForMetric(request);

if (response.MetricAlarms.Count > 0)
{
  foreach (var alarm in response.MetricAlarms)
  {
    Console.WriteLine();
    Console.WriteLine(alarm.AlarmName);
    Console.WriteLine(alarm.AlarmDescription);
    Console.WriteLine(alarm.MetricName + " " +
      alarm.ComparisonOperator + " " + alarm.Threshold);
  }
}
else
{
  Console.WriteLine("No alarms.");
}
      

Version Information

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also