delete_route_server_peer ¶

delete_route_server_peer(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    route_server_peer_id: Optional[RouteServerPeerId] = None,
    dry_run: Optional[Boolean] = None,
) -> DeleteRouteServerPeerResult

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:

route_server_peer_id (Optional[RouteServerPeerId], default: None ) –

The ID of the route server peer to delete.
dry_run (Optional[Boolean], default: 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.

Raises:

UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_ec2/_services/ec2.py

def delete_route_server_peer(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    route_server_peer_id: Optional[
        "capo_ec2.types.route_server_peer_id.RouteServerPeerId"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.delete_route_server_peer_result.DeleteRouteServerPeerResult":
    """<p>Deletes the specified BGP peer from a route server.</p> <p>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:</p> <ul> <li> <p>Have an elastic network interface in the VPC</p> </li> <li> <p>Support BGP (Border Gateway Protocol)</p> </li> <li> <p>Can initiate BGP sessions</p> </li> </ul>

    Args:
        route_server_peer_id: <p>The ID of the route server peer to delete.</p>
        dry_run: <p>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 <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_route_server_peer_request.DeleteRouteServerPeerRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.delete_route_server_peer_result.DeleteRouteServerPeerResult"
    ]:
        import capo_ec2._operations.amazon_ec2.delete_route_server_peer

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteRouteServerPeer")
    )
    input_: capo_ec2.types.delete_route_server_peer_request.DeleteRouteServerPeerRequest = {}
    if route_server_peer_id is not None:
        input_["route_server_peer_id"] = route_server_peer_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