IAM / Client / get_account_password_policy

get_account_password_policy#

IAM.Client.get_account_password_policy()#

Retrieves the password policy for the Amazon Web Services account. This tells you the complexity requirements and mandatory rotation periods for the IAM user passwords in your account. For more information about using a password policy, see Managing an IAM password policy.

Request Syntax

response = client.get_account_password_policy()

Return type:

dict

Returns:

Response Syntax

{
    'PasswordPolicy': {
        'MinimumPasswordLength': 123,
        'RequireSymbols': True|False,
        'RequireNumbers': True|False,
        'RequireUppercaseCharacters': True|False,
        'RequireLowercaseCharacters': True|False,
        'AllowUsersToChangePassword': True|False,
        'ExpirePasswords': True|False,
        'MaxPasswordAge': 123,
        'PasswordReusePrevention': 123,
        'HardExpiry': True|False
    }
}

Response Structure

(dict) –

Contains the response to a successful GetAccountPasswordPolicy request.
- PasswordPolicy (dict) –
  
  A structure that contains details about the account’s password policy.
  - MinimumPasswordLength (integer) –
    
    Minimum length to require for IAM user passwords.
  - RequireSymbols (boolean) –
    
    Specifies whether IAM user passwords must contain at least one of the following symbols:
    
    ! @ # $ % ^ & * ( ) _ + - = [ ] { } | ‘
  - RequireNumbers (boolean) –
    
    Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).
  - RequireUppercaseCharacters (boolean) –
    
    Specifies whether IAM user passwords must contain at least one uppercase character (A to Z).
  - RequireLowercaseCharacters (boolean) –
    
    Specifies whether IAM user passwords must contain at least one lowercase character (a to z).
  - AllowUsersToChangePassword (boolean) –
    
    Specifies whether IAM users are allowed to change their own password. Gives IAM users permissions to iam:ChangePassword for only their user and to the iam:GetAccountPasswordPolicy action. This option does not attach a permissions policy to each user, rather the permissions are applied at the account-level for all users by IAM.
  - ExpirePasswords (boolean) –
    
    Indicates whether passwords in the account expire. Returns true if MaxPasswordAge contains a value greater than 0. Returns false if MaxPasswordAge is 0 or not present.
  - MaxPasswordAge (integer) –
    
    The number of days that an IAM user password is valid.
  - PasswordReusePrevention (integer) –
    
    Specifies the number of previous passwords that IAM users are prevented from reusing.
  - HardExpiry (boolean) –
    
    Specifies whether IAM users are prevented from setting a new password via the Amazon Web Services Management Console after their password has expired. The IAM user cannot access the console until an administrator resets the password. IAM users with iam:ChangePassword permission and active access keys can reset their own expired console password using the CLI or API.

Exceptions

IAM.Client.exceptions.NoSuchEntityException
IAM.Client.exceptions.ServiceFailureException

Examples

The following command displays details about the password policy for the current AWS account.

response = client.get_account_password_policy(
)

print(response)

Expected Output:

{
    'PasswordPolicy': {
        'AllowUsersToChangePassword': False,
        'ExpirePasswords': False,
        'HardExpiry': False,
        'MaxPasswordAge': 90,
        'MinimumPasswordLength': 8,
        'PasswordReusePrevention': 12,
        'RequireLowercaseCharacters': False,
        'RequireNumbers': True,
        'RequireSymbols': True,
        'RequireUppercaseCharacters': False,
    },
    'ResponseMetadata': {
        '...': '...',
    },
}