IAmazonCloudWatch.DescribeAlarms Method (DescribeAlarmsRequest)

Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm name, the alarm state, or a prefix for any action.

To use this operation and return information about composite alarms, you must be signed on with the cloudwatch:DescribeAlarms permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarms permission has a narrower scope.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to DescribeAlarmsAsync.

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

Syntax

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: DescribeAlarmsResponse

The response from the DescribeAlarms service method, as returned by CloudWatch.

Exceptions

Exception	Condition
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

IAmazonCloudWatch.DescribeAlarms (DescribeAlarmsRequest)

Method