Copyright	(c) 2013-2021 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

Amazonka.CloudWatch.Types.MetricAlarm

Description

Synopsis

data MetricAlarm = MetricAlarm' {
- alarmName :: Maybe Text
- stateUpdatedTimestamp :: Maybe ISO8601
- metrics :: Maybe [MetricDataQuery]
- treatMissingData :: Maybe Text
- period :: Maybe Natural
- alarmDescription :: Maybe Text
- evaluationPeriods :: Maybe Natural
- metricName :: Maybe Text
- namespace :: Maybe Text
- thresholdMetricId :: Maybe Text
- comparisonOperator :: Maybe ComparisonOperator
- oKActions :: Maybe [Text]
- evaluateLowSampleCountPercentile :: Maybe Text
- stateValue :: Maybe StateValue
- datapointsToAlarm :: Maybe Natural
- threshold :: Maybe Double
- alarmConfigurationUpdatedTimestamp :: Maybe ISO8601
- actionsEnabled :: Maybe Bool
- insufficientDataActions :: Maybe [Text]
- stateReason :: Maybe Text
- stateReasonData :: Maybe Text
- dimensions :: Maybe [Dimension]
- alarmArn :: Maybe Text
- alarmActions :: Maybe [Text]
- unit :: Maybe StandardUnit
- statistic :: Maybe Statistic
- extendedStatistic :: Maybe Text
}
newMetricAlarm :: MetricAlarm
metricAlarm_alarmName :: Lens' MetricAlarm (Maybe Text)
metricAlarm_stateUpdatedTimestamp :: Lens' MetricAlarm (Maybe UTCTime)
metricAlarm_metrics :: Lens' MetricAlarm (Maybe [MetricDataQuery])
metricAlarm_treatMissingData :: Lens' MetricAlarm (Maybe Text)
metricAlarm_period :: Lens' MetricAlarm (Maybe Natural)
metricAlarm_alarmDescription :: Lens' MetricAlarm (Maybe Text)
metricAlarm_evaluationPeriods :: Lens' MetricAlarm (Maybe Natural)
metricAlarm_metricName :: Lens' MetricAlarm (Maybe Text)
metricAlarm_namespace :: Lens' MetricAlarm (Maybe Text)
metricAlarm_thresholdMetricId :: Lens' MetricAlarm (Maybe Text)
metricAlarm_comparisonOperator :: Lens' MetricAlarm (Maybe ComparisonOperator)
metricAlarm_oKActions :: Lens' MetricAlarm (Maybe [Text])
metricAlarm_evaluateLowSampleCountPercentile :: Lens' MetricAlarm (Maybe Text)
metricAlarm_stateValue :: Lens' MetricAlarm (Maybe StateValue)
metricAlarm_datapointsToAlarm :: Lens' MetricAlarm (Maybe Natural)
metricAlarm_threshold :: Lens' MetricAlarm (Maybe Double)
metricAlarm_alarmConfigurationUpdatedTimestamp :: Lens' MetricAlarm (Maybe UTCTime)
metricAlarm_actionsEnabled :: Lens' MetricAlarm (Maybe Bool)
metricAlarm_insufficientDataActions :: Lens' MetricAlarm (Maybe [Text])
metricAlarm_stateReason :: Lens' MetricAlarm (Maybe Text)
metricAlarm_stateReasonData :: Lens' MetricAlarm (Maybe Text)
metricAlarm_dimensions :: Lens' MetricAlarm (Maybe [Dimension])
metricAlarm_alarmArn :: Lens' MetricAlarm (Maybe Text)
metricAlarm_alarmActions :: Lens' MetricAlarm (Maybe [Text])
metricAlarm_unit :: Lens' MetricAlarm (Maybe StandardUnit)
metricAlarm_statistic :: Lens' MetricAlarm (Maybe Statistic)
metricAlarm_extendedStatistic :: Lens' MetricAlarm (Maybe Text)

Documentation

data MetricAlarm Source #

The details about a metric alarm.

See: newMetricAlarm smart constructor.

Constructors

MetricAlarm'

Fields

alarmName :: Maybe Text
The name of the alarm.
stateUpdatedTimestamp :: Maybe ISO8601
The time stamp of the last update to the alarm state.
metrics :: Maybe [MetricDataQuery]
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.
treatMissingData :: Maybe Text
Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of missing is used.
period :: Maybe Natural
The period, in seconds, over which the statistic is applied.
alarmDescription :: Maybe Text
The description of the alarm.
evaluationPeriods :: Maybe Natural
The number of periods over which data is compared to the specified threshold.
metricName :: Maybe Text
The name of the metric associated with the alarm, if this is an alarm based on a single metric.
namespace :: Maybe Text
The namespace of the metric associated with the alarm.
thresholdMetricId :: Maybe Text
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.
comparisonOperator :: Maybe ComparisonOperator
The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
oKActions :: Maybe [Text]
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).
evaluateLowSampleCountPercentile :: Maybe Text
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.
stateValue :: Maybe StateValue
The state value for the alarm.
datapointsToAlarm :: Maybe Natural
The number of data points that must be breaching to trigger the alarm.
threshold :: Maybe Double
The value to compare with the specified statistic.
alarmConfigurationUpdatedTimestamp :: Maybe ISO8601
The time stamp of the last update to the alarm configuration.
actionsEnabled :: Maybe Bool
Indicates whether actions should be executed during any changes to the alarm state.
insufficientDataActions :: Maybe [Text]
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).
stateReason :: Maybe Text
An explanation for the alarm state, in text format.
stateReasonData :: Maybe Text
An explanation for the alarm state, in JSON format.
dimensions :: Maybe [Dimension]
The dimensions for the metric associated with the alarm.
alarmArn :: Maybe Text
The Amazon Resource Name (ARN) of the alarm.
alarmActions :: Maybe [Text]
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).
unit :: Maybe StandardUnit
The unit of the metric associated with the alarm.
statistic :: Maybe Statistic
The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.
extendedStatistic :: Maybe Text
The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.

Instances

Instances details

Eq MetricAlarm Source #
Instance details Defined in Amazonka.CloudWatch.Types.MetricAlarm Methods (==) :: MetricAlarm -> MetricAlarm -> Bool # (/=) :: MetricAlarm -> MetricAlarm -> Bool #
Read MetricAlarm Source #
Instance details Defined in Amazonka.CloudWatch.Types.MetricAlarm Methods readsPrec :: Int -> ReadS MetricAlarm # readList :: ReadS [MetricAlarm] # readPrec :: ReadPrec MetricAlarm # readListPrec :: ReadPrec [MetricAlarm] #
Show MetricAlarm Source #
Instance details Defined in Amazonka.CloudWatch.Types.MetricAlarm Methods showsPrec :: Int -> MetricAlarm -> ShowS # show :: MetricAlarm -> String # showList :: [MetricAlarm] -> ShowS #
Generic MetricAlarm Source #
Instance details Defined in Amazonka.CloudWatch.Types.MetricAlarm Associated Types type Rep MetricAlarm :: Type -> Type # Methods from :: MetricAlarm -> Rep MetricAlarm x # to :: Rep MetricAlarm x -> MetricAlarm #
NFData MetricAlarm Source #
Instance details Defined in Amazonka.CloudWatch.Types.MetricAlarm Methods rnf :: MetricAlarm -> () #
Hashable MetricAlarm Source #
Instance details Defined in Amazonka.CloudWatch.Types.MetricAlarm Methods hashWithSalt :: Int -> MetricAlarm -> Int # hash :: MetricAlarm -> Int #
FromXML MetricAlarm Source #
Instance details Defined in Amazonka.CloudWatch.Types.MetricAlarm Methods parseXML :: [Node] -> Either String MetricAlarm #
type Rep MetricAlarm Source #
Instance details Defined in Amazonka.CloudWatch.Types.MetricAlarm type Rep MetricAlarm = D1 ('MetaData "MetricAlarm" "Amazonka.CloudWatch.Types.MetricAlarm" "libZSservicesZSamazonka-cloudwatchZSamazonka-cloudwatch" 'False) (C1 ('MetaCons "MetricAlarm'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "alarmName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "stateUpdatedTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "metrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricDataQuery])))) :: (S1 ('MetaSel ('Just "treatMissingData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "period") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "alarmDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "evaluationPeriods") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "thresholdMetricId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "comparisonOperator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ComparisonOperator))) :: (S1 ('MetaSel ('Just "oKActions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "evaluateLowSampleCountPercentile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :: (((S1 ('MetaSel ('Just "stateValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StateValue)) :: (S1 ('MetaSel ('Just "datapointsToAlarm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "threshold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))) :: ((S1 ('MetaSel ('Just "alarmConfigurationUpdatedTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "actionsEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "insufficientDataActions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "stateReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "stateReasonData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Dimension])) :: S1 ('MetaSel ('Just "alarmArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "alarmActions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "unit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StandardUnit))) :: (S1 ('MetaSel ('Just "statistic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Statistic)) :: S1 ('MetaSel ('Just "extendedStatistic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))))

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:alarmName:MetricAlarm', metricAlarm_alarmName - The name of the alarm.

