AWS API Changes

2018/10/11 - AWS Direct Connect - 1 new 25 updated api methods

Changes This release adds support for Jumbo Frames over AWS Direct Connect. You can now set MTU value when creating new virtual interfaces. This release also includes a new API to modify MTU value of existing virtual interfaces.

UpdateVirtualInterfaceAttributes (new)

Link ¶

Updates the specified attributes of the specified virtual private interface.

Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections . To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces .

See also: AWS API Documentation

Request Syntax

client.update_virtual_interface_attributes(
    virtualInterfaceId='string',
    mtu=123
)

type virtualInterfaceId

string

param virtualInterfaceId

[REQUIRED]

The ID of the virtual private interface.

type mtu

integer

param mtu

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'virtualInterfaceId': 'string',
    'location': 'string',
    'connectionId': 'string',
    'virtualInterfaceType': 'string',
    'virtualInterfaceName': 'string',
    'vlan': 123,
    'asn': 123,
    'amazonSideAsn': 123,
    'authKey': 'string',
    'amazonAddress': 'string',
    'customerAddress': 'string',
    'addressFamily': 'ipv4'|'ipv6',
    'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
    'customerRouterConfig': 'string',
    'mtu': 123,
    'jumboFrameCapable': True|False,
    'virtualGatewayId': 'string',
    'directConnectGatewayId': 'string',
    'routeFilterPrefixes': [
        {
            'cidr': 'string'
        },
    ],
    'bgpPeers': [
        {
            'asn': 123,
            'authKey': 'string',
            'addressFamily': 'ipv4'|'ipv6',
            'amazonAddress': 'string',
            'customerAddress': 'string',
            'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
            'bgpStatus': 'up'|'down',
            'awsDeviceV2': 'string'
        },
    ],
    'region': 'string',
    'awsDeviceV2': 'string'
}

Response Structure

(dict) --

Information about a virtual interface.
- ownerAccount (string) --
  
  The ID of the AWS account that owns the virtual interface.
- virtualInterfaceId (string) --
  
  The ID of the virtual interface.
- location (string) --
  
  The location of the connection.
- connectionId (string) --
  
  The ID of the connection.
- virtualInterfaceType (string) --
  
  The type of virtual interface. The possible values are private and public .
- virtualInterfaceName (string) --
  
  The name of the virtual interface assigned by the customer network.
- vlan (integer) --
  
  The ID of the VLAN.
- asn (integer) --
  
  The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
- amazonSideAsn (integer) --
  
  The autonomous system number (ASN) for the Amazon side of the connection.
- authKey (string) --
  
  The authentication key for BGP configuration.
- amazonAddress (string) --
  
  The IP address assigned to the Amazon interface.
- customerAddress (string) --
  
  The IP address assigned to the customer interface.
- addressFamily (string) --
  
  The address family for the BGP peer.
- virtualInterfaceState (string) --
  
  The state of the virtual interface. The following are the possible values:
  - confirming : The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
  - verifying : This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
  - pending : A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
  - available : A virtual interface that is able to forward traffic.
  - down : A virtual interface that is BGP down.
  - deleting : A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
  - deleted : A virtual interface that cannot forward traffic.
  - rejected : The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.
- customerRouterConfig (string) --
  
  The customer router configuration.
- mtu (integer) --
  
  The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames (9001 MTU) are supported.
- virtualGatewayId (string) --
  
  The ID of the virtual private gateway. Applies only to private virtual interfaces.
- directConnectGatewayId (string) --
  
  The ID of the Direct Connect gateway.
- routeFilterPrefixes (list) --
  
  The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
  - (dict) --
    
    Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
    - cidr (string) --
      
      The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
- bgpPeers (list) --
  
  The BGP peers configured on this virtual interface.
  - (dict) --
    
    Information about a BGP peer.
    - asn (integer) --
      
      The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
    - authKey (string) --
      
      The authentication key for BGP configuration.
    - addressFamily (string) --
      
      The address family for the BGP peer.
    - amazonAddress (string) --
      
      The IP address assigned to the Amazon interface.
    - customerAddress (string) --
      
      The IP address assigned to the customer interface.
    - bgpPeerState (string) --
      
      The state of the BGP peer. The following are the possible values:
      - verifying : The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
      - pending : The BGP peer is created, and remains in this state until it is ready to be established.
      - available : The BGP peer is ready to be established.
      - deleting : The BGP peer is being deleted.
      - deleted : The BGP peer is deleted and cannot be established.
    - bgpStatus (string) --
      
      The status of the BGP peer. The following are the possible values:
      - up : The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
      - down : The BGP peer is down.
      - unknown : The BGP peer status is unknown.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint on which the BGP peer terminates.
- region (string) --
  
  The AWS Region where the virtual interface is located.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint on which the virtual interface terminates.

AllocateConnectionOnInterconnect (updated)

Link ¶
Changes (response)

{'jumboFrameCapable': 'boolean'}

Deprecated. Use AllocateHostedConnection instead.

Creates a hosted connection on an interconnect.

Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the specified interconnect.

Note

Intended for use by AWS Direct Connect partners only.

!DANGER!

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

client.allocate_connection_on_interconnect(
    bandwidth='string',
    connectionName='string',
    ownerAccount='string',
    interconnectId='string',
    vlan=123
)

type bandwidth

string

param bandwidth

[REQUIRED]

The bandwidth of the connection, in Mbps. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, and 500Mbps.

type connectionName

string

param connectionName

[REQUIRED]

The name of the provisioned connection.

type ownerAccount

string

param ownerAccount

[REQUIRED]

The ID of the AWS account of the customer for whom the connection will be provisioned.

type interconnectId

string

param interconnectId

[REQUIRED]

The ID of the interconnect on which the connection will be provisioned. For example, dxcon-456abc78.

type vlan

integer

param vlan

[REQUIRED]

The dedicated VLAN provisioned to the connection.

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'connectionId': 'string',
    'connectionName': 'string',
    'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
    'region': 'string',
    'location': 'string',
    'bandwidth': 'string',
    'vlan': 123,
    'partnerName': 'string',
    'loaIssueTime': datetime(2015, 1, 1),
    'lagId': 'string',
    'awsDevice': 'string',
    'jumboFrameCapable': True|False,
    'awsDeviceV2': 'string'
}

Response Structure

(dict) --

Information about an AWS Direct Connect connection.
- ownerAccount (string) --
  
  The ID of the AWS account that owns the connection.
- connectionId (string) --
  
  The ID of the connection.
- connectionName (string) --
  
  The name of the connection.
- connectionState (string) --
  
  The state of the connection. The following are the possible values:
  - ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
  - requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  - pending : The connection has been approved and is being initialized.
  - available : The network link is up and the connection is ready for use.
  - down : The network link is down.
  - deleting : The connection is being deleted.
  - deleted : The connection has been deleted.
  - rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
- region (string) --
  
  The AWS Region where the connection is located.
- location (string) --
  
  The location of the connection.
- bandwidth (string) --
  
  The bandwidth of the connection.
- vlan (integer) --
  
  The ID of the VLAN.
- partnerName (string) --
  
  The name of the AWS Direct Connect service provider associated with the connection.
- loaIssueTime (datetime) --
  
  The time of the most recent call to DescribeLoa for this connection.
- lagId (string) --
  
  The ID of the LAG.
- awsDevice (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames (9001 MTU) are supported.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.

AllocateHostedConnection (updated)

Link ¶
Changes (response)

{'jumboFrameCapable': 'boolean'}

Creates a hosted connection on the specified interconnect or a link aggregation group (LAG).

Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the specified interconnect or LAG.

Note

Intended for use by AWS Direct Connect partners only.

See also: AWS API Documentation

Request Syntax

client.allocate_hosted_connection(
    connectionId='string',
    ownerAccount='string',
    bandwidth='string',
    connectionName='string',
    vlan=123
)

type connectionId

string

param connectionId

[REQUIRED]

The ID of the interconnect or LAG.

type ownerAccount

string

param ownerAccount

[REQUIRED]

The ID of the AWS account ID of the customer for the connection.

type bandwidth

string

param bandwidth

[REQUIRED]

The bandwidth of the hosted connection, in Mbps. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, and 500Mbps.

type connectionName

string

param connectionName

[REQUIRED]

The name of the hosted connection.

type vlan

integer

param vlan

[REQUIRED]

The dedicated VLAN provisioned to the hosted connection.

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'connectionId': 'string',
    'connectionName': 'string',
    'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
    'region': 'string',
    'location': 'string',
    'bandwidth': 'string',
    'vlan': 123,
    'partnerName': 'string',
    'loaIssueTime': datetime(2015, 1, 1),
    'lagId': 'string',
    'awsDevice': 'string',
    'jumboFrameCapable': True|False,
    'awsDeviceV2': 'string'
}

Response Structure

(dict) --

Information about an AWS Direct Connect connection.
- ownerAccount (string) --
  
  The ID of the AWS account that owns the connection.
- connectionId (string) --
  
  The ID of the connection.
- connectionName (string) --
  
  The name of the connection.
- connectionState (string) --
  
  The state of the connection. The following are the possible values:
  - ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
  - requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  - pending : The connection has been approved and is being initialized.
  - available : The network link is up and the connection is ready for use.
  - down : The network link is down.
  - deleting : The connection is being deleted.
  - deleted : The connection has been deleted.
  - rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
- region (string) --
  
  The AWS Region where the connection is located.
- location (string) --
  
  The location of the connection.
- bandwidth (string) --
  
  The bandwidth of the connection.
- vlan (integer) --
  
  The ID of the VLAN.
- partnerName (string) --
  
  The name of the AWS Direct Connect service provider associated with the connection.
- loaIssueTime (datetime) --
  
  The time of the most recent call to DescribeLoa for this connection.
- lagId (string) --
  
  The ID of the LAG.
- awsDevice (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames (9001 MTU) are supported.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.

AllocatePrivateVirtualInterface (updated)

Link ¶
Changes (request, response)
Request

{'newPrivateVirtualInterfaceAllocation': {'mtu': 'integer'}}

Response

{'jumboFrameCapable': 'boolean', 'mtu': 'integer'}

Provisions a private virtual interface to be owned by the specified AWS account.

Virtual interfaces created using this action must be confirmed by the owner using ConfirmPrivateVirtualInterface . Until then, the virtual interface is in the Confirming state and is not available to handle traffic.

See also: AWS API Documentation

Request Syntax

client.allocate_private_virtual_interface(
    connectionId='string',
    ownerAccount='string',
    newPrivateVirtualInterfaceAllocation={
        'virtualInterfaceName': 'string',
        'vlan': 123,
        'asn': 123,
        'mtu': 123,
        'authKey': 'string',
        'amazonAddress': 'string',
        'addressFamily': 'ipv4'|'ipv6',
        'customerAddress': 'string'
    }
)

type connectionId

string

param connectionId

[REQUIRED]

The ID of the connection on which the private virtual interface is provisioned.

type ownerAccount

string

param ownerAccount

[REQUIRED]

The ID of the AWS account that owns the virtual private interface.

type newPrivateVirtualInterfaceAllocation

dict

param newPrivateVirtualInterfaceAllocation

[REQUIRED]

Information about the private virtual interface.

virtualInterfaceName (string) -- [REQUIRED]

The name of the virtual interface assigned by the customer network.
vlan (integer) -- [REQUIRED]

The ID of the VLAN.
asn (integer) -- [REQUIRED]

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

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
authKey (string) --

The authentication key for BGP configuration.
amazonAddress (string) --

The IP address assigned to the Amazon interface.
addressFamily (string) --

The address family for the BGP peer.
customerAddress (string) --

The IP address assigned to the customer interface.

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'virtualInterfaceId': 'string',
    'location': 'string',
    'connectionId': 'string',
    'virtualInterfaceType': 'string',
    'virtualInterfaceName': 'string',
    'vlan': 123,
    'asn': 123,
    'amazonSideAsn': 123,
    'authKey': 'string',
    'amazonAddress': 'string',
    'customerAddress': 'string',
    'addressFamily': 'ipv4'|'ipv6',
    'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
    'customerRouterConfig': 'string',
    'mtu': 123,
    'jumboFrameCapable': True|False,
    'virtualGatewayId': 'string',
    'directConnectGatewayId': 'string',
    'routeFilterPrefixes': [
        {
            'cidr': 'string'
        },
    ],
    'bgpPeers': [
        {
            'asn': 123,
            'authKey': 'string',
            'addressFamily': 'ipv4'|'ipv6',
            'amazonAddress': 'string',
            'customerAddress': 'string',
            'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
            'bgpStatus': 'up'|'down',
            'awsDeviceV2': 'string'
        },
    ],
    'region': 'string',
    'awsDeviceV2': 'string'
}

Response Structure

(dict) --

Information about a virtual interface.
- ownerAccount (string) --
  
  The ID of the AWS account that owns the virtual interface.
- virtualInterfaceId (string) --
  
  The ID of the virtual interface.
- location (string) --
  
  The location of the connection.
- connectionId (string) --
  
  The ID of the connection.
- virtualInterfaceType (string) --
  
  The type of virtual interface. The possible values are private and public .
- virtualInterfaceName (string) --
  
  The name of the virtual interface assigned by the customer network.
- vlan (integer) --
  
  The ID of the VLAN.
- asn (integer) --
  
  The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
- amazonSideAsn (integer) --
  
  The autonomous system number (ASN) for the Amazon side of the connection.
- authKey (string) --
  
  The authentication key for BGP configuration.
- amazonAddress (string) --
  
  The IP address assigned to the Amazon interface.
- customerAddress (string) --
  
  The IP address assigned to the customer interface.
- addressFamily (string) --
  
  The address family for the BGP peer.
- virtualInterfaceState (string) --
  
  The state of the virtual interface. The following are the possible values:
  - confirming : The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
  - verifying : This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
  - pending : A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
  - available : A virtual interface that is able to forward traffic.
  - down : A virtual interface that is BGP down.
  - deleting : A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
  - deleted : A virtual interface that cannot forward traffic.
  - rejected : The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.
- customerRouterConfig (string) --
  
  The customer router configuration.
- mtu (integer) --
  
  The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames (9001 MTU) are supported.
- virtualGatewayId (string) --
  
  The ID of the virtual private gateway. Applies only to private virtual interfaces.
- directConnectGatewayId (string) --
  
  The ID of the Direct Connect gateway.
- routeFilterPrefixes (list) --
  
  The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
  - (dict) --
    
    Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
    - cidr (string) --
      
      The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
- bgpPeers (list) --
  
  The BGP peers configured on this virtual interface.
  - (dict) --
    
    Information about a BGP peer.
    - asn (integer) --
      
      The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
    - authKey (string) --
      
      The authentication key for BGP configuration.
    - addressFamily (string) --
      
      The address family for the BGP peer.
    - amazonAddress (string) --
      
      The IP address assigned to the Amazon interface.
    - customerAddress (string) --
      
      The IP address assigned to the customer interface.
    - bgpPeerState (string) --
      
      The state of the BGP peer. The following are the possible values:
      - verifying : The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
      - pending : The BGP peer is created, and remains in this state until it is ready to be established.
      - available : The BGP peer is ready to be established.
      - deleting : The BGP peer is being deleted.
      - deleted : The BGP peer is deleted and cannot be established.
    - bgpStatus (string) --
      
      The status of the BGP peer. The following are the possible values:
      - up : The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
      - down : The BGP peer is down.
      - unknown : The BGP peer status is unknown.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint on which the BGP peer terminates.
- region (string) --
  
  The AWS Region where the virtual interface is located.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint on which the virtual interface terminates.

AllocatePublicVirtualInterface (updated)

Link ¶
Changes (response)

{'jumboFrameCapable': 'boolean', 'mtu': 'integer'}

Provisions a public virtual interface to be owned by the specified AWS account.

The owner of a connection calls this function to provision a public virtual interface to be owned by the specified AWS account.

Virtual interfaces created using this function must be confirmed by the owner using ConfirmPublicVirtualInterface . Until this step has been completed, the virtual interface is in the confirming state and is not available to handle traffic.

When creating an IPv6 public virtual interface, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.

See also: AWS API Documentation

Request Syntax

client.allocate_public_virtual_interface(
    connectionId='string',
    ownerAccount='string',
    newPublicVirtualInterfaceAllocation={
        'virtualInterfaceName': 'string',
        'vlan': 123,
        'asn': 123,
        'authKey': 'string',
        'amazonAddress': 'string',
        'customerAddress': 'string',
        'addressFamily': 'ipv4'|'ipv6',
        'routeFilterPrefixes': [
            {
                'cidr': 'string'
            },
        ]
    }
)

type connectionId

string

param connectionId

[REQUIRED]

The ID of the connection on which the public virtual interface is provisioned.

type ownerAccount

string

param ownerAccount

[REQUIRED]

The ID of the AWS account that owns the public virtual interface.

type newPublicVirtualInterfaceAllocation

dict

param newPublicVirtualInterfaceAllocation

[REQUIRED]

Information about the public virtual interface.

virtualInterfaceName (string) -- [REQUIRED]

The name of the virtual interface assigned by the customer network.
vlan (integer) -- [REQUIRED]

The ID of the VLAN.
asn (integer) -- [REQUIRED]

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

The authentication key for BGP configuration.
amazonAddress (string) --

The IP address assigned to the Amazon interface.
customerAddress (string) --

The IP address assigned to the customer interface.
addressFamily (string) --

The address family for the BGP peer.
routeFilterPrefixes (list) --

The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
- (dict) --
  
  Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
  - cidr (string) --
    
    The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'virtualInterfaceId': 'string',
    'location': 'string',
    'connectionId': 'string',
    'virtualInterfaceType': 'string',
    'virtualInterfaceName': 'string',
    'vlan': 123,
    'asn': 123,
    'amazonSideAsn': 123,
    'authKey': 'string',
    'amazonAddress': 'string',
    'customerAddress': 'string',
    'addressFamily': 'ipv4'|'ipv6',
    'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
    'customerRouterConfig': 'string',
    'mtu': 123,
    'jumboFrameCapable': True|False,
    'virtualGatewayId': 'string',
    'directConnectGatewayId': 'string',
    'routeFilterPrefixes': [
        {
            'cidr': 'string'
        },
    ],
    'bgpPeers': [
        {
            'asn': 123,
            'authKey': 'string',
            'addressFamily': 'ipv4'|'ipv6',
            'amazonAddress': 'string',
            'customerAddress': 'string',
            'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
            'bgpStatus': 'up'|'down',
            'awsDeviceV2': 'string'
        },
    ],
    'region': 'string',
    'awsDeviceV2': 'string'
}

Response Structure

(dict) --

Information about a virtual interface.
- ownerAccount (string) --
  
  The ID of the AWS account that owns the virtual interface.
- virtualInterfaceId (string) --
  
  The ID of the virtual interface.
- location (string) --
  
  The location of the connection.
- connectionId (string) --
  
  The ID of the connection.
- virtualInterfaceType (string) --
  
  The type of virtual interface. The possible values are private and public .
- virtualInterfaceName (string) --
  
  The name of the virtual interface assigned by the customer network.
- vlan (integer) --
  
  The ID of the VLAN.
- asn (integer) --
  
  The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
- amazonSideAsn (integer) --
  
  The autonomous system number (ASN) for the Amazon side of the connection.
- authKey (string) --
  
  The authentication key for BGP configuration.
- amazonAddress (string) --
  
  The IP address assigned to the Amazon interface.
- customerAddress (string) --
  
  The IP address assigned to the customer interface.
- addressFamily (string) --
  
  The address family for the BGP peer.
- virtualInterfaceState (string) --
  
  The state of the virtual interface. The following are the possible values:
  - confirming : The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
  - verifying : This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
  - pending : A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
  - available : A virtual interface that is able to forward traffic.
  - down : A virtual interface that is BGP down.
  - deleting : A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
  - deleted : A virtual interface that cannot forward traffic.
  - rejected : The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.
- customerRouterConfig (string) --
  
  The customer router configuration.
- mtu (integer) --
  
  The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames (9001 MTU) are supported.
- virtualGatewayId (string) --
  
  The ID of the virtual private gateway. Applies only to private virtual interfaces.
- directConnectGatewayId (string) --
  
  The ID of the Direct Connect gateway.
- routeFilterPrefixes (list) --
  
  The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
  - (dict) --
    
    Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
    - cidr (string) --
      
      The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
- bgpPeers (list) --
  
  The BGP peers configured on this virtual interface.
  - (dict) --
    
    Information about a BGP peer.
    - asn (integer) --
      
      The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
    - authKey (string) --
      
      The authentication key for BGP configuration.
    - addressFamily (string) --
      
      The address family for the BGP peer.
    - amazonAddress (string) --
      
      The IP address assigned to the Amazon interface.
    - customerAddress (string) --
      
      The IP address assigned to the customer interface.
    - bgpPeerState (string) --
      
      The state of the BGP peer. The following are the possible values:
      - verifying : The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
      - pending : The BGP peer is created, and remains in this state until it is ready to be established.
      - available : The BGP peer is ready to be established.
      - deleting : The BGP peer is being deleted.
      - deleted : The BGP peer is deleted and cannot be established.
    - bgpStatus (string) --
      
      The status of the BGP peer. The following are the possible values:
      - up : The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
      - down : The BGP peer is down.
      - unknown : The BGP peer status is unknown.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint on which the BGP peer terminates.
- region (string) --
  
  The AWS Region where the virtual interface is located.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint on which the virtual interface terminates.

AssociateConnectionWithLag (updated)

Link ¶
Changes (response)

{'jumboFrameCapable': 'boolean'}

Associates an existing connection with a link aggregation group (LAG). The connection is interrupted and re-established as a member of the LAG (connectivity to AWS is interrupted). The connection must be hosted on the same AWS Direct Connect endpoint as the LAG, and its bandwidth must match the bandwidth for the LAG. You can re-associate a connection that's currently associated with a different LAG; however, if removing the connection would cause the original LAG to fall below its setting for minimum number of operational connections, the request fails.

Any virtual interfaces that are directly associated with the connection are automatically re-associated with the LAG. If the connection was originally associated with a different LAG, the virtual interfaces remain associated with the original LAG.

For interconnects, any hosted connections are automatically re-associated with the LAG. If the interconnect was originally associated with a different LAG, the hosted connections remain associated with the original LAG.

See also: AWS API Documentation

Request Syntax

client.associate_connection_with_lag(
    connectionId='string',
    lagId='string'
)

type connectionId

string

param connectionId

[REQUIRED]

The ID of the connection. For example, dxcon-abc123.

type lagId

string

param lagId

[REQUIRED]

The ID of the LAG with which to associate the connection. For example, dxlag-abc123.

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'connectionId': 'string',
    'connectionName': 'string',
    'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
    'region': 'string',
    'location': 'string',
    'bandwidth': 'string',
    'vlan': 123,
    'partnerName': 'string',
    'loaIssueTime': datetime(2015, 1, 1),
    'lagId': 'string',
    'awsDevice': 'string',
    'jumboFrameCapable': True|False,
    'awsDeviceV2': 'string'
}

Response Structure

(dict) --

Information about an AWS Direct Connect connection.
- ownerAccount (string) --
  
  The ID of the AWS account that owns the connection.
- connectionId (string) --
  
  The ID of the connection.
- connectionName (string) --
  
  The name of the connection.
- connectionState (string) --
  
  The state of the connection. The following are the possible values:
  - ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
  - requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  - pending : The connection has been approved and is being initialized.
  - available : The network link is up and the connection is ready for use.
  - down : The network link is down.
  - deleting : The connection is being deleted.
  - deleted : The connection has been deleted.
  - rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
- region (string) --
  
  The AWS Region where the connection is located.
- location (string) --
  
  The location of the connection.
- bandwidth (string) --
  
  The bandwidth of the connection.
- vlan (integer) --
  
  The ID of the VLAN.
- partnerName (string) --
  
  The name of the AWS Direct Connect service provider associated with the connection.
- loaIssueTime (datetime) --
  
  The time of the most recent call to DescribeLoa for this connection.
- lagId (string) --
  
  The ID of the LAG.
- awsDevice (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames (9001 MTU) are supported.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.

AssociateHostedConnection (updated)

Link ¶
Changes (response)

{'jumboFrameCapable': 'boolean'}

Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect. If the target interconnect or LAG has an existing hosted connection with a conflicting VLAN number or IP address, the operation fails. This action temporarily interrupts the hosted connection's connectivity to AWS as it is being migrated.

Note

Intended for use by AWS Direct Connect partners only.

See also: AWS API Documentation

Request Syntax

client.associate_hosted_connection(
    connectionId='string',
    parentConnectionId='string'
)

type connectionId

string

param connectionId

[REQUIRED]

The ID of the hosted connection.

type parentConnectionId

string

param parentConnectionId

[REQUIRED]

The ID of the interconnect or the LAG.

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'connectionId': 'string',
    'connectionName': 'string',
    'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
    'region': 'string',
    'location': 'string',
    'bandwidth': 'string',
    'vlan': 123,
    'partnerName': 'string',
    'loaIssueTime': datetime(2015, 1, 1),
    'lagId': 'string',
    'awsDevice': 'string',
    'jumboFrameCapable': True|False,
    'awsDeviceV2': 'string'
}

Response Structure

(dict) --

Information about an AWS Direct Connect connection.
- ownerAccount (string) --
  
  The ID of the AWS account that owns the connection.
- connectionId (string) --
  
  The ID of the connection.
- connectionName (string) --
  
  The name of the connection.
- connectionState (string) --
  
  The state of the connection. The following are the possible values:
  - ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
  - requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  - pending : The connection has been approved and is being initialized.
  - available : The network link is up and the connection is ready for use.
  - down : The network link is down.
  - deleting : The connection is being deleted.
  - deleted : The connection has been deleted.
  - rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
- region (string) --
  
  The AWS Region where the connection is located.
- location (string) --
  
  The location of the connection.
- bandwidth (string) --
  
  The bandwidth of the connection.
- vlan (integer) --
  
  The ID of the VLAN.
- partnerName (string) --
  
  The name of the AWS Direct Connect service provider associated with the connection.
- loaIssueTime (datetime) --
  
  The time of the most recent call to DescribeLoa for this connection.
- lagId (string) --
  
  The ID of the LAG.
- awsDevice (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames (9001 MTU) are supported.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.

AssociateVirtualInterface (updated)

Link ¶
Changes (response)

{'jumboFrameCapable': 'boolean', 'mtu': 'integer'}

Associates a virtual interface with a specified link aggregation group (LAG) or connection. Connectivity to AWS is temporarily interrupted as the virtual interface is being migrated. If the target connection or LAG has an associated virtual interface with a conflicting VLAN number or a conflicting IP address, the operation fails.

Virtual interfaces associated with a hosted connection cannot be associated with a LAG; hosted connections must be migrated along with their virtual interfaces using AssociateHostedConnection .

To reassociate a virtual interface to a new connection or LAG, the requester must own either the virtual interface itself or the connection to which the virtual interface is currently associated. Additionally, the requester must own the connection or LAG for the association.

See also: AWS API Documentation

Request Syntax

client.associate_virtual_interface(
    virtualInterfaceId='string',
    connectionId='string'
)

type virtualInterfaceId

string

param virtualInterfaceId

[REQUIRED]

The ID of the virtual interface.

type connectionId

string

param connectionId

[REQUIRED]

The ID of the LAG or connection.

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'virtualInterfaceId': 'string',
    'location': 'string',
    'connectionId': 'string',
    'virtualInterfaceType': 'string',
    'virtualInterfaceName': 'string',
    'vlan': 123,
    'asn': 123,
    'amazonSideAsn': 123,
    'authKey': 'string',
    'amazonAddress': 'string',
    'customerAddress': 'string',
    'addressFamily': 'ipv4'|'ipv6',
    'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
    'customerRouterConfig': 'string',
    'mtu': 123,
    'jumboFrameCapable': True|False,
    'virtualGatewayId': 'string',
    'directConnectGatewayId': 'string',
    'routeFilterPrefixes': [
        {
            'cidr': 'string'
        },
    ],
    'bgpPeers': [
        {
            'asn': 123,
            'authKey': 'string',
            'addressFamily': 'ipv4'|'ipv6',
            'amazonAddress': 'string',
            'customerAddress': 'string',
            'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
            'bgpStatus': 'up'|'down',
            'awsDeviceV2': 'string'
        },
    ],
    'region': 'string',
    'awsDeviceV2': 'string'
}

Response Structure

(dict) --

Information about a virtual interface.
- ownerAccount (string) --
  
  The ID of the AWS account that owns the virtual interface.
- virtualInterfaceId (string) --
  
  The ID of the virtual interface.
- location (string) --
  
  The location of the connection.
- connectionId (string) --
  
  The ID of the connection.
- virtualInterfaceType (string) --
  
  The type of virtual interface. The possible values are private and public .
- virtualInterfaceName (string) --
  
  The name of the virtual interface assigned by the customer network.
- vlan (integer) --
  
  The ID of the VLAN.
- asn (integer) --
  
  The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
- amazonSideAsn (integer) --
  
  The autonomous system number (ASN) for the Amazon side of the connection.
- authKey (string) --
  
  The authentication key for BGP configuration.
- amazonAddress (string) --
  
  The IP address assigned to the Amazon interface.
- customerAddress (string) --
  
  The IP address assigned to the customer interface.
- addressFamily (string) --
  
  The address family for the BGP peer.
- virtualInterfaceState (string) --
  
  The state of the virtual interface. The following are the possible values:
  - confirming : The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
  - verifying : This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
  - pending : A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
  - available : A virtual interface that is able to forward traffic.
  - down : A virtual interface that is BGP down.
  - deleting : A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
  - deleted : A virtual interface that cannot forward traffic.
  - rejected : The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.
- customerRouterConfig (string) --
  
  The customer router configuration.
- mtu (integer) --
  
  The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames (9001 MTU) are supported.
- virtualGatewayId (string) --
  
  The ID of the virtual private gateway. Applies only to private virtual interfaces.
- directConnectGatewayId (string) --
  
  The ID of the Direct Connect gateway.
- routeFilterPrefixes (list) --
  
  The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
  - (dict) --
    
    Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
    - cidr (string) --
      
      The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
- bgpPeers (list) --
  
  The BGP peers configured on this virtual interface.
  - (dict) --
    
    Information about a BGP peer.
    - asn (integer) --
      
      The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
    - authKey (string) --
      
      The authentication key for BGP configuration.
    - addressFamily (string) --
      
      The address family for the BGP peer.
    - amazonAddress (string) --
      
      The IP address assigned to the Amazon interface.
    - customerAddress (string) --
      
      The IP address assigned to the customer interface.
    - bgpPeerState (string) --
      
      The state of the BGP peer. The following are the possible values:
      - verifying : The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
      - pending : The BGP peer is created, and remains in this state until it is ready to be established.
      - available : The BGP peer is ready to be established.
      - deleting : The BGP peer is being deleted.
      - deleted : The BGP peer is deleted and cannot be established.
    - bgpStatus (string) --
      
      The status of the BGP peer. The following are the possible values:
      - up : The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
      - down : The BGP peer is down.
      - unknown : The BGP peer status is unknown.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint on which the BGP peer terminates.
- region (string) --
  
  The AWS Region where the virtual interface is located.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint on which the virtual interface terminates.

CreateBGPPeer (updated)

Link ¶
Changes (response)

{'virtualInterface': {'jumboFrameCapable': 'boolean', 'mtu': 'integer'}}

Creates a BGP peer on the specified virtual interface.

The BGP peer cannot be in the same address family (IPv4/IPv6) of an existing BGP peer on the virtual interface.

You must create a BGP peer for the corresponding address family in order to access AWS resources that also use that address family.

When creating a IPv6 BGP peer, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.

For a public virtual interface, the Autonomous System Number (ASN) must be private or already whitelisted for the virtual interface.

See also: AWS API Documentation

Request Syntax

client.create_bgp_peer(
    virtualInterfaceId='string',
    newBGPPeer={
        'asn': 123,
        'authKey': 'string',
        'addressFamily': 'ipv4'|'ipv6',
        'amazonAddress': 'string',
        'customerAddress': 'string'
    }
)

type virtualInterfaceId

string

param virtualInterfaceId

The ID of the virtual interface.

type newBGPPeer

dict

param newBGPPeer

Information about the BGP peer.

asn (integer) --

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

The authentication key for BGP configuration.
addressFamily (string) --

The address family for the BGP peer.
amazonAddress (string) --

The IP address assigned to the Amazon interface.
customerAddress (string) --

The IP address assigned to the customer interface.

rtype

dict

returns

Response Syntax

{
    'virtualInterface': {
        'ownerAccount': 'string',
        'virtualInterfaceId': 'string',
        'location': 'string',
        'connectionId': 'string',
        'virtualInterfaceType': 'string',
        'virtualInterfaceName': 'string',
        'vlan': 123,
        'asn': 123,
        'amazonSideAsn': 123,
        'authKey': 'string',
        'amazonAddress': 'string',
        'customerAddress': 'string',
        'addressFamily': 'ipv4'|'ipv6',
        'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
        'customerRouterConfig': 'string',
        'mtu': 123,
        'jumboFrameCapable': True|False,
        'virtualGatewayId': 'string',
        'directConnectGatewayId': 'string',
        'routeFilterPrefixes': [
            {
                'cidr': 'string'
            },
        ],
        'bgpPeers': [
            {
                'asn': 123,
                'authKey': 'string',
                'addressFamily': 'ipv4'|'ipv6',
                'amazonAddress': 'string',
                'customerAddress': 'string',
                'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
                'bgpStatus': 'up'|'down',
                'awsDeviceV2': 'string'
            },
        ],
        'region': 'string',
        'awsDeviceV2': 'string'
    }
}

Response Structure

(dict) --
- virtualInterface (dict) --
  
  The virtual interface.
  - ownerAccount (string) --
    
    The ID of the AWS account that owns the virtual interface.
  - virtualInterfaceId (string) --
    
    The ID of the virtual interface.
  - location (string) --
    
    The location of the connection.
  - connectionId (string) --
    
    The ID of the connection.
  - virtualInterfaceType (string) --
    
    The type of virtual interface. The possible values are private and public .
  - virtualInterfaceName (string) --
    
    The name of the virtual interface assigned by the customer network.
  - vlan (integer) --
    
    The ID of the VLAN.
  - asn (integer) --
    
    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
  - amazonSideAsn (integer) --
    
    The autonomous system number (ASN) for the Amazon side of the connection.
  - authKey (string) --
    
    The authentication key for BGP configuration.
  - amazonAddress (string) --
    
    The IP address assigned to the Amazon interface.
  - customerAddress (string) --
    
    The IP address assigned to the customer interface.
  - addressFamily (string) --
    
    The address family for the BGP peer.
  - virtualInterfaceState (string) --
    
    The state of the virtual interface. The following are the possible values:
    - confirming : The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
    - verifying : This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
    - pending : A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
    - available : A virtual interface that is able to forward traffic.
    - down : A virtual interface that is BGP down.
    - deleting : A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
    - deleted : A virtual interface that cannot forward traffic.
    - rejected : The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.
  - customerRouterConfig (string) --
    
    The customer router configuration.
  - mtu (integer) --
    
    The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
  - jumboFrameCapable (boolean) --
    
    Indicates whether jumbo frames (9001 MTU) are supported.
  - virtualGatewayId (string) --
    
    The ID of the virtual private gateway. Applies only to private virtual interfaces.
  - directConnectGatewayId (string) --
    
    The ID of the Direct Connect gateway.
  - routeFilterPrefixes (list) --
    
    The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
    - (dict) --
      
      Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
      - cidr (string) --
        
        The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
  - bgpPeers (list) --
    
    The BGP peers configured on this virtual interface.
    - (dict) --
      
      Information about a BGP peer.
      - asn (integer) --
        
        The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
      - authKey (string) --
        
        The authentication key for BGP configuration.
      - addressFamily (string) --
        
        The address family for the BGP peer.
      - amazonAddress (string) --
        
        The IP address assigned to the Amazon interface.
      - customerAddress (string) --
        
        The IP address assigned to the customer interface.
      - bgpPeerState (string) --
        
        The state of the BGP peer. The following are the possible values:
        
        verifying : The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
        
        pending : The BGP peer is created, and remains in this state until it is ready to be established.
        
        available : The BGP peer is ready to be established.
        
        deleting : The BGP peer is being deleted.
        
        deleted : The BGP peer is deleted and cannot be established.
      - bgpStatus (string) --
        
        The status of the BGP peer. The following are the possible values:
        
        up : The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
        
        down : The BGP peer is down.
        
        unknown : The BGP peer status is unknown.
      - awsDeviceV2 (string) --
        
        The Direct Connect endpoint on which the BGP peer terminates.
  - region (string) --
    
    The AWS Region where the virtual interface is located.
  - awsDeviceV2 (string) --
    
    The Direct Connect endpoint on which the virtual interface terminates.

CreateConnection (updated)

Link ¶
Changes (response)

{'jumboFrameCapable': 'boolean'}

Creates a connection between a customer network and a specific AWS Direct Connect location.

A connection links your internal network to an AWS Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router.

To find the locations for your Region, use DescribeLocations .

