Skip to content

delete_vpn_concentrator

delete_vpn_concentrator(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    vpn_concentrator_id: Optional[VpnConcentratorId] = None,
    dry_run: Optional[Boolean] = None,
) -> DeleteVpnConcentratorResult

Deletes the specified VPN concentrator.

Parameters:

  • vpn_concentrator_id (Optional[VpnConcentratorId], default: None ) –

    The ID of the VPN concentrator to delete.

  • 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_concentrator(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    vpn_concentrator_id: Optional[
        "capo_ec2.types.vpn_concentrator_id.VpnConcentratorId"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.delete_vpn_concentrator_result.DeleteVpnConcentratorResult":
    """<p>Deletes the specified VPN concentrator.</p>

    Args:
        vpn_concentrator_id: <p>The ID of the VPN concentrator to delete.</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_concentrator_request.DeleteVpnConcentratorRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.delete_vpn_concentrator_result.DeleteVpnConcentratorResult"
    ]:
        import capo_ec2._operations.amazon_ec2.delete_vpn_concentrator

        output, http_response = (
            capo_ec2._operations.amazon_ec2.delete_vpn_concentrator.delete_vpn_concentrator(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteVpnConcentrator")
    )
    input_: capo_ec2.types.delete_vpn_concentrator_request.DeleteVpnConcentratorRequest = {}
    if vpn_concentrator_id is not None:
        input_["vpn_concentrator_id"] = vpn_concentrator_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