AWS API Changes

2025/08/14 - AWS Direct Connect - 16 updated api methods

Changes Added pagination support for DescribeHostedConnections, DescribeVirtualInterfaces, DescribeConnections, DescribeInterconnects, DescribeLags. Added asnLong support for BGP peer operations which supports a large range.

AllocatePrivateVirtualInterface (updated)

Link ¶
Changes (request, response)
Request

{'newPrivateVirtualInterfaceAllocation': {'asnLong': 'long'}}

Response

{'asnLong': 'long', 'bgpPeers': {'asnLong': 'long'}}

Provisions a private virtual interface to be owned by the specified Amazon Web Services 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,
        'asnLong': 123,
        'mtu': 123,
        'authKey': 'string',
        'amazonAddress': 'string',
        'addressFamily': 'ipv4'|'ipv6',
        'customerAddress': 'string',
        'tags': [
            {
                'key': 'string',
                'value': '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 Amazon Web Services 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. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
vlan (integer) -- [REQUIRED]

The ID of the VLAN.
asn (integer) --

The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.
Note

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
- The asnLong attribute accepts both ASN and long ASN ranges.
- If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
The valid values are 1-2147483646.
asnLong (integer) --

The ASN when allocating a new private virtual interface. The valid range is from 1 to 4294967294 for BGP configuration.
Note

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
- The asnLong attribute accepts both ASN and long ASN ranges.
- If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
mtu (integer) --

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

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
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.
tags (list) --

The tags associated with the private virtual interface.
- (dict) --
  
  Information about a tag.
  - key (string) -- [REQUIRED]
    
    The key.
  - value (string) --
    
    The value.

rtype:

dict

returns:

Response Syntax

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

Response Structure

(dict) --

Information about a virtual interface.
- ownerAccount (string) --
  
  The ID of the Amazon Web Services 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, public and transit.
- virtualInterfaceName (string) --
  
  The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
- vlan (integer) --
  
  The ID of the VLAN.
- asn (integer) --
  
  The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.
  Note
  
  You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
  - The asnLong attribute accepts both ASN and long ASN ranges.
  - If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
- asnLong (integer) --
  
  The long ASN for the virtual interface. The valid range is from 1 to 4294967294 for BGP configuration.
  Note
  
  You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
  - The asnLong attribute accepts both ASN and long ASN ranges.
  - If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
- amazonSideAsn (integer) --
  
  The autonomous system number (AS) for the Amazon side of the connection.
- authKey (string) --
  
  The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
- 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.
  - testing: A virtual interface is in this state immediately after calling StartBgpFailoverTest and remains in this state during the duration of the test.
  - 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.
  - unknown: The state of the virtual interface is not available.
- customerRouterConfig (string) --
  
  The customer router configuration.
- mtu (integer) --
  
  The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames 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 Amazon Web Services 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.
    - bgpPeerId (string) --
      
      The ID of the BGP peer.
    - asn (integer) --
      
      The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.
      Note
      
      You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
      
      The asnLong attribute accepts both ASN and long ASN ranges.
      
      If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
    - asnLong (integer) --
      
      The long ASN for the BGP peer. The valid range is from 1 to 4294967294 for BGP configuration.
      Note
      
      You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
      
      The asnLong attribute accepts both ASN and long ASN ranges.
      
      If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
    - authKey (string) --
      
      The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
    - 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 not available.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint that terminates the BGP peer.
    - awsLogicalDeviceId (string) --
      
      The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
- region (string) --
  
  The Amazon Web Services Region where the virtual interface is located.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint that terminates the physical connection.
- awsLogicalDeviceId (string) --
  
  The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
- tags (list) --
  
  The tags associated with the virtual interface.
  - (dict) --
    
    Information about a tag.
    - key (string) --
      
      The key.
    - value (string) --
      
      The value.
- siteLinkEnabled (boolean) --
  
  Indicates whether SiteLink is enabled.

AllocatePublicVirtualInterface (updated)

Link ¶
Changes (request, response)
Request

{'newPublicVirtualInterfaceAllocation': {'asnLong': 'long'}}

Response

{'asnLong': 'long', 'bgpPeers': {'asnLong': 'long'}}

Provisions a public virtual interface to be owned by the specified Amazon Web Services account.

The owner of a connection calls this function to provision a public virtual interface to be owned by the specified Amazon Web Services 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,
        'asnLong': 123,
        'authKey': 'string',
        'amazonAddress': 'string',
        'customerAddress': 'string',
        'addressFamily': 'ipv4'|'ipv6',
        'routeFilterPrefixes': [
            {
                'cidr': 'string'
            },
        ],
        'tags': [
            {
                'key': 'string',
                'value': '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 Amazon Web Services 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. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
vlan (integer) -- [REQUIRED]

The ID of the VLAN.
asn (integer) --

The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.
Note

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
- The asnLong attribute accepts both ASN and long ASN ranges.
- If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
The valid values are 1-2147483646.
asnLong (integer) --

The ASN when allocating a new public virtual interface. The valid range is from 1 to 4294967294 for BGP configuration.
Note

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
- The asnLong attribute accepts both ASN and long ASN ranges.
- If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
authKey (string) --

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
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 Amazon Web Services 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.
tags (list) --

The tags associated with the public virtual interface.
- (dict) --
  
  Information about a tag.
  - key (string) -- [REQUIRED]
    
    The key.
  - value (string) --
    
    The value.

rtype:

dict

returns:

Response Syntax

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

Response Structure

(dict) --

Information about a virtual interface.
- ownerAccount (string) --
  
  The ID of the Amazon Web Services 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, public and transit.
- virtualInterfaceName (string) --
  
  The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
- vlan (integer) --
  
  The ID of the VLAN.
- asn (integer) --
  
  The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.
  Note
  
  You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
  - The asnLong attribute accepts both ASN and long ASN ranges.
  - If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
- asnLong (integer) --
  
  The long ASN for the virtual interface. The valid range is from 1 to 4294967294 for BGP configuration.
  Note
  
  You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
  - The asnLong attribute accepts both ASN and long ASN ranges.
  - If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
- amazonSideAsn (integer) --
  
  The autonomous system number (AS) for the Amazon side of the connection.
- authKey (string) --
  
  The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
- 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.
  - testing: A virtual interface is in this state immediately after calling StartBgpFailoverTest and remains in this state during the duration of the test.
  - 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.
  - unknown: The state of the virtual interface is not available.
- customerRouterConfig (string) --
  
  The customer router configuration.
- mtu (integer) --
  
  The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames 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 Amazon Web Services 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.
    - bgpPeerId (string) --
      
      The ID of the BGP peer.
    - asn (integer) --
      
      The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.
      Note
      
      You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
      
      The asnLong attribute accepts both ASN and long ASN ranges.
      
      If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
    - asnLong (integer) --
      
      The long ASN for the BGP peer. The valid range is from 1 to 4294967294 for BGP configuration.
      Note
      
      You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
      
      The asnLong attribute accepts both ASN and long ASN ranges.
      
      If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
    - authKey (string) --
      
      The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
    - 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 not available.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint that terminates the BGP peer.
    - awsLogicalDeviceId (string) --
      
      The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
- region (string) --
  
  The Amazon Web Services Region where the virtual interface is located.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint that terminates the physical connection.
- awsLogicalDeviceId (string) --
  
  The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
- tags (list) --
  
  The tags associated with the virtual interface.
  - (dict) --
    
    Information about a tag.
    - key (string) --
      
      The key.
    - value (string) --
      
      The value.
- siteLinkEnabled (boolean) --
  
  Indicates whether SiteLink is enabled.

AllocateTransitVirtualInterface (updated)

Link ¶
Changes (request, response)
Request

{'newTransitVirtualInterfaceAllocation': {'asnLong': 'long'}}

Response

{'virtualInterface': {'asnLong': 'long', 'bgpPeers': {'asnLong': 'long'}}}

Provisions a transit virtual interface to be owned by the specified Amazon Web Services account. Use this type of interface to connect a transit gateway to your Direct Connect gateway.

The owner of a connection provisions a transit virtual interface to be owned by the specified Amazon Web Services account.

After you create a transit virtual interface, it must be confirmed by the owner using ConfirmTransitVirtualInterface. Until this step has been completed, the transit virtual interface is in the requested state and is not available to handle traffic.

See also: AWS API Documentation

Request Syntax

client.allocate_transit_virtual_interface(
    connectionId='string',
    ownerAccount='string',
    newTransitVirtualInterfaceAllocation={
        'virtualInterfaceName': 'string',
        'vlan': 123,
        'asn': 123,
        'asnLong': 123,
        'mtu': 123,
        'authKey': 'string',
        'amazonAddress': 'string',
        'customerAddress': 'string',
        'addressFamily': 'ipv4'|'ipv6',
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ]
    }
)

type connectionId:

string

param connectionId:

[REQUIRED]

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

type ownerAccount:

string

param ownerAccount:

[REQUIRED]

The ID of the Amazon Web Services account that owns the transit virtual interface.

type newTransitVirtualInterfaceAllocation:

dict

param newTransitVirtualInterfaceAllocation:

[REQUIRED]

Information about the transit virtual interface.

virtualInterfaceName (string) --

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
vlan (integer) --

The ID of the VLAN.
asn (integer) --

The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.
Note

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
- The asnLong attribute accepts both ASN and long ASN ranges.
- If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
The valid values are 1-2147483646.
asnLong (integer) --

The ASN when allocating a new transit virtual interface. The valid range is from 1 to 4294967294 for BGP configuration.
Note

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
- The asnLong attribute accepts both ASN and long ASN ranges.
- If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
mtu (integer) --

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

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
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.
tags (list) --

The tags associated with the transitive virtual interface.
- (dict) --
  
  Information about a tag.
  - key (string) -- [REQUIRED]
    
    The key.
  - value (string) --
    
    The value.

rtype:

dict

returns:

Response Syntax

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

Response Structure

(dict) --
- virtualInterface (dict) --
  
  Information about the transit virtual interface.
  - ownerAccount (string) --
    
    The ID of the Amazon Web Services 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, public and transit.
  - virtualInterfaceName (string) --
    
    The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
  - vlan (integer) --
    
    The ID of the VLAN.
  - asn (integer) --
    
    The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.
    Note
    
    You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
    - The asnLong attribute accepts both ASN and long ASN ranges.
    - If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
  - asnLong (integer) --
    
    The long ASN for the virtual interface. The valid range is from 1 to 4294967294 for BGP configuration.
    Note
    
    You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
    - The asnLong attribute accepts both ASN and long ASN ranges.
    - If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
  - amazonSideAsn (integer) --
    
    The autonomous system number (AS) for the Amazon side of the connection.
  - authKey (string) --
    
    The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
  - 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.
    - testing: A virtual interface is in this state immediately after calling StartBgpFailoverTest and remains in this state during the duration of the test.
    - 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.
    - unknown: The state of the virtual interface is not available.
  - customerRouterConfig (string) --
    
    The customer router configuration.
  - mtu (integer) --
    
    The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500
  - jumboFrameCapable (boolean) --
    
    Indicates whether jumbo frames 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 Amazon Web Services 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.
      - bgpPeerId (string) --
        
        The ID of the BGP peer.
      - asn (integer) --
        
        The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.
        
        Note
        
        You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
        
        The asnLong attribute accepts both ASN and long ASN ranges.
        
        If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
      - asnLong (integer) --
        
        The long ASN for the BGP peer. The valid range is from 1 to 4294967294 for BGP configuration.
        
        Note
        
        You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
        
        The asnLong attribute accepts both ASN and long ASN ranges.
        
        If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
      - authKey (string) --
        
        The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
      - 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 not available.
      - awsDeviceV2 (string) --
        
        The Direct Connect endpoint that terminates the BGP peer.
      - awsLogicalDeviceId (string) --
        
        The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
  - region (string) --
    
    The Amazon Web Services Region where the virtual interface is located.
  - awsDeviceV2 (string) --
    
    The Direct Connect endpoint that terminates the physical connection.
  - awsLogicalDeviceId (string) --
    
    The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
  - tags (list) --
    
    The tags associated with the virtual interface.
    - (dict) --
      
      Information about a tag.
      - key (string) --
        
        The key.
      - value (string) --
        
        The value.
  - siteLinkEnabled (boolean) --
    
    Indicates whether SiteLink is enabled.

AssociateVirtualInterface (updated)

Link ¶
Changes (response)

{'asnLong': 'long', 'bgpPeers': {'asnLong': 'long'}}

Associates a virtual interface with a specified link aggregation group (LAG) or connection. Connectivity to Amazon Web Services 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,
    'asnLong': 123,
    'amazonSideAsn': 123,
    'authKey': 'string',
    'amazonAddress': 'string',
    'customerAddress': 'string',
    'addressFamily': 'ipv4'|'ipv6',
    'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'testing'|'deleting'|'deleted'|'rejected'|'unknown',
    'customerRouterConfig': 'string',
    'mtu': 123,
    'jumboFrameCapable': True|False,
    'virtualGatewayId': 'string',
    'directConnectGatewayId': 'string',
    'routeFilterPrefixes': [
        {
            'cidr': 'string'
        },
    ],
    'bgpPeers': [
        {
            'bgpPeerId': 'string',
            'asn': 123,
            'asnLong': 123,
            'authKey': 'string',
            'addressFamily': 'ipv4'|'ipv6',
            'amazonAddress': 'string',
            'customerAddress': 'string',
            'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
            'bgpStatus': 'up'|'down'|'unknown',
            'awsDeviceV2': 'string',
            'awsLogicalDeviceId': 'string'
        },
    ],
    'region': 'string',
    'awsDeviceV2': 'string',
    'awsLogicalDeviceId': 'string',
    'tags': [
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    'siteLinkEnabled': True|False
}

Response Structure

(dict) --

Information about a virtual interface.
- ownerAccount (string) --
  
  The ID of the Amazon Web Services 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, public and transit.
- virtualInterfaceName (string) --
  
  The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
- vlan (integer) --
  
  The ID of the VLAN.
- asn (integer) --
  
  The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.
  Note
  
  You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
  - The asnLong attribute accepts both ASN and long ASN ranges.
  - If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
- asnLong (integer) --
  
  The long ASN for the virtual interface. The valid range is from 1 to 4294967294 for BGP configuration.
  Note
  
  You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
  - The asnLong attribute accepts both ASN and long ASN ranges.
  - If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
- amazonSideAsn (integer) --
  
  The autonomous system number (AS) for the Amazon side of the connection.
- authKey (string) --
  
  The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
- 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.
  - testing: A virtual interface is in this state immediately after calling StartBgpFailoverTest and remains in this state during the duration of the test.
  - 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.
  - unknown: The state of the virtual interface is not available.
- customerRouterConfig (string) --
  
  The customer router configuration.
- mtu (integer) --
  
  The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames 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 Amazon Web Services 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.
    - bgpPeerId (string) --
      
      The ID of the BGP peer.
    - asn (integer) --
      
      The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.
      Note
      
      You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
      
      The asnLong attribute accepts both ASN and long ASN ranges.
      
      If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
    - asnLong (integer) --
      
      The long ASN for the BGP peer. The valid range is from 1 to 4294967294 for BGP configuration.
      Note
      
      You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
      
      The asnLong attribute accepts both ASN and long ASN ranges.
      
      If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
    - authKey (string) --
      
      The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
    - 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 not available.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint that terminates the BGP peer.
    - awsLogicalDeviceId (string) --
      
      The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
- region (string) --
  
  The Amazon Web Services Region where the virtual interface is located.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint that terminates the physical connection.
- awsLogicalDeviceId (string) --
  
  The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
- tags (list) --
  
  The tags associated with the virtual interface.
  - (dict) --
    
    Information about a tag.
    - key (string) --
      
      The key.
    - value (string) --
      
      The value.
- siteLinkEnabled (boolean) --
  
  Indicates whether SiteLink is enabled.

CreateBGPPeer (updated)

Link ¶
Changes (request, response)
Request

{'newBGPPeer': {'asnLong': 'long'}}

Response

{'virtualInterface': {'asnLong': 'long', 'bgpPeers': {'asnLong': 'long'}}}

Creates a BGP peer on the specified virtual interface.

You must create a BGP peer for the corresponding address family (IPv4/IPv6) in order to access Amazon Web Services resources that also use that address family.

If logical redundancy is not supported by the connection, interconnect, or LAG, the BGP peer cannot be in the same address family as an existing BGP peer on the virtual interface.

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 on the allow list for the virtual interface.

See also: AWS API Documentation

Request Syntax

client.create_bgp_peer(
    virtualInterfaceId='string',
    newBGPPeer={
        'asn': 123,
        'asnLong': 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 number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.
asnLong (integer) --

The long ASN for a new BGP peer. The valid range is from 1 to 4294967294.
authKey (string) --

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
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,
        'asnLong': 123,
        'amazonSideAsn': 123,
        'authKey': 'string',
        'amazonAddress': 'string',
        'customerAddress': 'string',
        'addressFamily': 'ipv4'|'ipv6',
        'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'testing'|'deleting'|'deleted'|'rejected'|'unknown',
        'customerRouterConfig': 'string',
        'mtu': 123,
        'jumboFrameCapable': True|False,
        'virtualGatewayId': 'string',
        'directConnectGatewayId': 'string',
        'routeFilterPrefixes': [
            {
                'cidr': 'string'
            },
        ],
        'bgpPeers': [
            {
                'bgpPeerId': 'string',
                'asn': 123,
                'asnLong': 123,
                'authKey': 'string',
                'addressFamily': 'ipv4'|'ipv6',
                'amazonAddress': 'string',
                'customerAddress': 'string',
                'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
                'bgpStatus': 'up'|'down'|'unknown',
                'awsDeviceV2': 'string',
                'awsLogicalDeviceId': 'string'
            },
        ],
        'region': 'string',
        'awsDeviceV2': 'string',
        'awsLogicalDeviceId': 'string',
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        'siteLinkEnabled': True|False
    }
}

Response Structure

(dict) --
- virtualInterface (dict) --
  
  The virtual interface.
  - ownerAccount (string) --
    
    The ID of the Amazon Web Services 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, public and transit.
  - virtualInterfaceName (string) --
    
    The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
  - vlan (integer) --
    
    The ID of the VLAN.
  - asn (integer) --
    
    The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.
    Note
    
    You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
    - The asnLong attribute accepts both ASN and long ASN ranges.
    - If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
  - asnLong (integer) --
    
    The long ASN for the virtual interface. The valid range is from 1 to 4294967294 for BGP configuration.
    Note
    
    You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
    - The asnLong attribute accepts both ASN and long ASN ranges.
    - If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
  - amazonSideAsn (integer) --
    
    The autonomous system number (AS) for the Amazon side of the connection.
  - authKey (string) --
    
    The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
  - 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.
    - testing: A virtual interface is in this state immediately after calling StartBgpFailoverTest and remains in this state during the duration of the test.
    - 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.
    - unknown: The state of the virtual interface is not available.
  - customerRouterConfig (string) --
    
    The customer router configuration.
  - mtu (integer) --
    
    The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500
  - jumboFrameCapable (boolean) --
    
    Indicates whether jumbo frames 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 Amazon Web Services 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.
      - bgpPeerId (string) --
        
        The ID of the BGP peer.
      - asn (integer) --
        
        The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.
        
        Note
        
        You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
        
        The asnLong attribute accepts both ASN and long ASN ranges.
        
        If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
      - asnLong (integer) --
        
        The long ASN for the BGP peer. The valid range is from 1 to 4294967294 for BGP configuration.
        
        Note
        
        You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
        
        The asnLong attribute accepts both ASN and long ASN ranges.
        
        If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
      - authKey (string) --
        
        The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
      - 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 not available.
      - awsDeviceV2 (string) --
        
        The Direct Connect endpoint that terminates the BGP peer.
      - awsLogicalDeviceId (string) --
        
        The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
  - region (string) --
    
    The Amazon Web Services Region where the virtual interface is located.
  - awsDeviceV2 (string) --
    
    The Direct Connect endpoint that terminates the physical connection.
  - awsLogicalDeviceId (string) --
    
    The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
  - tags (list) --
    
    The tags associated with the virtual interface.
    - (dict) --
      
      Information about a tag.
      - key (string) --
        
        The key.
      - value (string) --
        
        The value.
  - siteLinkEnabled (boolean) --
    
    Indicates whether SiteLink is enabled.

CreatePrivateVirtualInterface (updated)

Link ¶
Changes (request, response)
Request

{'newPrivateVirtualInterface': {'asnLong': 'long'}}

Response

{'asnLong': 'long', 'bgpPeers': {'asnLong': 'long'}}

Creates a private virtual interface. A virtual interface is the VLAN that transports 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 Amazon Web Services Regions. Connecting the private virtual interface to a VGW only provides access to a single VPC within the same Region.

Setting the MTU of a virtual interface to 8500 (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.create_private_virtual_interface(
    connectionId='string',
    newPrivateVirtualInterface={
        'virtualInterfaceName': 'string',
        'vlan': 123,
        'asn': 123,
        'asnLong': 123,
        'mtu': 123,
        'authKey': 'string',
        'amazonAddress': 'string',
        'customerAddress': 'string',
        'addressFamily': 'ipv4'|'ipv6',
        'virtualGatewayId': 'string',
        'directConnectGatewayId': 'string',
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        'enableSiteLink': True|False
    }
)

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. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
vlan (integer) -- [REQUIRED]

The ID of the VLAN.
asn (integer) --

The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.
Note

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
- The asnLong attribute accepts both ASN and long ASN ranges.
- If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
The valid values are 1-2147483646.
asnLong (integer) --

The long ASN for a new private virtual interface. The valid range is from 1 to 4294967294 for BGP configuration.
Note

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
- The asnLong attribute accepts both ASN and long ASN ranges.
- If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
mtu (integer) --

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

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
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.
tags (list) --

The tags associated with the private virtual interface.
- (dict) --
  
  Information about a tag.
  - key (string) -- [REQUIRED]
    
    The key.
  - value (string) --
    
    The value.
enableSiteLink (boolean) --

Indicates whether to enable or disable SiteLink.

rtype:

dict

returns:

Response Syntax

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

Response Structure

(dict) --

Information about a virtual interface.
- ownerAccount (string) --
  
  The ID of the Amazon Web Services 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, public and transit.
- virtualInterfaceName (string) --
  
  The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
- vlan (integer) --
  
  The ID of the VLAN.
- asn (integer) --
  
  The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.
  Note
  
  You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
  - The asnLong attribute accepts both ASN and long ASN ranges.
  - If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
- asnLong (integer) --
  
  The long ASN for the virtual interface. The valid range is from 1 to 4294967294 for BGP configuration.
  Note
  
  You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
  - The asnLong attribute accepts both ASN and long ASN ranges.
  - If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
- amazonSideAsn (integer) --
  
  The autonomous system number (AS) for the Amazon side of the connection.
- authKey (string) --
  
  The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
- 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.
  - testing: A virtual interface is in this state immediately after calling StartBgpFailoverTest and remains in this state during the duration of the test.
  - 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.
  - unknown: The state of the virtual interface is not available.
- customerRouterConfig (string) --
  
  The customer router configuration.
- mtu (integer) --
  
  The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames 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 Amazon Web Services 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.
    - bgpPeerId (string) --
      
      The ID of the BGP peer.
    - asn (integer) --
      
      The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.
      Note
      
      You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
      
      The asnLong attribute accepts both ASN and long ASN ranges.
      
      If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
    - asnLong (integer) --
      
      The long ASN for the BGP peer. The valid range is from 1 to 4294967294 for BGP configuration.
      Note
      
      You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
      
      The asnLong attribute accepts both ASN and long ASN ranges.
      
      If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
    - authKey (string) --
      
      The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
    - 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 not available.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint that terminates the BGP peer.
    - awsLogicalDeviceId (string) --
      
      The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
- region (string) --
  
  The Amazon Web Services Region where the virtual interface is located.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint that terminates the physical connection.
- awsLogicalDeviceId (string) --
  
  The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
- tags (list) --
  
  The tags associated with the virtual interface.
  - (dict) --
    
    Information about a tag.
    - key (string) --
      
      The key.
    - value (string) --
      
      The value.
- siteLinkEnabled (boolean) --
  
  Indicates whether SiteLink is enabled.

CreatePublicVirtualInterface (updated)

Link ¶
Changes (request, response)
Request

{'newPublicVirtualInterface': {'asnLong': 'long'}}

Response

{'asnLong': 'long', 'bgpPeers': {'asnLong': 'long'}}

Creates a public virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. A public virtual interface supports sending traffic to public services of Amazon Web Services 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,
        'asnLong': 123,
        'authKey': 'string',
        'amazonAddress': 'string',
        'customerAddress': 'string',
        'addressFamily': 'ipv4'|'ipv6',
        'routeFilterPrefixes': [
            {
                'cidr': 'string'
            },
        ],
        'tags': [
            {
                'key': 'string',
                'value': '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. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
vlan (integer) -- [REQUIRED]

The ID of the VLAN.
asn (integer) --

The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.
Note

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
- The asnLong attribute accepts both ASN and long ASN ranges.
- If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
asnLong (integer) --

The long ASN for a new public virtual interface. The valid range is from 1 to 4294967294 for BGP configuration.
Note

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
- The asnLong attribute accepts both ASN and long ASN ranges.
- If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
authKey (string) --

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
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 Amazon Web Services 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.
tags (list) --

The tags associated with the public virtual interface.
- (dict) --
  
  Information about a tag.
  - key (string) -- [REQUIRED]
    
    The key.
  - value (string) --
    
    The value.

rtype:

dict

returns:

Response Syntax

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

Response Structure

(dict) --

Information about a virtual interface.
- ownerAccount (string) --
  
  The ID of the Amazon Web Services 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, public and transit.
- virtualInterfaceName (string) --
  
  The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
- vlan (integer) --
  
  The ID of the VLAN.
- asn (integer) --
  
  The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.
  Note
  
  You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
  - The asnLong attribute accepts both ASN and long ASN ranges.
  - If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
- asnLong (integer) --
  
  The long ASN for the virtual interface. The valid range is from 1 to 4294967294 for BGP configuration.
  Note
  
  You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
  - The asnLong attribute accepts both ASN and long ASN ranges.
  - If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
- amazonSideAsn (integer) --
  
  The autonomous system number (AS) for the Amazon side of the connection.
- authKey (string) --
  
  The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
- 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.
  - testing: A virtual interface is in this state immediately after calling StartBgpFailoverTest and remains in this state during the duration of the test.
  - 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.
  - unknown: The state of the virtual interface is not available.
- customerRouterConfig (string) --
  
  The customer router configuration.
- mtu (integer) --
  
  The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames 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 Amazon Web Services 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.
    - bgpPeerId (string) --
      
      The ID of the BGP peer.
    - asn (integer) --
      
      The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.
      Note
      
      You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
      
      The asnLong attribute accepts both ASN and long ASN ranges.
      
      If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
    - asnLong (integer) --
      
      The long ASN for the BGP peer. The valid range is from 1 to 4294967294 for BGP configuration.
      Note
      
      You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
      
      The asnLong attribute accepts both ASN and long ASN ranges.
      
      If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
    - authKey (string) --
      
      The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
    - 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 not available.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint that terminates the BGP peer.
    - awsLogicalDeviceId (string) --
      
      The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
- region (string) --
  
  The Amazon Web Services Region where the virtual interface is located.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint that terminates the physical connection.
- awsLogicalDeviceId (string) --
  
  The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
- tags (list) --
  
  The tags associated with the virtual interface.
  - (dict) --
    
    Information about a tag.
    - key (string) --
      
      The key.
    - value (string) --
      
      The value.
- siteLinkEnabled (boolean) --
  
  Indicates whether SiteLink is enabled.

CreateTransitVirtualInterface (updated)

Link ¶
Changes (request, response)
Request

{'newTransitVirtualInterface': {'asnLong': 'long'}}

Response

{'virtualInterface': {'asnLong': 'long', 'bgpPeers': {'asnLong': 'long'}}}

Creates a transit virtual interface. A transit virtual interface should be used to access one or more transit gateways associated with Direct Connect gateways. A transit virtual interface enables the connection of multiple VPCs attached to a transit gateway to a Direct Connect gateway.

A jumbo MTU value must be either 1500 or 8500. No other values will be accepted. Setting the MTU of a virtual interface to 8500 (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.create_transit_virtual_interface(
    connectionId='string',
    newTransitVirtualInterface={
        'virtualInterfaceName': 'string',
        'vlan': 123,
        'asn': 123,
        'asnLong': 123,
        'mtu': 123,
        'authKey': 'string',
        'amazonAddress': 'string',
        'customerAddress': 'string',
        'addressFamily': 'ipv4'|'ipv6',
        'directConnectGatewayId': 'string',
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        'enableSiteLink': True|False
    }
)

type connectionId:

string

param connectionId:

[REQUIRED]

The ID of the connection.

type newTransitVirtualInterface:

dict

param newTransitVirtualInterface:

[REQUIRED]

Information about the transit virtual interface.

virtualInterfaceName (string) --

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
vlan (integer) --

The ID of the VLAN.
asn (integer) --

The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.
Note

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
- The asnLong attribute accepts both ASN and long ASN ranges.
- If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
asnLong (integer) --

The long ASN for a new transit virtual interface.The valid range is from 1 to 4294967294 for BGP configuration.
Note

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
- The asnLong attribute accepts both ASN and long ASN ranges.
- If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
mtu (integer) --

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

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
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.
directConnectGatewayId (string) --

The ID of the Direct Connect gateway.
tags (list) --

The tags associated with the transitive virtual interface.
- (dict) --
  
  Information about a tag.
  - key (string) -- [REQUIRED]
    
    The key.
  - value (string) --
    
    The value.
enableSiteLink (boolean) --

Indicates whether to enable or disable SiteLink.

rtype:

dict

returns:

Response Syntax

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

Response Structure

(dict) --
- virtualInterface (dict) --
  
  Information about a virtual interface.
  - ownerAccount (string) --
    
    The ID of the Amazon Web Services 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, public and transit.
  - virtualInterfaceName (string) --
    
    The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
  - vlan (integer) --
    
    The ID of the VLAN.
  - asn (integer) --
    
    The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.
    Note
    
    You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
    - The asnLong attribute accepts both ASN and long ASN ranges.
    - If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
  - asnLong (integer) --
    
    The long ASN for the virtual interface. The valid range is from 1 to 4294967294 for BGP configuration.
    Note
    
    You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
    - The asnLong attribute accepts both ASN and long ASN ranges.
    - If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
  - amazonSideAsn (integer) --
    
    The autonomous system number (AS) for the Amazon side of the connection.
  - authKey (string) --
    
    The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
  - 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.
    - testing: A virtual interface is in this state immediately after calling StartBgpFailoverTest and remains in this state during the duration of the test.
    - 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.
    - unknown: The state of the virtual interface is not available.
  - customerRouterConfig (string) --
    
    The customer router configuration.
  - mtu (integer) --
    
    The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500
  - jumboFrameCapable (boolean) --
    
    Indicates whether jumbo frames 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 Amazon Web Services 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.
      - bgpPeerId (string) --
        
        The ID of the BGP peer.
      - asn (integer) --
        
        The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.
        
        Note
        
        You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
        
        The asnLong attribute accepts both ASN and long ASN ranges.
        
        If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
      - asnLong (integer) --
        
        The long ASN for the BGP peer. The valid range is from 1 to 4294967294 for BGP configuration.
        
        Note
        
        You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
        
        The asnLong attribute accepts both ASN and long ASN ranges.
        
        If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
      - authKey (string) --
        
        The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
      - 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 not available.
      - awsDeviceV2 (string) --
        
        The Direct Connect endpoint that terminates the BGP peer.
      - awsLogicalDeviceId (string) --
        
        The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
  - region (string) --
    
    The Amazon Web Services Region where the virtual interface is located.
  - awsDeviceV2 (string) --
    
    The Direct Connect endpoint that terminates the physical connection.
  - awsLogicalDeviceId (string) --
    
    The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
  - tags (list) --
    
    The tags associated with the virtual interface.
    - (dict) --
      
      Information about a tag.
      - key (string) --
        
        The key.
      - value (string) --
        
        The value.
  - siteLinkEnabled (boolean) --
    
    Indicates whether SiteLink is enabled.

DeleteBGPPeer (updated)

Link ¶
Changes (request, response)
Request

{'asnLong': 'long'}

Response

{'virtualInterface': {'asnLong': 'long', 'bgpPeers': {'asnLong': 'long'}}}

Deletes the specified BGP peer on the specified virtual interface with the specified customer address and ASN.

You cannot delete the last BGP peer from a virtual interface.

See also: AWS API Documentation

Request Syntax

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

type virtualInterfaceId:

string

param virtualInterfaceId:

The ID of the virtual interface.

type asn:

integer

param asn:

The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.

type asnLong:

integer

param asnLong:

The long ASN for the BGP peer to be deleted from a Direct Connect virtual interface. The valid range is from 1 to 4294967294 for BGP configuration.

type customerAddress:

string

param customerAddress:

The IP address assigned to the customer interface.

type bgpPeerId:

string

param bgpPeerId:

The ID of the BGP peer.

rtype:

dict

returns:

Response Syntax

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

Response Structure

(dict) --
- virtualInterface (dict) --
  
  The virtual interface.
  - ownerAccount (string) --
    
    The ID of the Amazon Web Services 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, public and transit.
  - virtualInterfaceName (string) --
    
    The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
  - vlan (integer) --
    
    The ID of the VLAN.
  - asn (integer) --
    
    The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.
    Note
    
    You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
    - The asnLong attribute accepts both ASN and long ASN ranges.
    - If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
  - asnLong (integer) --
    
    The long ASN for the virtual interface. The valid range is from 1 to 4294967294 for BGP configuration.
    Note
    
    You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
    - The asnLong attribute accepts both ASN and long ASN ranges.
    - If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
  - amazonSideAsn (integer) --
    
    The autonomous system number (AS) for the Amazon side of the connection.
  - authKey (string) --
    
    The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
  - 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.
    - testing: A virtual interface is in this state immediately after calling StartBgpFailoverTest and remains in this state during the duration of the test.
    - 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.
    - unknown: The state of the virtual interface is not available.
  - customerRouterConfig (string) --
    
    The customer router configuration.
  - mtu (integer) --
    
    The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500
  - jumboFrameCapable (boolean) --
    
    Indicates whether jumbo frames 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 Amazon Web Services 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.
      - bgpPeerId (string) --
        
        The ID of the BGP peer.
      - asn (integer) --
        
        The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.
        
        Note
        
        You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
        
        The asnLong attribute accepts both ASN and long ASN ranges.
        
        If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
      - asnLong (integer) --
        
        The long ASN for the BGP peer. The valid range is from 1 to 4294967294 for BGP configuration.
        
        Note
        
        You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
        
        The asnLong attribute accepts both ASN and long ASN ranges.
        
        If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
      - authKey (string) --
        
        The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
      - 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 not available.
      - awsDeviceV2 (string) --
        
        The Direct Connect endpoint that terminates the BGP peer.
      - awsLogicalDeviceId (string) --
        
        The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
  - region (string) --
    
    The Amazon Web Services Region where the virtual interface is located.
  - awsDeviceV2 (string) --
    
    The Direct Connect endpoint that terminates the physical connection.
  - awsLogicalDeviceId (string) --
    
    The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
  - tags (list) --
    
    The tags associated with the virtual interface.
    - (dict) --
      
      Information about a tag.
      - key (string) --
        
        The key.
      - value (string) --
        
        The value.
  - siteLinkEnabled (boolean) --
    
    Indicates whether SiteLink is enabled.

DescribeConnections (updated)

Link ¶
Changes (request, response)
Request

{'maxResults': 'integer', 'nextToken': 'string'}

Response

{'nextToken': 'string'}

Displays the specified connection or all connections in this Region.

See also: AWS API Documentation

Request Syntax

client.describe_connections(
    connectionId='string',
    maxResults=123,
    nextToken='string'
)

type connectionId:

string

param connectionId:

The ID of the connection.

type maxResults:

integer

param maxResults:

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

type nextToken:

string

param nextToken:

The token for the next page of results.

rtype:

dict

returns:

Response Syntax

{
    'connections': [
        {
            'ownerAccount': 'string',
            'connectionId': 'string',
            'connectionName': 'string',
            'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
            'region': 'string',
            'location': 'string',
            'bandwidth': 'string',
            'vlan': 123,
            'partnerName': 'string',
            'loaIssueTime': datetime(2015, 1, 1),
            'lagId': 'string',
            'awsDevice': 'string',
            'jumboFrameCapable': True|False,
            'awsDeviceV2': 'string',
            'awsLogicalDeviceId': 'string',
            'hasLogicalRedundancy': 'unknown'|'yes'|'no',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'providerName': 'string',
            'macSecCapable': True|False,
            'portEncryptionStatus': 'string',
            'encryptionMode': 'string',
            'macSecKeys': [
                {
                    'secretARN': 'string',
                    'ckn': 'string',
                    'state': 'string',
                    'startOn': 'string'
                },
            ],
            'partnerInterconnectMacSecCapable': True|False
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- connections (list) --
  
  The connections.
  - (dict) --
    
    Information about an Direct Connect connection.
    - ownerAccount (string) --
      
      The ID of the Amazon Web Services 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.
      - unknown: The state of the connection is not available.
    - region (string) --
      
      The Amazon Web Services 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 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 are supported.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint that terminates the physical connection.
    - awsLogicalDeviceId (string) --
      
      The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
    - hasLogicalRedundancy (string) --
      
      Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
    - tags (list) --
      
      The tags associated with the connection.
      - (dict) --
        
        Information about a tag.
        
        key (string) --
        
        The key.
        
        value (string) --
        
        The value.
    - providerName (string) --
      
      The name of the service provider associated with the connection.
    - macSecCapable (boolean) --
      
      Indicates whether the connection supports MAC Security (MACsec).
    - portEncryptionStatus (string) --
      
      The MAC Security (MACsec) port link status of the connection.
      
      The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.
    - encryptionMode (string) --
      
      The MAC Security (MACsec) connection encryption mode.
      
      The valid values are no_encrypt, should_encrypt, and must_encrypt.
    - macSecKeys (list) --
      
      The MAC Security (MACsec) security keys associated with the connection.
      - (dict) --
        
        Information about the MAC Security (MACsec) secret key.
        
        secretARN (string) --
        
        The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
        
        ckn (string) --
        
        The Connection Key Name (CKN) for the MAC Security secret key.
        
        state (string) --
        
        The state of the MAC Security (MACsec) secret key.
        
        The possible values are:
        
        associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
        
        associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
        
        disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
        
        disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
        
        startOn (string) --
        
        The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
    - partnerInterconnectMacSecCapable (boolean) --
      
      Indicates whether the interconnect hosting this connection supports MAC Security (MACsec).
- nextToken (string) --
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

DescribeConnectionsOnInterconnect (updated)

Link ¶
Changes (response)

{'nextToken': 'string'}

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

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'|'unknown',
            'region': 'string',
            'location': 'string',
            'bandwidth': 'string',
            'vlan': 123,
            'partnerName': 'string',
            'loaIssueTime': datetime(2015, 1, 1),
            'lagId': 'string',
            'awsDevice': 'string',
            'jumboFrameCapable': True|False,
            'awsDeviceV2': 'string',
            'awsLogicalDeviceId': 'string',
            'hasLogicalRedundancy': 'unknown'|'yes'|'no',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'providerName': 'string',
            'macSecCapable': True|False,
            'portEncryptionStatus': 'string',
            'encryptionMode': 'string',
            'macSecKeys': [
                {
                    'secretARN': 'string',
                    'ckn': 'string',
                    'state': 'string',
                    'startOn': 'string'
                },
            ],
            'partnerInterconnectMacSecCapable': True|False
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- connections (list) --
  
  The connections.
  - (dict) --
    
    Information about an Direct Connect connection.
    - ownerAccount (string) --
      
      The ID of the Amazon Web Services 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.
      - unknown: The state of the connection is not available.
    - region (string) --
      
      The Amazon Web Services 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 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 are supported.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint that terminates the physical connection.
    - awsLogicalDeviceId (string) --
      
      The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
    - hasLogicalRedundancy (string) --
      
      Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
    - tags (list) --
      
      The tags associated with the connection.
      - (dict) --
        
        Information about a tag.
        
        key (string) --
        
        The key.
        
        value (string) --
        
        The value.
    - providerName (string) --
      
      The name of the service provider associated with the connection.
    - macSecCapable (boolean) --
      
      Indicates whether the connection supports MAC Security (MACsec).
    - portEncryptionStatus (string) --
      
      The MAC Security (MACsec) port link status of the connection.
      
      The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.
    - encryptionMode (string) --
      
      The MAC Security (MACsec) connection encryption mode.
      
      The valid values are no_encrypt, should_encrypt, and must_encrypt.
    - macSecKeys (list) --
      
      The MAC Security (MACsec) security keys associated with the connection.
      - (dict) --
        
        Information about the MAC Security (MACsec) secret key.
        
        secretARN (string) --
        
        The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
        
        ckn (string) --
        
        The Connection Key Name (CKN) for the MAC Security secret key.
        
        state (string) --
        
        The state of the MAC Security (MACsec) secret key.
        
        The possible values are:
        
        associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
        
        associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
        
        disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
        
        disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
        
        startOn (string) --
        
        The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
    - partnerInterconnectMacSecCapable (boolean) --
      
      Indicates whether the interconnect hosting this connection supports MAC Security (MACsec).
- nextToken (string) --
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

DescribeHostedConnections (updated)

Link ¶
Changes (request, response)
Request

{'maxResults': 'integer', 'nextToken': 'string'}

Response

{'nextToken': 'string'}

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

See also: AWS API Documentation

Request Syntax

client.describe_hosted_connections(
    connectionId='string',
    maxResults=123,
    nextToken='string'
)

type connectionId:

string

param connectionId:

[REQUIRED]

The ID of the interconnect or LAG.

type maxResults:

integer

param maxResults:

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

type nextToken:

string

param nextToken:

The token for the next page of results.

rtype:

dict

returns:

Response Syntax

{
    'connections': [
        {
            'ownerAccount': 'string',
            'connectionId': 'string',
            'connectionName': 'string',
            'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
            'region': 'string',
            'location': 'string',
            'bandwidth': 'string',
            'vlan': 123,
            'partnerName': 'string',
            'loaIssueTime': datetime(2015, 1, 1),
            'lagId': 'string',
            'awsDevice': 'string',
            'jumboFrameCapable': True|False,
            'awsDeviceV2': 'string',
            'awsLogicalDeviceId': 'string',
            'hasLogicalRedundancy': 'unknown'|'yes'|'no',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'providerName': 'string',
            'macSecCapable': True|False,
            'portEncryptionStatus': 'string',
            'encryptionMode': 'string',
            'macSecKeys': [
                {
                    'secretARN': 'string',
                    'ckn': 'string',
                    'state': 'string',
                    'startOn': 'string'
                },
            ],
            'partnerInterconnectMacSecCapable': True|False
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- connections (list) --
  
  The connections.
  - (dict) --
    
    Information about an Direct Connect connection.
    - ownerAccount (string) --
      
      The ID of the Amazon Web Services 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.
      - unknown: The state of the connection is not available.
    - region (string) --
      
      The Amazon Web Services 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 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 are supported.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint that terminates the physical connection.
    - awsLogicalDeviceId (string) --
      
      The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
    - hasLogicalRedundancy (string) --
      
      Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
    - tags (list) --
      
      The tags associated with the connection.
      - (dict) --
        
        Information about a tag.
        
        key (string) --
        
        The key.
        
        value (string) --
        
        The value.
    - providerName (string) --
      
      The name of the service provider associated with the connection.
    - macSecCapable (boolean) --
      
      Indicates whether the connection supports MAC Security (MACsec).
    - portEncryptionStatus (string) --
      
      The MAC Security (MACsec) port link status of the connection.
      
      The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.
    - encryptionMode (string) --
      
      The MAC Security (MACsec) connection encryption mode.
      
      The valid values are no_encrypt, should_encrypt, and must_encrypt.
    - macSecKeys (list) --
      
      The MAC Security (MACsec) security keys associated with the connection.
      - (dict) --
        
        Information about the MAC Security (MACsec) secret key.
        
        secretARN (string) --
        
        The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
        
        ckn (string) --
        
        The Connection Key Name (CKN) for the MAC Security secret key.
        
        state (string) --
        
        The state of the MAC Security (MACsec) secret key.
        
        The possible values are:
        
        associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
        
        associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
        
        disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
        
        disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
        
        startOn (string) --
        
        The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
    - partnerInterconnectMacSecCapable (boolean) --
      
      Indicates whether the interconnect hosting this connection supports MAC Security (MACsec).
- nextToken (string) --
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

DescribeInterconnects (updated)

Link ¶
Changes (request, response)
Request

{'maxResults': 'integer', 'nextToken': 'string'}

Response

{'nextToken': 'string'}

Lists the interconnects owned by the Amazon Web Services account or only the specified interconnect.

See also: AWS API Documentation

Request Syntax

client.describe_interconnects(
    interconnectId='string',
    maxResults=123,
    nextToken='string'
)

type interconnectId:

string

param interconnectId:

The ID of the interconnect.

type maxResults:

integer

param maxResults:

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

type nextToken:

string

param nextToken:

The token for the next page of results.

rtype:

dict

returns:

Response Syntax

{
    'interconnects': [
        {
            'interconnectId': 'string',
            'interconnectName': 'string',
            'interconnectState': 'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'unknown',
            'region': 'string',
            'location': 'string',
            'bandwidth': 'string',
            'loaIssueTime': datetime(2015, 1, 1),
            'lagId': 'string',
            'awsDevice': 'string',
            'jumboFrameCapable': True|False,
            'awsDeviceV2': 'string',
            'awsLogicalDeviceId': 'string',
            'hasLogicalRedundancy': 'unknown'|'yes'|'no',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'providerName': 'string',
            'macSecCapable': True|False,
            'portEncryptionStatus': 'string',
            'encryptionMode': 'string',
            'macSecKeys': [
                {
                    'secretARN': 'string',
                    'ckn': 'string',
                    'state': 'string',
                    'startOn': 'string'
                },
            ]
        },
    ],
    'nextToken': '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.
      - unknown: The state of the interconnect is not available.
    - region (string) --
      
      The Amazon Web Services 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 are supported.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint that terminates the physical connection.
    - awsLogicalDeviceId (string) --
      
      The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
    - hasLogicalRedundancy (string) --
      
      Indicates whether the interconnect supports a secondary BGP in the same address family (IPv4/IPv6).
    - tags (list) --
      
      The tags associated with the interconnect.
      - (dict) --
        
        Information about a tag.
        
        key (string) --
        
        The key.
        
        value (string) --
        
        The value.
    - providerName (string) --
      
      The name of the service provider associated with the interconnect.
    - macSecCapable (boolean) --
      
      Indicates whether the interconnect supports MAC Security (MACsec).
    - portEncryptionStatus (string) --
      
      The MAC Security (MACsec) port link status.
      
      The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.
    - encryptionMode (string) --
      
      The MAC Security (MACsec) encryption mode.
      
      The valid values are no_encrypt, should_encrypt, and must_encrypt.
    - macSecKeys (list) --
      
      The MAC Security (MACsec) security keys.
      - (dict) --
        
        Information about the MAC Security (MACsec) secret key.
        
        secretARN (string) --
        
        The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
        
        ckn (string) --
        
        The Connection Key Name (CKN) for the MAC Security secret key.
        
        state (string) --
        
        The state of the MAC Security (MACsec) secret key.
        
        The possible values are:
        
        associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
        
        associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
        
        disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
        
        disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
        
        startOn (string) --
        
        The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
- nextToken (string) --
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

DescribeLags (updated)

Link ¶
Changes (request, response)
Request

{'maxResults': 'integer', 'nextToken': 'string'}

Response

{'nextToken': 'string'}

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

See also: AWS API Documentation

Request Syntax

client.describe_lags(
    lagId='string',
    maxResults=123,
    nextToken='string'
)

type lagId:

string

param lagId:

The ID of the LAG.

type maxResults:

integer

param maxResults:

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

type nextToken:

string

param nextToken:

The token for the next page of results.

rtype:

dict

returns:

Response Syntax

{
    'lags': [
        {
            'connectionsBandwidth': 'string',
            'numberOfConnections': 123,
            'lagId': 'string',
            'ownerAccount': 'string',
            'lagName': 'string',
            'lagState': 'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'unknown',
            'location': 'string',
            'region': 'string',
            'minimumLinks': 123,
            'awsDevice': 'string',
            'awsDeviceV2': 'string',
            'awsLogicalDeviceId': 'string',
            'connections': [
                {
                    'ownerAccount': 'string',
                    'connectionId': 'string',
                    'connectionName': 'string',
                    'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
                    'region': 'string',
                    'location': 'string',
                    'bandwidth': 'string',
                    'vlan': 123,
                    'partnerName': 'string',
                    'loaIssueTime': datetime(2015, 1, 1),
                    'lagId': 'string',
                    'awsDevice': 'string',
                    'jumboFrameCapable': True|False,
                    'awsDeviceV2': 'string',
                    'awsLogicalDeviceId': 'string',
                    'hasLogicalRedundancy': 'unknown'|'yes'|'no',
                    'tags': [
                        {
                            'key': 'string',
                            'value': 'string'
                        },
                    ],
                    'providerName': 'string',
                    'macSecCapable': True|False,
                    'portEncryptionStatus': 'string',
                    'encryptionMode': 'string',
                    'macSecKeys': [
                        {
                            'secretARN': 'string',
                            'ckn': 'string',
                            'state': 'string',
                            'startOn': 'string'
                        },
                    ],
                    'partnerInterconnectMacSecCapable': True|False
                },
            ],
            'allowsHostedConnections': True|False,
            'jumboFrameCapable': True|False,
            'hasLogicalRedundancy': 'unknown'|'yes'|'no',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'providerName': 'string',
            'macSecCapable': True|False,
            'encryptionMode': 'string',
            'macSecKeys': [
                {
                    'secretARN': 'string',
                    'ckn': 'string',
                    'state': 'string',
                    'startOn': 'string'
                },
            ]
        },
    ],
    'nextToken': 'string'
}

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, 10Gbps, 100Gbps, or 400 Gbps..
    - numberOfConnections (integer) --
      
      The number of physical dedicated connections initially provisioned and bundled by the LAG. You can have a maximum of four connections when the port speed is 1 Gbps or 10 Gbps, or two when the port speed is 100 Gbps or 400 Gbps.
    - lagId (string) --
      
      The ID of the LAG.
    - ownerAccount (string) --
      
      The ID of the Amazon Web Services 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.
      - unknown: The state of the LAG is not available.
    - location (string) --
      
      The location of the LAG.
    - region (string) --
      
      The Amazon Web Services Region where the connection is located.
    - minimumLinks (integer) --
      
      The minimum number of physical dedicated 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.
    - awsLogicalDeviceId (string) --
      
      The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
    - connections (list) --
      
      The connections bundled by the LAG.
      - (dict) --
        
        Information about an Direct Connect connection.
        
        ownerAccount (string) --
        
        The ID of the Amazon Web Services 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.
        
        unknown: The state of the connection is not available.
        
        region (string) --
        
        The Amazon Web Services 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 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 are supported.
        
        awsDeviceV2 (string) --
        
        The Direct Connect endpoint that terminates the physical connection.
        
        awsLogicalDeviceId (string) --
        
        The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
        
        hasLogicalRedundancy (string) --
        
        Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
        
        tags (list) --
        
        The tags associated with the connection.
        
        (dict) --
        
        Information about a tag.
        
        key (string) --
        
        The key.
        
        value (string) --
        
        The value.
        
        providerName (string) --
        
        The name of the service provider associated with the connection.
        
        macSecCapable (boolean) --
        
        Indicates whether the connection supports MAC Security (MACsec).
        
        portEncryptionStatus (string) --
        
        The MAC Security (MACsec) port link status of the connection.
        
        The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.
        
        encryptionMode (string) --
        
        The MAC Security (MACsec) connection encryption mode.
        
        The valid values are no_encrypt, should_encrypt, and must_encrypt.
        
        macSecKeys (list) --
        
        The MAC Security (MACsec) security keys associated with the connection.
        
        (dict) --
        
        Information about the MAC Security (MACsec) secret key.
        
        secretARN (string) --
        
        The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
        
        ckn (string) --
        
        The Connection Key Name (CKN) for the MAC Security secret key.
        
        state (string) --
        
        The state of the MAC Security (MACsec) secret key.
        
        The possible values are:
        
        associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
        
        associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
        
        disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
        
        disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
        
        startOn (string) --
        
        The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
        
        partnerInterconnectMacSecCapable (boolean) --
        
        Indicates whether the interconnect hosting this connection supports MAC Security (MACsec).
    - allowsHostedConnections (boolean) --
      
      Indicates whether the LAG can host other connections.
    - jumboFrameCapable (boolean) --
      
      Indicates whether jumbo frames are supported.
    - hasLogicalRedundancy (string) --
      
      Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).
    - tags (list) --
      
      The tags associated with the LAG.
      - (dict) --
        
        Information about a tag.
        
        key (string) --
        
        The key.
        
        value (string) --
        
        The value.
    - providerName (string) --
      
      The name of the service provider associated with the LAG.
    - macSecCapable (boolean) --
      
      Indicates whether the LAG supports MAC Security (MACsec).
    - encryptionMode (string) --
      
      The LAG MAC Security (MACsec) encryption mode.
      
      The valid values are no_encrypt, should_encrypt, and must_encrypt.
    - macSecKeys (list) --
      
      The MAC Security (MACsec) security keys associated with the LAG.
      - (dict) --
        
        Information about the MAC Security (MACsec) secret key.
        
        secretARN (string) --
        
        The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
        
        ckn (string) --
        
        The Connection Key Name (CKN) for the MAC Security secret key.
        
        state (string) --
        
        The state of the MAC Security (MACsec) secret key.
        
        The possible values are:
        
        associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
        
        associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
        
        disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
        
        disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
        
        startOn (string) --
        
        The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
- nextToken (string) --
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

DescribeVirtualInterfaces (updated)

Link ¶
Changes (request, response)
Request

{'maxResults': 'integer', 'nextToken': 'string'}

Response

{'nextToken': 'string',
 'virtualInterfaces': {'asnLong': 'long', 'bgpPeers': {'asnLong': 'long'}}}

Displays all virtual interfaces for an Amazon Web Services 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 Direct Connect location and the customer network.

If you're using an asn, the response includes ASN value in both the asn and asnLong fields.
If you're using asnLong, the response returns a value of 0 (zero) for the asn attribute because it exceeds the highest ASN value of 2,147,483,647 that it can support

See also: AWS API Documentation

Request Syntax

client.describe_virtual_interfaces(
    connectionId='string',
    virtualInterfaceId='string',
    maxResults=123,
    nextToken='string'
)

type connectionId:

string

param connectionId:

The ID of the connection.

type virtualInterfaceId:

string

param virtualInterfaceId:

The ID of the virtual interface.

type maxResults:

integer

param maxResults:

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

type nextToken:

string

param nextToken:

The token for the next page of results.

rtype:

dict

returns:

Response Syntax

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

Response Structure

(dict) --
- virtualInterfaces (list) --
  
  The virtual interfaces
  - (dict) --
    
    Information about a virtual interface.
    - ownerAccount (string) --
      
      The ID of the Amazon Web Services 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, public and transit.
    - virtualInterfaceName (string) --
      
      The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
    - vlan (integer) --
      
      The ID of the VLAN.
    - asn (integer) --
      
      The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.
      Note
      
      You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
      
      The asnLong attribute accepts both ASN and long ASN ranges.
      
      If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
    - asnLong (integer) --
      
      The long ASN for the virtual interface. The valid range is from 1 to 4294967294 for BGP configuration.
      Note
      
      You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
      
      The asnLong attribute accepts both ASN and long ASN ranges.
      
      If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
    - amazonSideAsn (integer) --
      
      The autonomous system number (AS) for the Amazon side of the connection.
    - authKey (string) --
      
      The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
    - 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.
      - testing: A virtual interface is in this state immediately after calling StartBgpFailoverTest and remains in this state during the duration of the test.
      - 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.
      - unknown: The state of the virtual interface is not available.
    - customerRouterConfig (string) --
      
      The customer router configuration.
    - mtu (integer) --
      
      The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500
    - jumboFrameCapable (boolean) --
      
      Indicates whether jumbo frames 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 Amazon Web Services 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.
        
        bgpPeerId (string) --
        
        The ID of the BGP peer.
        
        asn (integer) --
        
        The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.
        
        Note
        
        You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
        
        The asnLong attribute accepts both ASN and long ASN ranges.
        
        If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
        
        asnLong (integer) --
        
        The long ASN for the BGP peer. The valid range is from 1 to 4294967294 for BGP configuration.
        
        Note
        
        You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
        
        The asnLong attribute accepts both ASN and long ASN ranges.
        
        If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
        
        authKey (string) --
        
        The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
        
        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 not available.
        
        awsDeviceV2 (string) --
        
        The Direct Connect endpoint that terminates the BGP peer.
        
        awsLogicalDeviceId (string) --
        
        The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
    - region (string) --
      
      The Amazon Web Services Region where the virtual interface is located.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint that terminates the physical connection.
    - awsLogicalDeviceId (string) --
      
      The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
    - tags (list) --
      
      The tags associated with the virtual interface.
      - (dict) --
        
        Information about a tag.
        
        key (string) --
        
        The key.
        
        value (string) --
        
        The value.
    - siteLinkEnabled (boolean) --
      
      Indicates whether SiteLink is enabled.
- nextToken (string) --
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

UpdateVirtualInterfaceAttributes (updated)

Link ¶
Changes (response)

{'asnLong': 'long', 'bgpPeers': {'asnLong': 'long'}}

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,
    enableSiteLink=True|False,
    virtualInterfaceName='string'
)

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 8500. The default value is 1500.

type enableSiteLink:

boolean

param enableSiteLink:

Indicates whether to enable or disable SiteLink.

type virtualInterfaceName:

string

param virtualInterfaceName:

The name of the virtual private interface.

rtype:

dict

returns:

Response Syntax

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

Response Structure

(dict) --

Information about a virtual interface.
- ownerAccount (string) --
  
  The ID of the Amazon Web Services 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, public and transit.
- virtualInterfaceName (string) --
  
  The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
- vlan (integer) --
  
  The ID of the VLAN.
- asn (integer) --
  
  The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.
  Note
  
  You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
  - The asnLong attribute accepts both ASN and long ASN ranges.
  - If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
- asnLong (integer) --
  
  The long ASN for the virtual interface. The valid range is from 1 to 4294967294 for BGP configuration.
  Note
  
  You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
  - The asnLong attribute accepts both ASN and long ASN ranges.
  - If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
- amazonSideAsn (integer) --
  
  The autonomous system number (AS) for the Amazon side of the connection.
- authKey (string) --
  
  The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
- 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.
  - testing: A virtual interface is in this state immediately after calling StartBgpFailoverTest and remains in this state during the duration of the test.
  - 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.
  - unknown: The state of the virtual interface is not available.
- customerRouterConfig (string) --
  
  The customer router configuration.
- mtu (integer) --
  
  The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames 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 Amazon Web Services 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.
    - bgpPeerId (string) --
      
      The ID of the BGP peer.
    - asn (integer) --
      
      The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.
      Note
      
      You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
      
      The asnLong attribute accepts both ASN and long ASN ranges.
      
      If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
    - asnLong (integer) --
      
      The long ASN for the BGP peer. The valid range is from 1 to 4294967294 for BGP configuration.
      Note
      
      You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
      
      The asnLong attribute accepts both ASN and long ASN ranges.
      
      If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
    - authKey (string) --
      
      The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
    - 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 not available.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint that terminates the BGP peer.
    - awsLogicalDeviceId (string) --
      
      The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
- region (string) --
  
  The Amazon Web Services Region where the virtual interface is located.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint that terminates the physical connection.
- awsLogicalDeviceId (string) --
  
  The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
- tags (list) --
  
  The tags associated with the virtual interface.
  - (dict) --
    
    Information about a tag.
    - key (string) --
      
      The key.
    - value (string) --
      
      The value.
- siteLinkEnabled (boolean) --
  
  Indicates whether SiteLink is enabled.