delete_customer_gateway ¶

def delete_customer_gateway(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    customer_gateway_id: Optional[
        "capo_ec2.types.customer_gateway_id.CustomerGatewayId"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> None:
    """<p>Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.</p>

    Args:
        customer_gateway_id: <p>The ID of the customer 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.

    Examples:
        To delete a customer gateway
        This example deletes the specified customer gateway.

        >>> client.delete_customer_gateway(customer_gateway_id='cgw-0e11f167')
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.delete_customer_gateway_request.DeleteCustomerGatewayRequest]",
    ) -> OperationResponse[None]:
        import capo_ec2._operations.amazon_ec2.delete_customer_gateway

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteCustomerGateway")
    )
    input_: capo_ec2.types.delete_customer_gateway_request.DeleteCustomerGatewayRequest = {}
    if customer_gateway_id is not None:
        input_["customer_gateway_id"] = customer_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