DisassociateClientVpnTargetNetwork
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
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
- AssociationId
-
The ID of the target network association.
Type: String
Required: Yes
- ClientVpnEndpointId
-
The ID of the Client VPN endpoint from which to disassociate the target network.
Type: String
Required: Yes
- DryRun
-
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 isUnauthorizedOperation.Type: Boolean
Required: No
Response Elements
The following elements are returned by the service.
- associationId
-
The ID of the target network association.
Type: String
- requestId
-
The ID of the request.
Type: String
- status
-
The current state of the target network association.
Type: AssociationStatus object
Errors
For information about the errors that are common to all actions, see Common client error codes.
Examples
Example
This example disassociates a target network from a Client VPN endpoint.
Sample Request
https://ec2.amazonaws.com/?Action=DisassociateClientVpnTargetNetwork
&ClientVpnEndpointId=cvpn-endpoint-00c5d11fc4EXAMPLE
&AssociationId=cvpn-assoc-0bc4bd8cecEXAMPLE
&AUTHPARAMSSample Response
<DisassociateClientVpnTargetNetworkResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
<requestId>61312648-93ec-4a86-a1d1-098c9EXAMPLE</requestId>
<status>
<code>disassociating</code>
</status>
<associationId>cvpn-assoc-0bc4bd8cecEXAMPLE</associationId>
</DisassociateClientVpnTargetNetworkResponse>See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
