aws-sdk 1.5.8 → 1.6.0

data/lib/aws/cloud_watch/client.rb

@@ -19,7 +19,7 @@ module AWS
 
       API_VERSION = '2010-08-01'
 
-      extend Core::Client::QueryXML
+      extend Core::QueryClient
 
       # @private
       CACHEABLE_REQUESTS = Set[
@@ -33,297 +33,224 @@ module AWS
 
       # Calls the DeleteAlarms API operation.
       # @method delete_alarms(options = {})
-      #
-      # === Options:
-      #
-      # * +:alarm_names+ - *required* - (Array<String>)
-      #
-      # === Response Structure:
-      #
-      # This method returns no response data.
-      #
+      # @param [Hash] options
+      #   * +:alarm_names+ - *required* - (Array<String>)
       # @return [Core::Response]
-      #
       define_client_method :delete_alarms, 'DeleteAlarms'
 
       # Calls the DescribeAlarmHistory API operation.
       # @method describe_alarm_history(options = {})
-      #
-      # === Options:
-      #
-      # * +:alarm_name+ - (String)
-      # * +:history_item_type+ - (String)
-      # * +:start_date+ - (String<ISO8601 datetime>)
-      # * +:end_date+ - (String<ISO8601 datetime>)
-      # * +:max_records+ - (Integer)
-      # * +:next_token+ - (String)
-      #
-      # === Response Structure:
-      #
-      # * +:alarm_history_items+ - (Array<Hash>)
+      # @param [Hash] options
       #   * +:alarm_name+ - (String)
-      #   * +:timestamp+ - (Time)
       #   * +:history_item_type+ - (String)
-      #   * +:history_summary+ - (String)
-      #   * +:history_data+ - (String)
-      # * +:next_token+ - (String)
-      #
+      #   * +:start_date+ - (String<ISO8601 datetime>)
+      #   * +:end_date+ - (String<ISO8601 datetime>)
+      #   * +:max_records+ - (Integer)
+      #   * +:next_token+ - (String)
       # @return [Core::Response]
-      #
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +:alarm_history_items+ - (Array<Hash>)
+      #     * +:alarm_name+ - (String)
+      #     * +:timestamp+ - (Time)
+      #     * +:history_item_type+ - (String)
+      #     * +:history_summary+ - (String)
+      #     * +:history_data+ - (String)
+      #   * +:next_token+ - (String)
       define_client_method :describe_alarm_history, 'DescribeAlarmHistory'
 
       # Calls the DescribeAlarms API operation.
       # @method describe_alarms(options = {})
-      #
-      # === Options:
-      #
-      # * +:alarm_names+ - (Array<String>)
-      # * +:alarm_name_prefix+ - (String)
-      # * +:state_value+ - (String)
-      # * +:action_prefix+ - (String)
-      # * +:max_records+ - (Integer)
-      # * +:next_token+ - (String)
-      #
-      # === Response Structure:
-      #
-      # * +:metric_alarms+ - (Array<Hash>)
-      #   * +:alarm_name+ - (String)
-      #   * +:alarm_arn+ - (String)
-      #   * +:alarm_description+ - (String)
-      #   * +:alarm_configuration_updated_timestamp+ - (Time)
-      #   * +:actions_enabled+ - (Boolean)
-      #   * +:ok_actions+ - (Array<String>)
-      #   * +:alarm_actions+ - (Array<String>)
-      #   * +:insufficient_data_actions+ - (Array<String>)
+      # @param [Hash] options
+      #   * +:alarm_names+ - (Array<String>)
+      #   * +:alarm_name_prefix+ - (String)
       #   * +:state_value+ - (String)
-      #   * +:state_reason+ - (String)
-      #   * +:state_reason_data+ - (String)
-      #   * +:state_updated_timestamp+ - (Time)
-      #   * +:metric_name+ - (String)
-      #   * +:namespace+ - (String)
-      #   * +:statistic+ - (String)
-      #   * +:dimensions+ - (Array<Hash>)
-      #     * +:name+ - (String)
-      #     * +:value+ - (String)
-      #   * +:period+ - (Integer)
-      #   * +:unit+ - (String)
-      #   * +:evaluation_periods+ - (Integer)
-      #   * +:threshold+ - (Numeric)
-      #   * +:comparison_operator+ - (String)
-      # * +:next_token+ - (String)
-      #
+      #   * +:action_prefix+ - (String)
+      #   * +:max_records+ - (Integer)
+      #   * +:next_token+ - (String)
       # @return [Core::Response]
-      #
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +:metric_alarms+ - (Array<Hash>)
+      #     * +:alarm_name+ - (String)
+      #     * +:alarm_arn+ - (String)
+      #     * +:alarm_description+ - (String)
+      #     * +:alarm_configuration_updated_timestamp+ - (Time)
+      #     * +:actions_enabled+ - (Boolean)
+      #     * +:ok_actions+ - (Array<String>)
+      #     * +:alarm_actions+ - (Array<String>)
+      #     * +:insufficient_data_actions+ - (Array<String>)
+      #     * +:state_value+ - (String)
+      #     * +:state_reason+ - (String)
+      #     * +:state_reason_data+ - (String)
+      #     * +:state_updated_timestamp+ - (Time)
+      #     * +:metric_name+ - (String)
+      #     * +:namespace+ - (String)
+      #     * +:statistic+ - (String)
+      #     * +:dimensions+ - (Array<Hash>)
+      #       * +:name+ - (String)
+      #       * +:value+ - (String)
+      #     * +:period+ - (Integer)
+      #     * +:unit+ - (String)
+      #     * +:evaluation_periods+ - (Integer)
+      #     * +:threshold+ - (Numeric)
+      #     * +:comparison_operator+ - (String)
+      #   * +:next_token+ - (String)
       define_client_method :describe_alarms, 'DescribeAlarms'
 
       # Calls the DescribeAlarmsForMetric API operation.
       # @method describe_alarms_for_metric(options = {})
-      #
-      # === Options:
-      #
-      # * +:metric_name+ - *required* - (String)
-      # * +:namespace+ - *required* - (String)
-      # * +:statistic+ - (String)
-      # * +:dimensions+ - (Array<Hash>)
-      #   * +:name+ - *required* - (String)
-      #   * +:value+ - *required* - (String)
-      # * +:period+ - (Integer)
-      # * +:unit+ - (String)
-      #
-      # === Response Structure:
-      #
-      # * +:metric_alarms+ - (Array<Hash>)
-      #   * +:alarm_name+ - (String)
-      #   * +:alarm_arn+ - (String)
-      #   * +:alarm_description+ - (String)
-      #   * +:alarm_configuration_updated_timestamp+ - (Time)
-      #   * +:actions_enabled+ - (Boolean)
-      #   * +:ok_actions+ - (Array<String>)
-      #   * +:alarm_actions+ - (Array<String>)
-      #   * +:insufficient_data_actions+ - (Array<String>)
-      #   * +:state_value+ - (String)
-      #   * +:state_reason+ - (String)
-      #   * +:state_reason_data+ - (String)
-      #   * +:state_updated_timestamp+ - (Time)
-      #   * +:metric_name+ - (String)
-      #   * +:namespace+ - (String)
+      # @param [Hash] options
+      #   * +:metric_name+ - *required* - (String)
+      #   * +:namespace+ - *required* - (String)
       #   * +:statistic+ - (String)
       #   * +:dimensions+ - (Array<Hash>)
-      #     * +:name+ - (String)
-      #     * +:value+ - (String)
+      #     * +:name+ - *required* - (String)
+      #     * +:value+ - *required* - (String)
       #   * +:period+ - (Integer)
       #   * +:unit+ - (String)
-      #   * +:evaluation_periods+ - (Integer)
-      #   * +:threshold+ - (Numeric)
-      #   * +:comparison_operator+ - (String)
-      #
       # @return [Core::Response]
-      #
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +:metric_alarms+ - (Array<Hash>)
+      #     * +:alarm_name+ - (String)
+      #     * +:alarm_arn+ - (String)
+      #     * +:alarm_description+ - (String)
+      #     * +:alarm_configuration_updated_timestamp+ - (Time)
+      #     * +:actions_enabled+ - (Boolean)
+      #     * +:ok_actions+ - (Array<String>)
+      #     * +:alarm_actions+ - (Array<String>)
+      #     * +:insufficient_data_actions+ - (Array<String>)
+      #     * +:state_value+ - (String)
+      #     * +:state_reason+ - (String)
+      #     * +:state_reason_data+ - (String)
+      #     * +:state_updated_timestamp+ - (Time)
+      #     * +:metric_name+ - (String)
+      #     * +:namespace+ - (String)
+      #     * +:statistic+ - (String)
+      #     * +:dimensions+ - (Array<Hash>)
+      #       * +:name+ - (String)
+      #       * +:value+ - (String)
+      #     * +:period+ - (Integer)
+      #     * +:unit+ - (String)
+      #     * +:evaluation_periods+ - (Integer)
+      #     * +:threshold+ - (Numeric)
+      #     * +:comparison_operator+ - (String)
       define_client_method :describe_alarms_for_metric, 'DescribeAlarmsForMetric'
 
       # Calls the DisableAlarmActions API operation.
       # @method disable_alarm_actions(options = {})
-      #
-      # === Options:
-      #
-      # * +:alarm_names+ - *required* - (Array<String>)
-      #
-      # === Response Structure:
-      #
-      # This method returns no response data.
-      #
+      # @param [Hash] options
+      #   * +:alarm_names+ - *required* - (Array<String>)
       # @return [Core::Response]
-      #
       define_client_method :disable_alarm_actions, 'DisableAlarmActions'
 
       # Calls the EnableAlarmActions API operation.
       # @method enable_alarm_actions(options = {})
-      #
-      # === Options:
-      #
-      # * +:alarm_names+ - *required* - (Array<String>)
-      #
-      # === Response Structure:
-      #
-      # This method returns no response data.
-      #
+      # @param [Hash] options
+      #   * +:alarm_names+ - *required* - (Array<String>)
       # @return [Core::Response]
-      #
       define_client_method :enable_alarm_actions, 'EnableAlarmActions'
 
       # Calls the GetMetricStatistics API operation.
       # @method get_metric_statistics(options = {})
-      #
-      # === Options:
-      #
-      # * +:namespace+ - *required* - (String)
-      # * +:metric_name+ - *required* - (String)
-      # * +:dimensions+ - (Array<Hash>)
-      #   * +:name+ - *required* - (String)
-      #   * +:value+ - *required* - (String)
-      # * +:start_time+ - *required* - (String<ISO8601 datetime>)
-      # * +:end_time+ - *required* - (String<ISO8601 datetime>)
-      # * +:period+ - *required* - (Integer)
-      # * +:statistics+ - *required* - (Array<String>)
-      # * +:unit+ - (String)
-      #
-      # === Response Structure:
-      #
-      # * +:label+ - (String)
-      # * +:datapoints+ - (Array<Hash>)
-      #   * +:timestamp+ - (Time)
-      #   * +:sample_count+ - (Numeric)
-      #   * +:average+ - (Numeric)
-      #   * +:sum+ - (Numeric)
-      #   * +:minimum+ - (Numeric)
-      #   * +:maximum+ - (Numeric)
+      # @param [Hash] options
+      #   * +:namespace+ - *required* - (String)
+      #   * +:metric_name+ - *required* - (String)
+      #   * +:dimensions+ - (Array<Hash>)
+      #     * +:name+ - *required* - (String)
+      #     * +:value+ - *required* - (String)
+      #   * +:start_time+ - *required* - (String<ISO8601 datetime>)
+      #   * +:end_time+ - *required* - (String<ISO8601 datetime>)
+      #   * +:period+ - *required* - (Integer)
+      #   * +:statistics+ - *required* - (Array<String>)
       #   * +:unit+ - (String)
-      #
       # @return [Core::Response]
-      #
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +:label+ - (String)
+      #   * +:datapoints+ - (Array<Hash>)
+      #     * +:timestamp+ - (Time)
+      #     * +:sample_count+ - (Numeric)
+      #     * +:average+ - (Numeric)
+      #     * +:sum+ - (Numeric)
+      #     * +:minimum+ - (Numeric)
+      #     * +:maximum+ - (Numeric)
+      #     * +:unit+ - (String)
       define_client_method :get_metric_statistics, 'GetMetricStatistics'
 
       # Calls the ListMetrics API operation.
       # @method list_metrics(options = {})
-      #
-      # === Options:
-      #
-      # * +:namespace+ - (String)
-      # * +:metric_name+ - (String)
-      # * +:dimensions+ - (Array<Hash>)
-      #   * +:name+ - *required* - (String)
-      #   * +:value+ - (String)
-      # * +:next_token+ - (String)
-      #
-      # === Response Structure:
-      #
-      # * +:metrics+ - (Array<Hash>)
+      # @param [Hash] options
       #   * +:namespace+ - (String)
       #   * +:metric_name+ - (String)
       #   * +:dimensions+ - (Array<Hash>)
-      #     * +:name+ - (String)
+      #     * +:name+ - *required* - (String)
       #     * +:value+ - (String)
-      # * +:next_token+ - (String)
-      #
+      #   * +:next_token+ - (String)
       # @return [Core::Response]
-      #
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +:metrics+ - (Array<Hash>)
+      #     * +:namespace+ - (String)
+      #     * +:metric_name+ - (String)
+      #     * +:dimensions+ - (Array<Hash>)
+      #       * +:name+ - (String)
+      #       * +:value+ - (String)
+      #   * +:next_token+ - (String)
       define_client_method :list_metrics, 'ListMetrics'
 
       # Calls the PutMetricAlarm API operation.
       # @method put_metric_alarm(options = {})
-      #
-      # === Options:
-      #
-      # * +:alarm_name+ - *required* - (String)
-      # * +:alarm_description+ - (String)
-      # * +:actions_enabled+ - (Boolean)
-      # * +:ok_actions+ - (Array<String>)
-      # * +:alarm_actions+ - (Array<String>)
-      # * +:insufficient_data_actions+ - (Array<String>)
-      # * +:metric_name+ - *required* - (String)
-      # * +:namespace+ - *required* - (String)
-      # * +:statistic+ - *required* - (String)
-      # * +:dimensions+ - (Array<Hash>)
-      #   * +:name+ - *required* - (String)
-      #   * +:value+ - *required* - (String)
-      # * +:period+ - *required* - (Integer)
-      # * +:unit+ - (String)
-      # * +:evaluation_periods+ - *required* - (Integer)
-      # * +:threshold+ - *required* - (Float)
-      # * +:comparison_operator+ - *required* - (String)
-      #
-      # === Response Structure:
-      #
-      # This method returns no response data.
-      #
-      # @return [Core::Response]
-      #
-      define_client_method :put_metric_alarm, 'PutMetricAlarm'
-
-      # Calls the PutMetricData API operation.
-      # @method put_metric_data(options = {})
-      #
-      # === Options:
-      #
-      # * +:namespace+ - *required* - (String)
-      # * +:metric_data+ - *required* - (Array<Hash>)
+      # @param [Hash] options
+      #   * +:alarm_name+ - *required* - (String)
+      #   * +:alarm_description+ - (String)
+      #   * +:actions_enabled+ - (Boolean)
+      #   * +:ok_actions+ - (Array<String>)
+      #   * +:alarm_actions+ - (Array<String>)
+      #   * +:insufficient_data_actions+ - (Array<String>)
       #   * +:metric_name+ - *required* - (String)
+      #   * +:namespace+ - *required* - (String)
+      #   * +:statistic+ - *required* - (String)
       #   * +:dimensions+ - (Array<Hash>)
       #     * +:name+ - *required* - (String)
       #     * +:value+ - *required* - (String)
-      #   * +:timestamp+ - (String<ISO8601 datetime>)
-      #   * +:value+ - (Float)
-      #   * +:statistic_values+ - (Hash)
-      #     * +:sample_count+ - *required* - (Float)
-      #     * +:sum+ - *required* - (Float)
-      #     * +:minimum+ - *required* - (Float)
-      #     * +:maximum+ - *required* - (Float)
+      #   * +:period+ - *required* - (Integer)
       #   * +:unit+ - (String)
-      #
-      # === Response Structure:
-      #
-      # This method returns no response data.
-      #
+      #   * +:evaluation_periods+ - *required* - (Integer)
+      #   * +:threshold+ - *required* - (Float)
+      #   * +:comparison_operator+ - *required* - (String)
+      # @return [Core::Response]
+      define_client_method :put_metric_alarm, 'PutMetricAlarm'
+
+      # Calls the PutMetricData API operation.
+      # @method put_metric_data(options = {})
+      # @param [Hash] options
+      #   * +:namespace+ - *required* - (String)
+      #   * +:metric_data+ - *required* - (Array<Hash>)
+      #     * +:metric_name+ - *required* - (String)
+      #     * +:dimensions+ - (Array<Hash>)
+      #       * +:name+ - *required* - (String)
+      #       * +:value+ - *required* - (String)
+      #     * +:timestamp+ - (String<ISO8601 datetime>)
+      #     * +:value+ - (Float)
+      #     * +:statistic_values+ - (Hash)
+      #       * +:sample_count+ - *required* - (Float)
+      #       * +:sum+ - *required* - (Float)
+      #       * +:minimum+ - *required* - (Float)
+      #       * +:maximum+ - *required* - (Float)
+      #     * +:unit+ - (String)
       # @return [Core::Response]
-      #
       define_client_method :put_metric_data, 'PutMetricData'
 
       # Calls the SetAlarmState API operation.
       # @method set_alarm_state(options = {})
-      #
-      # === Options:
-      #
-      # * +:alarm_name+ - *required* - (String)
-      # * +:state_value+ - *required* - (String)
-      # * +:state_reason+ - *required* - (String)
-      # * +:state_reason_data+ - (String)
-      #
-      # === Response Structure:
-      #
-      # This method returns no response data.
-      #
+      # @param [Hash] options
+      #   * +:alarm_name+ - *required* - (String)
+      #   * +:state_value+ - *required* - (String)
+      #   * +:state_reason+ - *required* - (String)
+      #   * +:state_reason_data+ - (String)
       # @return [Core::Response]
-      #
       define_client_method :set_alarm_state, 'SetAlarmState'
 
       ## end client methods ##