IAM / Client / update_group

update_group#

IAM.Client.update_group(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.update_group(
    GroupName='string',
    NewPath='string',
    NewGroupName='string'
)
Parameters:

  • GroupName (string) –

    [REQUIRED]

    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: _+=,.@-

  • NewPath (string) –

    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 ! ( \u0021 ) through the DEL character ( \u007F ), including most punctuation characters, digits, and upper and lowercased letters.

  • NewGroupName (string) –

    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”.

Returns:

None

Exceptions

  • IAM.Client.exceptions.NoSuchEntityException

  • IAM.Client.exceptions.EntityAlreadyExistsException

  • IAM.Client.exceptions.LimitExceededException

  • IAM.Client.exceptions.ServiceFailureException

Examples

The following command changes the name of the IAM group Test to Test-1.

response = client.update_group(
    GroupName='Test',
    NewGroupName='Test-1',
)

print(response)

Expected Output:

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