Menu
Amazon Cognito Identity Provider
API Reference (API Version 2016-04-18)

UserPoolType

A container for information about the user pool.

Contents

AdminCreateUserConfig

The configuration for AdminCreateUser requests.

Type: AdminCreateUserConfigType object

Required: No

AliasAttributes

Specifies the attributes that are aliased in a user pool.

Type: Array of strings

Valid Values: phone_number | email | preferred_username

Required: No

AutoVerifiedAttributes

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

Type: Array of strings

Valid Values: phone_number | email

Required: No

CreationDate

The date the user pool was created.

Type: Timestamp

Required: No

DeviceConfiguration

The device configuration.

Type: DeviceConfigurationType object

Required: No

Domain

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

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

Required: No

EmailConfiguration

The email configuration.

Type: EmailConfigurationType object

Required: No

EmailConfigurationFailure

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

Type: String

Required: No

EmailVerificationMessage

The contents of the email verification message.

Type: String

Length Constraints: Minimum length of 6. Maximum length of 20000.

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

Required: No

EmailVerificationSubject

The subject of the email verification message.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 140.

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

Required: No

EstimatedNumberOfUsers

A number estimating the size of the user pool.

Type: Integer

Required: No

Id

The ID of the user pool.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 55.

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

Required: No

LambdaConfig

The AWS Lambda triggers associated with tue user pool.

Type: LambdaConfigType object

Required: No

LastModifiedDate

The date the user pool was last modified.

Type: Timestamp

Required: No

MfaConfiguration

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.

Type: String

Valid Values: OFF | ON | OPTIONAL

Required: No

Name

The name of the user pool.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

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

Required: No

Policies

The policies associated with the user pool.

Type: UserPoolPolicyType object

Required: No

SchemaAttributes

A container with the schema attributes of a user pool.

Type: Array of SchemaAttributeType objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

SmsAuthenticationMessage

The contents of the SMS authentication message.

Type: String

Length Constraints: Minimum length of 6. Maximum length of 140.

Pattern: .*\{####\}.*

Required: No

SmsConfiguration

The SMS configuration.

Type: SmsConfigurationType object

Required: No

SmsConfigurationFailure

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

Type: String

Required: No

SmsVerificationMessage

The contents of the SMS verification message.

Type: String

Length Constraints: Minimum length of 6. Maximum length of 140.

Pattern: .*\{####\}.*

Required: No

Status

The status of a user pool.

Type: String

Valid Values: Enabled | Disabled

Required: No

UsernameAttributes

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

Type: Array of strings

Valid Values: phone_number | email

Required: No

UserPoolAddOns

The user pool add-ons.

Type: UserPoolAddOnsType object

Required: No

UserPoolTags

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

Type: String to string map

Required: No

VerificationMessageTemplate

The template for verification messages.

Type: VerificationMessageTemplateType object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: