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.IoTEvents.UpdateAlarmModel

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates an alarm model. Any alarms that were created based on the previous version are deleted and then created again as new data arrives.

Synopsis

data UpdateAlarmModel = UpdateAlarmModel' {
- severity :: Maybe Natural
- alarmNotification :: Maybe AlarmNotification
- alarmModelDescription :: Maybe Text
- alarmEventActions :: Maybe AlarmEventActions
- alarmCapabilities :: Maybe AlarmCapabilities
- alarmModelName :: Text
- roleArn :: Text
- alarmRule :: AlarmRule
}
newUpdateAlarmModel :: Text -> Text -> AlarmRule -> UpdateAlarmModel
updateAlarmModel_severity :: Lens' UpdateAlarmModel (Maybe Natural)
updateAlarmModel_alarmNotification :: Lens' UpdateAlarmModel (Maybe AlarmNotification)
updateAlarmModel_alarmModelDescription :: Lens' UpdateAlarmModel (Maybe Text)
updateAlarmModel_alarmEventActions :: Lens' UpdateAlarmModel (Maybe AlarmEventActions)
updateAlarmModel_alarmCapabilities :: Lens' UpdateAlarmModel (Maybe AlarmCapabilities)
updateAlarmModel_alarmModelName :: Lens' UpdateAlarmModel Text
updateAlarmModel_roleArn :: Lens' UpdateAlarmModel Text
updateAlarmModel_alarmRule :: Lens' UpdateAlarmModel AlarmRule
data UpdateAlarmModelResponse = UpdateAlarmModelResponse' {
- creationTime :: Maybe POSIX
- status :: Maybe AlarmModelVersionStatus
- lastUpdateTime :: Maybe POSIX
- alarmModelVersion :: Maybe Text
- alarmModelArn :: Maybe Text
- httpStatus :: Int
}
newUpdateAlarmModelResponse :: Int -> UpdateAlarmModelResponse
updateAlarmModelResponse_creationTime :: Lens' UpdateAlarmModelResponse (Maybe UTCTime)
updateAlarmModelResponse_status :: Lens' UpdateAlarmModelResponse (Maybe AlarmModelVersionStatus)
updateAlarmModelResponse_lastUpdateTime :: Lens' UpdateAlarmModelResponse (Maybe UTCTime)
updateAlarmModelResponse_alarmModelVersion :: Lens' UpdateAlarmModelResponse (Maybe Text)
updateAlarmModelResponse_alarmModelArn :: Lens' UpdateAlarmModelResponse (Maybe Text)
updateAlarmModelResponse_httpStatus :: Lens' UpdateAlarmModelResponse Int

Creating a Request

data UpdateAlarmModel Source #

See: newUpdateAlarmModel smart constructor.

Constructors

UpdateAlarmModel'

Fields

severity :: Maybe Natural
A non-negative integer that reflects the severity level of the alarm.
alarmNotification :: Maybe AlarmNotification
Contains information about one or more notification actions.
alarmModelDescription :: Maybe Text
The description of the alarm model.
alarmEventActions :: Maybe AlarmEventActions
Contains information about one or more alarm actions.
alarmCapabilities :: Maybe AlarmCapabilities
Contains the configuration information of alarm state changes.
alarmModelName :: Text
The name of the alarm model.
roleArn :: Text
The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
alarmRule :: AlarmRule
Defines when your alarm is invoked.

Instances

Instances details

Eq UpdateAlarmModel Source #
Instance details Defined in Amazonka.IoTEvents.UpdateAlarmModel Methods (==) :: UpdateAlarmModel -> UpdateAlarmModel -> Bool # (/=) :: UpdateAlarmModel -> UpdateAlarmModel -> Bool #
Read UpdateAlarmModel Source #
Instance details Defined in Amazonka.IoTEvents.UpdateAlarmModel Methods readsPrec :: Int -> ReadS UpdateAlarmModel # readList :: ReadS [UpdateAlarmModel] # readPrec :: ReadPrec UpdateAlarmModel # readListPrec :: ReadPrec [UpdateAlarmModel] #
Show UpdateAlarmModel Source #
Instance details Defined in Amazonka.IoTEvents.UpdateAlarmModel Methods showsPrec :: Int -> UpdateAlarmModel -> ShowS # show :: UpdateAlarmModel -> String # showList :: [UpdateAlarmModel] -> ShowS #
Generic UpdateAlarmModel Source #
Instance details Defined in Amazonka.IoTEvents.UpdateAlarmModel Associated Types type Rep UpdateAlarmModel :: Type -> Type # Methods from :: UpdateAlarmModel -> Rep UpdateAlarmModel x # to :: Rep UpdateAlarmModel x -> UpdateAlarmModel #
NFData UpdateAlarmModel Source #
Instance details Defined in Amazonka.IoTEvents.UpdateAlarmModel Methods rnf :: UpdateAlarmModel -> () #
Hashable UpdateAlarmModel Source #
Instance details Defined in Amazonka.IoTEvents.UpdateAlarmModel Methods hashWithSalt :: Int -> UpdateAlarmModel -> Int # hash :: UpdateAlarmModel -> Int #
ToJSON UpdateAlarmModel Source #
Instance details Defined in Amazonka.IoTEvents.UpdateAlarmModel Methods toJSON :: UpdateAlarmModel -> Value # toEncoding :: UpdateAlarmModel -> Encoding # toJSONList :: [UpdateAlarmModel] -> Value # toEncodingList :: [UpdateAlarmModel] -> Encoding #
AWSRequest UpdateAlarmModel Source #
Instance details Defined in Amazonka.IoTEvents.UpdateAlarmModel Associated Types type AWSResponse UpdateAlarmModel # Methods request :: UpdateAlarmModel -> Request UpdateAlarmModel # response :: MonadResource m => Logger -> Service -> Proxy UpdateAlarmModel -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateAlarmModel))) #
ToHeaders UpdateAlarmModel Source #
Instance details Defined in Amazonka.IoTEvents.UpdateAlarmModel Methods toHeaders :: UpdateAlarmModel -> [Header] #
ToPath UpdateAlarmModel Source #
Instance details Defined in Amazonka.IoTEvents.UpdateAlarmModel Methods toPath :: UpdateAlarmModel -> ByteString #
ToQuery UpdateAlarmModel Source #
Instance details Defined in Amazonka.IoTEvents.UpdateAlarmModel Methods toQuery :: UpdateAlarmModel -> QueryString #
type Rep UpdateAlarmModel Source #
Instance details Defined in Amazonka.IoTEvents.UpdateAlarmModel type Rep UpdateAlarmModel = D1 ('MetaData "UpdateAlarmModel" "Amazonka.IoTEvents.UpdateAlarmModel" "libZSservicesZSamazonka-ioteventsZSamazonka-iotevents" 'False) (C1 ('MetaCons "UpdateAlarmModel'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "severity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "alarmNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AlarmNotification))) :: (S1 ('MetaSel ('Just "alarmModelDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "alarmEventActions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AlarmEventActions)))) :: ((S1 ('MetaSel ('Just "alarmCapabilities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AlarmCapabilities)) :: S1 ('MetaSel ('Just "alarmModelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "alarmRule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AlarmRule)))))
type AWSResponse UpdateAlarmModel Source #
Instance details Defined in Amazonka.IoTEvents.UpdateAlarmModel type AWSResponse UpdateAlarmModel = UpdateAlarmModelResponse

newUpdateAlarmModel Source #

Arguments

:: Text	`$sel:alarmModelName:UpdateAlarmModel'`
-> Text	`$sel:roleArn:UpdateAlarmModel'`
-> AlarmRule	`$sel:alarmRule:UpdateAlarmModel'`
-> UpdateAlarmModel

Create a value of UpdateAlarmModel 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:severity:UpdateAlarmModel', updateAlarmModel_severity - A non-negative integer that reflects the severity level of the alarm.

$sel:alarmNotification:UpdateAlarmModel', updateAlarmModel_alarmNotification - Contains information about one or more notification actions.

$sel:alarmModelDescription:UpdateAlarmModel', updateAlarmModel_alarmModelDescription - The description of the alarm model.

$sel:alarmEventActions:UpdateAlarmModel', updateAlarmModel_alarmEventActions - Contains information about one or more alarm actions.

$sel:alarmCapabilities:UpdateAlarmModel', updateAlarmModel_alarmCapabilities - Contains the configuration information of alarm state changes.

$sel:alarmModelName:UpdateAlarmModel', updateAlarmModel_alarmModelName - The name of the alarm model.

$sel:roleArn:UpdateAlarmModel', updateAlarmModel_roleArn - The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.

$sel:alarmRule:UpdateAlarmModel', updateAlarmModel_alarmRule - Defines when your alarm is invoked.

Request Lenses

updateAlarmModel_severity :: Lens' UpdateAlarmModel (Maybe Natural) Source #

A non-negative integer that reflects the severity level of the alarm.

updateAlarmModel_alarmNotification :: Lens' UpdateAlarmModel (Maybe AlarmNotification) Source #

Contains information about one or more notification actions.

updateAlarmModel_alarmModelDescription :: Lens' UpdateAlarmModel (Maybe Text) Source #

The description of the alarm model.

updateAlarmModel_alarmEventActions :: Lens' UpdateAlarmModel (Maybe AlarmEventActions) Source #

Contains information about one or more alarm actions.

updateAlarmModel_alarmCapabilities :: Lens' UpdateAlarmModel (Maybe AlarmCapabilities) Source #

Contains the configuration information of alarm state changes.

updateAlarmModel_alarmModelName :: Lens' UpdateAlarmModel Text Source #

The name of the alarm model.

updateAlarmModel_roleArn :: Lens' UpdateAlarmModel Text Source #

The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.

updateAlarmModel_alarmRule :: Lens' UpdateAlarmModel AlarmRule Source #

Defines when your alarm is invoked.

Destructuring the Response

data UpdateAlarmModelResponse Source #

See: newUpdateAlarmModelResponse smart constructor.

Constructors

UpdateAlarmModelResponse'

Fields

creationTime :: Maybe POSIX
The time the alarm model was created, in the Unix epoch format.
status :: Maybe AlarmModelVersionStatus
The status of the alarm model. The status can be one of the following values:
- ACTIVE - The alarm model is active and it's ready to evaluate data.
- ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes.
- INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model.
- FAILED - You couldn't create or update the alarm model. Check your alarm model information and try again.
lastUpdateTime :: Maybe POSIX
The time the alarm model was last updated, in the Unix epoch format.
alarmModelVersion :: Maybe Text
The version of the alarm model.
alarmModelArn :: Maybe Text
The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq UpdateAlarmModelResponse Source #
Instance details Defined in Amazonka.IoTEvents.UpdateAlarmModel Methods (==) :: UpdateAlarmModelResponse -> UpdateAlarmModelResponse -> Bool # (/=) :: UpdateAlarmModelResponse -> UpdateAlarmModelResponse -> Bool #
Read UpdateAlarmModelResponse Source #
Instance details Defined in Amazonka.IoTEvents.UpdateAlarmModel Methods readsPrec :: Int -> ReadS UpdateAlarmModelResponse # readList :: ReadS [UpdateAlarmModelResponse] # readPrec :: ReadPrec UpdateAlarmModelResponse # readListPrec :: ReadPrec [UpdateAlarmModelResponse] #
Show UpdateAlarmModelResponse Source #
Instance details Defined in Amazonka.IoTEvents.UpdateAlarmModel Methods showsPrec :: Int -> UpdateAlarmModelResponse -> ShowS # show :: UpdateAlarmModelResponse -> String # showList :: [UpdateAlarmModelResponse] -> ShowS #
Generic UpdateAlarmModelResponse Source #
Instance details Defined in Amazonka.IoTEvents.UpdateAlarmModel Associated Types type Rep UpdateAlarmModelResponse :: Type -> Type # Methods from :: UpdateAlarmModelResponse -> Rep UpdateAlarmModelResponse x # to :: Rep UpdateAlarmModelResponse x -> UpdateAlarmModelResponse #
NFData UpdateAlarmModelResponse Source #
Instance details Defined in Amazonka.IoTEvents.UpdateAlarmModel Methods rnf :: UpdateAlarmModelResponse -> () #
type Rep UpdateAlarmModelResponse Source #
Instance details Defined in Amazonka.IoTEvents.UpdateAlarmModel type Rep UpdateAlarmModelResponse = D1 ('MetaData "UpdateAlarmModelResponse" "Amazonka.IoTEvents.UpdateAlarmModel" "libZSservicesZSamazonka-ioteventsZSamazonka-iotevents" 'False) (C1 ('MetaCons "UpdateAlarmModelResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AlarmModelVersionStatus)) :: S1 ('MetaSel ('Just "lastUpdateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: (S1 ('MetaSel ('Just "alarmModelVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "alarmModelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newUpdateAlarmModelResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateAlarmModelResponse'`
-> UpdateAlarmModelResponse

Create a value of UpdateAlarmModelResponse 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:creationTime:UpdateAlarmModelResponse', updateAlarmModelResponse_creationTime - The time the alarm model was created, in the Unix epoch format.

$sel:status:UpdateAlarmModelResponse', updateAlarmModelResponse_status - The status of the alarm model. The status can be one of the following values:

ACTIVE - The alarm model is active and it's ready to evaluate data.
ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes.
INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model.
FAILED - You couldn't create or update the alarm model. Check your alarm model information and try again.

$sel:lastUpdateTime:UpdateAlarmModelResponse', updateAlarmModelResponse_lastUpdateTime - The time the alarm model was last updated, in the Unix epoch format.

$sel:alarmModelVersion:UpdateAlarmModelResponse', updateAlarmModelResponse_alarmModelVersion - The version of the alarm model.

$sel:alarmModelArn:UpdateAlarmModelResponse', updateAlarmModelResponse_alarmModelArn - The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.

$sel:httpStatus:UpdateAlarmModelResponse', updateAlarmModelResponse_httpStatus - The response's http status code.

Response Lenses

updateAlarmModelResponse_creationTime :: Lens' UpdateAlarmModelResponse (Maybe UTCTime) Source #

The time the alarm model was created, in the Unix epoch format.

updateAlarmModelResponse_status :: Lens' UpdateAlarmModelResponse (Maybe AlarmModelVersionStatus) Source #

The status of the alarm model. The status can be one of the following values:

ACTIVE - The alarm model is active and it's ready to evaluate data.
ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes.
INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model.
FAILED - You couldn't create or update the alarm model. Check your alarm model information and try again.

updateAlarmModelResponse_lastUpdateTime :: Lens' UpdateAlarmModelResponse (Maybe UTCTime) Source #

The time the alarm model was last updated, in the Unix epoch format.

updateAlarmModelResponse_alarmModelVersion :: Lens' UpdateAlarmModelResponse (Maybe Text) Source #

The version of the alarm model.

updateAlarmModelResponse_alarmModelArn :: Lens' UpdateAlarmModelResponse (Maybe Text) Source #

The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.

updateAlarmModelResponse_httpStatus :: Lens' UpdateAlarmModelResponse Int Source #

The response's http status code.