Skip to content

disable_ldaps

disable_ldaps(
    directory_id: DirectoryId,
    type: LDAPSType,
    *,
    config_overrides: Optional[DirectoryServiceClientConfig] = None,
) -> DisableLDAPSResult

Deactivates LDAP secure calls for the specified directory.

Parameters:

  • directory_id (DirectoryId) –

    The identifier of the directory.

  • type (LDAPSType) –

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

Raises:

Source code in docs_src/capo_directory_service/_services/directory_service.py
def disable_ldaps(
    self,
    directory_id: "capo_directory_service.types.directory_id.DirectoryId",
    type: "capo_directory_service.types.ldaps_type.LDAPSType",
    *,
    config_overrides: Optional[DirectoryServiceClientConfig] = None,
) -> "capo_directory_service.types.disable_ldaps_result.DisableLDAPSResult":
    """<p>Deactivates LDAP secure calls for the specified directory.</p>

    Args:
        directory_id: <p>The identifier of the directory.</p>
        type: <p>The type of LDAP security to enable. Currently only the value <code>Client</code> is supported.</p>

    Raises:
        capo_directory_service.errors.client_exception.ClientException: <p>A client exception has occurred.</p>
        capo_directory_service.errors.directory_does_not_exist_exception.DirectoryDoesNotExistException: <p>The specified directory does not exist in the system.</p>
        capo_directory_service.errors.directory_unavailable_exception.DirectoryUnavailableException: <p>The specified directory is unavailable.</p>
        capo_directory_service.errors.invalid_ldaps_status_exception.InvalidLDAPSStatusException: <p>The LDAP activities could not be performed because they are limited by the LDAPS status.</p>
        capo_directory_service.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more parameters are not valid.</p>
        capo_directory_service.errors.service_exception.ServiceException: <p>An exception has occurred in Directory Service.</p>
        capo_directory_service.errors.unsupported_operation_exception.UnsupportedOperationException: <p>The operation is not supported.</p>
        capo_directory_service.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_directory_service.types.disable_ldaps_request.DisableLDAPSRequest]",
    ) -> OperationResponse[
        "capo_directory_service.types.disable_ldaps_result.DisableLDAPSResult"
    ]:
        import capo_directory_service._operations.directory_service_20150416.disable_ldaps

        output, http_response = (
            capo_directory_service._operations.directory_service_20150416.disable_ldaps.disable_ldaps(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DisableLDAPS")
    )
    input_: capo_directory_service.types.disable_ldaps_request.DisableLDAPSRequest = {
        "directory_id": directory_id,
        "type": type,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output