aws-sdk-cloudwatch 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48d9aa663940824517dcdfdfa92aad12885b40b4
-  data.tar.gz: 3e5cf0dc65052892ac7bd9b3a33f2ab403c7e025
+  metadata.gz: 685e98cfaecb5af8b1aee48655bb4d6521121e94
+  data.tar.gz: 17429224187972f355db51ff811ec87e284b7cef
 SHA512:
-  metadata.gz: f4ffe66e229cf3a26b4894e9f164b53759348d33a08f06c436bc2d33b63765b6d2989db22da68a3e85c5af480fd2318f014d6c9439bfd0bc23bc0ab99c87e70d
-  data.tar.gz: 75ee0e804f85db0fc3f55ce3a83015846b5337fb747fe9c08aad2603defa7d857da3367f6a20245a9d6a9d632e613197e4aab4fa67f34ccf8d7baa459c693314
+  metadata.gz: 29977d078d428b6d9430e2d65eaeb3a6686e41ebe75d2ae3d71525dbdda7ec5b616087a00341d56957c6f95b629a19def012f5e81984cfb9dc5ba8e1ee1e4166
+  data.tar.gz: ff00383f7f7a87dc97e29ca2332926e55f92bce485b08f0d7eaadf5bac18a9263c8e17f0dc95b14c4737d1169bf5e833b2c4b48249ac670346a339da121795f7

data/lib/aws-sdk-cloudwatch.rb

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

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

@@ -511,6 +511,114 @@ module Aws::CloudWatch
       req.send_request(options)
     end
 
+    # You can use the `GetMetricData` API to retrieve as many as 100
+    # different metrics in a single request, with a total of as many as
+    # 100,800 datapoints. You can also optionally perform 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][1] in the
+    # *Amazon CloudWatch User Guide*.
+    #
+    # Calls to the `GetMetricData` API have a different pricing structure
+    # than calls to `GetMetricStatistics`. For more information about
+    # pricing, see [Amazon CloudWatch Pricing][2].
+    #
+    #
+    #
+    # [1]: http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax
+    # [2]: https://aws.amazon.com/cloudwatch/pricing/
+    #
+    # @option params [required, Array<Types::MetricDataQuery>] :metric_data_queries
+    #   The metric queries to be returned. A single `GetMetricData` call can
+    #   include as many as 100 `MetricDataQuery` structures. Each of these
+    #   structures can specify either a metric to retrieve, or a math
+    #   expression to perform on retrieved data.
+    #
+    # @option params [required, Time,DateTime,Date,Integer,String] :start_time
+    #   The time stamp indicating the earliest data to be returned.
+    #
+    # @option params [required, Time,DateTime,Date,Integer,String] :end_time
+    #   The time stamp indicating the latest data to be returned.
+    #
+    # @option params [String] :next_token
+    #   Include this value, if it was returned by the previous call, to get
+    #   the next set of data points.
+    #
+    # @option params [String] :scan_by
+    #   The order in which data points should be returned.
+    #   `TimestampDescending` returns the newest data first and paginates when
+    #   the `MaxDatapoints` limit is reached. `TimestampAscending` returns the
+    #   oldest data first and paginates when the `MaxDatapoints` limit is
+    #   reached.
+    #
+    # @option params [Integer] :max_datapoints
+    #   The maximum number of data points the request should return before
+    #   paginating. If you omit this, the default of 100,800 is used.
+    #
+    # @return [Types::GetMetricDataOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetMetricDataOutput#metric_data_results #metric_data_results} => Array&lt;Types::MetricDataResult&gt;
+    #   * {Types::GetMetricDataOutput#next_token #next_token} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_metric_data({
+    #     metric_data_queries: [ # required
+    #       {
+    #         id: "MetricId", # required
+    #         metric_stat: {
+    #           metric: { # required
+    #             namespace: "Namespace",
+    #             metric_name: "MetricName",
+    #             dimensions: [
+    #               {
+    #                 name: "DimensionName", # required
+    #                 value: "DimensionValue", # required
+    #               },
+    #             ],
+    #           },
+    #           period: 1, # required
+    #           stat: "Stat", # required
+    #           unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
+    #         },
+    #         expression: "MetricExpression",
+    #         label: "MetricLabel",
+    #         return_data: false,
+    #       },
+    #     ],
+    #     start_time: Time.now, # required
+    #     end_time: Time.now, # required
+    #     next_token: "NextToken",
+    #     scan_by: "TimestampDescending", # accepts TimestampDescending, TimestampAscending
+    #     max_datapoints: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.metric_data_results #=> Array
+    #   resp.metric_data_results[0].id #=> String
+    #   resp.metric_data_results[0].label #=> String
+    #   resp.metric_data_results[0].timestamps #=> Array
+    #   resp.metric_data_results[0].timestamps[0] #=> Time
+    #   resp.metric_data_results[0].values #=> Array
+    #   resp.metric_data_results[0].values[0] #=> Float
+    #   resp.metric_data_results[0].status_code #=> String, one of "Complete", "InternalError", "PartialData"
+    #   resp.metric_data_results[0].messages #=> Array
+    #   resp.metric_data_results[0].messages[0].code #=> String
+    #   resp.metric_data_results[0].messages[0].value #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricData AWS API Documentation
+    #
+    # @overload get_metric_data(params = {})
+    # @param [Hash] params ({})
+    def get_metric_data(params = {}, options = {})
+      req = build_request(:get_metric_data, params)
+      req.send_request(options)
+    end
+
     # Gets statistics for the specified metric.
     #
     # The maximum number of data points returned from a single call is
@@ -667,8 +775,8 @@ module Aws::CloudWatch
     # @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
-    #   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] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -1028,7 +1136,7 @@ module Aws::CloudWatch
     #
     #   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
@@ -1059,12 +1167,24 @@ module Aws::CloudWatch
     #
     # @option params [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 params [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 params [required, Float] :threshold
     #   The value against which the specified statistic is compared.
@@ -1284,7 +1404,7 @@ module Aws::CloudWatch
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-cloudwatch'
-      context[:gem_version] = '1.4.0'
+      context[:gem_version] = '1.5.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -38,6 +38,7 @@ module Aws::CloudWatch
     Datapoint = Shapes::StructureShape.new(name: 'Datapoint')
     DatapointValue = Shapes::FloatShape.new(name: 'DatapointValue')
     DatapointValueMap = Shapes::MapShape.new(name: 'DatapointValueMap')
+    DatapointValues = Shapes::ListShape.new(name: 'DatapointValues')
     Datapoints = Shapes::ListShape.new(name: 'Datapoints')
     DatapointsToAlarm = Shapes::IntegerShape.new(name: 'DatapointsToAlarm')
     DeleteAlarmsInput = Shapes::StructureShape.new(name: 'DeleteAlarmsInput')
@@ -65,6 +66,9 @@ module Aws::CloudWatch
     FaultDescription = Shapes::StringShape.new(name: 'FaultDescription')
     GetDashboardInput = Shapes::StructureShape.new(name: 'GetDashboardInput')
     GetDashboardOutput = Shapes::StructureShape.new(name: 'GetDashboardOutput')
+    GetMetricDataInput = Shapes::StructureShape.new(name: 'GetMetricDataInput')
+    GetMetricDataMaxDatapoints = Shapes::IntegerShape.new(name: 'GetMetricDataMaxDatapoints')
+    GetMetricDataOutput = Shapes::StructureShape.new(name: 'GetMetricDataOutput')
     GetMetricStatisticsInput = Shapes::StructureShape.new(name: 'GetMetricStatisticsInput')
     GetMetricStatisticsOutput = Shapes::StructureShape.new(name: 'GetMetricStatisticsOutput')
     HistoryData = Shapes::StringShape.new(name: 'HistoryData')
