describeUserGroups method

Future<DescribeUserGroupsResult> describeUserGroups({ String? marker, int? maxRecords, String? userGroupId, })

Returns a list of user groups.

May throw UserGroupNotFoundFault. May throw InvalidParameterCombinationException.

Parameter marker : An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >

Parameter maxRecords : The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Parameter userGroupId : The ID of the user group.

Implementation

Future<DescribeUserGroupsResult> describeUserGroups({
  String? marker,
  int? maxRecords,
  String? userGroupId,
}) async {
  final $request = <String, dynamic>{};
  marker?.also((arg) => $request['Marker'] = arg);
  maxRecords?.also((arg) => $request['MaxRecords'] = arg);
  userGroupId?.also((arg) => $request['UserGroupId'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeUserGroups',
    version: '2015-02-02',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeUserGroupsMessage'],
    shapes: shapes,
    resultWrapper: 'DescribeUserGroupsResult',
  );
  return DescribeUserGroupsResult.fromXml($result);
}