ListUserPools
Lists the user pools associated with an AWS account.
Note
Amazon Cognito evaluates AWS Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Request Syntax
{
"MaxResults": number
,
"NextToken": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- MaxResults
-
The maximum number of results you want the request to return when listing the user pools.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 60.
Required: Yes
- 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.
Type: String
Length Constraints: Minimum length of 1.
Pattern:
[\S]+
Required: No
Response Syntax
{
"NextToken": "string",
"UserPools": [
{
"CreationDate": number,
"Id": "string",
"LambdaConfig": {
"CreateAuthChallenge": "string",
"CustomEmailSender": {
"LambdaArn": "string",
"LambdaVersion": "string"
},
"CustomMessage": "string",
"CustomSMSSender": {
"LambdaArn": "string",
"LambdaVersion": "string"
},
"DefineAuthChallenge": "string",
"KMSKeyID": "string",
"PostAuthentication": "string",
"PostConfirmation": "string",
"PreAuthentication": "string",
"PreSignUp": "string",
"PreTokenGeneration": "string",
"UserMigration": "string",
"VerifyAuthChallengeResponse": "string"
},
"LastModifiedDate": number,
"Name": "string",
"Status": "string"
}
]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- 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.
Type: String
Length Constraints: Minimum length of 1.
Pattern:
[\S]+
- UserPools
-
The user pools from the response to list users.
Type: Array of UserPoolDescriptionType objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalErrorException
-
This exception is thrown when Amazon Cognito encounters an internal error.
HTTP Status Code: 500
- InvalidParameterException
-
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
HTTP Status Code: 400
- NotAuthorizedException
-
This exception is thrown when a user isn't authorized.
HTTP Status Code: 400
- TooManyRequestsException
-
This exception is thrown when the user has made too many requests for a given operation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: