Menu
AWS Direct Connect
API Reference (API Version 2012-10-25)

DeleteBGPPeer

Deletes a BGP peer on the specified virtual interface that matches the specified customer address and ASN. You cannot delete the last BGP peer from a virtual interface.

Request Syntax

{ "asn": number, "customerAddress": "string", "virtualInterfaceId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

asn

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

Example: 65000

Type: Integer

Required: No

customerAddress

IP address assigned to the customer interface.

Example: 192.168.1.2/30 or 2001:db8::2/125

Type: String

Required: No

virtualInterfaceId

The ID of the virtual interface from which the BGP peer will be deleted.

Example: dxvif-456abc78

Default: None

Type: String

Required: No

Response Syntax

{ "virtualInterface": { "addressFamily": "string", "amazonAddress": "string", "amazonSideAsn": number, "asn": number, "authKey": "string", "bgpPeers": [ { "addressFamily": "string", "amazonAddress": "string", "asn": number, "authKey": "string", "bgpPeerState": "string", "bgpStatus": "string", "customerAddress": "string" } ], "connectionId": "string", "customerAddress": "string", "customerRouterConfig": "string", "directConnectGatewayId": "string", "location": "string", "ownerAccount": "string", "routeFilterPrefixes": [ { "cidr": "string" } ], "virtualGatewayId": "string", "virtualInterfaceId": "string", "virtualInterfaceName": "string", "virtualInterfaceState": "string", "virtualInterfaceType": "string", "vlan": number } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

virtualInterface

A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

Type: VirtualInterface object

Errors

For information about the errors that are common to all actions, see Common Errors.

DirectConnectClientException

The API was called with invalid parameters. The error message will contain additional details about the cause.

HTTP Status Code: 400

DirectConnectServerException

A server-side error occurred during the API call. The error message will contain additional details about the cause.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: