AWS SDK for .NET Documentation
Amazon.CloudWatch.Model Namespace
AmazonAmazon.CloudWatch.Model Did this page help you?   Yes   No    Tell us about it...
 
Declaration Syntax
C#
namespace Amazon.CloudWatch.Model
Types
All TypesClasses
IconTypeDescription
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
Returns information about the DeleteAlarms response metadata. The DeleteAlarms operation has a void result type.

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.

NOTE: Amazon CloudWatch retains the history of an alarm for two weeks, whether or not you delete the alarm.


DescribeAlarmHistoryResponse
Returns information about the DescribeAlarmHistoryResult response and response metadata.

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
Returns information about the DescribeAlarmsForMetricResult response and response metadata.

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
Returns information about the DescribeAlarmsResult response and response metadata.

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
Returns information about the DisableAlarmActions response metadata. The DisableAlarmActions operation has a void result type.

EnableAlarmActionsRequest
Container for the parameters to the EnableAlarmActions operation.

Enables actions for the specified alarms.


EnableAlarmActionsResponse
Returns information about the EnableAlarmActions response metadata. The EnableAlarmActions operation has a void result type.

GetMetricStatisticsRequest
Container for the parameters to the GetMetricStatistics operation.

Gets statistics for the specified metric.

NOTE: The maximum number of data points returned from a single GetMetricStatistics request is 1,440. If a request is made that generates more than 1,440 data points, Amazon CloudWatch returns an error. In such a case, alter the request by narrowing the specified time range or increasing the specified period. Alternatively, 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.

NOTE: The maximum number of data points that can be queried is 50,850; whereas the maximum number of data points returned is 1,440.

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 .


GetMetricStatisticsResponse
Returns information about the GetMetricStatisticsResult response and response metadata.

GetMetricStatisticsResult

The output for the GetMetricStatistics action.


InternalServiceException
AmazonCloudWatch exception

InvalidFormatException
AmazonCloudWatch exception

InvalidNextTokenException
AmazonCloudWatch exception

InvalidParameterCombinationException
AmazonCloudWatch exception

InvalidParameterValueException
AmazonCloudWatch exception

LimitExceededException
AmazonCloudWatch 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.

NOTE: Up to 500 results are returned for any one call. To retrieve further results, use returned NextToken values with subsequent ListMetrics operations.

NOTE: If you create a metric with the PutMetricData action, allow up to fifteen minutes for the metric to appear in calls to the ListMetrics action. Statistics about the metric, however, are available sooner using GetMetricStatistics.


ListMetricsResponse
Returns information about the ListMetricsResult response and response metadata.

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
AmazonCloudWatch 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 INSUFFICIENT_DATA . The alarm is evaluated and its StateValue is set appropriately. Any actions associated with the StateValue is then executed.

NOTE: When updating an existing alarm, its StateValue is left unchanged.


PutMetricAlarmResponse
Returns information about the PutMetricAlarm response metadata. The PutMetricAlarm operation has a void result type.

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.

NOTE: If you create a metric with the PutMetricData action, allow up to fifteen minutes for the metric to appear in calls to the ListMetrics action.

The size of a PutMetricData request is limited to 8 KB for HTTP GET requests and 40 KB for HTTP POST requests.

IMPORTANT: 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.


PutMetricDataResponse
Returns information about the PutMetricData response metadata. The PutMetricData operation has a void result type.

ResourceNotFoundException
AmazonCloudWatch 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. This is not a permanent change. The next periodic alarm check (in about a minute) will set the alarm to its actual state.


SetAlarmStateResponse
Returns information about the SetAlarmState response metadata. The SetAlarmState operation has a void result type.

StatisticSet

The StatisticSet data type describes the StatisticValues component of MetricDatum, and represents a set of statistics that describes a specific metric.