describeDomainControllers method

Future<DescribeDomainControllersResult> describeDomainControllers({
  1. required String directoryId,
  2. List<String>? domainControllerIds,
  3. int? limit,
  4. String? nextToken,
})

Provides information about any domain controllers in your directory.

May throw EntityDoesNotExistException. May throw InvalidNextTokenException. May throw InvalidParameterException. May throw ClientException. May throw ServiceException. May throw UnsupportedOperationException.

Parameter directoryId : Identifier of the directory for which to retrieve the domain controller information.

Parameter domainControllerIds : A list of identifiers for the domain controllers whose information will be provided.

Parameter limit : The maximum number of items to return.

Parameter nextToken : The DescribeDomainControllers.NextToken value from a previous call to DescribeDomainControllers. Pass null if this is the first call.

Implementation

Future<DescribeDomainControllersResult> describeDomainControllers({
  required String directoryId,
  List<String>? domainControllerIds,
  int? limit,
  String? nextToken,
}) async {
  ArgumentError.checkNotNull(directoryId, 'directoryId');
  _s.validateNumRange(
    'limit',
    limit,
    0,
    1152921504606846976,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'DirectoryService_20150416.DescribeDomainControllers'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'DirectoryId': directoryId,
      if (domainControllerIds != null)
        'DomainControllerIds': domainControllerIds,
      if (limit != null) 'Limit': limit,
      if (nextToken != null) 'NextToken': nextToken,
    },
  );

  return DescribeDomainControllersResult.fromJson(jsonResponse.body);
}