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

.NET Framework 3.5
 
Implementation for accessing CloudWatch Amazon CloudWatch monitors your Amazon Web Services (AWS) resources and the applications you run on AWS in real-time. You can use CloudWatch to collect and track metrics, which are the variables you want to measure for your resources and applications.

CloudWatch alarms send notifications or automatically make changes to the resources you are monitoring based on rules that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon Elastic Compute Cloud (Amazon EC2) instances and then use this data to determine whether you should launch additional instances to handle increased load. You can also use this data to stop under-used instances to save money.

In addition to monitoring the built-in metrics that come with AWS, you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility into resource utilization, application performance, and operational health.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.CloudWatch.AmazonCloudWatchClient

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

Syntax

C#
public class AmazonCloudWatchClient : AmazonServiceClient
         IAmazonCloudWatch, IDisposable

The AmazonCloudWatchClient type exposes the following members

Constructors

NameDescription
Public Method AmazonCloudWatchClient() Constructs AmazonCloudWatchClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             
Public Method AmazonCloudWatchClient(RegionEndpoint) Constructs AmazonCloudWatchClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             
Public Method AmazonCloudWatchClient(AmazonCloudWatchConfig) Constructs AmazonCloudWatchClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             
Public Method AmazonCloudWatchClient(AWSCredentials) Constructs AmazonCloudWatchClient with AWS Credentials
Public Method AmazonCloudWatchClient(AWSCredentials, RegionEndpoint) Constructs AmazonCloudWatchClient with AWS Credentials
Public Method AmazonCloudWatchClient(AWSCredentials, AmazonCloudWatchConfig) Constructs AmazonCloudWatchClient with AWS Credentials and an AmazonCloudWatchClient Configuration object.
Public Method AmazonCloudWatchClient(string, string) Constructs AmazonCloudWatchClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonCloudWatchClient(string, string, RegionEndpoint) Constructs AmazonCloudWatchClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonCloudWatchClient(string, string, AmazonCloudWatchConfig) Constructs AmazonCloudWatchClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudWatchClient Configuration object.
Public Method AmazonCloudWatchClient(string, string, string) Constructs AmazonCloudWatchClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonCloudWatchClient(string, string, string, RegionEndpoint) Constructs AmazonCloudWatchClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonCloudWatchClient(string, string, string, AmazonCloudWatchConfig) Constructs AmazonCloudWatchClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudWatchClient Configuration object.

Methods

NameDescription
Public Method BeginDeleteAlarms(DeleteAlarmsRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeleteAlarms operation.
Public Method BeginDescribeAlarmHistory(DescribeAlarmHistoryRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeAlarmHistory operation.
Public Method BeginDescribeAlarms(DescribeAlarmsRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeAlarms operation.
Public Method BeginDescribeAlarmsForMetric(DescribeAlarmsForMetricRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeAlarmsForMetric operation.
Public Method BeginDisableAlarmActions(DisableAlarmActionsRequest, AsyncCallback, object) Initiates the asynchronous execution of the DisableAlarmActions operation.
Public Method BeginEnableAlarmActions(EnableAlarmActionsRequest, AsyncCallback, object) Initiates the asynchronous execution of the EnableAlarmActions operation.
Public Method BeginGetMetricStatistics(GetMetricStatisticsRequest, AsyncCallback, object) Initiates the asynchronous execution of the GetMetricStatistics operation.
Public Method BeginListMetrics(ListMetricsRequest, AsyncCallback, object) Initiates the asynchronous execution of the ListMetrics operation.
Public Method BeginPutMetricAlarm(PutMetricAlarmRequest, AsyncCallback, object) Initiates the asynchronous execution of the PutMetricAlarm operation.
Public Method BeginPutMetricData(PutMetricDataRequest, AsyncCallback, object) Initiates the asynchronous execution of the PutMetricData operation.
Public Method BeginSetAlarmState(SetAlarmStateRequest, AsyncCallback, object) Initiates the asynchronous execution of the SetAlarmState operation.
Public Method DeleteAlarms(DeleteAlarmsRequest) Deletes all specified alarms. In the event of an error, no alarms are deleted.
Public Method DescribeAlarmHistory() 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.
Public Method DescribeAlarmHistory(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.
Public Method DescribeAlarms() Retrieves alarms with the specified names. If no name is specified, all alarms for the user are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.
Public Method DescribeAlarms(DescribeAlarmsRequest) Retrieves alarms with the specified names. If no name is specified, all alarms for the user are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.
Public Method DescribeAlarmsForMetric(DescribeAlarmsForMetricRequest) Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further.
Public Method DisableAlarmActions(DisableAlarmActionsRequest) Disables actions for the specified alarms. When an alarm's actions are disabled the alarm's state may change, but none of the alarm's actions will execute.
Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method EnableAlarmActions(EnableAlarmActionsRequest) Enables actions for the specified alarms.
Public Method EndDeleteAlarms(IAsyncResult) Finishes the asynchronous execution of the DeleteAlarms operation.
Public Method EndDescribeAlarmHistory(IAsyncResult) Finishes the asynchronous execution of the DescribeAlarmHistory operation.
Public Method EndDescribeAlarms(IAsyncResult) Finishes the asynchronous execution of the DescribeAlarms operation.
Public Method EndDescribeAlarmsForMetric(IAsyncResult) Finishes the asynchronous execution of the DescribeAlarmsForMetric operation.
Public Method EndDisableAlarmActions(IAsyncResult) Finishes the asynchronous execution of the DisableAlarmActions operation.
Public Method EndEnableAlarmActions(IAsyncResult) Finishes the asynchronous execution of the EnableAlarmActions operation.
Public Method EndGetMetricStatistics(IAsyncResult) Finishes the asynchronous execution of the GetMetricStatistics operation.
Public Method EndListMetrics(IAsyncResult) Finishes the asynchronous execution of the ListMetrics operation.
Public Method EndPutMetricAlarm(IAsyncResult) Finishes the asynchronous execution of the PutMetricAlarm operation.
Public Method EndPutMetricData(IAsyncResult) Finishes the asynchronous execution of the PutMetricData operation.
Public Method EndSetAlarmState(IAsyncResult) Finishes the asynchronous execution of the SetAlarmState operation.
Public Method GetMetricStatistics(GetMetricStatisticsRequest) Gets statistics for the specified metric.

The maximum number of data points that can be queried is 50,850, whereas the maximum number of data points returned from a single GetMetricStatistics request is 1,440. If you make a request that generates more than 1,440 data points, Amazon CloudWatch returns an error. In such a case, you can alter the request by narrowing the specified time range or increasing the specified period. Alternatively, you can make multiple requests across adjacent time ranges. GetMetricStatistics does not return the data in chronological order.

Amazon CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-minute granularity, Amazon CloudWatch aggregates data points with time stamps that fall within the same one-minute period. In such a case, the data points queried can greatly outnumber the data points returned.

The following examples show various statistics allowed by the data point query maximum of 50,850 when you call GetMetricStatistics on Amazon EC2 instances with detailed (one-minute) monitoring enabled:

  • Statistics for up to 400 instances for a span of one hour
  • Statistics for up to 35 instances over a span of 24 hours
  • Statistics for up to 2 instances over a span of 2 weeks

For information about the namespace, metric names, and dimensions that other Amazon Web Services products use to send metrics to CloudWatch, go to Amazon CloudWatch Metrics, Namespaces, and Dimensions Reference in the Amazon CloudWatch Developer Guide.

Public Method ListMetrics() Returns a list of valid metrics stored for the AWS account owner. Returned metrics can be used with GetMetricStatistics to obtain statistical data for a given metric. Up to 500 results are returned for any one call. To retrieve further results, use returned NextToken values with subsequent ListMetrics operations. If you create a metric with the PutMetricData action, allow up to fifteen minutes for the metric to appear in calls to the ListMetrics action. Statistics about the metric, however, are available sooner using GetMetricStatistics.
Public Method ListMetrics(ListMetricsRequest) Returns a list of valid metrics stored for the AWS account owner. Returned metrics can be used with GetMetricStatistics to obtain statistical data for a given metric. Up to 500 results are returned for any one call. To retrieve further results, use returned NextToken values with subsequent ListMetrics operations. If you create a metric with the PutMetricData action, allow up to fifteen minutes for the metric to appear in calls to the ListMetrics action. Statistics about the metric, however, are available sooner using GetMetricStatistics.
Public Method PutMetricAlarm(PutMetricAlarmRequest) Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric. Optionally, this operation can associate one or more Amazon Simple Notification Service resources with the alarm.

When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is evaluated and its StateValue is set appropriately. Any actions associated with the StateValue is then executed.

When updating an existing alarm, its StateValue is left unchanged. If you are using an AWS Identity and Access Management (IAM) account to create or modify an alarm, you must have the following Amazon EC2 permissions:
  • ec2:DescribeInstanceStatus and ec2:DescribeInstances for all alarms on Amazon EC2 instance status metrics.
  • ec2:StopInstances for alarms with stop actions.
  • ec2:TerminateInstances for alarms with terminate actions.
  • ec2:DescribeInstanceRecoveryAttribute, and ec2:RecoverInstances for alarms with recover actions.

If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm but the stop or terminate actions won't be performed on the Amazon EC2 instance. However, if you are later granted permission to use the associated Amazon EC2 APIs, the alarm actions you created earlier will be performed. For more information about IAM permissions, see Permissions and Policies in Using IAM.

If you are using an IAM role (e.g., an Amazon EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies.

If you are using temporary security credentials granted using the AWS Security Token Service (AWS STS), you cannot stop or terminate an Amazon EC2 instance using alarm actions.

Public Method PutMetricData(PutMetricDataRequest) Publishes metric data points to Amazon CloudWatch. Amazon CloudWatch associates the data points with the specified metric. If the specified metric does not exist, Amazon CloudWatch creates the metric. When Amazon CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to the ListMetrics action.

Each PutMetricData request is limited to 8 KB in size for HTTP GET requests and is limited to 40 KB in size for HTTP POST requests.

Although the Value parameter accepts numbers of type Double, Amazon CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (e.g., NaN, +Infinity, -Infinity) are not supported.

Data that is timestamped 24 hours or more in the past may take in excess of 48 hours to become available from submission time using GetMetricStatistics.

Public Method SetAlarmState(SetAlarmStateRequest) Temporarily sets the state of an alarm. When the updated StateValue differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm's state to ALARM will send an Amazon SNS message. This is not a permanent change. The next periodic alarm check (in about a minute) will set the alarm to its actual state. Because the alarm state change happens very quickly, it is typically only visibile in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Examples

This example shows how to get statistics for a metric.

Get metric statistics example

var client = new AmazonCloudWatchClient();

var dimension = new Dimension
{
  Name = "InstanceType",
  Value = "t1.micro"
};

var request = new GetMetricStatisticsRequest
{
  Dimensions = new List<Dimension>() { dimension },
  EndTime = DateTime.Today,
  MetricName = "CPUUtilization",
  Namespace = "AWS/EC2",
  // Get statistics by day.
  Period = (int)TimeSpan.FromDays(1).TotalSeconds,
  // Get statistics for the past month.
  StartTime = DateTime.Today.Subtract(TimeSpan.FromDays(30)),
  Statistics = new List<string>() { "Minimum" },
  Unit = StandardUnit.Percent
};

var response = client.GetMetricStatistics(request);

if (response.Datapoints.Count > 0)
{
  foreach (var point in response.Datapoints)
  {
    Console.WriteLine(point.Timestamp.ToShortDateString() +
      " " + point.Minimum + "%");
  }
}
      

Version Information

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

.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8

.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8