[ aws . iam ]

get-account-password-policy

Description

Retrieves the password policy for the AWS 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 .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-account-password-policy
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To see the current account password policy

The following get-account-password-policy command displays details about the password policy for the current account:

aws iam get-account-password-policy

Output:

{
    "PasswordPolicy": {
        "AllowUsersToChangePassword": false,
        "RequireLowercaseCharacters": false,
        "RequireUppercaseCharacters": false,
        "MinimumPasswordLength": 8,
        "RequireNumbers": true,
        "RequireSymbols": true
    }
}

If no password policy is defined for the account, the command returns a NoSuchEntity error.

For more information, see Managing an IAM Password Policy in the Using IAM guide.

Output

PasswordPolicy -> (structure)

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.

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 after their password has expired.