You can automatically add the new connection to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new connection is allocated on the same AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no connection is created.

See also: AWS API Documentation

Request Syntax

client.create_connection(
    location='string',
    bandwidth='string',
    connectionName='string',
    lagId='string'
)

type location

string

param location

[REQUIRED]

The location of the connection.

type bandwidth

string

param bandwidth

[REQUIRED]

The bandwidth of the connection.

type connectionName

string

param connectionName

[REQUIRED]

The name of the connection.

type lagId

string

param lagId

The ID of the LAG.

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'connectionId': 'string',
    'connectionName': 'string',
    'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
    'region': 'string',
    'location': 'string',
    'bandwidth': 'string',
    'vlan': 123,
    'partnerName': 'string',
    'loaIssueTime': datetime(2015, 1, 1),
    'lagId': 'string',
    'awsDevice': 'string',
    'jumboFrameCapable': True|False,
    'awsDeviceV2': 'string'
}

Response Structure

(dict) --

Information about an AWS Direct Connect connection.
- ownerAccount (string) --
  
  The ID of the AWS account that owns the connection.
- connectionId (string) --
  
  The ID of the connection.
- connectionName (string) --
  
  The name of the connection.
- connectionState (string) --
  
  The state of the connection. The following are the possible values:
  - ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
  - requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  - pending : The connection has been approved and is being initialized.
  - available : The network link is up and the connection is ready for use.
  - down : The network link is down.
  - deleting : The connection is being deleted.
  - deleted : The connection has been deleted.
  - rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
- region (string) --
  
  The AWS Region where the connection is located.
- location (string) --
  
  The location of the connection.
- bandwidth (string) --
  
  The bandwidth of the connection.
- vlan (integer) --
  
  The ID of the VLAN.
- partnerName (string) --
  
  The name of the AWS Direct Connect service provider associated with the connection.
- loaIssueTime (datetime) --
  
  The time of the most recent call to DescribeLoa for this connection.
- lagId (string) --
  
  The ID of the LAG.
- awsDevice (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames (9001 MTU) are supported.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.

CreateInterconnect (updated)

Link ¶
Changes (response)

{'jumboFrameCapable': 'boolean'}

Creates an interconnect between an AWS Direct Connect partner's network and a specific AWS Direct Connect location.

An interconnect is a connection which is capable of hosting other connections. The partner can use an interconnect to provide sub-1Gbps AWS Direct Connect service to tier 2 customers who do not have their own connections. Like a standard connection, an interconnect links the partner's network to an AWS Direct Connect location over a standard Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an AWS Direct Connect router.

You can automatically add the new interconnect to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new interconnect is allocated on the same AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no interconnect is created.

For each end customer, the AWS Direct Connect partner provisions a connection on their interconnect by calling AllocateConnectionOnInterconnect . The end customer can then connect to AWS resources by creating a virtual interface on their connection, using the VLAN assigned to them by the partner.

Note

Intended for use by AWS Direct Connect partners only.

See also: AWS API Documentation

Request Syntax

client.create_interconnect(
    interconnectName='string',
    bandwidth='string',
    location='string',
    lagId='string'
)

type interconnectName

string

param interconnectName

[REQUIRED]

The name of the interconnect.

type bandwidth

string

param bandwidth

[REQUIRED]

The port bandwidth, in Gbps. The possible values are 1 and 10.

type location

string

param location

[REQUIRED]

The location of the interconnect.

type lagId

string

param lagId

The ID of the LAG.

rtype

dict

returns

Response Syntax

{
    'interconnectId': 'string',
    'interconnectName': 'string',
    'interconnectState': 'requested'|'pending'|'available'|'down'|'deleting'|'deleted',
    'region': 'string',
    'location': 'string',
    'bandwidth': 'string',
    'loaIssueTime': datetime(2015, 1, 1),
    'lagId': 'string',
    'awsDevice': 'string',
    'jumboFrameCapable': True|False,
    'awsDeviceV2': 'string'
}

Response Structure

(dict) --

Information about an interconnect.
- interconnectId (string) --
  
  The ID of the interconnect.
- interconnectName (string) --
  
  The name of the interconnect.
- interconnectState (string) --
  
  The state of the interconnect. The following are the possible values:
  - requested : The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  - pending : The interconnect is approved, and is being initialized.
  - available : The network link is up, and the interconnect is ready for use.
  - down : The network link is down.
  - deleting : The interconnect is being deleted.
  - deleted : The interconnect is deleted.
- region (string) --
  
  The AWS Region where the connection is located.
- location (string) --
  
  The location of the connection.
- bandwidth (string) --
  
  The bandwidth of the connection.
- loaIssueTime (datetime) --
  
  The time of the most recent call to DescribeLoa for this connection.
- lagId (string) --
  
  The ID of the LAG.
- awsDevice (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames (9001 MTU) are supported.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.

CreateLag (updated)

Link ¶
Changes (response)

{'connections': {'jumboFrameCapable': 'boolean'},
 'jumboFrameCapable': 'boolean'}

Creates a link aggregation group (LAG) with the specified number of bundled physical connections between the customer network and a specific AWS Direct Connect location. A LAG is a logical interface that uses the Link Aggregation Control Protocol (LACP) to aggregate multiple interfaces, enabling you to treat them as a single interface.

All connections in a LAG must use the same bandwidth and must terminate at the same AWS Direct Connect endpoint.

You can have up to 10 connections per LAG. Regardless of this limit, if you request more connections for the LAG than AWS Direct Connect can allocate on a single endpoint, no LAG is created.

You can specify an existing physical connection or interconnect to include in the LAG (which counts towards the total number of connections). Doing so interrupts the current physical connection or hosted connections, and re-establishes them as a member of the LAG. The LAG will be created on the same AWS Direct Connect endpoint to which the connection terminates. Any virtual interfaces associated with the connection are automatically disassociated and re-associated with the LAG. The connection ID does not change.

If the AWS account used to create a LAG is a registered AWS Direct Connect partner, the LAG is automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual interfaces cannot be directly configured.

See also: AWS API Documentation

Request Syntax

client.create_lag(
    numberOfConnections=123,
    location='string',
    connectionsBandwidth='string',
    lagName='string',
    connectionId='string'
)

type numberOfConnections

integer

param numberOfConnections

[REQUIRED]

The number of physical connections initially provisioned and bundled by the LAG.

type location

string

param location

[REQUIRED]

The location for the LAG.

type connectionsBandwidth

string

param connectionsBandwidth

[REQUIRED]

The bandwidth of the individual physical connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.

type lagName

string

param lagName

[REQUIRED]

The name of the LAG.

type connectionId

string

param connectionId

The ID of an existing connection to migrate to the LAG.

rtype

dict

returns

Response Syntax

{
    'connectionsBandwidth': 'string',
    'numberOfConnections': 123,
    'lagId': 'string',
    'ownerAccount': 'string',
    'lagName': 'string',
    'lagState': 'requested'|'pending'|'available'|'down'|'deleting'|'deleted',
    'location': 'string',
    'region': 'string',
    'minimumLinks': 123,
    'awsDevice': 'string',
    'awsDeviceV2': 'string',
    'connections': [
        {
            'ownerAccount': 'string',
            'connectionId': 'string',
            'connectionName': 'string',
            'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
            'region': 'string',
            'location': 'string',
            'bandwidth': 'string',
            'vlan': 123,
            'partnerName': 'string',
            'loaIssueTime': datetime(2015, 1, 1),
            'lagId': 'string',
            'awsDevice': 'string',
            'jumboFrameCapable': True|False,
            'awsDeviceV2': 'string'
        },
    ],
    'allowsHostedConnections': True|False,
    'jumboFrameCapable': True|False
}

Response Structure

(dict) --

Information about a link aggregation group (LAG).
- connectionsBandwidth (string) --
  
  The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.
- numberOfConnections (integer) --
  
  The number of physical connections bundled by the LAG, up to a maximum of 10.
- lagId (string) --
  
  The ID of the LAG.
- ownerAccount (string) --
  
  The ID of the AWS account that owns the LAG.
- lagName (string) --
  
  The name of the LAG.
- lagState (string) --
  
  The state of the LAG. The following are the possible values:
  - requested : The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.
  - pending : The LAG has been approved and is being initialized.
  - available : The network link is established and the LAG is ready for use.
  - down : The network link is down.
  - deleting : The LAG is being deleted.
  - deleted : The LAG is deleted.
- location (string) --
  
  The location of the LAG.
- region (string) --
  
  The AWS Region where the connection is located.
- minimumLinks (integer) --
  
  The minimum number of physical connections that must be operational for the LAG itself to be operational.
- awsDevice (string) --
  
  The Direct Connect endpoint that hosts the LAG.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint that hosts the LAG.
- connections (list) --
  
  The connections bundled by the LAG.
  - (dict) --
    
    Information about an AWS Direct Connect connection.
    - ownerAccount (string) --
      
      The ID of the AWS account that owns the connection.
    - connectionId (string) --
      
      The ID of the connection.
    - connectionName (string) --
      
      The name of the connection.
    - connectionState (string) --
      
      The state of the connection. The following are the possible values:
      - ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
      - requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
      - pending : The connection has been approved and is being initialized.
      - available : The network link is up and the connection is ready for use.
      - down : The network link is down.
      - deleting : The connection is being deleted.
      - deleted : The connection has been deleted.
      - rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
    - region (string) --
      
      The AWS Region where the connection is located.
    - location (string) --
      
      The location of the connection.
    - bandwidth (string) --
      
      The bandwidth of the connection.
    - vlan (integer) --
      
      The ID of the VLAN.
    - partnerName (string) --
      
      The name of the AWS Direct Connect service provider associated with the connection.
    - loaIssueTime (datetime) --
      
      The time of the most recent call to DescribeLoa for this connection.
    - lagId (string) --
      
      The ID of the LAG.
    - awsDevice (string) --
      
      The Direct Connect endpoint on which the physical connection terminates.
    - jumboFrameCapable (boolean) --
      
      Indicates whether jumbo frames (9001 MTU) are supported.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint on which the physical connection terminates.
- allowsHostedConnections (boolean) --
  
  Indicates whether the LAG can host other connections.
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames (9001 MTU) are supported.

CreatePrivateVirtualInterface (updated)

Link ¶
Changes (request, response)
Request

{'newPrivateVirtualInterface': {'mtu': 'integer'}}

Response

{'jumboFrameCapable': 'boolean', 'mtu': 'integer'}

Creates a private virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A private virtual interface can be connected to either a Direct Connect gateway or a Virtual Private Gateway (VGW). Connecting the private virtual interface to a Direct Connect gateway enables the possibility for connecting to multiple VPCs, including VPCs in different AWS Regions. Connecting the private virtual interface to a VGW only provides access to a single VPC within the same Region.

See also: AWS API Documentation

Request Syntax

client.create_private_virtual_interface(
    connectionId='string',
    newPrivateVirtualInterface={
        'virtualInterfaceName': 'string',
        'vlan': 123,
        'asn': 123,
        'mtu': 123,
        'authKey': 'string',
        'amazonAddress': 'string',
        'customerAddress': 'string',
        'addressFamily': 'ipv4'|'ipv6',
        'virtualGatewayId': 'string',
        'directConnectGatewayId': 'string'
    }
)

type connectionId

string

param connectionId

[REQUIRED]

The ID of the connection.

type newPrivateVirtualInterface

dict

param newPrivateVirtualInterface

[REQUIRED]

Information about the private virtual interface.

virtualInterfaceName (string) -- [REQUIRED]

The name of the virtual interface assigned by the customer network.
vlan (integer) -- [REQUIRED]

The ID of the VLAN.
asn (integer) -- [REQUIRED]

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

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
authKey (string) --

The authentication key for BGP configuration.
amazonAddress (string) --

The IP address assigned to the Amazon interface.
customerAddress (string) --

The IP address assigned to the customer interface.
addressFamily (string) --

The address family for the BGP peer.
virtualGatewayId (string) --

The ID of the virtual private gateway.
directConnectGatewayId (string) --

The ID of the Direct Connect gateway.

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'virtualInterfaceId': 'string',
    'location': 'string',
    'connectionId': 'string',
    'virtualInterfaceType': 'string',
    'virtualInterfaceName': 'string',
    'vlan': 123,
    'asn': 123,
    'amazonSideAsn': 123,
    'authKey': 'string',
    'amazonAddress': 'string',
    'customerAddress': 'string',
    'addressFamily': 'ipv4'|'ipv6',
    'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
    'customerRouterConfig': 'string',
    'mtu': 123,
    'jumboFrameCapable': True|False,
    'virtualGatewayId': 'string',
    'directConnectGatewayId': 'string',
    'routeFilterPrefixes': [
        {
            'cidr': 'string'
        },
    ],
    'bgpPeers': [
        {
            'asn': 123,
            'authKey': 'string',
            'addressFamily': 'ipv4'|'ipv6',
            'amazonAddress': 'string',
            'customerAddress': 'string',
            'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
            'bgpStatus': 'up'|'down',
            'awsDeviceV2': 'string'
        },
    ],
    'region': 'string',
    'awsDeviceV2': 'string'
}

Response Structure

(dict) --

Information about a virtual interface.
- ownerAccount (string) --
  
  The ID of the AWS account that owns the virtual interface.
- virtualInterfaceId (string) --
  
  The ID of the virtual interface.
- location (string) --
  
  The location of the connection.
- connectionId (string) --
  
  The ID of the connection.
- virtualInterfaceType (string) --
  
  The type of virtual interface. The possible values are private and public .
- virtualInterfaceName (string) --
  
  The name of the virtual interface assigned by the customer network.
- vlan (integer) --
  
  The ID of the VLAN.
- asn (integer) --
  
  The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
- amazonSideAsn (integer) --
  
  The autonomous system number (ASN) for the Amazon side of the connection.
- authKey (string) --
  
  The authentication key for BGP configuration.
- amazonAddress (string) --
  
  The IP address assigned to the Amazon interface.
- customerAddress (string) --
  
  The IP address assigned to the customer interface.
- addressFamily (string) --
  
  The address family for the BGP peer.
- virtualInterfaceState (string) --
  
  The state of the virtual interface. The following are the possible values:
  - confirming : The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
  - verifying : This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
  - pending : A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
  - available : A virtual interface that is able to forward traffic.
  - down : A virtual interface that is BGP down.
  - deleting : A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
  - deleted : A virtual interface that cannot forward traffic.
  - rejected : The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.
- customerRouterConfig (string) --
  
  The customer router configuration.
- mtu (integer) --
  
  The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames (9001 MTU) are supported.
- virtualGatewayId (string) --
  
  The ID of the virtual private gateway. Applies only to private virtual interfaces.
- directConnectGatewayId (string) --
  
  The ID of the Direct Connect gateway.
- routeFilterPrefixes (list) --
  
  The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
  - (dict) --
    
    Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
    - cidr (string) --
      
      The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
- bgpPeers (list) --
  
  The BGP peers configured on this virtual interface.
  - (dict) --
    
    Information about a BGP peer.
    - asn (integer) --
      
      The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
    - authKey (string) --
      
      The authentication key for BGP configuration.
    - addressFamily (string) --
      
      The address family for the BGP peer.
    - amazonAddress (string) --
      
      The IP address assigned to the Amazon interface.
    - customerAddress (string) --
      
      The IP address assigned to the customer interface.
    - bgpPeerState (string) --
      
      The state of the BGP peer. The following are the possible values:
      - verifying : The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
      - pending : The BGP peer is created, and remains in this state until it is ready to be established.
      - available : The BGP peer is ready to be established.
      - deleting : The BGP peer is being deleted.
      - deleted : The BGP peer is deleted and cannot be established.
    - bgpStatus (string) --
      
      The status of the BGP peer. The following are the possible values:
      - up : The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
      - down : The BGP peer is down.
      - unknown : The BGP peer status is unknown.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint on which the BGP peer terminates.
- region (string) --
  
  The AWS Region where the virtual interface is located.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint on which the virtual interface terminates.

CreatePublicVirtualInterface (updated)

Link ¶
Changes (response)

{'jumboFrameCapable': 'boolean', 'mtu': 'integer'}

Creates a public virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A public virtual interface supports sending traffic to public services of AWS such as Amazon S3.

When creating an IPv6 public virtual interface (addressFamily is ipv6 ), leave the customer and amazon address fields blank to use auto-assigned IPv6 space. Custom IPv6 addresses are not supported.

See also: AWS API Documentation

Request Syntax

client.create_public_virtual_interface(
    connectionId='string',
    newPublicVirtualInterface={
        'virtualInterfaceName': 'string',
        'vlan': 123,
        'asn': 123,
        'authKey': 'string',
        'amazonAddress': 'string',
        'customerAddress': 'string',
        'addressFamily': 'ipv4'|'ipv6',
        'routeFilterPrefixes': [
            {
                'cidr': 'string'
            },
        ]
    }
)

type connectionId

string

param connectionId

[REQUIRED]

The ID of the connection.

type newPublicVirtualInterface

dict

param newPublicVirtualInterface

[REQUIRED]

Information about the public virtual interface.

virtualInterfaceName (string) -- [REQUIRED]

The name of the virtual interface assigned by the customer network.
vlan (integer) -- [REQUIRED]

The ID of the VLAN.
asn (integer) -- [REQUIRED]

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

The authentication key for BGP configuration.
amazonAddress (string) --

The IP address assigned to the Amazon interface.
customerAddress (string) --

The IP address assigned to the customer interface.
addressFamily (string) --

The address family for the BGP peer.
routeFilterPrefixes (list) --

The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
- (dict) --
  
  Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
  - cidr (string) --
    
    The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'virtualInterfaceId': 'string',
    'location': 'string',
    'connectionId': 'string',
    'virtualInterfaceType': 'string',
    'virtualInterfaceName': 'string',
    'vlan': 123,
    'asn': 123,
    'amazonSideAsn': 123,
    'authKey': 'string',
    'amazonAddress': 'string',
    'customerAddress': 'string',
    'addressFamily': 'ipv4'|'ipv6',
    'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
    'customerRouterConfig': 'string',
    'mtu': 123,
    'jumboFrameCapable': True|False,
    'virtualGatewayId': 'string',
    'directConnectGatewayId': 'string',
    'routeFilterPrefixes': [
        {
            'cidr': 'string'
        },
    ],
    'bgpPeers': [
        {
            'asn': 123,
            'authKey': 'string',
            'addressFamily': 'ipv4'|'ipv6',
            'amazonAddress': 'string',
            'customerAddress': 'string',
            'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
            'bgpStatus': 'up'|'down',
            'awsDeviceV2': 'string'
        },
    ],
    'region': 'string',
    'awsDeviceV2': 'string'
}

