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

Represents the history of a specific alarm.

Inheritance Hierarchy

System.Object
  Amazon.CloudWatch.Model.AlarmHistoryItem

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

Syntax

C#
public class AlarmHistoryItem

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.

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 summary of the alarm history, in text format.

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 Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms