AWS SDK Version 4 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.

This is the response object from the DescribeAlarms operation.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.CloudWatch.Model.DescribeAlarmsResponse

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

Syntax

C#
public class DescribeAlarmsResponse : AmazonWebServiceResponse

The DescribeAlarmsResponse type exposes the following members

Constructors

NameDescription
Public Method DescribeAlarmsResponse()

Properties

NameTypeDescription
Public Property CompositeAlarms System.Collections.Generic.List<Amazon.CloudWatch.Model.CompositeAlarm>

Gets and sets the property CompositeAlarms.

The information about any composite alarms returned by the operation.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property MetricAlarms System.Collections.Generic.List<Amazon.CloudWatch.Model.MetricAlarm>

Gets and sets the property MetricAlarms.

The information about any metric alarms returned by the operation.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property NextToken System.String

Gets and sets the property NextToken.

The token that marks the start of the next batch of returned results.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.

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 = 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));
            

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer