update_user¶
Operation¶
async
¶
update_user(input: UpdateUserInput, plugins: list[Plugin] | None = None) -> UpdateUserOutput
Updates the name and/or the path of the specified IAM user.
Warning
You should understand the implications of changing an IAM user's path or name. For more information, see Renaming an IAM user and Renaming an IAM group in the IAM User Guide.
Note: To change a user name, the requester must have appropriate permissions on both the source object and the target object. For example, to change Bob to Robert, the entity making the request must have permission on Bob and Robert, or must have permission on all (*). For more information about permissions, see Permissions and policies.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateUserInput
|
An instance of |
required |
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 |
|---|---|
UpdateUserOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateUserInput structure.
Attributes¶
class-attribute
instance-attribute
¶
new_path: str | None = ...
New path for the IAM user. Include this parameter only if you're changing the user's path.
This parameter allows (through its regex
pattern) a string of characters
consisting of either a forward slash (/) by itself or a string that must
begin and end with forward slashes. In addition, it can contain any
ASCII character from the ! (!) through the DEL character
(), including most punctuation characters, digits, and upper and
lowercased letters.
class-attribute
instance-attribute
¶
new_user_name: str | None = ...
New name for the user. Include this parameter only if you're changing the user's name.
IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".
class-attribute
instance-attribute
¶
user_name: str | None = ...
Name of the user to update. If you're changing the name of the user, this is the original 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: _+=,.@-
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateUserOutput structure.