@@ -83,13 +87,24 @@ module Aws::CloudWatch
     ListMetricsOutput = Shapes::StructureShape.new(name: 'ListMetricsOutput')
     MaxRecords = Shapes::IntegerShape.new(name: 'MaxRecords')
     Message = Shapes::StringShape.new(name: 'Message')
+    MessageData = Shapes::StructureShape.new(name: 'MessageData')
+    MessageDataCode = Shapes::StringShape.new(name: 'MessageDataCode')
+    MessageDataValue = Shapes::StringShape.new(name: 'MessageDataValue')
     Metric = Shapes::StructureShape.new(name: 'Metric')
     MetricAlarm = Shapes::StructureShape.new(name: 'MetricAlarm')
     MetricAlarms = Shapes::ListShape.new(name: 'MetricAlarms')
     MetricData = Shapes::ListShape.new(name: 'MetricData')
+    MetricDataQueries = Shapes::ListShape.new(name: 'MetricDataQueries')
+    MetricDataQuery = Shapes::StructureShape.new(name: 'MetricDataQuery')
+    MetricDataResult = Shapes::StructureShape.new(name: 'MetricDataResult')
+    MetricDataResultMessages = Shapes::ListShape.new(name: 'MetricDataResultMessages')
+    MetricDataResults = Shapes::ListShape.new(name: 'MetricDataResults')
     MetricDatum = Shapes::StructureShape.new(name: 'MetricDatum')
+    MetricExpression = Shapes::StringShape.new(name: 'MetricExpression')
+    MetricId = Shapes::StringShape.new(name: 'MetricId')
     MetricLabel = Shapes::StringShape.new(name: 'MetricLabel')
     MetricName = Shapes::StringShape.new(name: 'MetricName')
+    MetricStat = Shapes::StructureShape.new(name: 'MetricStat')
     Metrics = Shapes::ListShape.new(name: 'Metrics')
     MissingRequiredParameterException = Shapes::StructureShape.new(name: 'MissingRequiredParameterException')
     Namespace = Shapes::StringShape.new(name: 'Namespace')
@@ -102,18 +117,23 @@ module Aws::CloudWatch
     ResourceList = Shapes::ListShape.new(name: 'ResourceList')
     ResourceName = Shapes::StringShape.new(name: 'ResourceName')
     ResourceNotFound = Shapes::StructureShape.new(name: 'ResourceNotFound')
+    ReturnData = Shapes::BooleanShape.new(name: 'ReturnData')
+    ScanBy = Shapes::StringShape.new(name: 'ScanBy')
     SetAlarmStateInput = Shapes::StructureShape.new(name: 'SetAlarmStateInput')
     Size = Shapes::IntegerShape.new(name: 'Size')
     StandardUnit = Shapes::StringShape.new(name: 'StandardUnit')
+    Stat = Shapes::StringShape.new(name: 'Stat')
     StateReason = Shapes::StringShape.new(name: 'StateReason')
     StateReasonData = Shapes::StringShape.new(name: 'StateReasonData')
     StateValue = Shapes::StringShape.new(name: 'StateValue')
     Statistic = Shapes::StringShape.new(name: 'Statistic')
     StatisticSet = Shapes::StructureShape.new(name: 'StatisticSet')
     Statistics = Shapes::ListShape.new(name: 'Statistics')
+    StatusCode = Shapes::StringShape.new(name: 'StatusCode')
     StorageResolution = Shapes::IntegerShape.new(name: 'StorageResolution')
     Threshold = Shapes::FloatShape.new(name: 'Threshold')
     Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
+    Timestamps = Shapes::ListShape.new(name: 'Timestamps')
     TreatMissingData = Shapes::StringShape.new(name: 'TreatMissingData')
 
     AlarmHistoryItem.add_member(:alarm_name, Shapes::ShapeRef.new(shape: AlarmName, location_name: "AlarmName"))
