2019/10/07 - AWS Direct Connect - 17 updated api methods
Changes This release adds a service provider field for physical connection creation and provides a list of available partner providers for each Direct Connect location.
{'providerName': 'string'}
Deprecated. Use AllocateHostedConnection instead.
Creates a hosted connection on an interconnect.
Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the specified interconnect.
Note
Intended for use by AWS Direct Connect Partners only.
!DANGER!
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
client.allocate_connection_on_interconnect(
bandwidth='string',
connectionName='string',
ownerAccount='string',
interconnectId='string',
vlan=123
)
string
[REQUIRED]
The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those AWS Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.
string
[REQUIRED]
The name of the provisioned connection.
string
[REQUIRED]
The ID of the AWS account of the customer for whom the connection will be provisioned.
string
[REQUIRED]
The ID of the interconnect on which the connection will be provisioned.
integer
[REQUIRED]
The dedicated VLAN provisioned to the connection.
dict
Response Syntax
{
'ownerAccount': 'string',
'connectionId': 'string',
'connectionName': 'string',
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'vlan': 123,
'partnerName': 'string',
'loaIssueTime': datetime(2015, 1, 1),
'lagId': 'string',
'awsDevice': 'string',
'jumboFrameCapable': True|False,
'awsDeviceV2': 'string',
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string'
}
Response Structure
(dict) --
Information about an AWS Direct Connect connection.
ownerAccount (string) --
The ID of the AWS account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending : The connection has been approved and is being initialized.
available : The network link is up and the connection is ready for use.
down : The network link is down.
deleting : The connection is being deleted.
deleted : The connection has been deleted.
rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown : The state of the connection is not available.
region (string) --
The AWS Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the AWS Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
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.
{'providerName': 'string'}
Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects.
Allocates a VLAN number and a specified amount of capacity (bandwidth) for use by a hosted connection on the specified interconnect or LAG of interconnects. AWS polices the hosted connection for the specified capacity and the AWS Direct Connect Partner must also police the hosted connection for the specified capacity.
Note
Intended for use by AWS Direct Connect Partners only.
See also: AWS API Documentation
Request Syntax
client.allocate_hosted_connection(
connectionId='string',
ownerAccount='string',
bandwidth='string',
connectionName='string',
vlan=123,
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
string
[REQUIRED]
The ID of the interconnect or LAG.
string
[REQUIRED]
The ID of the AWS account ID of the customer for the connection.
string
[REQUIRED]
The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those AWS Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.
string
[REQUIRED]
The name of the hosted connection.
integer
[REQUIRED]
The dedicated VLAN provisioned to the hosted connection.
list
The tags associated with the connection.
(dict) --
Information about a tag.
key (string) -- [REQUIRED]
The key.
value (string) --
The value.
dict
Response Syntax
{
'ownerAccount': 'string',
'connectionId': 'string',
'connectionName': 'string',
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'vlan': 123,
'partnerName': 'string',
'loaIssueTime': datetime(2015, 1, 1),
'lagId': 'string',
'awsDevice': 'string',
'jumboFrameCapable': True|False,
'awsDeviceV2': 'string',
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string'
}
Response Structure
(dict) --
Information about an AWS Direct Connect connection.
ownerAccount (string) --
The ID of the AWS account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending : The connection has been approved and is being initialized.
available : The network link is up and the connection is ready for use.
down : The network link is down.
deleting : The connection is being deleted.
deleted : The connection has been deleted.
rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown : The state of the connection is not available.
region (string) --
The AWS Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the AWS Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
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.
{'providerName': 'string'}
Associates an existing connection with a link aggregation group (LAG). The connection is interrupted and re-established as a member of the LAG (connectivity to AWS is interrupted). The connection must be hosted on the same AWS Direct Connect endpoint as the LAG, and its bandwidth must match the bandwidth for the LAG. You can re-associate a connection that's currently associated with a different LAG; however, if removing the connection would cause the original LAG to fall below its setting for minimum number of operational connections, the request fails.
Any virtual interfaces that are directly associated with the connection are automatically re-associated with the LAG. If the connection was originally associated with a different LAG, the virtual interfaces remain associated with the original LAG.
For interconnects, any hosted connections are automatically re-associated with the LAG. If the interconnect was originally associated with a different LAG, the hosted connections remain associated with the original LAG.
See also: AWS API Documentation
Request Syntax
client.associate_connection_with_lag(
connectionId='string',
lagId='string'
)
string
[REQUIRED]
The ID of the connection.
string
[REQUIRED]
The ID of the LAG with which to associate the connection.
dict
Response Syntax
{
'ownerAccount': 'string',
'connectionId': 'string',
'connectionName': 'string',
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'vlan': 123,
'partnerName': 'string',
'loaIssueTime': datetime(2015, 1, 1),
'lagId': 'string',
'awsDevice': 'string',
'jumboFrameCapable': True|False,
'awsDeviceV2': 'string',
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string'
}
Response Structure
(dict) --
Information about an AWS Direct Connect connection.
ownerAccount (string) --
The ID of the AWS account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending : The connection has been approved and is being initialized.
available : The network link is up and the connection is ready for use.
down : The network link is down.
deleting : The connection is being deleted.
deleted : The connection has been deleted.
rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown : The state of the connection is not available.
region (string) --
The AWS Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the AWS Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
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.
{'providerName': 'string'}
Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect. If the target interconnect or LAG has an existing hosted connection with a conflicting VLAN number or IP address, the operation fails. This action temporarily interrupts the hosted connection's connectivity to AWS as it is being migrated.
Note
Intended for use by AWS Direct Connect Partners only.
See also: AWS API Documentation
Request Syntax
client.associate_hosted_connection(
connectionId='string',
parentConnectionId='string'
)
string
[REQUIRED]
The ID of the hosted connection.
string
[REQUIRED]
The ID of the interconnect or the LAG.
dict
Response Syntax
{
'ownerAccount': 'string',
'connectionId': 'string',
'connectionName': 'string',
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'vlan': 123,
'partnerName': 'string',
'loaIssueTime': datetime(2015, 1, 1),
'lagId': 'string',
'awsDevice': 'string',
'jumboFrameCapable': True|False,
'awsDeviceV2': 'string',
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string'
}
Response Structure
(dict) --
Information about an AWS Direct Connect connection.
ownerAccount (string) --
The ID of the AWS account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending : The connection has been approved and is being initialized.
available : The network link is up and the connection is ready for use.
down : The network link is down.
deleting : The connection is being deleted.
deleted : The connection has been deleted.
rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown : The state of the connection is not available.
region (string) --
The AWS Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the AWS Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
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.
{'providerName': 'string'}
Creates a connection between a customer network and a specific AWS Direct Connect location.
A connection links your internal network to an AWS Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router.
To find the locations for your Region, use DescribeLocations .
You can automatically add the new connection to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new connection is allocated on the same AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no connection is created.
See also: AWS API Documentation
Request Syntax
client.create_connection(
location='string',
bandwidth='string',
connectionName='string',
lagId='string',
tags=[
{
'key': 'string',
'value': 'string'
},
],
providerName='string'
)
string
[REQUIRED]
The location of the connection.
string
[REQUIRED]
The bandwidth of the connection.
string
[REQUIRED]
The name of the connection.
string
The ID of the LAG.
list
The tags to associate with the lag.
(dict) --
Information about a tag.
key (string) -- [REQUIRED]
The key.
value (string) --
The value.
string
The name of the service provider associated with the requested connection.
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',
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string'
}
Response Structure
(dict) --
Information about an AWS Direct Connect connection.
ownerAccount (string) --
The ID of the AWS account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending : The connection has been approved and is being initialized.
available : The network link is up and the connection is ready for use.
down : The network link is down.
deleting : The connection is being deleted.
deleted : The connection has been deleted.
rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown : The state of the connection is not available.
region (string) --
The AWS Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the AWS Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
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.
{'providerName': 'string'}
Creates an interconnect between an AWS Direct Connect Partner's network and a specific AWS Direct Connect location.
An interconnect is a connection that is capable of hosting other connections. The AWS Direct Connect partner can use an interconnect to provide AWS Direct Connect hosted connections to customers through their own network services. Like a standard connection, an interconnect links the partner's network to an AWS Direct Connect location over a standard Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an AWS Direct Connect router.
You can automatically add the new interconnect to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new interconnect is allocated on the same AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no interconnect is created.
For each end customer, the AWS Direct Connect Partner provisions a connection on their interconnect by calling AllocateHostedConnection . 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.
Note
Intended for use by AWS Direct Connect Partners only.
See also: AWS API Documentation
Request Syntax
client.create_interconnect(
interconnectName='string',
bandwidth='string',
location='string',
lagId='string',
tags=[
{
'key': 'string',
'value': 'string'
},
],
providerName='string'
)
string
[REQUIRED]
The name of the interconnect.
string
[REQUIRED]
The port bandwidth, in Gbps. The possible values are 1 and 10.
string
[REQUIRED]
The location of the interconnect.
string
The ID of the LAG.
list
The tags to associate with the interconnect.
(dict) --
Information about a tag.
key (string) -- [REQUIRED]
The key.
value (string) --
The value.
string
The name of the service provider associated with the interconnect.
dict
Response Syntax
{
'interconnectId': 'string',
'interconnectName': 'string',
'interconnectState': 'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'unknown',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'loaIssueTime': datetime(2015, 1, 1),
'lagId': 'string',
'awsDevice': 'string',
'jumboFrameCapable': True|False,
'awsDeviceV2': 'string',
'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 AWS Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
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.
{'providerName': 'string'}
Response {'connections': {'providerName': 'string'}, 'providerName': 'string'}
Creates a link aggregation group (LAG) with the specified number of bundled physical connections between the customer network and a specific AWS Direct Connect location. A LAG is a logical interface that uses the Link Aggregation Control Protocol (LACP) to aggregate multiple interfaces, enabling you to treat them as a single interface.
All connections in a LAG must use the same bandwidth and must terminate at the same AWS Direct Connect endpoint.
You can have up to 10 connections per LAG. Regardless of this limit, if you request more connections for the LAG than AWS Direct Connect can allocate on a single endpoint, no LAG is created.
You can specify an existing physical connection or interconnect to include in the LAG (which counts towards the total number of connections). Doing so interrupts the current physical connection or hosted connections, and re-establishes them as a member of the LAG. The LAG will be created on the same AWS Direct Connect endpoint to which the connection terminates. Any virtual interfaces associated with the connection are automatically disassociated and re-associated with the LAG. The connection ID does not change.
If the AWS account used to create a LAG is a registered AWS Direct Connect Partner, the LAG is automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual interfaces cannot be directly configured.
See also: AWS API Documentation
Request Syntax
client.create_lag(
numberOfConnections=123,
location='string',
connectionsBandwidth='string',
lagName='string',
connectionId='string',
tags=[
{
'key': 'string',
'value': 'string'
},
],
childConnectionTags=[
{
'key': 'string',
'value': 'string'
},
],
providerName='string'
)
integer
[REQUIRED]
The number of physical connections initially provisioned and bundled by the LAG.
string
[REQUIRED]
The location for the LAG.
string
[REQUIRED]
The bandwidth of the individual physical connections bundled by the LAG. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps.
string
[REQUIRED]
The name of the LAG.
string
The ID of an existing connection to migrate to the LAG.
list
The tags to associate with the LAG.
(dict) --
Information about a tag.
key (string) -- [REQUIRED]
The key.
value (string) --
The value.
list
The tags to associate with the automtically created LAGs.
(dict) --
Information about a tag.
key (string) -- [REQUIRED]
The key.
value (string) --
The value.
string
The name of the service provider associated with the LAG.
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',
'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',
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string'
},
],
'allowsHostedConnections': True|False,
'jumboFrameCapable': True|False,
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': '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 connections bundled by the LAG, up to a maximum of 10.
lagId (string) --
The ID of the LAG.
ownerAccount (string) --
The ID of the AWS account that owns the LAG.
lagName (string) --
The name of the LAG.
lagState (string) --
The state of the LAG. The following are the possible values:
requested : The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.
pending : The LAG has been approved and is being initialized.
available : The network link is established and the LAG is ready for use.
down : The network link is down.
deleting : The LAG is being deleted.
deleted : The LAG is deleted.
unknown : The state of the LAG is not available.
location (string) --
The location of the LAG.
region (string) --
The AWS Region where the connection is located.
minimumLinks (integer) --
The minimum number of physical connections that must be operational for the LAG itself to be operational.
awsDevice (string) --
The AWS Direct Connect endpoint that hosts the LAG.
awsDeviceV2 (string) --
The AWS Direct Connect endpoint that hosts the LAG.
connections (list) --
The connections bundled by the LAG.
(dict) --
Information about an AWS Direct Connect connection.
ownerAccount (string) --
The ID of the AWS account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending : The connection has been approved and is being initialized.
available : The network link is up and the connection is ready for use.
down : The network link is down.
deleting : The connection is being deleted.
deleted : The connection has been deleted.
rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown : The state of the connection is not available.
region (string) --
The AWS Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the AWS Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
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.
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.
{'providerName': 'string'}
Deletes the specified connection.
Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. If you are partnering with any third parties to connect with the AWS Direct Connect location, you must cancel your service with them separately.
See also: AWS API Documentation
Request Syntax
client.delete_connection(
connectionId='string'
)
string
[REQUIRED]
The ID of the connection.
dict
Response Syntax
{
'ownerAccount': 'string',
'connectionId': 'string',
'connectionName': 'string',
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'vlan': 123,
'partnerName': 'string',
'loaIssueTime': datetime(2015, 1, 1),
'lagId': 'string',
'awsDevice': 'string',
'jumboFrameCapable': True|False,
'awsDeviceV2': 'string',
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string'
}
Response Structure
(dict) --
Information about an AWS Direct Connect connection.
ownerAccount (string) --
The ID of the AWS account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending : The connection has been approved and is being initialized.
available : The network link is up and the connection is ready for use.
down : The network link is down.
deleting : The connection is being deleted.
deleted : The connection has been deleted.
rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown : The state of the connection is not available.
region (string) --
The AWS Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the AWS Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
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.
{'connections': {'providerName': 'string'}, 'providerName': 'string'}
Deletes the specified link aggregation group (LAG). You cannot delete a LAG if it has active virtual interfaces or hosted connections.
See also: AWS API Documentation
Request Syntax
client.delete_lag(
lagId='string'
)
string
[REQUIRED]
The ID of the LAG.
dict
Response Syntax
{
'connectionsBandwidth': 'string',
'numberOfConnections': 123,
'lagId': 'string',
'ownerAccount': 'string',
'lagName': 'string',
'lagState': 'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'unknown',
'location': 'string',
'region': 'string',
'minimumLinks': 123,
'awsDevice': 'string',
'awsDeviceV2': 'string',
'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',
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string'
},
],
'allowsHostedConnections': True|False,
'jumboFrameCapable': True|False,
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': '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 connections bundled by the LAG, up to a maximum of 10.
lagId (string) --
The ID of the LAG.
ownerAccount (string) --
The ID of the AWS account that owns the LAG.
lagName (string) --
The name of the LAG.
lagState (string) --
The state of the LAG. The following are the possible values:
requested : The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.
pending : The LAG has been approved and is being initialized.
available : The network link is established and the LAG is ready for use.
down : The network link is down.
deleting : The LAG is being deleted.
deleted : The LAG is deleted.
unknown : The state of the LAG is not available.
location (string) --
The location of the LAG.
region (string) --
The AWS Region where the connection is located.
minimumLinks (integer) --
The minimum number of physical connections that must be operational for the LAG itself to be operational.
awsDevice (string) --
The AWS Direct Connect endpoint that hosts the LAG.
awsDeviceV2 (string) --
The AWS Direct Connect endpoint that hosts the LAG.
connections (list) --
The connections bundled by the LAG.
(dict) --
Information about an AWS Direct Connect connection.
ownerAccount (string) --
The ID of the AWS account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending : The connection has been approved and is being initialized.
available : The network link is up and the connection is ready for use.
down : The network link is down.
deleting : The connection is being deleted.
deleted : The connection has been deleted.
rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown : The state of the connection is not available.
region (string) --
The AWS Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the AWS Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
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.
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.
{'connections': {'providerName': 'string'}}
Displays the specified connection or all connections in this Region.
See also: AWS API Documentation
Request Syntax
client.describe_connections(
connectionId='string'
)
string
The ID of the connection.
dict
Response Syntax
{
'connections': [
{
'ownerAccount': 'string',
'connectionId': 'string',
'connectionName': 'string',
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'vlan': 123,
'partnerName': 'string',
'loaIssueTime': datetime(2015, 1, 1),
'lagId': 'string',
'awsDevice': 'string',
'jumboFrameCapable': True|False,
'awsDeviceV2': 'string',
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string'
},
]
}
Response Structure
(dict) --
connections (list) --
The connections.
(dict) --
Information about an AWS Direct Connect connection.
ownerAccount (string) --
The ID of the AWS account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending : The connection has been approved and is being initialized.
available : The network link is up and the connection is ready for use.
down : The network link is down.
deleting : The connection is being deleted.
deleted : The connection has been deleted.
rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown : The state of the connection is not available.
region (string) --
The AWS Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the AWS Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
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.
{'connections': {'providerName': 'string'}}
Deprecated. Use DescribeHostedConnections instead.
Lists the connections that have been provisioned on the specified interconnect.
Note
Intended for use by AWS Direct Connect Partners only.
!DANGER!
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
client.describe_connections_on_interconnect(
interconnectId='string'
)
string
[REQUIRED]
The ID of the interconnect.
dict
Response Syntax
{
'connections': [
{
'ownerAccount': 'string',
'connectionId': 'string',
'connectionName': 'string',
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'vlan': 123,
'partnerName': 'string',
'loaIssueTime': datetime(2015, 1, 1),
'lagId': 'string',
'awsDevice': 'string',
'jumboFrameCapable': True|False,
'awsDeviceV2': 'string',
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string'
},
]
}
Response Structure
(dict) --
connections (list) --
The connections.
(dict) --
Information about an AWS Direct Connect connection.
ownerAccount (string) --
The ID of the AWS account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending : The connection has been approved and is being initialized.
available : The network link is up and the connection is ready for use.
down : The network link is down.
deleting : The connection is being deleted.
deleted : The connection has been deleted.
rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown : The state of the connection is not available.
region (string) --
The AWS Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the AWS Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
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.
{'connections': {'providerName': 'string'}}
Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG).
Note
Intended for use by AWS Direct Connect Partners only.
See also: AWS API Documentation
Request Syntax
client.describe_hosted_connections(
connectionId='string'
)
string
[REQUIRED]
The ID of the interconnect or LAG.
dict
Response Syntax
{
'connections': [
{
'ownerAccount': 'string',
'connectionId': 'string',
'connectionName': 'string',
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'vlan': 123,
'partnerName': 'string',
'loaIssueTime': datetime(2015, 1, 1),
'lagId': 'string',
'awsDevice': 'string',
'jumboFrameCapable': True|False,
'awsDeviceV2': 'string',
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string'
},
]
}
Response Structure
(dict) --
connections (list) --
The connections.
(dict) --
Information about an AWS Direct Connect connection.
ownerAccount (string) --
The ID of the AWS account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending : The connection has been approved and is being initialized.
available : The network link is up and the connection is ready for use.
down : The network link is down.
deleting : The connection is being deleted.
deleted : The connection has been deleted.
rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown : The state of the connection is not available.
region (string) --
The AWS Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the AWS Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
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.
{'interconnects': {'providerName': 'string'}}
Lists the interconnects owned by the AWS account or only the specified interconnect.
See also: AWS API Documentation
Request Syntax
client.describe_interconnects(
interconnectId='string'
)
string
The ID of the interconnect.
dict
Response Syntax
{
'interconnects': [
{
'interconnectId': 'string',
'interconnectName': 'string',
'interconnectState': 'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'unknown',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'loaIssueTime': datetime(2015, 1, 1),
'lagId': 'string',
'awsDevice': 'string',
'jumboFrameCapable': True|False,
'awsDeviceV2': 'string',
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string'
},
]
}
Response Structure
(dict) --
interconnects (list) --
The interconnects.
(dict) --
Information about an interconnect.
interconnectId (string) --
The ID of the interconnect.
interconnectName (string) --
The name of the interconnect.
interconnectState (string) --
The state of the interconnect. The following are the possible values:
requested : The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending : The interconnect is approved, and is being initialized.
available : The network link is up, and the interconnect is ready for use.
down : The network link is down.
deleting : The interconnect is being deleted.
deleted : The interconnect is deleted.
unknown : The state of the interconnect is not available.
region (string) --
The AWS Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
hasLogicalRedundancy (string) --
Indicates whether the interconnect supports a secondary BGP in the same address family (IPv4/IPv6).
tags (list) --
The tags associated with the interconnect.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
providerName (string) --
The name of the service provider associated with the interconnect.
{'lags': {'connections': {'providerName': 'string'}, 'providerName': 'string'}}
Describes all your link aggregation groups (LAG) or the specified LAG.
See also: AWS API Documentation
Request Syntax
client.describe_lags(
lagId='string'
)
string
The ID of the LAG.
dict
Response Syntax
{
'lags': [
{
'connectionsBandwidth': 'string',
'numberOfConnections': 123,
'lagId': 'string',
'ownerAccount': 'string',
'lagName': 'string',
'lagState': 'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'unknown',
'location': 'string',
'region': 'string',
'minimumLinks': 123,
'awsDevice': 'string',
'awsDeviceV2': 'string',
'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',
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string'
},
],
'allowsHostedConnections': True|False,
'jumboFrameCapable': True|False,
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string'
},
]
}
Response Structure
(dict) --
lags (list) --
The LAGs.
(dict) --
Information about a link aggregation group (LAG).
connectionsBandwidth (string) --
The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.
numberOfConnections (integer) --
The number of physical connections bundled by the LAG, up to a maximum of 10.
lagId (string) --
The ID of the LAG.
ownerAccount (string) --
The ID of the AWS account that owns the LAG.
lagName (string) --
The name of the LAG.
lagState (string) --
The state of the LAG. The following are the possible values:
requested : The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.
pending : The LAG has been approved and is being initialized.
available : The network link is established and the LAG is ready for use.
down : The network link is down.
deleting : The LAG is being deleted.
deleted : The LAG is deleted.
unknown : The state of the LAG is not available.
location (string) --
The location of the LAG.
region (string) --
The AWS Region where the connection is located.
minimumLinks (integer) --
The minimum number of physical connections that must be operational for the LAG itself to be operational.
awsDevice (string) --
The AWS Direct Connect endpoint that hosts the LAG.
awsDeviceV2 (string) --
The AWS Direct Connect endpoint that hosts the LAG.
connections (list) --
The connections bundled by the LAG.
(dict) --
Information about an AWS Direct Connect connection.
ownerAccount (string) --
The ID of the AWS account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending : The connection has been approved and is being initialized.
available : The network link is up and the connection is ready for use.
down : The network link is down.
deleting : The connection is being deleted.
deleted : The connection has been deleted.
rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown : The state of the connection is not available.
region (string) --
The AWS Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the AWS Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
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.
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.
{'locations': {'availableProviders': ['string']}}
Lists the AWS Direct Connect locations in the current AWS Region. These are the locations that can be selected when calling CreateConnection or CreateInterconnect .
See also: AWS API Documentation
Request Syntax
client.describe_locations()
dict
Response Syntax
{
'locations': [
{
'locationCode': 'string',
'locationName': 'string',
'region': 'string',
'availablePortSpeeds': [
'string',
],
'availableProviders': [
'string',
]
},
]
}
Response Structure
(dict) --
locations (list) --
The locations.
(dict) --
Information about an AWS Direct Connect location.
locationCode (string) --
The code for the location.
locationName (string) --
The name of the location. This includes the name of the colocation partner and the physical site of the building.
region (string) --
The AWS Region for the location.
availablePortSpeeds (list) --
The available port speeds for the location.
(string) --
availableProviders (list) --
The name of the service provider for the location.
(string) --
{'providerName': 'string'}
Disassociates a connection from a link aggregation group (LAG). The connection is interrupted and re-established as a standalone connection (the connection is not deleted; to delete the connection, use the DeleteConnection request). If the LAG has associated virtual interfaces or hosted connections, they remain associated with the LAG. A disassociated connection owned by an AWS Direct Connect Partner is automatically converted to an interconnect.
If disassociating the connection would cause the LAG to fall below its setting for minimum number of operational connections, the request fails, except when it's the last member of the LAG. If all connections are disassociated, the LAG continues to exist as an empty LAG with no physical connections.
See also: AWS API Documentation
Request Syntax
client.disassociate_connection_from_lag(
connectionId='string',
lagId='string'
)
string
[REQUIRED]
The ID of the connection.
string
[REQUIRED]
The ID of the LAG.
dict
Response Syntax
{
'ownerAccount': 'string',
'connectionId': 'string',
'connectionName': 'string',
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'vlan': 123,
'partnerName': 'string',
'loaIssueTime': datetime(2015, 1, 1),
'lagId': 'string',
'awsDevice': 'string',
'jumboFrameCapable': True|False,
'awsDeviceV2': 'string',
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string'
}
Response Structure
(dict) --
Information about an AWS Direct Connect connection.
ownerAccount (string) --
The ID of the AWS account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending : The connection has been approved and is being initialized.
available : The network link is up and the connection is ready for use.
down : The network link is down.
deleting : The connection is being deleted.
deleted : The connection has been deleted.
rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown : The state of the connection is not available.
region (string) --
The AWS Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the AWS Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
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.
{'connections': {'providerName': 'string'}, 'providerName': 'string'}
Updates the attributes of the specified link aggregation group (LAG).
You can update the following attributes:
The name of the LAG.
The value for the minimum number of connections that must be operational for the LAG itself to be operational.
When you create a LAG, the default value for the minimum number of operational connections is zero (0). If you update this value and the number of operational connections falls below the specified value, the LAG automatically goes down to avoid over-utilization of the remaining connections. Adjust this value with care, as it could force the LAG down if it is set higher than the current number of operational connections.
See also: AWS API Documentation
Request Syntax
client.update_lag(
lagId='string',
lagName='string',
minimumLinks=123
)
string
[REQUIRED]
The ID of the LAG.
string
The name of the LAG.
integer
The minimum number of physical connections that must be operational for the LAG itself to be operational.
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',
'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',
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string'
},
],
'allowsHostedConnections': True|False,
'jumboFrameCapable': True|False,
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': '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 connections bundled by the LAG, up to a maximum of 10.
lagId (string) --
The ID of the LAG.
ownerAccount (string) --
The ID of the AWS account that owns the LAG.
lagName (string) --
The name of the LAG.
lagState (string) --
The state of the LAG. The following are the possible values:
requested : The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.
pending : The LAG has been approved and is being initialized.
available : The network link is established and the LAG is ready for use.
down : The network link is down.
deleting : The LAG is being deleted.
deleted : The LAG is deleted.
unknown : The state of the LAG is not available.
location (string) --
The location of the LAG.
region (string) --
The AWS Region where the connection is located.
minimumLinks (integer) --
The minimum number of physical connections that must be operational for the LAG itself to be operational.
awsDevice (string) --
The AWS Direct Connect endpoint that hosts the LAG.
awsDeviceV2 (string) --
The AWS Direct Connect endpoint that hosts the LAG.
connections (list) --
The connections bundled by the LAG.
(dict) --
Information about an AWS Direct Connect connection.
ownerAccount (string) --
The ID of the AWS account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending : The connection has been approved and is being initialized.
available : The network link is up and the connection is ready for use.
down : The network link is down.
deleting : The connection is being deleted.
deleted : The connection has been deleted.
rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown : The state of the connection is not available.
region (string) --
The AWS Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the AWS Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint on which the physical connection terminates.
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.
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.