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.ListAlarms

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists one or more alarms. The operation returns only the metadata associated with each alarm.

Synopsis

Creating a Request

data ListAlarms Source #

See: newListAlarms smart constructor.

Constructors

ListAlarms'
Fields maxResults :: Maybe Natural The maximum number of results to be returned per request. nextToken :: Maybe Text The token that you can use to return the next set of results. alarmModelName :: Text The name of the alarm model.

Instances

Instances details

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

newListAlarms Source #

Arguments

:: Text	`ListAlarms`
-> ListAlarms

Create a value of ListAlarms 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:maxResults:ListAlarms', listAlarms_maxResults - The maximum number of results to be returned per request.

ListAlarms, listAlarms_nextToken - The token that you can use to return the next set of results.

ListAlarms, listAlarms_alarmModelName - The name of the alarm model.

Request Lenses

listAlarms_maxResults :: Lens' ListAlarms (Maybe Natural) Source #

The maximum number of results to be returned per request.

listAlarms_nextToken :: Lens' ListAlarms (Maybe Text) Source #

The token that you can use to return the next set of results.

listAlarms_alarmModelName :: Lens' ListAlarms Text Source #

The name of the alarm model.

Destructuring the Response

data ListAlarmsResponse Source #

See: newListAlarmsResponse smart constructor.

Constructors

ListAlarmsResponse'
Fields alarmSummaries :: Maybe [AlarmSummary] A list that summarizes each alarm. nextToken :: Maybe Text The token that you can use to return the next set of results, or `null` if there are no more results. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListAlarmsResponse Source #

Arguments

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

Create a value of ListAlarmsResponse 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:alarmSummaries:ListAlarmsResponse', listAlarmsResponse_alarmSummaries - A list that summarizes each alarm.

ListAlarms, listAlarmsResponse_nextToken - The token that you can use to return the next set of results, or null if there are no more results.

$sel:httpStatus:ListAlarmsResponse', listAlarmsResponse_httpStatus - The response's http status code.

Response Lenses

listAlarmsResponse_alarmSummaries :: Lens' ListAlarmsResponse (Maybe [AlarmSummary]) Source #

A list that summarizes each alarm.

listAlarmsResponse_nextToken :: Lens' ListAlarmsResponse (Maybe Text) Source #

The token that you can use to return the next set of results, or null if there are no more results.

listAlarmsResponse_httpStatus :: Lens' ListAlarmsResponse Int Source #

The response's http status code.