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.

Container for the parameters to the UpdateGroup operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.IdentityManagement.AmazonIdentityManagementServiceRequest
      Amazon.IdentityManagement.Model.UpdateGroupRequest

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

Syntax

C#
public class UpdateGroupRequest : AmazonIdentityManagementServiceRequest
         IAmazonWebServiceRequest

The UpdateGroupRequest type exposes the following members

Constructors

NameDescription
Public Method UpdateGroupRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method UpdateGroupRequest(string)

Instantiates UpdateGroupRequest with the parameterized properties

Properties

NameTypeDescription
Public Property GroupName System.String

Gets and sets the property GroupName.

Name of the IAM group to update. If you're changing the name of the group, this is the original name.

This parameter allows (per 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: _+=,.@-

Public Property NewGroupName System.String

Gets and sets the property NewGroupName.

New name for the IAM group. Only include this if changing the group's name.

This parameter allows (per 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: _+=,.@-

Public Property NewPath System.String

Gets and sets the property NewPath.

New path for the IAM group. Only include this if changing the group's path.

This parameter allows (per 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.

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 Standard:
Supported in: 1.3

.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