libZSservicesZSamazonka-ioteventsZSamazonka-iotevents
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoTEvents.CreateAlarmModel

Description

Creates an alarm model to monitor an AWS IoT Events input attribute. You can use the alarm to get notified when the value is outside a specified range. For more information, see Create an alarm model in the AWS IoT Events Developer Guide.

Synopsis

Creating a Request

data CreateAlarmModel Source #

See: newCreateAlarmModel smart constructor.

Constructors

CreateAlarmModel' 

Fields

Instances

Instances details
Eq CreateAlarmModel Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateAlarmModel

Methods

(==) :: CreateAlarmModel -> CreateAlarmModel -> Bool #

(/=) :: CreateAlarmModel -> CreateAlarmModel -> Bool #

Read CreateAlarmModel Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateAlarmModel

Methods

readsPrec :: Int -> ReadS CreateAlarmModel #

readList :: ReadS [CreateAlarmModel] #

readPrec :: ReadPrec CreateAlarmModel #

readListPrec :: ReadPrec [CreateAlarmModel] #

Show CreateAlarmModel Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateAlarmModel

Methods

showsPrec :: Int -> CreateAlarmModel -> ShowS #

show :: CreateAlarmModel -> String #

showList :: [CreateAlarmModel] -> ShowS #

Generic CreateAlarmModel Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateAlarmModel

Associated Types

type Rep CreateAlarmModel :: Type -> Type #

Methods

from :: CreateAlarmModel -> Rep CreateAlarmModel x #

to :: Rep CreateAlarmModel x -> CreateAlarmModel #

NFData CreateAlarmModel Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateAlarmModel

Methods

rnf :: CreateAlarmModel -> () #

Hashable CreateAlarmModel Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateAlarmModel

Methods

hashWithSalt :: Int -> CreateAlarmModel -> Int #

hash :: CreateAlarmModel -> Int #

ToJSON CreateAlarmModel Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateAlarmModel

Methods

toJSON :: CreateAlarmModel -> Value #

toEncoding :: CreateAlarmModel -> Encoding #

toJSONList :: [CreateAlarmModel] -> Value #

toEncodingList :: [CreateAlarmModel] -> Encoding #

AWSRequest CreateAlarmModel Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateAlarmModel

Associated Types

type AWSResponse CreateAlarmModel #

Methods

request :: CreateAlarmModel -> Request CreateAlarmModel #

response :: MonadResource m => Logger -> Service -> Proxy CreateAlarmModel -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateAlarmModel))) #

ToHeaders CreateAlarmModel Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateAlarmModel

Methods

toHeaders :: CreateAlarmModel -> [Header] #

ToPath CreateAlarmModel Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateAlarmModel

Methods

toPath :: CreateAlarmModel -> ByteString #

ToQuery CreateAlarmModel Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateAlarmModel

Methods

toQuery :: CreateAlarmModel -> QueryString #

type Rep CreateAlarmModel Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateAlarmModel

type Rep CreateAlarmModel = D1 ('MetaData "CreateAlarmModel" "Amazonka.IoTEvents.CreateAlarmModel" "libZSservicesZSamazonka-ioteventsZSamazonka-iotevents" 'False) (C1 ('MetaCons "CreateAlarmModel'" '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 "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (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 "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :*: (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 CreateAlarmModel Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateAlarmModel

type AWSResponse CreateAlarmModel = CreateAlarmModelResponse

newCreateAlarmModel Source #

Arguments

:: Text

$sel:alarmModelName:CreateAlarmModel'

-> Text

$sel:roleArn:CreateAlarmModel'

-> AlarmRule

$sel:alarmRule:CreateAlarmModel'

-> CreateAlarmModel 

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

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

$sel:key:CreateAlarmModel', createAlarmModel_key - An input attribute used as a key to create an alarm. AWS IoT Events routes inputs associated with this key to the alarm.

$sel:alarmModelDescription:CreateAlarmModel', createAlarmModel_alarmModelDescription - A description that tells you what the alarm model detects.

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

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

$sel:tags:CreateAlarmModel', createAlarmModel_tags - A list of key-value pairs that contain metadata for the alarm model. The tags help you manage the alarm model. For more information, see Tagging your AWS IoT Events resources in the AWS IoT Events Developer Guide.

You can create up to 50 tags for one alarm model.

$sel:alarmModelName:CreateAlarmModel', createAlarmModel_alarmModelName - A unique name that helps you identify the alarm model. You can't change this name after you create the alarm model.

$sel:roleArn:CreateAlarmModel', createAlarmModel_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:CreateAlarmModel', createAlarmModel_alarmRule - Defines when your alarm is invoked.

Request Lenses

createAlarmModel_severity :: Lens' CreateAlarmModel (Maybe Natural) Source #

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

createAlarmModel_alarmNotification :: Lens' CreateAlarmModel (Maybe AlarmNotification) Source #

Contains information about one or more notification actions.

createAlarmModel_key :: Lens' CreateAlarmModel (Maybe Text) Source #

An input attribute used as a key to create an alarm. AWS IoT Events routes inputs associated with this key to the alarm.

createAlarmModel_alarmModelDescription :: Lens' CreateAlarmModel (Maybe Text) Source #

A description that tells you what the alarm model detects.

createAlarmModel_alarmEventActions :: Lens' CreateAlarmModel (Maybe AlarmEventActions) Source #

Contains information about one or more alarm actions.

createAlarmModel_alarmCapabilities :: Lens' CreateAlarmModel (Maybe AlarmCapabilities) Source #

Contains the configuration information of alarm state changes.

createAlarmModel_tags :: Lens' CreateAlarmModel (Maybe [Tag]) Source #

A list of key-value pairs that contain metadata for the alarm model. The tags help you manage the alarm model. For more information, see Tagging your AWS IoT Events resources in the AWS IoT Events Developer Guide.

You can create up to 50 tags for one alarm model.

createAlarmModel_alarmModelName :: Lens' CreateAlarmModel Text Source #

A unique name that helps you identify the alarm model. You can't change this name after you create the alarm model.

createAlarmModel_roleArn :: Lens' CreateAlarmModel 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.

createAlarmModel_alarmRule :: Lens' CreateAlarmModel AlarmRule Source #

Defines when your alarm is invoked.

Destructuring the Response

data CreateAlarmModelResponse Source #

See: newCreateAlarmModelResponse smart constructor.

Constructors

CreateAlarmModelResponse' 

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 CreateAlarmModelResponse Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateAlarmModel

Methods

(==) :: CreateAlarmModelResponse -> CreateAlarmModelResponse -> Bool #

(/=) :: CreateAlarmModelResponse -> CreateAlarmModelResponse -> Bool #

Read CreateAlarmModelResponse Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateAlarmModel

Methods

readsPrec :: Int -> ReadS CreateAlarmModelResponse #

readList :: ReadS [CreateAlarmModelResponse] #

readPrec :: ReadPrec CreateAlarmModelResponse #

readListPrec :: ReadPrec [CreateAlarmModelResponse] #

Show CreateAlarmModelResponse Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateAlarmModel

Methods

showsPrec :: Int -> CreateAlarmModelResponse -> ShowS #

show :: CreateAlarmModelResponse -> String #

showList :: [CreateAlarmModelResponse] -> ShowS #

Generic CreateAlarmModelResponse Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateAlarmModel

Associated Types

type Rep CreateAlarmModelResponse :: Type -> Type #

Methods

from :: CreateAlarmModelResponse -> Rep CreateAlarmModelResponse x #

to :: Rep CreateAlarmModelResponse x -> CreateAlarmModelResponse #

NFData CreateAlarmModelResponse Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateAlarmModel

Methods

rnf :: CreateAlarmModelResponse -> () #

type Rep CreateAlarmModelResponse Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateAlarmModel

type Rep CreateAlarmModelResponse = D1 ('MetaData "CreateAlarmModelResponse" "Amazonka.IoTEvents.CreateAlarmModel" "libZSservicesZSamazonka-ioteventsZSamazonka-iotevents" 'False) (C1 ('MetaCons "CreateAlarmModelResponse'" '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)))))

newCreateAlarmModelResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateAlarmModelResponse'

-> CreateAlarmModelResponse 

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

$sel:status:CreateAlarmModelResponse', createAlarmModelResponse_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:CreateAlarmModelResponse', createAlarmModelResponse_lastUpdateTime - The time the alarm model was last updated, in the Unix epoch format.

$sel:alarmModelVersion:CreateAlarmModelResponse', createAlarmModelResponse_alarmModelVersion - The version of the alarm model.

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

$sel:httpStatus:CreateAlarmModelResponse', createAlarmModelResponse_httpStatus - The response's http status code.

Response Lenses

createAlarmModelResponse_creationTime :: Lens' CreateAlarmModelResponse (Maybe UTCTime) Source #

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

createAlarmModelResponse_status :: Lens' CreateAlarmModelResponse (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.

createAlarmModelResponse_lastUpdateTime :: Lens' CreateAlarmModelResponse (Maybe UTCTime) Source #

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

createAlarmModelResponse_alarmModelVersion :: Lens' CreateAlarmModelResponse (Maybe Text) Source #

The version of the alarm model.

createAlarmModelResponse_alarmModelArn :: Lens' CreateAlarmModelResponse (Maybe Text) Source #

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

createAlarmModelResponse_httpStatus :: Lens' CreateAlarmModelResponse Int Source #

The response's http status code.