amazonka-cognito-idp-1.4.5: Amazon Cognito Identity Provider SDK.

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

Network.AWS.CognitoIdentityProvider.ListUsers

Contents

Description

Lists the users in the Amazon Cognito user pool.

Synopsis

Creating a Request

listUsers #

Arguments

:: Text

luUserPoolId

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

  • luPaginationToken - An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
  • luAttributesToGet - The attributes to get from the request to list users.
  • luLimit - The limit of the request to list users.
  • luFilter - The filter for the list users request.
  • luUserPoolId - The user pool ID for which you want to list users.

data ListUsers #

Represents the request to list users.

See: listUsers smart constructor.

Instances

Eq ListUsers # 
Data 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 # 
Show ListUsers # 
Generic ListUsers # 

Associated Types

type Rep ListUsers :: * -> * #

Hashable ListUsers # 
ToJSON ListUsers # 
NFData ListUsers # 

Methods

rnf :: ListUsers -> () #

AWSRequest ListUsers # 
ToQuery ListUsers # 
ToPath ListUsers # 
ToHeaders ListUsers # 

Methods

toHeaders :: ListUsers -> [Header] #

type Rep ListUsers # 
type Rep ListUsers = D1 (MetaData "ListUsers" "Network.AWS.CognitoIdentityProvider.ListUsers" "amazonka-cognito-idp-1.4.5-FSH4ePU3ZIwKGfg2fnU2v3" False) (C1 (MetaCons "ListUsers'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_luPaginationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_luAttributesToGet") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))) ((:*:) (S1 (MetaSel (Just Symbol "_luLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) ((:*:) (S1 (MetaSel (Just Symbol "_luFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_luUserPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))
type Rs ListUsers # 

Request Lenses

luPaginationToken :: Lens' ListUsers (Maybe Text) #

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

luAttributesToGet :: Lens' ListUsers [Text] #

The attributes to get from the request to list users.

luLimit :: Lens' ListUsers (Maybe Natural) #

The limit of the request to list users.

luFilter :: Lens' ListUsers (Maybe Text) #

The filter for the list users request.

luUserPoolId :: Lens' ListUsers Text #

The user pool ID for which you want to list users.

Destructuring the Response

listUsersResponse #

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:

  • lursPaginationToken - An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
  • lursUsers - The users returned in the request to list users.
  • lursResponseStatus - -- | The response status code.

data ListUsersResponse #

The response from the request to list users.

See: listUsersResponse smart constructor.

Instances

Eq ListUsersResponse # 
Data ListUsersResponse # 

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 # 
Show ListUsersResponse # 
Generic ListUsersResponse # 
NFData ListUsersResponse # 

Methods

rnf :: ListUsersResponse -> () #

type Rep ListUsersResponse # 
type Rep ListUsersResponse = D1 (MetaData "ListUsersResponse" "Network.AWS.CognitoIdentityProvider.ListUsers" "amazonka-cognito-idp-1.4.5-FSH4ePU3ZIwKGfg2fnU2v3" False) (C1 (MetaCons "ListUsersResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lursPaginationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lursUsers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [UserType]))) (S1 (MetaSel (Just Symbol "_lursResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

lursPaginationToken :: Lens' ListUsersResponse (Maybe Text) #

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

lursUsers :: Lens' ListUsersResponse [UserType] #

The users returned in the request to list users.

lursResponseStatus :: Lens' ListUsersResponse Int #

  • - | The response status code.