AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Name | Description | |
---|---|---|
![]() |
AlarmHistoryItem |
The AlarmHistoryItem data type contains descriptive information about
the history of a specific alarm. If you call DescribeAlarmHistory, Amazon CloudWatch
returns this data type as part of the DescribeAlarmHistoryResult data type.
|
![]() |
Datapoint |
The Datapoint data type encapsulates the statistical data that Amazon
CloudWatch computes from metric data.
|
![]() |
DeleteAlarmsRequest | Container for the parameters to the DeleteAlarms operation. Deletes all specified alarms. In the event of an error, no alarms are deleted. |
![]() |
DeleteAlarmsResponse | |
![]() |
DescribeAlarmHistoryRequest |
Container for the parameters to the DescribeAlarmHistory operation.
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.
|
![]() |
DescribeAlarmHistoryResponse | Configuration for accessing Amazon DescribeAlarmHistory service |
![]() |
DescribeAlarmHistoryResult | The output for the DescribeAlarmHistory action. |
![]() |
DescribeAlarmsForMetricRequest | Container for the parameters to the DescribeAlarmsForMetric operation. Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further. |
![]() |
DescribeAlarmsForMetricResponse | Configuration for accessing Amazon DescribeAlarmsForMetric service |
![]() |
DescribeAlarmsForMetricResult | The output for the DescribeAlarmsForMetric action. |
![]() |
DescribeAlarmsRequest | Container for the parameters to the DescribeAlarms operation. 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. |
![]() |
DescribeAlarmsResponse | Configuration for accessing Amazon DescribeAlarms service |
![]() |
DescribeAlarmsResult | The output for the DescribeAlarms action. |
![]() |
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. |
![]() |
DimensionFilter |
The DimensionFilter data type is used to filter ListMetrics results.
|
![]() |
DisableAlarmActionsRequest | Container for the parameters to the DisableAlarmActions operation. 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. |
![]() |
DisableAlarmActionsResponse | |
![]() |
EnableAlarmActionsRequest | Container for the parameters to the EnableAlarmActions operation. Enables actions for the specified alarms. |
![]() |
EnableAlarmActionsResponse | |
![]() |
GetMetricStatisticsRequest |
Container for the parameters to the GetMetricStatistics operation.
Gets statistics for the specified metric.
The maximum number of data points that can be queried is 50,850, whereas the maximum
number of data points returned from a single
Amazon CloudWatch aggregates data points based on the length of the
The following examples show various statistics allowed by the data point query maximum
of 50,850 when you call
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. |
![]() |
GetMetricStatisticsResponse | Configuration for accessing Amazon GetMetricStatistics service |
![]() |
GetMetricStatisticsResult | The output for the GetMetricStatistics action. |
![]() |
InternalServiceException | CloudWatch exception |
![]() |
InvalidFormatException | CloudWatch exception |
![]() |
InvalidNextTokenException | CloudWatch exception |
![]() |
InvalidParameterCombinationException | CloudWatch exception |
![]() |
InvalidParameterValueException | CloudWatch exception |
![]() |
LimitExceededException | CloudWatch exception |
![]() |
ListMetricsRequest |
Container for the parameters to the ListMetrics operation.
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.
NextToken values with subsequent ListMetrics
operations. ListMetrics
action. Statistics about the metric, however, are available sooner using GetMetricStatistics.
|
![]() |
ListMetricsResponse | Configuration for accessing Amazon ListMetrics service |
![]() |
ListMetricsResult | The output for the ListMetrics action. |
![]() |
Metric |
The Metric data type contains information about a specific metric. If
you call ListMetrics, Amazon CloudWatch returns information contained by this
data type.
The example in the Examples section publishes two metrics named buffers and latency. Both metrics are in the examples namespace. Both metrics have two dimensions, InstanceID and InstanceType. |
![]() |
MetricAlarm | The MetricAlarm data type represents an alarm. You can use PutMetricAlarm to create or update an alarm. |
![]() |
MetricDatum |
The MetricDatum data type encapsulates the information sent with PutMetricData
to either create a new metric or add new values to be aggregated into an existing
metric.
|
![]() |
MissingRequiredParameterException | CloudWatch exception |
![]() |
PutMetricAlarmRequest |
Container for the parameters to the PutMetricAlarm operation.
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 StateValue is left unchanged.
If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm but the stop or terminate actions won't be performed on the Amazon EC2 instance. However, if you are later granted permission to use the associated Amazon EC2 APIs, the alarm actions you created earlier will be performed. For more information about IAM permissions, see Permissions and Policies in Using IAM. If you are using an IAM role (e.g., an Amazon EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies. If you are using temporary security credentials granted using the AWS Security Token Service (AWS STS), you cannot stop or terminate an Amazon EC2 instance using alarm actions. |
![]() |
PutMetricAlarmResponse | |
![]() |
PutMetricDataRequest |
Container for the parameters to the PutMetricData operation.
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. When Amazon CloudWatch creates a metric, it can take
up to fifteen minutes for the metric to appear in calls to the ListMetrics
action.
Each Value parameter accepts numbers of type Double ,
Amazon CloudWatch rejects values that are either too small or too large. Values must
be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base
2). In addition, special values (e.g., NaN, +Infinity, -Infinity) are not supported.
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 |
![]() |
PutMetricDataResponse | |
![]() |
ResourceNotFoundException | CloudWatch exception |
![]() |
SetAlarmStateRequest |
Container for the parameters to the SetAlarmState operation.
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. For example, if your alarm is configured to send an Amazon SNS message when
an alarm is triggered, temporarily changing the alarm's state to ALARM will
send an Amazon SNS message. This is not a permanent change. The next periodic alarm
check (in about a minute) will set the alarm to its actual state. Because the alarm
state change happens very quickly, it is typically only visibile in the alarm's History
tab in the Amazon CloudWatch console or through DescribeAlarmHistory .
|
![]() |
SetAlarmStateResponse | |
![]() |
StatisticSet |
The StatisticSet data type describes the StatisticValues
component of MetricDatum, and represents a set of statistics that describes
a specific metric.
|