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.
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.
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
public virtual DescribeAlarmsResponse DescribeAlarms( DescribeAlarmsRequest request )
Container for the necessary parameters to execute the DescribeAlarms service method.
| Exception | Condition |
|---|---|
| InvalidNextTokenException | The next token specified is invalid. |
This example shows how to get information about an alarm.
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 = await client.DescribeAlarmsAsync(request);
if (response.MetricAlarms != null)
{
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));
.NET Framework:
Supported in: 4.7.2 and newer