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

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

Syntax

C#
public abstract DescribeAlarmsResponse DescribeAlarms(
         DescribeAlarmsRequest request
)

Parameters

request
Type: Amazon.CloudWatch.Model.DescribeAlarmsRequest

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

Return Value
Type: Amazon.CloudWatch.Model.DescribeAlarmsResponse
The response from the DescribeAlarms service method, as returned by CloudWatch.

Exceptions

ExceptionCondition
InvalidNextTokenException The next token specified is invalid.

Examples

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<string>() 
    { "awseb-e-b36EXAMPLE-stack-CloudwatchAlarmLow-1KAKH4EXAMPLE" },
  MaxRecords = 1,
  StateValue = StateValue.ALARM
};

var response = new DescribeAlarmsResponse();

do
{
  response = client.DescribeAlarms(request);

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

  request.NextToken = response.NextToken;

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

Version Information

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