delete_user

delete_user(**kwargs)

Deletes the specified IAM user. Unlike the Amazon Web Services Management Console, when you delete a user programmatically, you must delete the items attached to the user manually, or the deletion fails. For more information, see Deleting an IAM user. Before attempting to delete a user, remove the following items:

• Password ( DeleteLoginProfile )
• Access keys ( DeleteAccessKey )
• Signing certificate ( DeleteSigningCertificate )
• SSH public key ( DeleteSSHPublicKey )
• Git credentials ( DeleteServiceSpecificCredential )
• Multi-factor authentication (MFA) device ( DeactivateMFADevice, DeleteVirtualMFADevice )
• Inline policies ( DeleteUserPolicy )
• Attached managed policies ( DetachUserPolicy )
• Group memberships ( RemoveUserFromGroup )

See also: AWS API Documentation

Request Syntax

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

Parameters

UserName (string) --

[REQUIRED]

The name of the user to delete.

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.LimitExceededException
• IAM.Client.exceptions.NoSuchEntityException
• IAM.Client.exceptions.DeleteConflictException
• IAM.Client.exceptions.ConcurrentModificationException
• IAM.Client.exceptions.ServiceFailureException

Examples

The following command removes the IAM user named Bob from the current account.

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

print(response)

Expected Output:

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