Container for the parameters to the DescribeAlarmHistory operation. 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.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.CloudWatch.AmazonCloudWatchRequest
Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest
Namespace: Amazon.CloudWatch.Model
Assembly: AWSSDK.CloudWatch.dll
Version: 3.x.y.z
Syntax
public class DescribeAlarmHistoryRequest : AmazonCloudWatchRequest IAmazonWebServiceRequest
The DescribeAlarmHistoryRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
DescribeAlarmHistoryRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
AlarmName | System.String |
Gets and sets the property AlarmName. The name of the alarm. |
|
|
AlarmTypes | System.Collections.Generic.List<System.String> |
Gets and sets the property AlarmTypes. Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. |
|
|
EndDate | System.Nullable<System.DateTime> |
Gets and sets the property EndDate. The ending date to retrieve alarm history. |
|
|
HistoryItemType | Amazon.CloudWatch.HistoryItemType |
Gets and sets the property HistoryItemType. The type of alarm histories to retrieve. |
|
|
MaxRecords | System.Nullable<System.Int32> |
Gets and sets the property MaxRecords. The maximum number of alarm history records to retrieve. |
|
|
NextToken | System.String |
Gets and sets the property NextToken. The token returned by a previous call to indicate that there is more data available. |
|
|
ScanBy | Amazon.CloudWatch.ScanBy |
Gets and sets the property ScanBy.
Specified whether to return the newest or oldest alarm history first. Specify |
|
|
StartDate | System.Nullable<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 = await client.DescribeAlarmHistoryAsync(request);
if (response.AlarmHistoryItems != null)
{
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:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.7.2 and newer