listUserGroups method

Future<ListUserGroupsResponse> listUserGroups({ required String awsAccountId, required String namespace, required String userName, int? maxResults, String? nextToken, })

Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.

May throw AccessDeniedException. May throw InvalidParameterValueException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw PreconditionNotMetException. May throw InternalFailureException. May throw ResourceUnavailableException.

Parameter awsAccountId : The AWS account ID that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

Parameter namespace : The namespace. Currently, you should set this to default.

Parameter userName : The Amazon QuickSight user name that you want to list group memberships for.

Parameter maxResults : The maximum number of results to return from this request.

Parameter nextToken : A pagination token that can be used in a subsequent request.

Implementation

Future<ListUserGroupsResponse> listUserGroups({
  required String awsAccountId,
  required String namespace,
  required String userName,
  int? maxResults,
  String? nextToken,
}) async {
  ArgumentError.checkNotNull(awsAccountId, 'awsAccountId');
  _s.validateStringLength(
    'awsAccountId',
    awsAccountId,
    12,
    12,
    isRequired: true,
  );
  ArgumentError.checkNotNull(namespace, 'namespace');
  _s.validateStringLength(
    'namespace',
    namespace,
    0,
    64,
    isRequired: true,
  );
  ArgumentError.checkNotNull(userName, 'userName');
  _s.validateStringLength(
    'userName',
    userName,
    1,
    1152921504606846976,
    isRequired: true,
  );
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  final $query = <String, List<String>>{
    if (maxResults != null) 'max-results': [maxResults.toString()],
    if (nextToken != null) 'next-token': [nextToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri:
        '/accounts/${Uri.encodeComponent(awsAccountId)}/namespaces/${Uri.encodeComponent(namespace)}/users/${Uri.encodeComponent(userName)}/groups',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListUserGroupsResponse.fromJson(response);
}