$sel:stateUpdatedTimestamp:MetricAlarm', metricAlarm_stateUpdatedTimestamp - The time stamp of the last update to the alarm state.

$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:treatMissingData:MetricAlarm', metricAlarm_treatMissingData - Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of missing is used.

$sel:period:MetricAlarm', metricAlarm_period - The period, in seconds, over which the statistic is applied.

$sel:alarmDescription:MetricAlarm', metricAlarm_alarmDescription - The description of the alarm.

$sel:evaluationPeriods:MetricAlarm', metricAlarm_evaluationPeriods - The number of periods over which data is compared to the specified threshold.

$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:namespace:MetricAlarm', metricAlarm_namespace - The namespace of the metric associated with the alarm.

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

$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:stateValue:MetricAlarm', metricAlarm_stateValue - The state value for the alarm.

$sel:datapointsToAlarm:MetricAlarm', metricAlarm_datapointsToAlarm - The number of data points that must be breaching to trigger the alarm.

$sel:threshold:MetricAlarm', metricAlarm_threshold - The value to compare with the specified statistic.

$sel:alarmConfigurationUpdatedTimestamp:MetricAlarm', metricAlarm_alarmConfigurationUpdatedTimestamp - The time stamp of the last update to the alarm configuration.

$sel:actionsEnabled:MetricAlarm', metricAlarm_actionsEnabled - Indicates whether actions should be executed during any changes to the alarm state.

$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: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:dimensions:MetricAlarm', metricAlarm_dimensions - The dimensions for the metric associated with the alarm.

$sel:alarmArn:MetricAlarm', metricAlarm_alarmArn - The Amazon Resource Name (ARN) of the alarm.

$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:unit:MetricAlarm', metricAlarm_unit - The unit of the metric associated with 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:extendedStatistic:MetricAlarm', metricAlarm_extendedStatistic - The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.

metricAlarm_alarmName :: Lens' MetricAlarm (Maybe Text) Source #

The name of the alarm.

metricAlarm_stateUpdatedTimestamp :: Lens' MetricAlarm (Maybe UTCTime) Source #

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

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

metricAlarm_period :: Lens' MetricAlarm (Maybe Natural) Source #

The period, in seconds, over which the statistic is applied.

metricAlarm_alarmDescription :: Lens' MetricAlarm (Maybe Text) Source #

The description of the alarm.

metricAlarm_evaluationPeriods :: Lens' MetricAlarm (Maybe Natural) Source #

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

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_namespace :: Lens' MetricAlarm (Maybe Text) Source #

The namespace of the metric associated with the alarm.

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_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_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_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_stateValue :: Lens' MetricAlarm (Maybe StateValue) Source #

The state value for the alarm.

metricAlarm_datapointsToAlarm :: Lens' MetricAlarm (Maybe Natural) Source #

The number of data points that must be breaching to trigger the alarm.

metricAlarm_threshold :: Lens' MetricAlarm (Maybe Double) Source #

The value to compare with the specified statistic.

metricAlarm_alarmConfigurationUpdatedTimestamp :: Lens' MetricAlarm (Maybe UTCTime) Source #

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

metricAlarm_actionsEnabled :: Lens' MetricAlarm (Maybe Bool) Source #

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

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_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_dimensions :: Lens' MetricAlarm (Maybe [Dimension]) Source #

The dimensions for the metric associated with the alarm.

metricAlarm_alarmArn :: Lens' MetricAlarm (Maybe Text) Source #

The Amazon Resource Name (ARN) of the alarm.

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_unit :: Lens' MetricAlarm (Maybe StandardUnit) Source #

The unit of the metric associated with 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_extendedStatistic :: Lens' MetricAlarm (Maybe Text) Source #

The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.