Amazon Cognito Identity Provider
  1. Root
Amazon Cognito Identity Provider
  • Root
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
  1. Root

/

POST
/
Lists the user pools associated with an Amazon Web Services account.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "NextToken": "string",
    "MaxResults": 0
}'
Response Response Example
200 - Example 1
{
    "UserPools": [],
    "NextToken": "string"
}

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 user pools.
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]+
MaxResults
integer 
required
The maximum number of results you want the request to return when listing the user pools.
>= 1<= 60
Examples

Responses

🟢200Success
application/json
Body
Represents the response to list user pools.
UserPools
array[object (UserPoolDescriptionType) {6}] 
optional
The user pools from the response to list users.
Id
string 
optional
The ID in a user pool description.
>= 1 characters<= 55 characters
Match pattern:
[\w-]+_[0-9a-zA-Z]+
Name
string 
optional
The name in a user pool description.
>= 1 characters<= 128 characters
Match pattern:
[\w\s+=,.@-]+
LambdaConfig
object 
optional
The Lambda configuration information in a user pool description.
Status
enum<string> 
optional
The user pool status in a user pool description.
Allowed values:
EnabledDisabled
LastModifiedDate
string <date-time>
optional
The date the user pool description was last modified.
CreationDate
string <date-time>
optional
The date the user pool description was created.
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
🟠481TooManyRequestsException
🟠482NotAuthorizedException
🟠483InternalErrorException
Modified at 2023-08-15 07:11:07
Previous
/
Next
/
Built with