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
 
The AlarmHistoryItem data type contains descriptive information about the history of a specific alarm. If you call DescribeAlarmHistory, Amazon CloudWatch returns this data type as part of the DescribeAlarmHistoryResult data type.

Inheritance Hierarchy

System.Object
  Amazon.CloudWatch.Model.AlarmHistoryItem

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

Syntax

C#
public class AlarmHistoryItem : Object

The AlarmHistoryItem type exposes the following members

Constructors

NameDescription
Public Method AlarmHistoryItem()

Properties

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

The descriptive name for the alarm.

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

Machine-readable data about the alarm in JSON format.

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

The type of alarm history item.

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

A human-readable summary of the alarm history.

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

The time stamp for the alarm history item.

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