We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.
Protected
Deletes the specified BGP peer on the specified virtual interface with the specified customer address and ASN.
You cannot delete the last BGP peer from a virtual interface.
Use a bare-bones client and the command you need to make an API call.
import { DirectConnectClient, DeleteBGPPeerCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import// const { DirectConnectClient, DeleteBGPPeerCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS importconst client = new DirectConnectClient(config);const input = { // DeleteBGPPeerRequest virtualInterfaceId: "STRING_VALUE", asn: Number("int"), customerAddress: "STRING_VALUE", bgpPeerId: "STRING_VALUE",};const command = new DeleteBGPPeerCommand(input);const response = await client.send(command);// { // DeleteBGPPeerResponse// virtualInterface: { // VirtualInterface// ownerAccount: "STRING_VALUE",// virtualInterfaceId: "STRING_VALUE",// location: "STRING_VALUE",// connectionId: "STRING_VALUE",// virtualInterfaceType: "STRING_VALUE",// virtualInterfaceName: "STRING_VALUE",// vlan: Number("int"),// asn: Number("int"),// amazonSideAsn: Number("long"),// authKey: "STRING_VALUE",// amazonAddress: "STRING_VALUE",// customerAddress: "STRING_VALUE",// addressFamily: "ipv4" || "ipv6",// virtualInterfaceState: "confirming" || "verifying" || "pending" || "available" || "down" || "deleting" || "deleted" || "rejected" || "unknown",// customerRouterConfig: "STRING_VALUE",// mtu: Number("int"),// jumboFrameCapable: true || false,// virtualGatewayId: "STRING_VALUE",// directConnectGatewayId: "STRING_VALUE",// routeFilterPrefixes: [ // RouteFilterPrefixList// { // RouteFilterPrefix// cidr: "STRING_VALUE",// },// ],// bgpPeers: [ // BGPPeerList// { // BGPPeer// bgpPeerId: "STRING_VALUE",// asn: Number("int"),// authKey: "STRING_VALUE",// addressFamily: "ipv4" || "ipv6",// amazonAddress: "STRING_VALUE",// customerAddress: "STRING_VALUE",// bgpPeerState: "verifying" || "pending" || "available" || "deleting" || "deleted",// bgpStatus: "up" || "down" || "unknown",// awsDeviceV2: "STRING_VALUE",// awsLogicalDeviceId: "STRING_VALUE",// },// ],// region: "STRING_VALUE",// awsDeviceV2: "STRING_VALUE",// awsLogicalDeviceId: "STRING_VALUE",// tags: [ // TagList// { // Tag// key: "STRING_VALUE", // required// value: "STRING_VALUE",// },// ],// siteLinkEnabled: true || false,// },// };
DeleteBGPPeerCommandInput
DeleteBGPPeerCommandOutput
input
response
config
DirectConnectClientException (client fault)
One or more parameters are not valid.
DirectConnectServerException (server fault)
A server-side error occurred.
DirectConnectServiceException
Base exception class for all service exceptions from DirectConnect service.
Readonly
Static
Deletes the specified BGP peer on the specified virtual interface with the specified customer address and ASN.
You cannot delete the last BGP peer from a virtual interface.
Example
Use a bare-bones client and the command you need to make an API call.
Param
DeleteBGPPeerCommandInput
Returns
DeleteBGPPeerCommandOutput
See
input
shape.response
shape.config
shape.Throws
DirectConnectClientException (client fault)
One or more parameters are not valid.
Throws
DirectConnectServerException (server fault)
A server-side error occurred.
Throws
DirectConnectServiceException
Base exception class for all service exceptions from DirectConnect service.