listWorkspaceInstances method

Future<ListWorkspaceInstancesResponse> listWorkspaceInstances({ int? maxResults, String? nextToken, List<ProvisionStateEnum>? provisionStates, })

Retrieves a collection of WorkSpaces Instances based on specified filters.

May throw AccessDeniedException. May throw InternalServerException. May throw ThrottlingException. May throw ValidationException.

Parameter maxResults : Maximum number of WorkSpaces Instances to return in a single response.

Parameter nextToken : Pagination token for retrieving subsequent pages of WorkSpaces Instances.

Parameter provisionStates : Filter WorkSpaces Instances by their current provisioning states.

Implementation

Future<ListWorkspaceInstancesResponse> listWorkspaceInstances({
  int? maxResults,
  String? nextToken,
  List<ProvisionStateEnum>? provisionStates,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    25,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.0',
    'X-Amz-Target': 'EUCMIFrontendAPIService.ListWorkspaceInstances'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (maxResults != null) 'MaxResults': maxResults,
      if (nextToken != null) 'NextToken': nextToken,
      if (provisionStates != null)
        'ProvisionStates': provisionStates.map((e) => e.value).toList(),
    },
  );

  return ListWorkspaceInstancesResponse.fromJson(jsonResponse.body);
}