Packages
erlcloud
3.7.6
3.8.3
3.8.2
3.8.1
3.7.6
3.7.4
3.7.3
3.7.2
3.7.1
3.7.0
3.6.8
3.6.7
3.6.5
3.6.4
3.6.3
3.6.2
3.6.1
3.6.0
3.5.16
3.5.15
3.5.14
3.5.13
3.5.12
3.5.11
3.5.10
3.5.9
3.5.8
3.5.7
3.5.6
3.5.5
3.5.4
3.5.3
3.5.2
3.5.1
3.5.0
3.4.5
3.4.3
3.4.1
3.4.0
3.3.9
3.3.8
3.3.7
3.3.6
3.3.5
3.3.4
3.3.3
3.3.2
3.3.1
3.3.0
3.2.18
3.2.17
3.2.16
3.2.15
3.2.14
3.2.13
3.2.12
3.2.11
3.2.10
3.2.7
3.2.6
3.2.5
3.2.4
3.2.3
3.2.2
3.2.1
3.2.0
3.1.17
3.1.16
3.1.14
3.1.13
3.1.12
3.1.11
3.1.9
3.1.8
3.1.7
3.1.6
3.1.5
3.1.4
3.1.3
3.1.2
3.1.1
3.1.0
3.0.5
3.0.4
3.0.3
3.0.2
3.0.1
2.2.16
2.2.15
2.2.14
2.2.13
2.2.12
2.2.11
2.2.10
2.2.9
2.2.8
2.2.7
2.2.6
2.2.5
2.2.4
2.2.2
2.2.1
2.2.0
2.1.0
2.0.5
2.0.4
2.0.3
2.0.0
0.13.10
0.13.9
0.13.8
0.13.6
0.13.5
0.13.4
0.13.3
0.13.2
0.13.0
0.12.0
0.11.0
0.9.2
0.9.2-rc.1
0.9.1
0.9.0
AWS APIs library for Erlang
Current section
Files
Jump to
Current section
Files
include/erlcloud_mon.hrl
-ifndef(erlcloud_mon_hrl).
-define(erlcloud_mon_hrl, 0).
-include("erlcloud.hrl").
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% File: erlcloud_mon.hrl
%% Date: 18-Sep-2011
%%
%% @doc AWS CloudWatch erlang binding (the CLI SDK uses "mon_" prefix)
%%
%% @author Zvi Avraham <zvi-AT-nivertech-DOT-com>
%% @copyright 2011 Zvi Avraham
%% @end
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%------------------------------------------------------------------------------
%% @doc date time
%% @end
%%------------------------------------------------------------------------------
%-type datetime() :: string().
%%------------------------------------------------------------------------------
%% @doc The unit of the metric.
%% Valid Values: 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
%% @end
%%------------------------------------------------------------------------------
-type unit() :: string().
%%------------------------------------------------------------------------------
%% @doc The statistic for the metric, other than percentiles.
%% Valid Values: SampleCount | Average | Sum | Minimum | Maximum
%% @end
%%------------------------------------------------------------------------------
-type statistic() :: string().
%%------------------------------------------------------------------------------
%% @doc Dimension
%% The Dimension data type further expands on the identity of a metric using a Name, Value pair.
%% For examples that use one or more dimensions, see PutMetricData.
%% @see[ http://docs.amazonwebservices.com/AmazonCloudWatch/latest/APIReference/index.html?API_Dimension.html ]
%% @end
%%------------------------------------------------------------------------------
-record(dimension, {
name ::string(), %% The name of the dimension. Length constraints: Minimum value of 1. Maximum value of 255.
value ::string() %% The value representing the dimension measurement. Length constraints: Minimum value of 1. Maximum value of 255.
}).
-type dimension() :: #dimension{}.
%%------------------------------------------------------------------------------
%% @doc StatisticSet
%% @see[ http://docs.amazonwebservices.com/AmazonCloudWatch/latest/APIReference/index.html?API_StatisticSet.html ]
%% @end
%%------------------------------------------------------------------------------
-record(statistic_set, {
sample_count ::non_neg_integer(), %% The number of samples used for the statistic set.
maximum ::float(), %% The maximum value of the sample set.
minimum ::float(), %% The minimum value of the sample set.
sum ::float() %% The sum of values for the sample set.
}).
-type statistic_set() :: #statistic_set{}.
%%------------------------------------------------------------------------------
%% @doc MetricDatum
%% @see[ http://docs.amazonwebservices.com/AmazonCloudWatch/latest/APIReference/index.html?API_MetricDatum.html ]
%% @end
%%------------------------------------------------------------------------------
-record(metric_datum, {
metric_name ::string(), %% The name of the metric.
%% Length constraints: Minimum value of 1. Maximum value of 255.
dimensions ::[dimension()], %% A list of dimensions associated with the metric.
%% Length constraints: Minimum of 0 item(s) in the list. Maximum of 10 item(s) in the list.
statistic_values::undefined|statistic_set(), %% A set of statistical values describing the metric.
timestamp ::undefined|datetime()|string(), %% The time stamp used for the metric. If not specified, the default value is set to the time the metric data was received.
unit ::unit(), %% The unit of the metric.
value ::undefined|float() %% The value for the metric.
}).
-type metric_datum() :: #metric_datum{}.
-endif.