AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

To change an IAM group name the requester must have appropriate permissions on both the source object and the target object. For example, to change "Managers" to "MGRs", the entity making the request must have permission on both "Managers" and "MGRs", or must have permission on all (*). For more information about permissions, see Permissions and Policies.

Note:

For PCL and Unity 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

C#
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
The response from the UpdateGroup service method, as returned by IdentityManagementService.

Exceptions

ExceptionCondition
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 AWS account limits. The error message describes the limit exceeded.
NoSuchEntityException The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
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 response = client.UpdateGroup(new UpdateGroupRequest 
{
    GroupName = "Test",
    NewGroupName = "Test-1"
});


            

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone

See Also