Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CognitoIdentityProvider.ListUserPoolClients

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the clients that have been created for the specified user pool.

This operation returns paginated results.

Synopsis

data ListUserPoolClients = ListUserPoolClients' {
- nextToken :: Maybe Text
- maxResults :: Maybe Natural
- userPoolId :: Text
}
newListUserPoolClients :: Text -> ListUserPoolClients
listUserPoolClients_nextToken :: Lens' ListUserPoolClients (Maybe Text)
listUserPoolClients_maxResults :: Lens' ListUserPoolClients (Maybe Natural)
listUserPoolClients_userPoolId :: Lens' ListUserPoolClients Text
data ListUserPoolClientsResponse = ListUserPoolClientsResponse' {
- nextToken :: Maybe Text
- userPoolClients :: Maybe [UserPoolClientDescription]
- httpStatus :: Int
}
newListUserPoolClientsResponse :: Int -> ListUserPoolClientsResponse
listUserPoolClientsResponse_nextToken :: Lens' ListUserPoolClientsResponse (Maybe Text)
listUserPoolClientsResponse_userPoolClients :: Lens' ListUserPoolClientsResponse (Maybe [UserPoolClientDescription])
listUserPoolClientsResponse_httpStatus :: Lens' ListUserPoolClientsResponse Int

Creating a Request

data ListUserPoolClients Source #

Represents the request to list the user pool clients.

See: newListUserPoolClients smart constructor.

Constructors

ListUserPoolClients'
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 :: Maybe Natural The maximum number of results you want the request to return when listing the user pool clients. userPoolId :: Text The user pool ID for the user pool where you want to list user pool clients.

Instances

Instances details

Eq ListUserPoolClients Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients Methods (==) :: ListUserPoolClients -> ListUserPoolClients -> Bool # (/=) :: ListUserPoolClients -> ListUserPoolClients -> Bool #
Read ListUserPoolClients Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients Methods readsPrec :: Int -> ReadS ListUserPoolClients # readList :: ReadS [ListUserPoolClients] # readPrec :: ReadPrec ListUserPoolClients # readListPrec :: ReadPrec [ListUserPoolClients] #
Show ListUserPoolClients Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients Methods showsPrec :: Int -> ListUserPoolClients -> ShowS # show :: ListUserPoolClients -> String # showList :: [ListUserPoolClients] -> ShowS #
Generic ListUserPoolClients Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients Associated Types type Rep ListUserPoolClients :: Type -> Type # Methods from :: ListUserPoolClients -> Rep ListUserPoolClients x # to :: Rep ListUserPoolClients x -> ListUserPoolClients #
NFData ListUserPoolClients Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients Methods rnf :: ListUserPoolClients -> () #
Hashable ListUserPoolClients Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients Methods hashWithSalt :: Int -> ListUserPoolClients -> Int # hash :: ListUserPoolClients -> Int #
ToJSON ListUserPoolClients Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients Methods toJSON :: ListUserPoolClients -> Value # toEncoding :: ListUserPoolClients -> Encoding # toJSONList :: [ListUserPoolClients] -> Value # toEncodingList :: [ListUserPoolClients] -> Encoding #
AWSPager ListUserPoolClients Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients Methods page :: ListUserPoolClients -> AWSResponse ListUserPoolClients -> Maybe ListUserPoolClients #
AWSRequest ListUserPoolClients Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients Associated Types type AWSResponse ListUserPoolClients # Methods request :: ListUserPoolClients -> Request ListUserPoolClients # response :: MonadResource m => Logger -> Service -> Proxy ListUserPoolClients -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListUserPoolClients))) #
ToHeaders ListUserPoolClients Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients Methods toHeaders :: ListUserPoolClients -> [Header] #
ToPath ListUserPoolClients Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients Methods toPath :: ListUserPoolClients -> ByteString #
ToQuery ListUserPoolClients Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients Methods toQuery :: ListUserPoolClients -> QueryString #
type Rep ListUserPoolClients Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients type Rep ListUserPoolClients = D1 ('MetaData "ListUserPoolClients" "Amazonka.CognitoIdentityProvider.ListUserPoolClients" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" 'False) (C1 ('MetaCons "ListUserPoolClients'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "userPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListUserPoolClients Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients type AWSResponse ListUserPoolClients = ListUserPoolClientsResponse

newListUserPoolClients Source #

Arguments

:: Text	`$sel:userPoolId:ListUserPoolClients'`
-> ListUserPoolClients

Create a value of ListUserPoolClients 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:nextToken:ListUserPoolClients', listUserPoolClients_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:ListUserPoolClients', listUserPoolClients_maxResults - The maximum number of results you want the request to return when listing the user pool clients.

$sel:userPoolId:ListUserPoolClients', listUserPoolClients_userPoolId - The user pool ID for the user pool where you want to list user pool clients.

Request Lenses

listUserPoolClients_nextToken :: Lens' ListUserPoolClients (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.

listUserPoolClients_maxResults :: Lens' ListUserPoolClients (Maybe Natural) Source #

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

listUserPoolClients_userPoolId :: Lens' ListUserPoolClients Text Source #

The user pool ID for the user pool where you want to list user pool clients.

Destructuring the Response

data ListUserPoolClientsResponse Source #

Represents the response from the server that lists user pool clients.

See: newListUserPoolClientsResponse smart constructor.

Constructors

ListUserPoolClientsResponse'
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. userPoolClients :: Maybe [UserPoolClientDescription] The user pool clients in the response that lists user pool clients. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListUserPoolClientsResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients Methods (==) :: ListUserPoolClientsResponse -> ListUserPoolClientsResponse -> Bool # (/=) :: ListUserPoolClientsResponse -> ListUserPoolClientsResponse -> Bool #
Show ListUserPoolClientsResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients Methods showsPrec :: Int -> ListUserPoolClientsResponse -> ShowS # show :: ListUserPoolClientsResponse -> String # showList :: [ListUserPoolClientsResponse] -> ShowS #
Generic ListUserPoolClientsResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients Associated Types type Rep ListUserPoolClientsResponse :: Type -> Type # Methods from :: ListUserPoolClientsResponse -> Rep ListUserPoolClientsResponse x # to :: Rep ListUserPoolClientsResponse x -> ListUserPoolClientsResponse #
NFData ListUserPoolClientsResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients Methods rnf :: ListUserPoolClientsResponse -> () #
type Rep ListUserPoolClientsResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients type Rep ListUserPoolClientsResponse = D1 ('MetaData "ListUserPoolClientsResponse" "Amazonka.CognitoIdentityProvider.ListUserPoolClients" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" 'False) (C1 ('MetaCons "ListUserPoolClientsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "userPoolClients") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UserPoolClientDescription])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListUserPoolClientsResponse Source #

Arguments

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

Create a value of ListUserPoolClientsResponse 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:nextToken:ListUserPoolClients', listUserPoolClientsResponse_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:userPoolClients:ListUserPoolClientsResponse', listUserPoolClientsResponse_userPoolClients - The user pool clients in the response that lists user pool clients.

$sel:httpStatus:ListUserPoolClientsResponse', listUserPoolClientsResponse_httpStatus - The response's http status code.

Response Lenses

listUserPoolClientsResponse_nextToken :: Lens' ListUserPoolClientsResponse (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.

listUserPoolClientsResponse_userPoolClients :: Lens' ListUserPoolClientsResponse (Maybe [UserPoolClientDescription]) Source #

The user pool clients in the response that lists user pool clients.

listUserPoolClientsResponse_httpStatus :: Lens' ListUserPoolClientsResponse Int Source #

The response's http status code.