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.

Container for the parameters to the DescribeAlarmsForMetric operation. Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.

Inheritance Hierarchy

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

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

Syntax

C#
public class DescribeAlarmsForMetricRequest : AmazonCloudWatchRequest
         IAmazonWebServiceRequest

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 dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the call to succeed.

Public Property ExtendedStatistic System.String

Gets and sets the property ExtendedStatistic.

The percentile statistic for the metric. Specify a value between p0.0 and p100.

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, other than percentiles. For percentile statistics, use ExtendedStatistics.

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 },
  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 Standard:
Supported in: 1.3

.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