listProfilingGroups method

Future<ListProfilingGroupsResponse> listProfilingGroups({ bool? includeDescription, int? maxResults, String? nextToken, })

Returns a list of profiling groups. The profiling groups are returned as ProfilingGroupDescription objects.

May throw InternalServerException. May throw ThrottlingException.

Parameter includeDescription : A Boolean value indicating whether to include a description. If true, then a list of ProfilingGroupDescription objects that contain detailed information about profiling groups is returned. If false, then a list of profiling group names is returned.

Parameter maxResults : The maximum number of profiling groups results returned by ListProfilingGroups in paginated output. When this parameter is used, ListProfilingGroups only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListProfilingGroups request with the returned nextToken value.

Parameter nextToken : The nextToken value returned from a previous paginated ListProfilingGroups request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

Implementation

Future<ListProfilingGroupsResponse> listProfilingGroups({
  bool? includeDescription,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    1000,
  );
  _s.validateStringLength(
    'nextToken',
    nextToken,
    1,
    64,
  );
  final $query = <String, List<String>>{
    if (includeDescription != null)
      'includeDescription': [includeDescription.toString()],
    if (maxResults != null) 'maxResults': [maxResults.toString()],
    if (nextToken != null) 'nextToken': [nextToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/profilingGroups',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListProfilingGroupsResponse.fromJson(response);
}