DescribeUserPool
Returns the configuration information and metadata of the specified user pool.
Request Syntax
{
"UserPoolId": "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.
- UserPoolId
-
The user pool ID for the user pool you want to describe.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern:
[\w-]+_[0-9a-zA-Z]+
Required: Yes
Response Syntax
{
"UserPool": {
"AccountRecoverySetting": {
"RecoveryMechanisms": [
{
"Name": "string",
"Priority": number
}
]
},
"AdminCreateUserConfig": {
"AllowAdminCreateUserOnly": boolean,
"InviteMessageTemplate": {
"EmailMessage": "string",
"EmailSubject": "string",
"SMSMessage": "string"
},
"UnusedAccountValidityDays": number
},
"AliasAttributes": [ "string" ],
"Arn": "string",
"AutoVerifiedAttributes": [ "string" ],
"CreationDate": number,
"CustomDomain": "string",
"DeviceConfiguration": {
"ChallengeRequiredOnNewDevice": boolean,
"DeviceOnlyRememberedOnUserPrompt": boolean
},
"Domain": "string",
"EmailConfiguration": {
"ConfigurationSet": "string",
"EmailSendingAccount": "string",
"From": "string",
"ReplyToEmailAddress": "string",
"SourceArn": "string"
},
"EmailConfigurationFailure": "string",
"EmailVerificationMessage": "string",
"EmailVerificationSubject": "string",
"EstimatedNumberOfUsers": 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,
"MfaConfiguration": "string",
"Name": "string",
"Policies": {
"PasswordPolicy": {
"MinimumLength": number,
"RequireLowercase": boolean,
"RequireNumbers": boolean,
"RequireSymbols": boolean,
"RequireUppercase": boolean,
"TemporaryPasswordValidityDays": number
}
},
"SchemaAttributes": [
{
"AttributeDataType": "string",
"DeveloperOnlyAttribute": boolean,
"Mutable": boolean,
"Name": "string",
"NumberAttributeConstraints": {
"MaxValue": "string",
"MinValue": "string"
},
"Required": boolean,
"StringAttributeConstraints": {
"MaxLength": "string",
"MinLength": "string"
}
}
],
"SmsAuthenticationMessage": "string",
"SmsConfiguration": {
"ExternalId": "string",
"SnsCallerArn": "string"
},
"SmsConfigurationFailure": "string",
"SmsVerificationMessage": "string",
"Status": "string",
"UsernameAttributes": [ "string" ],
"UsernameConfiguration": {
"CaseSensitive": boolean
},
"UserPoolAddOns": {
"AdvancedSecurityMode": "string"
},
"UserPoolTags": {
"string" : "string"
},
"VerificationMessageTemplate": {
"DefaultEmailOption": "string",
"EmailMessage": "string",
"EmailMessageByLink": "string",
"EmailSubject": "string",
"EmailSubjectByLink": "string",
"SmsMessage": "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.
- UserPool
-
The container of metadata returned by the server to describe the pool.
Type: UserPoolType object
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 is not authorized.
HTTP Status Code: 400
- ResourceNotFoundException
-
This exception is thrown when the Amazon Cognito service cannot find the requested resource.
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
- UserPoolTaggingException
-
This exception is thrown when a user pool tag cannot be set or updated.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: