Deletes the specified virtual private gateway. You must first detach the virtual private gateway from the VPC. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.
Parameters:
-
vpn_gateway_id
(Optional[VpnGatewayId], default:
None
)
–
The ID of the virtual private gateway.
-
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:
Source code in docs_src/capo_ec2/_services/ec2.py
| def delete_vpn_gateway(
self,
*,
config_overrides: Optional[EC2ClientConfig] = None,
vpn_gateway_id: Optional["capo_ec2.types.vpn_gateway_id.VpnGatewayId"] = None,
dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> None:
"""<p>Deletes the specified virtual private gateway. You must first detach the virtual private gateway from the VPC. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.</p>
Args:
vpn_gateway_id: <p>The ID of the virtual private gateway.</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.
"""
def _handler(
req: "OperationRequest[capo_ec2.types.delete_vpn_gateway_request.DeleteVpnGatewayRequest]",
) -> OperationResponse[None]:
import capo_ec2._operations.amazon_ec2.delete_vpn_gateway
output, http_response = (
capo_ec2._operations.amazon_ec2.delete_vpn_gateway.delete_vpn_gateway(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteVpnGateway")
)
input_: capo_ec2.types.delete_vpn_gateway_request.DeleteVpnGatewayRequest = {}
if vpn_gateway_id is not None:
input_["vpn_gateway_id"] = vpn_gateway_id
if dry_run is not None:
input_["dry_run"] = dry_run
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|