AWS SDK Version 2 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.

.NET Framework 4.5
 
Container for the parameters to the DescribeAlarmsForMetric operation. Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CloudWatch.AmazonCloudWatchRequest
      Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest

Namespace: Amazon.CloudWatch.Model
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public class DescribeAlarmsForMetricRequest : AmazonCloudWatchRequest
         IRequestEvents

The DescribeAlarmsForMetricRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property Dimensions System.Collections.Generic.List<Amazon.CloudWatch.Model.Dimension> Gets and sets the property Dimensions.

The list of dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the DescribeAlarmsForMetric to succeed.

Public Property MetricName System.String Gets and sets the property MetricName.

The name of the metric.

Public Property Namespace System.String Gets and sets the property Namespace.

The namespace of the metric.

Public Property Period System.Int32 Gets and sets the property Period.

The period in seconds over which the statistic is applied.

Public Property Statistic Amazon.CloudWatch.Statistic Gets and sets the property Statistic.

The statistic for the metric.

Public Property Unit Amazon.CloudWatch.StandardUnit Gets and sets the property Unit.

The unit for the metric.

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>() { 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

.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8

.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8