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

Contents

Description

Returns a list of all ActiveMQ users.

Synopsis

Creating a Request

listUsers Source #

Arguments

:: Text

luBrokerId

-> ListUsers 

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

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

  • luNextToken - The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
  • luMaxResults - The maximum number of ActiveMQ users that can be returned per page (20 by default). This value must be an integer from 5 to 100.
  • luBrokerId - The unique ID that Amazon MQ generates for the broker.

data ListUsers Source #

See: listUsers smart constructor.

Instances
Eq ListUsers Source # 
Instance details

Defined in Network.AWS.MQ.ListUsers

Data ListUsers Source # 
Instance details

Defined in Network.AWS.MQ.ListUsers

Methods

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

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

toConstr :: ListUsers -> Constr #

dataTypeOf :: ListUsers -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ListUsers Source # 
Instance details

Defined in Network.AWS.MQ.ListUsers

Show ListUsers Source # 
Instance details

Defined in Network.AWS.MQ.ListUsers

Generic ListUsers Source # 
Instance details

Defined in Network.AWS.MQ.ListUsers

Associated Types

type Rep ListUsers :: Type -> Type #

Hashable ListUsers Source # 
Instance details

Defined in Network.AWS.MQ.ListUsers

AWSRequest ListUsers Source # 
Instance details

Defined in Network.AWS.MQ.ListUsers

Associated Types

type Rs ListUsers :: Type #

ToHeaders ListUsers Source # 
Instance details

Defined in Network.AWS.MQ.ListUsers

Methods

toHeaders :: ListUsers -> [Header] #

ToPath ListUsers Source # 
Instance details

Defined in Network.AWS.MQ.ListUsers

ToQuery ListUsers Source # 
Instance details

Defined in Network.AWS.MQ.ListUsers

NFData ListUsers Source # 
Instance details

Defined in Network.AWS.MQ.ListUsers

Methods

rnf :: ListUsers -> () #

type Rep ListUsers Source # 
Instance details

Defined in Network.AWS.MQ.ListUsers

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

Defined in Network.AWS.MQ.ListUsers

Request Lenses

luNextToken :: Lens' ListUsers (Maybe Text) Source #

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

luMaxResults :: Lens' ListUsers (Maybe Natural) Source #

The maximum number of ActiveMQ users that can be returned per page (20 by default). This value must be an integer from 5 to 100.

luBrokerId :: Lens' ListUsers Text Source #

The unique ID that Amazon MQ generates for the broker.

Destructuring the Response

listUsersResponse Source #

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

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

  • lursUsers - Required. The list of all ActiveMQ usernames for the specified broker.
  • lursNextToken - The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
  • lursBrokerId - Required. The unique ID that Amazon MQ generates for the broker.
  • lursMaxResults - Required. The maximum number of ActiveMQ users that can be returned per page (20 by default). This value must be an integer from 5 to 100.
  • lursResponseStatus - -- | The response status code.

data ListUsersResponse Source #

See: listUsersResponse smart constructor.

Instances
Eq ListUsersResponse Source # 
Instance details

Defined in Network.AWS.MQ.ListUsers

Data ListUsersResponse Source # 
Instance details

Defined in Network.AWS.MQ.ListUsers

Methods

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

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

toConstr :: ListUsersResponse -> Constr #

dataTypeOf :: ListUsersResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ListUsersResponse Source # 
Instance details

Defined in Network.AWS.MQ.ListUsers

Show ListUsersResponse Source # 
Instance details

Defined in Network.AWS.MQ.ListUsers

Generic ListUsersResponse Source # 
Instance details

Defined in Network.AWS.MQ.ListUsers

Associated Types

type Rep ListUsersResponse :: Type -> Type #

NFData ListUsersResponse Source # 
Instance details

Defined in Network.AWS.MQ.ListUsers

Methods

rnf :: ListUsersResponse -> () #

type Rep ListUsersResponse Source # 
Instance details

Defined in Network.AWS.MQ.ListUsers

type Rep ListUsersResponse = D1 (MetaData "ListUsersResponse" "Network.AWS.MQ.ListUsers" "amazonka-mq-1.6.1-LPqbYptSHP5G5BofyZ5WCa" False) (C1 (MetaCons "ListUsersResponse'" PrefixI True) ((S1 (MetaSel (Just "_lursUsers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [UserSummary])) :*: S1 (MetaSel (Just "_lursNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_lursBrokerId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_lursMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)) :*: S1 (MetaSel (Just "_lursResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

lursUsers :: Lens' ListUsersResponse [UserSummary] Source #

Required. The list of all ActiveMQ usernames for the specified broker.

lursNextToken :: Lens' ListUsersResponse (Maybe Text) Source #

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

lursBrokerId :: Lens' ListUsersResponse (Maybe Text) Source #

Required. The unique ID that Amazon MQ generates for the broker.

lursMaxResults :: Lens' ListUsersResponse (Maybe Int) Source #

Required. The maximum number of ActiveMQ users that can be returned per page (20 by default). This value must be an integer from 5 to 100.

lursResponseStatus :: Lens' ListUsersResponse Int Source #

  • - | The response status code.