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
 

Classes

NameDescription
Class AlarmHistoryItem The AlarmHistoryItem data type contains descriptive information about the history of a specific alarm. If you call DescribeAlarmHistory, Amazon CloudWatch returns this data type as part of the DescribeAlarmHistoryResult data type.
Class Datapoint The Datapoint data type encapsulates the statistical data that Amazon CloudWatch computes from metric data.
Class DeleteAlarmsRequest Container for the parameters to the DeleteAlarms operation. Deletes all specified alarms. In the event of an error, no alarms are deleted.
Class DeleteAlarmsResponse
Class DescribeAlarmHistoryRequest Container for the parameters to the DescribeAlarmHistory operation. 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.
Class DescribeAlarmHistoryResponse Configuration for accessing Amazon DescribeAlarmHistory service
Class DescribeAlarmHistoryResult The output for the DescribeAlarmHistory action.
Class DescribeAlarmsForMetricRequest Container for the parameters to the DescribeAlarmsForMetric operation. Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further.
Class DescribeAlarmsForMetricResponse Configuration for accessing Amazon DescribeAlarmsForMetric service
Class DescribeAlarmsForMetricResult The output for the DescribeAlarmsForMetric action.
Class DescribeAlarmsRequest Container for the parameters to the DescribeAlarms operation. 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.
Class DescribeAlarmsResponse Configuration for accessing Amazon DescribeAlarms service
Class DescribeAlarmsResult The output for the DescribeAlarms action.
Class Dimension The Dimension data type further expands on the identity of a metric using a Name, Value pair.

For examples that use one or more dimensions, see PutMetricData.

Class DimensionFilter The DimensionFilter data type is used to filter ListMetrics results.
Class DisableAlarmActionsRequest Container for the parameters to the DisableAlarmActions operation. 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.
Class DisableAlarmActionsResponse
Class EnableAlarmActionsRequest Container for the parameters to the EnableAlarmActions operation. Enables actions for the specified alarms.
Class EnableAlarmActionsResponse
Class GetMetricStatisticsRequest Container for the parameters to the GetMetricStatistics operation. 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.

Class GetMetricStatisticsResponse Configuration for accessing Amazon GetMetricStatistics service
Class GetMetricStatisticsResult The output for the GetMetricStatistics action.
Class InternalServiceException CloudWatch exception
Class InvalidFormatException CloudWatch exception
Class InvalidNextTokenException CloudWatch exception
Class InvalidParameterCombinationException CloudWatch exception
Class InvalidParameterValueException CloudWatch exception
Class LimitExceededException CloudWatch exception
Class ListMetricsRequest Container for the parameters to the ListMetrics operation. 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.
Class ListMetricsResponse Configuration for accessing Amazon ListMetrics service
Class ListMetricsResult The output for the ListMetrics action.
Class Metric The Metric data type contains information about a specific metric. If you call ListMetrics, Amazon CloudWatch returns information contained by this data type.

The example in the Examples section publishes two metrics named buffers and latency. Both metrics are in the examples namespace. Both metrics have two dimensions, InstanceID and InstanceType.

Class MetricAlarm The MetricAlarm data type represents an alarm. You can use PutMetricAlarm to create or update an alarm.
Class MetricDatum The MetricDatum data type encapsulates the information sent with PutMetricData to either create a new metric or add new values to be aggregated into an existing metric.
Class MissingRequiredParameterException CloudWatch exception
Class PutMetricAlarmRequest Container for the parameters to the PutMetricAlarm operation. 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.

Class PutMetricAlarmResponse
Class PutMetricDataRequest Container for the parameters to the PutMetricData operation. 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.

Class PutMetricDataResponse
Class ResourceNotFoundException CloudWatch exception
Class SetAlarmStateRequest Container for the parameters to the SetAlarmState operation. 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.
Class SetAlarmStateResponse
Class StatisticSet The StatisticSet data type describes the StatisticValues component of MetricDatum, and represents a set of statistics that describes a specific metric.