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.IoTEventsData.DescribeAlarm

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves information about an alarm.

Creating a Request

data DescribeAlarm Source #

See: newDescribeAlarm smart constructor.

Constructors

DescribeAlarm'
Fields keyValue :: Maybe Text The value of the key used as a filter to select only the alarms associated with the key. alarmModelName :: Text The name of the alarm model.

Instances

Instances details

ToHeaders DescribeAlarm Source #
Instance details Defined in Amazonka.IoTEventsData.DescribeAlarm Methods toHeaders :: DescribeAlarm -> [Header] #
ToPath DescribeAlarm Source #
Instance details Defined in Amazonka.IoTEventsData.DescribeAlarm Methods toPath :: DescribeAlarm -> ByteString #
ToQuery DescribeAlarm Source #
Instance details Defined in Amazonka.IoTEventsData.DescribeAlarm Methods toQuery :: DescribeAlarm -> QueryString #
AWSRequest DescribeAlarm Source #
Instance details Defined in Amazonka.IoTEventsData.DescribeAlarm Associated Types type AWSResponse DescribeAlarm # Methods request :: (Service -> Service) -> DescribeAlarm -> Request DescribeAlarm # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeAlarm -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeAlarm))) #
Generic DescribeAlarm Source #
Instance details Defined in Amazonka.IoTEventsData.DescribeAlarm Associated Types type Rep DescribeAlarm :: Type -> Type # Methods from :: DescribeAlarm -> Rep DescribeAlarm x # to :: Rep DescribeAlarm x -> DescribeAlarm #
Read DescribeAlarm Source #
Instance details Defined in Amazonka.IoTEventsData.DescribeAlarm Methods readsPrec :: Int -> ReadS DescribeAlarm # readList :: ReadS [DescribeAlarm] # readPrec :: ReadPrec DescribeAlarm # readListPrec :: ReadPrec [DescribeAlarm] #
Show DescribeAlarm Source #
Instance details Defined in Amazonka.IoTEventsData.DescribeAlarm Methods showsPrec :: Int -> DescribeAlarm -> ShowS # show :: DescribeAlarm -> String # showList :: [DescribeAlarm] -> ShowS #
NFData DescribeAlarm Source #
Instance details Defined in Amazonka.IoTEventsData.DescribeAlarm Methods rnf :: DescribeAlarm -> () #
Eq DescribeAlarm Source #
Instance details Defined in Amazonka.IoTEventsData.DescribeAlarm Methods (==) :: DescribeAlarm -> DescribeAlarm -> Bool # (/=) :: DescribeAlarm -> DescribeAlarm -> Bool #
Hashable DescribeAlarm Source #
Instance details Defined in Amazonka.IoTEventsData.DescribeAlarm Methods hashWithSalt :: Int -> DescribeAlarm -> Int # hash :: DescribeAlarm -> Int #
type AWSResponse DescribeAlarm Source #
Instance details Defined in Amazonka.IoTEventsData.DescribeAlarm type AWSResponse DescribeAlarm = DescribeAlarmResponse
type Rep DescribeAlarm Source #
Instance details Defined in Amazonka.IoTEventsData.DescribeAlarm type Rep DescribeAlarm = D1 ('MetaData "DescribeAlarm" "Amazonka.IoTEventsData.DescribeAlarm" "amazonka-iotevents-data-2.0-2nkzod7vvQTAS38g00IbEB" 'False) (C1 ('MetaCons "DescribeAlarm'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "alarmModelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeAlarm Source #

Arguments

:: Text	`DescribeAlarm`
-> DescribeAlarm

Create a value of DescribeAlarm 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:

DescribeAlarm, describeAlarm_keyValue - The value of the key used as a filter to select only the alarms associated with the key.

DescribeAlarm, describeAlarm_alarmModelName - The name of the alarm model.

Request Lenses

describeAlarm_keyValue :: Lens' DescribeAlarm (Maybe Text) Source #

The value of the key used as a filter to select only the alarms associated with the key.

describeAlarm_alarmModelName :: Lens' DescribeAlarm Text Source #

The name of the alarm model.

Destructuring the Response

data DescribeAlarmResponse Source #

See: newDescribeAlarmResponse smart constructor.

Constructors

DescribeAlarmResponse'
Fields alarm :: Maybe Alarm Contains information about an alarm. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeAlarmResponse Source #
Instance details Defined in Amazonka.IoTEventsData.DescribeAlarm Associated Types type Rep DescribeAlarmResponse :: Type -> Type # Methods from :: DescribeAlarmResponse -> Rep DescribeAlarmResponse x # to :: Rep DescribeAlarmResponse x -> DescribeAlarmResponse #
Read DescribeAlarmResponse Source #
Instance details Defined in Amazonka.IoTEventsData.DescribeAlarm Methods readsPrec :: Int -> ReadS DescribeAlarmResponse # readList :: ReadS [DescribeAlarmResponse] # readPrec :: ReadPrec DescribeAlarmResponse # readListPrec :: ReadPrec [DescribeAlarmResponse] #
Show DescribeAlarmResponse Source #
Instance details Defined in Amazonka.IoTEventsData.DescribeAlarm Methods showsPrec :: Int -> DescribeAlarmResponse -> ShowS # show :: DescribeAlarmResponse -> String # showList :: [DescribeAlarmResponse] -> ShowS #
NFData DescribeAlarmResponse Source #
Instance details Defined in Amazonka.IoTEventsData.DescribeAlarm Methods rnf :: DescribeAlarmResponse -> () #
Eq DescribeAlarmResponse Source #
Instance details Defined in Amazonka.IoTEventsData.DescribeAlarm Methods (==) :: DescribeAlarmResponse -> DescribeAlarmResponse -> Bool # (/=) :: DescribeAlarmResponse -> DescribeAlarmResponse -> Bool #
type Rep DescribeAlarmResponse Source #
Instance details Defined in Amazonka.IoTEventsData.DescribeAlarm type Rep DescribeAlarmResponse = D1 ('MetaData "DescribeAlarmResponse" "Amazonka.IoTEventsData.DescribeAlarm" "amazonka-iotevents-data-2.0-2nkzod7vvQTAS38g00IbEB" 'False) (C1 ('MetaCons "DescribeAlarmResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "alarm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Alarm)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeAlarmResponse Source #

Arguments

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

Create a value of DescribeAlarmResponse 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:alarm:DescribeAlarmResponse', describeAlarmResponse_alarm - Contains information about an alarm.

$sel:httpStatus:DescribeAlarmResponse', describeAlarmResponse_httpStatus - The response's http status code.

Response Lenses

describeAlarmResponse_alarm :: Lens' DescribeAlarmResponse (Maybe Alarm) Source #

Contains information about an alarm.

describeAlarmResponse_httpStatus :: Lens' DescribeAlarmResponse Int Source #

The response's http status code.