Skip to content

Update User

iam_update_user R Documentation

Updates the name and/or the path of the specified IAM user

Description

Updates the name and/or the path of the specified IAM user.

You should understand the implications of changing an IAM user's path or name. For more information, see Renaming an IAM user and Renaming an IAM group in the IAM User Guide.

To change a user name, the requester must have appropriate permissions on both the source object and the target object. For example, to change Bob to Robert, the entity making the request must have permission on Bob and Robert, or must have permission on all (*). For more information about permissions, see Permissions and policies.

Usage

iam_update_user(UserName, NewPath, NewUserName)

Arguments

UserName

[required] Name of the user to update. If you're changing the name of the user, this is the original user name.

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: _+=,.@-

NewPath

New path for the IAM user. Include this parameter only if you're changing the user's path.

This parameter allows (through 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 ! (U+0021) through the DEL character (⁠U+007F⁠), including most punctuation characters, digits, and upper and lowercased letters.

NewUserName

New name for the user. Include this parameter only if you're changing the user's name.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

Value

An empty list.

Request syntax

svc$update_user(
  UserName = "string",
  NewPath = "string",
  NewUserName = "string"
)

Examples

## Not run: 
# The following command changes the name of the IAM user Bob to Robert. It
# does not change the user's path.
svc$update_user(
  NewUserName = "Robert",
  UserName = "Bob"
)

## End(Not run)