Class: AWS::CloudWatch::Client

Inherits:
AWS::Core::Client show all
Extended by:
AWS::Core::Client::QueryXML
Defined in:
lib/aws/cloud_watch/client.rb

Overview

Client class for Cloud Watch

Constant Summary collapse

API_VERSION = 
'2010-08-01'

Instance Attribute Summary

Attributes inherited from AWS::Core::Client

#config, #http_read_timeout

Instance Method Summary collapse

Methods inherited from AWS::Core::Client

#initialize, #operations, #with_http_handler, #with_options

Constructor Details

This class inherits a constructor from AWS::Core::Client

Instance Method Details

#delete_alarms(options = {}) ⇒ Core::Response

Calls the DeleteAlarms API operation.

Options:

  • :alarm_names - required - (Array<String>)

Response Structure:

This method returns no response data.

Returns:



47
 
# File 'lib/aws/cloud_watch/client.rb', line 47

define_client_method :delete_alarms, 'DeleteAlarms'

#describe_alarm_history(options = {}) ⇒ Core::Response

Calls the DescribeAlarmHistory API operation.

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>)

    • :alarm_name - (String)

    • :timestamp - (Time)

    • :history_item_type - (String)

    • :history_summary - (String)

    • :history_data - (String)

  • :next_token - (String)

Returns:



73
 
# File 'lib/aws/cloud_watch/client.rb', line 73

define_client_method :describe_alarm_history, 'DescribeAlarmHistory'

#describe_alarms(options = {}) ⇒ Core::Response

Calls the DescribeAlarms API operation.

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>)

    • :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)

Returns:



117
 
# File 'lib/aws/cloud_watch/client.rb', line 117

define_client_method :describe_alarms, 'DescribeAlarms'

#describe_alarms_for_metric(options = {}) ⇒ Core::Response

Calls the DescribeAlarmsForMetric API operation.

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)

    • :statistic - (String)

    • :dimensions - (Array<Hash>)

      • :name - (String)

      • :value - (String)

    • :period - (Integer)

    • :unit - (String)

    • :evaluation_periods - (Integer)

    • :threshold - (Numeric)

    • :comparison_operator - (String)

Returns:



162
 
# File 'lib/aws/cloud_watch/client.rb', line 162

define_client_method :describe_alarms_for_metric, 'DescribeAlarmsForMetric'

#disable_alarm_actions(options = {}) ⇒ Core::Response

Calls the DisableAlarmActions API operation.

Options:

  • :alarm_names - required - (Array<String>)

Response Structure:

This method returns no response data.

Returns:



177
 
# File 'lib/aws/cloud_watch/client.rb', line 177

define_client_method :disable_alarm_actions, 'DisableAlarmActions'

#enable_alarm_actions(options = {}) ⇒ Core::Response

Calls the EnableAlarmActions API operation.

Options:

  • :alarm_names - required - (Array<String>)

Response Structure:

This method returns no response data.

Returns:



192
 
# File 'lib/aws/cloud_watch/client.rb', line 192

define_client_method :enable_alarm_actions, 'EnableAlarmActions'

#get_metric_statistics(options = {}) ⇒ Core::Response

Calls the GetMetricStatistics API operation.

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)

    • :unit - (String)

Returns:



224
 
# File 'lib/aws/cloud_watch/client.rb', line 224

define_client_method :get_metric_statistics, 'GetMetricStatistics'

#list_metrics(options = {}) ⇒ Core::Response

Calls the ListMetrics API operation.

Options:

  • :namespace - (String)

  • :metric_name - (String)

  • :dimensions - (Array<Hash>)

    • :name - required - (String)

    • :value - (String)

  • :next_token - (String)

Response Structure:

  • :metrics - (Array<Hash>)

    • :namespace - (String)

    • :metric_name - (String)

    • :dimensions - (Array<Hash>)

      • :name - (String)

      • :value - (String)

  • :next_token - (String)

Returns:



250
 
# File 'lib/aws/cloud_watch/client.rb', line 250

define_client_method :list_metrics, 'ListMetrics'

#put_metric_alarm(options = {}) ⇒ Core::Response

Calls the PutMetricAlarm API operation.

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.

Returns:



281
 
# File 'lib/aws/cloud_watch/client.rb', line 281

define_client_method :put_metric_alarm, 'PutMetricAlarm'

#put_metric_data(options = {}) ⇒ Core::Response

Calls the PutMetricData API operation.

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)

Response Structure:

This method returns no response data.

Returns:



309
 
# File 'lib/aws/cloud_watch/client.rb', line 309

define_client_method :put_metric_data, 'PutMetricData'

#set_alarm_state(options = {}) ⇒ Core::Response

Calls the SetAlarmState API operation.

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.

Returns:



327
 
# File 'lib/aws/cloud_watch/client.rb', line 327

define_client_method :set_alarm_state, 'SetAlarmState'