listWorkspaces method

Future<ListWorkspacesResponse> listWorkspaces({
  1. int? maxResults,
  2. String? nextToken,
})

Retrieves a paginated list of workspaces. Use the nextToken parameter to retrieve additional results.

May throw AccessDeniedException. May throw InternalFailureException. May throw InvalidRequestException. May throw ThrottlingException.

Parameter maxResults : The maximum number of results to return for each paginated request. Default: 50.

Parameter nextToken : The token to be used for the next set of paginated results.

Implementation

Future<ListWorkspacesResponse> listWorkspaces({
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    250,
  );
  final $query = <String, List<String>>{
    if (maxResults != null) 'maxResults': [maxResults.toString()],
    if (nextToken != null) 'nextToken': [nextToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/workspaces',
    queryParams: $query,
    hostPrefix: 'api.',
    exceptionFnMap: _exceptionFns,
  );
  return ListWorkspacesResponse.fromJson(response);
}