Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data MetricAlarm = MetricAlarm' {
- actionsEnabled :: Maybe Bool
- alarmActions :: Maybe [Text]
- alarmArn :: Maybe Text
- alarmConfigurationUpdatedTimestamp :: Maybe ISO8601
- alarmDescription :: Maybe Text
- alarmName :: Maybe Text
- comparisonOperator :: Maybe ComparisonOperator
- datapointsToAlarm :: Maybe Natural
- dimensions :: Maybe [Dimension]
- evaluateLowSampleCountPercentile :: Maybe Text
- evaluationPeriods :: Maybe Natural
- evaluationState :: Maybe EvaluationState
- extendedStatistic :: Maybe Text
- insufficientDataActions :: Maybe [Text]
- metricName :: Maybe Text
- metrics :: Maybe [MetricDataQuery]
- namespace :: Maybe Text
- oKActions :: Maybe [Text]
- period :: Maybe Natural
- stateReason :: Maybe Text
- stateReasonData :: Maybe Text
- stateTransitionedTimestamp :: Maybe ISO8601
- stateUpdatedTimestamp :: Maybe ISO8601
- stateValue :: Maybe StateValue
- statistic :: Maybe Statistic
- threshold :: Maybe Double
- thresholdMetricId :: Maybe Text
- treatMissingData :: Maybe Text
- unit :: Maybe StandardUnit
- newMetricAlarm :: MetricAlarm
- metricAlarm_actionsEnabled :: Lens' MetricAlarm (Maybe Bool)
- metricAlarm_alarmActions :: Lens' MetricAlarm (Maybe [Text])
- metricAlarm_alarmArn :: Lens' MetricAlarm (Maybe Text)
- metricAlarm_alarmConfigurationUpdatedTimestamp :: Lens' MetricAlarm (Maybe UTCTime)
- metricAlarm_alarmDescription :: Lens' MetricAlarm (Maybe Text)
- metricAlarm_alarmName :: Lens' MetricAlarm (Maybe Text)
- metricAlarm_comparisonOperator :: Lens' MetricAlarm (Maybe ComparisonOperator)
- metricAlarm_datapointsToAlarm :: Lens' MetricAlarm (Maybe Natural)
- metricAlarm_dimensions :: Lens' MetricAlarm (Maybe [Dimension])
- metricAlarm_evaluateLowSampleCountPercentile :: Lens' MetricAlarm (Maybe Text)
- metricAlarm_evaluationPeriods :: Lens' MetricAlarm (Maybe Natural)
- metricAlarm_evaluationState :: Lens' MetricAlarm (Maybe EvaluationState)
- metricAlarm_extendedStatistic :: Lens' MetricAlarm (Maybe Text)
- metricAlarm_insufficientDataActions :: Lens' MetricAlarm (Maybe [Text])
- metricAlarm_metricName :: Lens' MetricAlarm (Maybe Text)
- metricAlarm_metrics :: Lens' MetricAlarm (Maybe [MetricDataQuery])
- metricAlarm_namespace :: Lens' MetricAlarm (Maybe Text)
- metricAlarm_oKActions :: Lens' MetricAlarm (Maybe [Text])
- metricAlarm_period :: Lens' MetricAlarm (Maybe Natural)
- metricAlarm_stateReason :: Lens' MetricAlarm (Maybe Text)
- metricAlarm_stateReasonData :: Lens' MetricAlarm (Maybe Text)
- metricAlarm_stateTransitionedTimestamp :: Lens' MetricAlarm (Maybe UTCTime)
- metricAlarm_stateUpdatedTimestamp :: Lens' MetricAlarm (Maybe UTCTime)
- metricAlarm_stateValue :: Lens' MetricAlarm (Maybe StateValue)
- metricAlarm_statistic :: Lens' MetricAlarm (Maybe Statistic)
- metricAlarm_threshold :: Lens' MetricAlarm (Maybe Double)
- metricAlarm_thresholdMetricId :: Lens' MetricAlarm (Maybe Text)
- metricAlarm_treatMissingData :: Lens' MetricAlarm (Maybe Text)
- metricAlarm_unit :: Lens' MetricAlarm (Maybe StandardUnit)
Documentation
data MetricAlarm Source #
The details about a metric alarm.
See: newMetricAlarm
smart constructor.
MetricAlarm' | |
|
Instances
newMetricAlarm :: MetricAlarm Source #
Create a value of MetricAlarm
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:actionsEnabled:MetricAlarm'
, metricAlarm_actionsEnabled
- Indicates whether actions should be executed during any changes to the
alarm state.
$sel:alarmActions:MetricAlarm'
, metricAlarm_alarmActions
- 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).
$sel:alarmArn:MetricAlarm'
, metricAlarm_alarmArn
- The Amazon Resource Name (ARN) of the alarm.
$sel:alarmConfigurationUpdatedTimestamp:MetricAlarm'
, metricAlarm_alarmConfigurationUpdatedTimestamp
- The time stamp of the last update to the alarm configuration.
$sel:alarmDescription:MetricAlarm'
, metricAlarm_alarmDescription
- The description of the alarm.
$sel:alarmName:MetricAlarm'
, metricAlarm_alarmName
- The name of the alarm.
$sel:comparisonOperator:MetricAlarm'
, metricAlarm_comparisonOperator
- The arithmetic operation to use when comparing the specified statistic
and threshold. The specified statistic value is used as the first
operand.
$sel:datapointsToAlarm:MetricAlarm'
, metricAlarm_datapointsToAlarm
- The number of data points that must be breaching to trigger the alarm.
$sel:dimensions:MetricAlarm'
, metricAlarm_dimensions
- The dimensions for the metric associated with the alarm.
$sel:evaluateLowSampleCountPercentile:MetricAlarm'
, metricAlarm_evaluateLowSampleCountPercentile
- 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.
$sel:evaluationPeriods:MetricAlarm'
, metricAlarm_evaluationPeriods
- The number of periods over which data is compared to the specified
threshold.
$sel:evaluationState:MetricAlarm'
, metricAlarm_evaluationState
- If the value of this field is PARTIAL_DATA
, the alarm is being
evaluated based on only partial data. This happens if the query used for
the alarm returns more than 10,000 metrics. For more information, see
Create alarms on Metrics Insights queries.
$sel:extendedStatistic:MetricAlarm'
, metricAlarm_extendedStatistic
- The percentile statistic for the metric associated with the alarm.
Specify a value between p0.0 and p100.
$sel:insufficientDataActions:MetricAlarm'
, metricAlarm_insufficientDataActions
- 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).
$sel:metricName:MetricAlarm'
, metricAlarm_metricName
- The name of the metric associated with the alarm, if this is an alarm
based on a single metric.
$sel:metrics:MetricAlarm'
, metricAlarm_metrics
- An array of MetricDataQuery structures, used in an alarm based on a
metric math expression. Each structure either retrieves a metric or
performs a math expression. One item in the Metrics array is the math
expression that the alarm watches. This expression by designated by
having ReturnData
set to true.
$sel:namespace:MetricAlarm'
, metricAlarm_namespace
- The namespace of the metric associated with the alarm.
$sel:oKActions:MetricAlarm'
, metricAlarm_oKActions
- 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).
MetricAlarm
, metricAlarm_period
- The period, in seconds, over which the statistic is applied.
$sel:stateReason:MetricAlarm'
, metricAlarm_stateReason
- An explanation for the alarm state, in text format.
$sel:stateReasonData:MetricAlarm'
, metricAlarm_stateReasonData
- An explanation for the alarm state, in JSON format.
$sel:stateTransitionedTimestamp:MetricAlarm'
, metricAlarm_stateTransitionedTimestamp
- The date and time that the alarm's StateValue
most recently changed.
$sel:stateUpdatedTimestamp:MetricAlarm'
, metricAlarm_stateUpdatedTimestamp
- The time stamp of the last update to the value of either the
StateValue
or EvaluationState
parameters.
$sel:stateValue:MetricAlarm'
, metricAlarm_stateValue
- The state value for the alarm.
$sel:statistic:MetricAlarm'
, metricAlarm_statistic
- The statistic for the metric associated with the alarm, other than
percentile. For percentile statistics, use ExtendedStatistic
.
$sel:threshold:MetricAlarm'
, metricAlarm_threshold
- The value to compare with the specified statistic.
$sel:thresholdMetricId:MetricAlarm'
, metricAlarm_thresholdMetricId
- In an alarm based on an anomaly detection model, this is the ID of the
ANOMALY_DETECTION_BAND
function used as the threshold for the alarm.
$sel:treatMissingData:MetricAlarm'
, metricAlarm_treatMissingData
- Sets how this alarm is to handle missing data points. The valid values
are breaching
, notBreaching
, ignore
, and missing
. For more
information, see
Configuring how CloudWatch alarms treat missing data.
If this parameter is omitted, the default behavior of missing
is used.
$sel:unit:MetricAlarm'
, metricAlarm_unit
- The unit of the metric associated with the alarm.
metricAlarm_actionsEnabled :: Lens' MetricAlarm (Maybe Bool) Source #
Indicates whether actions should be executed during any changes to the alarm state.
metricAlarm_alarmActions :: Lens' MetricAlarm (Maybe [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).
metricAlarm_alarmArn :: Lens' MetricAlarm (Maybe Text) Source #
The Amazon Resource Name (ARN) of the alarm.
metricAlarm_alarmConfigurationUpdatedTimestamp :: Lens' MetricAlarm (Maybe UTCTime) Source #
The time stamp of the last update to the alarm configuration.
metricAlarm_alarmDescription :: Lens' MetricAlarm (Maybe Text) Source #
The description of the alarm.
metricAlarm_alarmName :: Lens' MetricAlarm (Maybe Text) Source #
The name of the alarm.
metricAlarm_comparisonOperator :: 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.
metricAlarm_datapointsToAlarm :: Lens' MetricAlarm (Maybe Natural) Source #
The number of data points that must be breaching to trigger the alarm.
metricAlarm_dimensions :: Lens' MetricAlarm (Maybe [Dimension]) Source #
The dimensions for the metric associated with the alarm.
metricAlarm_evaluateLowSampleCountPercentile :: 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.
metricAlarm_evaluationPeriods :: Lens' MetricAlarm (Maybe Natural) Source #
The number of periods over which data is compared to the specified threshold.
metricAlarm_evaluationState :: Lens' MetricAlarm (Maybe EvaluationState) Source #
If the value of this field is PARTIAL_DATA
, the alarm is being
evaluated based on only partial data. This happens if the query used for
the alarm returns more than 10,000 metrics. For more information, see
Create alarms on Metrics Insights queries.
metricAlarm_extendedStatistic :: Lens' MetricAlarm (Maybe Text) Source #
The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
metricAlarm_insufficientDataActions :: Lens' MetricAlarm (Maybe [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).
metricAlarm_metricName :: Lens' MetricAlarm (Maybe Text) Source #
The name of the metric associated with the alarm, if this is an alarm based on a single metric.
metricAlarm_metrics :: Lens' MetricAlarm (Maybe [MetricDataQuery]) Source #
An array of MetricDataQuery structures, used in an alarm based on a
metric math expression. Each structure either retrieves a metric or
performs a math expression. One item in the Metrics array is the math
expression that the alarm watches. This expression by designated by
having ReturnData
set to true.
metricAlarm_namespace :: Lens' MetricAlarm (Maybe Text) Source #
The namespace of the metric associated with the alarm.
metricAlarm_oKActions :: Lens' MetricAlarm (Maybe [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).
metricAlarm_period :: Lens' MetricAlarm (Maybe Natural) Source #
The period, in seconds, over which the statistic is applied.
metricAlarm_stateReason :: Lens' MetricAlarm (Maybe Text) Source #
An explanation for the alarm state, in text format.
metricAlarm_stateReasonData :: Lens' MetricAlarm (Maybe Text) Source #
An explanation for the alarm state, in JSON format.
metricAlarm_stateTransitionedTimestamp :: Lens' MetricAlarm (Maybe UTCTime) Source #
The date and time that the alarm's StateValue
most recently changed.
metricAlarm_stateUpdatedTimestamp :: Lens' MetricAlarm (Maybe UTCTime) Source #
The time stamp of the last update to the value of either the
StateValue
or EvaluationState
parameters.
metricAlarm_stateValue :: Lens' MetricAlarm (Maybe StateValue) Source #
The state value for the alarm.
metricAlarm_statistic :: Lens' MetricAlarm (Maybe Statistic) Source #
The statistic for the metric associated with the alarm, other than
percentile. For percentile statistics, use ExtendedStatistic
.
metricAlarm_threshold :: Lens' MetricAlarm (Maybe Double) Source #
The value to compare with the specified statistic.
metricAlarm_thresholdMetricId :: Lens' MetricAlarm (Maybe Text) Source #
In an alarm based on an anomaly detection model, this is the ID of the
ANOMALY_DETECTION_BAND
function used as the threshold for the alarm.
metricAlarm_treatMissingData :: Lens' MetricAlarm (Maybe Text) Source #
Sets how this alarm is to handle missing data points. The valid values
are breaching
, notBreaching
, ignore
, and missing
. For more
information, see
Configuring how CloudWatch alarms treat missing data.
If this parameter is omitted, the default behavior of missing
is used.
metricAlarm_unit :: Lens' MetricAlarm (Maybe StandardUnit) Source #
The unit of the metric associated with the alarm.