Response Structure

(dict) --

Information about a virtual interface.
- ownerAccount (string) --
  
  The ID of the AWS account that owns the virtual interface.
- virtualInterfaceId (string) --
  
  The ID of the virtual interface.
- location (string) --
  
  The location of the connection.
- connectionId (string) --
  
  The ID of the connection.
- virtualInterfaceType (string) --
  
  The type of virtual interface. The possible values are private and public .
- virtualInterfaceName (string) --
  
  The name of the virtual interface assigned by the customer network.
- vlan (integer) --
  
  The ID of the VLAN.
- asn (integer) --
  
  The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
- amazonSideAsn (integer) --
  
  The autonomous system number (ASN) for the Amazon side of the connection.
- authKey (string) --
  
  The authentication key for BGP configuration.
- amazonAddress (string) --
  
  The IP address assigned to the Amazon interface.
- customerAddress (string) --
  
  The IP address assigned to the customer interface.
- addressFamily (string) --
  
  The address family for the BGP peer.
- virtualInterfaceState (string) --
  
  The state of the virtual interface. The following are the possible values:
  - confirming : The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
  - verifying : This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
  - pending : A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
  - available : A virtual interface that is able to forward traffic.
  - down : A virtual interface that is BGP down.
  - deleting : A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
  - deleted : A virtual interface that cannot forward traffic.
  - rejected : The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.
- customerRouterConfig (string) --
  
  The customer router configuration.
- mtu (integer) --
  
  The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames (9001 MTU) are supported.
- virtualGatewayId (string) --
  
  The ID of the virtual private gateway. Applies only to private virtual interfaces.
- directConnectGatewayId (string) --
  
  The ID of the Direct Connect gateway.
- routeFilterPrefixes (list) --
  
  The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
  - (dict) --
    
    Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
    - cidr (string) --
      
      The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
- bgpPeers (list) --
  
  The BGP peers configured on this virtual interface.
  - (dict) --
    
    Information about a BGP peer.
    - asn (integer) --
      
      The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
    - authKey (string) --
      
      The authentication key for BGP configuration.
    - addressFamily (string) --
      
      The address family for the BGP peer.
    - amazonAddress (string) --
      
      The IP address assigned to the Amazon interface.
    - customerAddress (string) --
      
      The IP address assigned to the customer interface.
    - bgpPeerState (string) --
      
      The state of the BGP peer. The following are the possible values:
      - verifying : The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
      - pending : The BGP peer is created, and remains in this state until it is ready to be established.
      - available : The BGP peer is ready to be established.
      - deleting : The BGP peer is being deleted.
      - deleted : The BGP peer is deleted and cannot be established.
    - bgpStatus (string) --
      
      The status of the BGP peer. The following are the possible values:
      - up : The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
      - down : The BGP peer is down.
      - unknown : The BGP peer status is unknown.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint on which the BGP peer terminates.
- region (string) --
  
  The AWS Region where the virtual interface is located.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint on which the virtual interface terminates.

DeleteBGPPeer (updated)

Link ¶
Changes (response)

{'virtualInterface': {'jumboFrameCapable': 'boolean', 'mtu': 'integer'}}

Deletes the 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.

See also: AWS API Documentation

Request Syntax

client.delete_bgp_peer(
    virtualInterfaceId='string',
    asn=123,
    customerAddress='string'
)

type virtualInterfaceId

string

param virtualInterfaceId

The ID of the virtual interface.

type asn

integer

param asn

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

type customerAddress

string

param customerAddress

The IP address assigned to the customer interface.

rtype

dict

returns

Response Syntax

{
    'virtualInterface': {
        'ownerAccount': 'string',
        'virtualInterfaceId': 'string',
        'location': 'string',
        'connectionId': 'string',
        'virtualInterfaceType': 'string',
        'virtualInterfaceName': 'string',
        'vlan': 123,
        'asn': 123,
        'amazonSideAsn': 123,
        'authKey': 'string',
        'amazonAddress': 'string',
        'customerAddress': 'string',
        'addressFamily': 'ipv4'|'ipv6',
        'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
        'customerRouterConfig': 'string',
        'mtu': 123,
        'jumboFrameCapable': True|False,
        'virtualGatewayId': 'string',
        'directConnectGatewayId': 'string',
        'routeFilterPrefixes': [
            {
                'cidr': 'string'
            },
        ],
        'bgpPeers': [
            {
                'asn': 123,
                'authKey': 'string',
                'addressFamily': 'ipv4'|'ipv6',
                'amazonAddress': 'string',
                'customerAddress': 'string',
                'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
                'bgpStatus': 'up'|'down',
                'awsDeviceV2': 'string'
            },
        ],
        'region': 'string',
        'awsDeviceV2': 'string'
    }
}

Response Structure

