delete_client_vpn_route¶
Operation¶
delete_client_vpn_route
¶
delete_client_vpn_route(request: DeleteClientVpnRouteInput | DeleteClientVpnRouteInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteClientVpnRouteInputDict]) -> DeleteClientVpnRouteOutput
Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using the CreateClientVpnRoute action. You cannot delete routes that were automatically added when associating a subnet. To remove routes that have been automatically added, disassociate the target subnet from the Client VPN endpoint.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeleteClientVpnRouteInput | DeleteClientVpnRouteInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[DeleteClientVpnRouteInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteClientVpnRouteOutput
|
An instance of |
delete_client_vpn_route
async
¶
delete_client_vpn_route(request: DeleteClientVpnRouteInput | DeleteClientVpnRouteInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteClientVpnRouteInputDict]) -> DeleteClientVpnRouteOutput
Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using the CreateClientVpnRoute action. You cannot delete routes that were automatically added when associating a subnet. To remove routes that have been automatically added, disassociate the target subnet from the Client VPN endpoint.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeleteClientVpnRouteInput | DeleteClientVpnRouteInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[DeleteClientVpnRouteInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteClientVpnRouteOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
DeleteClientVpnRouteInputDict
¶
Bases: TypedDict
Dictionary form of DeleteClientVpnRouteInput.
Attributes¶
client_vpn_endpoint_id
instance-attribute
¶
The ID of the Client VPN endpoint from which the route is to be deleted.
destination_cidr_block
instance-attribute
¶
The IPv4 address range, in CIDR notation, of the route to be deleted.
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.
DeleteClientVpnRouteInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeleteClientVpnRouteInput structure.
Attributes¶
client_vpn_endpoint_id
class-attribute
instance-attribute
¶
client_vpn_endpoint_id: str | None = ...
The ID of the Client VPN endpoint from which the route is to be deleted.
destination_cidr_block
class-attribute
instance-attribute
¶
destination_cidr_block: str | None = ...
The IPv4 address range, in CIDR notation, of the route to be deleted.
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.
Output¶
DeleteClientVpnRouteOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeleteClientVpnRouteOutput structure.
Attributes¶
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
status
class-attribute
instance-attribute
¶
status: ClientVpnRouteStatus | None = ...
The current state of the route.