Network.AWS.CognitoIdentityProvider.ListUserPools

Lists the user pools associated with an AWS account.

Creating a Request

listUserPools

Arguments

:: Natural

lupMaxResults

-> ListUserPools

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

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

• lupNextToken
• lupMaxResults

data ListUserPools

Represents the request to list user pools.

See: listUserPools smart constructor.

Instances

Eq ListUserPools

Methods

(==) :: ListUserPools -> ListUserPools -> Bool

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

Data ListUserPools

Methods

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

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

toConstr :: ListUserPools -> Constr

dataTypeOf :: ListUserPools -> DataType

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

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

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

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

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

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

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

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

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

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

Read ListUserPools

Methods

readsPrec :: Int -> ReadS ListUserPools

readList :: ReadS [ListUserPools]

readPrec :: ReadPrec ListUserPools

readListPrec :: ReadPrec [ListUserPools]

Show ListUserPools

Methods

showsPrec :: Int -> ListUserPools -> ShowS

show :: ListUserPools -> String

showList :: [ListUserPools] -> ShowS

Generic ListUserPools

Associated Types

type Rep ListUserPools :: * -> *

Methods

from :: ListUserPools -> Rep ListUserPools x

to :: Rep ListUserPools x -> ListUserPools

ToJSON ListUserPools

Methods

toJSON :: ListUserPools -> Value

toEncoding :: ListUserPools -> Encoding

Hashable ListUserPools

Methods

hashWithSalt :: Int -> ListUserPools -> Int

hash :: ListUserPools -> Int

NFData ListUserPools

Methods

rnf :: ListUserPools -> ()

AWSRequest ListUserPools

Associated Types

type Rs ListUserPools :: *

Methods

request :: ListUserPools -> Request ListUserPools

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

ToPath ListUserPools

Methods

toPath :: ListUserPools -> ByteString

ToHeaders ListUserPools

Methods

toHeaders :: ListUserPools -> [Header]

ToQuery ListUserPools

Methods

toQuery :: ListUserPools -> QueryString

type Rep ListUserPools

type Rep ListUserPools = D1 (MetaData "ListUserPools" "Network.AWS.CognitoIdentityProvider.ListUserPools" "amazonka-cognito-idp-1.4.3-C4aYmxMInTgGoQbrVLGYa0" False) (C1 (MetaCons "ListUserPools'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lupNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lupMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Nat))))

type Rs ListUserPools

type Rs ListUserPools = ListUserPoolsResponse

Request Lenses

lupNextToken :: Lens' ListUserPools (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.

lupMaxResults :: Lens' ListUserPools Natural

The maximum number of results you want the request to return when listing the user pools.

Destructuring the Response

listUserPoolsResponse

Arguments

:: Int

luprsResponseStatus

-> ListUserPoolsResponse

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

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

• luprsUserPools
• luprsNextToken
• luprsResponseStatus

data ListUserPoolsResponse

Represents the response to list user pools.

See: listUserPoolsResponse smart constructor.

Instances

Eq ListUserPoolsResponse

Methods

(==) :: ListUserPoolsResponse -> ListUserPoolsResponse -> Bool

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

Data ListUserPoolsResponse

Methods

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

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

toConstr :: ListUserPoolsResponse -> Constr

dataTypeOf :: ListUserPoolsResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read ListUserPoolsResponse

Methods

readsPrec :: Int -> ReadS ListUserPoolsResponse

readList :: ReadS [ListUserPoolsResponse]

readPrec :: ReadPrec ListUserPoolsResponse

readListPrec :: ReadPrec [ListUserPoolsResponse]

Show ListUserPoolsResponse

Methods

showsPrec :: Int -> ListUserPoolsResponse -> ShowS

show :: ListUserPoolsResponse -> String

showList :: [ListUserPoolsResponse] -> ShowS

Generic ListUserPoolsResponse

Associated Types

type Rep ListUserPoolsResponse :: * -> *

Methods

from :: ListUserPoolsResponse -> Rep ListUserPoolsResponse x

to :: Rep ListUserPoolsResponse x -> ListUserPoolsResponse

NFData ListUserPoolsResponse

Methods

rnf :: ListUserPoolsResponse -> ()

type Rep ListUserPoolsResponse

type Rep ListUserPoolsResponse = D1 (MetaData "ListUserPoolsResponse" "Network.AWS.CognitoIdentityProvider.ListUserPools" "amazonka-cognito-idp-1.4.3-C4aYmxMInTgGoQbrVLGYa0" False) (C1 (MetaCons "ListUserPoolsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_luprsUserPools") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [UserPoolDescriptionType]))) ((:*:) (S1 (MetaSel (Just Symbol "_luprsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_luprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

luprsUserPools :: Lens' ListUserPoolsResponse [UserPoolDescriptionType]

The user pools from the response to list users.

luprsNextToken :: Lens' ListUserPoolsResponse (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.

luprsResponseStatus :: Lens' ListUserPoolsResponse Int

The response status code.