Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Lightsail.GetAlarms

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about the configured alarms. Specify an alarm name in your request to return information about a specific alarm, or specify a monitored resource name to return information about all alarms for a specific resource.

An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.

Synopsis

Creating a Request

data GetAlarms Source #

See: newGetAlarms smart constructor.

Constructors

GetAlarms'

Fields

alarmName :: Maybe Text
The name of the alarm.
Specify an alarm name to return information about a specific alarm.
monitoredResourceName :: Maybe Text
The name of the Lightsail resource being monitored by the alarm.
Specify a monitored resource name to return information about all alarms for a specific resource.
pageToken :: Maybe Text
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetAlarms request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Instances

Instances details

Eq GetAlarms Source #
Instance details Defined in Amazonka.Lightsail.GetAlarms Methods (==) :: GetAlarms -> GetAlarms -> Bool # (/=) :: GetAlarms -> GetAlarms -> Bool #
Read GetAlarms Source #
Instance details Defined in Amazonka.Lightsail.GetAlarms Methods readsPrec :: Int -> ReadS GetAlarms # readList :: ReadS [GetAlarms] # readPrec :: ReadPrec GetAlarms # readListPrec :: ReadPrec [GetAlarms] #
Show GetAlarms Source #
Instance details Defined in Amazonka.Lightsail.GetAlarms Methods showsPrec :: Int -> GetAlarms -> ShowS # show :: GetAlarms -> String # showList :: [GetAlarms] -> ShowS #
Generic GetAlarms Source #
Instance details Defined in Amazonka.Lightsail.GetAlarms Associated Types type Rep GetAlarms :: Type -> Type # Methods from :: GetAlarms -> Rep GetAlarms x # to :: Rep GetAlarms x -> GetAlarms #
NFData GetAlarms Source #
Instance details Defined in Amazonka.Lightsail.GetAlarms Methods rnf :: GetAlarms -> () #
Hashable GetAlarms Source #
Instance details Defined in Amazonka.Lightsail.GetAlarms Methods hashWithSalt :: Int -> GetAlarms -> Int # hash :: GetAlarms -> Int #
ToJSON GetAlarms Source #
Instance details Defined in Amazonka.Lightsail.GetAlarms Methods toJSON :: GetAlarms -> Value # toEncoding :: GetAlarms -> Encoding # toJSONList :: [GetAlarms] -> Value # toEncodingList :: [GetAlarms] -> Encoding #
AWSRequest GetAlarms Source #
Instance details Defined in Amazonka.Lightsail.GetAlarms Associated Types type AWSResponse GetAlarms # Methods request :: GetAlarms -> Request GetAlarms # response :: MonadResource m => Logger -> Service -> Proxy GetAlarms -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetAlarms))) #
ToHeaders GetAlarms Source #
Instance details Defined in Amazonka.Lightsail.GetAlarms Methods toHeaders :: GetAlarms -> [Header] #
ToPath GetAlarms Source #
Instance details Defined in Amazonka.Lightsail.GetAlarms Methods toPath :: GetAlarms -> ByteString #
ToQuery GetAlarms Source #
Instance details Defined in Amazonka.Lightsail.GetAlarms Methods toQuery :: GetAlarms -> QueryString #
type Rep GetAlarms Source #
Instance details Defined in Amazonka.Lightsail.GetAlarms type Rep GetAlarms = D1 ('MetaData "GetAlarms" "Amazonka.Lightsail.GetAlarms" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "GetAlarms'" 'PrefixI 'True) (S1 ('MetaSel ('Just "alarmName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "monitoredResourceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "pageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))
type AWSResponse GetAlarms Source #
Instance details Defined in Amazonka.Lightsail.GetAlarms type AWSResponse GetAlarms = GetAlarmsResponse

newGetAlarms :: GetAlarms Source #

Create a value of GetAlarms 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:alarmName:GetAlarms', getAlarms_alarmName - The name of the alarm.

