disassociate_client_vpn_target_network `async` ¶

disassociate_client_vpn_target_network(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    client_vpn_endpoint_id: Optional[ClientVpnEndpointId] = None,
    association_id: Optional[String] = None,
    dry_run: Optional[Boolean] = None,
) -> DisassociateClientVpnTargetNetworkResult

Disassociates a target network from the specified Client VPN endpoint. When you disassociate the last target network from a Client VPN, the following happens:

The route that was automatically added for the VPC is deleted
All active client connections are terminated
New client connections are disallowed
The Client VPN endpoint's status changes to pending-associate

Parameters:

client_vpn_endpoint_id (Optional[ClientVpnEndpointId], default: None ) –

The ID of the Client VPN endpoint from which to disassociate the target network.
association_id (Optional[String], default: None ) –

The ID of the target network association.
dry_run (Optional[Boolean], default: None ) –

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Raises:

UnknownServiceError –

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

Source code in docs_src/capo_ec2/_services/async_ec2.py

async def disassociate_client_vpn_target_network(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    client_vpn_endpoint_id: Optional[
        "capo_ec2.types.client_vpn_endpoint_id.ClientVpnEndpointId"
    ] = None,
    association_id: Optional["capo_ec2.types.string.String"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.disassociate_client_vpn_target_network_result.DisassociateClientVpnTargetNetworkResult":
    """<p>Disassociates a target network from the specified Client VPN endpoint. When you disassociate the last target network from a Client VPN, the following happens:</p> <ul> <li> <p>The route that was automatically added for the VPC is deleted</p> </li> <li> <p>All active client connections are terminated</p> </li> <li> <p>New client connections are disallowed</p> </li> <li> <p>The Client VPN endpoint's status changes to <code>pending-associate</code> </p> </li> </ul>

    Args:
        client_vpn_endpoint_id: <p>The ID of the Client VPN endpoint from which to disassociate the target network.</p>
        association_id: <p>The ID of the target network association.</p>
        dry_run: <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.disassociate_client_vpn_target_network_request.DisassociateClientVpnTargetNetworkRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.disassociate_client_vpn_target_network_result.DisassociateClientVpnTargetNetworkResult"
    ]:
        import capo_ec2._operations.amazon_ec2.disassociate_client_vpn_target_network

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.disassociate_client_vpn_target_network.async_disassociate_client_vpn_target_network(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DisassociateClientVpnTargetNetwork")
    )
    input_: capo_ec2.types.disassociate_client_vpn_target_network_request.DisassociateClientVpnTargetNetworkRequest = {}
    if client_vpn_endpoint_id is not None:
        input_["client_vpn_endpoint_id"] = client_vpn_endpoint_id
    if association_id is not None:
        input_["association_id"] = association_id
    if dry_run is not None:
        input_["dry_run"] = dry_run

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

disassociate_client_vpn_target_network async ¶

disassociate_client_vpn_target_network `async` ¶