(dict) --
- virtualInterface (dict) --
  
  The virtual interface.
  - ownerAccount (string) --
    
    The ID of the AWS account that owns the virtual interface.
  - virtualInterfaceId (string) --
    
    The ID of the virtual interface.
  - location (string) --
    
    The location of the connection.
  - connectionId (string) --
    
    The ID of the connection.
  - virtualInterfaceType (string) --
    
    The type of virtual interface. The possible values are private and public .
  - virtualInterfaceName (string) --
    
    The name of the virtual interface assigned by the customer network.
  - vlan (integer) --
    
    The ID of the VLAN.
  - asn (integer) --
    
    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
  - amazonSideAsn (integer) --
    
    The autonomous system number (ASN) for the Amazon side of the connection.
  - authKey (string) --
    
    The authentication key for BGP configuration.
  - amazonAddress (string) --
    
    The IP address assigned to the Amazon interface.
  - customerAddress (string) --
    
    The IP address assigned to the customer interface.
  - addressFamily (string) --
    
    The address family for the BGP peer.
  - virtualInterfaceState (string) --
    
    The state of the virtual interface. The following are the possible values:
    - confirming : The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
    - verifying : This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
    - pending : A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
    - available : A virtual interface that is able to forward traffic.
    - down : A virtual interface that is BGP down.
    - deleting : A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
    - deleted : A virtual interface that cannot forward traffic.
    - rejected : The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.
  - customerRouterConfig (string) --
    
    The customer router configuration.
  - mtu (integer) --
    
    The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
  - jumboFrameCapable (boolean) --
    
    Indicates whether jumbo frames (9001 MTU) are supported.
  - virtualGatewayId (string) --
    
    The ID of the virtual private gateway. Applies only to private virtual interfaces.
  - directConnectGatewayId (string) --
    
    The ID of the Direct Connect gateway.
  - routeFilterPrefixes (list) --
    
    The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
    - (dict) --
      
      Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
      - cidr (string) --
        
        The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
  - bgpPeers (list) --
    
    The BGP peers configured on this virtual interface.
    - (dict) --
      
      Information about a BGP peer.
      - asn (integer) --
        
        The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
      - authKey (string) --
        
        The authentication key for BGP configuration.
      - addressFamily (string) --
        
        The address family for the BGP peer.
      - amazonAddress (string) --
        
        The IP address assigned to the Amazon interface.
      - customerAddress (string) --
        
        The IP address assigned to the customer interface.
      - bgpPeerState (string) --
        
        The state of the BGP peer. The following are the possible values:
        
        verifying : The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
        
        pending : The BGP peer is created, and remains in this state until it is ready to be established.
        
        available : The BGP peer is ready to be established.
        
        deleting : The BGP peer is being deleted.
        
        deleted : The BGP peer is deleted and cannot be established.
      - bgpStatus (string) --
        
        The status of the BGP peer. The following are the possible values:
        
        up : The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
        
        down : The BGP peer is down.
        
        unknown : The BGP peer status is unknown.
      - awsDeviceV2 (string) --
        
        The Direct Connect endpoint on which the BGP peer terminates.
  - region (string) --
    
    The AWS Region where the virtual interface is located.
  - awsDeviceV2 (string) --
    
    The Direct Connect endpoint on which the virtual interface terminates.

DeleteConnection (updated)

Link ¶
Changes (response)

{'jumboFrameCapable': 'boolean'}

Deletes the specified connection.

Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. If you are partnering with any third parties to connect with the AWS Direct Connect location, you must cancel your service with them separately.

See also: AWS API Documentation

Request Syntax

client.delete_connection(
    connectionId='string'
)

type connectionId

string

param connectionId

[REQUIRED]

The ID of the connection.

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'connectionId': 'string',
    'connectionName': 'string',
    'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
    'region': 'string',
    'location': 'string',
    'bandwidth': 'string',
    'vlan': 123,
    'partnerName': 'string',
    'loaIssueTime': datetime(2015, 1, 1),
    'lagId': 'string',
    'awsDevice': 'string',
    'jumboFrameCapable': True|False,
    'awsDeviceV2': 'string'
}

Response Structure

(dict) --

Information about an AWS Direct Connect connection.
- ownerAccount (string) --
  
  The ID of the AWS account that owns the connection.
- connectionId (string) --
  
  The ID of the connection.
- connectionName (string) --
  
  The name of the connection.
- connectionState (string) --
  
  The state of the connection. The following are the possible values:
  - ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
  - requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  - pending : The connection has been approved and is being initialized.
  - available : The network link is up and the connection is ready for use.
  - down : The network link is down.
  - deleting : The connection is being deleted.
  - deleted : The connection has been deleted.
  - rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
- region (string) --
  
  The AWS Region where the connection is located.
- location (string) --
  
  The location of the connection.
- bandwidth (string) --
  
  The bandwidth of the connection.
- vlan (integer) --
  
  The ID of the VLAN.
- partnerName (string) --
  
  The name of the AWS Direct Connect service provider associated with the connection.
- loaIssueTime (datetime) --
  
  The time of the most recent call to DescribeLoa for this connection.
- lagId (string) --
  
  The ID of the LAG.
- awsDevice (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames (9001 MTU) are supported.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.

DeleteLag (updated)

Link ¶
Changes (response)

{'connections': {'jumboFrameCapable': 'boolean'},
 'jumboFrameCapable': 'boolean'}

Deletes the specified link aggregation group (LAG). You cannot delete a LAG if it has active virtual interfaces or hosted connections.

See also: AWS API Documentation

Request Syntax

client.delete_lag(
    lagId='string'
)

type lagId

string

param lagId

[REQUIRED]

The ID of the LAG.

rtype

dict

returns

Response Syntax

{
    'connectionsBandwidth': 'string',
    'numberOfConnections': 123,
    'lagId': 'string',
    'ownerAccount': 'string',
    'lagName': 'string',
    'lagState': 'requested'|'pending'|'available'|'down'|'deleting'|'deleted',
    'location': 'string',
    'region': 'string',
    'minimumLinks': 123,
    'awsDevice': 'string',
    'awsDeviceV2': 'string',
    'connections': [
        {
            'ownerAccount': 'string',
            'connectionId': 'string',
            'connectionName': 'string',
            'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
            'region': 'string',
            'location': 'string',
            'bandwidth': 'string',
            'vlan': 123,
            'partnerName': 'string',
            'loaIssueTime': datetime(2015, 1, 1),
            'lagId': 'string',
            'awsDevice': 'string',
            'jumboFrameCapable': True|False,
            'awsDeviceV2': 'string'
        },
    ],
    'allowsHostedConnections': True|False,
    'jumboFrameCapable': True|False
}

Response Structure

(dict) --

Information about a link aggregation group (LAG).
- connectionsBandwidth (string) --
  
  The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.
- numberOfConnections (integer) --
  
  The number of physical connections bundled by the LAG, up to a maximum of 10.
- lagId (string) --
  
  The ID of the LAG.
- ownerAccount (string) --
  
  The ID of the AWS account that owns the LAG.
- lagName (string) --
  
  The name of the LAG.
- lagState (string) --
  
  The state of the LAG. The following are the possible values:
  - requested : The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.
  - pending : The LAG has been approved and is being initialized.
  - available : The network link is established and the LAG is ready for use.
  - down : The network link is down.
  - deleting : The LAG is being deleted.
  - deleted : The LAG is deleted.
- location (string) --
  
  The location of the LAG.
- region (string) --
  
  The AWS Region where the connection is located.
- minimumLinks (integer) --
  
  The minimum number of physical connections that must be operational for the LAG itself to be operational.
- awsDevice (string) --
  
  The Direct Connect endpoint that hosts the LAG.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint that hosts the LAG.
- connections (list) --
  
  The connections bundled by the LAG.
  - (dict) --
    
    Information about an AWS Direct Connect connection.
    - ownerAccount (string) --
      
      The ID of the AWS account that owns the connection.
    - connectionId (string) --
      
      The ID of the connection.
    - connectionName (string) --
      
      The name of the connection.
    - connectionState (string) --
      
      The state of the connection. The following are the possible values:
      - ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
      - requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
      - pending : The connection has been approved and is being initialized.
      - available : The network link is up and the connection is ready for use.
      - down : The network link is down.
      - deleting : The connection is being deleted.
      - deleted : The connection has been deleted.
      - rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
    - region (string) --
      
      The AWS Region where the connection is located.
    - location (string) --
      
      The location of the connection.
    - bandwidth (string) --
      
      The bandwidth of the connection.
    - vlan (integer) --
      
      The ID of the VLAN.
    - partnerName (string) --
      
      The name of the AWS Direct Connect service provider associated with the connection.
    - loaIssueTime (datetime) --
      
      The time of the most recent call to DescribeLoa for this connection.
    - lagId (string) --
      
      The ID of the LAG.
    - awsDevice (string) --
      
      The Direct Connect endpoint on which the physical connection terminates.
    - jumboFrameCapable (boolean) --
      
      Indicates whether jumbo frames (9001 MTU) are supported.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint on which the physical connection terminates.
- allowsHostedConnections (boolean) --
  
  Indicates whether the LAG can host other connections.
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames (9001 MTU) are supported.

DescribeConnections (updated)

Link ¶
Changes (response)

{'connections': {'jumboFrameCapable': 'boolean'}}

Displays the specified connection or all connections in this Region.

See also: AWS API Documentation

Request Syntax

client.describe_connections(
    connectionId='string'
)

type connectionId

string

param connectionId

The ID of the connection.

rtype

dict

returns

Response Syntax

{
    'connections': [
        {
            'ownerAccount': 'string',
            'connectionId': 'string',
            'connectionName': 'string',
            'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
            'region': 'string',
            'location': 'string',
            'bandwidth': 'string',
            'vlan': 123,
            'partnerName': 'string',
            'loaIssueTime': datetime(2015, 1, 1),
            'lagId': 'string',
            'awsDevice': 'string',
            'jumboFrameCapable': True|False,
            'awsDeviceV2': 'string'
        },
    ]
}

Response Structure

(dict) --
- connections (list) --
  
  The connections.
  - (dict) --
    
    Information about an AWS Direct Connect connection.
    - ownerAccount (string) --
      
      The ID of the AWS account that owns the connection.
    - connectionId (string) --
      
      The ID of the connection.
    - connectionName (string) --
      
      The name of the connection.
    - connectionState (string) --
      
      The state of the connection. The following are the possible values:
      - ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
      - requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
      - pending : The connection has been approved and is being initialized.
      - available : The network link is up and the connection is ready for use.
      - down : The network link is down.
      - deleting : The connection is being deleted.
      - deleted : The connection has been deleted.
      - rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
    - region (string) --
      
      The AWS Region where the connection is located.
    - location (string) --
      
      The location of the connection.
    - bandwidth (string) --
      
      The bandwidth of the connection.
    - vlan (integer) --
      
      The ID of the VLAN.
    - partnerName (string) --
      
      The name of the AWS Direct Connect service provider associated with the connection.
    - loaIssueTime (datetime) --
      
      The time of the most recent call to DescribeLoa for this connection.
    - lagId (string) --
      
      The ID of the LAG.
    - awsDevice (string) --
      
      The Direct Connect endpoint on which the physical connection terminates.
    - jumboFrameCapable (boolean) --
      
      Indicates whether jumbo frames (9001 MTU) are supported.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint on which the physical connection terminates.

DescribeConnectionsOnInterconnect (updated)

Link ¶
Changes (response)

{'connections': {'jumboFrameCapable': 'boolean'}}

Deprecated. Use DescribeHostedConnections instead.

Lists the connections that have been provisioned on the specified interconnect.

Note

Intended for use by AWS Direct Connect partners only.

!DANGER!

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

client.describe_connections_on_interconnect(
    interconnectId='string'
)

type interconnectId

string

param interconnectId

[REQUIRED]

The ID of the interconnect.

rtype

dict

returns

Response Syntax

{
    'connections': [
        {
            'ownerAccount': 'string',
            'connectionId': 'string',
            'connectionName': 'string',
            'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
            'region': 'string',
            'location': 'string',
            'bandwidth': 'string',
            'vlan': 123,
            'partnerName': 'string',
            'loaIssueTime': datetime(2015, 1, 1),
            'lagId': 'string',
            'awsDevice': 'string',
            'jumboFrameCapable': True|False,
            'awsDeviceV2': 'string'
        },
    ]
}

Response Structure

(dict) --
- connections (list) --
  
  The connections.
  - (dict) --
    
    Information about an AWS Direct Connect connection.
    - ownerAccount (string) --
      
      The ID of the AWS account that owns the connection.
    - connectionId (string) --
      
      The ID of the connection.
    - connectionName (string) --
      
      The name of the connection.
    - connectionState (string) --
      
      The state of the connection. The following are the possible values:
      - ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
      - requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
      - pending : The connection has been approved and is being initialized.
      - available : The network link is up and the connection is ready for use.
      - down : The network link is down.
      - deleting : The connection is being deleted.
      - deleted : The connection has been deleted.
      - rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
    - region (string) --
      
      The AWS Region where the connection is located.
    - location (string) --
      
      The location of the connection.
    - bandwidth (string) --
      
      The bandwidth of the connection.
    - vlan (integer) --
      
      The ID of the VLAN.
    - partnerName (string) --
      
      The name of the AWS Direct Connect service provider associated with the connection.
    - loaIssueTime (datetime) --
      
      The time of the most recent call to DescribeLoa for this connection.
    - lagId (string) --
      
      The ID of the LAG.
    - awsDevice (string) --
      
      The Direct Connect endpoint on which the physical connection terminates.
    - jumboFrameCapable (boolean) --
      
      Indicates whether jumbo frames (9001 MTU) are supported.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint on which the physical connection terminates.

DescribeHostedConnections (updated)

Link ¶
Changes (response)

{'connections': {'jumboFrameCapable': 'boolean'}}

Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG).

Note

Intended for use by AWS Direct Connect partners only.

See also: AWS API Documentation

Request Syntax

client.describe_hosted_connections(
    connectionId='string'
)

type connectionId

string

param connectionId

[REQUIRED]

The ID of the interconnect or LAG.

rtype

dict

returns

Response Syntax

{
    'connections': [
        {
            'ownerAccount': 'string',
            'connectionId': 'string',
            'connectionName': 'string',
            'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
            'region': 'string',
            'location': 'string',
            'bandwidth': 'string',
            'vlan': 123,
            'partnerName': 'string',
            'loaIssueTime': datetime(2015, 1, 1),
            'lagId': 'string',
            'awsDevice': 'string',
            'jumboFrameCapable': True|False,
            'awsDeviceV2': 'string'
        },
    ]
}

Response Structure

(dict) --
- connections (list) --
  
  The connections.
  - (dict) --
    
    Information about an AWS Direct Connect connection.
    - ownerAccount (string) --
      
      The ID of the AWS account that owns the connection.
    - connectionId (string) --
      
      The ID of the connection.
    - connectionName (string) --
      
      The name of the connection.
    - connectionState (string) --
      
      The state of the connection. The following are the possible values:
      - ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
      - requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
      - pending : The connection has been approved and is being initialized.
      - available : The network link is up and the connection is ready for use.
      - down : The network link is down.
      - deleting : The connection is being deleted.
      - deleted : The connection has been deleted.
      - rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
    - region (string) --
      
      The AWS Region where the connection is located.
    - location (string) --
      
      The location of the connection.
    - bandwidth (string) --
      
      The bandwidth of the connection.
    - vlan (integer) --
      
      The ID of the VLAN.
    - partnerName (string) --
      
      The name of the AWS Direct Connect service provider associated with the connection.
    - loaIssueTime (datetime) --
      
      The time of the most recent call to DescribeLoa for this connection.
    - lagId (string) --
      
      The ID of the LAG.
    - awsDevice (string) --
      
      The Direct Connect endpoint on which the physical connection terminates.
    - jumboFrameCapable (boolean) --
      
      Indicates whether jumbo frames (9001 MTU) are supported.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint on which the physical connection terminates.

DescribeInterconnects (updated)

Link ¶
Changes (response)

{'interconnects': {'jumboFrameCapable': 'boolean'}}

Lists the interconnects owned by the AWS account or only the specified interconnect.

See also: AWS API Documentation

Request Syntax

client.describe_interconnects(
    interconnectId='string'
)

type interconnectId

string

param interconnectId

The ID of the interconnect.

rtype

dict

returns

Response Syntax

{
    'interconnects': [
        {
            'interconnectId': 'string',
            'interconnectName': 'string',
            'interconnectState': 'requested'|'pending'|'available'|'down'|'deleting'|'deleted',
            'region': 'string',
            'location': 'string',
            'bandwidth': 'string',
            'loaIssueTime': datetime(2015, 1, 1),
            'lagId': 'string',
            'awsDevice': 'string',
            'jumboFrameCapable': True|False,
            'awsDeviceV2': 'string'
        },
    ]
}

Response Structure

(dict) --
- interconnects (list) --
  
  The interconnects.
  - (dict) --
    
    Information about an interconnect.
    - interconnectId (string) --
      
      The ID of the interconnect.
    - interconnectName (string) --
      
      The name of the interconnect.
    - interconnectState (string) --
      
      The state of the interconnect. The following are the possible values:
      - requested : The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
      - pending : The interconnect is approved, and is being initialized.
      - available : The network link is up, and the interconnect is ready for use.
      - down : The network link is down.
      - deleting : The interconnect is being deleted.
      - deleted : The interconnect is deleted.
    - region (string) --
      
      The AWS Region where the connection is located.
    - location (string) --
      
      The location of the connection.
    - bandwidth (string) --
      
      The bandwidth of the connection.
    - loaIssueTime (datetime) --
      
      The time of the most recent call to DescribeLoa for this connection.
    - lagId (string) --
      
      The ID of the LAG.
    - awsDevice (string) --
      
      The Direct Connect endpoint on which the physical connection terminates.
    - jumboFrameCapable (boolean) --
      
      Indicates whether jumbo frames (9001 MTU) are supported.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint on which the physical connection terminates.

DescribeLags (updated)

Link ¶
Changes (response)

{'lags': {'connections': {'jumboFrameCapable': 'boolean'},
          'jumboFrameCapable': 'boolean'}}

Describes all your link aggregation groups (LAG) or the specified LAG.

See also: AWS API Documentation

Request Syntax

client.describe_lags(
    lagId='string'
)

type lagId

string

param lagId

The ID of the LAG.

rtype

dict

returns

Response Syntax

{
    'lags': [
        {
            'connectionsBandwidth': 'string',
            'numberOfConnections': 123,
            'lagId': 'string',
            'ownerAccount': 'string',
            'lagName': 'string',
            'lagState': 'requested'|'pending'|'available'|'down'|'deleting'|'deleted',
            'location': 'string',
            'region': 'string',
            'minimumLinks': 123,
            'awsDevice': 'string',
            'awsDeviceV2': 'string',
            'connections': [
                {
                    'ownerAccount': 'string',
                    'connectionId': 'string',
                    'connectionName': 'string',
                    'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
                    'region': 'string',
                    'location': 'string',
                    'bandwidth': 'string',
                    'vlan': 123,
                    'partnerName': 'string',
                    'loaIssueTime': datetime(2015, 1, 1),
                    'lagId': 'string',
                    'awsDevice': 'string',
                    'jumboFrameCapable': True|False,
                    'awsDeviceV2': 'string'
                },
            ],
            'allowsHostedConnections': True|False,
            'jumboFrameCapable': True|False
        },
    ]
}

Response Structure

(dict) --
- lags (list) --
  
  The LAGs.
  - (dict) --
    
    Information about a link aggregation group (LAG).
    - connectionsBandwidth (string) --
      
      The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.
    - numberOfConnections (integer) --
      
      The number of physical connections bundled by the LAG, up to a maximum of 10.
    - lagId (string) --
      
      The ID of the LAG.
    - ownerAccount (string) --
      
      The ID of the AWS account that owns the LAG.
    - lagName (string) --
      
      The name of the LAG.
    - lagState (string) --
      
      The state of the LAG. The following are the possible values:
      - requested : The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.
      - pending : The LAG has been approved and is being initialized.
      - available : The network link is established and the LAG is ready for use.
      - down : The network link is down.
      - deleting : The LAG is being deleted.
      - deleted : The LAG is deleted.
    - location (string) --
      
      The location of the LAG.
    - region (string) --
      
      The AWS Region where the connection is located.
    - minimumLinks (integer) --
      
      The minimum number of physical connections that must be operational for the LAG itself to be operational.
    - awsDevice (string) --
      
      The Direct Connect endpoint that hosts the LAG.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint that hosts the LAG.
    - connections (list) --
      
      The connections bundled by the LAG.
      - (dict) --
        
        Information about an AWS Direct Connect connection.
        
        ownerAccount (string) --
        
        The ID of the AWS account that owns the connection.
        
        connectionId (string) --
        
        The ID of the connection.
        
        connectionName (string) --
        
        The name of the connection.
        
        connectionState (string) --
        
        The state of the connection. The following are the possible values:
        
        ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
        
        requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
        
        pending : The connection has been approved and is being initialized.
        
        available : The network link is up and the connection is ready for use.
        
        down : The network link is down.
        
        deleting : The connection is being deleted.
        
        deleted : The connection has been deleted.
        
        rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
        
        region (string) --
        
        The AWS Region where the connection is located.
        
        location (string) --
        
        The location of the connection.
        
        bandwidth (string) --
        
        The bandwidth of the connection.
        
        vlan (integer) --
        
        The ID of the VLAN.
        
        partnerName (string) --
        
        The name of the AWS Direct Connect service provider associated with the connection.
        
        loaIssueTime (datetime) --
        
        The time of the most recent call to DescribeLoa for this connection.
        
        lagId (string) --
        
        The ID of the LAG.
        
        awsDevice (string) --
        
        The Direct Connect endpoint on which the physical connection terminates.
        
        jumboFrameCapable (boolean) --
        
        Indicates whether jumbo frames (9001 MTU) are supported.
        
        awsDeviceV2 (string) --
        
        The Direct Connect endpoint on which the physical connection terminates.
    - allowsHostedConnections (boolean) --
      
      Indicates whether the LAG can host other connections.
    - jumboFrameCapable (boolean) --
      
      Indicates whether jumbo frames (9001 MTU) are supported.

DescribeVirtualInterfaces (updated)

Link ¶
Changes (response)

{'virtualInterfaces': {'jumboFrameCapable': 'boolean', 'mtu': 'integer'}}

Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before you make the request are also returned. If you specify a connection ID, only the virtual interfaces associated with the connection are returned. If you specify a virtual interface ID, then only a single virtual interface is returned.

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

See also: AWS API Documentation

Request Syntax

client.describe_virtual_interfaces(
    connectionId='string',
    virtualInterfaceId='string'
)

type connectionId

string

param connectionId

The ID of the connection.

type virtualInterfaceId

string

param virtualInterfaceId

The ID of the virtual interface.

rtype

dict

returns

Response Syntax

{
    'virtualInterfaces': [
        {
            'ownerAccount': 'string',
            'virtualInterfaceId': 'string',
            'location': 'string',
            'connectionId': 'string',
            'virtualInterfaceType': 'string',
            'virtualInterfaceName': 'string',
            'vlan': 123,
            'asn': 123,
            'amazonSideAsn': 123,
            'authKey': 'string',
            'amazonAddress': 'string',
            'customerAddress': 'string',
            'addressFamily': 'ipv4'|'ipv6',
            'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
            'customerRouterConfig': 'string',
            'mtu': 123,
            'jumboFrameCapable': True|False,
            'virtualGatewayId': 'string',
            'directConnectGatewayId': 'string',
            'routeFilterPrefixes': [
                {
                    'cidr': 'string'
                },
            ],
            'bgpPeers': [
                {
                    'asn': 123,
                    'authKey': 'string',
                    'addressFamily': 'ipv4'|'ipv6',
                    'amazonAddress': 'string',
                    'customerAddress': 'string',
                    'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
                    'bgpStatus': 'up'|'down',
                    'awsDeviceV2': 'string'
                },
            ],
            'region': 'string',
            'awsDeviceV2': 'string'
        },
    ]
}

Response Structure

(dict) --
- virtualInterfaces (list) --
  
  The virtual interfaces
  - (dict) --
    
    Information about a virtual interface.
    - ownerAccount (string) --
      
      The ID of the AWS account that owns the virtual interface.
    - virtualInterfaceId (string) --
      
      The ID of the virtual interface.
    - location (string) --
      
      The location of the connection.
    - connectionId (string) --
      
      The ID of the connection.
    - virtualInterfaceType (string) --
      
      The type of virtual interface. The possible values are private and public .
    - virtualInterfaceName (string) --
      
      The name of the virtual interface assigned by the customer network.
    - vlan (integer) --
      
      The ID of the VLAN.
    - asn (integer) --
      
      The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
    - amazonSideAsn (integer) --
      
      The autonomous system number (ASN) for the Amazon side of the connection.
    - authKey (string) --
      
      The authentication key for BGP configuration.
    - amazonAddress (string) --
      
      The IP address assigned to the Amazon interface.
    - customerAddress (string) --
      
      The IP address assigned to the customer interface.
    - addressFamily (string) --
      
      The address family for the BGP peer.
    - virtualInterfaceState (string) --
      
      The state of the virtual interface. The following are the possible values:
      - confirming : The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
      - verifying : This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
      - pending : A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
      - available : A virtual interface that is able to forward traffic.
      - down : A virtual interface that is BGP down.
      - deleting : A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
      - deleted : A virtual interface that cannot forward traffic.
      - rejected : The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.
    - customerRouterConfig (string) --
      
      The customer router configuration.
    - mtu (integer) --
      
      The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
    - jumboFrameCapable (boolean) --
      
      Indicates whether jumbo frames (9001 MTU) are supported.
    - virtualGatewayId (string) --
      
      The ID of the virtual private gateway. Applies only to private virtual interfaces.
    - directConnectGatewayId (string) --
      
      The ID of the Direct Connect gateway.
    - routeFilterPrefixes (list) --
      
      The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
      - (dict) --
        
        Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
        
        cidr (string) --
        
        The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
    - bgpPeers (list) --
      
      The BGP peers configured on this virtual interface.
      - (dict) --
        
        Information about a BGP peer.
        
        asn (integer) --
        
        The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
        
        authKey (string) --
        
        The authentication key for BGP configuration.
        
        addressFamily (string) --
        
        The address family for the BGP peer.
        
        amazonAddress (string) --
        
        The IP address assigned to the Amazon interface.
        
        customerAddress (string) --
        
        The IP address assigned to the customer interface.
        
        bgpPeerState (string) --
        
        The state of the BGP peer. The following are the possible values:
        
        verifying : The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
        
        pending : The BGP peer is created, and remains in this state until it is ready to be established.
        
        available : The BGP peer is ready to be established.
        
        deleting : The BGP peer is being deleted.
        
        deleted : The BGP peer is deleted and cannot be established.
        
        bgpStatus (string) --
        
        The status of the BGP peer. The following are the possible values:
        
        up : The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
        
        down : The BGP peer is down.
        
        unknown : The BGP peer status is unknown.
        
        awsDeviceV2 (string) --
        
        The Direct Connect endpoint on which the BGP peer terminates.
    - region (string) --
      
      The AWS Region where the virtual interface is located.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint on which the virtual interface terminates.

DisassociateConnectionFromLag (updated)

Link ¶
Changes (response)

{'jumboFrameCapable': 'boolean'}

Disassociates a connection from a link aggregation group (LAG). The connection is interrupted and re-established as a standalone connection (the connection is not deleted; to delete the connection, use the DeleteConnection request). If the LAG has associated virtual interfaces or hosted connections, they remain associated with the LAG. A disassociated connection owned by an AWS Direct Connect partner is automatically converted to an interconnect.

If disassociating the connection would cause the LAG to fall below its setting for minimum number of operational connections, the request fails, except when it's the last member of the LAG. If all connections are disassociated, the LAG continues to exist as an empty LAG with no physical connections.

See also: AWS API Documentation

Request Syntax

client.disassociate_connection_from_lag(
    connectionId='string',
    lagId='string'
)

type connectionId

string

param connectionId

[REQUIRED]

The ID of the connection. For example, dxcon-abc123.

type lagId

string

param lagId

[REQUIRED]

The ID of the LAG. For example, dxlag-abc123.

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'connectionId': 'string',
    'connectionName': 'string',
    'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
    'region': 'string',
    'location': 'string',
    'bandwidth': 'string',
    'vlan': 123,
    'partnerName': 'string',
    'loaIssueTime': datetime(2015, 1, 1),
    'lagId': 'string',
    'awsDevice': 'string',
    'jumboFrameCapable': True|False,
    'awsDeviceV2': 'string'
}

Response Structure

(dict) --

Information about an AWS Direct Connect connection.
- ownerAccount (string) --
  
  The ID of the AWS account that owns the connection.
- connectionId (string) --
  
  The ID of the connection.
- connectionName (string) --
  
  The name of the connection.
- connectionState (string) --
  
  The state of the connection. The following are the possible values:
  - ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
  - requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  - pending : The connection has been approved and is being initialized.
  - available : The network link is up and the connection is ready for use.
  - down : The network link is down.
  - deleting : The connection is being deleted.
  - deleted : The connection has been deleted.
  - rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
- region (string) --
  
  The AWS Region where the connection is located.
- location (string) --
  
  The location of the connection.
- bandwidth (string) --
  
  The bandwidth of the connection.
- vlan (integer) --
  
  The ID of the VLAN.
- partnerName (string) --
  
  The name of the AWS Direct Connect service provider associated with the connection.
- loaIssueTime (datetime) --
  
  The time of the most recent call to DescribeLoa for this connection.
- lagId (string) --
  
  The ID of the LAG.
- awsDevice (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames (9001 MTU) are supported.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.

UpdateLag (updated)

Link ¶
Changes (response)

{'connections': {'jumboFrameCapable': 'boolean'},
 'jumboFrameCapable': 'boolean'}

Updates the attributes of the specified link aggregation group (LAG).

You can update the following attributes:

The name of the LAG.
The value for the minimum number of connections that must be operational for the LAG itself to be operational.

When you create a LAG, the default value for the minimum number of operational connections is zero (0). If you update this value and the number of operational connections falls below the specified value, the LAG automatically goes down to avoid over-utilization of the remaining connections. Adjust this value with care, as it could force the LAG down if it is set higher than the current number of operational connections.

See also: AWS API Documentation

Request Syntax

client.update_lag(
    lagId='string',
    lagName='string',
    minimumLinks=123
)

type lagId

string

param lagId

[REQUIRED]

The ID of the LAG.

type lagName

string

param lagName

The name of the LAG.

type minimumLinks

integer

param minimumLinks

The minimum number of physical connections that must be operational for the LAG itself to be operational.

rtype

dict

returns

Response Syntax

{
    'connectionsBandwidth': 'string',
    'numberOfConnections': 123,
    'lagId': 'string',
    'ownerAccount': 'string',
    'lagName': 'string',
    'lagState': 'requested'|'pending'|'available'|'down'|'deleting'|'deleted',
    'location': 'string',
    'region': 'string',
    'minimumLinks': 123,
    'awsDevice': 'string',
    'awsDeviceV2': 'string',
    'connections': [
        {
            'ownerAccount': 'string',
            'connectionId': 'string',
            'connectionName': 'string',
            'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
            'region': 'string',
            'location': 'string',
            'bandwidth': 'string',
            'vlan': 123,
            'partnerName': 'string',
            'loaIssueTime': datetime(2015, 1, 1),
            'lagId': 'string',
            'awsDevice': 'string',
            'jumboFrameCapable': True|False,
            'awsDeviceV2': 'string'
        },
    ],
    'allowsHostedConnections': True|False,
    'jumboFrameCapable': True|False
}

Response Structure

(dict) --

Information about a link aggregation group (LAG).
- connectionsBandwidth (string) --
  
  The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.
- numberOfConnections (integer) --
  
  The number of physical connections bundled by the LAG, up to a maximum of 10.
- lagId (string) --
  
  The ID of the LAG.
- ownerAccount (string) --
  
  The ID of the AWS account that owns the LAG.
- lagName (string) --
  
  The name of the LAG.
- lagState (string) --
  
  The state of the LAG. The following are the possible values:
  - requested : The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.
  - pending : The LAG has been approved and is being initialized.
  - available : The network link is established and the LAG is ready for use.
  - down : The network link is down.
  - deleting : The LAG is being deleted.
  - deleted : The LAG is deleted.
- location (string) --
  
  The location of the LAG.
- region (string) --
  
  The AWS Region where the connection is located.
- minimumLinks (integer) --
  
  The minimum number of physical connections that must be operational for the LAG itself to be operational.
- awsDevice (string) --
  
  The Direct Connect endpoint that hosts the LAG.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint that hosts the LAG.
- connections (list) --
  
  The connections bundled by the LAG.
  - (dict) --
    
    Information about an AWS Direct Connect connection.
    - ownerAccount (string) --
      
      The ID of the AWS account that owns the connection.
    - connectionId (string) --
      
      The ID of the connection.
    - connectionName (string) --
      
      The name of the connection.
    - connectionState (string) --
      
      The state of the connection. The following are the possible values:
      - ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
      - requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
      - pending : The connection has been approved and is being initialized.
      - available : The network link is up and the connection is ready for use.
      - down : The network link is down.
      - deleting : The connection is being deleted.
      - deleted : The connection has been deleted.
      - rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
    - region (string) --
      
      The AWS Region where the connection is located.
    - location (string) --
      
      The location of the connection.
    - bandwidth (string) --
      
      The bandwidth of the connection.
    - vlan (integer) --
      
      The ID of the VLAN.
    - partnerName (string) --
      
      The name of the AWS Direct Connect service provider associated with the connection.
    - loaIssueTime (datetime) --
      
      The time of the most recent call to DescribeLoa for this connection.
    - lagId (string) --
      
      The ID of the LAG.
    - awsDevice (string) --
      
      The Direct Connect endpoint on which the physical connection terminates.
    - jumboFrameCapable (boolean) --
      
      Indicates whether jumbo frames (9001 MTU) are supported.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint on which the physical connection terminates.
- allowsHostedConnections (boolean) --
  
  Indicates whether the LAG can host other connections.
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames (9001 MTU) are supported.

UpdateVirtualInterfaceAttributes (updated)

Link ¶
Changes (response)

{'jumboFrameCapable': 'boolean', 'mtu': 'integer'}

Updates the specified attributes of the specified virtual private interface.

See also: AWS API Documentation

Request Syntax

client.update_virtual_interface_attributes(
    virtualInterfaceId='string',
    mtu=123
)

type virtualInterfaceId

string

param virtualInterfaceId

[REQUIRED]

The ID of the virtual private interface.

type mtu

integer

param mtu

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'virtualInterfaceId': 'string',
    'location': 'string',
    'connectionId': 'string',
    'virtualInterfaceType': 'string',
    'virtualInterfaceName': 'string',
    'vlan': 123,
    'asn': 123,
    'amazonSideAsn': 123,
    'authKey': 'string',
    'amazonAddress': 'string',
    'customerAddress': 'string',
    'addressFamily': 'ipv4'|'ipv6',
    'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
    'customerRouterConfig': 'string',
    'mtu': 123,
    'jumboFrameCapable': True|False,
    'virtualGatewayId': 'string',
    'directConnectGatewayId': 'string',
    'routeFilterPrefixes': [
        {
            'cidr': 'string'
        },
    ],
    'bgpPeers': [
        {
            'asn': 123,
            'authKey': 'string',
            'addressFamily': 'ipv4'|'ipv6',
            'amazonAddress': 'string',
            'customerAddress': 'string',
            'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
            'bgpStatus': 'up'|'down',
            'awsDeviceV2': 'string'
        },
    ],
    'region': 'string',
    'awsDeviceV2': 'string'
}

Response Structure

(dict) --

Information about a virtual interface.
- ownerAccount (string) --
  
  The ID of the AWS account that owns the virtual interface.
- virtualInterfaceId (string) --
  
  The ID of the virtual interface.
- location (string) --
  
  The location of the connection.
- connectionId (string) --
  
  The ID of the connection.
- virtualInterfaceType (string) --
  
  The type of virtual interface. The possible values are private and public .
- virtualInterfaceName (string) --
  
  The name of the virtual interface assigned by the customer network.
- vlan (integer) --
  
  The ID of the VLAN.
- asn (integer) --
  
  The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
- amazonSideAsn (integer) --
  
  The autonomous system number (ASN) for the Amazon side of the connection.
- authKey (string) --
  
  The authentication key for BGP configuration.
- amazonAddress (string) --
  
  The IP address assigned to the Amazon interface.
- customerAddress (string) --
  
  The IP address assigned to the customer interface.
- addressFamily (string) --
  
  The address family for the BGP peer.
- virtualInterfaceState (string) --
  
  The state of the virtual interface. The following are the possible values:
  - confirming : The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
  - verifying : This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
  - pending : A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
  - available : A virtual interface that is able to forward traffic.
  - down : A virtual interface that is BGP down.
  - deleting : A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
  - deleted : A virtual interface that cannot forward traffic.
  - rejected : The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.
- customerRouterConfig (string) --
  
  The customer router configuration.
- mtu (integer) --
  
  The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames (9001 MTU) are supported.
- virtualGatewayId (string) --
  
  The ID of the virtual private gateway. Applies only to private virtual interfaces.
- directConnectGatewayId (string) --
  
  The ID of the Direct Connect gateway.
- routeFilterPrefixes (list) --
  
  The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
  - (dict) --
    
    Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
    - cidr (string) --
      
      The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
- bgpPeers (list) --
  
  The BGP peers configured on this virtual interface.
  - (dict) --
    
    Information about a BGP peer.
    - asn (integer) --
      
      The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
    - authKey (string) --
      
      The authentication key for BGP configuration.
    - addressFamily (string) --
      
      The address family for the BGP peer.
    - amazonAddress (string) --
      
      The IP address assigned to the Amazon interface.
    - customerAddress (string) --
      
      The IP address assigned to the customer interface.
    - bgpPeerState (string) --
      
      The state of the BGP peer. The following are the possible values:
      - verifying : The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
      - pending : The BGP peer is created, and remains in this state until it is ready to be established.
      - available : The BGP peer is ready to be established.
      - deleting : The BGP peer is being deleted.
      - deleted : The BGP peer is deleted and cannot be established.
    - bgpStatus (string) --
      
      The status of the BGP peer. The following are the possible values:
      - up : The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
      - down : The BGP peer is down.
      - unknown : The BGP peer status is unknown.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint on which the BGP peer terminates.
- region (string) --
  
  The AWS Region where the virtual interface is located.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint on which the virtual interface terminates.