amazonka-cognito-idp-2.0: Amazon Cognito Identity Provider SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CognitoIdentityProvider.ListUserPools

Description

Lists the user pools associated with an Amazon Web Services account.

This operation returns paginated results.

Synopsis

Creating a Request

data ListUserPools Source #

Represents the request to list user pools.

See: newListUserPools smart constructor.

Constructors

ListUserPools' 

Fields

  • nextToken :: 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.

  • maxResults :: Natural

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

Instances

Instances details
ToJSON ListUserPools Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListUserPools

Methods

toJSON :: ListUserPools -> Value #

toEncoding :: ListUserPools -> Encoding #

toJSONList :: [ListUserPools] -> Value #

toEncodingList :: [ListUserPools] -> Encoding #

ToHeaders ListUserPools Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListUserPools

Methods

toHeaders :: ListUserPools -> [Header] #

ToPath ListUserPools Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListUserPools

Methods

toPath :: ListUserPools -> ByteString #

ToQuery ListUserPools Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListUserPools

Methods

toQuery :: ListUserPools -> QueryString #

AWSPager ListUserPools Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListUserPools

Methods

page :: ListUserPools -> AWSResponse ListUserPools -> Maybe ListUserPools #

AWSRequest ListUserPools Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListUserPools

Associated Types

type AWSResponse ListUserPools #

Methods

request :: (Service -> Service) -> ListUserPools -> Request ListUserPools #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListUserPools -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListUserPools))) #

Generic ListUserPools Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListUserPools

Associated Types

type Rep ListUserPools :: Type -> Type #

Methods

from :: ListUserPools -> Rep ListUserPools x #

to :: Rep ListUserPools x -> ListUserPools #

Read ListUserPools Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListUserPools

Methods

readsPrec :: Int -> ReadS ListUserPools #

readList :: ReadS [ListUserPools] #

readPrec :: ReadPrec ListUserPools #

readListPrec :: ReadPrec [ListUserPools] #

Show ListUserPools Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListUserPools

Methods

showsPrec :: Int -> ListUserPools -> ShowS #

show :: ListUserPools -> String #

showList :: [ListUserPools] -> ShowS #

NFData ListUserPools Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListUserPools

Methods

rnf :: ListUserPools -> () #

Eq ListUserPools Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListUserPools

Methods

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

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

Hashable ListUserPools Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListUserPools

Methods

hashWithSalt :: Int -> ListUserPools -> Int #

hash :: ListUserPools -> Int #

type AWSResponse ListUserPools Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListUserPools

type AWSResponse ListUserPools = ListUserPoolsResponse
type Rep ListUserPools Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListUserPools

type Rep ListUserPools = D1 ('MetaData "ListUserPools" "Amazonka.CognitoIdentityProvider.ListUserPools" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "ListUserPools'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))

newListUserPools Source #

Arguments

:: Natural

$sel:maxResults:ListUserPools'

-> ListUserPools 

Create a value of ListUserPools 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:

ListUserPools, listUserPools_nextToken - 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.

$sel:maxResults:ListUserPools', listUserPools_maxResults - The maximum number of results you want the request to return when listing the user pools.

Request Lenses

listUserPools_nextToken :: Lens' ListUserPools (Maybe Text) Source #

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.

listUserPools_maxResults :: Lens' ListUserPools Natural Source #

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

Destructuring the Response

data ListUserPoolsResponse Source #

Represents the response to list user pools.

See: newListUserPoolsResponse smart constructor.

Constructors

ListUserPoolsResponse' 

Fields

Instances

Instances details
Generic ListUserPoolsResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListUserPools

Associated Types

type Rep ListUserPoolsResponse :: Type -> Type #

Methods

from :: ListUserPoolsResponse -> Rep ListUserPoolsResponse x #

to :: Rep ListUserPoolsResponse x -> ListUserPoolsResponse #

Read ListUserPoolsResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListUserPools

Methods

readsPrec :: Int -> ReadS ListUserPoolsResponse #

readList :: ReadS [ListUserPoolsResponse] #

readPrec :: ReadPrec ListUserPoolsResponse #

readListPrec :: ReadPrec [ListUserPoolsResponse] #

Show ListUserPoolsResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListUserPools

Methods

showsPrec :: Int -> ListUserPoolsResponse -> ShowS #

show :: ListUserPoolsResponse -> String #

showList :: [ListUserPoolsResponse] -> ShowS #

NFData ListUserPoolsResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListUserPools

Methods

rnf :: ListUserPoolsResponse -> () #

Eq ListUserPoolsResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListUserPools

Methods

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

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

type Rep ListUserPoolsResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.ListUserPools

type Rep ListUserPoolsResponse = D1 ('MetaData "ListUserPoolsResponse" "Amazonka.CognitoIdentityProvider.ListUserPools" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "ListUserPoolsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "userPools") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UserPoolDescriptionType])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListUserPoolsResponse Source #

Arguments

:: Int

$sel:httpStatus:ListUserPoolsResponse'

-> ListUserPoolsResponse 

Create a value of ListUserPoolsResponse 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:

ListUserPools, listUserPoolsResponse_nextToken - 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.

$sel:userPools:ListUserPoolsResponse', listUserPoolsResponse_userPools - The user pools from the response to list users.

$sel:httpStatus:ListUserPoolsResponse', listUserPoolsResponse_httpStatus - The response's http status code.

Response Lenses

listUserPoolsResponse_nextToken :: Lens' ListUserPoolsResponse (Maybe Text) Source #

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.

listUserPoolsResponse_userPools :: Lens' ListUserPoolsResponse (Maybe [UserPoolDescriptionType]) Source #

The user pools from the response to list users.

listUserPoolsResponse_httpStatus :: Lens' ListUserPoolsResponse Int Source #

The response's http status code.