@@ -156,6 +176,8 @@ module Aws::CloudWatch
     DatapointValueMap.key = Shapes::ShapeRef.new(shape: ExtendedStatistic)
     DatapointValueMap.value = Shapes::ShapeRef.new(shape: DatapointValue)
 
+    DatapointValues.member = Shapes::ShapeRef.new(shape: DatapointValue)
+
     Datapoints.member = Shapes::ShapeRef.new(shape: Datapoint)
 
     DeleteAlarmsInput.add_member(:alarm_names, Shapes::ShapeRef.new(shape: AlarmNames, required: true, location_name: "AlarmNames"))
@@ -230,6 +252,18 @@ module Aws::CloudWatch
     GetDashboardOutput.add_member(:dashboard_name, Shapes::ShapeRef.new(shape: DashboardName, location_name: "DashboardName"))
     GetDashboardOutput.struct_class = Types::GetDashboardOutput
 
+    GetMetricDataInput.add_member(:metric_data_queries, Shapes::ShapeRef.new(shape: MetricDataQueries, required: true, location_name: "MetricDataQueries"))
+    GetMetricDataInput.add_member(:start_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "StartTime"))
+    GetMetricDataInput.add_member(:end_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "EndTime"))
+    GetMetricDataInput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
+    GetMetricDataInput.add_member(:scan_by, Shapes::ShapeRef.new(shape: ScanBy, location_name: "ScanBy"))
+    GetMetricDataInput.add_member(:max_datapoints, Shapes::ShapeRef.new(shape: GetMetricDataMaxDatapoints, location_name: "MaxDatapoints"))
+    GetMetricDataInput.struct_class = Types::GetMetricDataInput
+
+    GetMetricDataOutput.add_member(:metric_data_results, Shapes::ShapeRef.new(shape: MetricDataResults, location_name: "MetricDataResults"))
+    GetMetricDataOutput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
+    GetMetricDataOutput.struct_class = Types::GetMetricDataOutput
+
     GetMetricStatisticsInput.add_member(:namespace, Shapes::ShapeRef.new(shape: Namespace, required: true, location_name: "Namespace"))
     GetMetricStatisticsInput.add_member(:metric_name, Shapes::ShapeRef.new(shape: MetricName, required: true, location_name: "MetricName"))
     GetMetricStatisticsInput.add_member(:dimensions, Shapes::ShapeRef.new(shape: Dimensions, location_name: "Dimensions"))
@@ -263,6 +297,10 @@ module Aws::CloudWatch
     ListMetricsOutput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
     ListMetricsOutput.struct_class = Types::ListMetricsOutput
 
+    MessageData.add_member(:code, Shapes::ShapeRef.new(shape: MessageDataCode, location_name: "Code"))
+    MessageData.add_member(:value, Shapes::ShapeRef.new(shape: MessageDataValue, location_name: "Value"))
+    MessageData.struct_class = Types::MessageData
+
     Metric.add_member(:namespace, Shapes::ShapeRef.new(shape: Namespace, location_name: "Namespace"))
     Metric.add_member(:metric_name, Shapes::ShapeRef.new(shape: MetricName, location_name: "MetricName"))
     Metric.add_member(:dimensions, Shapes::ShapeRef.new(shape: Dimensions, location_name: "Dimensions"))
@@ -299,6 +337,27 @@ module Aws::CloudWatch
 
     MetricData.member = Shapes::ShapeRef.new(shape: MetricDatum)
 