Specify an alarm name to return information about a specific alarm.

$sel:monitoredResourceName:GetAlarms', getAlarms_monitoredResourceName - The name of the Lightsail resource being monitored by the alarm.

Specify a monitored resource name to return information about all alarms for a specific resource.

$sel:pageToken:GetAlarms', getAlarms_pageToken - The token to advance to the next page of results from your request.

To get a page token, perform an initial GetAlarms request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Request Lenses

getAlarms_alarmName :: Lens' GetAlarms (Maybe Text) Source #

The name of the alarm.

Specify an alarm name to return information about a specific alarm.

getAlarms_monitoredResourceName :: Lens' GetAlarms (Maybe Text) Source #

The name of the Lightsail resource being monitored by the alarm.

Specify a monitored resource name to return information about all alarms for a specific resource.

getAlarms_pageToken :: Lens' GetAlarms (Maybe Text) Source #

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetAlarms request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Destructuring the Response

data GetAlarmsResponse Source #

See: newGetAlarmsResponse smart constructor.

Constructors

GetAlarmsResponse'

Fields

nextPageToken :: Maybe Text
The token to advance to the next page of results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetAlarms request and specify the next page token using the pageToken parameter.
alarms :: Maybe [Alarm]
An array of objects that describe the alarms.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq GetAlarmsResponse Source #
Instance details Defined in Amazonka.Lightsail.GetAlarms Methods (==) :: GetAlarmsResponse -> GetAlarmsResponse -> Bool # (/=) :: GetAlarmsResponse -> GetAlarmsResponse -> Bool #
Read GetAlarmsResponse Source #
Instance details Defined in Amazonka.Lightsail.GetAlarms Methods readsPrec :: Int -> ReadS GetAlarmsResponse # readList :: ReadS [GetAlarmsResponse] # readPrec :: ReadPrec GetAlarmsResponse # readListPrec :: ReadPrec [GetAlarmsResponse] #
Show GetAlarmsResponse Source #
Instance details Defined in Amazonka.Lightsail.GetAlarms Methods showsPrec :: Int -> GetAlarmsResponse -> ShowS # show :: GetAlarmsResponse -> String # showList :: [GetAlarmsResponse] -> ShowS #
Generic GetAlarmsResponse Source #
Instance details Defined in Amazonka.Lightsail.GetAlarms Associated Types type Rep GetAlarmsResponse :: Type -> Type # Methods from :: GetAlarmsResponse -> Rep GetAlarmsResponse x # to :: Rep GetAlarmsResponse x -> GetAlarmsResponse #
NFData GetAlarmsResponse Source #
Instance details Defined in Amazonka.Lightsail.GetAlarms Methods rnf :: GetAlarmsResponse -> () #
type Rep GetAlarmsResponse Source #
Instance details Defined in Amazonka.Lightsail.GetAlarms type Rep GetAlarmsResponse = D1 ('MetaData "GetAlarmsResponse" "Amazonka.Lightsail.GetAlarms" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "GetAlarmsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextPageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "alarms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Alarm])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetAlarmsResponse Source #

Arguments

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

Create a value of GetAlarmsResponse 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:nextPageToken:GetAlarmsResponse', getAlarmsResponse_nextPageToken - The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetAlarms request and specify the next page token using the pageToken parameter.

$sel:alarms:GetAlarmsResponse', getAlarmsResponse_alarms - An array of objects that describe the alarms.

$sel:httpStatus:GetAlarmsResponse', getAlarmsResponse_httpStatus - The response's http status code.

Response Lenses

getAlarmsResponse_nextPageToken :: Lens' GetAlarmsResponse (Maybe Text) Source #

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetAlarms request and specify the next page token using the pageToken parameter.

getAlarmsResponse_alarms :: Lens' GetAlarmsResponse (Maybe [Alarm]) Source #

An array of objects that describe the alarms.

getAlarmsResponse_httpStatus :: Lens' GetAlarmsResponse Int Source #

The response's http status code.