2015/05/07 - AWS Direct Connect - 19 new api methods
Returns a list of interconnects owned by the AWS account.
If an interconnect ID is provided, it will only return this particular interconnect.
Request Syntax
client.describe_interconnects(
interconnectId='string'
)
string
The ID of the interconnect.
Example: dxcon-abc123
dict
Response Syntax
{
'interconnects': [
{
'interconnectId': 'string',
'interconnectName': 'string',
'interconnectState': 'requested'|'pending'|'available'|'down'|'deleting'|'deleted',
'region': 'string',
'location': 'string',
'bandwidth': 'string'
},
]
}
Response Structure
(dict) --
A structure containing a list of interconnects.
interconnects (list) --
A list of interconnects.
(dict) --
An interconnect is a connection that can host other connections.
Like a standard AWS Direct Connect connection, an interconnect represents the physical connection between an AWS Direct Connect partner's network and a specific Direct Connect location. An AWS Direct Connect partner who owns an interconnect can provision hosted connections on the interconnect for their end customers, thereby providing the end customers with connectivity to AWS services.
The resources of the interconnect, including bandwidth and VLAN numbers, are shared by all of the hosted connections on the interconnect, and the owner of the interconnect determines how these resources are assigned.
interconnectId (string) --
The ID of the interconnect.
Example: dxcon-abc123
interconnectName (string) --
The name of the interconnect.
Example: "1G Interconnect to AWS"
interconnectState (string) -- State of the interconnect.
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 has been approved, and is being initialized.
Available: The network link is up, and the interconnect is ready for use.
Down: The network link is down.
Deleted: The interconnect has been deleted.
region (string) --
The AWS region where the connection is located.
Example: us-east-1
Default: None
location (string) --
Where the connection is located.
Example: EqSV5
Default: None
bandwidth (string) --
Bandwidth of the connection.
Example: 1Gbps
Default: None
Return a list of connections that have been provisioned on the given interconnect.
Request Syntax
client.describe_connections_on_interconnect(
interconnectId='string'
)
string
[REQUIRED]
ID of the interconnect on which a list of connection is provisioned.
Example: dxcon-abc123
Default: None
dict
Response Syntax
{
'connections': [
{
'ownerAccount': 'string',
'connectionId': 'string',
'connectionName': 'string',
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'vlan': 123,
'partnerName': 'string'
},
]
}
Response Structure
(dict) --
A structure containing a list of connections.
connections (list) --
A list of connections.
(dict) --
A connection represents the physical network connection between the AWS Direct Connect location and the customer.
ownerAccount (string) --
connectionId (string) --
ID of the connection.
Example: dxcon-fg5678gh
Default: None
connectionName (string) --
The name of the connection.
Example: "My Connection to AWS"
Default: None
connectionState (string) -- State of the connection.
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.
Deleted: The connection has been deleted.
Rejected: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.
region (string) --
The AWS region where the connection is located.
Example: us-east-1
Default: None
location (string) --
Where the connection is located.
Example: EqSV5
Default: None
bandwidth (string) --
Bandwidth of the connection.
Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)
Default: None
vlan (integer) --
The VLAN ID.
Example: 101
partnerName (string) --
Returns a list of virtual private gateways owned by the AWS account.
You can create one or more AWS Direct Connect private virtual interfaces linking to a virtual private gateway. A virtual private gateway can be managed via Amazon Virtual Private Cloud (VPC) console or the EC2 CreateVpnGateway action.
Request Syntax
client.describe_virtual_gateways()
dict
Response Syntax
{
'virtualGateways': [
{
'virtualGatewayId': 'string',
'virtualGatewayState': 'string'
},
]
}
Response Structure
(dict) --
A structure containing a list of virtual private gateways.
virtualGateways (list) --
A list of virtual private gateways.
(dict) --
You can create one or more AWS Direct Connect private virtual interfaces linking to your virtual private gateway.
Virtual private gateways can be managed using the Amazon Virtual Private Cloud (Amazon VPC) console or the Amazon EC2 CreateVpnGateway action.
virtualGatewayId (string) --
The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.
Example: vgw-123er56
virtualGatewayState (string) -- State of the virtual private gateway.
Pending: This is the initial state after calling CreateVpnGateway.
Available: Ready for use by a private virtual interface.
Deleting: This is the initial state after calling DeleteVpnGateway.
Deleted: In this state, a private virtual interface is unable to send traffic over this gateway.
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 given interconnect.
Request Syntax
client.allocate_connection_on_interconnect(
bandwidth='string',
connectionName='string',
ownerAccount='string',
interconnectId='string',
vlan=123
)
string
[REQUIRED]
Bandwidth of the connection.
Example: "500Mbps"
Default: None
string
[REQUIRED]
Name of the provisioned connection.
Example: "500M Connection to AWS"
Default: None
string
[REQUIRED]
Numeric account Id of the customer for whom the connection will be provisioned.
Example: 123443215678
Default: None
string
[REQUIRED]
ID of the interconnect on which the connection will be provisioned.
Example: dxcon-456abc78
Default: None
integer
[REQUIRED]
The dedicated VLAN provisioned to the connection.
Example: 101
Default: None
dict
Response Syntax
{
'ownerAccount': 'string',
'connectionId': 'string',
'connectionName': 'string',
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'vlan': 123,
'partnerName': 'string'
}
Response Structure
(dict) --
A connection represents the physical network connection between the AWS Direct Connect location and the customer.
ownerAccount (string) --
connectionId (string) --
ID of the connection.
Example: dxcon-fg5678gh
Default: None
connectionName (string) --
The name of the connection.
Example: "My Connection to AWS"
Default: None
connectionState (string) -- State of the connection.
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.
Deleted: The connection has been deleted.
Rejected: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.
region (string) --
The AWS region where the connection is located.
Example: us-east-1
Default: None
location (string) --
Where the connection is located.
Example: EqSV5
Default: None
bandwidth (string) --
Bandwidth of the connection.
Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)
Default: None
vlan (integer) --
The VLAN ID.
Example: 101
partnerName (string) --
Creates a new connection between the customer network and a specific AWS Direct Connect location.
A connection links your internal network to an AWS Direct Connect location over a standard 1 gigabit or 10 gigabit Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router. An AWS Direct Connect location provides access to Amazon Web Services in the region it is associated with. You can establish connections with AWS Direct Connect locations in multiple regions, but a connection in one region does not provide connectivity to other regions.
Request Syntax
client.create_connection(
location='string',
bandwidth='string',
connectionName='string'
)
string
[REQUIRED]
Where the connection is located.
Example: EqSV5
Default: None
string
[REQUIRED]
Bandwidth of the connection.
Example: 1Gbps
Default: None
string
[REQUIRED]
The name of the connection.
Example: "My Connection to AWS"
Default: None
dict
Response Syntax
{
'ownerAccount': 'string',
'connectionId': 'string',
'connectionName': 'string',
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'vlan': 123,
'partnerName': 'string'
}
Response Structure
(dict) --
A connection represents the physical network connection between the AWS Direct Connect location and the customer.
ownerAccount (string) --
connectionId (string) --
ID of the connection.
Example: dxcon-fg5678gh
Default: None
connectionName (string) --
The name of the connection.
Example: "My Connection to AWS"
Default: None
connectionState (string) -- State of the connection.
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.
Deleted: The connection has been deleted.
Rejected: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.
region (string) --
The AWS region where the connection is located.
Example: us-east-1
Default: None
location (string) --
Where the connection is located.
Example: EqSV5
Default: None
bandwidth (string) --
Bandwidth of the connection.
Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)
Default: None
vlan (integer) --
The VLAN ID.
Example: 101
partnerName (string) --
Creates a new public virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A public virtual interface supports sending traffic to public services of AWS such as Amazon Simple Storage Service (Amazon S3).
Request Syntax
client.create_public_virtual_interface(
connectionId='string',
newPublicVirtualInterface={
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
]
}
)
string
[REQUIRED]
ID of the connection.
Example: dxcon-fg5678gh
Default: None
dict
[REQUIRED]
Detailed information for the public virtual interface to be created.
Default: None
virtualInterfaceName (string) -- [REQUIRED]
The name of the virtual interface assigned by the customer.
Example: "My VPC"
vlan (integer) -- [REQUIRED]
The VLAN ID.
Example: 101
asn (integer) -- [REQUIRED]
Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
Authentication key for BGP configuration.
Example: asdf34example
amazonAddress (string) -- [REQUIRED]
IP address assigned to the Amazon interface.
Example: 192.168.1.1/30
customerAddress (string) -- [REQUIRED]
IP address assigned to the customer interface.
Example: 192.168.1.2/30
routeFilterPrefixes (list) -- [REQUIRED]
A list of routes to be advertised to the AWS network in this region (public virtual interface) or your VPC (private virtual interface).
(dict) --
A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
CIDR notation for the advertised route. Multiple routes are separated by commas.
Example: 10.10.10.0/24,10.10.11.0/24
dict
Response Syntax
{
'ownerAccount': 'string',
'virtualInterfaceId': 'string',
'location': 'string',
'connectionId': 'string',
'virtualInterfaceType': 'string',
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'deleting'|'deleted'|'rejected',
'customerRouterConfig': 'string',
'virtualGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
]
}
Response Structure
(dict) --
A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.
ownerAccount (string) --
virtualInterfaceId (string) --
ID of the virtual interface.
Example: dxvif-123dfg56
Default: None
location (string) --
Where the connection is located.
Example: EqSV5
Default: None
connectionId (string) --
ID of the connection.
Example: dxcon-fg5678gh
Default: None
virtualInterfaceType (string) --
The type of virtual interface.
Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer.
Example: "My VPC"
vlan (integer) --
The VLAN ID.
Example: 101
asn (integer) --
Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
Authentication key for BGP configuration.
Example: asdf34example
amazonAddress (string) --
IP address assigned to the Amazon interface.
Example: 192.168.1.1/30
customerAddress (string) --
IP address assigned to the customer interface.
Example: 192.168.1.2/30
virtualInterfaceState (string) -- State of the virtual interface.
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.
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 will enter the 'Rejected' state.
customerRouterConfig (string) --
Information for generating the customer router configuration.
virtualGatewayId (string) --
The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.
Example: vgw-123er56
routeFilterPrefixes (list) --
A list of routes to be advertised to the AWS network in this region (public virtual interface) or your VPC (private virtual interface).
(dict) --
A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
CIDR notation for the advertised route. Multiple routes are separated by commas.
Example: 10.10.10.0/24,10.10.11.0/24
Displays all connections in this region.
If a connection ID is provided, the call returns only that particular connection.
Request Syntax
client.describe_connections(
connectionId='string'
)
string
ID of the connection.
Example: dxcon-fg5678gh
Default: None
dict
Response Syntax
{
'connections': [
{
'ownerAccount': 'string',
'connectionId': 'string',
'connectionName': 'string',
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'vlan': 123,
'partnerName': 'string'
},
]
}
Response Structure
(dict) --
A structure containing a list of connections.
connections (list) --
A list of connections.
(dict) --
A connection represents the physical network connection between the AWS Direct Connect location and the customer.
ownerAccount (string) --
connectionId (string) --
ID of the connection.
Example: dxcon-fg5678gh
Default: None
connectionName (string) --
The name of the connection.
Example: "My Connection to AWS"
Default: None
connectionState (string) -- State of the connection.
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.
Deleted: The connection has been deleted.
Rejected: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.
region (string) --
The AWS region where the connection is located.
Example: us-east-1
Default: None
location (string) --
Where the connection is located.
Example: EqSV5
Default: None
bandwidth (string) --
Bandwidth of the connection.
Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)
Default: None
vlan (integer) --
The VLAN ID.
Example: 101
partnerName (string) --
Deletes the specified interconnect.
Request Syntax
client.delete_interconnect(
interconnectId='string'
)
string
[REQUIRED]
The ID of the interconnect.
Example: dxcon-abc123
dict
Response Syntax
{
'interconnectState': 'requested'|'pending'|'available'|'down'|'deleting'|'deleted'
}
Response Structure
(dict) --
The response received when DeleteInterconnect is called.
interconnectState (string) -- State of the interconnect.
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 has been approved, and is being initialized.
Available: The network link is up, and the interconnect is ready for use.
Down: The network link is down.
Deleted: The interconnect has been deleted.
Deletes the connection.
Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. You need to cancel separately with the providers any services or charges for cross-connects or network circuits that connect you to the AWS Direct Connect location.
Request Syntax
client.delete_connection(
connectionId='string'
)
string
[REQUIRED]
ID of the connection.
Example: dxcon-fg5678gh
Default: None
dict
Response Syntax
{
'ownerAccount': 'string',
'connectionId': 'string',
'connectionName': 'string',
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'vlan': 123,
'partnerName': 'string'
}
Response Structure
(dict) --
A connection represents the physical network connection between the AWS Direct Connect location and the customer.
ownerAccount (string) --
connectionId (string) --
ID of the connection.
Example: dxcon-fg5678gh
Default: None
connectionName (string) --
The name of the connection.
Example: "My Connection to AWS"
Default: None
connectionState (string) -- State of the connection.
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.
Deleted: The connection has been deleted.
Rejected: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.
region (string) --
The AWS region where the connection is located.
Example: us-east-1
Default: None
location (string) --
Where the connection is located.
Example: EqSV5
Default: None
bandwidth (string) --
Bandwidth of the connection.
Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)
Default: None
vlan (integer) --
The VLAN ID.
Example: 101
partnerName (string) --
Creates a new private virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A private virtual interface supports sending traffic to a single virtual private cloud (VPC).
Request Syntax
client.create_private_virtual_interface(
connectionId='string',
newPrivateVirtualInterface={
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'virtualGatewayId': 'string'
}
)
string
[REQUIRED]
ID of the connection.
Example: dxcon-fg5678gh
Default: None
dict
[REQUIRED]
Detailed information for the private virtual interface to be created.
Default: None
virtualInterfaceName (string) -- [REQUIRED]
The name of the virtual interface assigned by the customer.
Example: "My VPC"
vlan (integer) -- [REQUIRED]
The VLAN ID.
Example: 101
asn (integer) -- [REQUIRED]
Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
Authentication key for BGP configuration.
Example: asdf34example
amazonAddress (string) --
IP address assigned to the Amazon interface.
Example: 192.168.1.1/30
customerAddress (string) --
IP address assigned to the customer interface.
Example: 192.168.1.2/30
virtualGatewayId (string) -- [REQUIRED]
The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.
Example: vgw-123er56
dict
Response Syntax
{
'ownerAccount': 'string',
'virtualInterfaceId': 'string',
'location': 'string',
'connectionId': 'string',
'virtualInterfaceType': 'string',
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'deleting'|'deleted'|'rejected',
'customerRouterConfig': 'string',
'virtualGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
]
}
Response Structure
(dict) --
A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.
ownerAccount (string) --
virtualInterfaceId (string) --
ID of the virtual interface.
Example: dxvif-123dfg56
Default: None
location (string) --
Where the connection is located.
Example: EqSV5
Default: None
connectionId (string) --
ID of the connection.
Example: dxcon-fg5678gh
Default: None
virtualInterfaceType (string) --
The type of virtual interface.
Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer.
Example: "My VPC"
vlan (integer) --
The VLAN ID.
Example: 101
asn (integer) --
Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
Authentication key for BGP configuration.
Example: asdf34example
amazonAddress (string) --
IP address assigned to the Amazon interface.
Example: 192.168.1.1/30
customerAddress (string) --
IP address assigned to the customer interface.
Example: 192.168.1.2/30
virtualInterfaceState (string) -- State of the virtual interface.
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.
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 will enter the 'Rejected' state.
customerRouterConfig (string) --
Information for generating the customer router configuration.
virtualGatewayId (string) --
The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.
Example: vgw-123er56
routeFilterPrefixes (list) --
A list of routes to be advertised to the AWS network in this region (public virtual interface) or your VPC (private virtual interface).
(dict) --
A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
CIDR notation for the advertised route. Multiple routes are separated by commas.
Example: 10.10.10.0/24,10.10.11.0/24
Accept ownership of a private virtual interface created by another customer.
After the virtual interface owner calls this function, the virtual interface will be created and attached to the given virtual private gateway, and will be available for handling traffic.
Request Syntax
client.confirm_private_virtual_interface(
virtualInterfaceId='string',
virtualGatewayId='string'
)
string
[REQUIRED]
ID of the virtual interface.
Example: dxvif-123dfg56
Default: None
string
[REQUIRED]
ID of the virtual private gateway that will be attached to the virtual interface.
A virtual private gateway can be managed via the Amazon Virtual Private Cloud (VPC) console or the EC2 CreateVpnGateway action.
Default: None
dict
Response Syntax
{
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'deleting'|'deleted'|'rejected'
}
Response Structure
(dict) --
The response received when ConfirmPrivateVirtualInterface is called.
virtualInterfaceState (string) -- State of the virtual interface.
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.
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 will enter the 'Rejected' state.
Provisions a private virtual interface to be owned by a different customer.
The owner of a connection calls this function to provision a private virtual interface which will be owned by another AWS customer.
Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPrivateVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic.
Request Syntax
client.allocate_private_virtual_interface(
connectionId='string',
ownerAccount='string',
newPrivateVirtualInterfaceAllocation={
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string'
}
)
string
[REQUIRED]
The connection ID on which the private virtual interface is provisioned.
Default: None
string
[REQUIRED]
The AWS account that will own the new private virtual interface.
Default: None
dict
[REQUIRED]
Detailed information for the private virtual interface to be provisioned.
Default: None
virtualInterfaceName (string) -- [REQUIRED]
The name of the virtual interface assigned by the customer.
Example: "My VPC"
vlan (integer) -- [REQUIRED]
The VLAN ID.
Example: 101
asn (integer) -- [REQUIRED]
Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
Authentication key for BGP configuration.
Example: asdf34example
amazonAddress (string) --
IP address assigned to the Amazon interface.
Example: 192.168.1.1/30
customerAddress (string) --
IP address assigned to the customer interface.
Example: 192.168.1.2/30
dict
Response Syntax
{
'ownerAccount': 'string',
'virtualInterfaceId': 'string',
'location': 'string',
'connectionId': 'string',
'virtualInterfaceType': 'string',
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'deleting'|'deleted'|'rejected',
'customerRouterConfig': 'string',
'virtualGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
]
}
Response Structure
(dict) --
A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.
ownerAccount (string) --
virtualInterfaceId (string) --
ID of the virtual interface.
Example: dxvif-123dfg56
Default: None
location (string) --
Where the connection is located.
Example: EqSV5
Default: None
connectionId (string) --
ID of the connection.
Example: dxcon-fg5678gh
Default: None
virtualInterfaceType (string) --
The type of virtual interface.
Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer.
Example: "My VPC"
vlan (integer) --
The VLAN ID.
Example: 101
asn (integer) --
Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
Authentication key for BGP configuration.
Example: asdf34example
amazonAddress (string) --
IP address assigned to the Amazon interface.
Example: 192.168.1.1/30
customerAddress (string) --
IP address assigned to the customer interface.
Example: 192.168.1.2/30
virtualInterfaceState (string) -- State of the virtual interface.
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.
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 will enter the 'Rejected' state.
customerRouterConfig (string) --
Information for generating the customer router configuration.
virtualGatewayId (string) --
The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.
Example: vgw-123er56
routeFilterPrefixes (list) --
A list of routes to be advertised to the AWS network in this region (public virtual interface) or your VPC (private virtual interface).
(dict) --
A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
CIDR notation for the advertised route. Multiple routes are separated by commas.
Example: 10.10.10.0/24,10.10.11.0/24
Provisions a public virtual interface to be owned by a different customer.
The owner of a connection calls this function to provision a public virtual interface which will be owned by another AWS customer.
Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic.
Request Syntax
client.allocate_public_virtual_interface(
connectionId='string',
ownerAccount='string',
newPublicVirtualInterfaceAllocation={
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
]
}
)
string
[REQUIRED]
The connection ID on which the public virtual interface is provisioned.
Default: None
string
[REQUIRED]
The AWS account that will own the new public virtual interface.
Default: None
dict
[REQUIRED]
Detailed information for the public virtual interface to be provisioned.
Default: None
virtualInterfaceName (string) -- [REQUIRED]
The name of the virtual interface assigned by the customer.
Example: "My VPC"
vlan (integer) -- [REQUIRED]
The VLAN ID.
Example: 101
asn (integer) -- [REQUIRED]
Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
Authentication key for BGP configuration.
Example: asdf34example
amazonAddress (string) -- [REQUIRED]
IP address assigned to the Amazon interface.
Example: 192.168.1.1/30
customerAddress (string) -- [REQUIRED]
IP address assigned to the customer interface.
Example: 192.168.1.2/30
routeFilterPrefixes (list) -- [REQUIRED]
A list of routes to be advertised to the AWS network in this region (public virtual interface) or your VPC (private virtual interface).
(dict) --
A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
CIDR notation for the advertised route. Multiple routes are separated by commas.
Example: 10.10.10.0/24,10.10.11.0/24
dict
Response Syntax
{
'ownerAccount': 'string',
'virtualInterfaceId': 'string',
'location': 'string',
'connectionId': 'string',
'virtualInterfaceType': 'string',
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'deleting'|'deleted'|'rejected',
'customerRouterConfig': 'string',
'virtualGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
]
}
Response Structure
(dict) --
A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.
ownerAccount (string) --
virtualInterfaceId (string) --
ID of the virtual interface.
Example: dxvif-123dfg56
Default: None
location (string) --
Where the connection is located.
Example: EqSV5
Default: None
connectionId (string) --
ID of the connection.
Example: dxcon-fg5678gh
Default: None
virtualInterfaceType (string) --
The type of virtual interface.
Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer.
Example: "My VPC"
vlan (integer) --
The VLAN ID.
Example: 101
asn (integer) --
Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
Authentication key for BGP configuration.
Example: asdf34example
amazonAddress (string) --
IP address assigned to the Amazon interface.
Example: 192.168.1.1/30
customerAddress (string) --
IP address assigned to the customer interface.
Example: 192.168.1.2/30
virtualInterfaceState (string) -- State of the virtual interface.
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.
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 will enter the 'Rejected' state.
customerRouterConfig (string) --
Information for generating the customer router configuration.
virtualGatewayId (string) --
The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.
Example: vgw-123er56
routeFilterPrefixes (list) --
A list of routes to be advertised to the AWS network in this region (public virtual interface) or your VPC (private virtual interface).
(dict) --
A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
CIDR notation for the advertised route. Multiple routes are separated by commas.
Example: 10.10.10.0/24,10.10.11.0/24
Accept ownership of a public virtual interface created by another customer.
After the virtual interface owner calls this function, the specified virtual interface will be created and made available for handling traffic.
Request Syntax
client.confirm_public_virtual_interface(
virtualInterfaceId='string'
)
string
[REQUIRED]
ID of the virtual interface.
Example: dxvif-123dfg56
Default: None
dict
Response Syntax
{
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'deleting'|'deleted'|'rejected'
}
Response Structure
(dict) --
The response received when ConfirmPublicVirtualInterface is called.
virtualInterfaceState (string) -- State of the virtual interface.
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.
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 will enter the 'Rejected' state.
Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before DescribeVirtualInterfaces is called are also returned. If a connection ID is included then only virtual interfaces associated with this connection will be returned. If a virtual interface ID is included then only a single virtual interface will be returned.
A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.
If a connection ID is provided, only virtual interfaces provisioned on the specified connection will be returned. If a virtual interface ID is provided, only this particular virtual interface will be returned.
Request Syntax
client.describe_virtual_interfaces(
connectionId='string',
virtualInterfaceId='string'
)
string
ID of the connection.
Example: dxcon-fg5678gh
Default: None
string
ID of the virtual interface.
Example: dxvif-123dfg56
Default: None
dict
Response Syntax
{
'virtualInterfaces': [
{
'ownerAccount': 'string',
'virtualInterfaceId': 'string',
'location': 'string',
'connectionId': 'string',
'virtualInterfaceType': 'string',
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'deleting'|'deleted'|'rejected',
'customerRouterConfig': 'string',
'virtualGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
]
},
]
}
Response Structure
(dict) --
A structure containing a list of virtual interfaces.
virtualInterfaces (list) --
A list of virtual interfaces.
(dict) --
A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.
ownerAccount (string) --
virtualInterfaceId (string) --
ID of the virtual interface.
Example: dxvif-123dfg56
Default: None
location (string) --
Where the connection is located.
Example: EqSV5
Default: None
connectionId (string) --
ID of the connection.
Example: dxcon-fg5678gh
Default: None
virtualInterfaceType (string) --
The type of virtual interface.
Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer.
Example: "My VPC"
vlan (integer) --
The VLAN ID.
Example: 101
asn (integer) --
Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
Authentication key for BGP configuration.
Example: asdf34example
amazonAddress (string) --
IP address assigned to the Amazon interface.
Example: 192.168.1.1/30
customerAddress (string) --
IP address assigned to the customer interface.
Example: 192.168.1.2/30
virtualInterfaceState (string) -- State of the virtual interface.
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.
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 will enter the 'Rejected' state.
customerRouterConfig (string) --
Information for generating the customer router configuration.
virtualGatewayId (string) --
The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.
Example: vgw-123er56
routeFilterPrefixes (list) --
A list of routes to be advertised to the AWS network in this region (public virtual interface) or your VPC (private virtual interface).
(dict) --
A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
CIDR notation for the advertised route. Multiple routes are separated by commas.
Example: 10.10.10.0/24,10.10.11.0/24
Confirm the creation of a hosted connection on an interconnect.
Upon creation, the hosted connection is initially in the 'Ordering' state, and will remain in this state until the owner calls ConfirmConnection to confirm creation of the hosted connection.
Request Syntax
client.confirm_connection(
connectionId='string'
)
string
[REQUIRED]
ID of the connection.
Example: dxcon-fg5678gh
Default: None
dict
Response Syntax
{
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'
}
Response Structure
(dict) --
The response received when ConfirmConnection is called.
connectionState (string) -- State of the connection.
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.
Deleted: The connection has been deleted.
Rejected: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.
Returns the list of AWS Direct Connect locations in the current AWS region. These are the locations that may be selected when calling CreateConnection or CreateInterconnect.
Request Syntax
client.describe_locations()
dict
Response Syntax
{
'locations': [
{
'locationCode': 'string',
'locationName': 'string'
},
]
}
Response Structure
(dict) --
locations (list) --
(dict) --
An AWS Direct Connect location where connections and interconnects can be requested.
locationCode (string) --
The code used to indicate the AWS Direct Connect location.
locationName (string) --
The name of the AWS Direct Connect location. The name includes the colocation partner name and the physical site of the lit building.
Creates a new interconnect between a AWS Direct Connect partner's network and a specific AWS Direct Connect location.
An interconnect is a connection which is capable of hosting other connections. The AWS Direct Connect partner can use an interconnect to provide sub-1Gbps AWS Direct Connect service to tier 2 customers who do not have their own connections. Like a standard connection, an interconnect links the AWS Direct Connect partner's network to an AWS Direct Connect location over a standard 1 Gbps or 10 Gbps Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an AWS Direct Connect router.
For each end customer, the AWS Direct Connect partner provisions a connection on their interconnect by calling AllocateConnectionOnInterconnect. The end customer can then connect to AWS resources by creating a virtual interface on their connection, using the VLAN assigned to them by the AWS Direct Connect partner.
Request Syntax
client.create_interconnect(
interconnectName='string',
bandwidth='string',
location='string'
)
string
[REQUIRED]
The name of the interconnect.
Example: "1G Interconnect to AWS"
Default: None
string
[REQUIRED]
The port bandwidth
Example: 1Gbps
Default: None
Available values: 1Gbps,10Gbps
string
[REQUIRED]
Where the interconnect is located
Example: EqSV5
Default: None
dict
Response Syntax
{
'interconnectId': 'string',
'interconnectName': 'string',
'interconnectState': 'requested'|'pending'|'available'|'down'|'deleting'|'deleted',
'region': 'string',
'location': 'string',
'bandwidth': 'string'
}
Response Structure
(dict) --
An interconnect is a connection that can host other connections.
Like a standard AWS Direct Connect connection, an interconnect represents the physical connection between an AWS Direct Connect partner's network and a specific Direct Connect location. An AWS Direct Connect partner who owns an interconnect can provision hosted connections on the interconnect for their end customers, thereby providing the end customers with connectivity to AWS services.
The resources of the interconnect, including bandwidth and VLAN numbers, are shared by all of the hosted connections on the interconnect, and the owner of the interconnect determines how these resources are assigned.
interconnectId (string) --
The ID of the interconnect.
Example: dxcon-abc123
interconnectName (string) --
The name of the interconnect.
Example: "1G Interconnect to AWS"
interconnectState (string) -- State of the interconnect.
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 has been approved, and is being initialized.
Available: The network link is up, and the interconnect is ready for use.
Down: The network link is down.
Deleted: The interconnect has been deleted.
region (string) --
The AWS region where the connection is located.
Example: us-east-1
Default: None
location (string) --
Where the connection is located.
Example: EqSV5
Default: None
bandwidth (string) --
Bandwidth of the connection.
Example: 1Gbps
Default: None
Deletes a virtual interface.
Request Syntax
client.delete_virtual_interface(
virtualInterfaceId='string'
)
string
[REQUIRED]
ID of the virtual interface.
Example: dxvif-123dfg56
Default: None
dict
Response Syntax
{
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'deleting'|'deleted'|'rejected'
}
Response Structure
(dict) --
The response received when DeleteVirtualInterface is called.
virtualInterfaceState (string) -- State of the virtual interface.
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.
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 will enter the 'Rejected' state.