+    MetricDataQueries.member = Shapes::ShapeRef.new(shape: MetricDataQuery)
+
+    MetricDataQuery.add_member(:id, Shapes::ShapeRef.new(shape: MetricId, required: true, location_name: "Id"))
+    MetricDataQuery.add_member(:metric_stat, Shapes::ShapeRef.new(shape: MetricStat, location_name: "MetricStat"))
+    MetricDataQuery.add_member(:expression, Shapes::ShapeRef.new(shape: MetricExpression, location_name: "Expression"))
+    MetricDataQuery.add_member(:label, Shapes::ShapeRef.new(shape: MetricLabel, location_name: "Label"))
+    MetricDataQuery.add_member(:return_data, Shapes::ShapeRef.new(shape: ReturnData, location_name: "ReturnData"))
+    MetricDataQuery.struct_class = Types::MetricDataQuery
+
+    MetricDataResult.add_member(:id, Shapes::ShapeRef.new(shape: MetricId, location_name: "Id"))
+    MetricDataResult.add_member(:label, Shapes::ShapeRef.new(shape: MetricLabel, location_name: "Label"))
+    MetricDataResult.add_member(:timestamps, Shapes::ShapeRef.new(shape: Timestamps, location_name: "Timestamps"))
+    MetricDataResult.add_member(:values, Shapes::ShapeRef.new(shape: DatapointValues, location_name: "Values"))
+    MetricDataResult.add_member(:status_code, Shapes::ShapeRef.new(shape: StatusCode, location_name: "StatusCode"))
+    MetricDataResult.add_member(:messages, Shapes::ShapeRef.new(shape: MetricDataResultMessages, location_name: "Messages"))
+    MetricDataResult.struct_class = Types::MetricDataResult
+
+    MetricDataResultMessages.member = Shapes::ShapeRef.new(shape: MessageData)
+
+    MetricDataResults.member = Shapes::ShapeRef.new(shape: MetricDataResult)
+
     MetricDatum.add_member(:metric_name, Shapes::ShapeRef.new(shape: MetricName, required: true, location_name: "MetricName"))
     MetricDatum.add_member(:dimensions, Shapes::ShapeRef.new(shape: Dimensions, location_name: "Dimensions"))
     MetricDatum.add_member(:timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "Timestamp"))
@@ -308,6 +367,12 @@ module Aws::CloudWatch
     MetricDatum.add_member(:storage_resolution, Shapes::ShapeRef.new(shape: StorageResolution, location_name: "StorageResolution"))
     MetricDatum.struct_class = Types::MetricDatum
 
+    MetricStat.add_member(:metric, Shapes::ShapeRef.new(shape: Metric, required: true, location_name: "Metric"))
+    MetricStat.add_member(:period, Shapes::ShapeRef.new(shape: Period, required: true, location_name: "Period"))
+    MetricStat.add_member(:stat, Shapes::ShapeRef.new(shape: Stat, required: true, location_name: "Stat"))
+    MetricStat.add_member(:unit, Shapes::ShapeRef.new(shape: StandardUnit, location_name: "Unit"))
+    MetricStat.struct_class = Types::MetricStat
+
     Metrics.member = Shapes::ShapeRef.new(shape: Metric)
 
     PutDashboardInput.add_member(:dashboard_name, Shapes::ShapeRef.new(shape: DashboardName, required: true, location_name: "DashboardName"))
@@ -358,6 +423,8 @@ module Aws::CloudWatch
 
     Statistics.member = Shapes::ShapeRef.new(shape: Statistic)
 
+    Timestamps.member = Shapes::ShapeRef.new(shape: Timestamp)
+
 
     # @api private
     API = Seahorse::Model::Api.new.tap do |api|
@@ -457,6 +524,15 @@ module Aws::CloudWatch
         o.errors << Shapes::ShapeRef.new(shape: InternalServiceFault)
       end)
 
