Amazonka.CognitoIdentityProvider.ListUserPoolClients

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

This operation returns paginated results.

Creating a Request

data ListUserPoolClients

Represents the request to list the user pool clients.

See: newListUserPoolClients smart constructor.

Constructors

ListUserPoolClients'

Fields

• maxResults :: Maybe Natural

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

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

• userPoolId :: Text

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

Instances

ToJSON ListUserPoolClients

Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients

Methods

toJSON :: ListUserPoolClients -> Value

toEncoding :: ListUserPoolClients -> Encoding

toJSONList :: [ListUserPoolClients] -> Value

toEncodingList :: [ListUserPoolClients] -> Encoding

ToHeaders ListUserPoolClients

Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients

Methods

toHeaders :: ListUserPoolClients -> [Header]

ToPath ListUserPoolClients

Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients

Methods

toPath :: ListUserPoolClients -> ByteString

ToQuery ListUserPoolClients

Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients

Methods

toQuery :: ListUserPoolClients -> QueryString

AWSPager ListUserPoolClients

Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients

Methods

page :: ListUserPoolClients -> AWSResponse ListUserPoolClients -> Maybe ListUserPoolClients

AWSRequest ListUserPoolClients

Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients

Associated Types

type AWSResponse ListUserPoolClients

Methods

request :: (Service -> Service) -> ListUserPoolClients -> Request ListUserPoolClients

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

Generic ListUserPoolClients

Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients

Associated Types

type Rep ListUserPoolClients :: Type -> Type

Methods

from :: ListUserPoolClients -> Rep ListUserPoolClients x

to :: Rep ListUserPoolClients x -> ListUserPoolClients

Read ListUserPoolClients

Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients

Methods

readsPrec :: Int -> ReadS ListUserPoolClients

readList :: ReadS [ListUserPoolClients]

readPrec :: ReadPrec ListUserPoolClients

readListPrec :: ReadPrec [ListUserPoolClients]

Show ListUserPoolClients

Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients

Methods

showsPrec :: Int -> ListUserPoolClients -> ShowS

show :: ListUserPoolClients -> String

showList :: [ListUserPoolClients] -> ShowS

NFData ListUserPoolClients

Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients

Methods

rnf :: ListUserPoolClients -> ()

Eq ListUserPoolClients

Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients

Methods

(==) :: ListUserPoolClients -> ListUserPoolClients -> Bool

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

Hashable ListUserPoolClients

Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients

Methods

hashWithSalt :: Int -> ListUserPoolClients -> Int

hash :: ListUserPoolClients -> Int

type AWSResponse ListUserPoolClients

Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients

type AWSResponse ListUserPoolClients = ListUserPoolClientsResponse

type Rep ListUserPoolClients

Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients

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

newListUserPoolClients

Arguments

:: Text

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

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.

ListUserPoolClients, listUserPoolClients_userPoolId - The user pool ID for the user pool where you want to list user pool clients.

Request Lenses

listUserPoolClients_maxResults :: Lens' ListUserPoolClients (Maybe Natural)

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

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

listUserPoolClients_userPoolId :: Lens' ListUserPoolClients Text

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

Destructuring the Response

data ListUserPoolClientsResponse

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

Generic ListUserPoolClientsResponse

Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients

Associated Types

type Rep ListUserPoolClientsResponse :: Type -> Type

Methods

from :: ListUserPoolClientsResponse -> Rep ListUserPoolClientsResponse x

to :: Rep ListUserPoolClientsResponse x -> ListUserPoolClientsResponse

Show ListUserPoolClientsResponse

Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients

Methods

showsPrec :: Int -> ListUserPoolClientsResponse -> ShowS

show :: ListUserPoolClientsResponse -> String

showList :: [ListUserPoolClientsResponse] -> ShowS

NFData ListUserPoolClientsResponse

Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients

Methods

rnf :: ListUserPoolClientsResponse -> ()

Eq ListUserPoolClientsResponse

Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients

Methods

(==) :: ListUserPoolClientsResponse -> ListUserPoolClientsResponse -> Bool

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

type Rep ListUserPoolClientsResponse

Defined in Amazonka.CognitoIdentityProvider.ListUserPoolClients

type Rep ListUserPoolClientsResponse = D1 ('MetaData "ListUserPoolClientsResponse" "Amazonka.CognitoIdentityProvider.ListUserPoolClients" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" '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

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:

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)

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])

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

listUserPoolClientsResponse_httpStatus :: Lens' ListUserPoolClientsResponse Int

The response's http status code.