org.jclouds.cloudwatch

Interface CloudWatchClient

public interface CloudWatchClient

Provides access to Amazon CloudWatch via the Query API

Author:

Adrian Cole

See Also:

Method Summary

Methods

Modifier and Type	Method and Description
Set<Datapoint>	getMetricStatisticsInRegion(String region, String metricName, String namespace, Date startTime, Date endTime, int period, Statistics statistics, GetMetricStatisticsOptions... options) This call returns data for one or more statistics of given a metric.

Method Detail

getMetricStatisticsInRegion

Set<Datapoint> getMetricStatisticsInRegion(@Nullable
                                         String region,
                                         String metricName,
                                         String namespace,
                                         Date startTime,
                                         Date endTime,
                                         int period,
                                         Statistics statistics,
                                         GetMetricStatisticsOptions... options)

This call returns data for one or more statistics of given a metric. For more information, see Statistic and Metric.

Note

The maximum number of datapoints that the Amazon CloudWatch service will return in a single GetMetricStatistics request is 1,440. If a request is made that would generate more datapoints than this amount, Amazon CloudWatch will return an error. You can alter your request by narrowing the time range (StartTime, EndTime) or increasing the Period in your single request. You may also get all of the data at the granularity you originally asked for by making multiple requests with adjacent time ranges.

Parameters:

region - region to gather metrics in

metricName - The measure name that corresponds to the measure for the gathered metric.

note

Must be a valid collected metric with the corresponding measure name, please see Available Amazon CloudWatch Metrics

namespace - The namespace of the metric (e.g. AWS/EC2)

startTime - The timestamp of the first datapoint to return, inclusive. We round your value down to the nearest minute. You can set your start time for more than two weeks in the past. However, you will only get data for the past two weeks.

endTime - The timestamp to use for determining the last datapoint to return. This is the last datapoint to fetch, exclusive.

period - The granularity (in seconds) of the returned datapoints.

statistics - The statistics to be returned for the given metric. ex. Average

options - more filtering options (e.g. instance ID)