+      api.add_operation(:get_metric_data, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "GetMetricData"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: GetMetricDataInput)
+        o.output = Shapes::ShapeRef.new(shape: GetMetricDataOutput)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidNextToken)
+      end)
+
       api.add_operation(:get_metric_statistics, Seahorse::Model::Operation.new.tap do |o|
         o.name = "GetMetricStatistics"
         o.http_method = "POST"

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

@@ -281,8 +281,8 @@ module Aws::CloudWatch
     # @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(
@@ -400,7 +400,7 @@ module Aws::CloudWatch
     #
     #   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
@@ -429,11 +429,23 @@ module Aws::CloudWatch
     #   `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

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

@@ -516,6 +516,102 @@ module Aws::CloudWatch
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass GetMetricDataInput
+    #   data as a hash:
+    #
+    #       {
+    #         metric_data_queries: [ # required
+    #           {
+    #             id: "MetricId", # required
+    #             metric_stat: {
+    #               metric: { # required
+    #                 namespace: "Namespace",
+    #                 metric_name: "MetricName",
+    #                 dimensions: [
+    #                   {
+    #                     name: "DimensionName", # required
+    #                     value: "DimensionValue", # required
+    #                   },
+    #                 ],
+    #               },
+    #               period: 1, # required
+    #               stat: "Stat", # required
+    #               unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
+    #             },
+    #             expression: "MetricExpression",
+    #             label: "MetricLabel",
+    #             return_data: false,
+    #           },
+    #         ],
+    #         start_time: Time.now, # required
+    #         end_time: Time.now, # required
+    #         next_token: "NextToken",
+    #         scan_by: "TimestampDescending", # accepts TimestampDescending, TimestampAscending
+    #         max_datapoints: 1,
+    #       }
+    #
+    # @!attribute [rw] metric_data_queries
+    #   The metric queries to be returned. A single `GetMetricData` call can
+    #   include as many as 100 `MetricDataQuery` structures. Each of these
+    #   structures can specify either a metric to retrieve, or a math
+    #   expression to perform on retrieved data.
+    #   @return [Array<Types::MetricDataQuery>]
+    #
+    # @!attribute [rw] start_time
+    #   The time stamp indicating the earliest data to be returned.
+    #   @return [Time]
+    #
+    # @!attribute [rw] end_time
+    #   The time stamp indicating the latest data to be returned.
+    #   @return [Time]
+    #
+    # @!attribute [rw] next_token
+    #   Include this value, if it was returned by the previous call, to get
+    #   the next set of data points.
+    #   @return [String]
+    #
+    # @!attribute [rw] scan_by
+    #   The order in which data points should be returned.
+    #   `TimestampDescending` returns the newest data first and paginates
+    #   when the `MaxDatapoints` limit is reached. `TimestampAscending`
+    #   returns the oldest data first and paginates when the `MaxDatapoints`
+    #   limit is reached.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_datapoints
+    #   The maximum number of data points the request should return before
+    #   paginating. If you omit this, the default of 100,800 is used.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricDataInput AWS API Documentation
+    #
+    class GetMetricDataInput < Struct.new(
+      :metric_data_queries,
+      :start_time,
+      :end_time,
+      :next_token,
+      :scan_by,
+      :max_datapoints)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] metric_data_results
+    #   The metrics that are returned, including the metric name, namespace,
+    #   and dimensions.
+    #   @return [Array<Types::MetricDataResult>]
+    #
+    # @!attribute [rw] next_token
+    #   A token that marks the next batch of returned results.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricDataOutput AWS API Documentation
+    #
+    class GetMetricDataOutput < Struct.new(
+      :metric_data_results,
+      :next_token)
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass GetMetricStatisticsInput
     #   data as a hash:
     #
@@ -641,8 +737,8 @@ module Aws::CloudWatch
     # @!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
-    #   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 [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricStatisticsInput AWS API Documentation
@@ -780,8 +876,41 @@ module Aws::CloudWatch
       include Aws::Structure
     end
 
+    # A message returned by the `GetMetricData`API, including a code and a
+    # description.
+    #
+    # @!attribute [rw] code
+    #   The error code or status code associated with the message.
+    #   @return [String]
+    #
+    # @!attribute [rw] value
+    #   The message text.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MessageData AWS API Documentation
+    #
+    class MessageData < Struct.new(
+      :code,
+      :value)
+      include Aws::Structure
+    end
+
     # Represents a specific metric.
     #
