describe-user-pool¶

Description¶

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

Synopsis¶

  describe-user-pool
--user-pool-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--user-pool-id (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To describe a user pool

This example describes a user pool with the user pool id us-west-2_aaaaaaaaa.

Command:

aws cognito-idp describe-user-pool --user-pool-id us-west-2_aaaaaaaaa

Output:

{
  "UserPool": {
      "SmsVerificationMessage": "Your verification code is {####}. ",
      "SchemaAttributes": [
          {
              "Name": "sub",
              "StringAttributeConstraints": {
                  "MinLength": "1",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": true,
              "AttributeDataType": "String",
              "Mutable": false
          },
          {
              "Name": "name",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "given_name",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "family_name",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "middle_name",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "nickname",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "preferred_username",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "profile",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "picture",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "website",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "email",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": true,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "AttributeDataType": "Boolean",
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "Name": "email_verified",
              "Mutable": true
          },
          {
              "Name": "gender",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "birthdate",
              "StringAttributeConstraints": {
                  "MinLength": "10",
                  "MaxLength": "10"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "zoneinfo",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "locale",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "phone_number",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "AttributeDataType": "Boolean",
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "Name": "phone_number_verified",
              "Mutable": true
          },
          {
              "Name": "address",
              "StringAttributeConstraints": {
                  "MinLength": "0",
                  "MaxLength": "2048"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "String",
              "Mutable": true
          },
          {
              "Name": "updated_at",
              "NumberAttributeConstraints": {
                  "MinValue": "0"
              },
              "DeveloperOnlyAttribute": false,
              "Required": false,
              "AttributeDataType": "Number",
              "Mutable": true
          }
      ],
      "EmailVerificationSubject": "Your verification code",
      "MfaConfiguration": "OFF",
      "Name": "MyUserPool",
      "EmailVerificationMessage": "Your verification code is {####}. ",
      "SmsAuthenticationMessage": "Your authentication code is {####}. ",
      "LastModifiedDate": 1547763720.822,
      "AdminCreateUserConfig": {
          "InviteMessageTemplate": {
              "EmailMessage": "Your username is {username} and temporary password is {####}. ",
              "EmailSubject": "Your temporary password",
              "SMSMessage": "Your username is {username} and temporary password is {####}. "
          },
          "UnusedAccountValidityDays": 7,
          "AllowAdminCreateUserOnly": false
      },
      "EmailConfiguration": {
          "ReplyToEmailAddress": "myemail@mydomain.com"
          "SourceArn": "arn:aws:ses:us-east-1:000000000000:identity/myemail@mydomain.com"
      },
      "AutoVerifiedAttributes": [
          "email"
      ],
      "Policies": {
          "PasswordPolicy": {
              "RequireLowercase": true,
              "RequireSymbols": true,
              "RequireNumbers": true,
              "MinimumLength": 8,
              "RequireUppercase": true
          }
      },
      "UserPoolTags": {},
      "UsernameAttributes": [
          "email"
      ],
      "CreationDate": 1547763720.822,
      "EstimatedNumberOfUsers": 1,
      "Id": "us-west-2_aaaaaaaaa",
      "LambdaConfig": {}
  }
}

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.

TemporaryPasswordValidityDays -> (integer)

In the password policy you have set, refers to the number of days a temporary password is valid. If the user does not sign-in during this time, their password will need to be reset by an administrator.

Note

When you set TemporaryPasswordValidityDays for a user pool, you will no longer be able to set the deprecated UnusedAccountValidityDays value for that user pool.

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)

Note

We recommend that you use WriteAttributes in the user pool client to control how attributes can be mutated for new use cases instead of using DeveloperOnlyAttribute .

Specifies whether the attribute type is developer only. This attribute can only be modified by an administrator. Users will not be able to modify this attribute using their access token. For example, DeveloperOnlyAttribute can be modified using the API but cannot be updated using the API.

Mutable -> (boolean)

Specifies whether the value of the attribute can be changed.

For any user pool attribute that’s mapped to an identity provider attribute, you must set this parameter to true . Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool .

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 a verified email address in Amazon SES. This email address is used in one of the following ways, depending on the value that you specify for the EmailSendingAccount parameter:

If you specify COGNITO_DEFAULT , Amazon Cognito uses this address as the custom FROM address when it emails your users by using its built-in email account.

If you specify DEVELOPER , Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.

ReplyToEmailAddress -> (string)

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

EmailSendingAccount -> (string)

Specifies whether Amazon Cognito emails your users by using its built-in email functionality or your Amazon SES email configuration. Specify one of the following values:

COGNITO_DEFAULT

When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is below the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.

To look up the email delivery limit for the default option, see Limits in Amazon Cognito in the Amazon Cognito Developer Guide .

The default FROM address is no-reply@verificationemail.com. To customize the FROM address, provide the ARN of an Amazon SES verified email address for the SourceArn parameter.

DEVELOPER

When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your AWS account.

If you use this option, you must provide the ARN of an Amazon SES verified email address for the SourceArn parameter.

Before Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf. When you update your user pool with this option, Amazon Cognito creates a service-linked role , which is a type of IAM role, in your AWS account. This role contains the permissions that allow Amazon Cognito to access Amazon SES and send email messages with your address. For more information about the service-linked role that Amazon Cognito creates, see Using Service-Linked Roles for Amazon Cognito in the Amazon Cognito Developer Guide .

From -> (string)

Identifies either the sender’s email address or the sender’s name with their email address. For example, testuser@example.com or Test User <testuser@example.com> . This address will appear before the body of the email.

ConfigurationSet -> (string)

The set of configuration rules that can be applied to emails sent using Amazon SES. A configuration set is applied to an email by including a reference to the configuration set in the headers of the email. Once applied, all of the rules in that configuration set are applied to the email. Configuration sets can be used to apply the following types of rules to emails:

Event publishing – Amazon SES can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other AWS services such as SNS and CloudWatch.

IP pool management – When leasing dedicated IP addresses with Amazon SES, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.

SmsConfiguration -> (structure)

The SMS configuration.

SnsCallerArn -> (string)

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) caller. This is the ARN of the IAM role in your AWS account which Cognito will use to send SMS messages.

ExternalId -> (string)

The external ID is a value that we recommend you use to add security to your IAM role which is used to call Amazon SNS to send SMS messages for your user pool. If you provide an ExternalId , the Cognito User Pool will include it when attempting to assume your IAM role, so that you can set your roles trust policy to require the ExternalID . If you use the Cognito Management Console to create a role for SMS MFA, Cognito will create a role with the required permissions and a trust policy that demonstrates use of the ExternalId .

UserPoolTags -> (map)

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.

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.

CustomDomain -> (string)

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. For example: auth.example.com .

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

AdminCreateUserConfig -> (structure)

The configuration for AdminCreateUser 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 AdminCreateUser again, specifying "RESEND" for the MessageAction parameter. The default value for this parameter is 7.

Note

If you set a value for TemporaryPasswordValidityDays in PasswordPolicy , that value will be used and UnusedAccountValidityDays will be deprecated for that user pool.

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.

UsernameConfiguration -> (structure)

You can choose to enable case sensitivity on the username input for the selected sign-in option. For example, when this is set to False , users will be able to sign in using either “username” or “Username”. This configuration is immutable once it has been set. For more information, see .

CaseSensitive -> (boolean)

Specifies whether username case sensitivity will be applied for all users in the user pool through Cognito APIs.

Valid values include:

**True ** : Enables case sensitivity for all username input. When this option is set to True , users must sign in using the exact capitalization of their given username. For example, “UserName”. This is the default value.

**False ** : Enables case insensitivity for all username input. For example, when this option is set to False , users will be able to sign in using either “username” or “Username”. This option also enables both preferred_username and email alias to be case insensitive, in addition to the username attribute.

Arn -> (string)

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

AccountRecoverySetting -> (structure)

Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword . It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.

RecoveryMechanisms -> (list)

The list of RecoveryOptionTypes .

(structure)

A map containing a priority as a key, and recovery method name as a value.

Priority -> (integer)

A positive integer specifying priority of a method with 1 being the highest priority.

Name -> (string)

Specifies the recovery method for a user.

Table of Contents

Feedback

User Guide