aws-sdk-cloudwatch 1.27.0 → 1.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0390b987a6c2bc5e73781d0d7995b4dac1c77f6
-  data.tar.gz: 86e95cf36ac15cb4b06a6179e40255bd4e401891
+  metadata.gz: 26afd1ce1a1c9695616b25f6505f9b047e07ed82
+  data.tar.gz: 4bb5ce3bc9e622a0fdd49130dea1e75948a58a36
 SHA512:
-  metadata.gz: 4f74b335db9bd93368f381bd2b2e1a76a668ad3d3e6e030a7715293c347eba98b8ca46ff5d19e021b4ca15aed5154181736fe9781643be48a2359259402fae16
-  data.tar.gz: cca228b1e309899d9a33340377b90632417071d810946a53b324d51a8f364327264a171e4bd2e89de9b4460e762fc6af1626526c1b1bd5f35cba26c6ae32a673
+  metadata.gz: 3adfb887812e83c365db6cd3ac082b7fd3643502ff3143d0b21458e411cd0fc9f095ff70678446a65330da48adf906b9b8b5fadb9777b36676affc3da4150cb1
+  data.tar.gz: 78f7d065e4fa8c96d7ecca2d8ca883c6f363a2df843f646776bf0dd072ddbd33490ca1d425b6203ae1b4ea8a9490750ed2a08b098d2a38fe3a4b3772f3670e7f

data/lib/aws-sdk-cloudwatch.rb

@@ -45,6 +45,6 @@ require_relative 'aws-sdk-cloudwatch/customizations'
 # @service
 module Aws::CloudWatch
 
-  GEM_VERSION = '1.27.0'
+  GEM_VERSION = '1.28.0'
 
 end

data/lib/aws-sdk-cloudwatch/client.rb

@@ -254,8 +254,8 @@ module Aws::CloudWatch
 
     # @!group API Operations
 
-    # Deletes the specified alarms. In the event of an error, no alarms are
-    # deleted.
+    # Deletes the specified alarms. You can delete up to 50 alarms in one
+    # operation. In the event of an error, no alarms are deleted.
     #
     # @option params [required, Array<String>] :alarm_names
     #   The alarms to be deleted.
@@ -802,6 +802,14 @@ module Aws::CloudWatch
     # 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 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.
+    #
     #
     #
     # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax
@@ -816,6 +824,31 @@ module Aws::CloudWatch
     # @option params [required, Time,DateTime,Date,Integer,String] :start_time
     #   The time stamp indicating the earliest data to be returned.
     #
+    #   The value specified is inclusive; results include data points with the
+    #   specified time stamp.
+    #
+    #   CloudWatch rounds the specified time stamp as follows:
+    #
+    #   * Start time less than 15 days ago - Round down to the nearest whole
+    #     minute. For example, 12:32:34 is rounded down to 12:32:00.
+    #
+    #   * Start time between 15 and 63 days ago - Round down to the nearest
+    #     5-minute clock interval. For example, 12:32:34 is rounded down to
+    #     12:30:00.
+    #
+    #   * Start time greater than 63 days ago - Round down to the nearest
+    #     1-hour clock interval. For example, 12:32:34 is rounded down to
+    #     12:00:00.
+    #
+    #   If you set `Period` to 5, 10, or 30, the start time of your request is
+    #   rounded down to the nearest time that corresponds to even 5-, 10-, or
+    #   30-second divisions of a minute. For example, if you make a query at
+    #   (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time
+    #   of your request is rounded down and you receive data from 01:05:10 to
+    #   01:05:20. If you make a query at 15:07:17 for the previous 5 minutes
+    #   of data, using a period of 5 seconds, you receive data timestamped
+    #   between 15:02:15 and 15:07:15.
+    #
     #   For better performance, specify `StartTime` and `EndTime` values that
     #   align with the value of the metric's `Period` and sync up with the
     #   beginning and end of an hour. For example, if the `Period` of a metric
