delete_customer_gateway¶
Operation¶
delete_customer_gateway
async
¶
delete_customer_gateway(request: DeleteCustomerGatewayInput | DeleteCustomerGatewayInputDict, /, *, plugins: list[Plugin] | None = None) -> DeleteCustomerGatewayOutput
delete_customer_gateway(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteCustomerGatewayInputDict]) -> DeleteCustomerGatewayOutput
Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DeleteCustomerGatewayOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
DeleteCustomerGatewayInput
dataclass
¶
Bases: _SerdeShape
Contains the parameters for DeleteCustomerGateway.
Attributes¶
customer_gateway_id
class-attribute
instance-attribute
¶
customer_gateway_id: str | None = ...
The ID of the customer gateway.
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | 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.
Dictionaries¶
DeleteCustomerGatewayInputDict
¶
Bases: TypedDict
Dictionary form of DeleteCustomerGatewayInput.
Attributes¶
customer_gateway_id
instance-attribute
¶
The ID of the customer gateway.
dry_run
instance-attribute
¶
dry_run: bool | 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.
Output¶
DeleteCustomerGatewayOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeleteCustomerGatewayOutput structure.