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 |
Retrieves information about an alarm model. If you don't specify a
value for the alarmModelVersion
parameter, the latest version is
returned.
Synopsis
- data DescribeAlarmModel = DescribeAlarmModel' {}
- newDescribeAlarmModel :: Text -> DescribeAlarmModel
- describeAlarmModel_alarmModelVersion :: Lens' DescribeAlarmModel (Maybe Text)
- describeAlarmModel_alarmModelName :: Lens' DescribeAlarmModel Text
- data DescribeAlarmModelResponse = DescribeAlarmModelResponse' {
- alarmCapabilities :: Maybe AlarmCapabilities
- alarmEventActions :: Maybe AlarmEventActions
- alarmModelArn :: Maybe Text
- alarmModelDescription :: Maybe Text
- alarmModelName :: Maybe Text
- alarmModelVersion :: Maybe Text
- alarmNotification :: Maybe AlarmNotification
- alarmRule :: Maybe AlarmRule
- creationTime :: Maybe POSIX
- key :: Maybe Text
- lastUpdateTime :: Maybe POSIX
- roleArn :: Maybe Text
- severity :: Maybe Natural
- status :: Maybe AlarmModelVersionStatus
- statusMessage :: Maybe Text
- httpStatus :: Int
- newDescribeAlarmModelResponse :: Int -> DescribeAlarmModelResponse
- describeAlarmModelResponse_alarmCapabilities :: Lens' DescribeAlarmModelResponse (Maybe AlarmCapabilities)
- describeAlarmModelResponse_alarmEventActions :: Lens' DescribeAlarmModelResponse (Maybe AlarmEventActions)
- describeAlarmModelResponse_alarmModelArn :: Lens' DescribeAlarmModelResponse (Maybe Text)
- describeAlarmModelResponse_alarmModelDescription :: Lens' DescribeAlarmModelResponse (Maybe Text)
- describeAlarmModelResponse_alarmModelName :: Lens' DescribeAlarmModelResponse (Maybe Text)
- describeAlarmModelResponse_alarmModelVersion :: Lens' DescribeAlarmModelResponse (Maybe Text)
- describeAlarmModelResponse_alarmNotification :: Lens' DescribeAlarmModelResponse (Maybe AlarmNotification)
- describeAlarmModelResponse_alarmRule :: Lens' DescribeAlarmModelResponse (Maybe AlarmRule)
- describeAlarmModelResponse_creationTime :: Lens' DescribeAlarmModelResponse (Maybe UTCTime)
- describeAlarmModelResponse_key :: Lens' DescribeAlarmModelResponse (Maybe Text)
- describeAlarmModelResponse_lastUpdateTime :: Lens' DescribeAlarmModelResponse (Maybe UTCTime)
- describeAlarmModelResponse_roleArn :: Lens' DescribeAlarmModelResponse (Maybe Text)
- describeAlarmModelResponse_severity :: Lens' DescribeAlarmModelResponse (Maybe Natural)
- describeAlarmModelResponse_status :: Lens' DescribeAlarmModelResponse (Maybe AlarmModelVersionStatus)
- describeAlarmModelResponse_statusMessage :: Lens' DescribeAlarmModelResponse (Maybe Text)
- describeAlarmModelResponse_httpStatus :: Lens' DescribeAlarmModelResponse Int
Creating a Request
data DescribeAlarmModel Source #
See: newDescribeAlarmModel
smart constructor.
DescribeAlarmModel' | |
|
Instances
newDescribeAlarmModel Source #
Create a value of DescribeAlarmModel
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:
DescribeAlarmModel
, describeAlarmModel_alarmModelVersion
- The version of the alarm model.
DescribeAlarmModel
, describeAlarmModel_alarmModelName
- The name of the alarm model.
Request Lenses
describeAlarmModel_alarmModelVersion :: Lens' DescribeAlarmModel (Maybe Text) Source #
The version of the alarm model.
describeAlarmModel_alarmModelName :: Lens' DescribeAlarmModel Text Source #
The name of the alarm model.
Destructuring the Response
data DescribeAlarmModelResponse Source #
See: newDescribeAlarmModelResponse
smart constructor.
DescribeAlarmModelResponse' | |
|
Instances
newDescribeAlarmModelResponse Source #
Create a value of DescribeAlarmModelResponse
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:alarmCapabilities:DescribeAlarmModelResponse'
, describeAlarmModelResponse_alarmCapabilities
- Contains the configuration information of alarm state changes.
$sel:alarmEventActions:DescribeAlarmModelResponse'
, describeAlarmModelResponse_alarmEventActions
- Contains information about one or more alarm actions.
DescribeAlarmModelResponse
, describeAlarmModelResponse_alarmModelArn
- The ARN of the alarm model. For more information, see
Amazon Resource Names (ARNs)
in the AWS General Reference.
DescribeAlarmModelResponse
, describeAlarmModelResponse_alarmModelDescription
- The description of the alarm model.
DescribeAlarmModel
, describeAlarmModelResponse_alarmModelName
- The name of the alarm model.
DescribeAlarmModel
, describeAlarmModelResponse_alarmModelVersion
- The version of the alarm model.
$sel:alarmNotification:DescribeAlarmModelResponse'
, describeAlarmModelResponse_alarmNotification
- Contains information about one or more notification actions.
$sel:alarmRule:DescribeAlarmModelResponse'
, describeAlarmModelResponse_alarmRule
- Defines when your alarm is invoked.
DescribeAlarmModelResponse
, describeAlarmModelResponse_creationTime
- The time the alarm model was created, in the Unix epoch format.
DescribeAlarmModelResponse
, describeAlarmModelResponse_key
- An input attribute used as a key to create an alarm. AWS IoT Events
routes
inputs
associated with this key to the alarm.
DescribeAlarmModelResponse
, describeAlarmModelResponse_lastUpdateTime
- The time the alarm model was last updated, in the Unix epoch format.
DescribeAlarmModelResponse
, describeAlarmModelResponse_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:severity:DescribeAlarmModelResponse'
, describeAlarmModelResponse_severity
- A non-negative integer that reflects the severity level of the alarm.
DescribeAlarmModelResponse
, describeAlarmModelResponse_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.
DescribeAlarmModelResponse
, describeAlarmModelResponse_statusMessage
- Contains information about the status of the alarm model.
$sel:httpStatus:DescribeAlarmModelResponse'
, describeAlarmModelResponse_httpStatus
- The response's http status code.
Response Lenses
describeAlarmModelResponse_alarmCapabilities :: Lens' DescribeAlarmModelResponse (Maybe AlarmCapabilities) Source #
Contains the configuration information of alarm state changes.
describeAlarmModelResponse_alarmEventActions :: Lens' DescribeAlarmModelResponse (Maybe AlarmEventActions) Source #
Contains information about one or more alarm actions.
describeAlarmModelResponse_alarmModelArn :: Lens' DescribeAlarmModelResponse (Maybe Text) Source #
The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
describeAlarmModelResponse_alarmModelDescription :: Lens' DescribeAlarmModelResponse (Maybe Text) Source #
The description of the alarm model.
describeAlarmModelResponse_alarmModelName :: Lens' DescribeAlarmModelResponse (Maybe Text) Source #
The name of the alarm model.
describeAlarmModelResponse_alarmModelVersion :: Lens' DescribeAlarmModelResponse (Maybe Text) Source #
The version of the alarm model.
describeAlarmModelResponse_alarmNotification :: Lens' DescribeAlarmModelResponse (Maybe AlarmNotification) Source #
Contains information about one or more notification actions.
describeAlarmModelResponse_alarmRule :: Lens' DescribeAlarmModelResponse (Maybe AlarmRule) Source #
Defines when your alarm is invoked.
describeAlarmModelResponse_creationTime :: Lens' DescribeAlarmModelResponse (Maybe UTCTime) Source #
The time the alarm model was created, in the Unix epoch format.
describeAlarmModelResponse_key :: Lens' DescribeAlarmModelResponse (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.
describeAlarmModelResponse_lastUpdateTime :: Lens' DescribeAlarmModelResponse (Maybe UTCTime) Source #
The time the alarm model was last updated, in the Unix epoch format.
describeAlarmModelResponse_roleArn :: Lens' DescribeAlarmModelResponse (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.
describeAlarmModelResponse_severity :: Lens' DescribeAlarmModelResponse (Maybe Natural) Source #
A non-negative integer that reflects the severity level of the alarm.
describeAlarmModelResponse_status :: Lens' DescribeAlarmModelResponse (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.
describeAlarmModelResponse_statusMessage :: Lens' DescribeAlarmModelResponse (Maybe Text) Source #
Contains information about the status of the alarm model.
describeAlarmModelResponse_httpStatus :: Lens' DescribeAlarmModelResponse Int Source #
The response's http status code.