@@ -826,6 +859,9 @@ module Aws::CloudWatch
     # @option params [required, Time,DateTime,Date,Integer,String] :end_time
     #   The time stamp indicating the latest data to be returned.
     #
+    #   The value specified is exclusive; results include data points up to
+    #   the specified time stamp.
+    #
     #   For better performance, specify `StartTime` and `EndTime` values that
     #   align with the value of the metric's `Period` and sync up with the
     #   beginning and end of an hour. For example, if the `Period` of a metric
@@ -1072,10 +1108,13 @@ module Aws::CloudWatch
     #   numbers.
     #
     # @option params [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
-    #   you specify only a unit that the metric does not report, the results
-    #   of the call are null.
+    #   The unit for a given metric. If you omit `Unit`, 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 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.
     #
     # @return [Types::GetMetricStatisticsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -1549,7 +1588,7 @@ module Aws::CloudWatch
     #
     # @option params [Boolean] :actions_enabled
     #   Indicates whether actions should be executed during any changes to the
-    #   alarm state. The default is TRUE.
+    #   alarm state. The default is `TRUE`.
     #
     # @option params [Array<String>] :ok_actions
     #   The actions to execute when this alarm transitions to an `OK` state
@@ -1612,7 +1651,9 @@ module Aws::CloudWatch
     #   `arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0`
     #
     # @option params [String] :metric_name
-    #   The name for the metric associated with the alarm.
+    #   The name for the metric associated with the alarm. For each
+    #   `PutMetricAlarm` operation, you must specify either `MetricName` or a
+    #   `Metrics` array.
     #
     #   If you are creating an alarm based on a math expression, you cannot
     #   specify this parameter, or any of the `Dimensions`, `Period`,
@@ -1642,6 +1683,10 @@ module Aws::CloudWatch
     #   `MetricName` is evaluated. Valid values are 10, 30, and any multiple
     #   of 60.
     #
+    #   `Period` is required for alarms based on static thresholds. If you are
+    #   creating an alarm based on a metric math expression, you specify the
+    #   period for each metric within the objects in the `Metrics` array.
+    #
     #   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
@@ -1669,9 +1714,18 @@ module Aws::CloudWatch
     #   help provide conceptual meaning to your data. Metric data points that
     #   specify a unit of measure, such as Percent, are aggregated separately.
     #
-    #   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.
+    #   If you don't specify `Unit`, CloudWatch retrieves all unit types that
+    #   have been published for the metric and attempts to evaluate the alarm.
+    #   Usually metrics are published with only one unit, so the alarm will
+    #   work as intended.
+    #
+    #   However, if the metric is published with multiple types of units and
+    #   you don't specify a unit, the alarm's behavior is not defined and
+    #   will behave un-predictably.
+    #
+    #   We recommend omitting `Unit` so that you don't inadvertently specify
+    #   an incorrect unit that is not published for this metric. Doing so
+    #   causes the alarm to be stuck in the `INSUFFICIENT DATA` state.
     #
     # @option params [required, Integer] :evaluation_periods
     #   The number of periods over which data is compared to the specified
@@ -1697,6 +1751,9 @@ module Aws::CloudWatch
     # @option params [Float] :threshold
     #   The value against which the specified statistic is compared.
     #
+    #   This parameter is required for alarms based on static thresholds, but
+    #   should not be used for alarms based on anomaly detection models.
+    #
     # @option params [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
@@ -1735,9 +1792,12 @@ module Aws::CloudWatch
     #
     # @option params [Array<Types::MetricDataQuery>] :metrics
     #   An array of `MetricDataQuery` structures that enable you to create an
