delete_client_vpn_endpoint `async` ¶

delete_client_vpn_endpoint(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    client_vpn_endpoint_id: Optional[ClientVpnEndpointId] = None,
    dry_run: Optional[Boolean] = None,
) -> DeleteClientVpnEndpointResult

Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint.

Parameters:

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

The ID of the Client VPN to be deleted.
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 delete_client_vpn_endpoint(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    client_vpn_endpoint_id: Optional[
        "capo_ec2.types.client_vpn_endpoint_id.ClientVpnEndpointId"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> (
    "capo_ec2.types.delete_client_vpn_endpoint_result.DeleteClientVpnEndpointResult"
):
    """<p>Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint.</p>

    Args:
        client_vpn_endpoint_id: <p>The ID of the Client VPN to be deleted.</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.delete_client_vpn_endpoint_request.DeleteClientVpnEndpointRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.delete_client_vpn_endpoint_result.DeleteClientVpnEndpointResult"
    ]:
        import capo_ec2._operations.amazon_ec2.delete_client_vpn_endpoint

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteClientVpnEndpoint")
    )
    input_: capo_ec2.types.delete_client_vpn_endpoint_request.DeleteClientVpnEndpointRequest = {}
    if client_vpn_endpoint_id is not None:
        input_["client_vpn_endpoint_id"] = client_vpn_endpoint_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

delete_client_vpn_endpoint async ¶

delete_client_vpn_endpoint `async` ¶