IAmazonCloudWatch.DescribeAlarmHistory Method (DescribeAlarmHistoryRequest)

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.

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

Syntax

public abstract DescribeAlarmHistoryResponse DescribeAlarmHistory(
         DescribeAlarmHistoryRequest request
)

Parameters

request: Type: Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest

Container for the necessary parameters to execute the DescribeAlarmHistory service method.

Return Value

Type: Amazon.CloudWatch.Model.DescribeAlarmHistoryResponse
The response from the DescribeAlarmHistory service method, as returned by CloudWatch.

Exceptions

Exception	Condition
InvalidNextTokenException	The next token specified is invalid.

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