listGroupsForUser method

Future<ListGroupsForUserResponse> listGroupsForUser({ required String userName, String? marker, int? maxItems, })

Lists the IAM groups that the specified IAM user belongs to.

You can paginate the results using the MaxItems and Marker parameters.

May throw NoSuchEntityException. May throw ServiceFailureException.

Parameter userName : The name of the user to list groups for.

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 marker : Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

Parameter maxItems : Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

Implementation

Future<ListGroupsForUserResponse> listGroupsForUser({
  required String userName,
  String? marker,
  int? maxItems,
}) async {
  ArgumentError.checkNotNull(userName, 'userName');
  _s.validateStringLength(
    'userName',
    userName,
    1,
    128,
    isRequired: true,
  );
  _s.validateStringLength(
    'marker',
    marker,
    1,
    320,
  );
  _s.validateNumRange(
    'maxItems',
    maxItems,
    1,
    1000,
  );
  final $request = <String, dynamic>{};
  $request['UserName'] = userName;
  marker?.also((arg) => $request['Marker'] = arg);
  maxItems?.also((arg) => $request['MaxItems'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'ListGroupsForUser',
    version: '2010-05-08',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['ListGroupsForUserRequest'],
    shapes: shapes,
    resultWrapper: 'ListGroupsForUserResult',
  );
  return ListGroupsForUserResponse.fromXml($result);
}