Class AWS::CloudWatch
In: lib/aws/cloud_watch.rb
lib/aws/cloud_watch/alarm_history_item_collection.rb
lib/aws/cloud_watch/metric_alarm_collection.rb
lib/aws/cloud_watch/client.rb
lib/aws/cloud_watch/alarm_history_item.rb
lib/aws/cloud_watch/metric.rb
lib/aws/cloud_watch/errors.rb
lib/aws/cloud_watch/metric_statistics.rb
lib/aws/cloud_watch/alarm_collection.rb
lib/aws/cloud_watch/metric_collection.rb
lib/aws/cloud_watch/alarm.rb
Parent: Object

This class is the starting point for working with Amazon CloudWatch.

To use Amazon CloudWatch you must first [sign up here](aws.amazon.com/cloudwatch/).

For more information about Amazon CloudWatch:

# Credentials

You can setup default credentials for all AWS services via AWS.config:

    AWS.config(
      :access_key_id => 'YOUR_ACCESS_KEY_ID',
      :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')

Or you can set them directly on the AWS::CloudWatch interface:

    cw = AWS::CloudWatch.new(
      :access_key_id => 'YOUR_ACCESS_KEY_ID',
      :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')

# Using the Client

AWS::CloudWatch does not provide higher level abstractions for CloudWatch at this time. You can still access all of the API methods using {AWS::CloudWatch::Client}. Here is how you access the client and make a simple request:

    cw = AWS::CloudWatch.new

    resp = cw.client.describe_alarms
    resp[:metric_alarms].each do |alarm|
      puts alarm[:alarm_name]
    end

See {Client} for documentation on all of the supported operations.

@!attribute [r] client

  @return [Client] the low-level CloudWatch client object

Methods

Included Modules

Core::ServiceInterface

Classes and Modules

Module AWS::CloudWatch::Errors
Class AWS::CloudWatch::Alarm
Class AWS::CloudWatch::AlarmCollection
Class AWS::CloudWatch::AlarmHistoryItem
Class AWS::CloudWatch::AlarmHistoryItemCollection
Class AWS::CloudWatch::Client
Class AWS::CloudWatch::Metric
Class AWS::CloudWatch::MetricAlarmCollection
Class AWS::CloudWatch::MetricCollection
Class AWS::CloudWatch::MetricStatistics

Public Instance methods

Puts data for a metric. The metric is created if it does not already exist.

    cw.put_metric_data(
      :namespace => 'test/cli',
      :metric_data => [
        { :metric_name => 'sample', :value => 1 },
        { :metric_name => 'sample', :value => 2 },
        { :metric_name => 'sample', :value => 3 },
        { :metric_name => 'sample', :value => 4 },
        { :metric_name => 'sample', :value => 5 },
      ]
    )

@param [Hash] options @see Client#put_metric_data @return [nil]

[Validate]