-    #   alarm based on the result of a metric math expression. Each item in
-    #   the `Metrics` array either retrieves a metric or performs a math
-    #   expression.
+    #   alarm based on the result of a metric math expression. For each
+    #   `PutMetricAlarm` operation, you must specify either `MetricName` or a
+    #   `Metrics` array.
+    #
+    #   Each item in the `Metrics` array either retrieves a metric or performs
+    #   a math expression.
     #
     #   One item in the `Metrics` array is the expression that the alarm
     #   watches. You designate this expression by setting `ReturnValue` to
@@ -1889,9 +1949,8 @@ module Aws::CloudWatch
     # @option params [required, String] :namespace
     #   The namespace for the metric data.
     #
-    #   You cannot specify a namespace that begins with "AWS/". Namespaces
-    #   that begin with "AWS/" are reserved for use by Amazon Web Services
-    #   products.
+    #   To avoid conflicts with AWS service namespaces, you should not specify
+    #   a namespace that begins with `AWS/`
     #
     # @option params [required, Array<Types::MetricDatum>] :metric_data
     #   The data for the metric. The array can include no more than 20 metrics
@@ -2080,7 +2139,7 @@ module Aws::CloudWatch
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-cloudwatch'
-      context[:gem_version] = '1.27.0'
+      context[:gem_version] = '1.28.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-cloudwatch/metric.rb

@@ -281,10 +281,13 @@ module Aws::CloudWatch
     #   available for metrics when any of the metric values are negative
     #   numbers.
     # @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
