Network.AWS.CloudWatch.DescribeAlarms

Retrieves alarms with the specified names. If no name is specified, all alarms for the user are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.

This operation returns paginated results.

Creating a Request

describeAlarms :: DescribeAlarms

Creates a value of DescribeAlarms with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• daAlarmNamePrefix
• daActionPrefix
• daNextToken
• daStateValue
• daAlarmNames
• daMaxRecords

data DescribeAlarms

See: describeAlarms smart constructor.

Instances

Eq DescribeAlarms

Methods

(==) :: DescribeAlarms -> DescribeAlarms -> Bool

(/=) :: DescribeAlarms -> DescribeAlarms -> Bool

Data DescribeAlarms

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeAlarms -> c DescribeAlarms

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeAlarms

toConstr :: DescribeAlarms -> Constr

dataTypeOf :: DescribeAlarms -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeAlarms)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeAlarms)

gmapT :: (forall b. Data b => b -> b) -> DescribeAlarms -> DescribeAlarms

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeAlarms -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeAlarms -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeAlarms -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeAlarms -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeAlarms -> m DescribeAlarms

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeAlarms -> m DescribeAlarms

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeAlarms -> m DescribeAlarms

Read DescribeAlarms

Methods

readsPrec :: Int -> ReadS DescribeAlarms

readList :: ReadS [DescribeAlarms]

readPrec :: ReadPrec DescribeAlarms

readListPrec :: ReadPrec [DescribeAlarms]

Show DescribeAlarms

Methods

showsPrec :: Int -> DescribeAlarms -> ShowS

show :: DescribeAlarms -> String

showList :: [DescribeAlarms] -> ShowS

Generic DescribeAlarms

Associated Types

type Rep DescribeAlarms :: * -> *

Methods

from :: DescribeAlarms -> Rep DescribeAlarms x

to :: Rep DescribeAlarms x -> DescribeAlarms

Hashable DescribeAlarms

Methods

hashWithSalt :: Int -> DescribeAlarms -> Int

hash :: DescribeAlarms -> Int

NFData DescribeAlarms

Methods

rnf :: DescribeAlarms -> ()

AWSPager DescribeAlarms

Methods

page :: DescribeAlarms -> Rs DescribeAlarms -> Maybe DescribeAlarms

AWSRequest DescribeAlarms

Associated Types

type Rs DescribeAlarms :: *

Methods

request :: DescribeAlarms -> Request DescribeAlarms

response :: MonadResource m => Logger -> Service -> Proxy * DescribeAlarms -> ClientResponse -> m (Response DescribeAlarms)

ToPath DescribeAlarms

Methods

toPath :: DescribeAlarms -> ByteString

ToHeaders DescribeAlarms

Methods

toHeaders :: DescribeAlarms -> [Header]

ToQuery DescribeAlarms

Methods

toQuery :: DescribeAlarms -> QueryString

type Rep DescribeAlarms

type Rep DescribeAlarms = D1 (MetaData "DescribeAlarms" "Network.AWS.CloudWatch.DescribeAlarms" "amazonka-cloudwatch-1.4.2-AyChybrvmHvFQ5VhtfqJpc" False) (C1 (MetaCons "DescribeAlarms'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_daAlarmNamePrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_daActionPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_daNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_daStateValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe StateValue))) ((:*:) (S1 (MetaSel (Just Symbol "_daAlarmNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_daMaxRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)))))))

type Rs DescribeAlarms

type Rs DescribeAlarms = DescribeAlarmsResponse

Request Lenses

daAlarmNamePrefix :: Lens' DescribeAlarms (Maybe Text)

The alarm name prefix. AlarmNames cannot be specified if this parameter is specified.

daActionPrefix :: Lens' DescribeAlarms (Maybe Text)

The action name prefix.

daNextToken :: Lens' DescribeAlarms (Maybe Text)

The token returned by a previous call to indicate that there is more data available.

daStateValue :: Lens' DescribeAlarms (Maybe StateValue)

The state value to be used in matching alarms.

daAlarmNames :: Lens' DescribeAlarms [Text]

A list of alarm names to retrieve information for.

daMaxRecords :: Lens' DescribeAlarms (Maybe Natural)

The maximum number of alarm descriptions to retrieve.

Destructuring the Response

describeAlarmsResponse

Arguments

:: Int

darsResponseStatus

-> DescribeAlarmsResponse

Creates a value of DescribeAlarmsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• darsMetricAlarms
• darsNextToken
• darsResponseStatus

data DescribeAlarmsResponse

The output for the DescribeAlarms action.

See: describeAlarmsResponse smart constructor.

Instances

Eq DescribeAlarmsResponse

Methods

(==) :: DescribeAlarmsResponse -> DescribeAlarmsResponse -> Bool

(/=) :: DescribeAlarmsResponse -> DescribeAlarmsResponse -> Bool

Data DescribeAlarmsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeAlarmsResponse -> c DescribeAlarmsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeAlarmsResponse

toConstr :: DescribeAlarmsResponse -> Constr

dataTypeOf :: DescribeAlarmsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeAlarmsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeAlarmsResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeAlarmsResponse -> DescribeAlarmsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeAlarmsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeAlarmsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeAlarmsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeAlarmsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeAlarmsResponse -> m DescribeAlarmsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeAlarmsResponse -> m DescribeAlarmsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeAlarmsResponse -> m DescribeAlarmsResponse

Read DescribeAlarmsResponse

Methods

readsPrec :: Int -> ReadS DescribeAlarmsResponse

readList :: ReadS [DescribeAlarmsResponse]

readPrec :: ReadPrec DescribeAlarmsResponse

readListPrec :: ReadPrec [DescribeAlarmsResponse]

Show DescribeAlarmsResponse

Methods

showsPrec :: Int -> DescribeAlarmsResponse -> ShowS

show :: DescribeAlarmsResponse -> String

showList :: [DescribeAlarmsResponse] -> ShowS

Generic DescribeAlarmsResponse

Associated Types

type Rep DescribeAlarmsResponse :: * -> *

Methods

from :: DescribeAlarmsResponse -> Rep DescribeAlarmsResponse x

to :: Rep DescribeAlarmsResponse x -> DescribeAlarmsResponse

NFData DescribeAlarmsResponse

Methods

rnf :: DescribeAlarmsResponse -> ()

type Rep DescribeAlarmsResponse

type Rep DescribeAlarmsResponse = D1 (MetaData "DescribeAlarmsResponse" "Network.AWS.CloudWatch.DescribeAlarms" "amazonka-cloudwatch-1.4.2-AyChybrvmHvFQ5VhtfqJpc" False) (C1 (MetaCons "DescribeAlarmsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_darsMetricAlarms") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [MetricAlarm]))) ((:*:) (S1 (MetaSel (Just Symbol "_darsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_darsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

darsMetricAlarms :: Lens' DescribeAlarmsResponse [MetricAlarm]

A list of information for the specified alarms.

darsNextToken :: Lens' DescribeAlarmsResponse (Maybe Text)

A string that marks the start of the next batch of returned results.

darsResponseStatus :: Lens' DescribeAlarmsResponse Int

The response status code.