IAmazonCloudWatch.DescribeAlarmHistory Method (DescribeAlarmHistoryRequest)

Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.

CloudWatch retains the history of an alarm even if you delete the alarm.

To use this operation and return information about a composite alarm, you must be signed on with the cloudwatch:DescribeAlarmHistory permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarmHistory permission has a narrower scope.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to DescribeAlarmHistoryAsync.

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

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: 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

IAmazonCloudWatch.DescribeAlarmHistory (DescribeAlarmHistoryRequest)

Method