metric.rb in aws-sdk-cloudwatch-1.5.0

- old
+ new

@@ -279,12 +279,12 @@
     #   calling `GetMetricStatistics`, you must specify either `Statistics` or
     #   `ExtendedStatistics`, but not both.
     # @option options [String] :unit
     #   The unit for a given metric. Metrics may be reported in multiple
     #   units. Not supplying a unit results in all units being returned. If
-    #   the metric only ever reports one unit, specifying a unit has no
-    #   effect.
+    #   you specify only a unit that the metric does not report, the results
+    #   of the call are null.
     # @return [Types::GetMetricStatisticsOutput]
     def get_statistics(options = {})
       options = options.merge(
         namespace: @namespace,
         metric_name: @name
@@ -398,11 +398,11 @@
     #   The period, in seconds, over which the specified statistic is applied.
     #   Valid values are 10, 30, and any multiple of 60.
     #
     #   Be sure to specify 10 or 30 only for metrics that are stored by a
     #   `PutMetricData` call with a `StorageResolution` of 1. If you specify a
-    #   Period of 10 or 30 for a metric that does not have sub-minute
+    #   period of 10 or 30 for a metric that does not have sub-minute
     #   resolution, the alarm still attempts to gather data at the period rate
     #   that you specify. In this case, it does not receive data for the
     #   attempts that do not correspond to a one-minute data resolution, and
     #   the alarm may often lapse into INSUFFICENT\_DATA status. Specifying 10
     #   or 30 also sets this alarm as a high-resolution alarm, which has a
@@ -427,14 +427,26 @@
     #   If you specify a unit, you must use a unit that is appropriate for the
     #   metric. Otherwise, the CloudWatch alarm can get stuck in the
     #   `INSUFFICIENT DATA` state.
     # @option options [required, Integer] :evaluation_periods
     #   The number of periods over which data is compared to the specified
-    #   threshold. An alarm's total current evaluation period can be no
-    #   longer than one day, so this number multiplied by `Period` cannot be
-    #   more than 86,400 seconds.
+    #   threshold. If you are setting an alarm which requires that a number of
+    #   consecutive data points be breaching to trigger the alarm, this value
+    #   specifies that number. If you are setting an "M out of N" alarm,
+    #   this value is the N.
+    #
+    #   An alarm's total current evaluation period can be no longer than one
+    #   day, so this number multiplied by `Period` cannot be more than 86,400
+    #   seconds.
     # @option options [Integer] :datapoints_to_alarm
     #   The number of datapoints that must be breaching to trigger the alarm.
+    #   This is used only if you are setting an "M out of N" alarm. In that
+    #   case, this value is the M. For more information, see [Evaluating an
+    #   Alarm][1] in the *Amazon CloudWatch User Guide*.
+    #
+    #
+    #
+    #   [1]: http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation
     # @option options [required, Float] :threshold
     #   The value against which the specified statistic is compared.
     # @option options [required, String] :comparison_operator
     #   The arithmetic operation to use when comparing the specified statistic
     #   and threshold. The specified statistic value is used as the first