Skip to content

Remove User From Group

iam_remove_user_from_group R Documentation

Removes the specified user from the specified group

Description

Removes the specified user from the specified group.

Usage

iam_remove_user_from_group(GroupName, UserName)

Arguments

GroupName

[required] The name of the group to update.

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

UserName

[required] The name of the user to remove.

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

Value

An empty list.

Request syntax

svc$remove_user_from_group(
  GroupName = "string",
  UserName = "string"
)

Examples

## Not run: 
# The following command removes the user named Bob from the IAM group
# named Admins.
svc$remove_user_from_group(
  GroupName = "Admins",
  UserName = "Bob"
)

## End(Not run)