Copyright	(c) 2013-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.CloudWatch.Types

Contents

Service Configuration
Errors
ComparisonOperator
HistoryItemType
StandardUnit
StateValue
Statistic
AlarmHistoryItem
Datapoint
Dimension
DimensionFilter
Metric
MetricAlarm
MetricDatum
StatisticSet

Description

Synopsis

Service Configuration

cloudWatch :: Service Source

API version '2010-08-01' of the Amazon CloudWatch SDK configuration.

Errors

_LimitExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source

The quota for alarms for this customer has already been reached.

_InvalidNextToken :: AsError a => Getting (First ServiceError) a ServiceError Source

The next token specified is invalid.

_InternalServiceFault :: AsError a => Getting (First ServiceError) a ServiceError Source

Indicates that the request processing has failed due to some unknown error, exception, or failure.

_InvalidParameterValueException :: AsError a => Getting (First ServiceError) a ServiceError Source

Bad or out-of-range value was supplied for the input parameter.

_InvalidFormatFault :: AsError a => Getting (First ServiceError) a ServiceError Source

Data was not syntactically valid JSON.

_MissingRequiredParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source

An input parameter that is mandatory for processing the request is not supplied.

_InvalidParameterCombinationException :: AsError a => Getting (First ServiceError) a ServiceError Source

Parameters that must not be used together were used together.

_ResourceNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source

The named resource does not exist.

ComparisonOperator

HistoryItemType

StandardUnit

StateValue

Statistic

AlarmHistoryItem

data AlarmHistoryItem Source

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.

See: alarmHistoryItem smart constructor.

alarmHistoryItem :: AlarmHistoryItem Source

Creates a value of AlarmHistoryItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ahiAlarmName :: Lens' AlarmHistoryItem (Maybe Text) Source

The descriptive name for the alarm.

ahiHistoryItemType :: Lens' AlarmHistoryItem (Maybe HistoryItemType) Source

The type of alarm history item.

ahiHistoryData :: Lens' AlarmHistoryItem (Maybe Text) Source

Machine-readable data about the alarm in JSON format.

ahiHistorySummary :: Lens' AlarmHistoryItem (Maybe Text) Source

A human-readable summary of the alarm history.

ahiTimestamp :: Lens' AlarmHistoryItem (Maybe UTCTime) Source

The time stamp for the alarm history item.

Datapoint

data Datapoint Source

The Datapoint data type encapsulates the statistical data that Amazon CloudWatch computes from metric data.

See: datapoint smart constructor.

datapoint :: Datapoint Source

Creates a value of Datapoint with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dSampleCount :: Lens' Datapoint (Maybe Double) Source

The number of metric values that contributed to the aggregate value of this datapoint.

dMaximum :: Lens' Datapoint (Maybe Double) Source

The maximum of the metric value used for the datapoint.

dAverage :: Lens' Datapoint (Maybe Double) Source

The average of metric values that correspond to the datapoint.

dMinimum :: Lens' Datapoint (Maybe Double) Source

The minimum metric value used for the datapoint.

dSum :: Lens' Datapoint (Maybe Double) Source

The sum of metric values used for the datapoint.

dUnit :: Lens' Datapoint (Maybe StandardUnit) Source

The standard unit used for the datapoint.

dTimestamp :: Lens' Datapoint (Maybe UTCTime) Source

The time stamp used for the datapoint.

Dimension

data Dimension Source

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: dimension smart constructor.

dimension Source

Arguments

:: Text	`dName`
-> Text	`dValue`
-> Dimension

Creates a value of Dimension with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dName
dValue

dName :: Lens' Dimension Text Source

The name of the dimension.

dValue :: Lens' Dimension Text Source

The value representing the dimension measurement

DimensionFilter

data DimensionFilter Source

The DimensionFilter data type is used to filter ListMetrics results.

See: dimensionFilter smart constructor.

dimensionFilter Source

Arguments

:: Text	`dfName`
-> DimensionFilter

Creates a value of DimensionFilter with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dfValue
dfName

dfValue :: Lens' DimensionFilter (Maybe Text) Source

The value of the dimension to be matched.

Specifying a Name without specifying a Value returns all values associated with that Name.

dfName :: Lens' DimensionFilter Text Source

The dimension name to be matched.

Metric

data Metric Source

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.

See: metric smart constructor.

Instances

Eq Metric Source
Data Metric Source
Read Metric Source
Show Metric Source
Generic Metric Source
Hashable Metric Source
FromXML Metric Source
type Rep Metric Source

metric :: Metric Source

Creates a value of Metric with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

mMetricName :: Lens' Metric (Maybe Text) Source

The name of the metric.

mNamespace :: Lens' Metric (Maybe Text) Source

The namespace of the metric.

mDimensions :: Lens' Metric [Dimension] Source

A list of dimensions associated with the metric.

MetricAlarm

data MetricAlarm Source

The MetricAlarm data type represents an alarm. You can use PutMetricAlarm to create or update an alarm.

See: metricAlarm smart constructor.

metricAlarm :: MetricAlarm Source

Creates a value of MetricAlarm with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

maAlarmName :: Lens' MetricAlarm (Maybe Text) Source

The name of the alarm.

maStateUpdatedTimestamp :: Lens' MetricAlarm (Maybe UTCTime) Source

The time stamp of the last update to the alarm's state.

maPeriod :: Lens' MetricAlarm (Maybe Natural) Source

The period in seconds over which the statistic is applied.

maAlarmDescription :: Lens' MetricAlarm (Maybe Text) Source

The description for the alarm.

maEvaluationPeriods :: Lens' MetricAlarm (Maybe Natural) Source

The number of periods over which data is compared to the specified threshold.

maMetricName :: Lens' MetricAlarm (Maybe Text) Source

The name of the alarm's metric.

maNamespace :: Lens' MetricAlarm (Maybe Text) Source

The namespace of alarm's associated metric.

maComparisonOperator :: Lens' MetricAlarm (Maybe ComparisonOperator) Source

The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand.

maOKActions :: Lens' MetricAlarm [Text] Source

The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

maStateValue :: Lens' MetricAlarm (Maybe StateValue) Source

The state value for the alarm.

maThreshold :: Lens' MetricAlarm (Maybe Double) Source

The value against which the specified statistic is compared.

maAlarmConfigurationUpdatedTimestamp :: Lens' MetricAlarm (Maybe UTCTime) Source

The time stamp of the last update to the alarm configuration.

maActionsEnabled :: Lens' MetricAlarm (Maybe Bool) Source

Indicates whether actions should be executed during any changes to the alarm's state.

maInsufficientDataActions :: Lens' MetricAlarm [Text] Source

The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

The current WSDL lists this attribute as UnknownActions.

maStateReason :: Lens' MetricAlarm (Maybe Text) Source

A human-readable explanation for the alarm's state.

maStateReasonData :: Lens' MetricAlarm (Maybe Text) Source

An explanation for the alarm's state in machine-readable JSON format

maDimensions :: Lens' MetricAlarm [Dimension] Source

The list of dimensions associated with the alarm's associated metric.

maAlarmARN :: Lens' MetricAlarm (Maybe Text) Source

The Amazon Resource Name (ARN) of the alarm.

maAlarmActions :: Lens' MetricAlarm [Text] Source

The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

maUnit :: Lens' MetricAlarm (Maybe StandardUnit) Source

The unit of the alarm's associated metric.

maStatistic :: Lens' MetricAlarm (Maybe Statistic) Source

The statistic to apply to the alarm's associated metric.

MetricDatum

data MetricDatum Source

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.

See: metricDatum smart constructor.

metricDatum Source

Arguments

:: Text	`mdMetricName`
-> MetricDatum

Creates a value of MetricDatum with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

mdValue :: Lens' MetricDatum (Maybe Double) Source

The value for the metric.

Although the 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.

mdDimensions :: Lens' MetricDatum [Dimension] Source

A list of dimensions associated with the metric. Note, when using the Dimensions value in a query, you need to append .member.N to it (e.g., Dimensions.member.N).

mdUnit :: Lens' MetricDatum (Maybe StandardUnit) Source

The unit of the metric.

mdTimestamp :: Lens' MetricDatum (Maybe UTCTime) Source

The time stamp used for the metric in ISO 8601 Universal Coordinated Time (UTC) format. If not specified, the default value is set to the time the metric data was received.

mdStatisticValues :: Lens' MetricDatum (Maybe StatisticSet) Source

A set of statistical values describing the metric.

mdMetricName :: Lens' MetricDatum Text Source

The name of the metric.

StatisticSet

data StatisticSet Source

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

See: statisticSet smart constructor.

statisticSet Source

Arguments

:: Double	`ssSampleCount`
-> Double	`ssSum`
-> Double	`ssMinimum`
-> Double	`ssMaximum`
-> StatisticSet

Creates a value of StatisticSet with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ssSampleCount :: Lens' StatisticSet Double Source

The number of samples used for the statistic set.

ssSum :: Lens' StatisticSet Double Source

The sum of values for the sample set.

ssMinimum :: Lens' StatisticSet Double Source

The minimum value of the sample set.

ssMaximum :: Lens' StatisticSet Double Source

The maximum value of the sample set.

GreaterThanOrEqualToThreshold
GreaterThanThreshold
LessThanOrEqualToThreshold
LessThanThreshold

