Represents the history of a specific alarm.
Inheritance Hierarchy
Namespace: Amazon.CloudWatch.Model
Assembly: AWSSDK.CloudWatch.dll
Version: 3.x.y.z
Syntax
public class AlarmHistoryItem
The AlarmHistoryItem type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
AlarmHistoryItem() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
AlarmContributorAttributes | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property AlarmContributorAttributes. A map of attributes that describe the alarm contributor associated with this history item, providing context about the contributor's characteristics at the time of the event. 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. |
|
|
AlarmContributorId | System.String |
Gets and sets the property AlarmContributorId. The unique identifier of the alarm contributor associated with this history item, if applicable. |
|
|
AlarmName | System.String |
Gets and sets the property AlarmName. The descriptive name for the alarm. |
|
|
AlarmType | Amazon.CloudWatch.AlarmType |
Gets and sets the property AlarmType. The type of alarm, either metric alarm or composite alarm. |
|
|
HistoryData | System.String |
Gets and sets the property HistoryData. Data about the alarm, in JSON format. |
|
|
HistoryItemType | Amazon.CloudWatch.HistoryItemType |
Gets and sets the property HistoryItemType. The type of alarm history item. |
|
|
HistorySummary | System.String |
Gets and sets the property HistorySummary. A summary of the alarm history, in text format. |
|
|
Timestamp | System.Nullable<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 = 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