Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions,
see Getting Started with Amazon Web Services in China
(PDF).
Use RemoveUserFromGroup
with an Amazon SDK or CLI
The following code examples show how to use RemoveUserFromGroup
.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in
context in the following code example:
- .NET
-
- Amazon SDK for .NET
-
/// <summary>
/// Remove a user from an IAM group.
/// </summary>
/// <param name="userName">The username of the user to remove.</param>
/// <param name="groupName">The name of the IAM group to remove the user from.</param>
/// <returns>A Boolean value indicating the success of the action.</returns>
public async Task<bool> RemoveUserFromGroupAsync(string userName, string groupName)
{
// Remove the user from the group.
var removeUserRequest = new RemoveUserFromGroupRequest()
{
UserName = userName,
GroupName = groupName,
};
var response = await _IAMService.RemoveUserFromGroupAsync(removeUserRequest);
return response.HttpStatusCode == HttpStatusCode.OK;
}
- CLI
-
- Amazon CLI
-
To remove a user from an IAM group
The following remove-user-from-group
command removes the user named Bob
from the IAM group named Admins
.
aws iam remove-user-from-group \
--user-name Bob \
--group-name Admins
This command produces no output.
For more information, see Adding and removing users in an IAM user group in the Amazon IAM User Guide.
- PowerShell
-
- Tools for PowerShell
-
Example 1: This example removes the IAM user Bob
from the group Testers
.
Remove-IAMUserFromGroup -GroupName Testers -UserName Bob
Example 2: This example finds any groups of which IAM user Theresa
is a member, and then removes Theresa
from those groups.
$groups = Get-IAMGroupForUser -UserName Theresa
foreach ($group in $groups) { Remove-IAMUserFromGroup -GroupName $group.GroupName -UserName Theresa -Force }
Example 3: This example shows an alternate way of removing the IAM user Bob
from the Testers
group.
Get-IAMGroupForUser -UserName Bob | Remove-IAMUserFromGroup -UserName Bob -GroupName Testers -Force
For a complete list of Amazon SDK developer guides and code examples, see
Using IAM with an Amazon SDK.
This topic also includes information about getting started and details about previous SDK versions.