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

.NET Framework 3.5
 
Container for the parameters to the DescribeAlarmHistory operation. Retrieves history for the specified alarm. Filter alarms by date range or item type. If an alarm name is not specified, Amazon CloudWatch returns histories for all of the owner's alarms. Amazon CloudWatch retains the history of an alarm for two weeks, whether or not you delete the alarm.

Inheritance Hierarchy

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

Namespace: Amazon.CloudWatch.Model
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public class DescribeAlarmHistoryRequest : AmazonCloudWatchRequest
         IRequestEvents

The DescribeAlarmHistoryRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AlarmName System.String Gets and sets the property AlarmName.

The name of the alarm.

Public Property EndDate System.DateTime Gets and sets the property EndDate.

The ending date to retrieve alarm history.

Public Property HistoryItemType Amazon.CloudWatch.HistoryItemType Gets and sets the property HistoryItemType.

The type of alarm histories to retrieve.

Public Property MaxRecords System.Int32 Gets and sets the property MaxRecords.

The maximum number of alarm history records to retrieve.

Public Property NextToken System.String Gets and sets the property NextToken.

The token returned by a previous call to indicate that there is more data available.

Public Property StartDate System.DateTime Gets and sets the property StartDate.

The starting date to retrieve alarm history.

Examples

This example shows how to get history for an alarm.

Get alarm history example

var client = new AmazonCloudWatchClient();

var request = new DescribeAlarmHistoryRequest
{
  AlarmName =
    "awseb-e-kkbEXAMPLE-stack-CloudwatchAlarmLow-1WVXD9EXAMPLE",
  EndDate = DateTime.Today,
  HistoryItemType = HistoryItemType.Action,
  MaxRecords = 1,
  StartDate = DateTime.Today.Subtract(TimeSpan.FromDays(30))
};

var response = new DescribeAlarmHistoryResponse();

do
{
  response = client.DescribeAlarmHistory(request);

  foreach (var item in response.AlarmHistoryItems)
  {
    Console.WriteLine(item.AlarmName);
    Console.WriteLine(item.HistorySummary);
    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