-    #   you specify only a unit that the metric does not report, the results
-    #   of the call are null.
+    #   The unit for a given metric. If you omit `Unit`, 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 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.
     # @return [Types::GetMetricStatisticsOutput]
     def get_statistics(options = {})
       options = options.merge(
@@ -359,7 +362,7 @@ module Aws::CloudWatch
     #   The description for the alarm.
     # @option options [Boolean] :actions_enabled
     #   Indicates whether actions should be executed during any changes to the
-    #   alarm state. The default is TRUE.
+    #   alarm state. The default is `TRUE`.
     # @option options [Array<String>] :ok_actions
     #   The actions to execute when this alarm transitions to an `OK` state
     #   from any other state. Each action is specified as an Amazon Resource
@@ -434,6 +437,10 @@ module Aws::CloudWatch
     #   `MetricName` is evaluated. Valid values are 10, 30, and any multiple
     #   of 60.
     #
+    #   `Period` is required for alarms based on static thresholds. If you are
+    #   creating an alarm based on a metric math expression, you specify the
+    #   period for each metric within the objects in the `Metrics` array.
+    #
     #   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
@@ -460,9 +467,18 @@ module Aws::CloudWatch
     #   help provide conceptual meaning to your data. Metric data points that
     #   specify a unit of measure, such as Percent, are aggregated separately.
     #
-    #   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.
+    #   If you don't specify `Unit`, CloudWatch retrieves all unit types that
+    #   have been published for the metric and attempts to evaluate the alarm.
+    #   Usually metrics are published with only one unit, so the alarm will
+    #   work as intended.
+    #
+    #   However, if the metric is published with multiple types of units and
+    #   you don't specify a unit, the alarm's behavior is not defined and
+    #   will behave un-predictably.
+    #
+    #   We recommend omitting `Unit` so that you don't inadvertently specify
+    #   an incorrect unit that is not published for this metric. Doing so
+    #   causes the alarm to be 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. If you are setting an alarm that requires that a number of
@@ -484,6 +500,9 @@ module Aws::CloudWatch
     #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation
     # @option options [Float] :threshold
     #   The value against which the specified statistic is compared.
+    #
+    #   This parameter is required for alarms based on static thresholds, but
+    #   should not be used for alarms based on anomaly detection models.
     # @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
@@ -519,9 +538,12 @@ module Aws::CloudWatch
     #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#percentiles-with-low-samples
     # @option options [Array<Types::MetricDataQuery>] :metrics
     #   An array of `MetricDataQuery` structures that enable you to create an
-    #   alarm based on the result of a metric math expression. Each item in
-    #   the `Metrics` array either retrieves a metric or performs a math
-    #   expression.
+    #   alarm based on the result of a metric math expression. For each
+    #   `PutMetricAlarm` operation, you must specify either `MetricName` or a
+    #   `Metrics` array.
+    #
+    #   Each item in the `Metrics` array either retrieves a metric or performs
+    #   a math expression.
     #
     #   One item in the `Metrics` array is the expression that the alarm
     #   watches. You designate this expression by setting `ReturnValue` to

data/lib/aws-sdk-cloudwatch/types.rb

@@ -795,6 +795,31 @@ module Aws::CloudWatch
     # @!attribute [rw] start_time
     #   The time stamp indicating the earliest data to be returned.
     #
+    #   The value specified is inclusive; results include data points with
+    #   the specified time stamp.
+    #
+    #   CloudWatch rounds the specified time stamp as follows:
+    #
+    #   * Start time less than 15 days ago - Round down to the nearest whole
+    #     minute. For example, 12:32:34 is rounded down to 12:32:00.
+    #
+    #   * Start time between 15 and 63 days ago - Round down to the nearest
+    #     5-minute clock interval. For example, 12:32:34 is rounded down to
+    #     12:30:00.
+    #
+    #   * Start time greater than 63 days ago - Round down to the nearest
+    #     1-hour clock interval. For example, 12:32:34 is rounded down to
+    #     12:00:00.
+    #
+    #   If you set `Period` to 5, 10, or 30, the start time of your request
+    #   is rounded down to the nearest time that corresponds to even 5-,
+    #   10-, or 30-second divisions of a minute. For example, if you make a
+    #   query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the
+    #   start time of your request is rounded down and you receive data from
+    #   01:05:10 to 01:05:20. If you make a query at 15:07:17 for the
+    #   previous 5 minutes of data, using a period of 5 seconds, you receive
+    #   data timestamped between 15:02:15 and 15:07:15.
+    #
     #   For better performance, specify `StartTime` and `EndTime` values
     #   that align with the value of the metric's `Period` and sync up with
     #   the beginning and end of an hour. For example, if the `Period` of a
@@ -806,6 +831,9 @@ module Aws::CloudWatch
     # @!attribute [rw] end_time
     #   The time stamp indicating the latest data to be returned.
     #
+    #   The value specified is exclusive; results include data points up to
+    #   the specified time stamp.
+    #
     #   For better performance, specify `StartTime` and `EndTime` values
     #   that align with the value of the metric's `Period` and sync up with
     #   the beginning and end of an hour. For example, if the `Period` of a
@@ -1000,10 +1028,13 @@ module Aws::CloudWatch
     #   @return [Array<String>]
     #
     # @!attribute [rw] 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
-    #   you specify only a unit that the metric does not report, the results
-    #   of the call are null.
+    #   The unit for a given metric. If you omit `Unit`, 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 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.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricStatisticsInput AWS API Documentation
@@ -1809,8 +1840,10 @@ module Aws::CloudWatch
     #
     # @!attribute [rw] unit
     #   When you are using a `Put` operation, this defines what unit you
-    #   want to use when storing the metric. In a `Get` operation, this
-    #   displays the unit that is used for the metric.
+    #   want to use when storing the metric.
+    #
+    #   In a `Get` operation, this displays the unit that is used for the
+    #   metric.
     #   @return [String]
     #
     # @!attribute [rw] storage_resolution
@@ -1884,8 +1917,15 @@ module Aws::CloudWatch
     #
     # @!attribute [rw] unit
     #   When you are using a `Put` operation, this defines what unit you
-    #   want to use when storing the metric. In a `Get` operation, this
-    #   displays the unit that is used for the metric.
+    #   want to use when storing the metric.
+    #
+    #   In a `Get` operation, if you omit `Unit` then 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 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.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricStat AWS API Documentation
@@ -2101,7 +2141,7 @@ module Aws::CloudWatch
     #
     # @!attribute [rw] actions_enabled
     #   Indicates whether actions should be executed during any changes to
-    #   the alarm state. The default is TRUE.
+    #   the alarm state. The default is `TRUE`.
     #   @return [Boolean]
     #
     # @!attribute [rw] ok_actions
@@ -2168,7 +2208,9 @@ module Aws::CloudWatch
     #   @return [Array<String>]
     #
     # @!attribute [rw] metric_name
-    #   The name for the metric associated with the alarm.
+    #   The name for the metric associated with the alarm. For each
+    #   `PutMetricAlarm` operation, you must specify either `MetricName` or
+    #   a `Metrics` array.
     #
     #   If you are creating an alarm based on a math expression, you cannot
     #   specify this parameter, or any of the `Dimensions`, `Period`,
@@ -2203,6 +2245,11 @@ module Aws::CloudWatch
     #   `MetricName` is evaluated. Valid values are 10, 30, and any multiple
     #   of 60.
     #
+    #   `Period` is required for alarms based on static thresholds. If you
+    #   are creating an alarm based on a metric math expression, you specify
+    #   the period for each metric within the objects in the `Metrics`
+    #   array.
+    #
     #   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
@@ -2232,9 +2279,19 @@ module Aws::CloudWatch
     #   data points that specify a unit of measure, such as Percent, are
     #   aggregated separately.
     #
-    #   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.
+    #   If you don't specify `Unit`, CloudWatch retrieves all unit types
+    #   that have been published for the metric and attempts to evaluate the
+    #   alarm. Usually metrics are published with only one unit, so the
+    #   alarm will work as intended.
+    #
+    #   However, if the metric is published with multiple types of units and
+    #   you don't specify a unit, the alarm's behavior is not defined and
+    #   will behave un-predictably.
+    #
+    #   We recommend omitting `Unit` so that you don't inadvertently
+    #   specify an incorrect unit that is not published for this metric.
+    #   Doing so causes the alarm to be stuck in the `INSUFFICIENT DATA`
+    #   state.
     #   @return [String]
     #
     # @!attribute [rw] evaluation_periods
@@ -2262,6 +2319,9 @@ module Aws::CloudWatch
     #
     # @!attribute [rw] threshold
     #   The value against which the specified statistic is compared.
+    #
+    #   This parameter is required for alarms based on static thresholds,
+    #   but should not be used for alarms based on anomaly detection models.
     #   @return [Float]
     #
     # @!attribute [rw] comparison_operator
@@ -2305,9 +2365,12 @@ module Aws::CloudWatch
     #
     # @!attribute [rw] metrics
     #   An array of `MetricDataQuery` structures that enable you to create
-    #   an alarm based on the result of a metric math expression. Each item
-    #   in the `Metrics` array either retrieves a metric or performs a math
-    #   expression.
+    #   an alarm based on the result of a metric math expression. For each
+    #   `PutMetricAlarm` operation, you must specify either `MetricName` or
+    #   a `Metrics` array.
+    #
+    #   Each item in the `Metrics` array either retrieves a metric or
+    #   performs a math expression.
     #
     #   One item in the `Metrics` array is the expression that the alarm
     #   watches. You designate this expression by setting `ReturnValue` to
@@ -2403,9 +2466,8 @@ module Aws::CloudWatch
     # @!attribute [rw] namespace
     #   The namespace for the metric data.
     #
-    #   You cannot specify a namespace that begins with "AWS/". Namespaces
-    #   that begin with "AWS/" are reserved for use by Amazon Web Services
-    #   products.
+    #   To avoid conflicts with AWS service namespaces, you should not
+    #   specify a namespace that begins with `AWS/`
     #   @return [String]
     #
     # @!attribute [rw] metric_data

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-cloudwatch
 version: !ruby/object:Gem::Version
-  version: 1.27.0
+  version: 1.28.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-25 00:00:00.000000000 Z
+date: 2019-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core