Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.CloudWatch.AmazonCloudWatchRequest
Amazon.CloudWatch.Model.DescribeAlarmsRequest
Namespace: Amazon.CloudWatch.Model
Assembly: AWSSDK.dll
Version: (assembly version)
Syntax
public class DescribeAlarmsRequest : AmazonCloudWatchRequest IRequestEvents
The DescribeAlarmsRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
DescribeAlarmsRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
ActionPrefix | System.String |
Gets and sets the property ActionPrefix.
The action name prefix. |
|
|
AlarmNamePrefix | System.String |
Gets and sets the property AlarmNamePrefix.
The alarm name prefix. |
|
|
AlarmNames | System.Collections.Generic.List<System.String> |
Gets and sets the property AlarmNames.
A list of alarm names to retrieve information for. |
|
|
MaxRecords | System.Int32 |
Gets and sets the property MaxRecords.
The maximum number of alarm descriptions to retrieve. |
|
|
NextToken | System.String |
Gets and sets the property NextToken.
The token returned by a previous call to indicate that there is more data available. |
|
|
StateValue | Amazon.CloudWatch.StateValue |
Gets and sets the property StateValue.
The state value to be used in matching alarms. |
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
.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8
.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8