Skip to content

update_conditional_forwarder async

update_conditional_forwarder(
    directory_id: DirectoryId,
    remote_domain_name: RemoteDomainName,
    *,
    config_overrides: Optional[AsyncDirectoryServiceClientConfig] = None,
    dns_ip_addrs: Optional[DnsIpAddrs] = None,
    dns_ipv6_addrs: Optional[DnsIpv6Addrs] = None,
) -> UpdateConditionalForwarderResult

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

Parameters:

  • directory_id (DirectoryId) –

    The directory ID of the Amazon Web Services directory for which to update the conditional forwarder.

  • remote_domain_name (RemoteDomainName) –

    The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.

  • dns_ip_addrs (Optional[DnsIpAddrs], default: None ) –

    The updated IP addresses of the remote DNS server associated with the conditional forwarder.

  • dns_ipv6_addrs (Optional[DnsIpv6Addrs], default: None ) –

    The updated IPv6 addresses of the remote DNS server associated with the conditional forwarder.

Raises:

Examples:

To update a conditional forwarder The following example updates a conditional forwarder for a specified directory.

>>> await client.update_conditional_forwarder(directory_id='d-92654abfed', remote_domain_name='sales.example.com', dns_ip_addrs=['172.168.101.11'])
Source code in docs_src/capo_directory_service/_services/async_directory_service.py
async def update_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[AsyncDirectoryServiceClientConfig] = None,
    dns_ip_addrs: Optional[
        "capo_directory_service.types.dns_ip_addrs.DnsIpAddrs"
    ] = None,
    dns_ipv6_addrs: Optional[
        "capo_directory_service.types.dns_ipv6_addrs.DnsIpv6Addrs"
    ] = None,
) -> "capo_directory_service.types.update_conditional_forwarder_result.UpdateConditionalForwarderResult":
    """<p>Updates a conditional forwarder that has been set up for your Amazon Web Services directory.</p>

    Args:
        directory_id: <p>The directory ID of the Amazon Web Services directory for which to update the conditional forwarder.</p>
        remote_domain_name: <p>The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.</p>
        dns_ip_addrs: <p>The updated IP addresses of the remote DNS server associated with the conditional forwarder.</p>
        dns_ipv6_addrs: <p>The updated IPv6 addresses of the remote DNS server associated with 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 update a conditional forwarder
        The following example updates a conditional forwarder for a specified directory.

        >>> await client.update_conditional_forwarder(directory_id='d-92654abfed', remote_domain_name='sales.example.com', dns_ip_addrs=['172.168.101.11'])
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_directory_service.types.update_conditional_forwarder_request.UpdateConditionalForwarderRequest]",
    ) -> AsyncOperationResponse[
        "capo_directory_service.types.update_conditional_forwarder_result.UpdateConditionalForwarderResult"
    ]:
        import capo_directory_service._operations.directory_service_20150416.update_conditional_forwarder

        (
            output,
            http_response,
        ) = await capo_directory_service._operations.directory_service_20150416.update_conditional_forwarder.async_update_conditional_forwarder(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateConditionalForwarder")
    )
    input_: capo_directory_service.types.update_conditional_forwarder_request.UpdateConditionalForwarderRequest = {
        "directory_id": directory_id,
        "remote_domain_name": remote_domain_name,
    }
    if dns_ip_addrs is not None:
        input_["dns_ip_addrs"] = dns_ip_addrs
    if dns_ipv6_addrs is not None:
        input_["dns_ipv6_addrs"] = dns_ipv6_addrs

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output