update_group¶
Operation¶
async
¶
update_group(input: UpdateGroupInput, plugins: list[Plugin] | None = None) -> UpdateGroupOutput
Updates the name and/or the path of the specified IAM group.
Warning
You should understand the implications of changing a group's path or name. For more information, see Renaming users and groups in the IAM User Guide.
Note:
The person making the request (the principal), must have permission to
change the role group with the old name and the new name. For example,
to change the group named Managers to MGRs, the principal must have
a policy that allows them to update both groups. If the principal has
permission to update the Managers group, but not the MGRs group,
then the update fails. For more information about permissions, see
Access
management.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateGroupInput
|
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 |
|---|---|
UpdateGroupOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateGroupInput structure.
Attributes¶
class-attribute
instance-attribute
¶
group_name: str | None = ...
Name of the IAM group to update. If you're changing the name of the group, this is the original 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: _+=,.@-
class-attribute
instance-attribute
¶
new_group_name: str | None = ...
New name for the IAM group. Only include this if changing the group'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
¶
new_path: str | None = ...
New path for the IAM group. Only include this if changing the group'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.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateGroupOutput structure.