Bounded ComparisonOperator Source
Enum ComparisonOperator Source
Eq ComparisonOperator Source
Data ComparisonOperator Source
Ord ComparisonOperator Source
Read ComparisonOperator Source
Show ComparisonOperator Source
Generic ComparisonOperator Source
Hashable ComparisonOperator Source
ToHeader ComparisonOperator Source
FromXML ComparisonOperator Source
ToQuery ComparisonOperator Source
ToByteString ComparisonOperator Source
FromText ComparisonOperator Source
ToText ComparisonOperator Source
type Rep ComparisonOperator Source

Bounded HistoryItemType Source
Enum HistoryItemType Source
Eq HistoryItemType Source
Data HistoryItemType Source
Ord HistoryItemType Source
Read HistoryItemType Source
Show HistoryItemType Source
Generic HistoryItemType Source
Hashable HistoryItemType Source
ToHeader HistoryItemType Source
FromXML HistoryItemType Source
ToQuery HistoryItemType Source
ToByteString HistoryItemType Source
FromText HistoryItemType Source
ToText HistoryItemType Source
type Rep HistoryItemType Source

Bits
BitsSecond
Bytes
BytesSecond
Count
CountSecond
Gigabits
GigabitsSecond
Gigabytes
GigabytesSecond
Kilobits
KilobitsSecond
Kilobytes
KilobytesSecond
Megabits
MegabitsSecond
Megabytes
MegabytesSecond
Microseconds
Milliseconds
None
Percent
Seconds
Terabits
TerabitsSecond
Terabytes
TerabytesSecond

Bounded StandardUnit Source
Enum StandardUnit Source
Eq StandardUnit Source
Data StandardUnit Source
Ord StandardUnit Source
Read StandardUnit Source
Show StandardUnit Source
Generic StandardUnit Source
Hashable StandardUnit Source
ToHeader StandardUnit Source
FromXML StandardUnit Source
ToQuery StandardUnit Source
ToByteString StandardUnit Source
FromText StandardUnit Source
ToText StandardUnit Source
type Rep StandardUnit Source

Bounded StateValue Source
Enum StateValue Source
Eq StateValue Source
Data StateValue Source
Ord StateValue Source
Read StateValue Source
Show StateValue Source
Generic StateValue Source
Hashable StateValue Source
ToHeader StateValue Source
FromXML StateValue Source
ToQuery StateValue Source
ToByteString StateValue Source
FromText StateValue Source
ToText StateValue Source
type Rep StateValue Source

Bounded Statistic Source
Enum Statistic Source
Eq Statistic Source
Data Statistic Source
Ord Statistic Source
Read Statistic Source
Show Statistic Source
Generic Statistic Source
Hashable Statistic Source
ToHeader Statistic Source
FromXML Statistic Source
ToQuery Statistic Source
ToByteString Statistic Source
FromText Statistic Source
ToText Statistic Source
type Rep Statistic Source

Eq AlarmHistoryItem Source
Data AlarmHistoryItem Source
Read AlarmHistoryItem Source
Show AlarmHistoryItem Source
Generic AlarmHistoryItem Source
Hashable AlarmHistoryItem Source
FromXML AlarmHistoryItem Source
type Rep AlarmHistoryItem Source

Eq Datapoint Source
Data Datapoint Source
Read Datapoint Source
Show Datapoint Source
Generic Datapoint Source
Hashable Datapoint Source
FromXML Datapoint Source
type Rep Datapoint Source

Eq Dimension Source
Data Dimension Source
Read Dimension Source
Show Dimension Source
Generic Dimension Source
Hashable Dimension Source
FromXML Dimension Source
ToQuery Dimension Source
type Rep Dimension Source

Eq DimensionFilter Source
Data DimensionFilter Source
Read DimensionFilter Source
Show DimensionFilter Source
Generic DimensionFilter Source
Hashable DimensionFilter Source
ToQuery DimensionFilter Source
type Rep DimensionFilter Source

Eq MetricAlarm Source
Data MetricAlarm Source
Read MetricAlarm Source
Show MetricAlarm Source
Generic MetricAlarm Source
Hashable MetricAlarm Source
FromXML MetricAlarm Source
type Rep MetricAlarm Source

Eq MetricDatum Source
Data MetricDatum Source
Read MetricDatum Source
Show MetricDatum Source
Generic MetricDatum Source
Hashable MetricDatum Source
ToQuery MetricDatum Source
type Rep MetricDatum Source

Eq StatisticSet Source
Data StatisticSet Source
Read StatisticSet Source
Show StatisticSet Source
Generic StatisticSet Source
Hashable StatisticSet Source
ToQuery StatisticSet Source
type Rep StatisticSet Source