2021/07/13 - AWS Direct Connect - 28 updated api methods
Changes This release adds a new filed named awsLogicalDeviceId that it displays the AWS Direct Connect endpoint which terminates a physical connection's BGP Sessions.
{'awsLogicalDeviceId': 'string'}
Deprecated. Use AllocateHostedConnection instead.
Creates a hosted connection on an interconnect.
Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the specified interconnect.
See also: AWS API Documentation
Request Syntax
client.allocate_connection_on_interconnect(
bandwidth='string',
connectionName='string',
ownerAccount='string',
interconnectId='string',
vlan=123
)
string
[REQUIRED]
The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.
string
[REQUIRED]
The name of the provisioned connection.
string
[REQUIRED]
The ID of the account of the customer for whom the connection will be provisioned.
string
[REQUIRED]
The ID of the interconnect on which the connection will be provisioned.
integer
[REQUIRED]
The dedicated VLAN provisioned to the connection.
dict
Response Syntax
{
'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'
},
]
}
Response Structure
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the 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 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 (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates a physical connection's BGP sessions.
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.
{'awsLogicalDeviceId': 'string'}
Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects.
Allocates a VLAN number and a specified amount of capacity (bandwidth) for use by a hosted connection on the specified interconnect or LAG of interconnects. Amazon Web Services polices the hosted connection for the specified capacity and the Direct Connect Partner must also police the hosted connection for the specified capacity.
See also: AWS API Documentation
Request Syntax
client.allocate_hosted_connection(
connectionId='string',
ownerAccount='string',
bandwidth='string',
connectionName='string',
vlan=123,
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
string
[REQUIRED]
The ID of the interconnect or LAG.
string
[REQUIRED]
The ID of the account ID of the customer for the connection.
string
[REQUIRED]
The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.
string
[REQUIRED]
The name of the hosted connection.
integer
[REQUIRED]
The dedicated VLAN provisioned to the hosted connection.
list
The tags associated with the connection.
(dict) --
Information about a tag.
key (string) -- [REQUIRED]
The key.
value (string) --
The value.
dict
Response Syntax
{
'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'
},
]
}
Response Structure
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the 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 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 (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates a physical connection's BGP sessions.
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.
{'awsLogicalDeviceId': 'string', 'bgpPeers': {'awsLogicalDeviceId': 'string'}}
Provisions a private virtual interface to be owned by the specified account.
Virtual interfaces created using this action must be confirmed by the owner using ConfirmPrivateVirtualInterface. Until then, the virtual interface is in the Confirming state and is not available to handle traffic.
See also: AWS API Documentation
Request Syntax
client.allocate_private_virtual_interface(
connectionId='string',
ownerAccount='string',
newPrivateVirtualInterfaceAllocation={
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'mtu': 123,
'authKey': 'string',
'amazonAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'customerAddress': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
)
string
[REQUIRED]
The ID of the connection on which the private virtual interface is provisioned.
string
[REQUIRED]
The ID of the account that owns the virtual private interface.
dict
[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) -- [REQUIRED]
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
mtu (integer) --
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
authKey (string) --
The authentication key for BGP configuration. 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.
dict
Response Syntax
{
'ownerAccount': 'string',
'virtualInterfaceId': 'string',
'location': 'string',
'connectionId': 'string',
'virtualInterfaceType': 'string',
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'amazonSideAsn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'customerRouterConfig': 'string',
'mtu': 123,
'jumboFrameCapable': True|False,
'virtualGatewayId': 'string',
'directConnectGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'bgpPeers': [
{
'bgpPeerId': 'string',
'asn': 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'
},
]
}
Response Structure
(dict) --
Information about a virtual interface.
ownerAccount (string) --
The ID of the account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private and public.
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer network. 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 (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
amazonSideAsn (integer) --
The autonomous system number (ASN) 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.
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 9001. The default value is 1500.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
routeFilterPrefixes (list) --
The routes to be advertised to the 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 (AS) number for Border Gateway Protocol (BGP) configuration.
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 on which the BGP peer terminates.
awsLogicalDeviceId (string) --
region (string) --
The Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the virtual interface terminates.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates a physical connection's BGP sessions.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
{'awsLogicalDeviceId': 'string', 'bgpPeers': {'awsLogicalDeviceId': 'string'}}
Provisions a public virtual interface to be owned by the specified account.
The owner of a connection calls this function to provision a public virtual interface to be owned by the specified account.
Virtual interfaces created using this function must be confirmed by the owner using ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface is in the confirming state and is not available to handle traffic.
When creating an IPv6 public virtual interface, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.
See also: AWS API Documentation
Request Syntax
client.allocate_public_virtual_interface(
connectionId='string',
ownerAccount='string',
newPublicVirtualInterfaceAllocation={
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
)
string
[REQUIRED]
The ID of the connection on which the public virtual interface is provisioned.
string
[REQUIRED]
The ID of the account that owns the public virtual interface.
dict
[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) -- [REQUIRED]
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
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.
dict
Response Syntax
{
'ownerAccount': 'string',
'virtualInterfaceId': 'string',
'location': 'string',
'connectionId': 'string',
'virtualInterfaceType': 'string',
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'amazonSideAsn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'customerRouterConfig': 'string',
'mtu': 123,
'jumboFrameCapable': True|False,
'virtualGatewayId': 'string',
'directConnectGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'bgpPeers': [
{
'bgpPeerId': 'string',
'asn': 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'
},
]
}
Response Structure
(dict) --
Information about a virtual interface.
ownerAccount (string) --
The ID of the account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private and public.
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer network. 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 (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
amazonSideAsn (integer) --
The autonomous system number (ASN) 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.
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 9001. The default value is 1500.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
routeFilterPrefixes (list) --
The routes to be advertised to the 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 (AS) number for Border Gateway Protocol (BGP) configuration.
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 on which the BGP peer terminates.
awsLogicalDeviceId (string) --
region (string) --
The Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the virtual interface terminates.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates a physical connection's BGP sessions.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
{'virtualInterface': {'awsLogicalDeviceId': 'string',
'bgpPeers': {'awsLogicalDeviceId': 'string'}}}
Provisions a transit virtual interface to be owned by the specified 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 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,
'mtu': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
)
string
[REQUIRED]
The ID of the connection on which the transit virtual interface is provisioned.
string
[REQUIRED]
The ID of the account that owns the transit virtual interface.
dict
[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 (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
mtu (integer) --
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
authKey (string) --
The authentication key for BGP configuration. 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.
dict
Response Syntax
{
'virtualInterface': {
'ownerAccount': 'string',
'virtualInterfaceId': 'string',
'location': 'string',
'connectionId': 'string',
'virtualInterfaceType': 'string',
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'amazonSideAsn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'customerRouterConfig': 'string',
'mtu': 123,
'jumboFrameCapable': True|False,
'virtualGatewayId': 'string',
'directConnectGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'bgpPeers': [
{
'bgpPeerId': 'string',
'asn': 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'
},
]
}
}
Response Structure
(dict) --
virtualInterface (dict) --
Information about a virtual interface.
ownerAccount (string) --
The ID of the account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private and public.
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer network. 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 (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
amazonSideAsn (integer) --
The autonomous system number (ASN) 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.
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 9001. The default value is 1500.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
routeFilterPrefixes (list) --
The routes to be advertised to the 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 (AS) number for Border Gateway Protocol (BGP) configuration.
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 on which the BGP peer terminates.
awsLogicalDeviceId (string) --
region (string) --
The Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the virtual interface terminates.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates a physical connection's BGP sessions.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
{'awsLogicalDeviceId': 'string'}
Associates an existing connection with a link aggregation group (LAG). The connection is interrupted and re-established as a member of the LAG (connectivity to Amazon Web Services is interrupted). The connection must be hosted on the same Direct Connect endpoint as the LAG, and its bandwidth must match the bandwidth for the LAG. You can re-associate a connection that's currently associated with a different LAG; however, if removing the connection would cause the original LAG to fall below its setting for minimum number of operational connections, the request fails.
Any virtual interfaces that are directly associated with the connection are automatically re-associated with the LAG. If the connection was originally associated with a different LAG, the virtual interfaces remain associated with the original LAG.
For interconnects, any hosted connections are automatically re-associated with the LAG. If the interconnect was originally associated with a different LAG, the hosted connections remain associated with the original LAG.
See also: AWS API Documentation
Request Syntax
client.associate_connection_with_lag(
connectionId='string',
lagId='string'
)
string
[REQUIRED]
The ID of the connection.
string
[REQUIRED]
The ID of the LAG with which to associate the connection.
dict
Response Syntax
{
'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'
},
]
}
Response Structure
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the 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 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 (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates a physical connection's BGP sessions.
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.
{'awsLogicalDeviceId': 'string'}
Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect. If the target interconnect or LAG has an existing hosted connection with a conflicting VLAN number or IP address, the operation fails. This action temporarily interrupts the hosted connection's connectivity to Amazon Web Services as it is being migrated.
See also: AWS API Documentation
Request Syntax
client.associate_hosted_connection(
connectionId='string',
parentConnectionId='string'
)
string
[REQUIRED]
The ID of the hosted connection.
string
[REQUIRED]
The ID of the interconnect or the LAG.
dict
Response Syntax
{
'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'
},
]
}
Response Structure
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the 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 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 (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates a physical connection's BGP sessions.
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.
{'awsLogicalDeviceId': 'string', 'bgpPeers': {'awsLogicalDeviceId': 'string'}}
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'
)
string
[REQUIRED]
The ID of the virtual interface.
string
[REQUIRED]
The ID of the LAG or connection.
dict
Response Syntax
{
'ownerAccount': 'string',
'virtualInterfaceId': 'string',
'location': 'string',
'connectionId': 'string',
'virtualInterfaceType': 'string',
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'amazonSideAsn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'customerRouterConfig': 'string',
'mtu': 123,
'jumboFrameCapable': True|False,
'virtualGatewayId': 'string',
'directConnectGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'bgpPeers': [
{
'bgpPeerId': 'string',
'asn': 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'
},
]
}
Response Structure
(dict) --
Information about a virtual interface.
ownerAccount (string) --
The ID of the account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private and public.
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer network. 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 (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
amazonSideAsn (integer) --
The autonomous system number (ASN) 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.
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 9001. The default value is 1500.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
routeFilterPrefixes (list) --
The routes to be advertised to the 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 (AS) number for Border Gateway Protocol (BGP) configuration.
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 on which the BGP peer terminates.
awsLogicalDeviceId (string) --
region (string) --
The Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the virtual interface terminates.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates a physical connection's BGP sessions.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
{'virtualInterface': {'awsLogicalDeviceId': 'string',
'bgpPeers': {'awsLogicalDeviceId': 'string'}}}
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,
'authKey': 'string',
'addressFamily': 'ipv4'|'ipv6',
'amazonAddress': 'string',
'customerAddress': 'string'
}
)
string
The ID of the virtual interface.
dict
Information about the BGP peer.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
authKey (string) --
The authentication key for BGP configuration. 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.
dict
Response Syntax
{
'virtualInterface': {
'ownerAccount': 'string',
'virtualInterfaceId': 'string',
'location': 'string',
'connectionId': 'string',
'virtualInterfaceType': 'string',
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'amazonSideAsn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'customerRouterConfig': 'string',
'mtu': 123,
'jumboFrameCapable': True|False,
'virtualGatewayId': 'string',
'directConnectGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'bgpPeers': [
{
'bgpPeerId': 'string',
'asn': 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'
},
]
}
}
Response Structure
(dict) --
virtualInterface (dict) --
The virtual interface.
ownerAccount (string) --
The ID of the account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private and public.
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer network. 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 (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
amazonSideAsn (integer) --
The autonomous system number (ASN) 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.
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 9001. The default value is 1500.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
routeFilterPrefixes (list) --
The routes to be advertised to the 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 (AS) number for Border Gateway Protocol (BGP) configuration.
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 on which the BGP peer terminates.
awsLogicalDeviceId (string) --
region (string) --
The Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the virtual interface terminates.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates a physical connection's BGP sessions.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
{'awsLogicalDeviceId': 'string'}
Creates a connection between a customer network and a specific Direct Connect location.
A connection links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an Direct Connect router.
To find the locations for your Region, use DescribeLocations.
You can automatically add the new connection to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new connection is allocated on the same Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no connection is created.
See also: AWS API Documentation
Request Syntax
client.create_connection(
location='string',
bandwidth='string',
connectionName='string',
lagId='string',
tags=[
{
'key': 'string',
'value': 'string'
},
],
providerName='string',
requestMACSec=True|False
)
string
[REQUIRED]
The location of the connection.
string
[REQUIRED]
The bandwidth of the connection.
string
[REQUIRED]
The name of the connection.
string
The ID of the LAG.
list
The tags to associate with the lag.
(dict) --
Information about a tag.
key (string) -- [REQUIRED]
The key.
value (string) --
The value.
string
The name of the service provider associated with the requested connection.
boolean
Indicates whether you want the connection to support MAC Security (MACsec).
MAC Security (MACsec) is only available on dedicated connections. For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the Direct Connect User Guide.
dict
Response Syntax
{
'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'
},
]
}
Response Structure
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the 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 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 (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates a physical connection's BGP sessions.
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.
{'awsLogicalDeviceId': 'string'}
Creates an interconnect between an Direct Connect Partner's network and a specific Direct Connect location.
An interconnect is a connection that is capable of hosting other connections. The Direct Connect Partner can use an interconnect to provide Direct Connect hosted connections to customers through their own network services. Like a standard connection, an interconnect links the partner's network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an Direct Connect router.
You can automatically add the new interconnect to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new interconnect is allocated on the same Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no interconnect is created.
For each end customer, the Direct Connect Partner provisions a connection on their interconnect by calling AllocateHostedConnection. The end customer can then connect to Amazon Web Services resources by creating a virtual interface on their connection, using the VLAN assigned to them by the Direct Connect Partner.
See also: AWS API Documentation
Request Syntax
client.create_interconnect(
interconnectName='string',
bandwidth='string',
location='string',
lagId='string',
tags=[
{
'key': 'string',
'value': 'string'
},
],
providerName='string'
)
string
[REQUIRED]
The name of the interconnect.
string
[REQUIRED]
The port bandwidth, in Gbps. The possible values are 1 and 10.
string
[REQUIRED]
The location of the interconnect.
string
The ID of the LAG.
list
The tags to associate with the interconnect.
(dict) --
Information about a tag.
key (string) -- [REQUIRED]
The key.
value (string) --
The value.
string
The name of the service provider associated with the interconnect.
dict
Response Syntax
{
'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'
}
Response Structure
(dict) --
Information about an interconnect.
interconnectId (string) --
The ID of the interconnect.
interconnectName (string) --
The name of the interconnect.
interconnectState (string) --
The state of the interconnect. The following are the possible values:
requested: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending: The interconnect is approved, and is being initialized.
available: The network link is up, and the interconnect is ready for use.
down: The network link is down.
deleting: The interconnect is being deleted.
deleted: The interconnect is deleted.
unknown: The state of the interconnect is not available.
region (string) --
The Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates a physical connection's BGP sessions.
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.
{'awsLogicalDeviceId': 'string',
'connections': {'awsLogicalDeviceId': 'string'}}
Creates a link aggregation group (LAG) with the specified number of bundled physical dedicated connections between the customer network and a specific Direct Connect location. A LAG is a logical interface that uses the Link Aggregation Control Protocol (LACP) to aggregate multiple interfaces, enabling you to treat them as a single interface.
All connections in a LAG must use the same bandwidth (either 1Gbps or 10Gbps) and must terminate at the same Direct Connect endpoint.
You can have up to 10 dedicated connections per LAG. Regardless of this limit, if you request more connections for the LAG than Direct Connect can allocate on a single endpoint, no LAG is created.
You can specify an existing physical dedicated connection or interconnect to include in the LAG (which counts towards the total number of connections). Doing so interrupts the current physical dedicated connection, and re-establishes them as a member of the LAG. The LAG will be created on the same Direct Connect endpoint to which the dedicated connection terminates. Any virtual interfaces associated with the dedicated connection are automatically disassociated and re-associated with the LAG. The connection ID does not change.
If the account used to create a LAG is a registered Direct Connect Partner, the LAG is automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual interfaces cannot be directly configured.
See also: AWS API Documentation
Request Syntax
client.create_lag(
numberOfConnections=123,
location='string',
connectionsBandwidth='string',
lagName='string',
connectionId='string',
tags=[
{
'key': 'string',
'value': 'string'
},
],
childConnectionTags=[
{
'key': 'string',
'value': 'string'
},
],
providerName='string',
requestMACSec=True|False
)
integer
[REQUIRED]
The number of physical dedicated connections initially provisioned and bundled by the LAG.
string
[REQUIRED]
The location for the LAG.
string
[REQUIRED]
The bandwidth of the individual physical dedicated connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.
string
[REQUIRED]
The name of the LAG.
string
The ID of an existing dedicated connection to migrate to the LAG.
list
The tags to associate with the LAG.
(dict) --
Information about a tag.
key (string) -- [REQUIRED]
The key.
value (string) --
The value.
list
The tags to associate with the automtically created LAGs.
(dict) --
Information about a tag.
key (string) -- [REQUIRED]
The key.
value (string) --
The value.
string
The name of the service provider associated with the LAG.
boolean
Indicates whether the connection will support MAC Security (MACsec).
dict
Response Syntax
{
'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'
},
]
},
],
'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'
},
]
}
Response Structure
(dict) --
Information about a link aggregation group (LAG).
connectionsBandwidth (string) --
The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.
numberOfConnections (integer) --
The number of physical dedicated connections bundled by the LAG, up to a maximum of 10.
lagId (string) --
The ID of the LAG.
ownerAccount (string) --
The ID of the 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 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 a physical connection's BGP sessions.
connections (list) --
The connections bundled by the LAG.
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the 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 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 (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates a physical connection's BGP sessions.
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.
allowsHostedConnections (boolean) --
Indicates whether the LAG can host other connections.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) 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.
{'awsLogicalDeviceId': 'string', 'bgpPeers': {'awsLogicalDeviceId': 'string'}}
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 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 9001 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces.
See also: AWS API Documentation
Request Syntax
client.create_private_virtual_interface(
connectionId='string',
newPrivateVirtualInterface={
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'mtu': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'virtualGatewayId': 'string',
'directConnectGatewayId': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
)
string
[REQUIRED]
The ID of the connection.
dict
[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) -- [REQUIRED]
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
mtu (integer) --
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
authKey (string) --
The authentication key for BGP configuration. 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.
dict
Response Syntax
{
'ownerAccount': 'string',
'virtualInterfaceId': 'string',
'location': 'string',
'connectionId': 'string',
'virtualInterfaceType': 'string',
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'amazonSideAsn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'customerRouterConfig': 'string',
'mtu': 123,
'jumboFrameCapable': True|False,
'virtualGatewayId': 'string',
'directConnectGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'bgpPeers': [
{
'bgpPeerId': 'string',
'asn': 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'
},
]
}
Response Structure
(dict) --
Information about a virtual interface.
ownerAccount (string) --
The ID of the account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private and public.
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer network. 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 (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
amazonSideAsn (integer) --
The autonomous system number (ASN) 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.
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 9001. The default value is 1500.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
routeFilterPrefixes (list) --
The routes to be advertised to the 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 (AS) number for Border Gateway Protocol (BGP) configuration.
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 on which the BGP peer terminates.
awsLogicalDeviceId (string) --
region (string) --
The Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the virtual interface terminates.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates a physical connection's BGP sessions.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
{'awsLogicalDeviceId': 'string', 'bgpPeers': {'awsLogicalDeviceId': 'string'}}
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,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
)
string
[REQUIRED]
The ID of the connection.
dict
[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) -- [REQUIRED]
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
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.
dict
Response Syntax
{
'ownerAccount': 'string',
'virtualInterfaceId': 'string',
'location': 'string',
'connectionId': 'string',
'virtualInterfaceType': 'string',
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'amazonSideAsn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'customerRouterConfig': 'string',
'mtu': 123,
'jumboFrameCapable': True|False,
'virtualGatewayId': 'string',
'directConnectGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'bgpPeers': [
{
'bgpPeerId': 'string',
'asn': 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'
},
]
}
Response Structure
(dict) --
Information about a virtual interface.
ownerAccount (string) --
The ID of the account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private and public.
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer network. 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 (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
amazonSideAsn (integer) --
The autonomous system number (ASN) 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.
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 9001. The default value is 1500.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
routeFilterPrefixes (list) --
The routes to be advertised to the 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 (AS) number for Border Gateway Protocol (BGP) configuration.
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 on which the BGP peer terminates.
awsLogicalDeviceId (string) --
region (string) --
The Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the virtual interface terminates.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates a physical connection's BGP sessions.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
{'virtualInterface': {'awsLogicalDeviceId': 'string',
'bgpPeers': {'awsLogicalDeviceId': 'string'}}}
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.
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,
'mtu': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'directConnectGatewayId': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
)
string
[REQUIRED]
The ID of the connection.
dict
[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 (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
mtu (integer) --
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
authKey (string) --
The authentication key for BGP configuration. 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.
dict
Response Syntax
{
'virtualInterface': {
'ownerAccount': 'string',
'virtualInterfaceId': 'string',
'location': 'string',
'connectionId': 'string',
'virtualInterfaceType': 'string',
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'amazonSideAsn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'customerRouterConfig': 'string',
'mtu': 123,
'jumboFrameCapable': True|False,
'virtualGatewayId': 'string',
'directConnectGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'bgpPeers': [
{
'bgpPeerId': 'string',
'asn': 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'
},
]
}
}
Response Structure
(dict) --
virtualInterface (dict) --
Information about a virtual interface.
ownerAccount (string) --
The ID of the account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private and public.
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer network. 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 (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
amazonSideAsn (integer) --
The autonomous system number (ASN) 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.
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 9001. The default value is 1500.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
routeFilterPrefixes (list) --
The routes to be advertised to the 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 (AS) number for Border Gateway Protocol (BGP) configuration.
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 on which the BGP peer terminates.
awsLogicalDeviceId (string) --
region (string) --
The Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the virtual interface terminates.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates a physical connection's BGP sessions.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
{'virtualInterface': {'awsLogicalDeviceId': 'string',
'bgpPeers': {'awsLogicalDeviceId': 'string'}}}
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,
customerAddress='string',
bgpPeerId='string'
)
string
The ID of the virtual interface.
integer
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
string
The IP address assigned to the customer interface.
string
The ID of the BGP peer.
dict
Response Syntax
{
'virtualInterface': {
'ownerAccount': 'string',
'virtualInterfaceId': 'string',
'location': 'string',
'connectionId': 'string',
'virtualInterfaceType': 'string',
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'amazonSideAsn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'customerRouterConfig': 'string',
'mtu': 123,
'jumboFrameCapable': True|False,
'virtualGatewayId': 'string',
'directConnectGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'bgpPeers': [
{
'bgpPeerId': 'string',
'asn': 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'
},
]
}
}
Response Structure
(dict) --
virtualInterface (dict) --
The virtual interface.
ownerAccount (string) --
The ID of the account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private and public.
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer network. 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 (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
amazonSideAsn (integer) --
The autonomous system number (ASN) 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.
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 9001. The default value is 1500.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
routeFilterPrefixes (list) --
The routes to be advertised to the 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 (AS) number for Border Gateway Protocol (BGP) configuration.
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 on which the BGP peer terminates.
awsLogicalDeviceId (string) --
region (string) --
The Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the virtual interface terminates.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates a physical connection's BGP sessions.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
{'awsLogicalDeviceId': 'string'}
Deletes the specified connection.
Deleting a connection only stops the Direct Connect port hour and data transfer charges. If you are partnering with any third parties to connect with the Direct Connect location, you must cancel your service with them separately.
See also: AWS API Documentation
Request Syntax
client.delete_connection(
connectionId='string'
)
string
[REQUIRED]
The ID of the connection.
dict
Response Syntax
{
'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'
},
]
}
Response Structure
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the 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 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 (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates a physical connection's BGP sessions.
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.
{'awsLogicalDeviceId': 'string',
'connections': {'awsLogicalDeviceId': 'string'}}
Deletes the specified link aggregation group (LAG). You cannot delete a LAG if it has active virtual interfaces or hosted connections.
See also: AWS API Documentation
Request Syntax
client.delete_lag(
lagId='string'
)
string
[REQUIRED]
The ID of the LAG.
dict
Response Syntax
{
'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'
},
]
},
],
'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'
},
]
}
Response Structure
(dict) --
Information about a link aggregation group (LAG).
connectionsBandwidth (string) --
The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.
numberOfConnections (integer) --
The number of physical dedicated connections bundled by the LAG, up to a maximum of 10.
lagId (string) --
The ID of the LAG.
ownerAccount (string) --
The ID of the 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 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 a physical connection's BGP sessions.
connections (list) --
The connections bundled by the LAG.
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the 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 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 (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates a physical connection's BGP sessions.
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.
allowsHostedConnections (boolean) --
Indicates whether the LAG can host other connections.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) 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.
{'connections': {'awsLogicalDeviceId': 'string'}}
Displays the specified connection or all connections in this Region.
See also: AWS API Documentation
Request Syntax
client.describe_connections(
connectionId='string'
)
string
The ID of the connection.
dict
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'
},
]
},
]
}
Response Structure
(dict) --
connections (list) --
The connections.
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the 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 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 (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates a physical connection's BGP sessions.
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.
{'connections': {'awsLogicalDeviceId': 'string'}}
Deprecated. Use DescribeHostedConnections instead.
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'
)
string
[REQUIRED]
The ID of the interconnect.
dict
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'
},
]
},
]
}
Response Structure
(dict) --
connections (list) --
The connections.
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the 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 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 (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates a physical connection's BGP sessions.
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.
{'connections': {'awsLogicalDeviceId': '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'
)
string
[REQUIRED]
The ID of the interconnect or LAG.
dict
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'
},
]
},
]
}
Response Structure
(dict) --
connections (list) --
The connections.
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the 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 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 (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates a physical connection's BGP sessions.
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.
{'interconnects': {'awsLogicalDeviceId': 'string'}}
Lists the interconnects owned by the account or only the specified interconnect.
See also: AWS API Documentation
Request Syntax
client.describe_interconnects(
interconnectId='string'
)
string
The ID of the interconnect.
dict
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'
},
]
}
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 Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates a physical connection's BGP sessions.
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.
{'lags': {'awsLogicalDeviceId': 'string',
'connections': {'awsLogicalDeviceId': 'string'}}}
Describes all your link aggregation groups (LAG) or the specified LAG.
See also: AWS API Documentation
Request Syntax
client.describe_lags(
lagId='string'
)
string
The ID of the LAG.
dict
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'
},
]
},
],
'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'
},
]
},
]
}
Response Structure
(dict) --
lags (list) --
The LAGs.
(dict) --
Information about a link aggregation group (LAG).
connectionsBandwidth (string) --
The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.
numberOfConnections (integer) --
The number of physical dedicated connections bundled by the LAG, up to a maximum of 10.
lagId (string) --
The ID of the LAG.
ownerAccount (string) --
The ID of the 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 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 a physical connection's BGP sessions.
connections (list) --
The connections bundled by the LAG.
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the 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 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 (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates a physical connection's BGP sessions.
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.
allowsHostedConnections (boolean) --
Indicates whether the LAG can host other connections.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) 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.
{'virtualInterfaces': {'awsLogicalDeviceId': 'string',
'bgpPeers': {'awsLogicalDeviceId': 'string'}}}
Displays all virtual interfaces for an 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.
See also: AWS API Documentation
Request Syntax
client.describe_virtual_interfaces(
connectionId='string',
virtualInterfaceId='string'
)
string
The ID of the connection.
string
The ID of the virtual interface.
dict
Response Syntax
{
'virtualInterfaces': [
{
'ownerAccount': 'string',
'virtualInterfaceId': 'string',
'location': 'string',
'connectionId': 'string',
'virtualInterfaceType': 'string',
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'amazonSideAsn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'customerRouterConfig': 'string',
'mtu': 123,
'jumboFrameCapable': True|False,
'virtualGatewayId': 'string',
'directConnectGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'bgpPeers': [
{
'bgpPeerId': 'string',
'asn': 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'
},
]
},
]
}
Response Structure
(dict) --
virtualInterfaces (list) --
The virtual interfaces
(dict) --
Information about a virtual interface.
ownerAccount (string) --
The ID of the account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private and public.
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer network. 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 (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
amazonSideAsn (integer) --
The autonomous system number (ASN) 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.
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 9001. The default value is 1500.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
routeFilterPrefixes (list) --
The routes to be advertised to the 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 (AS) number for Border Gateway Protocol (BGP) configuration.
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 on which the BGP peer terminates.
awsLogicalDeviceId (string) --
region (string) --
The Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the virtual interface terminates.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates a physical connection's BGP sessions.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
{'awsLogicalDeviceId': 'string'}
Disassociates a connection from a link aggregation group (LAG). The connection is interrupted and re-established as a standalone connection (the connection is not deleted; to delete the connection, use the DeleteConnection request). If the LAG has associated virtual interfaces or hosted connections, they remain associated with the LAG. A disassociated connection owned by an Direct Connect Partner is automatically converted to an interconnect.
If disassociating the connection would cause the LAG to fall below its setting for minimum number of operational connections, the request fails, except when it's the last member of the LAG. If all connections are disassociated, the LAG continues to exist as an empty LAG with no physical connections.
See also: AWS API Documentation
Request Syntax
client.disassociate_connection_from_lag(
connectionId='string',
lagId='string'
)
string
[REQUIRED]
The ID of the connection.
string
[REQUIRED]
The ID of the LAG.
dict
Response Syntax
{
'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'
},
]
}
Response Structure
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the 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 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 (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates a physical connection's BGP sessions.
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.
{'awsLogicalDeviceId': 'string'}
Updates the Direct Connect dedicated connection configuration.
You can update the following parameters for a connection:
The connection name
The connection's MAC Security (MACsec) encryption mode.
See also: AWS API Documentation
Request Syntax
client.update_connection(
connectionId='string',
connectionName='string',
encryptionMode='string'
)
string
[REQUIRED]
The ID of the dedicated connection.
You can use DescribeConnections to retrieve the connection ID.
string
The name of the connection.
string
The connection MAC Security (MACsec) encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
dict
Response Syntax
{
'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'
},
]
}
Response Structure
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the 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 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 (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates a physical connection's BGP sessions.
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.
{'awsLogicalDeviceId': 'string',
'connections': {'awsLogicalDeviceId': 'string'}}
Updates the attributes of the specified link aggregation group (LAG).
You can update the following LAG attributes:
The name of the LAG.
The value for the minimum number of connections that must be operational for the LAG itself to be operational.
The LAG's MACsec encryption mode. Amazon Web Services assigns this value to each connection which is part of the LAG.
The tags
See also: AWS API Documentation
Request Syntax
client.update_lag(
lagId='string',
lagName='string',
minimumLinks=123,
encryptionMode='string'
)
string
[REQUIRED]
The ID of the LAG.
string
The name of the LAG.
integer
The minimum number of physical connections that must be operational for the LAG itself to be operational.
string
The LAG MAC Security (MACsec) encryption mode.
Amazon Web Services applies the value to all connections which are part of the LAG.
dict
Response Syntax
{
'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'
},
]
},
],
'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'
},
]
}
Response Structure
(dict) --
Information about a link aggregation group (LAG).
connectionsBandwidth (string) --
The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.
numberOfConnections (integer) --
The number of physical dedicated connections bundled by the LAG, up to a maximum of 10.
lagId (string) --
The ID of the LAG.
ownerAccount (string) --
The ID of the 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 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 a physical connection's BGP sessions.
connections (list) --
The connections bundled by the LAG.
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the 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 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 (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates a physical connection's BGP sessions.
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.
allowsHostedConnections (boolean) --
Indicates whether the LAG can host other connections.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) 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.
{'awsLogicalDeviceId': 'string', 'bgpPeers': {'awsLogicalDeviceId': 'string'}}
Updates the specified attributes of the specified virtual private interface.
Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual q interface supports jumbo frames, call DescribeVirtualInterfaces.
See also: AWS API Documentation
Request Syntax
client.update_virtual_interface_attributes(
virtualInterfaceId='string',
mtu=123
)
string
[REQUIRED]
The ID of the virtual private interface.
integer
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
dict
Response Syntax
{
'ownerAccount': 'string',
'virtualInterfaceId': 'string',
'location': 'string',
'connectionId': 'string',
'virtualInterfaceType': 'string',
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'amazonSideAsn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'customerRouterConfig': 'string',
'mtu': 123,
'jumboFrameCapable': True|False,
'virtualGatewayId': 'string',
'directConnectGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'bgpPeers': [
{
'bgpPeerId': 'string',
'asn': 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'
},
]
}
Response Structure
(dict) --
Information about a virtual interface.
ownerAccount (string) --
The ID of the account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private and public.
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer network. 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 (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
amazonSideAsn (integer) --
The autonomous system number (ASN) 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.
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 9001. The default value is 1500.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
routeFilterPrefixes (list) --
The routes to be advertised to the 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 (AS) number for Border Gateway Protocol (BGP) configuration.
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 on which the BGP peer terminates.
awsLogicalDeviceId (string) --
region (string) --
The Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the virtual interface terminates.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates a physical connection's BGP sessions.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.