updateUser method

Future<void> updateUser({
  1. required String userName,
  2. String? newPath,
  3. String? newUserName,
})

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

May throw NoSuchEntityException. May throw LimitExceededException. May throw EntityAlreadyExistsException. May throw EntityTemporarilyUnmodifiableException. May throw ConcurrentModificationException. May throw ServiceFailureException.

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

Parameter 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 ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

Parameter 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".

Implementation

Future<void> updateUser({
  required String userName,
  String? newPath,
  String? newUserName,
}) async {
  ArgumentError.checkNotNull(userName, 'userName');
  _s.validateStringLength(
    'userName',
    userName,
    1,
    128,
    isRequired: true,
  );
  _s.validateStringLength(
    'newPath',
    newPath,
    1,
    512,
  );
  _s.validateStringLength(
    'newUserName',
    newUserName,
    1,
    64,
  );
  final $request = <String, dynamic>{};
  $request['UserName'] = userName;
  newPath?.also((arg) => $request['NewPath'] = arg);
  newUserName?.also((arg) => $request['NewUserName'] = arg);
  await _protocol.send(
    $request,
    action: 'UpdateUser',
    version: '2010-05-08',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['UpdateUserRequest'],
    shapes: shapes,
  );
}