/ - Amazon Cognito Identity Provider

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

Request

Query Params

MaxResults

string

optional

Pagination limit

NextToken

string

optional

Pagination token

Header Params

X-Amz-Target

string

required

Body Params application/json

Represents the request to list the user pool clients.

UserPoolId

string

required

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

>= 1 characters<= 55 characters

Match pattern:

[\w-]+_[0-9a-zA-Z]+

MaxResults

integer

optional

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

>= 1<= 60

NextToken

string

optional

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.

>= 1 characters

Match pattern:

[\S]+

Examples

Responses

🟢200Success

application/json

Body

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

UserPoolClients

array[object (UserPoolClientDescription) {3}]

optional

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

ClientId

string <password>

optional

The ID of the client associated with the user pool.

>= 1 characters<= 128 characters

Match pattern:

[\w+]+

UserPoolId

string

optional

The user pool ID for the user pool where you want to describe the user pool client.

>= 1 characters<= 55 characters

Match pattern:

[\w-]+_[0-9a-zA-Z]+

ClientName

string

optional

The client name from the user pool client description.

>= 1 characters<= 128 characters

Match pattern:

[\w\s+=,.@-]+

NextToken

string

optional

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.

>= 1 characters

Match pattern:

[\S]+

🟠480InvalidParameterException

🟠481ResourceNotFoundException

🟠482TooManyRequestsException

🟠483NotAuthorizedException

🟠484InternalErrorException