updateUser method

Future<void> updateUser({ required String brokerId, required String username, bool? consoleAccess, List<String>? groups, String? password, })

Updates the information for an ActiveMQ user.

May throw NotFoundException. May throw BadRequestException. May throw InternalServerErrorException. May throw ConflictException. May throw ForbiddenException.

Parameter brokerId : The unique ID that Amazon MQ generates for the broker.

Parameter username : Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

Parameter consoleAccess : Enables access to the the ActiveMQ Web Console for the ActiveMQ user.

Parameter groups : The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

Parameter password : The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas.

Implementation

Future<void> updateUser({
  required String brokerId,
  required String username,
  bool? consoleAccess,
  List<String>? groups,
  String? password,
}) async {
  ArgumentError.checkNotNull(brokerId, 'brokerId');
  ArgumentError.checkNotNull(username, 'username');
  final $payload = <String, dynamic>{
    if (consoleAccess != null) 'consoleAccess': consoleAccess,
    if (groups != null) 'groups': groups,
    if (password != null) 'password': password,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'PUT',
    requestUri:
        '/v1/brokers/${Uri.encodeComponent(brokerId)}/users/${Uri.encodeComponent(username)}',
    exceptionFnMap: _exceptionFns,
  );
}