Class: Aws::CloudWatch::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::CloudWatch::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb
Overview
An API client for CloudWatch. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::CloudWatch::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#delete_alarms(params = {}) ⇒ Struct
Deletes the specified alarms.
-
#delete_anomaly_detector(params = {}) ⇒ Struct
Deletes the specified anomaly detection model from your account.
-
#delete_dashboards(params = {}) ⇒ Struct
Deletes all dashboards that you specify.
-
#delete_insight_rules(params = {}) ⇒ Types::DeleteInsightRulesOutput
Permanently deletes the specified Contributor Insights rules.
-
#delete_metric_stream(params = {}) ⇒ Struct
Permanently deletes the metric stream that you specify.
-
#describe_alarm_history(params = {}) ⇒ Types::DescribeAlarmHistoryOutput
Retrieves the history for the specified alarm.
-
#describe_alarms(params = {}) ⇒ Types::DescribeAlarmsOutput
Retrieves the specified alarms.
-
#describe_alarms_for_metric(params = {}) ⇒ Types::DescribeAlarmsForMetricOutput
Retrieves the alarms for the specified metric.
-
#describe_anomaly_detectors(params = {}) ⇒ Types::DescribeAnomalyDetectorsOutput
Lists the anomaly detection models that you have created in your account.
-
#describe_insight_rules(params = {}) ⇒ Types::DescribeInsightRulesOutput
Returns a list of all the Contributor Insights rules in your account.
-
#disable_alarm_actions(params = {}) ⇒ Struct
Disables the actions for the specified alarms.
-
#disable_insight_rules(params = {}) ⇒ Types::DisableInsightRulesOutput
Disables the specified Contributor Insights rules.
-
#enable_alarm_actions(params = {}) ⇒ Struct
Enables the actions for the specified alarms.
-
#enable_insight_rules(params = {}) ⇒ Types::EnableInsightRulesOutput
Enables the specified Contributor Insights rules.
-
#get_dashboard(params = {}) ⇒ Types::GetDashboardOutput
Displays the details of the dashboard that you specify.
-
#get_insight_rule_report(params = {}) ⇒ Types::GetInsightRuleReportOutput
This operation returns the time series data collected by a Contributor Insights rule.
-
#get_metric_data(params = {}) ⇒ Types::GetMetricDataOutput
You can use the
GetMetricData
API to retrieve CloudWatch metric values. -
#get_metric_statistics(params = {}) ⇒ Types::GetMetricStatisticsOutput
Gets statistics for the specified metric.
-
#get_metric_stream(params = {}) ⇒ Types::GetMetricStreamOutput
Returns information about the metric stream that you specify.
-
#get_metric_widget_image(params = {}) ⇒ Types::GetMetricWidgetImageOutput
You can use the
GetMetricWidgetImage
API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image. -
#list_dashboards(params = {}) ⇒ Types::ListDashboardsOutput
Returns a list of the dashboards for your account.
-
#list_managed_insight_rules(params = {}) ⇒ Types::ListManagedInsightRulesOutput
Returns a list that contains the number of managed Contributor Insights rules in your account.
-
#list_metric_streams(params = {}) ⇒ Types::ListMetricStreamsOutput
Returns a list of metric streams in this account.
-
#list_metrics(params = {}) ⇒ Types::ListMetricsOutput
List the specified metrics.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Displays the tags associated with a CloudWatch resource.
-
#put_anomaly_detector(params = {}) ⇒ Struct
Creates an anomaly detection model for a CloudWatch metric.
-
#put_composite_alarm(params = {}) ⇒ Struct
Creates or updates a composite alarm.
-
#put_dashboard(params = {}) ⇒ Types::PutDashboardOutput
Creates a dashboard if it does not already exist, or updates an existing dashboard.
-
#put_insight_rule(params = {}) ⇒ Struct
Creates a Contributor Insights rule.
-
#put_managed_insight_rules(params = {}) ⇒ Types::PutManagedInsightRulesOutput
Creates a managed Contributor Insights rule for a specified Amazon Web Services resource.
-
#put_metric_alarm(params = {}) ⇒ Struct
Creates or updates an alarm and associates it with the specified metric, metric math expression, anomaly detection model, or Metrics Insights query.
-
#put_metric_data(params = {}) ⇒ Struct
Publishes metric data points to Amazon CloudWatch.
-
#put_metric_stream(params = {}) ⇒ Types::PutMetricStreamOutput
Creates or updates a metric stream.
-
#set_alarm_state(params = {}) ⇒ Struct
Temporarily sets the state of an alarm for testing purposes.
-
#start_metric_streams(params = {}) ⇒ Struct
Starts the streaming of metrics for one or more of your metric streams.
-
#stop_metric_streams(params = {}) ⇒ Struct
Stops the streaming of metrics for one or more of your metric streams.
-
#tag_resource(params = {}) ⇒ Struct
Assigns one or more tags (key-value pairs) to the specified CloudWatch resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from the specified resource.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
444 445 446 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 444 def initialize(*args) super end |
Instance Method Details
#delete_alarms(params = {}) ⇒ Struct
Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation.
If you specify an incorrect alarm name or make any other error in the
operation, no alarms are deleted. To confirm that alarms were deleted
successfully, you can use the DescribeAlarms operation after
using DeleteAlarms
.
To get out of such a situation, you must break the cycle by changing
the rule of one of the composite alarms in the cycle to remove a
dependency that creates the cycle. The simplest change to make to
break a cycle is to change the AlarmRule
of one of the alarms to
false
.
Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.
499 500 501 502 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 499 def delete_alarms(params = {}, = {}) req = build_request(:delete_alarms, params) req.send_request() end |
#delete_anomaly_detector(params = {}) ⇒ Struct
Deletes the specified anomaly detection model from your account. For more information about how to delete an anomaly detection model, see Deleting an anomaly detection model in the CloudWatch User Guide.
625 626 627 628 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 625 def delete_anomaly_detector(params = {}, = {}) req = build_request(:delete_anomaly_detector, params) req.send_request() end |
#delete_dashboards(params = {}) ⇒ Struct
Deletes all dashboards that you specify. You can specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.
649 650 651 652 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 649 def delete_dashboards(params = {}, = {}) req = build_request(:delete_dashboards, params) req.send_request() end |
#delete_insight_rules(params = {}) ⇒ Types::DeleteInsightRulesOutput
Permanently deletes the specified Contributor Insights rules.
If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.
690 691 692 693 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 690 def delete_insight_rules(params = {}, = {}) req = build_request(:delete_insight_rules, params) req.send_request() end |
#delete_metric_stream(params = {}) ⇒ Struct
Permanently deletes the metric stream that you specify.
712 713 714 715 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 712 def delete_metric_stream(params = {}, = {}) req = build_request(:delete_metric_stream, params) req.send_request() end |
#describe_alarm_history(params = {}) ⇒ Types::DescribeAlarmHistoryOutput
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 either all metric alarms or all composite alarms are returned.
CloudWatch retains the history of an alarm even if you delete the alarm.
To use this operation and return information about a composite alarm,
you must be signed on with the cloudwatch:DescribeAlarmHistory
permission that is scoped to *
. You can't return information about
composite alarms if your cloudwatch:DescribeAlarmHistory
permission
has a narrower scope.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
796 797 798 799 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 796 def describe_alarm_history(params = {}, = {}) req = build_request(:describe_alarm_history, params) req.send_request() end |
#describe_alarms(params = {}) ⇒ Types::DescribeAlarmsOutput
Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm name, the alarm state, or a prefix for any action.
To use this operation and return information about composite alarms,
you must be signed on with the cloudwatch:DescribeAlarms
permission
that is scoped to *
. You can't return information about composite
alarms if your cloudwatch:DescribeAlarms
permission has a narrower
scope.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- alarm_exists
- composite_alarm_exists
999 1000 1001 1002 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 999 def describe_alarms(params = {}, = {}) req = build_request(:describe_alarms, params) req.send_request() end |
#describe_alarms_for_metric(params = {}) ⇒ Types::DescribeAlarmsForMetricOutput
Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.
This operation retrieves only standard alarms that are based on the specified metric. It does not return alarms based on math expressions that use the specified metric, or composite alarms that use the specified metric.
1114 1115 1116 1117 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 1114 def describe_alarms_for_metric(params = {}, = {}) req = build_request(:describe_alarms_for_metric, params) req.send_request() end |
#describe_anomaly_detectors(params = {}) ⇒ Types::DescribeAnomalyDetectorsOutput
Lists the anomaly detection models that you have created in your
account. For single metric anomaly detectors, you can list all of the
models in your account or filter the results to only the models that
are related to a certain namespace, metric name, or metric dimension.
For metric math anomaly detectors, you can list them by adding
METRIC_MATH
to the AnomalyDetectorTypes
array. This will return
all metric math anomaly detectors in your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1225 1226 1227 1228 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 1225 def describe_anomaly_detectors(params = {}, = {}) req = build_request(:describe_anomaly_detectors, params) req.send_request() end |
#describe_insight_rules(params = {}) ⇒ Types::DescribeInsightRulesOutput
Returns a list of all the Contributor Insights rules in your account.
For more information about Contributor Insights, see Using Contributor Insights to Analyze High-Cardinality Data.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1275 1276 1277 1278 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 1275 def describe_insight_rules(params = {}, = {}) req = build_request(:describe_insight_rules, params) req.send_request() end |
#disable_alarm_actions(params = {}) ⇒ Struct
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.
1299 1300 1301 1302 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 1299 def disable_alarm_actions(params = {}, = {}) req = build_request(:disable_alarm_actions, params) req.send_request() end |
#disable_insight_rules(params = {}) ⇒ Types::DisableInsightRulesOutput
Disables the specified Contributor Insights rules. When rules are disabled, they do not analyze log groups and do not incur costs.
1337 1338 1339 1340 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 1337 def disable_insight_rules(params = {}, = {}) req = build_request(:disable_insight_rules, params) req.send_request() end |
#enable_alarm_actions(params = {}) ⇒ Struct
Enables the actions for the specified alarms.
1359 1360 1361 1362 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 1359 def enable_alarm_actions(params = {}, = {}) req = build_request(:enable_alarm_actions, params) req.send_request() end |
#enable_insight_rules(params = {}) ⇒ Types::EnableInsightRulesOutput
Enables the specified Contributor Insights rules. When rules are enabled, they immediately begin analyzing log data.
1397 1398 1399 1400 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 1397 def enable_insight_rules(params = {}, = {}) req = build_request(:enable_insight_rules, params) req.send_request() end |
#get_dashboard(params = {}) ⇒ Types::GetDashboardOutput
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.
1433 1434 1435 1436 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 1433 def get_dashboard(params = {}, = {}) req = build_request(:get_dashboard, params) req.send_request() end |
#get_insight_rule_report(params = {}) ⇒ Types::GetInsightRuleReportOutput
This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of contributors to the log group.
You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:
UniqueContributors
-- the number of unique contributors for each data point.MaxContributorValue
-- the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph.If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's
Value
, during that period.SampleCount
-- the number of data points matched by the rule.Sum
-- the sum of the values from all contributors during the time period represented by that data point.Minimum
-- the minimum value from a single observation during the time period represented by that data point.Maximum
-- the maximum value from a single observation during the time period represented by that data point.Average
-- the average value from all contributors during the time period represented by that data point.
1577 1578 1579 1580 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 1577 def get_insight_rule_report(params = {}, = {}) req = build_request(:get_insight_rule_report, params) req.send_request() end |
#get_metric_data(params = {}) ⇒ Types::GetMetricDataOutput
You can use the GetMetricData
API to retrieve CloudWatch metric
values. The operation can also include a CloudWatch Metrics Insights
query, and one or more metric math functions.
A GetMetricData
operation that does not include a query can retrieve
as many as 500 different metrics in a single request, with a total of
as many as 100,800 data points. You can also optionally perform metric
math expressions on the values of the returned statistics, to create
new time series that represent new insights into your data. For
example, using Lambda metrics, you could divide the Errors metric by
the Invocations metric to get an error rate time series. For more
information about metric math expressions, see Metric Math Syntax and
Functions in the Amazon CloudWatch User Guide.
If you include a Metrics Insights query, each GetMetricData
operation can include only one query. But the same GetMetricData
operation can also retrieve other metrics. Metrics Insights queries
can query only the most recent three hours of metric data. For more
information about Metrics Insights, see Query your metrics with
CloudWatch Metrics Insights.
Calls to the GetMetricData
API have a different pricing structure
than calls to GetMetricStatistics
. For more information about
pricing, see Amazon CloudWatch Pricing.
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.
If you omit Unit
in your request, all data that was collected with
any unit is returned, along with the corresponding units that were
specified when the data was reported to CloudWatch. If you specify a
unit, the operation returns only data that was collected with that
unit specified. If you specify a unit that does not match the data
collected, the results of the operation are null. CloudWatch does not
perform unit conversions.
Using Metrics Insights queries with metric math
You can't mix a Metric Insights query and metric math syntax in the same expression, but you can reference results from a Metrics Insights query within other Metric math expressions. A Metrics Insights query without a GROUP BY clause returns a single time-series (TS), and can be used as input for a metric math expression that expects a single time series. A Metrics Insights query with a GROUP BY clause returns an array of time-series (TS[]), and can be used as input for a metric math expression that expects an array of time series.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1801 1802 1803 1804 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 1801 def get_metric_data(params = {}, = {}) req = build_request(:get_metric_data, params) req.send_request() end |
#get_metric_statistics(params = {}) ⇒ Types::GetMetricStatisticsOutput
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.
Percentile statistics are not available for metrics when any of the metric values are negative numbers.
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 Amazon Web Services services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide.
2015 2016 2017 2018 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 2015 def get_metric_statistics(params = {}, = {}) req = build_request(:get_metric_statistics, params) req.send_request() end |
#get_metric_stream(params = {}) ⇒ Types::GetMetricStreamOutput
Returns information about the metric stream that you specify.
2076 2077 2078 2079 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 2076 def get_metric_stream(params = {}, = {}) req = build_request(:get_metric_stream, params) req.send_request() end |
#get_metric_widget_image(params = {}) ⇒ Types::GetMetricWidgetImageOutput
You can use the GetMetricWidgetImage
API to retrieve a snapshot
graph of one or more Amazon CloudWatch metrics as a bitmap image. You
can then embed this image into your services and products, such as
wiki pages, reports, and documents. You could also retrieve images
regularly, such as every minute, and create your own custom live
dashboard.
The graph you retrieve can include all CloudWatch metric graph features, including metric math and horizontal and vertical annotations.
There is a limit of 20 transactions per second for this API. Each
GetMetricWidgetImage
action has the following limits:
As many as 100 metrics in the graph.
Up to 100 KB uncompressed payload.
2168 2169 2170 2171 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 2168 def (params = {}, = {}) req = build_request(:get_metric_widget_image, params) req.send_request() end |
#list_dashboards(params = {}) ⇒ Types::ListDashboardsOutput
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.
ListDashboards
returns up to 1000 results on one page. If there are
more than 1000 dashboards, you can call ListDashboards
again and
include the value you received for NextToken
in the first call, to
receive the next 1000 results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2219 2220 2221 2222 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 2219 def list_dashboards(params = {}, = {}) req = build_request(:list_dashboards, params) req.send_request() end |
#list_managed_insight_rules(params = {}) ⇒ Types::ListManagedInsightRulesOutput
Returns a list that contains the number of managed Contributor Insights rules in your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2268 2269 2270 2271 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 2268 def list_managed_insight_rules(params = {}, = {}) req = build_request(:list_managed_insight_rules, params) req.send_request() end |
#list_metric_streams(params = {}) ⇒ Types::ListMetricStreamsOutput
Returns a list of metric streams in this account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2312 2313 2314 2315 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 2312 def list_metric_streams(params = {}, = {}) req = build_request(:list_metric_streams, params) req.send_request() end |
#list_metrics(params = {}) ⇒ Types::ListMetricsOutput
List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to get 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 15 minutes for the metric to appear. To see metric statistics sooner, use GetMetricData or GetMetricStatistics.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view metrics from the linked source accounts. For more information, see CloudWatch cross-account observability.
ListMetrics
doesn't return information about metrics if those
metrics haven't reported data in the past two weeks. To retrieve
those metrics, use GetMetricData or GetMetricStatistics.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2422 2423 2424 2425 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 2422 def list_metrics(params = {}, = {}) req = build_request(:list_metrics, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Displays the tags associated with a CloudWatch resource. Currently, alarms and Contributor Insights rules support tagging.
2466 2467 2468 2469 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 2466 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_anomaly_detector(params = {}) ⇒ Struct
Creates an anomaly detection model for a CloudWatch metric. You can use the model to display a band of expected normal values when the metric is graphed.
If you have enabled unified cross-account observability, and this
account is a monitoring account, the metric can be in the same account
or a source account. You can specify the account ID in the object you
specify in the SingleMetricAnomalyDetector
parameter.
For more information, see CloudWatch Anomaly Detection.
2623 2624 2625 2626 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 2623 def put_anomaly_detector(params = {}, = {}) req = build_request(:put_anomaly_detector, params) req.send_request() end |
#put_composite_alarm(params = {}) ⇒ Struct
Creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.
The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms. The rule expression of a composite alarm can include as many as 100 underlying alarms. Any single alarm can be included in the rule expressions of as many as 150 composite alarms.
Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.
Composite alarms can take the following actions:
Notify Amazon SNS topics.
Invoke Lambda functions.
Create OpsItems in Systems Manager Ops Center.
Create incidents in Systems Manager Incident Manager.
To get out of such a situation, you must break the cycle by changing
the rule of one of the composite alarms in the cycle to remove a
dependency that creates the cycle. The simplest change to make to
break a cycle is to change the AlarmRule
of one of the alarms to
false
.
Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.
When this operation creates an alarm, the alarm state is immediately
set to INSUFFICIENT_DATA
. The alarm is then evaluated and its state
is set appropriately. Any actions associated with the new state are
then executed. For a composite alarm, this initial time after creation
is the only time that the alarm can be in INSUFFICIENT_DATA
state.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
To use this operation, you must be signed on with the
cloudwatch:PutCompositeAlarm
permission that is scoped to *
. You
can't create a composite alarms if your
cloudwatch:PutCompositeAlarm
permission has a narrower scope.
If you are an IAM user, you must have iam:CreateServiceLinkedRole
to
create a composite alarm that has Systems Manager OpsItem actions.
2903 2904 2905 2906 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 2903 def put_composite_alarm(params = {}, = {}) req = build_request(:put_composite_alarm, params) req.send_request() end |
#put_dashboard(params = {}) ⇒ Types::PutDashboardOutput
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.
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.
2969 2970 2971 2972 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 2969 def put_dashboard(params = {}, = {}) req = build_request(:put_dashboard, params) req.send_request() end |
#put_insight_rule(params = {}) ⇒ Struct
Creates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, see Using Contributor Insights to Analyze High-Cardinality Data.
If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.
3041 3042 3043 3044 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 3041 def put_insight_rule(params = {}, = {}) req = build_request(:put_insight_rule, params) req.send_request() end |
#put_managed_insight_rules(params = {}) ⇒ Types::PutManagedInsightRulesOutput
Creates a managed Contributor Insights rule for a specified Amazon Web
Services resource. When you enable a managed rule, you create a
Contributor Insights rule that collects data from Amazon Web Services
services. You cannot edit these rules with PutInsightRule
. The rules
can be enabled, disabled, and deleted using EnableInsightRules
,
DisableInsightRules
, and DeleteInsightRules
. If a previously
created managed rule is currently disabled, a subsequent call to this
API will re-enable it. Use ListManagedInsightRules
to describe all
available rules.
3092 3093 3094 3095 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 3092 def put_managed_insight_rules(params = {}, = {}) req = build_request(:put_managed_insight_rules, params) req.send_request() end |
#put_metric_alarm(params = {}) ⇒ Struct
Creates or updates an alarm and associates it with the specified metric, metric math expression, anomaly detection model, or Metrics Insights query. For more information about using a Metrics Insights query for an alarm, see Create alarms on Metrics Insights queries.
Alarms based on anomaly detection models cannot have Auto Scaling actions.
When this operation creates an alarm, the alarm state is immediately
set to INSUFFICIENT_DATA
. The alarm is then evaluated and its state
is set appropriately. Any actions associated with the new 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 alarm operations:
The
iam:CreateServiceLinkedRole
permission for all alarms with EC2 actionsThe
iam:CreateServiceLinkedRole
permissions to create an alarm with Systems Manager OpsItem or response plan actions.
The first time you create an alarm in the Amazon Web Services
Management Console, the CLI, or by using the PutMetricAlarm API,
CloudWatch creates the necessary service-linked role for you. The
service-linked roles are called AWSServiceRoleForCloudWatchEvents
and AWSServiceRoleForCloudWatchAlarms_ActionSSM
. For more
information, see Amazon Web Services service-linked role.
Each PutMetricAlarm
action has a maximum uncompressed payload of 120
KB.
Cross-account alarms
You can set an alarm on metrics in the current account, or in another account. To create a cross-account alarm that watches a metric in a different account, you must have completed the following pre-requisites:
The account where the metrics are located (the sharing account) must already have a sharing role named CloudWatch-CrossAccountSharingRole. If it does not already have this role, you must create it using the instructions in Set up a sharing account in Cross-account cross-Region CloudWatch console. The policy for that role must grant access to the ID of the account where you are creating the alarm.
The account where you are creating the alarm (the monitoring account) must already have a service-linked role named AWSServiceRoleForCloudWatchCrossAccount to allow CloudWatch to assume the sharing role in the sharing account. If it does not, you must create it following the directions in Set up a monitoring account in Cross-account cross-Region CloudWatch console.
3643 3644 3645 3646 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 3643 def put_metric_alarm(params = {}, = {}) req = build_request(:put_metric_alarm, params) req.send_request() end |
#put_metric_data(params = {}) ⇒ Struct
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.
You can publish either individual data points in the Value
field, or
arrays of values and the number of times each value occurred during
the period by using the Values
and Counts
fields in the
MetricData
structure. Using the Values
and Counts
method enables
you to publish up to 150 values per metric with one PutMetricData
request, and supports retrieving percentile statistics on this data.
Each PutMetricData
request is limited to 1 MB in size for HTTP POST
requests. You can send a payload compressed by gzip. Each request is
also limited to no more than 1000 different metrics.
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 -2360 to 2360. In addition, special
values (for example, NaN, +Infinity, -Infinity) are not supported.
You can use up to 30 dimensions per metric to further clarify what data the metric collects. Each dimension consists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.
You specify the time stamp to be associated with each data point. You can specify time stamps that are as much as two weeks before the current date, and as much as 2 hours after the current day and time.
Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for GetMetricData or GetMetricStatistics from the time they are submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available for for GetMetricData or GetMetricStatistics.
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 andMin
,Max
, andSum
are all equal.The
Min
andMax
are equal, andSum
is equal toMin
multiplied bySampleCount
.
3750 3751 3752 3753 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 3750 def put_metric_data(params = {}, = {}) req = build_request(:put_metric_data, params) req.send_request() end |
#put_metric_stream(params = {}) ⇒ Types::PutMetricStreamOutput
Creates or updates a metric stream. Metric streams can automatically stream CloudWatch metrics to Amazon Web Services destinations, including Amazon S3, and to many third-party solutions.
For more information, see Using Metric Streams.
To create a metric stream, you must be signed in to an account that
has the iam:PassRole
permission and either the
CloudWatchFullAccess
policy or the cloudwatch:PutMetricStream
permission.
When you create or update a metric stream, you choose one of the following:
Stream metrics from all metric namespaces in the account.
Stream metrics from all metric namespaces in the account, except for the namespaces that you list in
ExcludeFilters
.Stream metrics from only the metric namespaces that you list in
IncludeFilters
.
By default, a metric stream always sends the MAX
, MIN
, SUM
, and
SAMPLECOUNT
statistics for each metric that is streamed. You can use
the StatisticsConfigurations
parameter to have the metric stream
send additional statistics in the stream. Streaming additional
statistics incurs additional costs. For more information, see Amazon
CloudWatch Pricing.
When you use PutMetricStream
to create a new metric stream, the
stream is created in the running
state. If you use it to update an
existing stream, the state of the stream is not changed.
If you are using CloudWatch cross-account observability and you create a metric stream in a monitoring account, you can choose whether to include metrics from source accounts in the stream. For more information, see CloudWatch cross-account observability.
3941 3942 3943 3944 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 3941 def put_metric_stream(params = {}, = {}) req = build_request(:put_metric_stream, params) req.send_request() end |
#set_alarm_state(params = {}) ⇒ Struct
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.
Metric alarms returns to their actual state quickly, often within seconds. Because the metric alarm state change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory.
If you use SetAlarmState
on a composite alarm, the composite alarm
is not guaranteed to return to its actual state. It returns to its
actual state only once any of its children alarms change state. It is
also reevaluated if you update its configuration.
If an alarm triggers EC2 Auto Scaling policies or application Auto
Scaling policies, you must include information in the
StateReasonData
parameter to enable the policy to take the correct
action.
4005 4006 4007 4008 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 4005 def set_alarm_state(params = {}, = {}) req = build_request(:set_alarm_state, params) req.send_request() end |
#start_metric_streams(params = {}) ⇒ Struct
Starts the streaming of metrics for one or more of your metric streams.
4032 4033 4034 4035 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 4032 def start_metric_streams(params = {}, = {}) req = build_request(:start_metric_streams, params) req.send_request() end |
#stop_metric_streams(params = {}) ⇒ Struct
Stops the streaming of metrics for one or more of your metric streams.
4058 4059 4060 4061 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 4058 def stop_metric_streams(params = {}, = {}) req = build_request(:stop_metric_streams, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that can be tagged are alarms and Contributor Insights rules.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the TagResource
action with an alarm that already has
tags. If you specify a new tag key for the alarm, this tag is appended
to the list of tags associated with the alarm. If you specify a tag
key that is already associated with the alarm, the new tag value that
you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a CloudWatch resource.
4119 4120 4121 4122 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 4119 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from the specified resource.
4158 4159 4160 4161 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 4158 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Basic Usage
A waiter will call an API operation until:
- It is successful
- It enters a terminal state
- It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success
or :failure
from these callbacks,
it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Valid Waiters
The following table lists the valid waiter names, the operations they call,
and the default :delay
and :max_attempts
values.
waiter_name | params | :delay | :max_attempts |
---|---|---|---|
alarm_exists | #describe_alarms | 5 | 40 |
composite_alarm_exists | #describe_alarms | 5 | 40 |
4274 4275 4276 4277 4278 |
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb', line 4274 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |