DescribeAlarmsRequest Class | AWS SDK for .NET V3

Container for the parameters to the DescribeAlarms operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CloudWatch.AmazonCloudWatchRequest
      Amazon.CloudWatch.Model.DescribeAlarmsRequest

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

Syntax

public class DescribeAlarmsRequest : AmazonCloudWatchRequest
         IAmazonWebServiceRequest

The DescribeAlarmsRequest type exposes the following members

Constructors

	Name	Description
	DescribeAlarmsRequest()

Properties

Name	Type	Description
ActionPrefix	System.String	Gets and sets the property ActionPrefix. Use this parameter to filter the results of the operation to only those alarms that use a certain alarm action. For example, you could specify the ARN of an SNS topic to find all alarms that send notifications to that topic.
AlarmNamePrefix	System.String	Gets and sets the property AlarmNamePrefix. An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names that start with this prefix. If this parameter is specified, you cannot specify `AlarmNames`.
AlarmNames	System.Collections.Generic.List<System.String>	Gets and sets the property AlarmNames. The names of the alarms to retrieve information about.
AlarmTypes	System.Collections.Generic.List<System.String>	Gets and sets the property AlarmTypes. Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned, even if composite alarms exist in the account. For example, if you omit this parameter or specify `MetricAlarms`, the operation returns only a list of metric alarms. It does not return any composite alarms, even if composite alarms exist in the account. If you specify `CompositeAlarms`, the operation returns only a list of composite alarms, and does not return any metric alarms.
ChildrenOfAlarmName	System.String	Gets and sets the property ChildrenOfAlarmName. If you use this parameter and specify the name of a composite alarm, the operation returns information about the "children" alarms of the alarm you specify. These are the metric alarms and composite alarms referenced in the `AlarmRule` field of the composite alarm that you specify in `ChildrenOfAlarmName`. Information about the composite alarm that you name in `ChildrenOfAlarmName` is not returned. If you specify `ChildrenOfAlarmName`, you cannot specify any other parameters in the request except for `MaxRecords` and `NextToken`. If you do so, you receive a validation error. Only the `Alarm Name`, `ARN`, `StateValue` (OK/ALARM/INSUFFICIENT_DATA), and `StateUpdatedTimestamp` information are returned by this operation when you use this parameter. To get complete information about these alarms, perform another `DescribeAlarms` operation and specify the parent alarm names in the `AlarmNames` parameter.
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.
ParentsOfAlarmName	System.String	Gets and sets the property ParentsOfAlarmName. If you use this parameter and specify the name of a metric or composite alarm, the operation returns information about the "parent" alarms of the alarm you specify. These are the composite alarms that have `AlarmRule` parameters that reference the alarm named in `ParentsOfAlarmName`. Information about the alarm that you specify in `ParentsOfAlarmName` is not returned. If you specify `ParentsOfAlarmName`, you cannot specify any other parameters in the request except for `MaxRecords` and `NextToken`. If you do so, you receive a validation error. Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete information about these alarms, perform another `DescribeAlarms` operation and specify the parent alarm names in the `AlarmNames` parameter.
StateValue	Amazon.CloudWatch.StateValue	Gets and sets the property StateValue. Specify this parameter to receive information only about alarms that are currently in the state that you specify.

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 Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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