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

Classes

NameDescription
Class AlarmHistoryItem

Represents the history of a specific alarm.

Class DashboardEntry

Represents a specific dashboard.

Class DashboardInvalidInputErrorException

CloudWatch exception

Class DashboardNotFoundErrorException

CloudWatch exception

Class DashboardValidationMessage

An error or warning for the operation.

Class Datapoint

Encapsulates the statistical data that CloudWatch computes from metric data.

Class DeleteAlarmsRequest

Container for the parameters to the DeleteAlarms operation. Deletes the specified alarms. In the event of an error, no alarms are deleted.

Class DeleteAlarmsResponse

This is the response object from the DeleteAlarms operation.

Class DeleteDashboardsRequest

Container for the parameters to the DeleteDashboards operation. Deletes all dashboards that you specify. You may specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.

Class DeleteDashboardsResponse

This is the response object from the DeleteDashboards operation.

Class DescribeAlarmHistoryRequest

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 all alarms are returned.

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

Class DescribeAlarmHistoryResponse

This is the response object from the DescribeAlarmHistory operation.

Class DescribeAlarmsForMetricRequest

Container for the parameters to the DescribeAlarmsForMetric operation. Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.

Class DescribeAlarmsForMetricResponse

This is the response object from the DescribeAlarmsForMetric operation.

Class DescribeAlarmsRequest

Container for the parameters to the DescribeAlarms operation. Retrieves the specified alarms. If no alarms are specified, all alarms 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

This is the response object from the DescribeAlarms operation.

Class Dimension

Expands the identity of a metric.

Class DimensionFilter

Represents filters for a dimension.

Class DisableAlarmActionsRequest

Container for the parameters to the DisableAlarmActions operation. Disables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute when the alarm state changes.

Class DisableAlarmActionsResponse

This is the response object from the DisableAlarmActions operation.

Class EnableAlarmActionsRequest

Container for the parameters to the EnableAlarmActions operation. Enables the actions for the specified alarms.

Class EnableAlarmActionsResponse

This is the response object from the EnableAlarmActions operation.

Class GetDashboardRequest

Container for the parameters to the GetDashboard operation. Displays the details of the dashboard that you specify.

To copy an existing dashboard, use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard to create the copy.

Class GetDashboardResponse

This is the response object from the GetDashboard operation.

Class GetMetricStatisticsRequest

Container for the parameters to the GetMetricStatistics operation. Gets statistics for the specified metric.

The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order.

CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.

CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:

  • The SampleCount value of the statistic set is 1.

  • The Min and the Max values of the statistic set are equal.

Amazon CloudWatch retains metric data as follows:

  • Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.

  • Data points with a period of 60 seconds (1-minute) are available for 15 days.

  • Data points with a period of 300 seconds (5-minute) are available for 63 days.

  • Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).

Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.

CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.

For information about metrics and dimensions supported by AWS services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide.

Class GetMetricStatisticsResponse

This is the response object from the GetMetricStatistics operation.

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 ListDashboardsRequest

Container for the parameters to the ListDashboards operation. Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.

Class ListDashboardsResponse

This is the response object from the ListDashboards operation.

Class ListMetricsRequest

Container for the parameters to the ListMetrics operation. List the specified metrics. You can use the returned metrics with GetMetricStatistics to obtain statistical data.

Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.

After you create a metric, allow up to fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner using GetMetricStatistics.

Class ListMetricsResponse

This is the response object from the ListMetrics operation.

Class Metric

Represents a specific metric.

Class MetricAlarm

Represents an alarm.

Class MetricDatum

Encapsulates the information sent to either create a metric or add new values to be aggregated into an existing metric.

Class MissingRequiredParameterException

CloudWatch exception

Class PutDashboardRequest

Container for the parameters to the PutDashboard operation. Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.

You can have up to 500 dashboards per account. All dashboards in your account are global, not region-specific.

A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard.

When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the DashboardBody script or the CloudFormation template used to create the dashboard.

Class PutDashboardResponse

This is the response object from the PutDashboard operation.

Class PutMetricAlarmRequest

Container for the parameters to the PutMetricAlarm operation. Creates or updates an alarm and associates it with the specified metric. Optionally, this operation can associate one or more Amazon SNS 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 state is set appropriately. Any actions associated with the state are then executed.

When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

If you are an IAM user, you must have Amazon EC2 permissions for some operations:

  • ec2:DescribeInstanceStatus and ec2:DescribeInstances for all alarms on 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 are not performed. However, if you are later granted the required permissions, the alarm actions that you created earlier are performed.

If you are using an IAM role (for example, an 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 AWS STS, you cannot stop or terminate an EC2 instance using alarm actions.

You must create at least one stop, terminate, or reboot alarm using either the Amazon EC2 or CloudWatch consoles to create the EC2ActionsAccess IAM role. After this IAM role is created, you can create stop, terminate, or reboot alarms using a command-line interface or API.

Class PutMetricAlarmResponse

This is the response object from the PutMetricAlarm operation.

Class PutMetricDataRequest

Container for the parameters to the PutMetricData operation. Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to ListMetrics.

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

Although the Value parameter accepts numbers of type Double, 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 (for example, NaN, +Infinity, -Infinity) are not supported.

You can use up to 10 dimensions per metric to further clarify what data the metric collects. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for GetMetricStatistics from the time they are submitted.

CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:

  • The SampleCount value of the statistic set is 1

  • The Min and the Max values of the statistic set are equal

Class PutMetricDataResponse

This is the response object from the PutMetricData operation.

Class ResourceNotFoundException

CloudWatch exception

Class SetAlarmStateRequest

Container for the parameters to the SetAlarmState operation. Temporarily sets the state of an alarm for testing purposes. When the updated state 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 state to ALARM sends an SNS message. The alarm returns to its actual state (often within seconds). Because the alarm state change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory.

Class SetAlarmStateResponse

This is the response object from the SetAlarmState operation.

Class StatisticSet

Represents a set of statistics that describes a specific metric.