describeLDAPSSettings method

Future<DescribeLDAPSSettingsResult> describeLDAPSSettings({
  1. required String directoryId,
  2. int? limit,
  3. String? nextToken,
  4. LDAPSType? type,
})

Describes the status of LDAP security for the specified directory.

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

Parameter directoryId : The identifier of the directory.

Parameter limit : Specifies the number of items that should be displayed on one page.

Parameter nextToken : The type of next token used for pagination.

Parameter type : The type of LDAP security to enable. Currently only the value Client is supported.

Implementation

Future<DescribeLDAPSSettingsResult> describeLDAPSSettings({
  required String directoryId,
  int? limit,
  String? nextToken,
  LDAPSType? type,
}) async {
  ArgumentError.checkNotNull(directoryId, 'directoryId');
  _s.validateNumRange(
    'limit',
    limit,
    1,
    50,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'DirectoryService_20150416.DescribeLDAPSSettings'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'DirectoryId': directoryId,
      if (limit != null) 'Limit': limit,
      if (nextToken != null) 'NextToken': nextToken,
      if (type != null) 'Type': type.toValue(),
    },
  );

  return DescribeLDAPSSettingsResult.fromJson(jsonResponse.body);
}