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§
- Alarm
History Item Represents the history of a specific alarm.
- Anomaly
Detector 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.
- Anomaly
Detector Configuration 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.
- Cloud
Watch Client - A client for the CloudWatch API.
- Composite
Alarm The details about a composite alarm.
- Dashboard
Entry Represents a specific dashboard.
- Dashboard
Validation Message An error or warning for the operation.
- Datapoint
Encapsulates the statistical data that CloudWatch computes from metric data.
- Delete
Alarms Input - Delete
Anomaly Detector Input - Delete
Anomaly Detector Output - Delete
Dashboards Input - Delete
Dashboards Output - Delete
Insight Rules Input - Delete
Insight Rules Output - Delete
Metric Stream Input - Delete
Metric Stream Output - Describe
Alarm History Input - Describe
Alarm History Output - Describe
Alarms ForMetric Input - Describe
Alarms ForMetric Output - Describe
Alarms Input - Describe
Alarms Output - Describe
Anomaly Detectors Input - Describe
Anomaly Detectors Output - Describe
Insight Rules Input - Describe
Insight Rules Output - Dimension
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.
- Dimension
Filter Represents filters for a dimension.
- Disable
Alarm Actions Input - Disable
Insight Rules Input - Disable
Insight Rules Output - Enable
Alarm Actions Input - Enable
Insight Rules Input - Enable
Insight Rules Output - GetDashboard
Input - GetDashboard
Output - GetInsight
Rule Report Input - GetInsight
Rule Report Output - GetMetric
Data Input - GetMetric
Data Output - GetMetric
Statistics Input - GetMetric
Statistics Output - GetMetric
Stream Input - GetMetric
Stream Output - GetMetric
Widget Image Input - GetMetric
Widget Image Output - Insight
Rule This structure contains the definition for a Contributor Insights rule.
- Insight
Rule Contributor 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.
- Insight
Rule Contributor Datapoint One data point related to one contributor.
For more information, see GetInsightRuleReport and InsightRuleContributor.
- Insight
Rule Metric Datapoint One data point from the metric time series returned in a Contributor Insights rule report.
For more information, see GetInsightRuleReport.
- Label
Options 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.- List
Dashboards Input - List
Dashboards Output - List
Metric Streams Input - List
Metric Streams Output - List
Metrics Input - List
Metrics Output - List
Tags ForResource Input - List
Tags ForResource Output - Message
Data A message returned by the
GetMetricData
API, including a code and a description.- Metric
Represents a specific metric.
- Metric
Alarm The details about a metric alarm.
- Metric
Data Query This structure is used in both
GetMetricData
andPutMetricAlarm
. 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 singleGetMetricData
call can include up to 500MetricDataQuery
structures.When used in
PutMetricAlarm
, it enables you to create an alarm based on a metric math expression. EachMetricDataQuery
in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A singlePutMetricAlarm
call can include up to 20MetricDataQuery
structures in the array. The 20 structures can include as many as 10 structures that contain aMetricStat
parameter to retrieve a metric, and as many as 10 structures that contain theExpression
parameter to perform a math expression. Of thoseExpression
structures, one must haveTrue
as the value forReturnData
. 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 aPutMetricAlarm
operation. These differences are explained in the following parameter list.- Metric
Data Result A
GetMetricData
call returns an array ofMetricDataResult
structures. Each of these structures includes the data points for that metric, along with the timestamps of those data points and other identifying information.- Metric
Datum Encapsulates the information sent to either create a metric or add new values to be aggregated into an existing metric.
- Metric
Stat This structure defines the metric to be returned, along with the statistics, period, and units.
- Metric
Stream Entry This structure contains the configuration information about one metric stream.
- Metric
Stream Filter This structure contains the name of one of the metric namespaces that is listed in a filter of a metric stream.
- Partial
Failure 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.
- PutAnomaly
Detector Input - PutAnomaly
Detector Output - PutComposite
Alarm Input - PutDashboard
Input - PutDashboard
Output - PutInsight
Rule Input - PutInsight
Rule Output - PutMetric
Alarm Input - PutMetric
Data Input - PutMetric
Stream Input - PutMetric
Stream Output - Range
Specifies one range of days or times to exclude from use for training an anomaly detection model.
- SetAlarm
State Input - Start
Metric Streams Input - Start
Metric Streams Output - Statistic
Set Represents a set of statistics that describes a specific metric.
- Stop
Metric Streams Input - Stop
Metric Streams Output - Tag
A key-value pair associated with a CloudWatch resource.
- TagResource
Input - TagResource
Output - Untag
Resource Input - Untag
Resource Output
Enums§
- Delete
Alarms Error - Errors returned by DeleteAlarms
- Delete
Anomaly Detector Error - Errors returned by DeleteAnomalyDetector
- Delete
Dashboards Error - Errors returned by DeleteDashboards
- Delete
Insight Rules Error - Errors returned by DeleteInsightRules
- Delete
Metric Stream Error - Errors returned by DeleteMetricStream
- Describe
Alarm History Error - Errors returned by DescribeAlarmHistory
- Describe
Alarms Error - Errors returned by DescribeAlarms
- Describe
Alarms ForMetric Error - Errors returned by DescribeAlarmsForMetric
- Describe
Anomaly Detectors Error - Errors returned by DescribeAnomalyDetectors
- Describe
Insight Rules Error - Errors returned by DescribeInsightRules
- Disable
Alarm Actions Error - Errors returned by DisableAlarmActions
- Disable
Insight Rules Error - Errors returned by DisableInsightRules
- Enable
Alarm Actions Error - Errors returned by EnableAlarmActions
- Enable
Insight Rules Error - Errors returned by EnableInsightRules
- GetDashboard
Error - Errors returned by GetDashboard
- GetInsight
Rule Report Error - Errors returned by GetInsightRuleReport
- GetMetric
Data Error - Errors returned by GetMetricData
- GetMetric
Statistics Error - Errors returned by GetMetricStatistics
- GetMetric
Stream Error - Errors returned by GetMetricStream
- GetMetric
Widget Image Error - Errors returned by GetMetricWidgetImage
- List
Dashboards Error - Errors returned by ListDashboards
- List
Metric Streams Error - Errors returned by ListMetricStreams
- List
Metrics Error - Errors returned by ListMetrics
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- PutAnomaly
Detector Error - Errors returned by PutAnomalyDetector
- PutComposite
Alarm Error - Errors returned by PutCompositeAlarm
- PutDashboard
Error - Errors returned by PutDashboard
- PutInsight
Rule Error - Errors returned by PutInsightRule
- PutMetric
Alarm Error - Errors returned by PutMetricAlarm
- PutMetric
Data Error - Errors returned by PutMetricData
- PutMetric
Stream Error - Errors returned by PutMetricStream
- SetAlarm
State Error - Errors returned by SetAlarmState
- Start
Metric Streams Error - Errors returned by StartMetricStreams
- Stop
Metric Streams Error - Errors returned by StopMetricStreams
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
Traits§
- Cloud
Watch - Trait representing the capabilities of the CloudWatch API. CloudWatch clients implement this trait.