AWS API Changes

2016/11/14 - Amazon Cognito Identity Provider - 1 updated api methods

CreateUserPool (updated)

Link ¶
Changes (request)

{'Schema': [{'AttributeDataType': 'String | Number | DateTime | Boolean',
             'DeveloperOnlyAttribute': 'boolean',
             'Mutable': 'boolean',
             'Name': 'string',
             'NumberAttributeConstraints': {'MaxValue': 'string',
                                            'MinValue': 'string'},
             'Required': 'boolean',
             'StringAttributeConstraints': {'MaxLength': 'string',
                                            'MinLength': 'string'}}]}

Creates a new Amazon Cognito user pool and sets the password policy for the pool.

Request Syntax

client.create_user_pool(
    PoolName='string',
    Policies={
        'PasswordPolicy': {
            'MinimumLength': 123,
            'RequireUppercase': True|False,
            'RequireLowercase': True|False,
            'RequireNumbers': True|False,
            'RequireSymbols': True|False
        }
    },
    LambdaConfig={
        'PreSignUp': 'string',
        'CustomMessage': 'string',
        'PostConfirmation': 'string',
        'PreAuthentication': 'string',
        'PostAuthentication': 'string',
        'DefineAuthChallenge': 'string',
        'CreateAuthChallenge': 'string',
        'VerifyAuthChallengeResponse': 'string'
    },
    AutoVerifiedAttributes=[
        'phone_number'|'email',
    ],
    AliasAttributes=[
        'phone_number'|'email'|'preferred_username',
    ],
    SmsVerificationMessage='string',
    EmailVerificationMessage='string',
    EmailVerificationSubject='string',
    SmsAuthenticationMessage='string',
    MfaConfiguration='OFF'|'ON'|'OPTIONAL',
    DeviceConfiguration={
        'ChallengeRequiredOnNewDevice': True|False,
        'DeviceOnlyRememberedOnUserPrompt': True|False
    },
    EmailConfiguration={
        'SourceArn': 'string',
        'ReplyToEmailAddress': 'string'
    },
    SmsConfiguration={
        'SnsCallerArn': 'string',
        'ExternalId': 'string'
    },
    AdminCreateUserConfig={
        'AllowAdminCreateUserOnly': True|False,
        'UnusedAccountValidityDays': 123,
        'InviteMessageTemplate': {
            'SMSMessage': 'string',
            'EmailMessage': 'string',
            'EmailSubject': 'string'
        }
    },
    Schema=[
        {
            'Name': 'string',
            'AttributeDataType': 'String'|'Number'|'DateTime'|'Boolean',
            'DeveloperOnlyAttribute': True|False,
            'Mutable': True|False,
            'Required': True|False,
            'NumberAttributeConstraints': {
                'MinValue': 'string',
                'MaxValue': 'string'
            },
            'StringAttributeConstraints': {
                'MinLength': 'string',
                'MaxLength': 'string'
            }
        },
    ]
)

type PoolName

string

param PoolName

[REQUIRED]

A string used to name the user pool.

type Policies

dict

param Policies

The policies associated with the new user pool.

PasswordPolicy (dict) --

A container with information about the user pool 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.

type LambdaConfig

dict

param LambdaConfig

The Lambda trigger configuration information for the new 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.

type AutoVerifiedAttributes

list

param AutoVerifiedAttributes

The attributes to be auto-verified. Possible values: email , phone_number .

(string) --

type AliasAttributes

list

param AliasAttributes

Attributes supported as an alias for this user pool. Possible values: phone_number , email , or preferred_username .

(string) --

type SmsVerificationMessage

string

param SmsVerificationMessage

A string representing the SMS verification message.

type EmailVerificationMessage

string

param EmailVerificationMessage

A string representing the email verification message.

type EmailVerificationSubject

string

param EmailVerificationSubject

A string representing the email verification subject.

type SmsAuthenticationMessage

string

param SmsAuthenticationMessage

A string representing the SMS authentication message.

type MfaConfiguration

string

param MfaConfiguration

Specifies MFA configuration details.

type DeviceConfiguration

dict

param DeviceConfiguration

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.

type EmailConfiguration

dict

param EmailConfiguration

The email configuration.

SourceArn (string) --

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

The REPLY-TO email address.

type SmsConfiguration

dict

param SmsConfiguration

The SMS configuration.

SnsCallerArn (string) -- [REQUIRED]

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

The external ID.

type AdminCreateUserConfig

dict

param AdminCreateUserConfig

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.
InviteMessageTemplate (dict) --

The message template to be used for the welcome message to new users.
- SMSMessage (string) --
  
  The message template for SMS messages.
- EmailMessage (string) --
  
  The message template for email messages.
- EmailSubject (string) --
  
  The subject line for email messages.

type Schema

list

param Schema

An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

(dict) --

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 attribute can be changed once it has been created.
- 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 (dict) --
  
  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 (dict) --
  
  Specifies the constraints for an attribute of the string type.
  - MinLength (string) --
    
    The minimum length of an attribute value of the string type.
  - MaxLength (string) --
    
    The maximum length of an attribute value of the string type.

