amazonka-cloudwatch-0.1.3: Amazon CloudWatch SDK.

Safe HaskellNone
LanguageHaskell2010

Network.AWS.CloudWatch.Types

Contents

Synopsis

Service

data CloudWatch Source

Version 2010-08-01 of the Amazon CloudWatch service.

Error

data RESTError :: *

Instances

Eq RESTError 
Show RESTError 
Generic RESTError 
AWSErrorCode RESTError 
FromXML RESTError 
type Rep RESTError = D1 D1RESTError (C1 C1_0RESTError ((:*:) ((:*:) (S1 S1_0_0RESTError (Rec0 Text)) (S1 S1_0_1RESTError (Rec0 (Maybe ErrorType)))) ((:*:) (S1 S1_0_2RESTError (Rec0 ErrorCode)) (S1 S1_0_3RESTError (Rec0 Text))))) 

XML

StatisticSet

statisticSet Source

StatisticSet constructor.

The fields accessible through corresponding lenses are:

ssMaximum :: Lens' StatisticSet Double Source

The maximum value of the sample set.

ssMinimum :: Lens' StatisticSet Double Source

The minimum value of the sample set.

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.

MetricAlarm

maActionsEnabled :: Lens' MetricAlarm (Maybe Bool) Source

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

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 Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic and triggering an Auto Scaling policy.

maAlarmArn :: Lens' MetricAlarm (Maybe Text) Source

The Amazon Resource Name (ARN) of the alarm.

maAlarmConfigurationUpdatedTimestamp :: Lens' MetricAlarm (Maybe UTCTime) Source

The time stamp of the last update to the alarm configuration. Amazon CloudWatch uses Coordinated Universal Time (UTC) when returning time stamps, which do not accommodate seasonal adjustments such as daylight savings time. For more information, see Time stamps in the Amazon CloudWatch Developer Guide .

maAlarmDescription :: Lens' MetricAlarm (Maybe Text) Source

The description for the alarm.

maAlarmName :: Lens' MetricAlarm (Maybe Text) Source

The name of the alarm.

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.

maDimensions :: Lens' MetricAlarm [Dimension] Source

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

maEvaluationPeriods :: Lens' MetricAlarm (Maybe Natural) Source

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

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 Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic or triggering an Auto Scaling policy.

The current WSDL lists this attribute as UnknownActions.

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.

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 Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic and triggering an Auto Scaling policy.

maPeriod :: Lens' MetricAlarm (Maybe Natural) Source

The period in seconds over which the statistic is applied.

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

maStateUpdatedTimestamp :: Lens' MetricAlarm (Maybe UTCTime) Source

The time stamp of the last update to the alarm's state. Amazon CloudWatch uses Coordinated Universal Time (UTC) when returning time stamps, which do not accommodate seasonal adjustments such as daylight savings time. For more information, see Time stamps in the Amazon CloudWatch Developer Guide.

maStateValue :: Lens' MetricAlarm (Maybe StateValue) Source

The state value for the alarm.

maStatistic :: Lens' MetricAlarm (Maybe Statistic) Source

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

maThreshold :: Lens' MetricAlarm (Maybe Double) Source

The value against which the specified statistic is compared.

maUnit :: Lens' MetricAlarm (Maybe StandardUnit) Source

The unit of the alarm's associated metric.

HistoryItemType

MetricDatum

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).

mdMetricName :: Lens' MetricDatum Text Source

The name of the metric.

mdStatisticValues :: Lens' MetricDatum (Maybe StatisticSet) Source

A set of statistical values describing the metric.

mdTimestamp :: Lens' MetricDatum (Maybe UTCTime) Source

The time stamp used for the metric. If not specified, the default value is set to the time the metric data was received. Amazon CloudWatch uses Coordinated Universal Time (UTC) when returning time stamps, which do not accommodate seasonal adjustments such as daylight savings time. For more information, see Time stamps in the Amazon CloudWatch Developer Guide.

mdUnit :: Lens' MetricDatum (Maybe StandardUnit) Source

The unit of the metric.

mdValue :: Lens' MetricDatum (Maybe Double) Source

The value for the metric.

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.

StandardUnit

data StandardUnit Source

Constructors

Bits

Bits

BitsSecond

Bits/Second

Bytes

Bytes

BytesSecond

Bytes/Second

Count

Count

CountSecond

Count/Second

Gigabits

Gigabits

GigabitsSecond

Gigabits/Second

Gigabytes

Gigabytes

GigabytesSecond

Gigabytes/Second

Kilobits

Kilobits

KilobitsSecond

Kilobits/Second

Kilobytes

Kilobytes

KilobytesSecond

Kilobytes/Second

Megabits

Megabits

MegabitsSecond

Megabits/Second

Megabytes

Megabytes

MegabytesSecond

Megabytes/Second

Microseconds

Microseconds

Milliseconds

Milliseconds

None

None

Percent

Percent

Seconds

Seconds

Terabits

Terabits

TerabitsSecond

Terabits/Second

Terabytes

Terabytes

TerabytesSecond

Terabytes/Second

Dimension

dimension Source

Arguments

:: Text

dName

-> Text

dValue

-> Dimension 

Dimension constructor.

The fields accessible through corresponding lenses are:

dName :: Lens' Dimension Text Source

The name of the dimension.

dValue :: Lens' Dimension Text Source

The value representing the dimension measurement

ComparisonOperator

AlarmHistoryItem

ahiAlarmName :: Lens' AlarmHistoryItem (Maybe Text) Source

The descriptive name for the alarm.

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. Amazon CloudWatch uses Coordinated Universal Time (UTC) when returning time stamps, which do not accommodate seasonal adjustments such as daylight savings time. For more information, see Time stamps in the Amazon CloudWatch Developer Guide.

Metric

metric :: Metric Source

Metric constructor.

The fields accessible through corresponding lenses are:

mDimensions :: Lens' Metric [Dimension] Source

A list of dimensions associated with the metric.

mMetricName :: Lens' Metric (Maybe Text) Source

The name of the metric.

mNamespace :: Lens' Metric (Maybe Text) Source

The namespace of the metric.

StateValue

Datapoint

dAverage :: Lens' Datapoint (Maybe Double) Source

The average of metric values that correspond to the datapoint.

dMaximum :: Lens' Datapoint (Maybe Double) Source

The maximum of the metric value used for the datapoint.

dMinimum :: Lens' Datapoint (Maybe Double) Source

The minimum metric value used for the datapoint.

dSampleCount :: Lens' Datapoint (Maybe Double) Source

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

dSum :: Lens' Datapoint (Maybe Double) Source

The sum of metric values used for the datapoint.

dTimestamp :: Lens' Datapoint (Maybe UTCTime) Source

The time stamp used for the datapoint. Amazon CloudWatch uses Coordinated Universal Time (UTC) when returning time stamps, which do not accommodate seasonal adjustments such as daylight savings time. For more information, see Time stamps in the Amazon CloudWatch Developer Guide.

dUnit :: Lens' Datapoint (Maybe StandardUnit) Source

The standard unit used for the datapoint.

DimensionFilter

dimensionFilter Source

Arguments

:: Text

dfName

-> DimensionFilter 

DimensionFilter constructor.

The fields accessible through corresponding lenses are:

dfName :: Lens' DimensionFilter Text Source

The dimension name to be matched.

dfValue :: Lens' DimensionFilter (Maybe Text) Source

The value of the dimension to be matched.

Statistic