describeWorkspaceDirectories method

Future<DescribeWorkspaceDirectoriesResult> describeWorkspaceDirectories({ List<String>? directoryIds, List<DescribeWorkspaceDirectoriesFilter>? filters, int? limit, String? nextToken, List<String>? workspaceDirectoryNames, })

Describes the available directories that are registered with Amazon WorkSpaces.

May throw InvalidParameterValuesException.

Parameter directoryIds : The identifiers of the directories. If the value is null, all directories are retrieved.

Parameter filters : The filter condition for the WorkSpaces.

Parameter limit : The maximum number of directories to return.

Parameter nextToken : If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Parameter workspaceDirectoryNames : The names of the WorkSpace directories.

Implementation

Future<DescribeWorkspaceDirectoriesResult> describeWorkspaceDirectories({
  List<String>? directoryIds,
  List<DescribeWorkspaceDirectoriesFilter>? filters,
  int? limit,
  String? nextToken,
  List<String>? workspaceDirectoryNames,
}) async {
  _s.validateNumRange(
    'limit',
    limit,
    1,
    25,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'WorkspacesService.DescribeWorkspaceDirectories'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (directoryIds != null) 'DirectoryIds': directoryIds,
      if (filters != null) 'Filters': filters,
      if (limit != null) 'Limit': limit,
      if (nextToken != null) 'NextToken': nextToken,
      if (workspaceDirectoryNames != null)
        'WorkspaceDirectoryNames': workspaceDirectoryNames,
    },
  );

  return DescribeWorkspaceDirectoriesResult.fromJson(jsonResponse.body);
}