EC2 / Client / disassociate_client_vpn_target_network

disassociate_client_vpn_target_network#

EC2.Client.disassociate_client_vpn_target_network(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.disassociate_client_vpn_target_network(
    ClientVpnEndpointId='string',
    AssociationId='string',
    DryRun=True|False
)
Parameters:

  • ClientVpnEndpointId (string) –

    [REQUIRED]

    The ID of the Client VPN endpoint from which to disassociate the target network.

  • AssociationId (string) –

    [REQUIRED]

    The ID of the target network association.

  • DryRun (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'AssociationId': 'string',
    'Status': {
        'Code': 'associating'|'associated'|'association-failed'|'disassociating'|'disassociated',
        'Message': 'string'
    }
}

Response Structure

  • (dict) –

    • AssociationId (string) –

      The ID of the target network association.

    • Status (dict) –

      The current state of the target network association.

      • Code (string) –

        The state of the target network association.

      • Message (string) –

        A message about the status of the target network association, if applicable.