amazonka-mq-1.6.1: Amazon MQ SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.MQ.ListBrokers

Contents

Description

Returns a list of all brokers.

Synopsis

Creating a Request

listBrokers :: ListBrokers Source #

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

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

  • lbNextToken - The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
  • lbMaxResults - The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.

data ListBrokers Source #

See: listBrokers smart constructor.

Instances
Eq ListBrokers Source # 
Instance details

Defined in Network.AWS.MQ.ListBrokers

Data ListBrokers Source # 
Instance details

Defined in Network.AWS.MQ.ListBrokers

Methods

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

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

toConstr :: ListBrokers -> Constr #

dataTypeOf :: ListBrokers -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListBrokers) #

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

gmapT :: (forall b. Data b => b -> b) -> ListBrokers -> ListBrokers #

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

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

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

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

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

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

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

Read ListBrokers Source # 
Instance details

Defined in Network.AWS.MQ.ListBrokers

Show ListBrokers Source # 
Instance details

Defined in Network.AWS.MQ.ListBrokers

Generic ListBrokers Source # 
Instance details

Defined in Network.AWS.MQ.ListBrokers

Associated Types

type Rep ListBrokers :: Type -> Type #

Hashable ListBrokers Source # 
Instance details

Defined in Network.AWS.MQ.ListBrokers

AWSRequest ListBrokers Source # 
Instance details

Defined in Network.AWS.MQ.ListBrokers

Associated Types

type Rs ListBrokers :: Type #

ToHeaders ListBrokers Source # 
Instance details

Defined in Network.AWS.MQ.ListBrokers

Methods

toHeaders :: ListBrokers -> [Header] #

ToPath ListBrokers Source # 
Instance details

Defined in Network.AWS.MQ.ListBrokers

ToQuery ListBrokers Source # 
Instance details

Defined in Network.AWS.MQ.ListBrokers

NFData ListBrokers Source # 
Instance details

Defined in Network.AWS.MQ.ListBrokers

Methods

rnf :: ListBrokers -> () #

type Rep ListBrokers Source # 
Instance details

Defined in Network.AWS.MQ.ListBrokers

type Rep ListBrokers = D1 (MetaData "ListBrokers" "Network.AWS.MQ.ListBrokers" "amazonka-mq-1.6.1-LPqbYptSHP5G5BofyZ5WCa" False) (C1 (MetaCons "ListBrokers'" PrefixI True) (S1 (MetaSel (Just "_lbNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lbMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))))
type Rs ListBrokers Source # 
Instance details

Defined in Network.AWS.MQ.ListBrokers

Request Lenses

lbNextToken :: Lens' ListBrokers (Maybe Text) Source #

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

lbMaxResults :: Lens' ListBrokers (Maybe Natural) Source #

The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.

Destructuring the Response

listBrokersResponse Source #

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

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

  • lbrsNextToken - The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
  • lbrsBrokerSummaries - A list of information about all brokers.
  • lbrsResponseStatus - -- | The response status code.

data ListBrokersResponse Source #

See: listBrokersResponse smart constructor.

Instances
Eq ListBrokersResponse Source # 
Instance details

Defined in Network.AWS.MQ.ListBrokers

Data ListBrokersResponse Source # 
Instance details

Defined in Network.AWS.MQ.ListBrokers

Methods

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

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

toConstr :: ListBrokersResponse -> Constr #

dataTypeOf :: ListBrokersResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListBrokersResponse) #

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

gmapT :: (forall b. Data b => b -> b) -> ListBrokersResponse -> ListBrokersResponse #

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

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

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

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

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

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

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

Read ListBrokersResponse Source # 
Instance details

Defined in Network.AWS.MQ.ListBrokers

Show ListBrokersResponse Source # 
Instance details

Defined in Network.AWS.MQ.ListBrokers

Generic ListBrokersResponse Source # 
Instance details

Defined in Network.AWS.MQ.ListBrokers

Associated Types

type Rep ListBrokersResponse :: Type -> Type #

NFData ListBrokersResponse Source # 
Instance details

Defined in Network.AWS.MQ.ListBrokers

Methods

rnf :: ListBrokersResponse -> () #

type Rep ListBrokersResponse Source # 
Instance details

Defined in Network.AWS.MQ.ListBrokers

type Rep ListBrokersResponse = D1 (MetaData "ListBrokersResponse" "Network.AWS.MQ.ListBrokers" "amazonka-mq-1.6.1-LPqbYptSHP5G5BofyZ5WCa" False) (C1 (MetaCons "ListBrokersResponse'" PrefixI True) (S1 (MetaSel (Just "_lbrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_lbrsBrokerSummaries") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [BrokerSummary])) :*: S1 (MetaSel (Just "_lbrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

lbrsNextToken :: Lens' ListBrokersResponse (Maybe Text) Source #

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

lbrsBrokerSummaries :: Lens' ListBrokersResponse [BrokerSummary] Source #

A list of information about all brokers.

lbrsResponseStatus :: Lens' ListBrokersResponse Int Source #

  • - | The response status code.