/

POST

Returns the configuration information and metadata of the specified user pool.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "UserPoolId": "string"
}'

Response Example

200 - Example 1

{
    "UserPool": {
        "Id": "string",
        "Name": "string",
        "Policies": {
            "PasswordPolicy": {
                "MinimumLength": 0,
                "RequireUppercase": true,
                "RequireLowercase": true,
                "RequireNumbers": true,
                "RequireSymbols": true,
                "TemporaryPasswordValidityDays": 0
            }
        },
        "DeletionProtection": "ACTIVE",
        "LambdaConfig": {
            "PreSignUp": "string",
            "CustomMessage": "string",
            "PostConfirmation": "string",
            "PreAuthentication": "string",
            "PostAuthentication": "string",
            "DefineAuthChallenge": "string",
            "CreateAuthChallenge": "string",
            "VerifyAuthChallengeResponse": "string",
            "PreTokenGeneration": "string",
            "UserMigration": "string",
            "CustomSMSSender": {
                "LambdaVersion": "V1_0",
                "LambdaArn": "string"
            },
            "CustomEmailSender": {
                "LambdaVersion": "V1_0",
                "LambdaArn": "string"
            },
            "KMSKeyID": "string"
        },
        "Status": "Enabled",
        "LastModifiedDate": "string",
        "CreationDate": "string",
        "SchemaAttributes": [],
        "AutoVerifiedAttributes": [],
        "AliasAttributes": [],
        "UsernameAttributes": [],
        "SmsVerificationMessage": "string",
        "EmailVerificationMessage": "string",
        "EmailVerificationSubject": "string",
        "VerificationMessageTemplate": {
            "SmsMessage": "string",
            "EmailMessage": "string",
            "EmailSubject": "string",
            "EmailMessageByLink": "string",
            "EmailSubjectByLink": "string",
            "DefaultEmailOption": "CONFIRM_WITH_LINK"
        },
        "SmsAuthenticationMessage": "string",
        "UserAttributeUpdateSettings": {},
        "MfaConfiguration": "OFF",
        "DeviceConfiguration": {},
        "EstimatedNumberOfUsers": 0,
        "EmailConfiguration": {},
        "SmsConfiguration": {
            "SnsCallerArn": "string",
            "ExternalId": "string",
            "SnsRegion": "string"
        },
        "UserPoolTags": {
            "property1": "string",
            "property2": "string"
        },
        "SmsConfigurationFailure": "string",
        "EmailConfigurationFailure": "string",
        "Domain": "string",
        "CustomDomain": "string",
        "AdminCreateUserConfig": {
            "AllowAdminCreateUserOnly": true,
            "UnusedAccountValidityDays": 0,
            "InviteMessageTemplate": {
                "SMSMessage": "string",
                "EmailMessage": "string",
                "EmailSubject": "string"
            }
        },
        "UserPoolAddOns": {
            "AdvancedSecurityMode": "OFF"
        },
        "UsernameConfiguration": {
            "CaseSensitive": true
        },
        "Arn": "string",
        "AccountRecoverySetting": {
            "RecoveryMechanisms": []
        }
    }
}

Request

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠480ResourceNotFoundException

🟠481InvalidParameterException

🟠482TooManyRequestsException

🟠483NotAuthorizedException

🟠484UserPoolTaggingException

🟠485InternalErrorException

Modified at 2023-08-15 07:11:07