delete_route_server_peer¶
Operation¶
delete_route_server_peer
¶
delete_route_server_peer(request: DeleteRouteServerPeerInput | DeleteRouteServerPeerInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteRouteServerPeerInputDict]) -> DeleteRouteServerPeerOutput
Deletes the specified BGP peer from a route server.
A route server peer is a session between a route server endpoint and the device deployed in Amazon Web Services (such as a firewall appliance or other network security function running on an EC2 instance). The device must meet these requirements:
-
Have an elastic network interface in the VPC
-
Support BGP (Border Gateway Protocol)
-
Can initiate BGP sessions
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeleteRouteServerPeerInput | DeleteRouteServerPeerInputDict | 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[DeleteRouteServerPeerInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteRouteServerPeerOutput
|
An instance of |
delete_route_server_peer
async
¶
delete_route_server_peer(request: DeleteRouteServerPeerInput | DeleteRouteServerPeerInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteRouteServerPeerInputDict]) -> DeleteRouteServerPeerOutput
Deletes the specified BGP peer from a route server.
A route server peer is a session between a route server endpoint and the device deployed in Amazon Web Services (such as a firewall appliance or other network security function running on an EC2 instance). The device must meet these requirements:
-
Have an elastic network interface in the VPC
-
Support BGP (Border Gateway Protocol)
-
Can initiate BGP sessions
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeleteRouteServerPeerInput | DeleteRouteServerPeerInputDict | 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[DeleteRouteServerPeerInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteRouteServerPeerOutput
|
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.
DeleteRouteServerPeerInputDict
¶
Bases: TypedDict
Dictionary form of DeleteRouteServerPeerInput.
Attributes¶
dry_run
instance-attribute
¶
dry_run: bool | None
A check for 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.
DeleteRouteServerPeerInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeleteRouteServerPeerInput structure.
Attributes¶
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
A check for 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¶
DeleteRouteServerPeerOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeleteRouteServerPeerOutput 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.
route_server_peer
class-attribute
instance-attribute
¶
route_server_peer: RouteServerPeer | None = ...
Information about the deleted route server peer.