Table of Contents
DirectConnect.Client¶A low-level client representing AWS Direct Connect
Direct Connect 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. With this connection in place, you can create virtual interfaces directly to the Amazon Web Services Cloud (for example, to Amazon EC2 and Amazon S3) and to Amazon VPC, bypassing Internet service providers in your network path. A connection provides access to all Amazon Web Services Regions except the China (Beijing) and (China) Ningxia Regions. Amazon Web Services resources in the China Regions can only be accessed through locations associated with those Regions.
import boto3
client = boto3.client('directconnect')
These are the available methods:
accept_direct_connect_gateway_association_proposal()allocate_connection_on_interconnect()allocate_hosted_connection()allocate_private_virtual_interface()allocate_public_virtual_interface()allocate_transit_virtual_interface()associate_connection_with_lag()associate_hosted_connection()associate_mac_sec_key()associate_virtual_interface()can_paginate()close()confirm_connection()confirm_customer_agreement()confirm_private_virtual_interface()confirm_public_virtual_interface()confirm_transit_virtual_interface()create_bgp_peer()create_connection()create_direct_connect_gateway()create_direct_connect_gateway_association()create_direct_connect_gateway_association_proposal()create_interconnect()create_lag()create_private_virtual_interface()create_public_virtual_interface()create_transit_virtual_interface()delete_bgp_peer()delete_connection()delete_direct_connect_gateway()delete_direct_connect_gateway_association()delete_direct_connect_gateway_association_proposal()delete_interconnect()delete_lag()delete_virtual_interface()describe_connection_loa()describe_connections()describe_connections_on_interconnect()describe_customer_metadata()describe_direct_connect_gateway_association_proposals()describe_direct_connect_gateway_associations()describe_direct_connect_gateway_attachments()describe_direct_connect_gateways()describe_hosted_connections()describe_interconnect_loa()describe_interconnects()describe_lags()describe_loa()describe_locations()describe_router_configuration()describe_tags()describe_virtual_gateways()describe_virtual_interfaces()disassociate_connection_from_lag()disassociate_mac_sec_key()get_paginator()get_waiter()list_virtual_interface_test_history()start_bgp_failover_test()stop_bgp_failover_test()tag_resource()untag_resource()update_connection()update_direct_connect_gateway()update_direct_connect_gateway_association()update_lag()update_virtual_interface_attributes()accept_direct_connect_gateway_association_proposal(**kwargs)¶Accepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway.
See also: AWS API Documentation
Request Syntax
response = client.accept_direct_connect_gateway_association_proposal(
directConnectGatewayId='string',
proposalId='string',
associatedGatewayOwnerAccount='string',
overrideAllowedPrefixesToDirectConnectGateway=[
{
'cidr': 'string'
},
]
)
[REQUIRED]
The ID of the Direct Connect gateway.
[REQUIRED]
The ID of the request proposal.
[REQUIRED]
The ID of the Amazon Web Services account that owns the virtual private gateway or transit gateway.
Overrides the Amazon VPC prefixes advertised to the Direct Connect gateway.
For information about how to set the prefixes, see Allowed Prefixes in the Direct Connect User Guide .
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
dict
Response Syntax
{
'directConnectGatewayAssociation': {
'directConnectGatewayId': 'string',
'directConnectGatewayOwnerAccount': 'string',
'associationState': 'associating'|'associated'|'disassociating'|'disassociated'|'updating',
'stateChangeError': 'string',
'associatedGateway': {
'id': 'string',
'type': 'virtualPrivateGateway'|'transitGateway',
'ownerAccount': 'string',
'region': 'string'
},
'associationId': 'string',
'allowedPrefixesToDirectConnectGateway': [
{
'cidr': 'string'
},
],
'virtualGatewayId': 'string',
'virtualGatewayRegion': 'string',
'virtualGatewayOwnerAccount': 'string'
}
}
Response Structure
(dict) --
directConnectGatewayAssociation (dict) --
Information about an association between a Direct Connect gateway and a virtual private gateway or transit gateway.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
directConnectGatewayOwnerAccount (string) --
The ID of the Amazon Web Services account that owns the associated gateway.
associationState (string) --
The state of the association. The following are the possible values:
associating : The initial state after calling CreateDirectConnectGatewayAssociation.associated : The Direct Connect gateway and virtual private gateway or transit gateway are successfully associated and ready to pass traffic.disassociating : The initial state after calling DeleteDirectConnectGatewayAssociation.disassociated : The virtual private gateway or transit gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway or transit gateway is stopped.stateChangeError (string) --
The error message if the state of an object failed to advance.
associatedGateway (dict) --
Information about the associated gateway.
id (string) --
The ID of the associated gateway.
type (string) --
The type of associated gateway.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the associated virtual private gateway or transit gateway.
region (string) --
The Region where the associated gateway is located.
associationId (string) --
The ID of the Direct Connect gateway association.
allowedPrefixesToDirectConnectGateway (list) --
The Amazon VPC prefixes to advertise to the Direct Connect gateway.
(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.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
virtualGatewayRegion (string) --
The Amazon Web Services Region where the virtual private gateway is located.
virtualGatewayOwnerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual private gateway.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptionallocate_connection_on_interconnect(**kwargs)¶Deprecated. Use AllocateHostedConnection instead.
Creates a hosted connection on an interconnect.
Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the specified interconnect.
Note
Intended for use by Direct Connect Partners only.
Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
response = client.allocate_connection_on_interconnect(
bandwidth='string',
connectionName='string',
ownerAccount='string',
interconnectId='string',
vlan=123
)
[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.
[REQUIRED]
The name of the provisioned connection.
[REQUIRED]
The ID of the Amazon Web Services account of the customer for whom the connection will be provisioned.
[REQUIRED]
The ID of the interconnect on which the connection will be provisioned.
[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 Amazon Web Services account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.pending : The connection has been approved and is being initialized.available : The network link is up and the connection is ready for use.down : The network link is down.deleting : The connection is being deleted.deleted : The connection has been deleted.rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.unknown : The state of the connection is not available.region (string) --
The Amazon Web Services Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
hasLogicalRedundancy (string) --
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags (list) --
The tags associated with the connection.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
providerName (string) --
The name of the service provider associated with the connection.
macSecCapable (boolean) --
Indicates whether the connection supports MAC Security (MACsec).
portEncryptionStatus (string) --
The MAC Security (MACsec) port link status of the connection.
The valid values are Encryption Up , which means that there is an active Connection Key Name, or Encryption Down .
encryptionMode (string) --
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt , should_encrypt , and must_encrypt .
macSecKeys (list) --
The MAC Security (MACsec) security keys associated with the connection.
(dict) --
Information about the MAC Security (MACsec) secret key.
secretARN (string) --
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
ckn (string) --
The Connection Key Name (CKN) for the MAC Security secret key.
state (string) --
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating : The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.associated : The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.disassociating : The MAC Security (MACsec) secret key is being disassociated from the connection or LAGdisassociated : 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.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptionallocate_hosted_connection(**kwargs)¶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.
Note
Intended for use by Direct Connect Partners only.
See also: AWS API Documentation
Request Syntax
response = client.allocate_hosted_connection(
connectionId='string',
ownerAccount='string',
bandwidth='string',
connectionName='string',
vlan=123,
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
[REQUIRED]
The ID of the interconnect or LAG.
[REQUIRED]
The ID of the Amazon Web Services account ID of the customer for the connection.
[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.
[REQUIRED]
The name of the hosted connection.
[REQUIRED]
The dedicated VLAN provisioned to the hosted connection.
The tags associated with the connection.
Information about a tag.
The key.
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 Amazon Web Services account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.pending : The connection has been approved and is being initialized.available : The network link is up and the connection is ready for use.down : The network link is down.deleting : The connection is being deleted.deleted : The connection has been deleted.rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.unknown : The state of the connection is not available.region (string) --
The Amazon Web Services Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
hasLogicalRedundancy (string) --
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags (list) --
The tags associated with the connection.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
providerName (string) --
The name of the service provider associated with the connection.
macSecCapable (boolean) --
Indicates whether the connection supports MAC Security (MACsec).
portEncryptionStatus (string) --
The MAC Security (MACsec) port link status of the connection.
The valid values are Encryption Up , which means that there is an active Connection Key Name, or Encryption Down .
encryptionMode (string) --
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt , should_encrypt , and must_encrypt .
macSecKeys (list) --
The MAC Security (MACsec) security keys associated with the connection.
(dict) --
Information about the MAC Security (MACsec) secret key.
secretARN (string) --
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
ckn (string) --
The Connection Key Name (CKN) for the MAC Security secret key.
state (string) --
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating : The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.associated : The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.disassociating : The MAC Security (MACsec) secret key is being disassociated from the connection or LAGdisassociated : 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.
Exceptions
DirectConnect.Client.exceptions.DuplicateTagKeysExceptionDirectConnect.Client.exceptions.TooManyTagsExceptionDirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptionallocate_private_virtual_interface(**kwargs)¶Provisions a private virtual interface to be owned by the specified Amazon Web Services account.
Virtual interfaces created using this action must be confirmed by the owner using ConfirmPrivateVirtualInterface. Until then, the virtual interface is in the Confirming state and is not available to handle traffic.
See also: AWS API Documentation
Request Syntax
response = 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'
},
]
}
)
[REQUIRED]
The ID of the connection on which the private virtual interface is provisioned.
[REQUIRED]
The ID of the Amazon Web Services account that owns the virtual private interface.
[REQUIRED]
Information about the private virtual interface.
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 (-).
The ID of the VLAN.
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
The IP address assigned to the Amazon interface.
The address family for the BGP peer.
The IP address assigned to the customer interface.
The tags associated with the private virtual interface.
Information about a tag.
The key.
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'
},
],
'siteLinkEnabled': True|False
}
Response Structure
(dict) --
Information about a virtual interface.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private 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 that terminates the BGP peer.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
region (string) --
The Amazon Web Services Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
siteLinkEnabled (boolean) --
Indicates whether SiteLink is enabled.
Exceptions
DirectConnect.Client.exceptions.DuplicateTagKeysExceptionDirectConnect.Client.exceptions.TooManyTagsExceptionDirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptionallocate_public_virtual_interface(**kwargs)¶Provisions a public virtual interface to be owned by the specified Amazon Web Services account.
The owner of a connection calls this function to provision a public virtual interface to be owned by the specified Amazon Web Services account.
Virtual interfaces created using this function must be confirmed by the owner using ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface is in the confirming state and is not available to handle traffic.
When creating an IPv6 public virtual interface, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.
See also: AWS API Documentation
Request Syntax
response = 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'
},
]
}
)
[REQUIRED]
The ID of the connection on which the public virtual interface is provisioned.
[REQUIRED]
The ID of the Amazon Web Services account that owns the public virtual interface.
[REQUIRED]
Information about the public virtual interface.
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 (-).
The ID of the VLAN.
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
The IP address assigned to the Amazon interface.
The IP address assigned to the customer interface.
The address family for the BGP peer.
The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
The tags associated with the public virtual interface.
Information about a tag.
The key.
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'
},
],
'siteLinkEnabled': True|False
}
Response Structure
(dict) --
Information about a virtual interface.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private 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 that terminates the BGP peer.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
region (string) --
The Amazon Web Services Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
siteLinkEnabled (boolean) --
Indicates whether SiteLink is enabled.
Exceptions
DirectConnect.Client.exceptions.DuplicateTagKeysExceptionDirectConnect.Client.exceptions.TooManyTagsExceptionDirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptionallocate_transit_virtual_interface(**kwargs)¶Provisions a transit virtual interface to be owned by the specified Amazon Web Services account. Use this type of interface to connect a transit gateway to your Direct Connect gateway.
The owner of a connection provisions a transit virtual interface to be owned by the specified Amazon Web Services account.
After you create a transit virtual interface, it must be confirmed by the owner using ConfirmTransitVirtualInterface. Until this step has been completed, the transit virtual interface is in the requested state and is not available to handle traffic.
See also: AWS API Documentation
Request Syntax
response = 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'
},
]
}
)
[REQUIRED]
The ID of the connection on which the transit virtual interface is provisioned.
[REQUIRED]
The ID of the Amazon Web Services account that owns the transit virtual interface.
[REQUIRED]
Information about the transit virtual interface.
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 (-).
The ID of the VLAN.
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
The IP address assigned to the Amazon interface.
The IP address assigned to the customer interface.
The address family for the BGP peer.
The tags associated with the transitive virtual interface.
Information about a tag.
The key.
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'
},
],
'siteLinkEnabled': True|False
}
}
Response Structure
(dict) --
virtualInterface (dict) --
Information about a virtual interface.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private 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 that terminates the BGP peer.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
region (string) --
The Amazon Web Services Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
siteLinkEnabled (boolean) --
Indicates whether SiteLink is enabled.
Exceptions
DirectConnect.Client.exceptions.DuplicateTagKeysExceptionDirectConnect.Client.exceptions.TooManyTagsExceptionDirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptionassociate_connection_with_lag(**kwargs)¶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
response = client.associate_connection_with_lag(
connectionId='string',
lagId='string'
)
[REQUIRED]
The ID of the connection.
[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 Amazon Web Services account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.pending : The connection has been approved and is being initialized.available : The network link is up and the connection is ready for use.down : The network link is down.deleting : The connection is being deleted.deleted : The connection has been deleted.rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.unknown : The state of the connection is not available.region (string) --
The Amazon Web Services Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
hasLogicalRedundancy (string) --
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags (list) --
The tags associated with the connection.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
providerName (string) --
The name of the service provider associated with the connection.
macSecCapable (boolean) --
Indicates whether the connection supports MAC Security (MACsec).
portEncryptionStatus (string) --
The MAC Security (MACsec) port link status of the connection.
The valid values are Encryption Up , which means that there is an active Connection Key Name, or Encryption Down .
encryptionMode (string) --
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt , should_encrypt , and must_encrypt .
macSecKeys (list) --
The MAC Security (MACsec) security keys associated with the connection.
(dict) --
Information about the MAC Security (MACsec) secret key.
secretARN (string) --
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
ckn (string) --
The Connection Key Name (CKN) for the MAC Security secret key.
state (string) --
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating : The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.associated : The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.disassociating : The MAC Security (MACsec) secret key is being disassociated from the connection or LAGdisassociated : 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.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptionassociate_hosted_connection(**kwargs)¶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.
Note
Intended for use by Direct Connect Partners only.
See also: AWS API Documentation
Request Syntax
response = client.associate_hosted_connection(
connectionId='string',
parentConnectionId='string'
)
[REQUIRED]
The ID of the hosted connection.
[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 Amazon Web Services account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.pending : The connection has been approved and is being initialized.available : The network link is up and the connection is ready for use.down : The network link is down.deleting : The connection is being deleted.deleted : The connection has been deleted.rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.unknown : The state of the connection is not available.region (string) --
The Amazon Web Services Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
hasLogicalRedundancy (string) --
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags (list) --
The tags associated with the connection.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
providerName (string) --
The name of the service provider associated with the connection.
macSecCapable (boolean) --
Indicates whether the connection supports MAC Security (MACsec).
portEncryptionStatus (string) --
The MAC Security (MACsec) port link status of the connection.
The valid values are Encryption Up , which means that there is an active Connection Key Name, or Encryption Down .
encryptionMode (string) --
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt , should_encrypt , and must_encrypt .
macSecKeys (list) --
The MAC Security (MACsec) security keys associated with the connection.
(dict) --
Information about the MAC Security (MACsec) secret key.
secretARN (string) --
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
ckn (string) --
The Connection Key Name (CKN) for the MAC Security secret key.
state (string) --
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating : The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.associated : The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.disassociating : The MAC Security (MACsec) secret key is being disassociated from the connection or LAGdisassociated : 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.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptionassociate_mac_sec_key(**kwargs)¶Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with an Direct Connect dedicated connection.
You must supply either the secretARN, or the CKN/CAK ( ckn and cak ) pair in the request.
For information about MAC Security (MACsec) key considerations, see MACsec pre-shared CKN/CAK key considerations in the Direct Connect User Guide .
See also: AWS API Documentation
Request Syntax
response = client.associate_mac_sec_key(
connectionId='string',
secretARN='string',
ckn='string',
cak='string'
)
[REQUIRED]
The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).
You can use DescribeConnections or DescribeLags to retrieve connection ID.
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key to associate with the dedicated connection.
You can use DescribeConnections or DescribeLags to retrieve the MAC Security (MACsec) secret key.
If you use this request parameter, you do not use the ckn and cak request parameters.
The MAC Security (MACsec) CKN to associate with the dedicated connection.
You can create the CKN/CAK pair using an industry standard tool.
The valid values are 64 hexadecimal characters (0-9, A-E).
If you use this request parameter, you must use the cak request parameter and not use the secretARN request parameter.
The MAC Security (MACsec) CAK to associate with the dedicated connection.
You can create the CKN/CAK pair using an industry standard tool.
The valid values are 64 hexadecimal characters (0-9, A-E).
If you use this request parameter, you must use the ckn request parameter and not use the secretARN request parameter.
dict
Response Syntax
{
'connectionId': 'string',
'macSecKeys': [
{
'secretARN': 'string',
'ckn': 'string',
'state': 'string',
'startOn': 'string'
},
]
}
Response Structure
(dict) --
connectionId (string) --
The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).
macSecKeys (list) --
The MAC Security (MACsec) security keys associated with the dedicated 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 LAGdisassociated : 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.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptionassociate_virtual_interface(**kwargs)¶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
response = client.associate_virtual_interface(
virtualInterfaceId='string',
connectionId='string'
)
[REQUIRED]
The ID of the virtual interface.
[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'
},
],
'siteLinkEnabled': True|False
}
Response Structure
(dict) --
Information about a virtual interface.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private 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 that terminates the BGP peer.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
region (string) --
The Amazon Web Services Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
siteLinkEnabled (boolean) --
Indicates whether SiteLink is enabled.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
confirm_connection(**kwargs)¶Confirms the creation of the specified hosted connection on an interconnect.
Upon creation, the hosted connection is initially in the Ordering state, and remains in this state until the owner confirms creation of the hosted connection.
See also: AWS API Documentation
Request Syntax
response = client.confirm_connection(
connectionId='string'
)
[REQUIRED]
The ID of the hosted connection.
{
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown'
}
Response Structure
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.Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptionconfirm_customer_agreement(**kwargs)¶The confirmation of the terms of agreement when creating the connection/link aggregation group (LAG).
See also: AWS API Documentation
Request Syntax
response = client.confirm_customer_agreement(
agreementName='string'
)
{
'status': 'string'
}
Response Structure
The status of the customer agreement when the connection was created. This will be either signed or unsigned .
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptionconfirm_private_virtual_interface(**kwargs)¶Accepts ownership of a private virtual interface created by another Amazon Web Services account.
After the virtual interface owner makes this call, the virtual interface is created and attached to the specified virtual private gateway or Direct Connect gateway, and is made available to handle traffic.
See also: AWS API Documentation
Request Syntax
response = client.confirm_private_virtual_interface(
virtualInterfaceId='string',
virtualGatewayId='string',
directConnectGatewayId='string'
)
[REQUIRED]
The ID of the virtual interface.
dict
Response Syntax
{
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown'
}
Response Structure
(dict) --
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.Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptionconfirm_public_virtual_interface(**kwargs)¶Accepts ownership of a public virtual interface created by another Amazon Web Services account.
After the virtual interface owner makes this call, the specified virtual interface is created and made available to handle traffic.
See also: AWS API Documentation
Request Syntax
response = client.confirm_public_virtual_interface(
virtualInterfaceId='string'
)
[REQUIRED]
The ID of the virtual interface.
{
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown'
}
Response Structure
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.Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptionconfirm_transit_virtual_interface(**kwargs)¶Accepts ownership of a transit virtual interface created by another Amazon Web Services account.
After the owner of the transit virtual interface makes this call, the specified transit virtual interface is created and made available to handle traffic.
See also: AWS API Documentation
Request Syntax
response = client.confirm_transit_virtual_interface(
virtualInterfaceId='string',
directConnectGatewayId='string'
)
[REQUIRED]
The ID of the virtual interface.
[REQUIRED]
The ID of the Direct Connect gateway.
dict
Response Syntax
{
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown'
}
Response Structure
(dict) --
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.Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptioncreate_bgp_peer(**kwargs)¶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
response = client.create_bgp_peer(
virtualInterfaceId='string',
newBGPPeer={
'asn': 123,
'authKey': 'string',
'addressFamily': 'ipv4'|'ipv6',
'amazonAddress': 'string',
'customerAddress': 'string'
}
)
Information about the BGP peer.
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
The address family for the BGP peer.
The IP address assigned to the Amazon interface.
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'
},
],
'siteLinkEnabled': True|False
}
}
Response Structure
(dict) --
virtualInterface (dict) --
The virtual interface.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private 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 that terminates the BGP peer.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
region (string) --
The Amazon Web Services Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
siteLinkEnabled (boolean) --
Indicates whether SiteLink is enabled.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptioncreate_connection(**kwargs)¶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
response = client.create_connection(
location='string',
bandwidth='string',
connectionName='string',
lagId='string',
tags=[
{
'key': 'string',
'value': 'string'
},
],
providerName='string',
requestMACSec=True|False
)
[REQUIRED]
The location of the connection.
[REQUIRED]
The bandwidth of the connection.
[REQUIRED]
The name of the connection.
The tags to associate with the lag.
Information about a tag.
The key.
The value.
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 Amazon Web Services account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.pending : The connection has been approved and is being initialized.available : The network link is up and the connection is ready for use.down : The network link is down.deleting : The connection is being deleted.deleted : The connection has been deleted.rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.unknown : The state of the connection is not available.region (string) --
The Amazon Web Services Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
hasLogicalRedundancy (string) --
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags (list) --
The tags associated with the connection.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
providerName (string) --
The name of the service provider associated with the connection.
macSecCapable (boolean) --
Indicates whether the connection supports MAC Security (MACsec).
portEncryptionStatus (string) --
The MAC Security (MACsec) port link status of the connection.
The valid values are Encryption Up , which means that there is an active Connection Key Name, or Encryption Down .
encryptionMode (string) --
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt , should_encrypt , and must_encrypt .
macSecKeys (list) --
The MAC Security (MACsec) security keys associated with the connection.
(dict) --
Information about the MAC Security (MACsec) secret key.
secretARN (string) --
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
ckn (string) --
The Connection Key Name (CKN) for the MAC Security secret key.
state (string) --
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating : The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.associated : The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.disassociating : The MAC Security (MACsec) secret key is being disassociated from the connection or LAGdisassociated : 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.
Exceptions
DirectConnect.Client.exceptions.DuplicateTagKeysExceptionDirectConnect.Client.exceptions.TooManyTagsExceptionDirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptioncreate_direct_connect_gateway(**kwargs)¶Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways. A Direct Connect gateway is global and visible in any Amazon Web Services Region after it is created. The virtual interfaces and virtual private gateways that are connected through a Direct Connect gateway can be in different Amazon Web Services Regions. This enables you to connect to a VPC in any Region, regardless of the Region in which the virtual interfaces are located, and pass traffic between them.
See also: AWS API Documentation
Request Syntax
response = client.create_direct_connect_gateway(
directConnectGatewayName='string',
amazonSideAsn=123
)
[REQUIRED]
The name of the Direct Connect gateway.
dict
Response Syntax
{
'directConnectGateway': {
'directConnectGatewayId': 'string',
'directConnectGatewayName': 'string',
'amazonSideAsn': 123,
'ownerAccount': 'string',
'directConnectGatewayState': 'pending'|'available'|'deleting'|'deleted',
'stateChangeError': 'string'
}
}
Response Structure
(dict) --
directConnectGateway (dict) --
The Direct Connect gateway.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
directConnectGatewayName (string) --
The name of the Direct Connect gateway.
amazonSideAsn (integer) --
The autonomous system number (ASN) for the Amazon side of the connection.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the Direct Connect gateway.
directConnectGatewayState (string) --
The state of the Direct Connect gateway. The following are the possible values:
pending : The initial state after calling CreateDirectConnectGateway.available : The Direct Connect gateway is ready for use.deleting : The initial state after calling DeleteDirectConnectGateway.deleted : The Direct Connect gateway is deleted and cannot pass traffic.stateChangeError (string) --
The error message if the state of an object failed to advance.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptioncreate_direct_connect_gateway_association(**kwargs)¶Creates an association between a Direct Connect gateway and a virtual private gateway. The virtual private gateway must be attached to a VPC and must not be associated with another Direct Connect gateway.
See also: AWS API Documentation
Request Syntax
response = client.create_direct_connect_gateway_association(
directConnectGatewayId='string',
gatewayId='string',
addAllowedPrefixesToDirectConnectGateway=[
{
'cidr': 'string'
},
],
virtualGatewayId='string'
)
[REQUIRED]
The ID of the Direct Connect gateway.
The Amazon VPC prefixes to advertise to the Direct Connect gateway
This parameter is required when you create an association to a transit gateway.
For information about how to set the prefixes, see Allowed Prefixes in the Direct Connect User Guide .
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
dict
Response Syntax
{
'directConnectGatewayAssociation': {
'directConnectGatewayId': 'string',
'directConnectGatewayOwnerAccount': 'string',
'associationState': 'associating'|'associated'|'disassociating'|'disassociated'|'updating',
'stateChangeError': 'string',
'associatedGateway': {
'id': 'string',
'type': 'virtualPrivateGateway'|'transitGateway',
'ownerAccount': 'string',
'region': 'string'
},
'associationId': 'string',
'allowedPrefixesToDirectConnectGateway': [
{
'cidr': 'string'
},
],
'virtualGatewayId': 'string',
'virtualGatewayRegion': 'string',
'virtualGatewayOwnerAccount': 'string'
}
}
Response Structure
(dict) --
directConnectGatewayAssociation (dict) --
The association to be created.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
directConnectGatewayOwnerAccount (string) --
The ID of the Amazon Web Services account that owns the associated gateway.
associationState (string) --
The state of the association. The following are the possible values:
associating : The initial state after calling CreateDirectConnectGatewayAssociation.associated : The Direct Connect gateway and virtual private gateway or transit gateway are successfully associated and ready to pass traffic.disassociating : The initial state after calling DeleteDirectConnectGatewayAssociation.disassociated : The virtual private gateway or transit gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway or transit gateway is stopped.stateChangeError (string) --
The error message if the state of an object failed to advance.
associatedGateway (dict) --
Information about the associated gateway.
id (string) --
The ID of the associated gateway.
type (string) --
The type of associated gateway.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the associated virtual private gateway or transit gateway.
region (string) --
The Region where the associated gateway is located.
associationId (string) --
The ID of the Direct Connect gateway association.
allowedPrefixesToDirectConnectGateway (list) --
The Amazon VPC prefixes to advertise to the Direct Connect gateway.
(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.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
virtualGatewayRegion (string) --
The Amazon Web Services Region where the virtual private gateway is located.
virtualGatewayOwnerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual private gateway.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptioncreate_direct_connect_gateway_association_proposal(**kwargs)¶Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway.
You can associate a Direct Connect gateway and virtual private gateway or transit gateway that is owned by any Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
response = client.create_direct_connect_gateway_association_proposal(
directConnectGatewayId='string',
directConnectGatewayOwnerAccount='string',
gatewayId='string',
addAllowedPrefixesToDirectConnectGateway=[
{
'cidr': 'string'
},
],
removeAllowedPrefixesToDirectConnectGateway=[
{
'cidr': 'string'
},
]
)
[REQUIRED]
The ID of the Direct Connect gateway.
[REQUIRED]
The ID of the Amazon Web Services account that owns the Direct Connect gateway.
[REQUIRED]
The ID of the virtual private gateway or transit gateway.
The Amazon VPC prefixes to advertise to the Direct Connect gateway.
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
dict
Response Syntax
{
'directConnectGatewayAssociationProposal': {
'proposalId': 'string',
'directConnectGatewayId': 'string',
'directConnectGatewayOwnerAccount': 'string',
'proposalState': 'requested'|'accepted'|'deleted',
'associatedGateway': {
'id': 'string',
'type': 'virtualPrivateGateway'|'transitGateway',
'ownerAccount': 'string',
'region': 'string'
},
'existingAllowedPrefixesToDirectConnectGateway': [
{
'cidr': 'string'
},
],
'requestedAllowedPrefixesToDirectConnectGateway': [
{
'cidr': 'string'
},
]
}
}
Response Structure
(dict) --
directConnectGatewayAssociationProposal (dict) --
Information about the Direct Connect gateway proposal.
proposalId (string) --
The ID of the association proposal.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
directConnectGatewayOwnerAccount (string) --
The ID of the Amazon Web Services account that owns the Direct Connect gateway.
proposalState (string) --
The state of the proposal. The following are possible values:
accepted : The proposal has been accepted. The Direct Connect gateway association is available to use in this state.deleted : The proposal has been deleted by the owner that made the proposal. The Direct Connect gateway association cannot be used in this state.requested : The proposal has been requested. The Direct Connect gateway association cannot be used in this state.associatedGateway (dict) --
Information about the associated gateway.
id (string) --
The ID of the associated gateway.
type (string) --
The type of associated gateway.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the associated virtual private gateway or transit gateway.
region (string) --
The Region where the associated gateway is located.
existingAllowedPrefixesToDirectConnectGateway (list) --
The existing Amazon VPC prefixes advertised to the Direct Connect gateway.
(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.
requestedAllowedPrefixesToDirectConnectGateway (list) --
The Amazon VPC prefixes to advertise to the Direct Connect gateway.
(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.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptioncreate_interconnect(**kwargs)¶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.
Note
Intended for use by Direct Connect Partners only.
See also: AWS API Documentation
Request Syntax
response = client.create_interconnect(
interconnectName='string',
bandwidth='string',
location='string',
lagId='string',
tags=[
{
'key': 'string',
'value': 'string'
},
],
providerName='string'
)
[REQUIRED]
The name of the interconnect.
[REQUIRED]
The port bandwidth, in Gbps. The possible values are 1 and 10.
[REQUIRED]
The location of the interconnect.
The tags to associate with the interconnect.
Information about a tag.
The key.
The value.
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 Amazon Web Services Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
hasLogicalRedundancy (string) --
Indicates whether the interconnect supports a secondary BGP in the same address family (IPv4/IPv6).
tags (list) --
The tags associated with the interconnect.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
providerName (string) --
The name of the service provider associated with the interconnect.
Exceptions
DirectConnect.Client.exceptions.DuplicateTagKeysExceptionDirectConnect.Client.exceptions.TooManyTagsExceptionDirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptioncreate_lag(**kwargs)¶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 Amazon Web Services 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
response = 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
)
[REQUIRED]
The number of physical dedicated connections initially provisioned and bundled by the LAG.
[REQUIRED]
The location for the LAG.
[REQUIRED]
The bandwidth of the individual physical dedicated connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.
[REQUIRED]
The name of the LAG.
The tags to associate with the LAG.
Information about a tag.
The key.
The value.
The tags to associate with the automtically created LAGs.
Information about a tag.
The key.
The value.
Indicates whether the connection will support MAC Security (MACsec).
Note
All connections in the LAG must be capable of supporting MAC Security (MACsec). For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the Direct Connect User Guide .
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 Amazon Web Services account that owns the LAG.
lagName (string) --
The name of the LAG.
lagState (string) --
The state of the LAG. The following are the possible values:
requested : The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.pending : The LAG has been approved and is being initialized.available : The network link is established and the LAG is ready for use.down : The network link is down.deleting : The LAG is being deleted.deleted : The LAG is deleted.unknown : The state of the LAG is not available.location (string) --
The location of the LAG.
region (string) --
The Amazon Web Services Region where the connection is located.
minimumLinks (integer) --
The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.
awsDevice (string) --
The Direct Connect endpoint that hosts the LAG.
awsDeviceV2 (string) --
The Direct Connect endpoint that hosts the LAG.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
connections (list) --
The connections bundled by the LAG.
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.pending : The connection has been approved and is being initialized.available : The network link is up and the connection is ready for use.down : The network link is down.deleting : The connection is being deleted.deleted : The connection has been deleted.rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.unknown : The state of the connection is not available.region (string) --
The Amazon Web Services Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
hasLogicalRedundancy (string) --
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags (list) --
The tags associated with the connection.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
providerName (string) --
The name of the service provider associated with the connection.
macSecCapable (boolean) --
Indicates whether the connection supports MAC Security (MACsec).
portEncryptionStatus (string) --
The MAC Security (MACsec) port link status of the connection.
The valid values are Encryption Up , which means that there is an active Connection Key Name, or Encryption Down .
encryptionMode (string) --
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt , should_encrypt , and must_encrypt .
macSecKeys (list) --
The MAC Security (MACsec) security keys associated with the connection.
(dict) --
Information about the MAC Security (MACsec) secret key.
secretARN (string) --
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
ckn (string) --
The Connection Key Name (CKN) for the MAC Security secret key.
state (string) --
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating : The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.associated : The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.disassociating : The MAC Security (MACsec) secret key is being disassociated from the connection or LAGdisassociated : 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 LAGdisassociated : 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.
Exceptions
DirectConnect.Client.exceptions.DuplicateTagKeysExceptionDirectConnect.Client.exceptions.TooManyTagsExceptionDirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptioncreate_private_virtual_interface(**kwargs)¶Creates a private virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. A private virtual interface can be connected to either a Direct Connect gateway or a Virtual Private Gateway (VGW). Connecting the private virtual interface to a Direct Connect gateway enables the possibility for connecting to multiple VPCs, including VPCs in different Amazon Web Services Regions. Connecting the private virtual interface to a VGW only provides access to a single VPC within the same Region.
Setting the MTU of a virtual interface to 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
response = 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'
},
],
'enableSiteLink': True|False
}
)
[REQUIRED]
The ID of the connection.
[REQUIRED]
Information about the private virtual interface.
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 (-).
The ID of the VLAN.
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
The IP address assigned to the Amazon interface.
The IP address assigned to the customer interface.
The address family for the BGP peer.
The ID of the virtual private gateway.
The ID of the Direct Connect gateway.
The tags associated with the private virtual interface.
Information about a tag.
The key.
The value.
Indicates whether to enable or disable SiteLink.
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'
},
],
'siteLinkEnabled': True|False
}
Response Structure
(dict) --
Information about a virtual interface.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private 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 that terminates the BGP peer.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
region (string) --
The Amazon Web Services Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
siteLinkEnabled (boolean) --
Indicates whether SiteLink is enabled.
Exceptions
DirectConnect.Client.exceptions.DuplicateTagKeysExceptionDirectConnect.Client.exceptions.TooManyTagsExceptionDirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptioncreate_public_virtual_interface(**kwargs)¶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
response = 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'
},
]
}
)
[REQUIRED]
The ID of the connection.
[REQUIRED]
Information about the public virtual interface.
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 (-).
The ID of the VLAN.
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
The IP address assigned to the Amazon interface.
The IP address assigned to the customer interface.
The address family for the BGP peer.
The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
The tags associated with the public virtual interface.
Information about a tag.
The key.
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'
},
],
'siteLinkEnabled': True|False
}
Response Structure
(dict) --
Information about a virtual interface.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private 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 that terminates the BGP peer.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
region (string) --
The Amazon Web Services Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
siteLinkEnabled (boolean) --
Indicates whether SiteLink is enabled.
Exceptions
DirectConnect.Client.exceptions.DuplicateTagKeysExceptionDirectConnect.Client.exceptions.TooManyTagsExceptionDirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptioncreate_transit_virtual_interface(**kwargs)¶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.
Warning
If you associate your transit gateway with one or more Direct Connect gateways, the Autonomous System Number (ASN) used by the transit gateway and the Direct Connect gateway must be different. For example, if you use the default ASN 64512 for both your the transit gateway and Direct Connect gateway, the association request fails.
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
response = 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'
},
],
'enableSiteLink': True|False
}
)
[REQUIRED]
The ID of the connection.
[REQUIRED]
Information about the transit virtual interface.
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 (-).
The ID of the VLAN.
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
The IP address assigned to the Amazon interface.
The IP address assigned to the customer interface.
The address family for the BGP peer.
The ID of the Direct Connect gateway.
The tags associated with the transitive virtual interface.
Information about a tag.
The key.
The value.
Indicates whether to enable or disable SiteLink.
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'
},
],
'siteLinkEnabled': True|False
}
}
Response Structure
(dict) --
virtualInterface (dict) --
Information about a virtual interface.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private 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 that terminates the BGP peer.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
region (string) --
The Amazon Web Services Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
siteLinkEnabled (boolean) --
Indicates whether SiteLink is enabled.
Exceptions
DirectConnect.Client.exceptions.DuplicateTagKeysExceptionDirectConnect.Client.exceptions.TooManyTagsExceptionDirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptiondelete_bgp_peer(**kwargs)¶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
response = client.delete_bgp_peer(
virtualInterfaceId='string',
asn=123,
customerAddress='string',
bgpPeerId='string'
)
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'
},
],
'siteLinkEnabled': True|False
}
}
Response Structure
(dict) --
virtualInterface (dict) --
The virtual interface.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private 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 that terminates the BGP peer.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
region (string) --
The Amazon Web Services Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
siteLinkEnabled (boolean) --
Indicates whether SiteLink is enabled.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptiondelete_connection(**kwargs)¶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
response = client.delete_connection(
connectionId='string'
)
[REQUIRED]
The ID of the connection.
{
'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
Information about an Direct Connect connection.
The ID of the Amazon Web Services account that owns the connection.
The ID of the connection.
The name of the connection.
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.The Amazon Web Services Region where the connection is located.
The location of the connection.
The bandwidth of the connection.
The ID of the VLAN.
The name of the Direct Connect service provider associated with the connection.
The time of the most recent call to DescribeLoa for this connection.
The ID of the LAG.
The Direct Connect endpoint on which the physical connection terminates.
Indicates whether jumbo frames (9001 MTU) are supported.
The Direct Connect endpoint that terminates the physical connection.
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
The tags associated with the connection.
Information about a tag.
The key.
The value.
The name of the service provider associated with the connection.
Indicates whether the connection supports MAC Security (MACsec).
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 .
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt , should_encrypt , and must_encrypt .
The MAC Security (MACsec) security keys associated with the connection.
Information about the MAC Security (MACsec) secret key.
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
The Connection Key Name (CKN) for the MAC Security secret key.
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 LAGdisassociated : The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptiondelete_direct_connect_gateway(**kwargs)¶Deletes the specified Direct Connect gateway. You must first delete all virtual interfaces that are attached to the Direct Connect gateway and disassociate all virtual private gateways associated with the Direct Connect gateway.
See also: AWS API Documentation
Request Syntax
response = client.delete_direct_connect_gateway(
directConnectGatewayId='string'
)
[REQUIRED]
The ID of the Direct Connect gateway.
{
'directConnectGateway': {
'directConnectGatewayId': 'string',
'directConnectGatewayName': 'string',
'amazonSideAsn': 123,
'ownerAccount': 'string',
'directConnectGatewayState': 'pending'|'available'|'deleting'|'deleted',
'stateChangeError': 'string'
}
}
Response Structure
The Direct Connect gateway.
The ID of the Direct Connect gateway.
The name of the Direct Connect gateway.
The autonomous system number (ASN) for the Amazon side of the connection.
The ID of the Amazon Web Services account that owns the Direct Connect gateway.
The state of the Direct Connect gateway. The following are the possible values:
pending : The initial state after calling CreateDirectConnectGateway.available : The Direct Connect gateway is ready for use.deleting : The initial state after calling DeleteDirectConnectGateway.deleted : The Direct Connect gateway is deleted and cannot pass traffic.The error message if the state of an object failed to advance.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptiondelete_direct_connect_gateway_association(**kwargs)¶Deletes the association between the specified Direct Connect gateway and virtual private gateway.
We recommend that you specify the associationID to delete the association. Alternatively, if you own virtual gateway and a Direct Connect gateway association, you can specify the virtualGatewayId and directConnectGatewayId to delete an association.
See also: AWS API Documentation
Request Syntax
response = client.delete_direct_connect_gateway_association(
associationId='string',
directConnectGatewayId='string',
virtualGatewayId='string'
)
dict
Response Syntax
{
'directConnectGatewayAssociation': {
'directConnectGatewayId': 'string',
'directConnectGatewayOwnerAccount': 'string',
'associationState': 'associating'|'associated'|'disassociating'|'disassociated'|'updating',
'stateChangeError': 'string',
'associatedGateway': {
'id': 'string',
'type': 'virtualPrivateGateway'|'transitGateway',
'ownerAccount': 'string',
'region': 'string'
},
'associationId': 'string',
'allowedPrefixesToDirectConnectGateway': [
{
'cidr': 'string'
},
],
'virtualGatewayId': 'string',
'virtualGatewayRegion': 'string',
'virtualGatewayOwnerAccount': 'string'
}
}
Response Structure
(dict) --
directConnectGatewayAssociation (dict) --
Information about the deleted association.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
directConnectGatewayOwnerAccount (string) --
The ID of the Amazon Web Services account that owns the associated gateway.
associationState (string) --
The state of the association. The following are the possible values:
associating : The initial state after calling CreateDirectConnectGatewayAssociation.associated : The Direct Connect gateway and virtual private gateway or transit gateway are successfully associated and ready to pass traffic.disassociating : The initial state after calling DeleteDirectConnectGatewayAssociation.disassociated : The virtual private gateway or transit gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway or transit gateway is stopped.stateChangeError (string) --
The error message if the state of an object failed to advance.
associatedGateway (dict) --
Information about the associated gateway.
id (string) --
The ID of the associated gateway.
type (string) --
The type of associated gateway.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the associated virtual private gateway or transit gateway.
region (string) --
The Region where the associated gateway is located.
associationId (string) --
The ID of the Direct Connect gateway association.
allowedPrefixesToDirectConnectGateway (list) --
The Amazon VPC prefixes to advertise to the Direct Connect gateway.
(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.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
virtualGatewayRegion (string) --
The Amazon Web Services Region where the virtual private gateway is located.
virtualGatewayOwnerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual private gateway.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptiondelete_direct_connect_gateway_association_proposal(**kwargs)¶Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway or transit gateway.
See also: AWS API Documentation
Request Syntax
response = client.delete_direct_connect_gateway_association_proposal(
proposalId='string'
)
[REQUIRED]
The ID of the proposal.
{
'directConnectGatewayAssociationProposal': {
'proposalId': 'string',
'directConnectGatewayId': 'string',
'directConnectGatewayOwnerAccount': 'string',
'proposalState': 'requested'|'accepted'|'deleted',
'associatedGateway': {
'id': 'string',
'type': 'virtualPrivateGateway'|'transitGateway',
'ownerAccount': 'string',
'region': 'string'
},
'existingAllowedPrefixesToDirectConnectGateway': [
{
'cidr': 'string'
},
],
'requestedAllowedPrefixesToDirectConnectGateway': [
{
'cidr': 'string'
},
]
}
}
Response Structure
The ID of the associated gateway.
The ID of the association proposal.
The ID of the Direct Connect gateway.
The ID of the Amazon Web Services account that owns the Direct Connect gateway.
The state of the proposal. The following are possible values:
accepted : The proposal has been accepted. The Direct Connect gateway association is available to use in this state.deleted : The proposal has been deleted by the owner that made the proposal. The Direct Connect gateway association cannot be used in this state.requested : The proposal has been requested. The Direct Connect gateway association cannot be used in this state.Information about the associated gateway.
The ID of the associated gateway.
The type of associated gateway.
The ID of the Amazon Web Services account that owns the associated virtual private gateway or transit gateway.
The Region where the associated gateway is located.
The existing Amazon VPC prefixes advertised to the Direct Connect gateway.
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
The Amazon VPC prefixes to advertise to the Direct Connect gateway.
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptiondelete_interconnect(**kwargs)¶Deletes the specified interconnect.
Note
Intended for use by Direct Connect Partners only.
See also: AWS API Documentation
Request Syntax
response = client.delete_interconnect(
interconnectId='string'
)
[REQUIRED]
The ID of the interconnect.
{
'interconnectState': 'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'unknown'
}
Response Structure
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.Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptiondelete_lag(**kwargs)¶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
response = client.delete_lag(
lagId='string'
)
[REQUIRED]
The ID of the LAG.
{
'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
Information about a link aggregation group (LAG).
The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.
The number of physical dedicated connections bundled by the LAG, up to a maximum of 10.
The ID of the LAG.
The ID of the Amazon Web Services account that owns the LAG.
The name of the LAG.
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.The location of the LAG.
The Amazon Web Services Region where the connection is located.
The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.
The Direct Connect endpoint that hosts the LAG.
The Direct Connect endpoint that hosts the LAG.
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
The connections bundled by the LAG.
Information about an Direct Connect connection.
The ID of the Amazon Web Services account that owns the connection.
The ID of the connection.
The name of the connection.
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.The Amazon Web Services Region where the connection is located.
The location of the connection.
The bandwidth of the connection.
The ID of the VLAN.
The name of the Direct Connect service provider associated with the connection.
The time of the most recent call to DescribeLoa for this connection.
The ID of the LAG.
The Direct Connect endpoint on which the physical connection terminates.
Indicates whether jumbo frames (9001 MTU) are supported.
The Direct Connect endpoint that terminates the physical connection.
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
The tags associated with the connection.
Information about a tag.
The key.
The value.
The name of the service provider associated with the connection.
Indicates whether the connection supports MAC Security (MACsec).
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 .
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt , should_encrypt , and must_encrypt .
The MAC Security (MACsec) security keys associated with the connection.
Information about the MAC Security (MACsec) secret key.
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
The Connection Key Name (CKN) for the MAC Security secret key.
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 LAGdisassociated : The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
Indicates whether the LAG can host other connections.
Indicates whether jumbo frames (9001 MTU) are supported.
Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).
The tags associated with the LAG.
Information about a tag.
The key.
The value.
The name of the service provider associated with the LAG.
Indicates whether the LAG supports MAC Security (MACsec).
The LAG MAC Security (MACsec) encryption mode.
The valid values are no_encrypt , should_encrypt , and must_encrypt .
The MAC Security (MACsec) security keys associated with the LAG.
Information about the MAC Security (MACsec) secret key.
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
The Connection Key Name (CKN) for the MAC Security secret key.
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 LAGdisassociated : The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptiondelete_virtual_interface(**kwargs)¶Deletes a virtual interface.
See also: AWS API Documentation
Request Syntax
response = client.delete_virtual_interface(
virtualInterfaceId='string'
)
[REQUIRED]
The ID of the virtual interface.
{
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown'
}
Response Structure
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.Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptiondescribe_connection_loa(**kwargs)¶Deprecated. Use DescribeLoa instead.
Gets the LOA-CFA for a connection.
The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that your APN partner or service provider uses when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations in the Direct Connect User Guide .
Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
response = client.describe_connection_loa(
connectionId='string',
providerName='string',
loaContentType='application/pdf'
)
[REQUIRED]
The ID of the connection.
dict
Response Syntax
{
'loa': {
'loaContent': b'bytes',
'loaContentType': 'application/pdf'
}
}
Response Structure
(dict) --
loa (dict) --
The Letter of Authorization - Connecting Facility Assignment (LOA-CFA).
loaContent (bytes) --
The binary contents of the LOA-CFA document.
loaContentType (string) --
The standard media type for the LOA-CFA document. The only supported value is application/pdf.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptiondescribe_connections(**kwargs)¶Displays the specified connection or all connections in this Region.
See also: AWS API Documentation
Request Syntax
response = client.describe_connections(
connectionId='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'
},
]
},
]
}
Response Structure
The connections.
Information about an Direct Connect connection.
The ID of the Amazon Web Services account that owns the connection.
The ID of the connection.
The name of the connection.
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.The Amazon Web Services Region where the connection is located.
The location of the connection.
The bandwidth of the connection.
The ID of the VLAN.
The name of the Direct Connect service provider associated with the connection.
The time of the most recent call to DescribeLoa for this connection.
The ID of the LAG.
The Direct Connect endpoint on which the physical connection terminates.
Indicates whether jumbo frames (9001 MTU) are supported.
The Direct Connect endpoint that terminates the physical connection.
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
The tags associated with the connection.
Information about a tag.
The key.
The value.
The name of the service provider associated with the connection.
Indicates whether the connection supports MAC Security (MACsec).
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 .
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt , should_encrypt , and must_encrypt .
The MAC Security (MACsec) security keys associated with the connection.
Information about the MAC Security (MACsec) secret key.
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
The Connection Key Name (CKN) for the MAC Security secret key.
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 LAGdisassociated : The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptiondescribe_connections_on_interconnect(**kwargs)¶Deprecated. Use DescribeHostedConnections instead.
Lists the connections that have been provisioned on the specified interconnect.
Note
Intended for use by Direct Connect Partners only.
Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
response = client.describe_connections_on_interconnect(
interconnectId='string'
)
[REQUIRED]
The ID of the interconnect.
{
'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
The connections.
Information about an Direct Connect connection.
The ID of the Amazon Web Services account that owns the connection.
The ID of the connection.
The name of the connection.
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.The Amazon Web Services Region where the connection is located.
The location of the connection.
The bandwidth of the connection.
The ID of the VLAN.
The name of the Direct Connect service provider associated with the connection.
The time of the most recent call to DescribeLoa for this connection.
The ID of the LAG.
The Direct Connect endpoint on which the physical connection terminates.
Indicates whether jumbo frames (9001 MTU) are supported.
The Direct Connect endpoint that terminates the physical connection.
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
The tags associated with the connection.
Information about a tag.
The key.
The value.
The name of the service provider associated with the connection.
Indicates whether the connection supports MAC Security (MACsec).
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 .
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt , should_encrypt , and must_encrypt .
The MAC Security (MACsec) security keys associated with the connection.
Information about the MAC Security (MACsec) secret key.
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
The Connection Key Name (CKN) for the MAC Security secret key.
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 LAGdisassociated : The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptiondescribe_customer_metadata()¶Get and view a list of customer agreements, along with their signed status and whether the customer is an NNIPartner, NNIPartnerV2, or a nonPartner.
See also: AWS API Documentation
Request Syntax
response = client.describe_customer_metadata()
{
'agreements': [
{
'agreementName': 'string',
'status': 'string'
},
],
'nniPartnerType': 'v1'|'v2'|'nonPartner'
}
Response Structure
The list of customer agreements.
The name and status of a customer agreement.
The name of the agreement.
The status of the customer agreement. This will be either signed or unsigned
The type of network-to-network interface (NNI) partner. The partner type will be one of the following:
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptiondescribe_direct_connect_gateway_association_proposals(**kwargs)¶Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway.
See also: AWS API Documentation
Request Syntax
response = client.describe_direct_connect_gateway_association_proposals(
directConnectGatewayId='string',
proposalId='string',
associatedGatewayId='string',
maxResults=123,
nextToken='string'
)
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
If MaxResults is given a value larger than 100, only 100 results are returned.
dict
Response Syntax
{
'directConnectGatewayAssociationProposals': [
{
'proposalId': 'string',
'directConnectGatewayId': 'string',
'directConnectGatewayOwnerAccount': 'string',
'proposalState': 'requested'|'accepted'|'deleted',
'associatedGateway': {
'id': 'string',
'type': 'virtualPrivateGateway'|'transitGateway',
'ownerAccount': 'string',
'region': 'string'
},
'existingAllowedPrefixesToDirectConnectGateway': [
{
'cidr': 'string'
},
],
'requestedAllowedPrefixesToDirectConnectGateway': [
{
'cidr': 'string'
},
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
directConnectGatewayAssociationProposals (list) --
Describes the Direct Connect gateway association proposals.
(dict) --
Information about the proposal request to attach a virtual private gateway to a Direct Connect gateway.
proposalId (string) --
The ID of the association proposal.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
directConnectGatewayOwnerAccount (string) --
The ID of the Amazon Web Services account that owns the Direct Connect gateway.
proposalState (string) --
The state of the proposal. The following are possible values:
accepted : The proposal has been accepted. The Direct Connect gateway association is available to use in this state.deleted : The proposal has been deleted by the owner that made the proposal. The Direct Connect gateway association cannot be used in this state.requested : The proposal has been requested. The Direct Connect gateway association cannot be used in this state.associatedGateway (dict) --
Information about the associated gateway.
id (string) --
The ID of the associated gateway.
type (string) --
The type of associated gateway.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the associated virtual private gateway or transit gateway.
region (string) --
The Region where the associated gateway is located.
existingAllowedPrefixesToDirectConnectGateway (list) --
The existing Amazon VPC prefixes advertised to the Direct Connect gateway.
(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.
requestedAllowedPrefixesToDirectConnectGateway (list) --
The Amazon VPC prefixes to advertise to the Direct Connect gateway.
(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.
nextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptiondescribe_direct_connect_gateway_associations(**kwargs)¶Lists the associations between your Direct Connect gateways and virtual private gateways and transit gateways. You must specify one of the following:
See also: AWS API Documentation
Request Syntax
response = client.describe_direct_connect_gateway_associations(
associationId='string',
associatedGatewayId='string',
directConnectGatewayId='string',
maxResults=123,
nextToken='string',
virtualGatewayId='string'
)
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
If MaxResults is given a value larger than 100, only 100 results are returned.
dict
Response Syntax
{
'directConnectGatewayAssociations': [
{
'directConnectGatewayId': 'string',
'directConnectGatewayOwnerAccount': 'string',
'associationState': 'associating'|'associated'|'disassociating'|'disassociated'|'updating',
'stateChangeError': 'string',
'associatedGateway': {
'id': 'string',
'type': 'virtualPrivateGateway'|'transitGateway',
'ownerAccount': 'string',
'region': 'string'
},
'associationId': 'string',
'allowedPrefixesToDirectConnectGateway': [
{
'cidr': 'string'
},
],
'virtualGatewayId': 'string',
'virtualGatewayRegion': 'string',
'virtualGatewayOwnerAccount': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
directConnectGatewayAssociations (list) --
Information about the associations.
(dict) --
Information about an association between a Direct Connect gateway and a virtual private gateway or transit gateway.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
directConnectGatewayOwnerAccount (string) --
The ID of the Amazon Web Services account that owns the associated gateway.
associationState (string) --
The state of the association. The following are the possible values:
associating : The initial state after calling CreateDirectConnectGatewayAssociation.associated : The Direct Connect gateway and virtual private gateway or transit gateway are successfully associated and ready to pass traffic.disassociating : The initial state after calling DeleteDirectConnectGatewayAssociation.disassociated : The virtual private gateway or transit gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway or transit gateway is stopped.stateChangeError (string) --
The error message if the state of an object failed to advance.
associatedGateway (dict) --
Information about the associated gateway.
id (string) --
The ID of the associated gateway.
type (string) --
The type of associated gateway.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the associated virtual private gateway or transit gateway.
region (string) --
The Region where the associated gateway is located.
associationId (string) --
The ID of the Direct Connect gateway association.
allowedPrefixesToDirectConnectGateway (list) --
The Amazon VPC prefixes to advertise to the Direct Connect gateway.
(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.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
virtualGatewayRegion (string) --
The Amazon Web Services Region where the virtual private gateway is located.
virtualGatewayOwnerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual private gateway.
nextToken (string) --
The token to retrieve the next page.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptiondescribe_direct_connect_gateway_attachments(**kwargs)¶Lists the attachments between your Direct Connect gateways and virtual interfaces. You must specify a Direct Connect gateway, a virtual interface, or both. If you specify a Direct Connect gateway, the response contains all virtual interfaces attached to the Direct Connect gateway. If you specify a virtual interface, the response contains all Direct Connect gateways attached to the virtual interface. If you specify both, the response contains the attachment between the Direct Connect gateway and the virtual interface.
See also: AWS API Documentation
Request Syntax
response = client.describe_direct_connect_gateway_attachments(
directConnectGatewayId='string',
virtualInterfaceId='string',
maxResults=123,
nextToken='string'
)
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
If MaxResults is given a value larger than 100, only 100 results are returned.
dict
Response Syntax
{
'directConnectGatewayAttachments': [
{
'directConnectGatewayId': 'string',
'virtualInterfaceId': 'string',
'virtualInterfaceRegion': 'string',
'virtualInterfaceOwnerAccount': 'string',
'attachmentState': 'attaching'|'attached'|'detaching'|'detached',
'attachmentType': 'TransitVirtualInterface'|'PrivateVirtualInterface',
'stateChangeError': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
directConnectGatewayAttachments (list) --
The attachments.
(dict) --
Information about an attachment between a Direct Connect gateway and a virtual interface.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
virtualInterfaceId (string) --
The ID of the virtual interface.
virtualInterfaceRegion (string) --
The Amazon Web Services Region where the virtual interface is located.
virtualInterfaceOwnerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual interface.
attachmentState (string) --
The state of the attachment. The following are the possible values:
attaching : The initial state after a virtual interface is created using the Direct Connect gateway.attached : The Direct Connect gateway and virtual interface are attached and ready to pass traffic.detaching : The initial state after calling DeleteVirtualInterface.detached : The virtual interface is detached from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual interface is stopped.attachmentType (string) --
The type of attachment.
stateChangeError (string) --
The error message if the state of an object failed to advance.
nextToken (string) --
The token to retrieve the next page.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptiondescribe_direct_connect_gateways(**kwargs)¶Lists all your Direct Connect gateways or only the specified Direct Connect gateway. Deleted Direct Connect gateways are not returned.
See also: AWS API Documentation
Request Syntax
response = client.describe_direct_connect_gateways(
directConnectGatewayId='string',
maxResults=123,
nextToken='string'
)
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
If MaxResults is given a value larger than 100, only 100 results are returned.
dict
Response Syntax
{
'directConnectGateways': [
{
'directConnectGatewayId': 'string',
'directConnectGatewayName': 'string',
'amazonSideAsn': 123,
'ownerAccount': 'string',
'directConnectGatewayState': 'pending'|'available'|'deleting'|'deleted',
'stateChangeError': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
directConnectGateways (list) --
The Direct Connect gateways.
(dict) --
Information about a Direct Connect gateway, which enables you to connect virtual interfaces and virtual private gateway or transit gateways.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
directConnectGatewayName (string) --
The name of the Direct Connect gateway.
amazonSideAsn (integer) --
The autonomous system number (ASN) for the Amazon side of the connection.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the Direct Connect gateway.
directConnectGatewayState (string) --
The state of the Direct Connect gateway. The following are the possible values:
pending : The initial state after calling CreateDirectConnectGateway.available : The Direct Connect gateway is ready for use.deleting : The initial state after calling DeleteDirectConnectGateway.deleted : The Direct Connect gateway is deleted and cannot pass traffic.stateChangeError (string) --
The error message if the state of an object failed to advance.
nextToken (string) --
The token to retrieve the next page.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptiondescribe_hosted_connections(**kwargs)¶Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG).
Note
Intended for use by Direct Connect Partners only.
See also: AWS API Documentation
Request Syntax
response = client.describe_hosted_connections(
connectionId='string'
)
[REQUIRED]
The ID of the interconnect or LAG.
{
'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
The connections.
Information about an Direct Connect connection.
The ID of the Amazon Web Services account that owns the connection.
The ID of the connection.
The name of the connection.
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.The Amazon Web Services Region where the connection is located.
The location of the connection.
The bandwidth of the connection.
The ID of the VLAN.
The name of the Direct Connect service provider associated with the connection.
The time of the most recent call to DescribeLoa for this connection.
The ID of the LAG.
The Direct Connect endpoint on which the physical connection terminates.
Indicates whether jumbo frames (9001 MTU) are supported.
The Direct Connect endpoint that terminates the physical connection.
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
The tags associated with the connection.
Information about a tag.
The key.
The value.
The name of the service provider associated with the connection.
Indicates whether the connection supports MAC Security (MACsec).
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 .
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt , should_encrypt , and must_encrypt .
The MAC Security (MACsec) security keys associated with the connection.
Information about the MAC Security (MACsec) secret key.
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
The Connection Key Name (CKN) for the MAC Security secret key.
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 LAGdisassociated : The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptiondescribe_interconnect_loa(**kwargs)¶Deprecated. Use DescribeLoa instead.
Gets the LOA-CFA for the specified interconnect.
The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations in the Direct Connect User Guide .
Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
response = client.describe_interconnect_loa(
interconnectId='string',
providerName='string',
loaContentType='application/pdf'
)
[REQUIRED]
The ID of the interconnect.
dict
Response Syntax
{
'loa': {
'loaContent': b'bytes',
'loaContentType': 'application/pdf'
}
}
Response Structure
(dict) --
loa (dict) --
The Letter of Authorization - Connecting Facility Assignment (LOA-CFA).
loaContent (bytes) --
The binary contents of the LOA-CFA document.
loaContentType (string) --
The standard media type for the LOA-CFA document. The only supported value is application/pdf.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptiondescribe_interconnects(**kwargs)¶Lists the interconnects owned by the Amazon Web Services account or only the specified interconnect.
See also: AWS API Documentation
Request Syntax
response = client.describe_interconnects(
interconnectId='string'
)
{
'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
The interconnects.
Information about an interconnect.
The ID of the interconnect.
The name of the interconnect.
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.The Amazon Web Services Region where the connection is located.
The location of the connection.
The bandwidth of the connection.
The time of the most recent call to DescribeLoa for this connection.
The ID of the LAG.
The Direct Connect endpoint on which the physical connection terminates.
Indicates whether jumbo frames (9001 MTU) are supported.
The Direct Connect endpoint that terminates the physical connection.
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
Indicates whether the interconnect supports a secondary BGP in the same address family (IPv4/IPv6).
The tags associated with the interconnect.
Information about a tag.
The key.
The value.
The name of the service provider associated with the interconnect.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptiondescribe_lags(**kwargs)¶Describes all your link aggregation groups (LAG) or the specified LAG.
See also: AWS API Documentation
Request Syntax
response = client.describe_lags(
lagId='string'
)
{
'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
The LAGs.
Information about a link aggregation group (LAG).
The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.
The number of physical dedicated connections bundled by the LAG, up to a maximum of 10.
The ID of the LAG.
The ID of the Amazon Web Services account that owns the LAG.
The name of the LAG.
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.The location of the LAG.
The Amazon Web Services Region where the connection is located.
The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.
The Direct Connect endpoint that hosts the LAG.
The Direct Connect endpoint that hosts the LAG.
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
The connections bundled by the LAG.
Information about an Direct Connect connection.
The ID of the Amazon Web Services account that owns the connection.
The ID of the connection.
The name of the connection.
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.The Amazon Web Services Region where the connection is located.
The location of the connection.
The bandwidth of the connection.
The ID of the VLAN.
The name of the Direct Connect service provider associated with the connection.
The time of the most recent call to DescribeLoa for this connection.
The ID of the LAG.
The Direct Connect endpoint on which the physical connection terminates.
Indicates whether jumbo frames (9001 MTU) are supported.
The Direct Connect endpoint that terminates the physical connection.
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
The tags associated with the connection.
Information about a tag.
The key.
The value.
The name of the service provider associated with the connection.
Indicates whether the connection supports MAC Security (MACsec).
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 .
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt , should_encrypt , and must_encrypt .
The MAC Security (MACsec) security keys associated with the connection.
Information about the MAC Security (MACsec) secret key.
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
The Connection Key Name (CKN) for the MAC Security secret key.
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 LAGdisassociated : The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
Indicates whether the LAG can host other connections.
Indicates whether jumbo frames (9001 MTU) are supported.
Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).
The tags associated with the LAG.
Information about a tag.
The key.
The value.
The name of the service provider associated with the LAG.
Indicates whether the LAG supports MAC Security (MACsec).
The LAG MAC Security (MACsec) encryption mode.
The valid values are no_encrypt , should_encrypt , and must_encrypt .
The MAC Security (MACsec) security keys associated with the LAG.
Information about the MAC Security (MACsec) secret key.
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
The Connection Key Name (CKN) for the MAC Security secret key.
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 LAGdisassociated : The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptiondescribe_loa(**kwargs)¶Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).
The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations in the Direct Connect User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_loa(
connectionId='string',
providerName='string',
loaContentType='application/pdf'
)
[REQUIRED]
The ID of a connection, LAG, or interconnect.
dict
Response Syntax
{
'loaContent': b'bytes',
'loaContentType': 'application/pdf'
}
Response Structure
(dict) --
Information about a Letter of Authorization - Connecting Facility Assignment (LOA-CFA) for a connection.
loaContent (bytes) --
The binary contents of the LOA-CFA document.
loaContentType (string) --
The standard media type for the LOA-CFA document. The only supported value is application/pdf.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptiondescribe_locations()¶Lists the Direct Connect locations in the current Amazon Web Services Region. These are the locations that can be selected when calling CreateConnection or CreateInterconnect.
See also: AWS API Documentation
Request Syntax
response = client.describe_locations()
{
'locations': [
{
'locationCode': 'string',
'locationName': 'string',
'region': 'string',
'availablePortSpeeds': [
'string',
],
'availableProviders': [
'string',
],
'availableMacSecPortSpeeds': [
'string',
]
},
]
}
Response Structure
The locations.
Information about an Direct Connect location.
The code for the location.
The name of the location. This includes the name of the colocation partner and the physical site of the building.
The Amazon Web Services Region for the location.
The available port speeds for the location.
The name of the service provider for the location.
The available MAC Security (MACsec) port speeds for the location.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptiondescribe_router_configuration(**kwargs)¶Details about the router.
See also: AWS API Documentation
Request Syntax
response = client.describe_router_configuration(
virtualInterfaceId='string',
routerTypeIdentifier='string'
)
[REQUIRED]
The ID of the virtual interface.
CiscoSystemsInc-2900SeriesRouters-IOS124 .dict
Response Syntax
{
'customerRouterConfig': 'string',
'router': {
'vendor': 'string',
'platform': 'string',
'software': 'string',
'xsltTemplateName': 'string',
'xsltTemplateNameForMacSec': 'string',
'routerTypeIdentifier': 'string'
},
'virtualInterfaceId': 'string',
'virtualInterfaceName': 'string'
}
Response Structure
(dict) --
customerRouterConfig (string) --
The customer router configuration.
router (dict) --
The details about the router.
vendor (string) --
The vendor for the virtual interface's router.
platform (string) --
The virtual interface router platform.
software (string) --
The router software.
xsltTemplateName (string) --
The template for the virtual interface's router.
xsltTemplateNameForMacSec (string) --
The MAC Security (MACsec) template for the virtual interface's router.
routerTypeIdentifier (string) --
Identifies the router by a combination of vendor, platform, and software version. For example, CiscoSystemsInc-2900SeriesRouters-IOS124 .
virtualInterfaceId (string) --
The ID assigned to the virtual interface.
virtualInterfaceName (string) --
Provides the details about a virtual interface's router.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptionDescribes the tags associated with the specified Direct Connect resources.
See also: AWS API Documentation
Request Syntax
response = client.describe_tags(
resourceArns=[
'string',
]
)
[REQUIRED]
The Amazon Resource Names (ARNs) of the resources.
{
'resourceTags': [
{
'resourceArn': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
]
},
]
}
Response Structure
Information about the tags.
Information about a tag associated with an Direct Connect resource.
The Amazon Resource Name (ARN) of the resource.
The tags.
Information about a tag.
The key.
The value.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptiondescribe_virtual_gateways()¶Lists the virtual private gateways owned by the Amazon Web Services account.
You can create one or more Direct Connect private virtual interfaces linked to a virtual private gateway.
See also: AWS API Documentation
Request Syntax
response = client.describe_virtual_gateways()
{
'virtualGateways': [
{
'virtualGatewayId': 'string',
'virtualGatewayState': 'string'
},
]
}
Response Structure
The virtual private gateways.
Information about a virtual private gateway for a private virtual interface.
The ID of the virtual private gateway.
The state of the virtual private gateway. The following are the possible values:
pending : Initial state after creating the virtual private gateway.available : Ready for use by a private virtual interface.deleting : Initial state after deleting the virtual private gateway.deleted : The virtual private gateway is deleted. The private virtual interface is unable to send traffic over this gateway.Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptiondescribe_virtual_interfaces(**kwargs)¶Displays all virtual interfaces for an Amazon Web Services account. Virtual interfaces deleted fewer than 15 minutes before you make the request are also returned. If you specify a connection ID, only the virtual interfaces associated with the connection are returned. If you specify a virtual interface ID, then only a single virtual interface is returned.
A virtual interface (VLAN) transmits the traffic between the Direct Connect location and the customer network.
See also: AWS API Documentation
Request Syntax
response = client.describe_virtual_interfaces(
connectionId='string',
virtualInterfaceId='string'
)
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'
},
],
'siteLinkEnabled': True|False
},
]
}
Response Structure
(dict) --
virtualInterfaces (list) --
The virtual interfaces
(dict) --
Information about a virtual interface.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private 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 that terminates the BGP peer.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
region (string) --
The Amazon Web Services Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
siteLinkEnabled (boolean) --
Indicates whether SiteLink is enabled.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptiondisassociate_connection_from_lag(**kwargs)¶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
response = client.disassociate_connection_from_lag(
connectionId='string',
lagId='string'
)
[REQUIRED]
The ID of the connection.
[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 Amazon Web Services account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.pending : The connection has been approved and is being initialized.available : The network link is up and the connection is ready for use.down : The network link is down.deleting : The connection is being deleted.deleted : The connection has been deleted.rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.unknown : The state of the connection is not available.region (string) --
The Amazon Web Services Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
hasLogicalRedundancy (string) --
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags (list) --
The tags associated with the connection.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
providerName (string) --
The name of the service provider associated with the connection.
macSecCapable (boolean) --
Indicates whether the connection supports MAC Security (MACsec).
portEncryptionStatus (string) --
The MAC Security (MACsec) port link status of the connection.
The valid values are Encryption Up , which means that there is an active Connection Key Name, or Encryption Down .
encryptionMode (string) --
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt , should_encrypt , and must_encrypt .
macSecKeys (list) --
The MAC Security (MACsec) security keys associated with the connection.
(dict) --
Information about the MAC Security (MACsec) secret key.
secretARN (string) --
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
ckn (string) --
The Connection Key Name (CKN) for the MAC Security secret key.
state (string) --
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating : The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.associated : The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.disassociating : The MAC Security (MACsec) secret key is being disassociated from the connection or LAGdisassociated : 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.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptiondisassociate_mac_sec_key(**kwargs)¶Removes the association between a MAC Security (MACsec) security key and an Direct Connect dedicated connection.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_mac_sec_key(
connectionId='string',
secretARN='string'
)
[REQUIRED]
The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).
You can use DescribeConnections or DescribeLags to retrieve connection ID.
[REQUIRED]
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
You can use DescribeConnections to retrieve the ARN of the MAC Security (MACsec) secret key.
dict
Response Syntax
{
'connectionId': 'string',
'macSecKeys': [
{
'secretARN': 'string',
'ckn': 'string',
'state': 'string',
'startOn': 'string'
},
]
}
Response Structure
(dict) --
connectionId (string) --
The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).
macSecKeys (list) --
The MAC Security (MACsec) security keys no longer associated with the dedicated 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 LAGdisassociated : 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.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_virtual_interface_test_history(**kwargs)¶Lists the virtual interface failover test history.
See also: AWS API Documentation
Request Syntax
response = client.list_virtual_interface_test_history(
testId='string',
virtualInterfaceId='string',
bgpPeers=[
'string',
],
status='string',
maxResults=123,
nextToken='string'
)
The BGP peers that were placed in the DOWN state during the virtual interface failover test.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
If MaxResults is given a value larger than 100, only 100 results are returned.
dict
Response Syntax
{
'virtualInterfaceTestHistory': [
{
'testId': 'string',
'virtualInterfaceId': 'string',
'bgpPeers': [
'string',
],
'status': 'string',
'ownerAccount': 'string',
'testDurationInMinutes': 123,
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
virtualInterfaceTestHistory (list) --
The ID of the tested virtual interface.
(dict) --
Information about the virtual interface failover test.
testId (string) --
The ID of the virtual interface failover test.
virtualInterfaceId (string) --
The ID of the tested virtual interface.
bgpPeers (list) --
The BGP peers that were put in the DOWN state as part of the virtual interface failover test.
status (string) --
The status of the virtual interface failover test.
ownerAccount (string) --
The owner ID of the tested virtual interface.
testDurationInMinutes (integer) --
The time that the virtual interface failover test ran in minutes.
startTime (datetime) --
The time that the virtual interface moves to the DOWN state.
endTime (datetime) --
The time that the virtual interface moves out of the DOWN state.
nextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptionstart_bgp_failover_test(**kwargs)¶Starts the virtual interface failover test that verifies your configuration meets your resiliency requirements by placing the BGP peering session in the DOWN state. You can then send traffic to verify that there are no outages.
You can run the test on public, private, transit, and hosted virtual interfaces.
You can use ListVirtualInterfaceTestHistory to view the virtual interface test history.
If you need to stop the test before the test interval completes, use StopBgpFailoverTest.
See also: AWS API Documentation
Request Syntax
response = client.start_bgp_failover_test(
virtualInterfaceId='string',
bgpPeers=[
'string',
],
testDurationInMinutes=123
)
[REQUIRED]
The ID of the virtual interface you want to test.
The BGP peers to place in the DOWN state.
The time in minutes that the virtual interface failover test will last.
Maximum value: 180 minutes (3 hours).
Default: 180 minutes (3 hours).
dict
Response Syntax
{
'virtualInterfaceTest': {
'testId': 'string',
'virtualInterfaceId': 'string',
'bgpPeers': [
'string',
],
'status': 'string',
'ownerAccount': 'string',
'testDurationInMinutes': 123,
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
virtualInterfaceTest (dict) --
Information about the virtual interface failover test.
testId (string) --
The ID of the virtual interface failover test.
virtualInterfaceId (string) --
The ID of the tested virtual interface.
bgpPeers (list) --
The BGP peers that were put in the DOWN state as part of the virtual interface failover test.
status (string) --
The status of the virtual interface failover test.
ownerAccount (string) --
The owner ID of the tested virtual interface.
testDurationInMinutes (integer) --
The time that the virtual interface failover test ran in minutes.
startTime (datetime) --
The time that the virtual interface moves to the DOWN state.
endTime (datetime) --
The time that the virtual interface moves out of the DOWN state.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptionstop_bgp_failover_test(**kwargs)¶Stops the virtual interface failover test.
See also: AWS API Documentation
Request Syntax
response = client.stop_bgp_failover_test(
virtualInterfaceId='string'
)
[REQUIRED]
The ID of the virtual interface you no longer want to test.
{
'virtualInterfaceTest': {
'testId': 'string',
'virtualInterfaceId': 'string',
'bgpPeers': [
'string',
],
'status': 'string',
'ownerAccount': 'string',
'testDurationInMinutes': 123,
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1)
}
}
Response Structure
Information about the virtual interface failover test.
The ID of the virtual interface failover test.
The ID of the tested virtual interface.
The BGP peers that were put in the DOWN state as part of the virtual interface failover test.
The status of the virtual interface failover test.
The owner ID of the tested virtual interface.
The time that the virtual interface failover test ran in minutes.
The time that the virtual interface moves to the DOWN state.
The time that the virtual interface moves out of the DOWN state.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptiontag_resource(**kwargs)¶Adds the specified tags to the specified Direct Connect resource. Each resource can have a maximum of 50 tags.
Each tag consists of a key and an optional value. If a tag with the same key is already associated with the resource, this action updates its value.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
[REQUIRED]
The tags to add.
Information about a tag.
The key.
The value.
dict
Response Syntax
{}
Response Structure
Exceptions
DirectConnect.Client.exceptions.DuplicateTagKeysExceptionDirectConnect.Client.exceptions.TooManyTagsExceptionDirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptionuntag_resource(**kwargs)¶Removes one or more tags from the specified Direct Connect resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
[REQUIRED]
The tag keys of the tags to remove.
dict
Response Syntax
{}
Response Structure
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptionupdate_connection(**kwargs)¶Updates the Direct Connect dedicated connection configuration.
You can update the following parameters for a connection:
See also: AWS API Documentation
Request Syntax
response = client.update_connection(
connectionId='string',
connectionName='string',
encryptionMode='string'
)
[REQUIRED]
The ID of the dedicated connection.
You can use DescribeConnections to retrieve the connection ID.
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 Amazon Web Services account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.pending : The connection has been approved and is being initialized.available : The network link is up and the connection is ready for use.down : The network link is down.deleting : The connection is being deleted.deleted : The connection has been deleted.rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.unknown : The state of the connection is not available.region (string) --
The Amazon Web Services Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
hasLogicalRedundancy (string) --
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags (list) --
The tags associated with the connection.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
providerName (string) --
The name of the service provider associated with the connection.
macSecCapable (boolean) --
Indicates whether the connection supports MAC Security (MACsec).
portEncryptionStatus (string) --
The MAC Security (MACsec) port link status of the connection.
The valid values are Encryption Up , which means that there is an active Connection Key Name, or Encryption Down .
encryptionMode (string) --
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt , should_encrypt , and must_encrypt .
macSecKeys (list) --
The MAC Security (MACsec) security keys associated with the connection.
(dict) --
Information about the MAC Security (MACsec) secret key.
secretARN (string) --
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
ckn (string) --
The Connection Key Name (CKN) for the MAC Security secret key.
state (string) --
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating : The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.associated : The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.disassociating : The MAC Security (MACsec) secret key is being disassociated from the connection or LAGdisassociated : 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.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptionupdate_direct_connect_gateway(**kwargs)¶Updates the name of a current Direct Connect gateway.
See also: AWS API Documentation
Request Syntax
response = client.update_direct_connect_gateway(
directConnectGatewayId='string',
newDirectConnectGatewayName='string'
)
[REQUIRED]
The ID of the Direct Connect gateway to update.
[REQUIRED]
The new name for the Direct Connect gateway.
dict
Response Syntax
{
'directConnectGateway': {
'directConnectGatewayId': 'string',
'directConnectGatewayName': 'string',
'amazonSideAsn': 123,
'ownerAccount': 'string',
'directConnectGatewayState': 'pending'|'available'|'deleting'|'deleted',
'stateChangeError': 'string'
}
}
Response Structure
(dict) --
directConnectGateway (dict) --
Information about a Direct Connect gateway, which enables you to connect virtual interfaces and virtual private gateway or transit gateways.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
directConnectGatewayName (string) --
The name of the Direct Connect gateway.
amazonSideAsn (integer) --
The autonomous system number (ASN) for the Amazon side of the connection.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the Direct Connect gateway.
directConnectGatewayState (string) --
The state of the Direct Connect gateway. The following are the possible values:
pending : The initial state after calling CreateDirectConnectGateway.available : The Direct Connect gateway is ready for use.deleting : The initial state after calling DeleteDirectConnectGateway.deleted : The Direct Connect gateway is deleted and cannot pass traffic.stateChangeError (string) --
The error message if the state of an object failed to advance.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptionupdate_direct_connect_gateway_association(**kwargs)¶Updates the specified attributes of the Direct Connect gateway association.
Add or remove prefixes from the association.
See also: AWS API Documentation
Request Syntax
response = client.update_direct_connect_gateway_association(
associationId='string',
addAllowedPrefixesToDirectConnectGateway=[
{
'cidr': 'string'
},
],
removeAllowedPrefixesToDirectConnectGateway=[
{
'cidr': 'string'
},
]
)
The Amazon VPC prefixes to advertise to the Direct Connect gateway.
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
dict
Response Syntax
{
'directConnectGatewayAssociation': {
'directConnectGatewayId': 'string',
'directConnectGatewayOwnerAccount': 'string',
'associationState': 'associating'|'associated'|'disassociating'|'disassociated'|'updating',
'stateChangeError': 'string',
'associatedGateway': {
'id': 'string',
'type': 'virtualPrivateGateway'|'transitGateway',
'ownerAccount': 'string',
'region': 'string'
},
'associationId': 'string',
'allowedPrefixesToDirectConnectGateway': [
{
'cidr': 'string'
},
],
'virtualGatewayId': 'string',
'virtualGatewayRegion': 'string',
'virtualGatewayOwnerAccount': 'string'
}
}
Response Structure
(dict) --
directConnectGatewayAssociation (dict) --
Information about an association between a Direct Connect gateway and a virtual private gateway or transit gateway.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
directConnectGatewayOwnerAccount (string) --
The ID of the Amazon Web Services account that owns the associated gateway.
associationState (string) --
The state of the association. The following are the possible values:
associating : The initial state after calling CreateDirectConnectGatewayAssociation.associated : The Direct Connect gateway and virtual private gateway or transit gateway are successfully associated and ready to pass traffic.disassociating : The initial state after calling DeleteDirectConnectGatewayAssociation.disassociated : The virtual private gateway or transit gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway or transit gateway is stopped.stateChangeError (string) --
The error message if the state of an object failed to advance.
associatedGateway (dict) --
Information about the associated gateway.
id (string) --
The ID of the associated gateway.
type (string) --
The type of associated gateway.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the associated virtual private gateway or transit gateway.
region (string) --
The Region where the associated gateway is located.
associationId (string) --
The ID of the Direct Connect gateway association.
allowedPrefixesToDirectConnectGateway (list) --
The Amazon VPC prefixes to advertise to the Direct Connect gateway.
(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.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
virtualGatewayRegion (string) --
The Amazon Web Services Region where the virtual private gateway is located.
virtualGatewayOwnerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual private gateway.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptionupdate_lag(**kwargs)¶Updates the attributes of the specified link aggregation group (LAG).
You can update the following LAG attributes:
Note
If you adjust the threshold value for the minimum number of operational connections, ensure that the new value does not cause the LAG to fall below the threshold and become non-operational.
See also: AWS API Documentation
Request Syntax
response = client.update_lag(
lagId='string',
lagName='string',
minimumLinks=123,
encryptionMode='string'
)
[REQUIRED]
The ID of the LAG.
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 Amazon Web Services account that owns the LAG.
lagName (string) --
The name of the LAG.
lagState (string) --
The state of the LAG. The following are the possible values:
requested : The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.pending : The LAG has been approved and is being initialized.available : The network link is established and the LAG is ready for use.down : The network link is down.deleting : The LAG is being deleted.deleted : The LAG is deleted.unknown : The state of the LAG is not available.location (string) --
The location of the LAG.
region (string) --
The Amazon Web Services Region where the connection is located.
minimumLinks (integer) --
The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.
awsDevice (string) --
The Direct Connect endpoint that hosts the LAG.
awsDeviceV2 (string) --
The Direct Connect endpoint that hosts the LAG.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
connections (list) --
The connections bundled by the LAG.
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.pending : The connection has been approved and is being initialized.available : The network link is up and the connection is ready for use.down : The network link is down.deleting : The connection is being deleted.deleted : The connection has been deleted.rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.unknown : The state of the connection is not available.region (string) --
The Amazon Web Services Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
hasLogicalRedundancy (string) --
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags (list) --
The tags associated with the connection.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
providerName (string) --
The name of the service provider associated with the connection.
macSecCapable (boolean) --
Indicates whether the connection supports MAC Security (MACsec).
portEncryptionStatus (string) --
The MAC Security (MACsec) port link status of the connection.
The valid values are Encryption Up , which means that there is an active Connection Key Name, or Encryption Down .
encryptionMode (string) --
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt , should_encrypt , and must_encrypt .
macSecKeys (list) --
The MAC Security (MACsec) security keys associated with the connection.
(dict) --
Information about the MAC Security (MACsec) secret key.
secretARN (string) --
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
ckn (string) --
The Connection Key Name (CKN) for the MAC Security secret key.
state (string) --
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating : The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.associated : The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.disassociating : The MAC Security (MACsec) secret key is being disassociated from the connection or LAGdisassociated : 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 LAGdisassociated : 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.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptionupdate_virtual_interface_attributes(**kwargs)¶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
response = client.update_virtual_interface_attributes(
virtualInterfaceId='string',
mtu=123,
enableSiteLink=True|False,
virtualInterfaceName='string'
)
[REQUIRED]
The ID of the virtual private interface.
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'
},
],
'siteLinkEnabled': True|False
}
Response Structure
(dict) --
Information about a virtual interface.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private 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 that terminates the BGP peer.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
region (string) --
The Amazon Web Services Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
siteLinkEnabled (boolean) --
Indicates whether SiteLink is enabled.
Exceptions
DirectConnect.Client.exceptions.DirectConnectServerExceptionDirectConnect.Client.exceptions.DirectConnectClientExceptionThe available paginators are:
DirectConnect.Paginator.DescribeDirectConnectGatewayAssociationsDirectConnect.Paginator.DescribeDirectConnectGatewayAttachmentsDirectConnect.Paginator.DescribeDirectConnectGatewaysDirectConnect.Paginator.DescribeDirectConnectGatewayAssociations¶paginator = client.get_paginator('describe_direct_connect_gateway_associations')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from DirectConnect.Client.describe_direct_connect_gateway_associations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
associationId='string',
associatedGatewayId='string',
directConnectGatewayId='string',
virtualGatewayId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'directConnectGatewayAssociations': [
{
'directConnectGatewayId': 'string',
'directConnectGatewayOwnerAccount': 'string',
'associationState': 'associating'|'associated'|'disassociating'|'disassociated'|'updating',
'stateChangeError': 'string',
'associatedGateway': {
'id': 'string',
'type': 'virtualPrivateGateway'|'transitGateway',
'ownerAccount': 'string',
'region': 'string'
},
'associationId': 'string',
'allowedPrefixesToDirectConnectGateway': [
{
'cidr': 'string'
},
],
'virtualGatewayId': 'string',
'virtualGatewayRegion': 'string',
'virtualGatewayOwnerAccount': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
directConnectGatewayAssociations (list) --
Information about the associations.
(dict) --
Information about an association between a Direct Connect gateway and a virtual private gateway or transit gateway.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
directConnectGatewayOwnerAccount (string) --
The ID of the Amazon Web Services account that owns the associated gateway.
associationState (string) --
The state of the association. The following are the possible values:
associating : The initial state after calling CreateDirectConnectGatewayAssociation.associated : The Direct Connect gateway and virtual private gateway or transit gateway are successfully associated and ready to pass traffic.disassociating : The initial state after calling DeleteDirectConnectGatewayAssociation.disassociated : The virtual private gateway or transit gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway or transit gateway is stopped.stateChangeError (string) --
The error message if the state of an object failed to advance.
associatedGateway (dict) --
Information about the associated gateway.
id (string) --
The ID of the associated gateway.
type (string) --
The type of associated gateway.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the associated virtual private gateway or transit gateway.
region (string) --
The Region where the associated gateway is located.
associationId (string) --
The ID of the Direct Connect gateway association.
allowedPrefixesToDirectConnectGateway (list) --
The Amazon VPC prefixes to advertise to the Direct Connect gateway.
(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.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
virtualGatewayRegion (string) --
The Amazon Web Services Region where the virtual private gateway is located.
virtualGatewayOwnerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual private gateway.
NextToken (string) --
A token to resume pagination.
DirectConnect.Paginator.DescribeDirectConnectGatewayAttachments¶paginator = client.get_paginator('describe_direct_connect_gateway_attachments')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from DirectConnect.Client.describe_direct_connect_gateway_attachments().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
directConnectGatewayId='string',
virtualInterfaceId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'directConnectGatewayAttachments': [
{
'directConnectGatewayId': 'string',
'virtualInterfaceId': 'string',
'virtualInterfaceRegion': 'string',
'virtualInterfaceOwnerAccount': 'string',
'attachmentState': 'attaching'|'attached'|'detaching'|'detached',
'attachmentType': 'TransitVirtualInterface'|'PrivateVirtualInterface',
'stateChangeError': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
directConnectGatewayAttachments (list) --
The attachments.
(dict) --
Information about an attachment between a Direct Connect gateway and a virtual interface.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
virtualInterfaceId (string) --
The ID of the virtual interface.
virtualInterfaceRegion (string) --
The Amazon Web Services Region where the virtual interface is located.
virtualInterfaceOwnerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual interface.
attachmentState (string) --
The state of the attachment. The following are the possible values:
attaching : The initial state after a virtual interface is created using the Direct Connect gateway.attached : The Direct Connect gateway and virtual interface are attached and ready to pass traffic.detaching : The initial state after calling DeleteVirtualInterface.detached : The virtual interface is detached from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual interface is stopped.attachmentType (string) --
The type of attachment.
stateChangeError (string) --
The error message if the state of an object failed to advance.
NextToken (string) --
A token to resume pagination.
DirectConnect.Paginator.DescribeDirectConnectGateways¶paginator = client.get_paginator('describe_direct_connect_gateways')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from DirectConnect.Client.describe_direct_connect_gateways().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
directConnectGatewayId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'directConnectGateways': [
{
'directConnectGatewayId': 'string',
'directConnectGatewayName': 'string',
'amazonSideAsn': 123,
'ownerAccount': 'string',
'directConnectGatewayState': 'pending'|'available'|'deleting'|'deleted',
'stateChangeError': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
directConnectGateways (list) --
The Direct Connect gateways.
(dict) --
Information about a Direct Connect gateway, which enables you to connect virtual interfaces and virtual private gateway or transit gateways.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
directConnectGatewayName (string) --
The name of the Direct Connect gateway.
amazonSideAsn (integer) --
The autonomous system number (ASN) for the Amazon side of the connection.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the Direct Connect gateway.
directConnectGatewayState (string) --
The state of the Direct Connect gateway. The following are the possible values:
pending : The initial state after calling CreateDirectConnectGateway.available : The Direct Connect gateway is ready for use.deleting : The initial state after calling DeleteDirectConnectGateway.deleted : The Direct Connect gateway is deleted and cannot pass traffic.stateChangeError (string) --
The error message if the state of an object failed to advance.
NextToken (string) --
A token to resume pagination.