delete_conditional_forwarder ¶

delete_conditional_forwarder(
    directory_id: DirectoryId,
    remote_domain_name: RemoteDomainName,
    *,
    config_overrides: Optional[DirectoryServiceClientConfig] = None,
) -> DeleteConditionalForwarderResult

Deletes a conditional forwarder that has been set up for your Amazon Web Services directory.

Parameters:

directory_id (DirectoryId) –

The directory ID for which you are deleting the conditional forwarder.
remote_domain_name (RemoteDomainName) –

The fully qualified domain name (FQDN) of the remote domain with which you are deleting the conditional forwarder.

Raises:

ClientException –

A client exception has occurred.
DirectoryUnavailableException –

The specified directory is unavailable.
EntityDoesNotExistException –

The specified entity could not be found.
InvalidParameterException –

One or more parameters are not valid.
ServiceException –

An exception has occurred in Directory Service.
UnsupportedOperationException –

The operation is not supported.
UnknownServiceError –

The service returned an error code this client does not model.

Examples:

To delete a conditional forwarder The following example deletes a conditional forwarder.

>>> client.delete_conditional_forwarder(directory_id='d-92654abfed', remote_domain_name='sales.example.com')

Source code in docs_src/capo_directory_service/_services/directory_service.py

def delete_conditional_forwarder(
    self,
    directory_id: "capo_directory_service.types.directory_id.DirectoryId",
    remote_domain_name: "capo_directory_service.types.remote_domain_name.RemoteDomainName",
    *,
    config_overrides: Optional[DirectoryServiceClientConfig] = None,
) -> "capo_directory_service.types.delete_conditional_forwarder_result.DeleteConditionalForwarderResult":
    """<p>Deletes a conditional forwarder that has been set up for your Amazon Web Services directory.</p>

    Args:
        directory_id: <p>The directory ID for which you are deleting the conditional forwarder.</p>
        remote_domain_name: <p>The fully qualified domain name (FQDN) of the remote domain with which you are deleting the conditional forwarder.</p>

    Raises:
        capo_directory_service.errors.client_exception.ClientException: <p>A client exception has occurred.</p>
        capo_directory_service.errors.directory_unavailable_exception.DirectoryUnavailableException: <p>The specified directory is unavailable.</p>
        capo_directory_service.errors.entity_does_not_exist_exception.EntityDoesNotExistException: <p>The specified entity could not be found.</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.

    Examples:
        To delete a conditional forwarder
        The following example deletes a conditional forwarder.

        >>> client.delete_conditional_forwarder(directory_id='d-92654abfed', remote_domain_name='sales.example.com')
    """

    def _handler(
        req: "OperationRequest[capo_directory_service.types.delete_conditional_forwarder_request.DeleteConditionalForwarderRequest]",
    ) -> OperationResponse[
        "capo_directory_service.types.delete_conditional_forwarder_result.DeleteConditionalForwarderResult"
    ]:
        import capo_directory_service._operations.directory_service_20150416.delete_conditional_forwarder

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteConditionalForwarder")
    )
    input_: capo_directory_service.types.delete_conditional_forwarder_request.DeleteConditionalForwarderRequest = {
        "directory_id": directory_id,
        "remote_domain_name": remote_domain_name,
    }

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