/

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

X-Amz-Target

string

required

Body Params application/json

Represents the request to describe the user pool.

UserPoolId

string

required

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

>= 1 characters<= 55 characters

Match pattern:

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

Examples

Responses

🟢200Success

application/json

Body

Represents the response to describe the user pool.

UserPool

object

optional

The container of metadata returned by the server to describe the pool.

string

optional

The ID of the user pool.

>= 1 characters<= 55 characters

Match pattern:

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

Name

string

optional

The name of the user pool.

>= 1 characters<= 128 characters

Match pattern:

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

Policies

object

optional

The policies associated with the user pool.

DeletionProtection

enum<string>

optional

When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.

Allowed values:

ACTIVEINACTIVE

LambdaConfig

object

optional

The Lambda triggers associated with the user pool.

Status

enum<string>

optional

The status of a user pool.

Allowed values:

EnabledDisabled

LastModifiedDate

string <date-time>

optional

The date the user pool was last modified.

CreationDate

string <date-time>

optional

The date the user pool was created.

SchemaAttributes

array[object (SchemaAttributeType) {7}]

optional

A container with the schema attributes of a user pool.

>= 1 items<= 50 items

AutoVerifiedAttributes

array[string]

optional

The attributes that are auto-verified in a user pool.

Allowed values:

phone_numberemail

AliasAttributes

array[string]

optional

The attributes that are aliased in a user pool.

Allowed values:

phone_numberemailpreferred_username

UsernameAttributes

array[string]

optional

Specifies whether a user can use an email address or phone number as a username when they sign up.

Allowed values:

phone_numberemail

SmsVerificationMessage

string

optional

This parameter is no longer used. See VerificationMessageTemplateType.

>= 6 characters<= 140 characters

Match pattern:

.*\{####\}.*

EmailVerificationMessage

string

optional

This parameter is no longer used. See VerificationMessageTemplateType.

>= 6 characters<= 20000 characters

Match pattern:

[\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*\{####\}[\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*

EmailVerificationSubject

string

optional

This parameter is no longer used. See VerificationMessageTemplateType.

>= 1 characters<= 140 characters

Match pattern:

[\p{L}\p{M}\p{S}\p{N}\p{P}\s]+

VerificationMessageTemplate

object

optional

The template for verification messages.

SmsAuthenticationMessage

string

optional

The contents of the SMS authentication message.

>= 6 characters<= 140 characters

Match pattern:

.*\{####\}.*

UserAttributeUpdateSettings

object

optional

The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.

MfaConfiguration

enum<string>

optional

Can be one of the following values:

OFF - MFA tokens aren't required and can't be specified during user registration.
ON - MFA tokens are required for all user registrations. You can only specify required when you're initially creating a user pool.
OPTIONAL - Users have the option when registering to create an MFA token.

Allowed values:

OFFONOPTIONAL

DeviceConfiguration

object

optional

The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

EstimatedNumberOfUsers

integer

optional

A number estimating the size of the user pool.

EmailConfiguration

object

optional

The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages tfrom your user pool.

SmsConfiguration

object

optional

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

UserPoolTags

object

optional

The tags that are assigned to the user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

SmsConfigurationFailure

string

optional

The reason why the SMS configuration can't send the messages to your users.

This message might include comma-separated values to describe why your SMS configuration can't send messages to user pool end users.

InvalidSmsRoleAccessPolicyException: The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly configured. For more information, see SmsConfigurationType.
SNSSandbox: The Amazon Web Services account is in the SNS SMS Sandbox and messages will only reach verified end users. This parameter won’t get populated with SNSSandbox if the IAM user creating the user pool doesn’t have SNS permissions. To learn how to move your Amazon Web Services account out of the sandbox, see Moving out of the SMS sandbox.

EmailConfigurationFailure

string

optional

Deprecated. Review error codes from API requests with EventSource:cognito-idp.amazonaws.com in CloudTrail for information about problems with user pool email configuration.

Domain

string

optional

The domain prefix, if the user pool has a domain associated with it.

>= 1 characters<= 63 characters

Match pattern:

^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$

CustomDomain

string

optional

A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. An example of a custom domain name might be auth.example.com.

For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.

>= 1 characters<= 63 characters

Match pattern:

^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$

AdminCreateUserConfig

object

optional

The configuration for AdminCreateUser requests.

UserPoolAddOns

object

optional

The user pool add-ons.

UsernameConfiguration

object

optional

Case sensitivity of the username input for the selected sign-in option. For example, when case sensitivity is set to False, users can sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.

Arn

string

optional

The Amazon Resource Name (ARN) for the user pool.

>= 20 characters<= 2048 characters

Match pattern:

arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

AccountRecoverySetting

object

optional

The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.

🟠480ResourceNotFoundException

🟠481InvalidParameterException

🟠482TooManyRequestsException

🟠483NotAuthorizedException

🟠484UserPoolTaggingException

🟠485InternalErrorException

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