update_account_password_policy¶
Operation¶
update_account_password_policy
¶
update_account_password_policy(request: UpdateAccountPasswordPolicyInput | UpdateAccountPasswordPolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateAccountPasswordPolicyInputDict]) -> UpdateAccountPasswordPolicyOutput
Updates the password policy settings for the Amazon Web Services account.
Note
This operation does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the Request Parameters section for each parameter's default value. Also note that some parameters do not allow the default parameter to be explicitly set. Instead, to invoke the default value, do not include that parameter when you invoke the operation.
For more information about using a password policy, see Managing an IAM password policy in the IAM User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateAccountPasswordPolicyInput | UpdateAccountPasswordPolicyInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[UpdateAccountPasswordPolicyInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateAccountPasswordPolicyOutput
|
An instance of |
update_account_password_policy
async
¶
update_account_password_policy(request: UpdateAccountPasswordPolicyInput | UpdateAccountPasswordPolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateAccountPasswordPolicyInputDict]) -> UpdateAccountPasswordPolicyOutput
Updates the password policy settings for the Amazon Web Services account.
Note
This operation does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the Request Parameters section for each parameter's default value. Also note that some parameters do not allow the default parameter to be explicitly set. Instead, to invoke the default value, do not include that parameter when you invoke the operation.
For more information about using a password policy, see Managing an IAM password policy in the IAM User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateAccountPasswordPolicyInput | UpdateAccountPasswordPolicyInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[UpdateAccountPasswordPolicyInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateAccountPasswordPolicyOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
UpdateAccountPasswordPolicyInputDict
¶
Bases: TypedDict
Dictionary form of UpdateAccountPasswordPolicyInput.
Attributes¶
allow_users_to_change_password
instance-attribute
¶
allow_users_to_change_password: bool | None
Allows all IAM users in your account to use the Amazon Web Services Management Console to change their own passwords. For more information, see Permitting IAM users to change their own passwords in the IAM User Guide.
If you do not specify a value for this parameter, then the operation
uses the default value of false. The result is that IAM users in the
account do not automatically have permissions to change their own
password.
hard_expiry
instance-attribute
¶
hard_expiry: bool | None
Prevents IAM users who are accessing the account via the Amazon Web Services Management Console from setting a new console password after their password has expired. The IAM user cannot access the console until an administrator resets the password.
If you do not specify a value for this parameter, then the operation
uses the default value of false. The result is that IAM users can
change their passwords after they expire and continue to sign in as the
user.
Note
In the Amazon Web Services Management Console, the custom password
policy option Allow users 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. IAM users with
iam:ChangePassword permission and active access keys can reset their
own expired console password using the CLI or API.
max_password_age
instance-attribute
¶
max_password_age: int | None
The number of days that an IAM user password is valid.
If you do not specify a value for this parameter, then the operation
uses the default value of 0. The result is that IAM user passwords
never expire.
minimum_password_length
instance-attribute
¶
minimum_password_length: int | None
The minimum number of characters allowed in an IAM user password.
If you do not specify a value for this parameter, then the operation
uses the default value of 6.
password_reuse_prevention
instance-attribute
¶
password_reuse_prevention: int | None
Specifies the number of previous passwords that IAM users are prevented from reusing.
If you do not specify a value for this parameter, then the operation
uses the default value of 0. The result is that IAM users are not
prevented from reusing previous passwords.
require_lowercase_characters
instance-attribute
¶
require_lowercase_characters: bool | None
Specifies whether IAM user passwords must contain at least one lowercase character from the ISO basic Latin alphabet (a to z).
If you do not specify a value for this parameter, then the operation
uses the default value of false. The result is that passwords do not
require at least one lowercase character.
require_numbers
instance-attribute
¶
require_numbers: bool | None
Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).
If you do not specify a value for this parameter, then the operation
uses the default value of false. The result is that passwords do not
require at least one numeric character.
require_symbols
instance-attribute
¶
require_symbols: bool | None
Specifies whether IAM user passwords must contain at least one of the following non-alphanumeric characters:
! @ # $ % ^ & * ( ) _ + - = [ ] { } | '
If you do not specify a value for this parameter, then the operation
uses the default value of false. The result is that passwords do not
require at least one symbol character.
require_uppercase_characters
instance-attribute
¶
require_uppercase_characters: bool | None
Specifies whether IAM user passwords must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z).
If you do not specify a value for this parameter, then the operation
uses the default value of false. The result is that passwords do not
require at least one uppercase character.
UpdateAccountPasswordPolicyInput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateAccountPasswordPolicyInput structure.
Attributes¶
allow_users_to_change_password
class-attribute
instance-attribute
¶
allow_users_to_change_password: bool = ...
Allows all IAM users in your account to use the Amazon Web Services Management Console to change their own passwords. For more information, see Permitting IAM users to change their own passwords in the IAM User Guide.
If you do not specify a value for this parameter, then the operation
uses the default value of false. The result is that IAM users in the
account do not automatically have permissions to change their own
password.
hard_expiry
class-attribute
instance-attribute
¶
hard_expiry: bool | None = ...
Prevents IAM users who are accessing the account via the Amazon Web Services Management Console from setting a new console password after their password has expired. The IAM user cannot access the console until an administrator resets the password.
If you do not specify a value for this parameter, then the operation
uses the default value of false. The result is that IAM users can
change their passwords after they expire and continue to sign in as the
user.
Note
In the Amazon Web Services Management Console, the custom password
policy option Allow users 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. IAM users with
iam:ChangePassword permission and active access keys can reset their
own expired console password using the CLI or API.
max_password_age
class-attribute
instance-attribute
¶
max_password_age: int | None = ...
The number of days that an IAM user password is valid.
If you do not specify a value for this parameter, then the operation
uses the default value of 0. The result is that IAM user passwords
never expire.
minimum_password_length
class-attribute
instance-attribute
¶
minimum_password_length: int | None = ...
The minimum number of characters allowed in an IAM user password.
If you do not specify a value for this parameter, then the operation
uses the default value of 6.
password_reuse_prevention
class-attribute
instance-attribute
¶
password_reuse_prevention: int | None = ...
Specifies the number of previous passwords that IAM users are prevented from reusing.
If you do not specify a value for this parameter, then the operation
uses the default value of 0. The result is that IAM users are not
prevented from reusing previous passwords.
require_lowercase_characters
class-attribute
instance-attribute
¶
require_lowercase_characters: bool = ...
Specifies whether IAM user passwords must contain at least one lowercase character from the ISO basic Latin alphabet (a to z).
If you do not specify a value for this parameter, then the operation
uses the default value of false. The result is that passwords do not
require at least one lowercase character.
require_numbers
class-attribute
instance-attribute
¶
require_numbers: bool = ...
Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).
If you do not specify a value for this parameter, then the operation
uses the default value of false. The result is that passwords do not
require at least one numeric character.
require_symbols
class-attribute
instance-attribute
¶
require_symbols: bool = ...
Specifies whether IAM user passwords must contain at least one of the following non-alphanumeric characters:
! @ # $ % ^ & * ( ) _ + - = [ ] { } | '
If you do not specify a value for this parameter, then the operation
uses the default value of false. The result is that passwords do not
require at least one symbol character.
require_uppercase_characters
class-attribute
instance-attribute
¶
require_uppercase_characters: bool = ...
Specifies whether IAM user passwords must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z).
If you do not specify a value for this parameter, then the operation
uses the default value of false. The result is that passwords do not
require at least one uppercase character.
Output¶
UpdateAccountPasswordPolicyOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateAccountPasswordPolicyOutput structure.