Updates the name and/or the path of the specified group.
You should understand the implications of changing a group’s path or name. For more information, see Renaming Users and Groups in Using AWS Identity and Access Management.
To change a 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 Managers and MGRs, or must have permission on all (*). For more information about permissions, see Permissions and Policies.
Access
public
Parameters
Parameter |
Type |
Required |
Description |
---|---|---|---|
|
Required |
Name of the group to update. If you’re changing the name of the group, this is the original name. [Constraints: The value must be between 1 and 128 characters, and must match the following regular expression pattern: |
|
|
Optional |
An associative array of parameters that can have the following keys:
|
Returns
Type |
Description |
---|---|
A |
Examples
Update an existing user group.
// Instantiate the class $iam = new AmazonIAM(); // Create a new parent group $response = $iam->update_group('xyz_group', array( 'NewGroupName' => 'wxyz_group' )); // Success? var_dump($response->isOK());Result:
bool(true)
Update an existing user group.
// Instantiate the class $iam = new AmazonIAM(); // Create a new parent group $response = $iam->update_group('abc_group', array( 'NewGroupName' => 'abcd_group' )); // Success? var_dump($response->isOK());Result:
bool(true)
Related Methods
Source
Method defined in services/iam.class.php | Toggle source view (7 lines) | View on GitHub