logo
Expand description

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 change 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 EC2 instances. 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.

If you’re using the service, you’re probably looking for CloudWatchClient and CloudWatch.

Structs

Represents the history of a specific alarm.

An anomaly detection model associated with a particular CloudWatch metric and statistic. You can use the model to display a band of expected normal values when the metric is graphed.

The configuration specifies details about how the anomaly detection model is to be trained, including time ranges to exclude from use for training the model and the time zone to use for the metric.

A client for the CloudWatch API.

The details about a composite alarm.

Represents a specific dashboard.

An error or warning for the operation.

Encapsulates the statistical data that CloudWatch computes from metric data.

A dimension is a name/value pair that is part of the identity of a metric. You can assign up to 10 dimensions to a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric.

Represents filters for a dimension.

This structure contains the definition for a Contributor Insights rule.

One of the unique contributors found by a Contributor Insights rule. If the rule contains multiple keys, then a unique contributor is a unique combination of values from all the keys in the rule.

If the rule contains a single key, then each unique contributor is each unique value for this key.

For more information, see GetInsightRuleReport.

One data point related to one contributor.

For more information, see GetInsightRuleReport and InsightRuleContributor.

One data point from the metric time series returned in a Contributor Insights rule report.

For more information, see GetInsightRuleReport.

This structure includes the Timezone parameter, which you can use to specify your time zone so that the labels that are associated with returned metrics display the correct time for your time zone.

The Timezone value affects a label only if you have a time-based dynamic expression in the label. For more information about dynamic expressions in labels, see Using Dynamic Labels.

A message returned by the GetMetricDataAPI, including a code and a description.

Represents a specific metric.

The details about a metric alarm.

This structure is used in both GetMetricData and PutMetricAlarm. The supported use of this structure is different for those two operations.

When used in GetMetricData, it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data. A single GetMetricData call can include up to 500 MetricDataQuery structures.

When used in PutMetricAlarm, it enables you to create an alarm based on a metric math expression. Each MetricDataQuery in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single PutMetricAlarm call can include up to 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, one must have True as the value for ReturnData. The result of this expression is the value the alarm watches.

Any expression used in a PutMetricAlarm operation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData operation or a PutMetricAlarm operation. These differences are explained in the following parameter list.

A GetMetricData call returns an array of MetricDataResult structures. Each of these structures includes the data points for that metric, along with the timestamps of those data points and other identifying information.

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

This structure defines the metric to be returned, along with the statistics, period, and units.

This structure contains the configuration information about one metric stream.

This structure contains the name of one of the metric namespaces that is listed in a filter of a metric stream.

This array is empty if the API operation was successful for all the rules specified in the request. If the operation could not process one of the rules, the following data is returned for each of those rules.

Specifies one range of days or times to exclude from use for training an anomaly detection model.

Represents a set of statistics that describes a specific metric.

A key-value pair associated with a CloudWatch resource.

Enums

Errors returned by DeleteAlarms

Errors returned by DeleteAnomalyDetector

Errors returned by DeleteDashboards

Errors returned by DeleteInsightRules

Errors returned by DeleteMetricStream

Errors returned by DescribeAlarmHistory

Errors returned by DescribeAlarms

Errors returned by DescribeAlarmsForMetric

Errors returned by DescribeAnomalyDetectors

Errors returned by DescribeInsightRules

Errors returned by DisableAlarmActions

Errors returned by DisableInsightRules

Errors returned by EnableAlarmActions

Errors returned by EnableInsightRules

Errors returned by GetDashboard

Errors returned by GetInsightRuleReport

Errors returned by GetMetricData

Errors returned by GetMetricStatistics

Errors returned by GetMetricStream

Errors returned by GetMetricWidgetImage

Errors returned by ListDashboards

Errors returned by ListMetricStreams

Errors returned by ListMetrics

Errors returned by ListTagsForResource

Errors returned by PutAnomalyDetector

Errors returned by PutCompositeAlarm

Errors returned by PutDashboard

Errors returned by PutInsightRule

Errors returned by PutMetricAlarm

Errors returned by PutMetricData

Errors returned by PutMetricStream

Errors returned by SetAlarmState

Errors returned by StartMetricStreams

Errors returned by StopMetricStreams

Errors returned by TagResource

Errors returned by UntagResource

Traits

Trait representing the capabilities of the CloudWatch API. CloudWatch clients implement this trait.