Copyright | (c) 2013-2017 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- cloudWatch :: Service
- _LimitExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DashboardNotFoundError :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidNextToken :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServiceFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DashboardInvalidInputError :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterValueException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidFormatFault :: AsError a => Getting (First ServiceError) a ServiceError
- _MissingRequiredParameterException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterCombinationException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFound :: AsError a => Getting (First ServiceError) a ServiceError
- data ComparisonOperator
- data HistoryItemType
- data StandardUnit
- = 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
- data StateValue
- = Alarm
- | InsufficientData
- | OK
- data Statistic
- = Average
- | Maximum
- | Minimum
- | SampleCount
- | Sum
- data AlarmHistoryItem
- alarmHistoryItem :: AlarmHistoryItem
- ahiAlarmName :: Lens' AlarmHistoryItem (Maybe Text)
- ahiHistoryItemType :: Lens' AlarmHistoryItem (Maybe HistoryItemType)
- ahiHistoryData :: Lens' AlarmHistoryItem (Maybe Text)
- ahiHistorySummary :: Lens' AlarmHistoryItem (Maybe Text)
- ahiTimestamp :: Lens' AlarmHistoryItem (Maybe UTCTime)
- data DashboardEntry
- dashboardEntry :: DashboardEntry
- deSize :: Lens' DashboardEntry (Maybe Integer)
- deDashboardName :: Lens' DashboardEntry (Maybe Text)
- deLastModified :: Lens' DashboardEntry (Maybe UTCTime)
- deDashboardARN :: Lens' DashboardEntry (Maybe Text)
- data DashboardValidationMessage
- dashboardValidationMessage :: DashboardValidationMessage
- dvmDataPath :: Lens' DashboardValidationMessage (Maybe Text)
- dvmMessage :: Lens' DashboardValidationMessage (Maybe Text)
- data Datapoint
- datapoint :: Datapoint
- dSampleCount :: Lens' Datapoint (Maybe Double)
- dMaximum :: Lens' Datapoint (Maybe Double)
- dAverage :: Lens' Datapoint (Maybe Double)
- dMinimum :: Lens' Datapoint (Maybe Double)
- dExtendedStatistics :: Lens' Datapoint (HashMap Text Double)
- dSum :: Lens' Datapoint (Maybe Double)
- dUnit :: Lens' Datapoint (Maybe StandardUnit)
- dTimestamp :: Lens' Datapoint (Maybe UTCTime)
- data Dimension
- dimension :: Text -> Text -> Dimension
- dName :: Lens' Dimension Text
- dValue :: Lens' Dimension Text
- data DimensionFilter
- dimensionFilter :: Text -> DimensionFilter
- dfValue :: Lens' DimensionFilter (Maybe Text)
- dfName :: Lens' DimensionFilter Text
- data Metric
- metric :: Metric
- mMetricName :: Lens' Metric (Maybe Text)
- mNamespace :: Lens' Metric (Maybe Text)
- mDimensions :: Lens' Metric [Dimension]
- data MetricAlarm
- metricAlarm :: MetricAlarm
- maAlarmName :: Lens' MetricAlarm (Maybe Text)
- maStateUpdatedTimestamp :: Lens' MetricAlarm (Maybe UTCTime)
- maTreatMissingData :: Lens' MetricAlarm (Maybe Text)
- maPeriod :: Lens' MetricAlarm (Maybe Natural)
- maAlarmDescription :: Lens' MetricAlarm (Maybe Text)
- maEvaluationPeriods :: Lens' MetricAlarm (Maybe Natural)
- maMetricName :: Lens' MetricAlarm (Maybe Text)
- maNamespace :: Lens' MetricAlarm (Maybe Text)
- maComparisonOperator :: Lens' MetricAlarm (Maybe ComparisonOperator)
- maOKActions :: Lens' MetricAlarm [Text]
- maEvaluateLowSampleCountPercentile :: Lens' MetricAlarm (Maybe Text)
- maStateValue :: Lens' MetricAlarm (Maybe StateValue)
- maThreshold :: Lens' MetricAlarm (Maybe Double)
- maAlarmConfigurationUpdatedTimestamp :: Lens' MetricAlarm (Maybe UTCTime)
- maActionsEnabled :: Lens' MetricAlarm (Maybe Bool)
- maInsufficientDataActions :: Lens' MetricAlarm [Text]
- maStateReason :: Lens' MetricAlarm (Maybe Text)
- maStateReasonData :: Lens' MetricAlarm (Maybe Text)
- maDimensions :: Lens' MetricAlarm [Dimension]
- maAlarmARN :: Lens' MetricAlarm (Maybe Text)
- maAlarmActions :: Lens' MetricAlarm [Text]
- maUnit :: Lens' MetricAlarm (Maybe StandardUnit)
- maStatistic :: Lens' MetricAlarm (Maybe Statistic)
- maExtendedStatistic :: Lens' MetricAlarm (Maybe Text)
- data MetricDatum
- metricDatum :: Text -> MetricDatum
- mdValue :: Lens' MetricDatum (Maybe Double)
- mdStorageResolution :: Lens' MetricDatum (Maybe Natural)
- mdDimensions :: Lens' MetricDatum [Dimension]
- mdUnit :: Lens' MetricDatum (Maybe StandardUnit)
- mdTimestamp :: Lens' MetricDatum (Maybe UTCTime)
- mdStatisticValues :: Lens' MetricDatum (Maybe StatisticSet)
- mdMetricName :: Lens' MetricDatum Text
- data StatisticSet
- statisticSet :: Double -> Double -> Double -> Double -> StatisticSet
- ssSampleCount :: Lens' StatisticSet Double
- ssSum :: Lens' StatisticSet Double
- ssMinimum :: Lens' StatisticSet Double
- ssMaximum :: Lens' StatisticSet Double
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.
_DashboardNotFoundError :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified dashboard does not exist.
_InvalidNextToken :: AsError a => Getting (First ServiceError) a ServiceError Source #
The next token specified is invalid.
_InternalServiceFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
Request processing has failed due to some unknown error, exception, or failure.
_DashboardInvalidInputError :: AsError a => Getting (First ServiceError) a ServiceError Source #
Some part of the dashboard data is invalid.
_InvalidParameterValueException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The value of an input parameter is bad or out-of-range.
_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 required is missing.
_InvalidParameterCombinationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Parameters were used together that cannot be used together.
_ResourceNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source #
The named resource does not exist.
ComparisonOperator
data ComparisonOperator Source #
HistoryItemType
data HistoryItemType Source #
StandardUnit
data StandardUnit Source #
StateValue
data StateValue Source #
Statistic
AlarmHistoryItem
data AlarmHistoryItem Source #
Represents the history of a specific alarm.
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
- The descriptive name for the alarm.ahiHistoryItemType
- The type of alarm history item.ahiHistoryData
- Data about the alarm, in JSON format.ahiHistorySummary
- A summary of the alarm history, in text format.ahiTimestamp
- The time stamp for the alarm history item.
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 #
Data about the alarm, in JSON format.
ahiHistorySummary :: Lens' AlarmHistoryItem (Maybe Text) Source #
A summary of the alarm history, in text format.
ahiTimestamp :: Lens' AlarmHistoryItem (Maybe UTCTime) Source #
The time stamp for the alarm history item.
DashboardEntry
data DashboardEntry Source #
Represents a specific dashboard.
See: dashboardEntry
smart constructor.
dashboardEntry :: DashboardEntry Source #
Creates a value of DashboardEntry
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
deSize
- The size of the dashboard, in bytes.deDashboardName
- The name of the dashboard.deLastModified
- The time stamp of when the dashboard was last modified, either by an API call or through the console. This number is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.deDashboardARN
- The Amazon Resource Name (ARN) of the dashboard.
deDashboardName :: Lens' DashboardEntry (Maybe Text) Source #
The name of the dashboard.
deLastModified :: Lens' DashboardEntry (Maybe UTCTime) Source #
The time stamp of when the dashboard was last modified, either by an API call or through the console. This number is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
deDashboardARN :: Lens' DashboardEntry (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dashboard.
DashboardValidationMessage
data DashboardValidationMessage Source #
An error or warning for the operation.
See: dashboardValidationMessage
smart constructor.
dashboardValidationMessage :: DashboardValidationMessage Source #
Creates a value of DashboardValidationMessage
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dvmDataPath
- The data path related to the message.dvmMessage
- A message describing the error or warning.
dvmDataPath :: Lens' DashboardValidationMessage (Maybe Text) Source #
The data path related to the message.
dvmMessage :: Lens' DashboardValidationMessage (Maybe Text) Source #
A message describing the error or warning.
Datapoint
Encapsulates the statistical data that 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
- The number of metric values that contributed to the aggregate value of this data point.dMaximum
- The maximum metric value for the data point.dAverage
- The average of the metric values that correspond to the data point.dMinimum
- The minimum metric value for the data point.dExtendedStatistics
- The percentile statistic for the data point.dSum
- The sum of the metric values for the data point.dUnit
- The standard unit for the data point.dTimestamp
- The time stamp used for the data point.
dSampleCount :: Lens' Datapoint (Maybe Double) Source #
The number of metric values that contributed to the aggregate value of this data point.
dAverage :: Lens' Datapoint (Maybe Double) Source #
The average of the metric values that correspond to the data point.
dExtendedStatistics :: Lens' Datapoint (HashMap Text Double) Source #
The percentile statistic for the data point.
Dimension
Expands the identity of a metric.
See: dimension
smart constructor.
DimensionFilter
data DimensionFilter Source #
Represents filters for a dimension.
See: dimensionFilter
smart constructor.
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:
Metric
Represents a specific metric.
See: metric
smart constructor.
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
- The name of the metric.mNamespace
- The namespace of the metric.mDimensions
- The dimensions for the metric.
MetricAlarm
data MetricAlarm Source #
Represents 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
- The name of the alarm.maStateUpdatedTimestamp
- The time stamp of the last update to the alarm state.maTreatMissingData
- Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior ofmissing
is used.maPeriod
- The period, in seconds, over which the statistic is applied.maAlarmDescription
- The description of the alarm.maEvaluationPeriods
- The number of periods over which data is compared to the specified threshold.maMetricName
- The name of the metric associated with the alarm.maNamespace
- The namespace of the metric associated with the alarm.maComparisonOperator
- The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.maOKActions
- The actions to execute when this alarm transitions to theOK
state from any other state. Each action is specified as an Amazon Resource Name (ARN).maEvaluateLowSampleCountPercentile
- Used only for alarms based on percentiles. Ifignore
, the alarm state does not change during periods with too few data points to be statistically significant. Ifevaluate
or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.maStateValue
- The state value for the alarm.maThreshold
- The value to compare with the specified statistic.maAlarmConfigurationUpdatedTimestamp
- The time stamp of the last update to the alarm configuration.maActionsEnabled
- Indicates whether actions should be executed during any changes to the alarm state.maInsufficientDataActions
- The actions to execute when this alarm transitions to theINSUFFICIENT_DATA
state from any other state. Each action is specified as an Amazon Resource Name (ARN).maStateReason
- An explanation for the alarm state, in text format.maStateReasonData
- An explanation for the alarm state, in JSON format.maDimensions
- The dimensions for the metric associated with the alarm.maAlarmARN
- The Amazon Resource Name (ARN) of the alarm.maAlarmActions
- The actions to execute when this alarm transitions to theALARM
state from any other state. Each action is specified as an Amazon Resource Name (ARN).maUnit
- The unit of the metric associated with the alarm.maStatistic
- The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, useExtendedStatistic
.maExtendedStatistic
- The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
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 state.
maTreatMissingData :: Lens' MetricAlarm (Maybe Text) Source #
Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of missing
is used.
maPeriod :: Lens' MetricAlarm (Maybe Natural) Source #
The period, in seconds, over which the statistic is applied.
maAlarmDescription :: Lens' MetricAlarm (Maybe Text) Source #
The description of 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 metric associated with the alarm.
maNamespace :: Lens' MetricAlarm (Maybe Text) Source #
The namespace of the metric associated with 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.
maOKActions :: Lens' MetricAlarm [Text] Source #
The actions to execute when this alarm transitions to the OK
state from any other state. Each action is specified as an Amazon Resource Name (ARN).
maEvaluateLowSampleCountPercentile :: Lens' MetricAlarm (Maybe Text) Source #
Used only for alarms based on percentiles. If ignore
, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate
or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
maStateValue :: Lens' MetricAlarm (Maybe StateValue) Source #
The state value for the alarm.
maThreshold :: Lens' MetricAlarm (Maybe Double) Source #
The value to compare with the specified statistic.
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 state.
maInsufficientDataActions :: Lens' MetricAlarm [Text] Source #
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA
state from any other state. Each action is specified as an Amazon Resource Name (ARN).
maStateReason :: Lens' MetricAlarm (Maybe Text) Source #
An explanation for the alarm state, in text format.
maStateReasonData :: Lens' MetricAlarm (Maybe Text) Source #
An explanation for the alarm state, in JSON format.
maDimensions :: Lens' MetricAlarm [Dimension] Source #
The dimensions for the metric associated with the alarm.
maAlarmARN :: Lens' MetricAlarm (Maybe Text) Source #
The Amazon Resource Name (ARN) of the alarm.
maAlarmActions :: Lens' MetricAlarm [Text] Source #
The actions to execute when this alarm transitions to the 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 metric associated with the alarm.
maStatistic :: Lens' MetricAlarm (Maybe Statistic) Source #
The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic
.
maExtendedStatistic :: Lens' MetricAlarm (Maybe Text) Source #
The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
MetricDatum
data MetricDatum Source #
Encapsulates the information sent to either create a metric or add new values to be aggregated into an existing metric.
See: metricDatum
smart constructor.
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
- The value for the metric. Although the parameter accepts numbers of type Double, 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 (for example, NaN, +Infinity, -Infinity) are not supported.mdStorageResolution
- Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with sub-minute resolution down to one second. Setting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available only for custom metrics. For more information about high-resolution metrics, see High-Resolution Metrics in the Amazon CloudWatch User Guide . This field is optional, if you do not specify it the default of 60 is used.mdDimensions
- The dimensions associated with the metric.mdUnit
- The unit of the metric.mdTimestamp
- The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.mdStatisticValues
- The statistical values for the metric.mdMetricName
- The name of the metric.
mdValue :: Lens' MetricDatum (Maybe Double) Source #
The value for the metric. Although the parameter accepts numbers of type Double, 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 (for example, NaN, +Infinity, -Infinity) are not supported.
mdStorageResolution :: Lens' MetricDatum (Maybe Natural) Source #
Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with sub-minute resolution down to one second. Setting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available only for custom metrics. For more information about high-resolution metrics, see High-Resolution Metrics in the Amazon CloudWatch User Guide . This field is optional, if you do not specify it the default of 60 is used.
mdDimensions :: Lens' MetricDatum [Dimension] Source #
The dimensions associated with the metric.
mdUnit :: Lens' MetricDatum (Maybe StandardUnit) Source #
The unit of the metric.
mdTimestamp :: Lens' MetricDatum (Maybe UTCTime) Source #
The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
mdStatisticValues :: Lens' MetricDatum (Maybe StatisticSet) Source #
The statistical values for the metric.
mdMetricName :: Lens' MetricDatum Text Source #
The name of the metric.
StatisticSet
data StatisticSet Source #
Represents a set of statistics that describes a specific metric.
See: statisticSet
smart constructor.
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
- The number of samples used for the statistic set.ssSum
- The sum of values for the sample set.ssMinimum
- The minimum value of the sample set.ssMaximum
- The maximum value of the sample set.
ssSampleCount :: Lens' StatisticSet Double Source #
The number of samples used for the statistic set.