Crate rusoto_cloudwatch

Source
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§

AlarmHistoryItem

Represents the history of a specific alarm.

AnomalyDetector

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.

AnomalyDetectorConfiguration

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.

CloudWatchClient
A client for the CloudWatch API.
CompositeAlarm

The details about a composite alarm.

DashboardEntry

Represents a specific dashboard.

DashboardValidationMessage

An error or warning for the operation.

Datapoint

Encapsulates the statistical data that CloudWatch computes from metric data.

DeleteAlarmsInput
DeleteAnomalyDetectorInput
DeleteAnomalyDetectorOutput
DeleteDashboardsInput
DeleteDashboardsOutput
DeleteInsightRulesInput
DeleteInsightRulesOutput
DeleteMetricStreamInput
DeleteMetricStreamOutput
DescribeAlarmHistoryInput
DescribeAlarmHistoryOutput
DescribeAlarmsForMetricInput
DescribeAlarmsForMetricOutput
DescribeAlarmsInput
DescribeAlarmsOutput
DescribeAnomalyDetectorsInput
DescribeAnomalyDetectorsOutput
DescribeInsightRulesInput
DescribeInsightRulesOutput
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.

DimensionFilter

Represents filters for a dimension.

DisableAlarmActionsInput
DisableInsightRulesInput
DisableInsightRulesOutput
EnableAlarmActionsInput
EnableInsightRulesInput
EnableInsightRulesOutput
GetDashboardInput
GetDashboardOutput
GetInsightRuleReportInput
GetInsightRuleReportOutput
GetMetricDataInput
GetMetricDataOutput
GetMetricStatisticsInput
GetMetricStatisticsOutput
GetMetricStreamInput
GetMetricStreamOutput
GetMetricWidgetImageInput
GetMetricWidgetImageOutput
InsightRule

This structure contains the definition for a Contributor Insights rule.

InsightRuleContributor

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.

InsightRuleContributorDatapoint

One data point related to one contributor.

For more information, see GetInsightRuleReport and InsightRuleContributor.

InsightRuleMetricDatapoint

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

For more information, see GetInsightRuleReport.

LabelOptions

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.

ListDashboardsInput
ListDashboardsOutput
ListMetricStreamsInput
ListMetricStreamsOutput
ListMetricsInput
ListMetricsOutput
ListTagsForResourceInput
ListTagsForResourceOutput
MessageData

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

Metric

Represents a specific metric.

MetricAlarm

The details about a metric alarm.

MetricDataQuery

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.

MetricDataResult

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.

MetricDatum

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

MetricStat

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

MetricStreamEntry

This structure contains the configuration information about one metric stream.

MetricStreamFilter

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

PartialFailure

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.

PutAnomalyDetectorInput
PutAnomalyDetectorOutput
PutCompositeAlarmInput
PutDashboardInput
PutDashboardOutput
PutInsightRuleInput
PutInsightRuleOutput
PutMetricAlarmInput
PutMetricDataInput
PutMetricStreamInput
PutMetricStreamOutput
Range

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

SetAlarmStateInput
StartMetricStreamsInput
StartMetricStreamsOutput
StatisticSet

Represents a set of statistics that describes a specific metric.

StopMetricStreamsInput
StopMetricStreamsOutput
Tag

A key-value pair associated with a CloudWatch resource.

TagResourceInput
TagResourceOutput
UntagResourceInput
UntagResourceOutput

Enums§

DeleteAlarmsError
Errors returned by DeleteAlarms
DeleteAnomalyDetectorError
Errors returned by DeleteAnomalyDetector
DeleteDashboardsError
Errors returned by DeleteDashboards
DeleteInsightRulesError
Errors returned by DeleteInsightRules
DeleteMetricStreamError
Errors returned by DeleteMetricStream
DescribeAlarmHistoryError
Errors returned by DescribeAlarmHistory
DescribeAlarmsError
Errors returned by DescribeAlarms
DescribeAlarmsForMetricError
Errors returned by DescribeAlarmsForMetric
DescribeAnomalyDetectorsError
Errors returned by DescribeAnomalyDetectors
DescribeInsightRulesError
Errors returned by DescribeInsightRules
DisableAlarmActionsError
Errors returned by DisableAlarmActions
DisableInsightRulesError
Errors returned by DisableInsightRules
EnableAlarmActionsError
Errors returned by EnableAlarmActions
EnableInsightRulesError
Errors returned by EnableInsightRules
GetDashboardError
Errors returned by GetDashboard
GetInsightRuleReportError
Errors returned by GetInsightRuleReport
GetMetricDataError
Errors returned by GetMetricData
GetMetricStatisticsError
Errors returned by GetMetricStatistics
GetMetricStreamError
Errors returned by GetMetricStream
GetMetricWidgetImageError
Errors returned by GetMetricWidgetImage
ListDashboardsError
Errors returned by ListDashboards
ListMetricStreamsError
Errors returned by ListMetricStreams
ListMetricsError
Errors returned by ListMetrics
ListTagsForResourceError
Errors returned by ListTagsForResource
PutAnomalyDetectorError
Errors returned by PutAnomalyDetector
PutCompositeAlarmError
Errors returned by PutCompositeAlarm
PutDashboardError
Errors returned by PutDashboard
PutInsightRuleError
Errors returned by PutInsightRule
PutMetricAlarmError
Errors returned by PutMetricAlarm
PutMetricDataError
Errors returned by PutMetricData
PutMetricStreamError
Errors returned by PutMetricStream
SetAlarmStateError
Errors returned by SetAlarmState
StartMetricStreamsError
Errors returned by StartMetricStreams
StopMetricStreamsError
Errors returned by StopMetricStreams
TagResourceError
Errors returned by TagResource
UntagResourceError
Errors returned by UntagResource

Traits§

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