Amazon Cognito Identity Provider

{'UserPool': {'CustomDomain': 'string'}}

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

See also: AWS API Documentation

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',
        'PreTokenGeneration': 'string',
        'UserMigration': 'string'
    },
    AutoVerifiedAttributes=[
        'phone_number'|'email',
    ],
    AliasAttributes=[
        'phone_number'|'email'|'preferred_username',
    ],
    UsernameAttributes=[
        'phone_number'|'email',
    ],
    SmsVerificationMessage='string',
    EmailVerificationMessage='string',
    EmailVerificationSubject='string',
    VerificationMessageTemplate={
        'SmsMessage': 'string',
        'EmailMessage': 'string',
        'EmailSubject': 'string',
        'EmailMessageByLink': 'string',
        'EmailSubjectByLink': 'string',
        'DefaultEmailOption': 'CONFIRM_WITH_LINK'|'CONFIRM_WITH_CODE'
    },
    SmsAuthenticationMessage='string',
    MfaConfiguration='OFF'|'ON'|'OPTIONAL',
    DeviceConfiguration={
        'ChallengeRequiredOnNewDevice': True|False,
        'DeviceOnlyRememberedOnUserPrompt': True|False
    },
    EmailConfiguration={
        'SourceArn': 'string',
        'ReplyToEmailAddress': 'string'
    },
    SmsConfiguration={
        'SnsCallerArn': 'string',
        'ExternalId': 'string'
    },
    UserPoolTags={
        'string': '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'
            }
        },
    ],
    UserPoolAddOns={
        'AdvancedSecurityMode': 'OFF'|'AUDIT'|'ENFORCED'
    }
)

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) --

  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.

type LambdaConfig

dict

param LambdaConfig

The Lambda trigger configuration information for the new user pool.

Note

In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you will need to make an extra call to add permission for these event sources to invoke your Lambda function.

For more information on using the Lambda API to add permission, see AddPermission .

For adding permission using the AWS CLI, see add-permission .

• 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.

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 UsernameAttributes

list

param UsernameAttributes

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

• (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 VerificationMessageTemplate

dict

param VerificationMessageTemplate

The template for the verification message that the user sees when the app requests permission to access the user's information.

• 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.

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 destination to which the receiver of the email should reply to.

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 UserPoolTags

dict

param UserPoolTags

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

• (string) --

  • (string) --

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. The default value for this parameter is 7.

• InviteMessageTemplate (dict) --

  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.

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 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 (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.

    • MaxLength (string) --

      The maximum length.

type UserPoolAddOns

dict

param UserPoolAddOns

Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".

• AdvancedSecurityMode (string) -- [REQUIRED]

  The advanced security mode.

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',
            'PreTokenGeneration': 'string',
            'UserMigration': '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',
        ],
        'UsernameAttributes': [
            'phone_number'|'email',
        ],
        'SmsVerificationMessage': 'string',
        'EmailVerificationMessage': 'string',
        'EmailVerificationSubject': 'string',
        'VerificationMessageTemplate': {
            'SmsMessage': 'string',
            'EmailMessage': 'string',
            'EmailSubject': 'string',
            'EmailMessageByLink': 'string',
            'EmailSubjectByLink': 'string',
            'DefaultEmailOption': 'CONFIRM_WITH_LINK'|'CONFIRM_WITH_CODE'
        },
        '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'
        },
        'UserPoolTags': {
            'string': 'string'
        },
        'SmsConfigurationFailure': 'string',
        'EmailConfigurationFailure': 'string',
        'Domain': 'string',
        'CustomDomain': 'string',
        'AdminCreateUserConfig': {
            'AllowAdminCreateUserOnly': True|False,
            'UnusedAccountValidityDays': 123,
            'InviteMessageTemplate': {
                'SMSMessage': 'string',
                'EmailMessage': 'string',
                'EmailSubject': 'string'
            }
        },
        'UserPoolAddOns': {
            'AdvancedSecurityMode': 'OFF'|'AUDIT'|'ENFORCED'
        },
        'Arn': '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) --

      The policies associated with the user pool.

      • PasswordPolicy (dict) --

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

      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 (datetime) --

      The date the user pool was last modified.

    • CreationDate (datetime) --

      The date the user pool was created.

    • 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 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 (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.

          • 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 (dict) --

      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 (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 destination to which the receiver of the email should reply to.

    • 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.

    • UserPoolTags (dict) --

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

      • (string) --

        • (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) --

    • 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. The default value for this parameter is 7.

      • InviteMessageTemplate (dict) --

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

      The user pool add-ons.

      • AdvancedSecurityMode (string) --

        The advanced security mode.

    • Arn (string) --

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

{'CustomDomainConfig': {'CertificateArn': 'string'}}

{'CloudFrontDomain': 'string'}

Creates a new domain for a user pool.

See also: AWS API Documentation

Request Syntax

client.create_user_pool_domain(
    Domain='string',
    UserPoolId='string',
    CustomDomainConfig={
        'CertificateArn': 'string'
    }
)

type Domain

string

param Domain

[REQUIRED]

The domain string.

type UserPoolId

string

param UserPoolId

[REQUIRED]

The user pool ID.

type CustomDomainConfig

dict

param CustomDomainConfig

The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

Provide this parameter only if you want to use own custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.

For more information about the hosted domain and custom domains, see Configuring a User Pool Domain .

• CertificateArn (string) -- [REQUIRED]

  The Amazon Resource Name (ARN) of an AWS Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.

rtype

dict

returns

Response Syntax

{
    'CloudFrontDomain': 'string'
}

Response Structure

• (dict) --

  • CloudFrontDomain (string) --

    The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.

{'UserPool': {'CustomDomain': 'string'}}

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

See also: AWS API Documentation

Request Syntax

client.describe_user_pool(
    UserPoolId='string'
)

type UserPoolId

string

param UserPoolId

[REQUIRED]

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

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',
            'PreTokenGeneration': 'string',
            'UserMigration': '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',
        ],
        'UsernameAttributes': [
            'phone_number'|'email',
        ],
        'SmsVerificationMessage': 'string',
        'EmailVerificationMessage': 'string',
        'EmailVerificationSubject': 'string',
        'VerificationMessageTemplate': {
            'SmsMessage': 'string',
            'EmailMessage': 'string',
            'EmailSubject': 'string',
            'EmailMessageByLink': 'string',
            'EmailSubjectByLink': 'string',
            'DefaultEmailOption': 'CONFIRM_WITH_LINK'|'CONFIRM_WITH_CODE'
        },
        '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'
        },
        'UserPoolTags': {
            'string': 'string'
        },
        'SmsConfigurationFailure': 'string',
        'EmailConfigurationFailure': 'string',
        'Domain': 'string',
        'CustomDomain': 'string',
        'AdminCreateUserConfig': {
            'AllowAdminCreateUserOnly': True|False,
            'UnusedAccountValidityDays': 123,
            'InviteMessageTemplate': {
                'SMSMessage': 'string',
                'EmailMessage': 'string',
                'EmailSubject': 'string'
            }
        },
        'UserPoolAddOns': {
            'AdvancedSecurityMode': 'OFF'|'AUDIT'|'ENFORCED'
        },
        'Arn': 'string'
    }
}

Response Structure

• (dict) --

  Represents the response to describe the user pool.

  • UserPool (dict) --

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

      The policies associated with the user pool.

      • PasswordPolicy (dict) --

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

      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 (datetime) --

      The date the user pool was last modified.

    • CreationDate (datetime) --

      The date the user pool was created.

    • 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 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 (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.

          • 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 (dict) --

      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 (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 destination to which the receiver of the email should reply to.

    • 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.

    • UserPoolTags (dict) --

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

      • (string) --

        • (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) --

    • 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. The default value for this parameter is 7.

      • InviteMessageTemplate (dict) --

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

      The user pool add-ons.

      • AdvancedSecurityMode (string) --

        The advanced security mode.

    • Arn (string) --

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

{'DomainDescription': {'CustomDomainConfig': {'CertificateArn': 'string'}}}

Gets information about a domain.

See also: AWS API Documentation

Request Syntax

client.describe_user_pool_domain(
    Domain='string'
)

type Domain

string

param Domain

[REQUIRED]

The domain string.

rtype

dict

returns

Response Syntax

{
    'DomainDescription': {
        'UserPoolId': 'string',
        'AWSAccountId': 'string',
        'Domain': 'string',
        'S3Bucket': 'string',
        'CloudFrontDistribution': 'string',
        'Version': 'string',
        'Status': 'CREATING'|'DELETING'|'UPDATING'|'ACTIVE'|'FAILED',
        'CustomDomainConfig': {
            'CertificateArn': 'string'
        }
    }
}

Response Structure

• (dict) --

  • DomainDescription (dict) --

    A domain description object containing information about the domain.

    • UserPoolId (string) --

      The user pool ID.

    • AWSAccountId (string) --

      The AWS account ID for the user pool owner.

    • Domain (string) --

      The domain string.

    • S3Bucket (string) --

      The S3 bucket where the static files for this domain are stored.

    • CloudFrontDistribution (string) --

      The ARN of the CloudFront distribution.

    • Version (string) --

      The app version.

    • Status (string) --

      The domain status.

    • CustomDomainConfig (dict) --

      The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

      • CertificateArn (string) --

        The Amazon Resource Name (ARN) of an AWS Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.