rtype

dict

returns

Response Syntax

{
    'UserPool': {
        'Id': 'string',
        'Name': 'string',
        'Policies': {
            'PasswordPolicy': {
                'MinimumLength': 123,
                'RequireUppercase': True|False,
                'RequireLowercase': True|False,
                'RequireNumbers': True|False,
                'RequireSymbols': True|False
            }
        },
        'LambdaConfig': {
            'PreSignUp': 'string',
            'CustomMessage': 'string',
            'PostConfirmation': 'string',
            'PreAuthentication': 'string',
            'PostAuthentication': 'string',
            'DefineAuthChallenge': 'string',
            'CreateAuthChallenge': 'string',
            'VerifyAuthChallengeResponse': 'string'
        },
        'Status': 'Enabled'|'Disabled',
        'LastModifiedDate': datetime(2015, 1, 1),
        'CreationDate': datetime(2015, 1, 1),
        'SchemaAttributes': [
            {
                'Name': 'string',
                'AttributeDataType': 'String'|'Number'|'DateTime'|'Boolean',
                'DeveloperOnlyAttribute': True|False,
                'Mutable': True|False,
                'Required': True|False,
                'NumberAttributeConstraints': {
                    'MinValue': 'string',
                    'MaxValue': 'string'
                },
                'StringAttributeConstraints': {
                    'MinLength': 'string',
                    'MaxLength': 'string'
                }
            },
        ],
        'AutoVerifiedAttributes': [
            'phone_number'|'email',
        ],
        'AliasAttributes': [
            'phone_number'|'email'|'preferred_username',
        ],
        'SmsVerificationMessage': 'string',
        'EmailVerificationMessage': 'string',
        'EmailVerificationSubject': 'string',
        'SmsAuthenticationMessage': 'string',
        'MfaConfiguration': 'OFF'|'ON'|'OPTIONAL',
        'DeviceConfiguration': {
            'ChallengeRequiredOnNewDevice': True|False,
            'DeviceOnlyRememberedOnUserPrompt': True|False
        },
        'EstimatedNumberOfUsers': 123,
        'EmailConfiguration': {
            'SourceArn': 'string',
            'ReplyToEmailAddress': 'string'
        },
        'SmsConfiguration': {
            'SnsCallerArn': 'string',
            'ExternalId': 'string'
        },
        'SmsConfigurationFailure': 'string',
        'EmailConfigurationFailure': 'string',
        'AdminCreateUserConfig': {
            'AllowAdminCreateUserOnly': True|False,
            'UnusedAccountValidityDays': 123,
            'InviteMessageTemplate': {
                'SMSMessage': 'string',
                'EmailMessage': 'string',
                'EmailSubject': 'string'
            }
        }
    }
}

Response Structure

(dict) --

Represents the response from the server for the request to create a user pool.
- UserPool (dict) --
  
  A container for the user pool details.
  - Id (string) --
    
    The ID of the user pool.
  - Name (string) --
    
    The name of the user pool.
  - Policies (dict) --
    
    A container describing the policies associated with a user pool.
    - PasswordPolicy (dict) --
      
      A container with information about the user pool 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 (dict) --
    
    A container describing the AWS Lambda triggers associated with a 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.
  - Status (string) --
    
    The status of a user pool.
  - LastModifiedDate (datetime) --
    
    The last modified date of a user pool.
  - CreationDate (datetime) --
    
    The creation date of a user pool.
  - SchemaAttributes (list) --
    
    A container with the schema attributes of a user pool.
    - (dict) --
      
      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 attribute can be changed once it has been created.
      - 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 (dict) --
        
        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 (dict) --
        
        Specifies the constraints for an attribute of the string type.
        
        MinLength (string) --
        
        The minimum length of an attribute value of the string type.
        
        MaxLength (string) --
        
        The maximum length of an attribute value of the string type.
  - 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) --
  - 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.
  - 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 (dict) --
    
    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 (dict) --
    
    The email configuration.
    - SourceArn (string) --
      
      The Amazon Resource Name (ARN) of the email source.
    - ReplyToEmailAddress (string) --
      
      The REPLY-TO email address.
  - SmsConfiguration (dict) --
    
    The SMS configuration.
    - SnsCallerArn (string) --
      
      The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) caller.
    - ExternalId (string) --
      
      The external ID.
  - SmsConfigurationFailure (string) --
    
    The reason why the SMS configuration cannot send the message(s) to your users.
  - EmailConfigurationFailure (string) --
    
    The reason why the email configuration cannot send the messages to your users.
  - AdminCreateUserConfig (dict) --
    
    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.
    - InviteMessageTemplate (dict) --
      
      The message template to be used for the welcome message to new users.
      - SMSMessage (string) --
        
        The message template for SMS messages.
      - EmailMessage (string) --
        
        The message template for email messages.
      - EmailSubject (string) --
        
        The subject line for email messages.