+    # @note When making an API call, you may pass Metric
+    #   data as a hash:
+    #
+    #       {
+    #         namespace: "Namespace",
+    #         metric_name: "MetricName",
+    #         dimensions: [
+    #           {
+    #             name: "DimensionName", # required
+    #             value: "DimensionValue", # required
+    #           },
+    #         ],
+    #       }
+    #
     # @!attribute [rw] namespace
     #   The namespace of the metric.
     #   @return [String]
@@ -954,6 +1083,147 @@ module Aws::CloudWatch
       include Aws::Structure
     end
 
+    # This structure 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 100 `MetricDataQuery` structures.
+    #
+    # @note When making an API call, you may pass MetricDataQuery
+    #   data as a hash:
+    #
+    #       {
+    #         id: "MetricId", # required
+    #         metric_stat: {
+    #           metric: { # required
+    #             namespace: "Namespace",
+    #             metric_name: "MetricName",
+    #             dimensions: [
+    #               {
+    #                 name: "DimensionName", # required
+    #                 value: "DimensionValue", # required
+    #               },
+    #             ],
+    #           },
+    #           period: 1, # required
+    #           stat: "Stat", # required
+    #           unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
+    #         },
+    #         expression: "MetricExpression",
+    #         label: "MetricLabel",
+    #         return_data: false,
+    #       }
+    #
+    # @!attribute [rw] id
+    #   A short name used to tie this structure to the results in the
+    #   response. This name must be unique within a single call to
+    #   `GetMetricData`. If you are performing math expressions on this set
+    #   of data, this name represents that data and can serve as a variable
+    #   in the mathematical expression. The valid characters are letters,
+    #   numbers, and underscore. The first character must be a lowercase
+    #   letter.
+    #   @return [String]
+    #
+    # @!attribute [rw] metric_stat
+    #   The metric to be returned, along with statistics, period, and units.
+    #   Use this parameter only if this structure is performing a data
+    #   retrieval and not performing a math expression on the returned data.
+    #
+    #   Within one MetricDataQuery structure, you must specify either
+    #   `Expression` or `MetricStat` but not both.
+    #   @return [Types::MetricStat]
+    #
+    # @!attribute [rw] expression
+    #   The math expression to be performed on the returned data, if this
+    #   structure is performing a math expression. For more information
+    #   about metric math expressions, see [Metric Math Syntax and
+    #   Functions][1] in the *Amazon CloudWatch User Guide*.
+    #
+    #   Within one MetricDataQuery structure, you must specify either
+    #   `Expression` or `MetricStat` but not both.
+    #
+    #
+    #
+    #   [1]: http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax
+    #   @return [String]
+    #
+    # @!attribute [rw] label
+    #   A human-readable label for this metric or expression. This is
+    #   especially useful if this is an expression, so that you know what
+    #   the value represents. If the metric or expression is shown in a
+    #   CloudWatch dashboard widget, the label is shown. If Label is
+    #   omitted, CloudWatch generates a default.
+    #   @return [String]
+    #
+    # @!attribute [rw] return_data
+    #   Indicates whether to return the time stamps and raw data values of
+    #   this metric. If you are performing this call just to do math
+    #   expressions and do not also need the raw data returned, you can
+    #   specify `False`. If you omit this, the default of `True` is used.
+    #   @return [Boolean]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricDataQuery AWS API Documentation
+    #
+    class MetricDataQuery < Struct.new(
+      :id,
+      :metric_stat,
+      :expression,
+      :label,
+      :return_data)
+      include Aws::Structure
+    end
+
+    # A `GetMetricData` call returns an array of `MetricDataResult`
+    # structures. Each of these structures includes the data points for that
+    # metric, along with the time stamps of those data points and other
+    # identifying information.
+    #
+    # @!attribute [rw] id
+    #   The short name you specified to represent this metric.
+    #   @return [String]
+    #
+    # @!attribute [rw] label
+    #   The human-readable label associated with the data.
+    #   @return [String]
+    #
+    # @!attribute [rw] timestamps
+    #   The time stamps for the data points, formatted in Unix timestamp
+    #   format. The number of time stamps always matches the number of
+    #   values and the value for Timestamps\[x\] is Values\[x\].
+    #   @return [Array<Time>]
+    #
+    # @!attribute [rw] values
+    #   The data points for the metric corresponding to `Timestamps`. The
+    #   number of values always matches the number of time stamps and the
+    #   time stamp for Values\[x\] is Timestamps\[x\].
+    #   @return [Array<Float>]
+    #
+    # @!attribute [rw] status_code
+    #   The status of the returned data. `Complete` indicates that all data
+    #   points in the requested time range were returned. `PartialData`
+    #   means that an incomplete set of data points were returned. You can
+    #   use the `NextToken` value that was returned and repeat your request
+    #   to get more data points. `NextToken` is not returned if you are
+    #   performing a math expression. `InternalError` indicates that an
+    #   error occurred. Retry your request using `NextToken`, if present.
+    #   @return [String]
+    #
+    # @!attribute [rw] messages
+    #   A list of messages with additional information about the data
+    #   returned.
+    #   @return [Array<Types::MessageData>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricDataResult AWS API Documentation
+    #
+    class MetricDataResult < Struct.new(
+      :id,
+      :label,
+      :timestamps,
+      :values,
+      :status_code,
+      :messages)
+      include Aws::Structure
+    end
+
     # Encapsulates the information sent to either create a metric or add new
     # values to be aggregated into an existing metric.
     #
@@ -1042,6 +1312,56 @@ module Aws::CloudWatch
       include Aws::Structure
     end
 
+    # This structure defines the metric to be returned, along with the
+    # statistics, period, and units.
+    #
+    # @note When making an API call, you may pass MetricStat
+    #   data as a hash:
+    #
+    #       {
+    #         metric: { # required
+    #           namespace: "Namespace",
+    #           metric_name: "MetricName",
+    #           dimensions: [
+    #             {
+    #               name: "DimensionName", # required
+    #               value: "DimensionValue", # required
+    #             },
+    #           ],
+    #         },
+    #         period: 1, # required
+    #         stat: "Stat", # required
+    #         unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
+    #       }
+    #
+    # @!attribute [rw] metric
+    #   The metric to return, including the metric name, namespace, and
+    #   dimensions.
+    #   @return [Types::Metric]
+    #
+    # @!attribute [rw] period
+    #   The period to use when retrieving the metric.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] stat
+    #   The statistic to return. It can include any CloudWatch statistic or
+    #   extended statistic.
+    #   @return [String]
+    #
+    # @!attribute [rw] unit
+    #   The unit to use for the returned data points.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricStat AWS API Documentation
+    #
+    class MetricStat < Struct.new(
+      :metric,
+      :period,
+      :stat,
+      :unit)
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass PutDashboardInput
     #   data as a hash:
     #
@@ -1230,7 +1550,7 @@ module Aws::CloudWatch
     #
     #   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
+    #   a 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,
@@ -1264,14 +1584,25 @@ module Aws::CloudWatch
     #
     # @!attribute [rw] 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.
     #   @return [Integer]
     #
     # @!attribute [rw] datapoints_to_alarm
     #   The number of datapoints that must be breaching to trigger the
-    #   alarm.
+    #   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
     #   @return [Integer]
     #
     # @!attribute [rw] threshold

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-cloudwatch
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-19 00:00:00.000000000 Z
+date: 2018-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -78,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2.2
 signing_key: 
 specification_version: 4
 summary: AWS SDK for Ruby - CloudWatch