ExAws.Monitoring.Core
Amazon CloudWatch
This is the Amazon CloudWatch API Reference. This guide provides detailed information about Amazon CloudWatch actions, data types, parameters, and errors. For detailed information about Amazon CloudWatch features and their associated API calls, go to the Amazon CloudWatch Developer Guide.
Amazon CloudWatch is a web service that enables you to publish, monitor, and manage various metrics, as well as configure alarm actions based on data from metrics. For more information about this product go to http://aws.amazon.com/cloudwatch.
For information about the namespace, metric names, and dimensions that other Amazon Web Services products use to send metrics to Cloudwatch, go to Amazon CloudWatch Metrics, Namespaces, and Dimensions Reference in the Amazon CloudWatch Developer Guide.
Use the following links to get started using the Amazon CloudWatch API Reference:
Actions: An alphabetical list of all Amazon CloudWatch actions.
Data Types: An alphabetical list of all Amazon CloudWatch data types.
Common Parameters: Parameters that all Query actions can use.
Common Errors: Client and server errors that all actions can return.
Regions and Endpoints: Itemized regions and endpoints for all AWS products.
- WSDL Location: http://monitoring.amazonaws.com/doc/2010-08-01/CloudWatch.wsdl
In addition to using the Amazon CloudWatch API, you can also use the following SDKs and third-party libraries to access Amazon CloudWatch programmatically.
Developers in the AWS developer community also provide their own libraries, which you can find at the following AWS developer centers:
Summary↑
Types ↑
statistic :: binary
history_item_type :: binary
put_metric_data_input :: [metric_data: metric_data, namespace: namespace]
dimension_value :: binary
statistic_set :: [maximum: datapoint_value, minimum: datapoint_value, sample_count: datapoint_value, sum: datapoint_value]
resource_not_found :: [{:message, error_message}]
dimensions :: [dimension]
dimension_name :: binary
error_message :: binary
standard_unit :: binary
disable_alarm_actions_input :: [{:alarm_names, alarm_names}]
internal_service_fault :: [{:message, fault_description}]
invalid_parameter_value_exception :: [{:message, aws_query_error_message}]
invalid_next_token :: [{:message, error_message}]
list_metrics_input :: [dimensions: dimension_filters, metric_name: metric_name, namespace: namespace, next_token: next_token]
alarm_arn :: binary
statistics :: [statistic]
state_reason_data :: binary
actions_enabled :: boolean
datapoint :: [average: datapoint_value, maximum: datapoint_value, minimum: datapoint_value, sample_count: datapoint_value, sum: datapoint_value, timestamp: timestamp, unit: standard_unit]
describe_alarms_input :: [action_prefix: action_prefix, alarm_name_prefix: alarm_name_prefix, alarm_names: alarm_names, max_records: max_records, next_token: next_token, state_value: state_value]
state_reason :: binary
put_metric_alarm_input :: [actions_enabled: actions_enabled, alarm_actions: resource_list, alarm_description: alarm_description, alarm_name: alarm_name, comparison_operator: comparison_operator, dimensions: dimensions, evaluation_periods: evaluation_periods, insufficient_data_actions: resource_list, metric_name: metric_name, namespace: namespace, ok_actions: resource_list, period: period, statistic: statistic, threshold: threshold, unit: standard_unit]
timestamp :: integer
metric_datum :: [dimensions: dimensions, metric_name: metric_name, statistic_values: statistic_set, timestamp: timestamp, unit: standard_unit, value: datapoint_value]
limit_exceeded_fault :: [{:message, error_message}]
describe_alarm_history_output :: [alarm_history_items: alarm_history_items, next_token: next_token]
metric_label :: binary
state_value :: binary
metric_name :: binary
max_records :: integer
metric_data :: [metric_datum]
describe_alarms_output :: [metric_alarms: metric_alarms, next_token: next_token]
history_summary :: binary
alarm_name_prefix :: binary
dimension :: [name: dimension_name, value: dimension_value]
missing_required_parameter_exception :: [{:message, aws_query_error_message}]
invalid_format_fault :: [{:message, error_message}]
fault_description :: binary
describe_alarms_for_metric_input :: [dimensions: dimensions, metric_name: metric_name, namespace: namespace, period: period, statistic: statistic, unit: standard_unit]
comparison_operator :: binary
enable_alarm_actions_input :: [{:alarm_names, alarm_names}]
datapoints :: [datapoint]
threshold :: float
delete_alarms_input :: [{:alarm_names, alarm_names}]
aws_query_error_message :: binary
metric_alarm :: [actions_enabled: actions_enabled, alarm_actions: resource_list, alarm_arn: alarm_arn, alarm_configuration_updated_timestamp: timestamp, alarm_description: alarm_description, alarm_name: alarm_name, comparison_operator: comparison_operator, dimensions: dimensions, evaluation_periods: evaluation_periods, insufficient_data_actions: resource_list, metric_name: metric_name, namespace: namespace, ok_actions: resource_list, period: period, state_reason: state_reason, state_reason_data: state_reason_data, state_updated_timestamp: timestamp, state_value: state_value, statistic: statistic, threshold: threshold, unit: standard_unit]
period :: integer
metric :: [dimensions: dimensions, metric_name: metric_name, namespace: namespace]
invalid_parameter_combination_exception :: [{:message, aws_query_error_message}]
action_prefix :: binary
history_data :: binary
set_alarm_state_input :: [alarm_name: alarm_name, state_reason: state_reason, state_reason_data: state_reason_data, state_value: state_value]
alarm_name :: binary
evaluation_periods :: integer
dimension_filter :: [name: dimension_name, value: dimension_value]
get_metric_statistics_output :: [datapoints: datapoints, label: metric_label]
namespace :: binary
list_metrics_output :: [metrics: metrics, next_token: next_token]
alarm_names :: [alarm_name]
describe_alarms_for_metric_output :: [{:metric_alarms, metric_alarms}]
get_metric_statistics_input :: [dimensions: dimensions, end_time: timestamp, metric_name: metric_name, namespace: namespace, period: period, start_time: timestamp, statistics: statistics, unit: standard_unit]
resource_name :: binary
alarm_history_item :: [alarm_name: alarm_name, history_data: history_data, history_item_type: history_item_type, history_summary: history_summary, timestamp: timestamp]
describe_alarm_history_input :: [alarm_name: alarm_name, end_date: timestamp, history_item_type: history_item_type, max_records: max_records, next_token: next_token, start_date: timestamp]
alarm_description :: binary
next_token :: binary
datapoint_value :: float
Functions
Specs:
- delete_alarms(client :: ExAws.Monitoring.t, input :: delete_alarms_input) :: ExAws.Request.Query.response_t
DeleteAlarms
Deletes all specified alarms. In the event of an error, no alarms are deleted.
Specs:
- delete_alarms!(client :: ExAws.Monitoring.t, input :: delete_alarms_input) :: ExAws.Request.Query.success_t | no_return
Same as delete_alarms/2
but raise on error.
Specs:
- describe_alarm_history(client :: ExAws.Monitoring.t, input :: describe_alarm_history_input) :: ExAws.Request.Query.response_t
DescribeAlarmHistory
Retrieves history for the specified alarm. Filter alarms by date range or item type. If an alarm name is not specified, Amazon CloudWatch returns histories for all of the owner’s alarms.
Specs:
- describe_alarm_history!(client :: ExAws.Monitoring.t, input :: describe_alarm_history_input) :: ExAws.Request.Query.success_t | no_return
Same as describe_alarm_history/2
but raise on error.
Specs:
- describe_alarms(client :: ExAws.Monitoring.t, input :: describe_alarms_input) :: ExAws.Request.Query.response_t
DescribeAlarms
Retrieves alarms with the specified names. If no name is specified, all alarms for the user are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.
Specs:
- describe_alarms!(client :: ExAws.Monitoring.t, input :: describe_alarms_input) :: ExAws.Request.Query.success_t | no_return
Same as describe_alarms/2
but raise on error.
Specs:
- describe_alarms_for_metric(client :: ExAws.Monitoring.t, input :: describe_alarms_for_metric_input) :: ExAws.Request.Query.response_t
DescribeAlarmsForMetric
Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further.
Specs:
- describe_alarms_for_metric!(client :: ExAws.Monitoring.t, input :: describe_alarms_for_metric_input) :: ExAws.Request.Query.success_t | no_return
Same as describe_alarms_for_metric/2
but raise on error.
Specs:
- disable_alarm_actions(client :: ExAws.Monitoring.t, input :: disable_alarm_actions_input) :: ExAws.Request.Query.response_t
DisableAlarmActions
Disables actions for the specified alarms. When an alarm’s actions are disabled the alarm’s state may change, but none of the alarm’s actions will execute.
Specs:
- disable_alarm_actions!(client :: ExAws.Monitoring.t, input :: disable_alarm_actions_input) :: ExAws.Request.Query.success_t | no_return
Same as disable_alarm_actions/2
but raise on error.
Specs:
- enable_alarm_actions(client :: ExAws.Monitoring.t, input :: enable_alarm_actions_input) :: ExAws.Request.Query.response_t
EnableAlarmActions
Enables actions for the specified alarms.
Specs:
- enable_alarm_actions!(client :: ExAws.Monitoring.t, input :: enable_alarm_actions_input) :: ExAws.Request.Query.success_t | no_return
Same as enable_alarm_actions/2
but raise on error.
Specs:
- get_metric_statistics(client :: ExAws.Monitoring.t, input :: get_metric_statistics_input) :: ExAws.Request.Query.response_t
GetMetricStatistics
Gets statistics for the specified metric.
The maximum number of data points returned from a single
GetMetricStatistics
request is 1,440, wereas the maximum number of data
points that can be queried is 50,850. If you make a request that generates
more than 1,440 data points, Amazon CloudWatch returns an error. In such a
case, you can alter the request by narrowing the specified time range or
increasing the specified period. Alternatively, you can make multiple
requests across adjacent time ranges.
Amazon CloudWatch aggregates data points based on the length of the
period
that you specify. For example, if you request statistics with a
one-minute granularity, Amazon CloudWatch aggregates data points with time
stamps that fall within the same one-minute period. In such a case, the
data points queried can greatly outnumber the data points returned.
The following examples show various statistics allowed by the data point
query maximum of 50,850 when you call GetMetricStatistics
on Amazon EC2
instances with detailed (one-minute) monitoring enabled:
Statistics for up to 400 instances for a span of one hour
Statistics for up to 35 instances over a span of 24 hours
- Statistics for up to 2 instances over a span of 2 weeks
For information about the namespace, metric names, and dimensions that other Amazon Web Services products use to send metrics to Cloudwatch, go to Amazon CloudWatch Metrics, Namespaces, and Dimensions Reference in the Amazon CloudWatch Developer Guide.
Specs:
- get_metric_statistics!(client :: ExAws.Monitoring.t, input :: get_metric_statistics_input) :: ExAws.Request.Query.success_t | no_return
Same as get_metric_statistics/2
but raise on error.
Specs:
- list_metrics(client :: ExAws.Monitoring.t, input :: list_metrics_input) :: ExAws.Request.Query.response_t
ListMetrics
Returns a list of valid metrics stored for the AWS account owner. Returned
metrics can be used with GetMetricStatistics
to obtain statistical data
for a given metric.
Specs:
- list_metrics!(client :: ExAws.Monitoring.t, input :: list_metrics_input) :: ExAws.Request.Query.success_t | no_return
Same as list_metrics/2
but raise on error.
Specs:
- put_metric_alarm(client :: ExAws.Monitoring.t, input :: put_metric_alarm_input) :: ExAws.Request.Query.response_t
PutMetricAlarm
Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric. Optionally, this operation can associate one or more Amazon Simple Notification Service resources with the alarm.
When this operation creates an alarm, the alarm state is immediately set to
INSUFFICIENT_DATA
. The alarm is evaluated and its StateValue
is set
appropriately. Any actions associated with the StateValue
is then
executed.
Specs:
- put_metric_alarm!(client :: ExAws.Monitoring.t, input :: put_metric_alarm_input) :: ExAws.Request.Query.success_t | no_return
Same as put_metric_alarm/2
but raise on error.
Specs:
- put_metric_data(client :: ExAws.Monitoring.t, input :: put_metric_data_input) :: ExAws.Request.Query.response_t
PutMetricData
Publishes metric data points to Amazon CloudWatch. Amazon Cloudwatch
associates the data points with the specified metric. If the specified
metric does not exist, Amazon CloudWatch creates the metric. It can take up
to fifteen minutes for a new metric to appear in calls to the ListMetrics
action.
The size of a
Although the Value
parameter accepts numbers of type Double
, Amazon
CloudWatch truncates values with very large exponents. Values with base-10
exponents greater than 126 (1 x 10^126) are truncated. Likewise, values
with base-10 exponents less than -130 (1 x 10^-130) are also truncated.
Data that is timestamped 24 hours or more in the past may take in excess of
48 hours to become available from submission time using
GetMetricStatistics
.
Specs:
- put_metric_data!(client :: ExAws.Monitoring.t, input :: put_metric_data_input) :: ExAws.Request.Query.success_t | no_return
Same as put_metric_data/2
but raise on error.
Specs:
- set_alarm_state(client :: ExAws.Monitoring.t, input :: set_alarm_state_input) :: ExAws.Request.Query.response_t
SetAlarmState
Temporarily sets the state of an alarm. When the updated StateValue
differs from the previous value, the action configured for the appropriate
state is invoked. This is not a permanent change. The next periodic alarm
check (in about a minute) will set the alarm to its actual state.
Specs:
- set_alarm_state!(client :: ExAws.Monitoring.t, input :: set_alarm_state_input) :: ExAws.Request.Query.success_t | no_return
Same as set_alarm_state/2
but raise on error.