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.MQ.ListBrokers

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of all brokers.

This operation returns paginated results.

Creating a Request

data ListBrokers Source #

See: newListBrokers smart constructor.

Constructors

ListBrokers'
Fields maxResults :: Maybe Natural 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. nextToken :: Maybe Text The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

Instances

Instances details

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

newListBrokers :: ListBrokers Source #

Create a value of ListBrokers 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:ListBrokers', listBrokers_maxResults - 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.

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

Request Lenses

listBrokers_maxResults :: 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.

listBrokers_nextToken :: 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.

Destructuring the Response

data ListBrokersResponse Source #

See: newListBrokersResponse smart constructor.

Constructors

ListBrokersResponse'
Fields brokerSummaries :: Maybe [BrokerSummary] A list of information about all brokers. nextToken :: Maybe Text The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListBrokersResponse Source #
Instance details Defined in Amazonka.MQ.ListBrokers Associated Types type Rep ListBrokersResponse :: Type -> Type # Methods from :: ListBrokersResponse -> Rep ListBrokersResponse x # to :: Rep ListBrokersResponse x -> ListBrokersResponse #
Read ListBrokersResponse Source #
Instance details Defined in Amazonka.MQ.ListBrokers Methods readsPrec :: Int -> ReadS ListBrokersResponse # readList :: ReadS [ListBrokersResponse] # readPrec :: ReadPrec ListBrokersResponse # readListPrec :: ReadPrec [ListBrokersResponse] #
Show ListBrokersResponse Source #
Instance details Defined in Amazonka.MQ.ListBrokers Methods showsPrec :: Int -> ListBrokersResponse -> ShowS # show :: ListBrokersResponse -> String # showList :: [ListBrokersResponse] -> ShowS #
NFData ListBrokersResponse Source #
Instance details Defined in Amazonka.MQ.ListBrokers Methods rnf :: ListBrokersResponse -> () #
Eq ListBrokersResponse Source #
Instance details Defined in Amazonka.MQ.ListBrokers Methods (==) :: ListBrokersResponse -> ListBrokersResponse -> Bool # (/=) :: ListBrokersResponse -> ListBrokersResponse -> Bool #
type Rep ListBrokersResponse Source #
Instance details Defined in Amazonka.MQ.ListBrokers type Rep ListBrokersResponse = D1 ('MetaData "ListBrokersResponse" "Amazonka.MQ.ListBrokers" "amazonka-mq-2.0-3ebKNoK022m255Abw9OF0s" 'False) (C1 ('MetaCons "ListBrokersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "brokerSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BrokerSummary])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListBrokersResponse Source #

Arguments

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

Create a value of ListBrokersResponse 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:brokerSummaries:ListBrokersResponse', listBrokersResponse_brokerSummaries - A list of information about all brokers.

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

$sel:httpStatus:ListBrokersResponse', listBrokersResponse_httpStatus - The response's http status code.

Response Lenses

listBrokersResponse_brokerSummaries :: Lens' ListBrokersResponse (Maybe [BrokerSummary]) Source #

A list of information about all brokers.

listBrokersResponse_nextToken :: 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.

listBrokersResponse_httpStatus :: Lens' ListBrokersResponse Int Source #

The response's http status code.