EC2 / Client / delete_client_vpn_route

delete_client_vpn_route#

EC2.Client.delete_client_vpn_route(**kwargs)#

Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using the CreateClientVpnRoute action. You cannot delete routes that were automatically added when associating a subnet. To remove routes that have been automatically added, disassociate the target subnet from the Client VPN endpoint.

See also: AWS API Documentation

Request Syntax

response = client.delete_client_vpn_route(
    ClientVpnEndpointId='string',
    TargetVpcSubnetId='string',
    DestinationCidrBlock='string',
    DryRun=True|False
)
Parameters:

  • ClientVpnEndpointId (string) –

    [REQUIRED]

    The ID of the Client VPN endpoint from which the route is to be deleted.

  • TargetVpcSubnetId (string) – The ID of the target subnet used by the route.

  • DestinationCidrBlock (string) –

    [REQUIRED]

    The IPv4 address range, in CIDR notation, of the route to be deleted.

  • 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

{
    'Status': {
        'Code': 'creating'|'active'|'failed'|'deleting',
        'Message': 'string'
    }
}

Response Structure

  • (dict) –

    • Status (dict) –

      The current state of the route.

      • Code (string) –

        The state of the Client VPN endpoint route.

      • Message (string) –

        A message about the status of the Client VPN endpoint route, if applicable.