Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . cognito-idp ]

describe-user-pool

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-user-pool
--user-pool-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--user-pool-id (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

UserPool -> (structure)

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

Id -> (string)

The ID of the user pool.

Name -> (string)

The name of the user pool.

Policies -> (structure)

The policies associated with the user pool.

PasswordPolicy -> (structure)

The password policy.

MinimumLength -> (integer)

The minimum length of the password policy that you have set. Cannot be less than 6.

RequireUppercase -> (boolean)

In the password policy that you have set, refers to whether you have required users to use at least one uppercase letter in their password.

RequireLowercase -> (boolean)

In the password policy that you have set, refers to whether you have required users to use at least one lowercase letter in their password.

RequireNumbers -> (boolean)

In the password policy that you have set, refers to whether you have required users to use at least one number in their password.

RequireSymbols -> (boolean)

In the password policy that you have set, refers to whether you have required users to use at least one symbol in their password.

LambdaConfig -> (structure)

The AWS Lambda triggers associated with the user pool.

PreSignUp -> (string)

A pre-registration AWS Lambda trigger.

CustomMessage -> (string)

A custom Message AWS Lambda trigger.

PostConfirmation -> (string)

A post-confirmation AWS Lambda trigger.

PreAuthentication -> (string)

A pre-authentication AWS Lambda trigger.

PostAuthentication -> (string)

A post-authentication AWS Lambda trigger.

DefineAuthChallenge -> (string)

Defines the authentication challenge.

CreateAuthChallenge -> (string)

Creates an authentication challenge.

VerifyAuthChallengeResponse -> (string)

Verifies the authentication challenge response.

PreTokenGeneration -> (string)

A Lambda trigger that is invoked before token generation.

UserMigration -> (string)

The user migration Lambda config type.

Status -> (string)

The status of a user pool.

LastModifiedDate -> (timestamp)

The date the user pool was last modified.

CreationDate -> (timestamp)

The date the user pool was created.

SchemaAttributes -> (list)

A container with the schema attributes of a user pool.

(structure)

Contains information about the schema attribute.

Name -> (string)

A schema attribute of the name type.

AttributeDataType -> (string)

The attribute data type.

DeveloperOnlyAttribute -> (boolean)

Specifies whether the attribute type is developer only.

Mutable -> (boolean)

Specifies whether the value of the attribute can be changed.

Required -> (boolean)

Specifies whether a user pool attribute is required. If the attribute is required and the user does not provide a value, registration or sign-in will fail.

NumberAttributeConstraints -> (structure)

Specifies the constraints for an attribute of the number type.

MinValue -> (string)

The minimum value of an attribute that is of the number data type.

MaxValue -> (string)

The maximum value of an attribute that is of the number data type.

StringAttributeConstraints -> (structure)

Specifies the constraints for an attribute of the string type.

MinLength -> (string)

The minimum length.

MaxLength -> (string)

The maximum length.

AutoVerifiedAttributes -> (list)

Specifies the attributes that are auto-verified in a user pool.

(string)

AliasAttributes -> (list)

Specifies the attributes that are aliased in a user pool.

(string)

UsernameAttributes -> (list)

Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.

(string)

SmsVerificationMessage -> (string)

The contents of the SMS verification message.

EmailVerificationMessage -> (string)

The contents of the email verification message.

EmailVerificationSubject -> (string)

The subject of the email verification message.

VerificationMessageTemplate -> (structure)

The template for verification messages.

SmsMessage -> (string)

The SMS message template.

EmailMessage -> (string)

The email message template.

EmailSubject -> (string)

The subject line for the email message template.

EmailMessageByLink -> (string)

The email message template for sending a confirmation link to the user.

EmailSubjectByLink -> (string)

The subject line for the email message template for sending a confirmation link to the user.

DefaultEmailOption -> (string)

The default email option.

SmsAuthenticationMessage -> (string)

The contents of the SMS authentication message.

MfaConfiguration -> (string)

Can be one of the following values:

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

DeviceConfiguration -> (structure)

The device configuration.

ChallengeRequiredOnNewDevice -> (boolean)

Indicates whether a challenge is required on a new device. Only applicable to a new device.

DeviceOnlyRememberedOnUserPrompt -> (boolean)

If true, a device is only remembered on user prompt.

EstimatedNumberOfUsers -> (integer)

A number estimating the size of the user pool.

EmailConfiguration -> (structure)

The email configuration.

SourceArn -> (string)

The Amazon Resource Name (ARN) of the email source.

ReplyToEmailAddress -> (string)

The destination to which the receiver of the email should reply to.

SmsConfiguration -> (structure)

The SMS configuration.

SnsCallerArn -> (string)

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) caller.

ExternalId -> (string)

The external ID.

UserPoolTags -> (map)

The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool

key -> (string)

value -> (string)

SmsConfigurationFailure -> (string)

The reason why the SMS configuration cannot send the messages to your users.

EmailConfigurationFailure -> (string)

The reason why the email configuration cannot send the messages to your users.

Domain -> (string)

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

AdminCreateUserConfig -> (structure)

The configuration for admin-create-user requests.

AllowAdminCreateUserOnly -> (boolean)

Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.

UnusedAccountValidityDays -> (integer)

The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call admin-create-user again, specifying "RESEND" for the MessageAction parameter. The default value for this parameter is 7.

InviteMessageTemplate -> (structure)

The message template to be used for the welcome message to new users.

See also Customizing User Invitation Messages .

SMSMessage -> (string)

The message template for SMS messages.

EmailMessage -> (string)

The message template for email messages.

EmailSubject -> (string)

The subject line for email messages.

UserPoolAddOns -> (structure)

The user pool add-ons.

AdvancedSecurityMode -> (string)

The advanced security mode.

Arn -> (string)

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