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

Amazonka.IoTSiteWise.Types.Alarms

Description

Synopsis

data Alarms = Alarms' {
- notificationLambdaArn :: Maybe Text
- alarmRoleArn :: Text
}
newAlarms :: Text -> Alarms
alarms_notificationLambdaArn :: Lens' Alarms (Maybe Text)
alarms_alarmRoleArn :: Lens' Alarms Text

Documentation

data Alarms Source #

Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide.

See: newAlarms smart constructor.

Constructors

Alarms'
Fields notificationLambdaArn :: Maybe Text The ARN of the Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the IoT Events Developer Guide. alarmRoleArn :: Text The ARN of the IAM role that allows the alarm to perform actions and access Amazon Web Services resources and services, such as IoT Events.

Instances

Instances details

FromJSON Alarms Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.Alarms Methods parseJSON :: Value -> Parser Alarms # parseJSONList :: Value -> Parser [Alarms] #
ToJSON Alarms Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.Alarms Methods toJSON :: Alarms -> Value # toEncoding :: Alarms -> Encoding # toJSONList :: [Alarms] -> Value # toEncodingList :: [Alarms] -> Encoding #
Generic Alarms Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.Alarms Associated Types type Rep Alarms :: Type -> Type # Methods from :: Alarms -> Rep Alarms x # to :: Rep Alarms x -> Alarms #
Read Alarms Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.Alarms Methods readsPrec :: Int -> ReadS Alarms # readList :: ReadS [Alarms] # readPrec :: ReadPrec Alarms # readListPrec :: ReadPrec [Alarms] #
Show Alarms Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.Alarms Methods showsPrec :: Int -> Alarms -> ShowS # show :: Alarms -> String # showList :: [Alarms] -> ShowS #
NFData Alarms Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.Alarms Methods rnf :: Alarms -> () #
Eq Alarms Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.Alarms Methods (==) :: Alarms -> Alarms -> Bool # (/=) :: Alarms -> Alarms -> Bool #
Hashable Alarms Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.Alarms Methods hashWithSalt :: Int -> Alarms -> Int # hash :: Alarms -> Int #
type Rep Alarms Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.Alarms type Rep Alarms = D1 ('MetaData "Alarms" "Amazonka.IoTSiteWise.Types.Alarms" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "Alarms'" 'PrefixI 'True) (S1 ('MetaSel ('Just "notificationLambdaArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "alarmRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newAlarms Source #

Arguments

:: Text	`$sel:alarmRoleArn:Alarms'`
-> Alarms

Create a value of Alarms 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:notificationLambdaArn:Alarms', alarms_notificationLambdaArn - The ARN of the Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the IoT Events Developer Guide.

$sel:alarmRoleArn:Alarms', alarms_alarmRoleArn - The ARN of the IAM role that allows the alarm to perform actions and access Amazon Web Services resources and services, such as IoT Events.

alarms_notificationLambdaArn :: Lens' Alarms (Maybe Text) Source #

The ARN of the Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the IoT Events Developer Guide.

alarms_alarmRoleArn :: Lens' Alarms Text Source #

The ARN of the IAM role that allows the alarm to perform actions and access Amazon Web Services resources and services, such as IoT Events.