delete_user¶
Operation¶
delete_user
async
¶
delete_user(request: DeleteUserInput | DeleteUserInputDict, /, *, plugins: list[Plugin] | None = None) -> DeleteUserOutput
delete_user(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteUserInputDict]) -> DeleteUserOutput
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)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
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
|
Returns:
| Type | Description |
|---|---|
DeleteUserOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
DeleteUserInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeleteUserInput structure.
Attributes¶
user_name
class-attribute
instance-attribute
¶
user_name: str | None = ...
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: _+=,.@-
Dictionaries¶
DeleteUserInputDict
¶
Bases: TypedDict
Dictionary form of DeleteUserInput.
Attributes¶
user_name
instance-attribute
¶
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: _+=,.@-
Output¶
DeleteUserOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeleteUserOutput structure.