amazonka-iotevents-2.0: Amazon IoT Events SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IoTEvents.Types.AlarmModelVersionSummary

Description

 
Synopsis

Documentation

data AlarmModelVersionSummary Source #

Contains a summary of an alarm model version.

See: newAlarmModelVersionSummary smart constructor.

Constructors

AlarmModelVersionSummary' 

Fields

  • alarmModelArn :: Maybe Text

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

  • alarmModelName :: Maybe Text

    The name of the alarm model.

  • alarmModelVersion :: Maybe Text

    The version of the alarm model.

  • creationTime :: Maybe POSIX

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

  • lastUpdateTime :: Maybe POSIX

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

  • roleArn :: Maybe 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.

  • 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.
  • statusMessage :: Maybe Text

    Contains information about the status of the alarm model version.

Instances

Instances details
FromJSON AlarmModelVersionSummary Source # 
Instance details

Defined in Amazonka.IoTEvents.Types.AlarmModelVersionSummary

Generic AlarmModelVersionSummary Source # 
Instance details

Defined in Amazonka.IoTEvents.Types.AlarmModelVersionSummary

Associated Types

type Rep AlarmModelVersionSummary :: Type -> Type #

Read AlarmModelVersionSummary Source # 
Instance details

Defined in Amazonka.IoTEvents.Types.AlarmModelVersionSummary

Show AlarmModelVersionSummary Source # 
Instance details

Defined in Amazonka.IoTEvents.Types.AlarmModelVersionSummary

NFData AlarmModelVersionSummary Source # 
Instance details

Defined in Amazonka.IoTEvents.Types.AlarmModelVersionSummary

Eq AlarmModelVersionSummary Source # 
Instance details

Defined in Amazonka.IoTEvents.Types.AlarmModelVersionSummary

Hashable AlarmModelVersionSummary Source # 
Instance details

Defined in Amazonka.IoTEvents.Types.AlarmModelVersionSummary

type Rep AlarmModelVersionSummary Source # 
Instance details

Defined in Amazonka.IoTEvents.Types.AlarmModelVersionSummary

type Rep AlarmModelVersionSummary = D1 ('MetaData "AlarmModelVersionSummary" "Amazonka.IoTEvents.Types.AlarmModelVersionSummary" "amazonka-iotevents-2.0-6xKaLx5KciSK3LEs0FyRYn" 'False) (C1 ('MetaCons "AlarmModelVersionSummary'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "alarmModelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "alarmModelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "alarmModelVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "lastUpdateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AlarmModelVersionStatus)) :*: S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newAlarmModelVersionSummary :: AlarmModelVersionSummary Source #

Create a value of AlarmModelVersionSummary 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:alarmModelArn:AlarmModelVersionSummary', alarmModelVersionSummary_alarmModelArn - The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.

$sel:alarmModelName:AlarmModelVersionSummary', alarmModelVersionSummary_alarmModelName - The name of the alarm model.

$sel:alarmModelVersion:AlarmModelVersionSummary', alarmModelVersionSummary_alarmModelVersion - The version of the alarm model.

$sel:creationTime:AlarmModelVersionSummary', alarmModelVersionSummary_creationTime - The time the alarm model was created, in the Unix epoch format.

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

$sel:roleArn:AlarmModelVersionSummary', alarmModelVersionSummary_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:status:AlarmModelVersionSummary', alarmModelVersionSummary_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:statusMessage:AlarmModelVersionSummary', alarmModelVersionSummary_statusMessage - Contains information about the status of the alarm model version.

alarmModelVersionSummary_alarmModelArn :: Lens' AlarmModelVersionSummary (Maybe Text) Source #

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

alarmModelVersionSummary_creationTime :: Lens' AlarmModelVersionSummary (Maybe UTCTime) Source #

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

alarmModelVersionSummary_lastUpdateTime :: Lens' AlarmModelVersionSummary (Maybe UTCTime) Source #

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

alarmModelVersionSummary_roleArn :: Lens' AlarmModelVersionSummary (Maybe 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.

alarmModelVersionSummary_status :: Lens' AlarmModelVersionSummary (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.

alarmModelVersionSummary_statusMessage :: Lens' AlarmModelVersionSummary (Maybe Text) Source #

Contains information about the status of the alarm model version.