AmazonIdentityManagementServiceClient.UpdateGroup Method (UpdateGroupRequest)

Updates the name and/or the path of the specified IAM group.

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.

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to UpdateGroupAsync.

Namespace: Amazon.IdentityManagement
Assembly: AWSSDK.IdentityManagement.dll
Version: 3.x.y.z

Syntax

public virtual UpdateGroupResponse UpdateGroup(
         UpdateGroupRequest request
)

Parameters

request: Type: Amazon.IdentityManagement.Model.UpdateGroupRequest

Container for the necessary parameters to execute the UpdateGroup service method.

Return Value

Type: UpdateGroupResponse

The response from the UpdateGroup service method, as returned by IdentityManagementService.

Exceptions

Exception	Condition
EntityAlreadyExistsException	The request was rejected because it attempted to create a resource that already exists.
LimitExceededException	The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
NoSuchEntityException	The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
ServiceFailureException	The request processing has failed because of an unknown error, exception or failure.

Examples

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

To rename an IAM group


var client = new AmazonIdentityManagementServiceClient();
var response = client.UpdateGroup(new UpdateGroupRequest 
{
    GroupName = "Test",
    NewGroupName = "Test-1"
});

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

AmazonIdentityManagementServiceClient.UpdateGroup (UpdateGroupRequest)

Method