Skip to content

PasswordPolicyType

Source code in docs_src/capo_cognito_identity_provider/types/password_policy_type.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class PasswordPolicyType(TypedDict, closed=True):
    minimum_length: NotRequired[
        "capo_cognito_identity_provider.types.password_policy_min_length_type.PasswordPolicyMinLengthType"
    ]
    """<p>The minimum length of the password in the policy that you have set. This value can't be less than 6.</p>"""
    require_uppercase: "capo_cognito_identity_provider.types.boolean_type.BooleanType"
    """<p>The requirement in a password policy that users must include at least one uppercase letter in their password.</p>"""
    require_lowercase: "capo_cognito_identity_provider.types.boolean_type.BooleanType"
    """<p>The requirement in a password policy that users must include at least one lowercase letter in their password.</p>"""
    require_numbers: "capo_cognito_identity_provider.types.boolean_type.BooleanType"
    """<p>The requirement in a password policy that users must include at least one number in their password.</p>"""
    require_symbols: "capo_cognito_identity_provider.types.boolean_type.BooleanType"
    """<p>The requirement in a password policy that users must include at least one symbol in their password.</p>"""
    password_history_size: NotRequired[
        "capo_cognito_identity_provider.types.password_history_size_type.PasswordHistorySizeType"
    ]
    """<p>The number of previous passwords that you want Amazon Cognito to restrict each user from reusing. Users can't set a password that matches any of <code>n</code> previous passwords, where <code>n</code> is the value of <code>PasswordHistorySize</code>.</p>"""
    temporary_password_validity_days: "capo_cognito_identity_provider.types.temporary_password_validity_days_type.TemporaryPasswordValidityDaysType"
    """<p>The number of days a temporary password is valid in the password policy. If the user doesn't sign in during this time, an administrator must reset their password. Defaults to <code>7</code>. If you submit a value of <code>0</code>, Amazon Cognito treats it as a null value and sets <code>TemporaryPasswordValidityDays</code> to its default value.</p> <note> <p>When you set <code>TemporaryPasswordValidityDays</code> for a user pool, you can no longer set a value for the legacy <code>UnusedAccountValidityDays</code> parameter in that user pool.</p> </note>"""

minimum_length instance-attribute 

minimum_length: NotRequired[PasswordPolicyMinLengthType]

The minimum length of the password in the policy that you have set. This value can't be less than 6.

password_history_size instance-attribute 

password_history_size: NotRequired[PasswordHistorySizeType]

The number of previous passwords that you want Amazon Cognito to restrict each user from reusing. Users can't set a password that matches any of n previous passwords, where n is the value of PasswordHistorySize.

require_lowercase instance-attribute 

require_lowercase: BooleanType

The requirement in a password policy that users must include at least one lowercase letter in their password.

require_numbers instance-attribute 

require_numbers: BooleanType

The requirement in a password policy that users must include at least one number in their password.

require_symbols instance-attribute 

require_symbols: BooleanType

The requirement in a password policy that users must include at least one symbol in their password.

require_uppercase instance-attribute 

require_uppercase: BooleanType

The requirement in a password policy that users must include at least one uppercase letter in their password.

temporary_password_validity_days instance-attribute 

temporary_password_validity_days: TemporaryPasswordValidityDaysType

The number of days a temporary password is valid in the password policy. If the user doesn't sign in during this time, an administrator must reset their password. Defaults to 7. If you submit a value of 0, Amazon Cognito treats it as a null value and sets TemporaryPasswordValidityDays to its default value.

When you set TemporaryPasswordValidityDays for a user pool, you can no longer set a value for the legacy UnusedAccountValidityDays parameter in that user pool.