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 DescribeAlarms operation. Retrieves the specified alarms. If no alarms are specified, all alarms are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.

Inheritance Hierarchy


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


public class DescribeAlarmsRequest : AmazonCloudWatchRequest

The DescribeAlarmsRequest type exposes the following members


Public Method DescribeAlarmsRequest()


Public Property ActionPrefix System.String

Gets and sets the property ActionPrefix.

The action name prefix.

Public Property AlarmNamePrefix System.String

Gets and sets the property AlarmNamePrefix.

The alarm name prefix. If this parameter is specified, you cannot specify AlarmNames.

Public Property AlarmNames System.Collections.Generic.List<System.String>

Gets and sets the property AlarmNames.

The names of the alarms.

Public Property MaxRecords System.Int32

Gets and sets the property MaxRecords.

The maximum number of alarm descriptions to retrieve.

Public Property NextToken System.String

Gets and sets the property NextToken.

The token returned by a previous call to indicate that there is more data available.

Public Property StateValue Amazon.CloudWatch.StateValue

Gets and sets the property StateValue.

The state value to be used in matching alarms.


This example shows how to get information about an alarm.

Get alarm information example

var client = new AmazonCloudWatchClient();

var request = new DescribeAlarmsRequest
  AlarmNames = new List() 
    { "awseb-e-b36EXAMPLE-stack-CloudwatchAlarmLow-1KAKH4EXAMPLE" },
  MaxRecords = 1,
  StateValue = StateValue.ALARM

var response = new DescribeAlarmsResponse();

  response = client.DescribeAlarms(request);

  foreach (var alarm in response.MetricAlarms)
    Console.WriteLine(alarm.MetricName + " " +
        alarm.ComparisonOperator + " " + alarm.Threshold);

  request.NextToken = response.NextToken;

} while (!string.IsNullOrEmpty(response.NextToken));

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