IAM / Client / delete_login_profile

delete_login_profile#

IAM.Client.delete_login_profile(**kwargs)#

Deletes the password for the specified IAM user, For more information, see Managing passwords for IAM users.

You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to delete a password for any IAM user. You can use ChangePassword to update, but not delete, your own password in the My Security Credentials page in the Amazon Web Services Management Console.

Warning

Deleting a user’s password does not prevent a user from accessing Amazon Web Services through the command line interface or the API. To prevent all user access, you must also either make any access keys inactive or delete them. For more information about making keys inactive or deleting them, see UpdateAccessKey and DeleteAccessKey.

Request Syntax

response = client.delete_login_profile(
    UserName='string'
)

Parameters:

UserName (string) –

The name of the user whose password you want to delete.

This parameter is optional. If no user name is included, it defaults to the principal making the request. When you make this request with root user credentials, you must use an AssumeRoot session to omit the user name.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Returns:

None

Exceptions

IAM.Client.exceptions.EntityTemporarilyUnmodifiableException
IAM.Client.exceptions.NoSuchEntityException
IAM.Client.exceptions.LimitExceededException
IAM.Client.exceptions.ServiceFailureException

Examples

The following command deletes the password for the IAM user named Bob.

response = client.delete_login_profile(
    UserName='Bob',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}