2026/09/15 - AWS Direct Connect - 9 new16 updated api methods
Changes AWS Direct Connect is introducing flat-rate pricing, a simplified billing model that gives you a fixed monthly price for dedicated connectivity with no per-gigabyte data transfer out charges within the selected pricing tier.
Deletes the specified resiliency group. Deletion is asynchronous: the resiliency group transitions through the deleting state before it reaches the deleted state. The response returns the resiliency group so you can observe its current state without a subsequent GetResiliencyGroup call.
See also: AWS API Documentation
Request Syntax
client.delete_resiliency_group(
resiliencyGroupId='string'
)
string
[REQUIRED]
The ID of the resiliency group.
dict
Response Syntax
{
'resiliencyGroup': {
'resiliencyGroupId': 'string',
'resiliencyGroupArn': 'string',
'resiliencyGroupName': 'string',
'resiliencyGroupType': 'Managed',
'ownerAccount': 'string',
'state': 'pending'|'available'|'deleting'|'deleted',
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
}
Response Structure
(dict) --
resiliencyGroup (dict) --
Information about the resiliency group.
resiliencyGroupId (string) --
The ID of the resiliency group.
resiliencyGroupArn (string) --
The Amazon Resource Name (ARN) of the resiliency group.
resiliencyGroupName (string) --
The name of the resiliency group.
resiliencyGroupType (string) --
The type of the resiliency group. The valid value is Managed.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the resiliency group.
state (string) --
The state of the resiliency group. The valid values are pending, available, deleting, and deleted.
tags (list) --
The tags associated with the resiliency group.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
Updates the billing mode for the specified Direct Connect connections. You can update the billing mode for up to 200 connections in a single request.
See also: AWS API Documentation
Request Syntax
client.update_connections_billing_mode(
connectionIds=[
'string',
],
billingMode='PayAsYouGo'|'FlatRateTier1'|'FlatRateTier2'|'FlatRateTier3'|'FlatRateTier4'|'FlatRateTier5'
)
list
[REQUIRED]
The IDs of the connections to update. You can specify from 1 to 200 connections.
(string) --
string
[REQUIRED]
The billing mode to apply to the specified connections. The valid values are PayAsYouGo, FlatRateTier1, FlatRateTier2, FlatRateTier3, FlatRateTier4, and FlatRateTier5.
dict
Response Syntax
{
'billingMode': 'PayAsYouGo'|'FlatRateTier1'|'FlatRateTier2'|'FlatRateTier3'|'FlatRateTier4'|'FlatRateTier5'|'PortPairFlatRateTier1'|'PortPairFlatRateTier2'|'PortPairFlatRateTier3'|'PortPairFlatRateTier4'|'PortPairFlatRateTier5',
'connections': [
{
'ownerAccount': 'string',
'connectionId': 'string',
'connectionName': 'string',
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'vlan': 123,
'partnerName': 'string',
'loaIssueTime': datetime(2015, 1, 1),
'lagId': 'string',
'awsDevice': 'string',
'jumboFrameCapable': True|False,
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string',
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string',
'macSecCapable': True|False,
'portEncryptionStatus': 'string',
'encryptionMode': 'string',
'macSecKeys': [
{
'secretARN': 'string',
'ckn': 'string',
'state': 'string',
'startOn': 'string'
},
],
'rateLimiterStatus': {
'maxAllowed': 123,
'inUse': 123,
'remaining': 123,
'totalBandwidth': 'string'
},
'partnerInterconnectMacSecCapable': True|False,
'prefixPoolSizeIpv4': 123,
'prefixPoolSizeIpv6': 123,
'prefixPoolUnallocatedCountIpv4': 123,
'prefixPoolUnallocatedCountIpv6': 123,
'billingMode': 'PayAsYouGo'|'FlatRateTier1'|'FlatRateTier2'|'FlatRateTier3'|'FlatRateTier4'|'FlatRateTier5'|'PortPairFlatRateTier1'|'PortPairFlatRateTier2'|'PortPairFlatRateTier3'|'PortPairFlatRateTier4'|'PortPairFlatRateTier5'
},
]
}
Response Structure
(dict) --
billingMode (string) --
The billing mode applied to the connections.
connections (list) --
The connections with the updated billing mode.
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending: The connection has been approved and is being initialized.
available: The network link is up and the connection is ready for use.
down: The network link is down.
deleting: The connection is being deleted.
deleted: The connection has been deleted.
rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown: The state of the connection is not available.
region (string) --
The Amazon Web Services Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
hasLogicalRedundancy (string) --
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags (list) --
The tags associated with the connection.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
providerName (string) --
The name of the service provider associated with the connection.
macSecCapable (boolean) --
Indicates whether the connection supports MAC Security (MACsec).
portEncryptionStatus (string) --
The MAC Security (MACsec) port link status of the connection.
The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.
encryptionMode (string) --
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
macSecKeys (list) --
The MAC Security (MACsec) security keys associated with the connection.
(dict) --
Information about the MAC Security (MACsec) secret key.
secretARN (string) --
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
ckn (string) --
The Connection Key Name (CKN) for the MAC Security secret key.
state (string) --
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
startOn (string) --
The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
rateLimiterStatus (dict) --
The rate limiter status for the connection, including how many rate limiters are in use and the maximum allowed.
maxAllowed (integer) --
The maximum number of rate limiters allowed on the connection.
inUse (integer) --
The number of rate limiters currently in use on the connection.
remaining (integer) --
The number of rate limiters remaining (available) on the connection.
totalBandwidth (string) --
The total bandwidth allocated across all rate limiters on the connection.
partnerInterconnectMacSecCapable (boolean) --
Indicates whether the interconnect hosting this connection supports MAC Security (MACsec).
prefixPoolSizeIpv4 (integer) --
The total number of inbound IPv4 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolSizeIpv6 (integer) --
The total number of inbound IPv6 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv4 (integer) --
The number of inbound IPv4 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv6 (integer) --
The number of inbound IPv6 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
billingMode (string) --
The billing mode of the connection.
Updates the name of the specified resiliency group.
See also: AWS API Documentation
Request Syntax
client.update_resiliency_group(
resiliencyGroupId='string',
resiliencyGroupName='string',
clientToken='string'
)
string
[REQUIRED]
The ID of the resiliency group.
string
[REQUIRED]
The new name of the resiliency group.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
dict
Response Syntax
{
'resiliencyGroup': {
'resiliencyGroupId': 'string',
'resiliencyGroupArn': 'string',
'resiliencyGroupName': 'string',
'resiliencyGroupType': 'Managed',
'ownerAccount': 'string',
'state': 'pending'|'available'|'deleting'|'deleted',
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
}
Response Structure
(dict) --
resiliencyGroup (dict) --
Information about the resiliency group.
resiliencyGroupId (string) --
The ID of the resiliency group.
resiliencyGroupArn (string) --
The Amazon Resource Name (ARN) of the resiliency group.
resiliencyGroupName (string) --
The name of the resiliency group.
resiliencyGroupType (string) --
The type of the resiliency group. The valid value is Managed.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the resiliency group.
state (string) --
The state of the resiliency group. The valid values are pending, available, deleting, and deleted.
tags (list) --
The tags associated with the resiliency group.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
Gets information about the specified resiliency group.
See also: AWS API Documentation
Request Syntax
client.get_resiliency_group(
resiliencyGroupId='string'
)
string
[REQUIRED]
The ID of the resiliency group.
dict
Response Syntax
{
'resiliencyGroup': {
'resiliencyGroupId': 'string',
'resiliencyGroupArn': 'string',
'resiliencyGroupName': 'string',
'resiliencyGroupType': 'Managed',
'ownerAccount': 'string',
'state': 'pending'|'available'|'deleting'|'deleted',
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
}
Response Structure
(dict) --
resiliencyGroup (dict) --
Information about the resiliency group.
resiliencyGroupId (string) --
The ID of the resiliency group.
resiliencyGroupArn (string) --
The Amazon Resource Name (ARN) of the resiliency group.
resiliencyGroupName (string) --
The name of the resiliency group.
resiliencyGroupType (string) --
The type of the resiliency group. The valid value is Managed.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the resiliency group.
state (string) --
The state of the resiliency group. The valid values are pending, available, deleting, and deleted.
tags (list) --
The tags associated with the resiliency group.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
Creates a resiliency group. A resiliency group lets you group Direct Connect connections together and manage them as a single unit to meet a target resiliency model.
See also: AWS API Documentation
Request Syntax
client.create_resiliency_group(
resiliencyGroupName='string',
intendedResiliencyModel='maximum-resiliency'|'high-resiliency'|'basic-resiliency',
clientToken='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
string
[REQUIRED]
The name of the resiliency group.
string
[REQUIRED]
The resiliency model that the resiliency group is intended to meet. The valid values are maximum-resiliency, high-resiliency, and basic-resiliency.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
list
The tags to associate with the resiliency group.
(dict) --
Information about a tag.
key (string) -- [REQUIRED]
The key.
value (string) --
The value.
dict
Response Syntax
{
'resiliencyGroup': {
'resiliencyGroupId': 'string',
'resiliencyGroupArn': 'string',
'resiliencyGroupName': 'string',
'resiliencyGroupType': 'Managed',
'ownerAccount': 'string',
'state': 'pending'|'available'|'deleting'|'deleted',
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
}
Response Structure
(dict) --
resiliencyGroup (dict) --
Information about the resiliency group.
resiliencyGroupId (string) --
The ID of the resiliency group.
resiliencyGroupArn (string) --
The Amazon Resource Name (ARN) of the resiliency group.
resiliencyGroupName (string) --
The name of the resiliency group.
resiliencyGroupType (string) --
The type of the resiliency group. The valid value is Managed.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the resiliency group.
state (string) --
The state of the resiliency group. The valid values are pending, available, deleting, and deleted.
tags (list) --
The tags associated with the resiliency group.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
Associates one or more connections with the specified resiliency group. This operation is atomic: either all of the specified connections are associated, or the operation fails and no changes are made.
See also: AWS API Documentation
Request Syntax
client.associate_connections_to_resiliency_group(
connectionIdentifiers=[
'string',
],
resiliencyGroupId='string',
clientToken='string'
)
list
[REQUIRED]
The IDs or ARNs of the connections to associate with the resiliency group.
(string) --
string
[REQUIRED]
The ID of the resiliency group.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
dict
Response Syntax
{
'resiliencyGroupAssociations': [
{
'resiliencyGroupId': 'string',
'connectionArn': 'string',
'state': 'associating'|'associated'|'disassociating'|'disassociated'
},
]
}
Response Structure
(dict) --
resiliencyGroupAssociations (list) --
The connection associations for the resiliency group.
(dict) --
Information about an association between a connection and a resiliency group.
resiliencyGroupId (string) --
The ID of the resiliency group.
connectionArn (string) --
The Amazon Resource Name (ARN) of the associated connection.
state (string) --
The state of the association. The valid values are associating, associated, disassociating, and disassociated.
Lists the connection associations for the specified resiliency group.
See also: AWS API Documentation
Request Syntax
client.list_resiliency_group_associations(
resiliencyGroupId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The ID of the resiliency group.
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
If MaxResults is given a value larger than 100, only 100 results are returned.
string
The token for the next page of results.
dict
Response Syntax
{
'items': [
{
'resiliencyGroupId': 'string',
'connectionArn': 'string',
'state': 'associating'|'associated'|'disassociating'|'disassociated'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
The connection associations for the resiliency group.
(dict) --
Information about an association between a connection and a resiliency group.
resiliencyGroupId (string) --
The ID of the resiliency group.
connectionArn (string) --
The Amazon Resource Name (ARN) of the associated connection.
state (string) --
The state of the association. The valid values are associating, associated, disassociating, and disassociated.
nextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Lists the resiliency groups owned by your Amazon Web Services account in the current Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
client.list_resiliency_groups(
maxResults=123,
nextToken='string'
)
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
If MaxResults is given a value larger than 100, only 100 results are returned.
string
The token for the next page of results.
dict
Response Syntax
{
'items': [
{
'resiliencyGroupId': 'string',
'resiliencyGroupArn': 'string',
'resiliencyGroupName': 'string',
'resiliencyGroupType': 'Managed',
'ownerAccount': 'string',
'state': 'pending'|'available'|'deleting'|'deleted'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Summary information about the resiliency groups.
(dict) --
Summary information about a resiliency group.
resiliencyGroupId (string) --
The ID of the resiliency group.
resiliencyGroupArn (string) --
The Amazon Resource Name (ARN) of the resiliency group.
resiliencyGroupName (string) --
The name of the resiliency group.
resiliencyGroupType (string) --
The type of the resiliency group. The valid value is Managed.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the resiliency group.
state (string) --
The state of the resiliency group.
nextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Disassociates one or more connections from the specified resiliency group. This operation is atomic: either all of the specified connections are disassociated, or the operation fails and no changes are made.
See also: AWS API Documentation
Request Syntax
client.disassociate_connections_from_resiliency_group(
connectionIdentifiers=[
'string',
],
resiliencyGroupId='string',
clientToken='string'
)
list
[REQUIRED]
The IDs or ARNs of the connections to disassociate from the resiliency group.
(string) --
string
[REQUIRED]
The ID of the resiliency group.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
dict
Response Syntax
{
'resiliencyGroupAssociations': [
{
'resiliencyGroupId': 'string',
'connectionArn': 'string',
'state': 'associating'|'associated'|'disassociating'|'disassociated'
},
]
}
Response Structure
(dict) --
resiliencyGroupAssociations (list) --
The connection associations for the resiliency group.
(dict) --
Information about an association between a connection and a resiliency group.
resiliencyGroupId (string) --
The ID of the resiliency group.
connectionArn (string) --
The Amazon Resource Name (ARN) of the associated connection.
state (string) --
The state of the association. The valid values are associating, associated, disassociating, and disassociated.
{'billingMode': 'PayAsYouGo | FlatRateTier1 | FlatRateTier2 | FlatRateTier3 | '
'FlatRateTier4 | FlatRateTier5 | PortPairFlatRateTier1 | '
'PortPairFlatRateTier2 | PortPairFlatRateTier3 | '
'PortPairFlatRateTier4 | PortPairFlatRateTier5'}
Creates a hosted connection on an interconnect.
Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the specified interconnect.
See also: AWS API Documentation
Request Syntax
client.allocate_connection_on_interconnect(
bandwidth='string',
connectionName='string',
ownerAccount='string',
interconnectId='string',
vlan=123
)
string
[REQUIRED]
The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.
string
[REQUIRED]
The name of the provisioned connection.
string
[REQUIRED]
The ID of the Amazon Web Services account of the customer for whom the connection will be provisioned.
string
[REQUIRED]
The ID of the interconnect on which the connection will be provisioned.
integer
[REQUIRED]
The dedicated VLAN provisioned to the connection.
dict
Response Syntax
{
'ownerAccount': 'string',
'connectionId': 'string',
'connectionName': 'string',
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'vlan': 123,
'partnerName': 'string',
'loaIssueTime': datetime(2015, 1, 1),
'lagId': 'string',
'awsDevice': 'string',
'jumboFrameCapable': True|False,
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string',
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string',
'macSecCapable': True|False,
'portEncryptionStatus': 'string',
'encryptionMode': 'string',
'macSecKeys': [
{
'secretARN': 'string',
'ckn': 'string',
'state': 'string',
'startOn': 'string'
},
],
'rateLimiterStatus': {
'maxAllowed': 123,
'inUse': 123,
'remaining': 123,
'totalBandwidth': 'string'
},
'partnerInterconnectMacSecCapable': True|False,
'prefixPoolSizeIpv4': 123,
'prefixPoolSizeIpv6': 123,
'prefixPoolUnallocatedCountIpv4': 123,
'prefixPoolUnallocatedCountIpv6': 123,
'billingMode': 'PayAsYouGo'|'FlatRateTier1'|'FlatRateTier2'|'FlatRateTier3'|'FlatRateTier4'|'FlatRateTier5'|'PortPairFlatRateTier1'|'PortPairFlatRateTier2'|'PortPairFlatRateTier3'|'PortPairFlatRateTier4'|'PortPairFlatRateTier5'
}
Response Structure
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending: The connection has been approved and is being initialized.
available: The network link is up and the connection is ready for use.
down: The network link is down.
deleting: The connection is being deleted.
deleted: The connection has been deleted.
rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown: The state of the connection is not available.
region (string) --
The Amazon Web Services Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
hasLogicalRedundancy (string) --
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags (list) --
The tags associated with the connection.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
providerName (string) --
The name of the service provider associated with the connection.
macSecCapable (boolean) --
Indicates whether the connection supports MAC Security (MACsec).
portEncryptionStatus (string) --
The MAC Security (MACsec) port link status of the connection.
The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.
encryptionMode (string) --
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
macSecKeys (list) --
The MAC Security (MACsec) security keys associated with the connection.
(dict) --
Information about the MAC Security (MACsec) secret key.
secretARN (string) --
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
ckn (string) --
The Connection Key Name (CKN) for the MAC Security secret key.
state (string) --
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
startOn (string) --
The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
rateLimiterStatus (dict) --
The rate limiter status for the connection, including how many rate limiters are in use and the maximum allowed.
maxAllowed (integer) --
The maximum number of rate limiters allowed on the connection.
inUse (integer) --
The number of rate limiters currently in use on the connection.
remaining (integer) --
The number of rate limiters remaining (available) on the connection.
totalBandwidth (string) --
The total bandwidth allocated across all rate limiters on the connection.
partnerInterconnectMacSecCapable (boolean) --
Indicates whether the interconnect hosting this connection supports MAC Security (MACsec).
prefixPoolSizeIpv4 (integer) --
The total number of inbound IPv4 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolSizeIpv6 (integer) --
The total number of inbound IPv6 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv4 (integer) --
The number of inbound IPv4 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv6 (integer) --
The number of inbound IPv6 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
billingMode (string) --
The billing mode of the connection.
{'billingMode': 'PayAsYouGo | FlatRateTier1 | FlatRateTier2 | FlatRateTier3 | '
'FlatRateTier4 | FlatRateTier5 | PortPairFlatRateTier1 | '
'PortPairFlatRateTier2 | PortPairFlatRateTier3 | '
'PortPairFlatRateTier4 | PortPairFlatRateTier5'}
Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects.
Allocates a VLAN number and a specified amount of capacity (bandwidth) for use by a hosted connection on the specified interconnect or LAG of interconnects. Amazon Web Services polices the hosted connection for the specified capacity and the Direct Connect Partner must also police the hosted connection for the specified capacity.
See also: AWS API Documentation
Request Syntax
client.allocate_hosted_connection(
connectionId='string',
ownerAccount='string',
bandwidth='string',
connectionName='string',
vlan=123,
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
string
[REQUIRED]
The ID of the interconnect or LAG.
string
[REQUIRED]
The ID of the Amazon Web Services 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, 10Gbps, and 25Gbps. Note that only those Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps, 10Gbps, or 25Gbps hosted connection.
string
[REQUIRED]
The name of the hosted connection.
integer
[REQUIRED]
The dedicated VLAN provisioned to the hosted connection.
list
The tags associated with the connection.
(dict) --
Information about a tag.
key (string) -- [REQUIRED]
The key.
value (string) --
The value.
dict
Response Syntax
{
'ownerAccount': 'string',
'connectionId': 'string',
'connectionName': 'string',
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'vlan': 123,
'partnerName': 'string',
'loaIssueTime': datetime(2015, 1, 1),
'lagId': 'string',
'awsDevice': 'string',
'jumboFrameCapable': True|False,
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string',
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string',
'macSecCapable': True|False,
'portEncryptionStatus': 'string',
'encryptionMode': 'string',
'macSecKeys': [
{
'secretARN': 'string',
'ckn': 'string',
'state': 'string',
'startOn': 'string'
},
],
'rateLimiterStatus': {
'maxAllowed': 123,
'inUse': 123,
'remaining': 123,
'totalBandwidth': 'string'
},
'partnerInterconnectMacSecCapable': True|False,
'prefixPoolSizeIpv4': 123,
'prefixPoolSizeIpv6': 123,
'prefixPoolUnallocatedCountIpv4': 123,
'prefixPoolUnallocatedCountIpv6': 123,
'billingMode': 'PayAsYouGo'|'FlatRateTier1'|'FlatRateTier2'|'FlatRateTier3'|'FlatRateTier4'|'FlatRateTier5'|'PortPairFlatRateTier1'|'PortPairFlatRateTier2'|'PortPairFlatRateTier3'|'PortPairFlatRateTier4'|'PortPairFlatRateTier5'
}
Response Structure
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending: The connection has been approved and is being initialized.
available: The network link is up and the connection is ready for use.
down: The network link is down.
deleting: The connection is being deleted.
deleted: The connection has been deleted.
rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown: The state of the connection is not available.
region (string) --
The Amazon Web Services Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
hasLogicalRedundancy (string) --
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags (list) --
The tags associated with the connection.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
providerName (string) --
The name of the service provider associated with the connection.
macSecCapable (boolean) --
Indicates whether the connection supports MAC Security (MACsec).
portEncryptionStatus (string) --
The MAC Security (MACsec) port link status of the connection.
The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.
encryptionMode (string) --
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
macSecKeys (list) --
The MAC Security (MACsec) security keys associated with the connection.
(dict) --
Information about the MAC Security (MACsec) secret key.
secretARN (string) --
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
ckn (string) --
The Connection Key Name (CKN) for the MAC Security secret key.
state (string) --
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
startOn (string) --
The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
rateLimiterStatus (dict) --
The rate limiter status for the connection, including how many rate limiters are in use and the maximum allowed.
maxAllowed (integer) --
The maximum number of rate limiters allowed on the connection.
inUse (integer) --
The number of rate limiters currently in use on the connection.
remaining (integer) --
The number of rate limiters remaining (available) on the connection.
totalBandwidth (string) --
The total bandwidth allocated across all rate limiters on the connection.
partnerInterconnectMacSecCapable (boolean) --
Indicates whether the interconnect hosting this connection supports MAC Security (MACsec).
prefixPoolSizeIpv4 (integer) --
The total number of inbound IPv4 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolSizeIpv6 (integer) --
The total number of inbound IPv6 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv4 (integer) --
The number of inbound IPv4 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv6 (integer) --
The number of inbound IPv6 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
billingMode (string) --
The billing mode of the connection.
{'billingMode': 'PayAsYouGo | FlatRateTier1 | FlatRateTier2 | FlatRateTier3 | '
'FlatRateTier4 | FlatRateTier5 | PortPairFlatRateTier1 | '
'PortPairFlatRateTier2 | PortPairFlatRateTier3 | '
'PortPairFlatRateTier4 | PortPairFlatRateTier5'}
Associates an existing connection with a link aggregation group (LAG). The connection is interrupted and re-established as a member of the LAG (connectivity to Amazon Web Services is interrupted). The connection must be hosted on the same Direct Connect endpoint as the LAG, and its bandwidth must match the bandwidth for the LAG. You can re-associate a connection that's currently associated with a different LAG; however, if removing the connection would cause the original LAG to fall below its setting for minimum number of operational connections, the request fails.
Any virtual interfaces that are directly associated with the connection are automatically re-associated with the LAG. If the connection was originally associated with a different LAG, the virtual interfaces remain associated with the original LAG.
For interconnects, any hosted connections are automatically re-associated with the LAG. If the interconnect was originally associated with a different LAG, the hosted connections remain associated with the original LAG.
See also: AWS API Documentation
Request Syntax
client.associate_connection_with_lag(
connectionId='string',
lagId='string'
)
string
[REQUIRED]
The ID of the connection.
string
[REQUIRED]
The ID of the LAG with which to associate the connection.
dict
Response Syntax
{
'ownerAccount': 'string',
'connectionId': 'string',
'connectionName': 'string',
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'vlan': 123,
'partnerName': 'string',
'loaIssueTime': datetime(2015, 1, 1),
'lagId': 'string',
'awsDevice': 'string',
'jumboFrameCapable': True|False,
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string',
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string',
'macSecCapable': True|False,
'portEncryptionStatus': 'string',
'encryptionMode': 'string',
'macSecKeys': [
{
'secretARN': 'string',
'ckn': 'string',
'state': 'string',
'startOn': 'string'
},
],
'rateLimiterStatus': {
'maxAllowed': 123,
'inUse': 123,
'remaining': 123,
'totalBandwidth': 'string'
},
'partnerInterconnectMacSecCapable': True|False,
'prefixPoolSizeIpv4': 123,
'prefixPoolSizeIpv6': 123,
'prefixPoolUnallocatedCountIpv4': 123,
'prefixPoolUnallocatedCountIpv6': 123,
'billingMode': 'PayAsYouGo'|'FlatRateTier1'|'FlatRateTier2'|'FlatRateTier3'|'FlatRateTier4'|'FlatRateTier5'|'PortPairFlatRateTier1'|'PortPairFlatRateTier2'|'PortPairFlatRateTier3'|'PortPairFlatRateTier4'|'PortPairFlatRateTier5'
}
Response Structure
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending: The connection has been approved and is being initialized.
available: The network link is up and the connection is ready for use.
down: The network link is down.
deleting: The connection is being deleted.
deleted: The connection has been deleted.
rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown: The state of the connection is not available.
region (string) --
The Amazon Web Services Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
hasLogicalRedundancy (string) --
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags (list) --
The tags associated with the connection.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
providerName (string) --
The name of the service provider associated with the connection.
macSecCapable (boolean) --
Indicates whether the connection supports MAC Security (MACsec).
portEncryptionStatus (string) --
The MAC Security (MACsec) port link status of the connection.
The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.
encryptionMode (string) --
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
macSecKeys (list) --
The MAC Security (MACsec) security keys associated with the connection.
(dict) --
Information about the MAC Security (MACsec) secret key.
secretARN (string) --
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
ckn (string) --
The Connection Key Name (CKN) for the MAC Security secret key.
state (string) --
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
startOn (string) --
The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
rateLimiterStatus (dict) --
The rate limiter status for the connection, including how many rate limiters are in use and the maximum allowed.
maxAllowed (integer) --
The maximum number of rate limiters allowed on the connection.
inUse (integer) --
The number of rate limiters currently in use on the connection.
remaining (integer) --
The number of rate limiters remaining (available) on the connection.
totalBandwidth (string) --
The total bandwidth allocated across all rate limiters on the connection.
partnerInterconnectMacSecCapable (boolean) --
Indicates whether the interconnect hosting this connection supports MAC Security (MACsec).
prefixPoolSizeIpv4 (integer) --
The total number of inbound IPv4 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolSizeIpv6 (integer) --
The total number of inbound IPv6 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv4 (integer) --
The number of inbound IPv4 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv6 (integer) --
The number of inbound IPv6 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
billingMode (string) --
The billing mode of the connection.
{'billingMode': 'PayAsYouGo | FlatRateTier1 | FlatRateTier2 | FlatRateTier3 | '
'FlatRateTier4 | FlatRateTier5 | PortPairFlatRateTier1 | '
'PortPairFlatRateTier2 | PortPairFlatRateTier3 | '
'PortPairFlatRateTier4 | PortPairFlatRateTier5'}
Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect. If the target interconnect or LAG has an existing hosted connection with a conflicting VLAN number or IP address, the operation fails. This action temporarily interrupts the hosted connection's connectivity to Amazon Web Services as it is being migrated.
See also: AWS API Documentation
Request Syntax
client.associate_hosted_connection(
connectionId='string',
parentConnectionId='string'
)
string
[REQUIRED]
The ID of the hosted connection.
string
[REQUIRED]
The ID of the interconnect or the LAG.
dict
Response Syntax
{
'ownerAccount': 'string',
'connectionId': 'string',
'connectionName': 'string',
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'vlan': 123,
'partnerName': 'string',
'loaIssueTime': datetime(2015, 1, 1),
'lagId': 'string',
'awsDevice': 'string',
'jumboFrameCapable': True|False,
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string',
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string',
'macSecCapable': True|False,
'portEncryptionStatus': 'string',
'encryptionMode': 'string',
'macSecKeys': [
{
'secretARN': 'string',
'ckn': 'string',
'state': 'string',
'startOn': 'string'
},
],
'rateLimiterStatus': {
'maxAllowed': 123,
'inUse': 123,
'remaining': 123,
'totalBandwidth': 'string'
},
'partnerInterconnectMacSecCapable': True|False,
'prefixPoolSizeIpv4': 123,
'prefixPoolSizeIpv6': 123,
'prefixPoolUnallocatedCountIpv4': 123,
'prefixPoolUnallocatedCountIpv6': 123,
'billingMode': 'PayAsYouGo'|'FlatRateTier1'|'FlatRateTier2'|'FlatRateTier3'|'FlatRateTier4'|'FlatRateTier5'|'PortPairFlatRateTier1'|'PortPairFlatRateTier2'|'PortPairFlatRateTier3'|'PortPairFlatRateTier4'|'PortPairFlatRateTier5'
}
Response Structure
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending: The connection has been approved and is being initialized.
available: The network link is up and the connection is ready for use.
down: The network link is down.
deleting: The connection is being deleted.
deleted: The connection has been deleted.
rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown: The state of the connection is not available.
region (string) --
The Amazon Web Services Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
hasLogicalRedundancy (string) --
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags (list) --
The tags associated with the connection.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
providerName (string) --
The name of the service provider associated with the connection.
macSecCapable (boolean) --
Indicates whether the connection supports MAC Security (MACsec).
portEncryptionStatus (string) --
The MAC Security (MACsec) port link status of the connection.
The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.
encryptionMode (string) --
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
macSecKeys (list) --
The MAC Security (MACsec) security keys associated with the connection.
(dict) --
Information about the MAC Security (MACsec) secret key.
secretARN (string) --
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
ckn (string) --
The Connection Key Name (CKN) for the MAC Security secret key.
state (string) --
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
startOn (string) --
The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
rateLimiterStatus (dict) --
The rate limiter status for the connection, including how many rate limiters are in use and the maximum allowed.
maxAllowed (integer) --
The maximum number of rate limiters allowed on the connection.
inUse (integer) --
The number of rate limiters currently in use on the connection.
remaining (integer) --
The number of rate limiters remaining (available) on the connection.
totalBandwidth (string) --
The total bandwidth allocated across all rate limiters on the connection.
partnerInterconnectMacSecCapable (boolean) --
Indicates whether the interconnect hosting this connection supports MAC Security (MACsec).
prefixPoolSizeIpv4 (integer) --
The total number of inbound IPv4 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolSizeIpv6 (integer) --
The total number of inbound IPv6 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv4 (integer) --
The number of inbound IPv4 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv6 (integer) --
The number of inbound IPv6 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
billingMode (string) --
The billing mode of the connection.
{'billingMode': 'PayAsYouGo | FlatRateTier1 | FlatRateTier2 | FlatRateTier3 | '
'FlatRateTier4 | FlatRateTier5'}
Response {'billingMode': 'PayAsYouGo | FlatRateTier1 | FlatRateTier2 | FlatRateTier3 | '
'FlatRateTier4 | FlatRateTier5 | PortPairFlatRateTier1 | '
'PortPairFlatRateTier2 | PortPairFlatRateTier3 | '
'PortPairFlatRateTier4 | PortPairFlatRateTier5'}
Creates a connection between a customer network and a specific Direct Connect location.
A connection links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an Direct Connect router.
To find the locations for your Region, use DescribeLocations.
You can automatically add the new connection to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new connection is allocated on the same Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no connection is created.
See also: AWS API Documentation
Request Syntax
client.create_connection(
location='string',
bandwidth='string',
connectionName='string',
lagId='string',
tags=[
{
'key': 'string',
'value': 'string'
},
],
providerName='string',
requestMACSec=True|False,
billingMode='PayAsYouGo'|'FlatRateTier1'|'FlatRateTier2'|'FlatRateTier3'|'FlatRateTier4'|'FlatRateTier5'
)
string
[REQUIRED]
The location of the connection.
string
[REQUIRED]
The bandwidth of the connection.
string
[REQUIRED]
The name of the connection.
string
The ID of the LAG.
list
The tags to associate with the lag.
(dict) --
Information about a tag.
key (string) -- [REQUIRED]
The key.
value (string) --
The value.
string
The name of the service provider associated with the requested connection.
boolean
Indicates whether you want the connection to support MAC Security (MACsec).
MAC Security (MACsec) is unavailable on hosted connections. For information about MAC Security (MACsec) prerequisites, see MAC Security in Direct Connect in the Direct Connect User Guide.
string
The billing mode for the connection.
dict
Response Syntax
{
'ownerAccount': 'string',
'connectionId': 'string',
'connectionName': 'string',
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'vlan': 123,
'partnerName': 'string',
'loaIssueTime': datetime(2015, 1, 1),
'lagId': 'string',
'awsDevice': 'string',
'jumboFrameCapable': True|False,
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string',
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string',
'macSecCapable': True|False,
'portEncryptionStatus': 'string',
'encryptionMode': 'string',
'macSecKeys': [
{
'secretARN': 'string',
'ckn': 'string',
'state': 'string',
'startOn': 'string'
},
],
'rateLimiterStatus': {
'maxAllowed': 123,
'inUse': 123,
'remaining': 123,
'totalBandwidth': 'string'
},
'partnerInterconnectMacSecCapable': True|False,
'prefixPoolSizeIpv4': 123,
'prefixPoolSizeIpv6': 123,
'prefixPoolUnallocatedCountIpv4': 123,
'prefixPoolUnallocatedCountIpv6': 123,
'billingMode': 'PayAsYouGo'|'FlatRateTier1'|'FlatRateTier2'|'FlatRateTier3'|'FlatRateTier4'|'FlatRateTier5'|'PortPairFlatRateTier1'|'PortPairFlatRateTier2'|'PortPairFlatRateTier3'|'PortPairFlatRateTier4'|'PortPairFlatRateTier5'
}
Response Structure
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending: The connection has been approved and is being initialized.
available: The network link is up and the connection is ready for use.
down: The network link is down.
deleting: The connection is being deleted.
deleted: The connection has been deleted.
rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown: The state of the connection is not available.
region (string) --
The Amazon Web Services Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
hasLogicalRedundancy (string) --
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags (list) --
The tags associated with the connection.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
providerName (string) --
The name of the service provider associated with the connection.
macSecCapable (boolean) --
Indicates whether the connection supports MAC Security (MACsec).
portEncryptionStatus (string) --
The MAC Security (MACsec) port link status of the connection.
The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.
encryptionMode (string) --
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
macSecKeys (list) --
The MAC Security (MACsec) security keys associated with the connection.
(dict) --
Information about the MAC Security (MACsec) secret key.
secretARN (string) --
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
ckn (string) --
The Connection Key Name (CKN) for the MAC Security secret key.
state (string) --
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
startOn (string) --
The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
rateLimiterStatus (dict) --
The rate limiter status for the connection, including how many rate limiters are in use and the maximum allowed.
maxAllowed (integer) --
The maximum number of rate limiters allowed on the connection.
inUse (integer) --
The number of rate limiters currently in use on the connection.
remaining (integer) --
The number of rate limiters remaining (available) on the connection.
totalBandwidth (string) --
The total bandwidth allocated across all rate limiters on the connection.
partnerInterconnectMacSecCapable (boolean) --
Indicates whether the interconnect hosting this connection supports MAC Security (MACsec).
prefixPoolSizeIpv4 (integer) --
The total number of inbound IPv4 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolSizeIpv6 (integer) --
The total number of inbound IPv6 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv4 (integer) --
The number of inbound IPv4 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv6 (integer) --
The number of inbound IPv6 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
billingMode (string) --
The billing mode of the connection.
{'billingMode': 'PayAsYouGo | FlatRateTier1 | FlatRateTier2 | FlatRateTier3 | '
'FlatRateTier4 | FlatRateTier5'}
Response {'billingMode': 'PayAsYouGo | FlatRateTier1 | FlatRateTier2 | FlatRateTier3 | '
'FlatRateTier4 | FlatRateTier5 | PortPairFlatRateTier1 | '
'PortPairFlatRateTier2 | PortPairFlatRateTier3 | '
'PortPairFlatRateTier4 | PortPairFlatRateTier5',
'connections': {'billingMode': 'PayAsYouGo | FlatRateTier1 | FlatRateTier2 | '
'FlatRateTier3 | FlatRateTier4 | FlatRateTier5 '
'| PortPairFlatRateTier1 | '
'PortPairFlatRateTier2 | PortPairFlatRateTier3 '
'| PortPairFlatRateTier4 | '
'PortPairFlatRateTier5'}}
Creates a link aggregation group (LAG) with the specified number of bundled physical dedicated connections between the customer network and a specific Direct Connect location. A LAG is a logical interface that uses the Link Aggregation Control Protocol (LACP) to aggregate multiple interfaces, enabling you to treat them as a single interface.
All connections in a LAG must use the same bandwidth (either 1Gbps, 10Gbps, 100Gbps, or 400Gbps) and must terminate at the same Direct Connect endpoint.
You can have up to 10 dedicated connections per location. Regardless of this limit, if you request more connections for the LAG than Direct Connect can allocate on a single endpoint, no LAG is created..
You can specify an existing physical dedicated connection or interconnect to include in the LAG (which counts towards the total number of connections). Doing so interrupts the current physical dedicated connection, and re-establishes them as a member of the LAG. The LAG will be created on the same Direct Connect endpoint to which the dedicated connection terminates. Any virtual interfaces associated with the dedicated connection are automatically disassociated and re-associated with the LAG. The connection ID does not change.
If the Amazon Web Services account used to create a LAG is a registered Direct Connect Partner, the LAG is automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual interfaces cannot be directly configured.
See also: AWS API Documentation
Request Syntax
client.create_lag(
numberOfConnections=123,
location='string',
connectionsBandwidth='string',
lagName='string',
connectionId='string',
tags=[
{
'key': 'string',
'value': 'string'
},
],
childConnectionTags=[
{
'key': 'string',
'value': 'string'
},
],
providerName='string',
requestMACSec=True|False,
billingMode='PayAsYouGo'|'FlatRateTier1'|'FlatRateTier2'|'FlatRateTier3'|'FlatRateTier4'|'FlatRateTier5'
)
integer
[REQUIRED]
The number of physical dedicated connections initially provisioned and bundled by the LAG. You can have a maximum of four connections when the port speed is 1Gbps or 10Gbps, or two when the port speed is 100Gbps or 400Gbps.
string
[REQUIRED]
The location for the LAG.
string
[REQUIRED]
The bandwidth of the individual physical dedicated connections bundled by the LAG. The possible values are 1Gbps,10Gbps, 100Gbps, and 400Gbps.
string
[REQUIRED]
The name of the LAG.
string
The ID of an existing dedicated connection to migrate to the LAG.
list
The tags to associate with the LAG.
(dict) --
Information about a tag.
key (string) -- [REQUIRED]
The key.
value (string) --
The value.
list
The tags to associate with the automtically created LAGs.
(dict) --
Information about a tag.
key (string) -- [REQUIRED]
The key.
value (string) --
The value.
string
The name of the service provider associated with the LAG.
boolean
Indicates whether the connection will support MAC Security (MACsec).
string
The billing mode for the LAG.
dict
Response Syntax
{
'connectionsBandwidth': 'string',
'numberOfConnections': 123,
'lagId': 'string',
'ownerAccount': 'string',
'lagName': 'string',
'lagState': 'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'unknown',
'location': 'string',
'region': 'string',
'minimumLinks': 123,
'awsDevice': 'string',
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string',
'connections': [
{
'ownerAccount': 'string',
'connectionId': 'string',
'connectionName': 'string',
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'vlan': 123,
'partnerName': 'string',
'loaIssueTime': datetime(2015, 1, 1),
'lagId': 'string',
'awsDevice': 'string',
'jumboFrameCapable': True|False,
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string',
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string',
'macSecCapable': True|False,
'portEncryptionStatus': 'string',
'encryptionMode': 'string',
'macSecKeys': [
{
'secretARN': 'string',
'ckn': 'string',
'state': 'string',
'startOn': 'string'
},
],
'rateLimiterStatus': {
'maxAllowed': 123,
'inUse': 123,
'remaining': 123,
'totalBandwidth': 'string'
},
'partnerInterconnectMacSecCapable': True|False,
'prefixPoolSizeIpv4': 123,
'prefixPoolSizeIpv6': 123,
'prefixPoolUnallocatedCountIpv4': 123,
'prefixPoolUnallocatedCountIpv6': 123,
'billingMode': 'PayAsYouGo'|'FlatRateTier1'|'FlatRateTier2'|'FlatRateTier3'|'FlatRateTier4'|'FlatRateTier5'|'PortPairFlatRateTier1'|'PortPairFlatRateTier2'|'PortPairFlatRateTier3'|'PortPairFlatRateTier4'|'PortPairFlatRateTier5'
},
],
'allowsHostedConnections': True|False,
'jumboFrameCapable': True|False,
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string',
'macSecCapable': True|False,
'encryptionMode': 'string',
'macSecKeys': [
{
'secretARN': 'string',
'ckn': 'string',
'state': 'string',
'startOn': 'string'
},
],
'prefixPoolSizeIpv4': 123,
'prefixPoolSizeIpv6': 123,
'prefixPoolUnallocatedCountIpv4': 123,
'prefixPoolUnallocatedCountIpv6': 123,
'rateLimiterStatus': {
'maxAllowed': 123,
'inUse': 123,
'remaining': 123,
'totalBandwidth': 'string'
},
'billingMode': 'PayAsYouGo'|'FlatRateTier1'|'FlatRateTier2'|'FlatRateTier3'|'FlatRateTier4'|'FlatRateTier5'|'PortPairFlatRateTier1'|'PortPairFlatRateTier2'|'PortPairFlatRateTier3'|'PortPairFlatRateTier4'|'PortPairFlatRateTier5'
}
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, 10Gbps, 100Gbps, or 400 Gbps..
numberOfConnections (integer) --
The number of physical dedicated connections initially provisioned and bundled by the LAG. You can have a maximum of four connections when the port speed is 1 Gbps or 10 Gbps, or two when the port speed is 100 Gbps or 400 Gbps.
lagId (string) --
The ID of the LAG.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the LAG.
lagName (string) --
The name of the LAG.
lagState (string) --
The state of the LAG. The following are the possible values:
requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.
pending: The LAG has been approved and is being initialized.
available: The network link is established and the LAG is ready for use.
down: The network link is down.
deleting: The LAG is being deleted.
deleted: The LAG is deleted.
unknown: The state of the LAG is not available.
location (string) --
The location of the LAG.
region (string) --
The Amazon Web Services Region where the connection is located.
minimumLinks (integer) --
The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.
awsDevice (string) --
The Direct Connect endpoint that hosts the LAG.
awsDeviceV2 (string) --
The Direct Connect endpoint that hosts the LAG.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
connections (list) --
The connections bundled by the LAG.
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending: The connection has been approved and is being initialized.
available: The network link is up and the connection is ready for use.
down: The network link is down.
deleting: The connection is being deleted.
deleted: The connection has been deleted.
rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown: The state of the connection is not available.
region (string) --
The Amazon Web Services Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
hasLogicalRedundancy (string) --
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags (list) --
The tags associated with the connection.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
providerName (string) --
The name of the service provider associated with the connection.
macSecCapable (boolean) --
Indicates whether the connection supports MAC Security (MACsec).
portEncryptionStatus (string) --
The MAC Security (MACsec) port link status of the connection.
The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.
encryptionMode (string) --
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
macSecKeys (list) --
The MAC Security (MACsec) security keys associated with the connection.
(dict) --
Information about the MAC Security (MACsec) secret key.
secretARN (string) --
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
ckn (string) --
The Connection Key Name (CKN) for the MAC Security secret key.
state (string) --
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
startOn (string) --
The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
rateLimiterStatus (dict) --
The rate limiter status for the connection, including how many rate limiters are in use and the maximum allowed.
maxAllowed (integer) --
The maximum number of rate limiters allowed on the connection.
inUse (integer) --
The number of rate limiters currently in use on the connection.
remaining (integer) --
The number of rate limiters remaining (available) on the connection.
totalBandwidth (string) --
The total bandwidth allocated across all rate limiters on the connection.
partnerInterconnectMacSecCapable (boolean) --
Indicates whether the interconnect hosting this connection supports MAC Security (MACsec).
prefixPoolSizeIpv4 (integer) --
The total number of inbound IPv4 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolSizeIpv6 (integer) --
The total number of inbound IPv6 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv4 (integer) --
The number of inbound IPv4 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv6 (integer) --
The number of inbound IPv6 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
billingMode (string) --
The billing mode of the connection.
allowsHostedConnections (boolean) --
Indicates whether the LAG can host other connections.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames are supported.
hasLogicalRedundancy (string) --
Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags (list) --
The tags associated with the LAG.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
providerName (string) --
The name of the service provider associated with the LAG.
macSecCapable (boolean) --
Indicates whether the LAG supports MAC Security (MACsec).
encryptionMode (string) --
The LAG MAC Security (MACsec) encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
macSecKeys (list) --
The MAC Security (MACsec) security keys associated with the LAG.
(dict) --
Information about the MAC Security (MACsec) secret key.
secretARN (string) --
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
ckn (string) --
The Connection Key Name (CKN) for the MAC Security secret key.
state (string) --
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
startOn (string) --
The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
prefixPoolSizeIpv4 (integer) --
The total number of inbound IPv4 route prefixes you can allocate across the virtual interfaces on the LAG. Not applicable to LAGs that are interconnects and support hosted connections.
prefixPoolSizeIpv6 (integer) --
The total number of inbound IPv6 route prefixes you can allocate across the virtual interfaces on the LAG. Not applicable to LAGs that are interconnects and support hosted connections.
prefixPoolUnallocatedCountIpv4 (integer) --
The number of inbound IPv4 route prefixes in the LAG prefix pool not yet allocated to a virtual interface. Not applicable to LAGs that are interconnects and support hosted connections.
prefixPoolUnallocatedCountIpv6 (integer) --
The number of inbound IPv6 route prefixes in the LAG prefix pool not yet allocated to a virtual interface. Not applicable to LAGs that are interconnects and support hosted connections.
rateLimiterStatus (dict) --
The rate limiter status for the LAG, including how many rate limiters are in use and the maximum allowed.
maxAllowed (integer) --
The maximum number of rate limiters allowed on the connection.
inUse (integer) --
The number of rate limiters currently in use on the connection.
remaining (integer) --
The number of rate limiters remaining (available) on the connection.
totalBandwidth (string) --
The total bandwidth allocated across all rate limiters on the connection.
billingMode (string) --
The billing mode of the LAG.
{'billingMode': 'PayAsYouGo | FlatRateTier1 | FlatRateTier2 | FlatRateTier3 | '
'FlatRateTier4 | FlatRateTier5 | PortPairFlatRateTier1 | '
'PortPairFlatRateTier2 | PortPairFlatRateTier3 | '
'PortPairFlatRateTier4 | PortPairFlatRateTier5'}
Deletes the specified connection.
Deleting a connection only stops the Direct Connect port hour and data transfer charges. If you are partnering with any third parties to connect with the Direct Connect location, you must cancel your service with them separately.
See also: AWS API Documentation
Request Syntax
client.delete_connection(
connectionId='string'
)
string
[REQUIRED]
The ID of the connection.
dict
Response Syntax
{
'ownerAccount': 'string',
'connectionId': 'string',
'connectionName': 'string',
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'vlan': 123,
'partnerName': 'string',
'loaIssueTime': datetime(2015, 1, 1),
'lagId': 'string',
'awsDevice': 'string',
'jumboFrameCapable': True|False,
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string',
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string',
'macSecCapable': True|False,
'portEncryptionStatus': 'string',
'encryptionMode': 'string',
'macSecKeys': [
{
'secretARN': 'string',
'ckn': 'string',
'state': 'string',
'startOn': 'string'
},
],
'rateLimiterStatus': {
'maxAllowed': 123,
'inUse': 123,
'remaining': 123,
'totalBandwidth': 'string'
},
'partnerInterconnectMacSecCapable': True|False,
'prefixPoolSizeIpv4': 123,
'prefixPoolSizeIpv6': 123,
'prefixPoolUnallocatedCountIpv4': 123,
'prefixPoolUnallocatedCountIpv6': 123,
'billingMode': 'PayAsYouGo'|'FlatRateTier1'|'FlatRateTier2'|'FlatRateTier3'|'FlatRateTier4'|'FlatRateTier5'|'PortPairFlatRateTier1'|'PortPairFlatRateTier2'|'PortPairFlatRateTier3'|'PortPairFlatRateTier4'|'PortPairFlatRateTier5'
}
Response Structure
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending: The connection has been approved and is being initialized.
available: The network link is up and the connection is ready for use.
down: The network link is down.
deleting: The connection is being deleted.
deleted: The connection has been deleted.
rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown: The state of the connection is not available.
region (string) --
The Amazon Web Services Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
hasLogicalRedundancy (string) --
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags (list) --
The tags associated with the connection.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
providerName (string) --
The name of the service provider associated with the connection.
macSecCapable (boolean) --
Indicates whether the connection supports MAC Security (MACsec).
portEncryptionStatus (string) --
The MAC Security (MACsec) port link status of the connection.
The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.
encryptionMode (string) --
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
macSecKeys (list) --
The MAC Security (MACsec) security keys associated with the connection.
(dict) --
Information about the MAC Security (MACsec) secret key.
secretARN (string) --
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
ckn (string) --
The Connection Key Name (CKN) for the MAC Security secret key.
state (string) --
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
startOn (string) --
The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
rateLimiterStatus (dict) --
The rate limiter status for the connection, including how many rate limiters are in use and the maximum allowed.
maxAllowed (integer) --
The maximum number of rate limiters allowed on the connection.
inUse (integer) --
The number of rate limiters currently in use on the connection.
remaining (integer) --
The number of rate limiters remaining (available) on the connection.
totalBandwidth (string) --
The total bandwidth allocated across all rate limiters on the connection.
partnerInterconnectMacSecCapable (boolean) --
Indicates whether the interconnect hosting this connection supports MAC Security (MACsec).
prefixPoolSizeIpv4 (integer) --
The total number of inbound IPv4 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolSizeIpv6 (integer) --
The total number of inbound IPv6 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv4 (integer) --
The number of inbound IPv4 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv6 (integer) --
The number of inbound IPv6 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
billingMode (string) --
The billing mode of the connection.
{'billingMode': 'PayAsYouGo | FlatRateTier1 | FlatRateTier2 | FlatRateTier3 | '
'FlatRateTier4 | FlatRateTier5 | PortPairFlatRateTier1 | '
'PortPairFlatRateTier2 | PortPairFlatRateTier3 | '
'PortPairFlatRateTier4 | PortPairFlatRateTier5',
'connections': {'billingMode': 'PayAsYouGo | FlatRateTier1 | FlatRateTier2 | '
'FlatRateTier3 | FlatRateTier4 | FlatRateTier5 '
'| PortPairFlatRateTier1 | '
'PortPairFlatRateTier2 | PortPairFlatRateTier3 '
'| PortPairFlatRateTier4 | '
'PortPairFlatRateTier5'}}
Deletes the specified link aggregation group (LAG). You cannot delete a LAG if it has active virtual interfaces or hosted connections.
See also: AWS API Documentation
Request Syntax
client.delete_lag(
lagId='string'
)
string
[REQUIRED]
The ID of the LAG.
dict
Response Syntax
{
'connectionsBandwidth': 'string',
'numberOfConnections': 123,
'lagId': 'string',
'ownerAccount': 'string',
'lagName': 'string',
'lagState': 'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'unknown',
'location': 'string',
'region': 'string',
'minimumLinks': 123,
'awsDevice': 'string',
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string',
'connections': [
{
'ownerAccount': 'string',
'connectionId': 'string',
'connectionName': 'string',
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'vlan': 123,
'partnerName': 'string',
'loaIssueTime': datetime(2015, 1, 1),
'lagId': 'string',
'awsDevice': 'string',
'jumboFrameCapable': True|False,
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string',
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string',
'macSecCapable': True|False,
'portEncryptionStatus': 'string',
'encryptionMode': 'string',
'macSecKeys': [
{
'secretARN': 'string',
'ckn': 'string',
'state': 'string',
'startOn': 'string'
},
],
'rateLimiterStatus': {
'maxAllowed': 123,
'inUse': 123,
'remaining': 123,
'totalBandwidth': 'string'
},
'partnerInterconnectMacSecCapable': True|False,
'prefixPoolSizeIpv4': 123,
'prefixPoolSizeIpv6': 123,
'prefixPoolUnallocatedCountIpv4': 123,
'prefixPoolUnallocatedCountIpv6': 123,
'billingMode': 'PayAsYouGo'|'FlatRateTier1'|'FlatRateTier2'|'FlatRateTier3'|'FlatRateTier4'|'FlatRateTier5'|'PortPairFlatRateTier1'|'PortPairFlatRateTier2'|'PortPairFlatRateTier3'|'PortPairFlatRateTier4'|'PortPairFlatRateTier5'
},
],
'allowsHostedConnections': True|False,
'jumboFrameCapable': True|False,
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string',
'macSecCapable': True|False,
'encryptionMode': 'string',
'macSecKeys': [
{
'secretARN': 'string',
'ckn': 'string',
'state': 'string',
'startOn': 'string'
},
],
'prefixPoolSizeIpv4': 123,
'prefixPoolSizeIpv6': 123,
'prefixPoolUnallocatedCountIpv4': 123,
'prefixPoolUnallocatedCountIpv6': 123,
'rateLimiterStatus': {
'maxAllowed': 123,
'inUse': 123,
'remaining': 123,
'totalBandwidth': 'string'
},
'billingMode': 'PayAsYouGo'|'FlatRateTier1'|'FlatRateTier2'|'FlatRateTier3'|'FlatRateTier4'|'FlatRateTier5'|'PortPairFlatRateTier1'|'PortPairFlatRateTier2'|'PortPairFlatRateTier3'|'PortPairFlatRateTier4'|'PortPairFlatRateTier5'
}
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, 10Gbps, 100Gbps, or 400 Gbps..
numberOfConnections (integer) --
The number of physical dedicated connections initially provisioned and bundled by the LAG. You can have a maximum of four connections when the port speed is 1 Gbps or 10 Gbps, or two when the port speed is 100 Gbps or 400 Gbps.
lagId (string) --
The ID of the LAG.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the LAG.
lagName (string) --
The name of the LAG.
lagState (string) --
The state of the LAG. The following are the possible values:
requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.
pending: The LAG has been approved and is being initialized.
available: The network link is established and the LAG is ready for use.
down: The network link is down.
deleting: The LAG is being deleted.
deleted: The LAG is deleted.
unknown: The state of the LAG is not available.
location (string) --
The location of the LAG.
region (string) --
The Amazon Web Services Region where the connection is located.
minimumLinks (integer) --
The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.
awsDevice (string) --
The Direct Connect endpoint that hosts the LAG.
awsDeviceV2 (string) --
The Direct Connect endpoint that hosts the LAG.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
connections (list) --
The connections bundled by the LAG.
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending: The connection has been approved and is being initialized.
available: The network link is up and the connection is ready for use.
down: The network link is down.
deleting: The connection is being deleted.
deleted: The connection has been deleted.
rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown: The state of the connection is not available.
region (string) --
The Amazon Web Services Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
hasLogicalRedundancy (string) --
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags (list) --
The tags associated with the connection.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
providerName (string) --
The name of the service provider associated with the connection.
macSecCapable (boolean) --
Indicates whether the connection supports MAC Security (MACsec).
portEncryptionStatus (string) --
The MAC Security (MACsec) port link status of the connection.
The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.
encryptionMode (string) --
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
macSecKeys (list) --
The MAC Security (MACsec) security keys associated with the connection.
(dict) --
Information about the MAC Security (MACsec) secret key.
secretARN (string) --
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
ckn (string) --
The Connection Key Name (CKN) for the MAC Security secret key.
state (string) --
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
startOn (string) --
The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
rateLimiterStatus (dict) --
The rate limiter status for the connection, including how many rate limiters are in use and the maximum allowed.
maxAllowed (integer) --
The maximum number of rate limiters allowed on the connection.
inUse (integer) --
The number of rate limiters currently in use on the connection.
remaining (integer) --
The number of rate limiters remaining (available) on the connection.
totalBandwidth (string) --
The total bandwidth allocated across all rate limiters on the connection.
partnerInterconnectMacSecCapable (boolean) --
Indicates whether the interconnect hosting this connection supports MAC Security (MACsec).
prefixPoolSizeIpv4 (integer) --
The total number of inbound IPv4 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolSizeIpv6 (integer) --
The total number of inbound IPv6 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv4 (integer) --
The number of inbound IPv4 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv6 (integer) --
The number of inbound IPv6 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
billingMode (string) --
The billing mode of the connection.
allowsHostedConnections (boolean) --
Indicates whether the LAG can host other connections.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames are supported.
hasLogicalRedundancy (string) --
Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags (list) --
The tags associated with the LAG.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
providerName (string) --
The name of the service provider associated with the LAG.
macSecCapable (boolean) --
Indicates whether the LAG supports MAC Security (MACsec).
encryptionMode (string) --
The LAG MAC Security (MACsec) encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
macSecKeys (list) --
The MAC Security (MACsec) security keys associated with the LAG.
(dict) --
Information about the MAC Security (MACsec) secret key.
secretARN (string) --
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
ckn (string) --
The Connection Key Name (CKN) for the MAC Security secret key.
state (string) --
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
startOn (string) --
The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
prefixPoolSizeIpv4 (integer) --
The total number of inbound IPv4 route prefixes you can allocate across the virtual interfaces on the LAG. Not applicable to LAGs that are interconnects and support hosted connections.
prefixPoolSizeIpv6 (integer) --
The total number of inbound IPv6 route prefixes you can allocate across the virtual interfaces on the LAG. Not applicable to LAGs that are interconnects and support hosted connections.
prefixPoolUnallocatedCountIpv4 (integer) --
The number of inbound IPv4 route prefixes in the LAG prefix pool not yet allocated to a virtual interface. Not applicable to LAGs that are interconnects and support hosted connections.
prefixPoolUnallocatedCountIpv6 (integer) --
The number of inbound IPv6 route prefixes in the LAG prefix pool not yet allocated to a virtual interface. Not applicable to LAGs that are interconnects and support hosted connections.
rateLimiterStatus (dict) --
The rate limiter status for the LAG, including how many rate limiters are in use and the maximum allowed.
maxAllowed (integer) --
The maximum number of rate limiters allowed on the connection.
inUse (integer) --
The number of rate limiters currently in use on the connection.
remaining (integer) --
The number of rate limiters remaining (available) on the connection.
totalBandwidth (string) --
The total bandwidth allocated across all rate limiters on the connection.
billingMode (string) --
The billing mode of the LAG.
{'connections': {'billingMode': 'PayAsYouGo | FlatRateTier1 | FlatRateTier2 | '
'FlatRateTier3 | FlatRateTier4 | FlatRateTier5 '
'| PortPairFlatRateTier1 | '
'PortPairFlatRateTier2 | PortPairFlatRateTier3 '
'| PortPairFlatRateTier4 | '
'PortPairFlatRateTier5'}}
Displays the specified connection or all connections in this Region.
See also: AWS API Documentation
Request Syntax
client.describe_connections(
connectionId='string',
maxResults=123,
nextToken='string'
)
string
The ID of the connection.
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
If MaxResults is given a value larger than 100, only 100 results are returned.
string
The token for the next page of results.
dict
Response Syntax
{
'connections': [
{
'ownerAccount': 'string',
'connectionId': 'string',
'connectionName': 'string',
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'vlan': 123,
'partnerName': 'string',
'loaIssueTime': datetime(2015, 1, 1),
'lagId': 'string',
'awsDevice': 'string',
'jumboFrameCapable': True|False,
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string',
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string',
'macSecCapable': True|False,
'portEncryptionStatus': 'string',
'encryptionMode': 'string',
'macSecKeys': [
{
'secretARN': 'string',
'ckn': 'string',
'state': 'string',
'startOn': 'string'
},
],
'rateLimiterStatus': {
'maxAllowed': 123,
'inUse': 123,
'remaining': 123,
'totalBandwidth': 'string'
},
'partnerInterconnectMacSecCapable': True|False,
'prefixPoolSizeIpv4': 123,
'prefixPoolSizeIpv6': 123,
'prefixPoolUnallocatedCountIpv4': 123,
'prefixPoolUnallocatedCountIpv6': 123,
'billingMode': 'PayAsYouGo'|'FlatRateTier1'|'FlatRateTier2'|'FlatRateTier3'|'FlatRateTier4'|'FlatRateTier5'|'PortPairFlatRateTier1'|'PortPairFlatRateTier2'|'PortPairFlatRateTier3'|'PortPairFlatRateTier4'|'PortPairFlatRateTier5'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
connections (list) --
The connections.
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending: The connection has been approved and is being initialized.
available: The network link is up and the connection is ready for use.
down: The network link is down.
deleting: The connection is being deleted.
deleted: The connection has been deleted.
rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown: The state of the connection is not available.
region (string) --
The Amazon Web Services Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
hasLogicalRedundancy (string) --
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags (list) --
The tags associated with the connection.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
providerName (string) --
The name of the service provider associated with the connection.
macSecCapable (boolean) --
Indicates whether the connection supports MAC Security (MACsec).
portEncryptionStatus (string) --
The MAC Security (MACsec) port link status of the connection.
The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.
encryptionMode (string) --
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
macSecKeys (list) --
The MAC Security (MACsec) security keys associated with the connection.
(dict) --
Information about the MAC Security (MACsec) secret key.
secretARN (string) --
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
ckn (string) --
The Connection Key Name (CKN) for the MAC Security secret key.
state (string) --
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
startOn (string) --
The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
rateLimiterStatus (dict) --
The rate limiter status for the connection, including how many rate limiters are in use and the maximum allowed.
maxAllowed (integer) --
The maximum number of rate limiters allowed on the connection.
inUse (integer) --
The number of rate limiters currently in use on the connection.
remaining (integer) --
The number of rate limiters remaining (available) on the connection.
totalBandwidth (string) --
The total bandwidth allocated across all rate limiters on the connection.
partnerInterconnectMacSecCapable (boolean) --
Indicates whether the interconnect hosting this connection supports MAC Security (MACsec).
prefixPoolSizeIpv4 (integer) --
The total number of inbound IPv4 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolSizeIpv6 (integer) --
The total number of inbound IPv6 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv4 (integer) --
The number of inbound IPv4 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv6 (integer) --
The number of inbound IPv6 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
billingMode (string) --
The billing mode of the connection.
nextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
{'connections': {'billingMode': 'PayAsYouGo | FlatRateTier1 | FlatRateTier2 | '
'FlatRateTier3 | FlatRateTier4 | FlatRateTier5 '
'| PortPairFlatRateTier1 | '
'PortPairFlatRateTier2 | PortPairFlatRateTier3 '
'| PortPairFlatRateTier4 | '
'PortPairFlatRateTier5'}}
Lists the connections that have been provisioned on the specified interconnect.
See also: AWS API Documentation
Request Syntax
client.describe_connections_on_interconnect(
interconnectId='string'
)
string
[REQUIRED]
The ID of the interconnect.
dict
Response Syntax
{
'connections': [
{
'ownerAccount': 'string',
'connectionId': 'string',
'connectionName': 'string',
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'vlan': 123,
'partnerName': 'string',
'loaIssueTime': datetime(2015, 1, 1),
'lagId': 'string',
'awsDevice': 'string',
'jumboFrameCapable': True|False,
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string',
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string',
'macSecCapable': True|False,
'portEncryptionStatus': 'string',
'encryptionMode': 'string',
'macSecKeys': [
{
'secretARN': 'string',
'ckn': 'string',
'state': 'string',
'startOn': 'string'
},
],
'rateLimiterStatus': {
'maxAllowed': 123,
'inUse': 123,
'remaining': 123,
'totalBandwidth': 'string'
},
'partnerInterconnectMacSecCapable': True|False,
'prefixPoolSizeIpv4': 123,
'prefixPoolSizeIpv6': 123,
'prefixPoolUnallocatedCountIpv4': 123,
'prefixPoolUnallocatedCountIpv6': 123,
'billingMode': 'PayAsYouGo'|'FlatRateTier1'|'FlatRateTier2'|'FlatRateTier3'|'FlatRateTier4'|'FlatRateTier5'|'PortPairFlatRateTier1'|'PortPairFlatRateTier2'|'PortPairFlatRateTier3'|'PortPairFlatRateTier4'|'PortPairFlatRateTier5'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
connections (list) --
The connections.
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending: The connection has been approved and is being initialized.
available: The network link is up and the connection is ready for use.
down: The network link is down.
deleting: The connection is being deleted.
deleted: The connection has been deleted.
rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown: The state of the connection is not available.
region (string) --
The Amazon Web Services Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
hasLogicalRedundancy (string) --
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags (list) --
The tags associated with the connection.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
providerName (string) --
The name of the service provider associated with the connection.
macSecCapable (boolean) --
Indicates whether the connection supports MAC Security (MACsec).
portEncryptionStatus (string) --
The MAC Security (MACsec) port link status of the connection.
The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.
encryptionMode (string) --
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
macSecKeys (list) --
The MAC Security (MACsec) security keys associated with the connection.
(dict) --
Information about the MAC Security (MACsec) secret key.
secretARN (string) --
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
ckn (string) --
The Connection Key Name (CKN) for the MAC Security secret key.
state (string) --
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
startOn (string) --
The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
rateLimiterStatus (dict) --
The rate limiter status for the connection, including how many rate limiters are in use and the maximum allowed.
maxAllowed (integer) --
The maximum number of rate limiters allowed on the connection.
inUse (integer) --
The number of rate limiters currently in use on the connection.
remaining (integer) --
The number of rate limiters remaining (available) on the connection.
totalBandwidth (string) --
The total bandwidth allocated across all rate limiters on the connection.
partnerInterconnectMacSecCapable (boolean) --
Indicates whether the interconnect hosting this connection supports MAC Security (MACsec).
prefixPoolSizeIpv4 (integer) --
The total number of inbound IPv4 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolSizeIpv6 (integer) --
The total number of inbound IPv6 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv4 (integer) --
The number of inbound IPv4 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv6 (integer) --
The number of inbound IPv6 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
billingMode (string) --
The billing mode of the connection.
nextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
{'connections': {'billingMode': 'PayAsYouGo | FlatRateTier1 | FlatRateTier2 | '
'FlatRateTier3 | FlatRateTier4 | FlatRateTier5 '
'| PortPairFlatRateTier1 | '
'PortPairFlatRateTier2 | PortPairFlatRateTier3 '
'| PortPairFlatRateTier4 | '
'PortPairFlatRateTier5'}}
Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG).
See also: AWS API Documentation
Request Syntax
client.describe_hosted_connections(
connectionId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The ID of the interconnect or LAG.
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
If MaxResults is given a value larger than 100, only 100 results are returned.
string
The token for the next page of results.
dict
Response Syntax
{
'connections': [
{
'ownerAccount': 'string',
'connectionId': 'string',
'connectionName': 'string',
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'vlan': 123,
'partnerName': 'string',
'loaIssueTime': datetime(2015, 1, 1),
'lagId': 'string',
'awsDevice': 'string',
'jumboFrameCapable': True|False,
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string',
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string',
'macSecCapable': True|False,
'portEncryptionStatus': 'string',
'encryptionMode': 'string',
'macSecKeys': [
{
'secretARN': 'string',
'ckn': 'string',
'state': 'string',
'startOn': 'string'
},
],
'rateLimiterStatus': {
'maxAllowed': 123,
'inUse': 123,
'remaining': 123,
'totalBandwidth': 'string'
},
'partnerInterconnectMacSecCapable': True|False,
'prefixPoolSizeIpv4': 123,
'prefixPoolSizeIpv6': 123,
'prefixPoolUnallocatedCountIpv4': 123,
'prefixPoolUnallocatedCountIpv6': 123,
'billingMode': 'PayAsYouGo'|'FlatRateTier1'|'FlatRateTier2'|'FlatRateTier3'|'FlatRateTier4'|'FlatRateTier5'|'PortPairFlatRateTier1'|'PortPairFlatRateTier2'|'PortPairFlatRateTier3'|'PortPairFlatRateTier4'|'PortPairFlatRateTier5'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
connections (list) --
The connections.
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending: The connection has been approved and is being initialized.
available: The network link is up and the connection is ready for use.
down: The network link is down.
deleting: The connection is being deleted.
deleted: The connection has been deleted.
rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown: The state of the connection is not available.
region (string) --
The Amazon Web Services Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
hasLogicalRedundancy (string) --
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags (list) --
The tags associated with the connection.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
providerName (string) --
The name of the service provider associated with the connection.
macSecCapable (boolean) --
Indicates whether the connection supports MAC Security (MACsec).
portEncryptionStatus (string) --
The MAC Security (MACsec) port link status of the connection.
The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.
encryptionMode (string) --
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
macSecKeys (list) --
The MAC Security (MACsec) security keys associated with the connection.
(dict) --
Information about the MAC Security (MACsec) secret key.
secretARN (string) --
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
ckn (string) --
The Connection Key Name (CKN) for the MAC Security secret key.
state (string) --
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
startOn (string) --
The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
rateLimiterStatus (dict) --
The rate limiter status for the connection, including how many rate limiters are in use and the maximum allowed.
maxAllowed (integer) --
The maximum number of rate limiters allowed on the connection.
inUse (integer) --
The number of rate limiters currently in use on the connection.
remaining (integer) --
The number of rate limiters remaining (available) on the connection.
totalBandwidth (string) --
The total bandwidth allocated across all rate limiters on the connection.
partnerInterconnectMacSecCapable (boolean) --
Indicates whether the interconnect hosting this connection supports MAC Security (MACsec).
prefixPoolSizeIpv4 (integer) --
The total number of inbound IPv4 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolSizeIpv6 (integer) --
The total number of inbound IPv6 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv4 (integer) --
The number of inbound IPv4 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv6 (integer) --
The number of inbound IPv6 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
billingMode (string) --
The billing mode of the connection.
nextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
{'lags': {'billingMode': 'PayAsYouGo | FlatRateTier1 | FlatRateTier2 | '
'FlatRateTier3 | FlatRateTier4 | FlatRateTier5 | '
'PortPairFlatRateTier1 | PortPairFlatRateTier2 | '
'PortPairFlatRateTier3 | PortPairFlatRateTier4 | '
'PortPairFlatRateTier5',
'connections': {'billingMode': 'PayAsYouGo | FlatRateTier1 | '
'FlatRateTier2 | FlatRateTier3 | '
'FlatRateTier4 | FlatRateTier5 | '
'PortPairFlatRateTier1 | '
'PortPairFlatRateTier2 | '
'PortPairFlatRateTier3 | '
'PortPairFlatRateTier4 | '
'PortPairFlatRateTier5'}}}
Describes all your link aggregation groups (LAG) or the specified LAG.
See also: AWS API Documentation
Request Syntax
client.describe_lags(
lagId='string',
maxResults=123,
nextToken='string'
)
string
The ID of the LAG.
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
If MaxResults is given a value larger than 100, only 100 results are returned.
string
The token for the next page of results.
dict
Response Syntax
{
'lags': [
{
'connectionsBandwidth': 'string',
'numberOfConnections': 123,
'lagId': 'string',
'ownerAccount': 'string',
'lagName': 'string',
'lagState': 'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'unknown',
'location': 'string',
'region': 'string',
'minimumLinks': 123,
'awsDevice': 'string',
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string',
'connections': [
{
'ownerAccount': 'string',
'connectionId': 'string',
'connectionName': 'string',
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'vlan': 123,
'partnerName': 'string',
'loaIssueTime': datetime(2015, 1, 1),
'lagId': 'string',
'awsDevice': 'string',
'jumboFrameCapable': True|False,
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string',
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string',
'macSecCapable': True|False,
'portEncryptionStatus': 'string',
'encryptionMode': 'string',
'macSecKeys': [
{
'secretARN': 'string',
'ckn': 'string',
'state': 'string',
'startOn': 'string'
},
],
'rateLimiterStatus': {
'maxAllowed': 123,
'inUse': 123,
'remaining': 123,
'totalBandwidth': 'string'
},
'partnerInterconnectMacSecCapable': True|False,
'prefixPoolSizeIpv4': 123,
'prefixPoolSizeIpv6': 123,
'prefixPoolUnallocatedCountIpv4': 123,
'prefixPoolUnallocatedCountIpv6': 123,
'billingMode': 'PayAsYouGo'|'FlatRateTier1'|'FlatRateTier2'|'FlatRateTier3'|'FlatRateTier4'|'FlatRateTier5'|'PortPairFlatRateTier1'|'PortPairFlatRateTier2'|'PortPairFlatRateTier3'|'PortPairFlatRateTier4'|'PortPairFlatRateTier5'
},
],
'allowsHostedConnections': True|False,
'jumboFrameCapable': True|False,
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string',
'macSecCapable': True|False,
'encryptionMode': 'string',
'macSecKeys': [
{
'secretARN': 'string',
'ckn': 'string',
'state': 'string',
'startOn': 'string'
},
],
'prefixPoolSizeIpv4': 123,
'prefixPoolSizeIpv6': 123,
'prefixPoolUnallocatedCountIpv4': 123,
'prefixPoolUnallocatedCountIpv6': 123,
'rateLimiterStatus': {
'maxAllowed': 123,
'inUse': 123,
'remaining': 123,
'totalBandwidth': 'string'
},
'billingMode': 'PayAsYouGo'|'FlatRateTier1'|'FlatRateTier2'|'FlatRateTier3'|'FlatRateTier4'|'FlatRateTier5'|'PortPairFlatRateTier1'|'PortPairFlatRateTier2'|'PortPairFlatRateTier3'|'PortPairFlatRateTier4'|'PortPairFlatRateTier5'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
lags (list) --
The LAGs.
(dict) --
Information about a link aggregation group (LAG).
connectionsBandwidth (string) --
The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps, 10Gbps, 100Gbps, or 400 Gbps..
numberOfConnections (integer) --
The number of physical dedicated connections initially provisioned and bundled by the LAG. You can have a maximum of four connections when the port speed is 1 Gbps or 10 Gbps, or two when the port speed is 100 Gbps or 400 Gbps.
lagId (string) --
The ID of the LAG.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the LAG.
lagName (string) --
The name of the LAG.
lagState (string) --
The state of the LAG. The following are the possible values:
requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.
pending: The LAG has been approved and is being initialized.
available: The network link is established and the LAG is ready for use.
down: The network link is down.
deleting: The LAG is being deleted.
deleted: The LAG is deleted.
unknown: The state of the LAG is not available.
location (string) --
The location of the LAG.
region (string) --
The Amazon Web Services Region where the connection is located.
minimumLinks (integer) --
The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.
awsDevice (string) --
The Direct Connect endpoint that hosts the LAG.
awsDeviceV2 (string) --
The Direct Connect endpoint that hosts the LAG.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
connections (list) --
The connections bundled by the LAG.
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending: The connection has been approved and is being initialized.
available: The network link is up and the connection is ready for use.
down: The network link is down.
deleting: The connection is being deleted.
deleted: The connection has been deleted.
rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown: The state of the connection is not available.
region (string) --
The Amazon Web Services Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
hasLogicalRedundancy (string) --
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags (list) --
The tags associated with the connection.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
providerName (string) --
The name of the service provider associated with the connection.
macSecCapable (boolean) --
Indicates whether the connection supports MAC Security (MACsec).
portEncryptionStatus (string) --
The MAC Security (MACsec) port link status of the connection.
The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.
encryptionMode (string) --
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
macSecKeys (list) --
The MAC Security (MACsec) security keys associated with the connection.
(dict) --
Information about the MAC Security (MACsec) secret key.
secretARN (string) --
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
ckn (string) --
The Connection Key Name (CKN) for the MAC Security secret key.
state (string) --
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
startOn (string) --
The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
rateLimiterStatus (dict) --
The rate limiter status for the connection, including how many rate limiters are in use and the maximum allowed.
maxAllowed (integer) --
The maximum number of rate limiters allowed on the connection.
inUse (integer) --
The number of rate limiters currently in use on the connection.
remaining (integer) --
The number of rate limiters remaining (available) on the connection.
totalBandwidth (string) --
The total bandwidth allocated across all rate limiters on the connection.
partnerInterconnectMacSecCapable (boolean) --
Indicates whether the interconnect hosting this connection supports MAC Security (MACsec).
prefixPoolSizeIpv4 (integer) --
The total number of inbound IPv4 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolSizeIpv6 (integer) --
The total number of inbound IPv6 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv4 (integer) --
The number of inbound IPv4 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv6 (integer) --
The number of inbound IPv6 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
billingMode (string) --
The billing mode of the connection.
allowsHostedConnections (boolean) --
Indicates whether the LAG can host other connections.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames are supported.
hasLogicalRedundancy (string) --
Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags (list) --
The tags associated with the LAG.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
providerName (string) --
The name of the service provider associated with the LAG.
macSecCapable (boolean) --
Indicates whether the LAG supports MAC Security (MACsec).
encryptionMode (string) --
The LAG MAC Security (MACsec) encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
macSecKeys (list) --
The MAC Security (MACsec) security keys associated with the LAG.
(dict) --
Information about the MAC Security (MACsec) secret key.
secretARN (string) --
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
ckn (string) --
The Connection Key Name (CKN) for the MAC Security secret key.
state (string) --
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
startOn (string) --
The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
prefixPoolSizeIpv4 (integer) --
The total number of inbound IPv4 route prefixes you can allocate across the virtual interfaces on the LAG. Not applicable to LAGs that are interconnects and support hosted connections.
prefixPoolSizeIpv6 (integer) --
The total number of inbound IPv6 route prefixes you can allocate across the virtual interfaces on the LAG. Not applicable to LAGs that are interconnects and support hosted connections.
prefixPoolUnallocatedCountIpv4 (integer) --
The number of inbound IPv4 route prefixes in the LAG prefix pool not yet allocated to a virtual interface. Not applicable to LAGs that are interconnects and support hosted connections.
prefixPoolUnallocatedCountIpv6 (integer) --
The number of inbound IPv6 route prefixes in the LAG prefix pool not yet allocated to a virtual interface. Not applicable to LAGs that are interconnects and support hosted connections.
rateLimiterStatus (dict) --
The rate limiter status for the LAG, including how many rate limiters are in use and the maximum allowed.
maxAllowed (integer) --
The maximum number of rate limiters allowed on the connection.
inUse (integer) --
The number of rate limiters currently in use on the connection.
remaining (integer) --
The number of rate limiters remaining (available) on the connection.
totalBandwidth (string) --
The total bandwidth allocated across all rate limiters on the connection.
billingMode (string) --
The billing mode of the LAG.
nextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
{'locations': {'availableBillingModes': [{'availablePortSpeeds': ['string'],
'billingMode': 'PayAsYouGo | '
'FlatRateTier1 | '
'FlatRateTier2 | '
'FlatRateTier3 | '
'FlatRateTier4 | '
'FlatRateTier5 | '
'PortPairFlatRateTier1 '
'| '
'PortPairFlatRateTier2 '
'| '
'PortPairFlatRateTier3 '
'| '
'PortPairFlatRateTier4 '
'| '
'PortPairFlatRateTier5',
'includedRegions': ['string']}]}}
Lists the Direct Connect locations in the current Amazon Web Services Region. These are the locations that can be selected when calling CreateConnection or CreateInterconnect.
See also: AWS API Documentation
Request Syntax
client.describe_locations()
dict
Response Syntax
{
'locations': [
{
'locationCode': 'string',
'locationName': 'string',
'region': 'string',
'availablePortSpeeds': [
'string',
],
'availableProviders': [
'string',
],
'availableMacSecPortSpeeds': [
'string',
],
'availableBillingModes': [
{
'billingMode': 'PayAsYouGo'|'FlatRateTier1'|'FlatRateTier2'|'FlatRateTier3'|'FlatRateTier4'|'FlatRateTier5'|'PortPairFlatRateTier1'|'PortPairFlatRateTier2'|'PortPairFlatRateTier3'|'PortPairFlatRateTier4'|'PortPairFlatRateTier5',
'availablePortSpeeds': [
'string',
],
'includedRegions': [
'string',
]
},
]
},
]
}
Response Structure
(dict) --
locations (list) --
The locations.
(dict) --
Information about an 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 Amazon Web Services 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) --
availableMacSecPortSpeeds (list) --
The available MAC Security (MACsec) port speeds for the location.
(string) --
availableBillingModes (list) --
The billing modes available at the location, including the port speeds and Amazon Web Services Regions supported by each mode.
(dict) --
Information about a billing mode available at an Direct Connect location.
billingMode (string) --
The billing mode.
availablePortSpeeds (list) --
The port speeds available for the billing mode.
(string) --
includedRegions (list) --
The Amazon Web Services Regions included with the billing mode.
(string) --
{'billingMode': 'PayAsYouGo | FlatRateTier1 | FlatRateTier2 | FlatRateTier3 | '
'FlatRateTier4 | FlatRateTier5 | PortPairFlatRateTier1 | '
'PortPairFlatRateTier2 | PortPairFlatRateTier3 | '
'PortPairFlatRateTier4 | PortPairFlatRateTier5'}
Disassociates a connection from a link aggregation group (LAG). The connection is interrupted and re-established as a standalone connection (the connection is not deleted; to delete the connection, use the DeleteConnection request). If the LAG has associated virtual interfaces or hosted connections, they remain associated with the LAG. A disassociated connection owned by an Direct Connect Partner is automatically converted to an interconnect.
If disassociating the connection would cause the LAG to fall below its setting for minimum number of operational connections, the request fails, except when it's the last member of the LAG. If all connections are disassociated, the LAG continues to exist as an empty LAG with no physical connections.
See also: AWS API Documentation
Request Syntax
client.disassociate_connection_from_lag(
connectionId='string',
lagId='string'
)
string
[REQUIRED]
The ID of the connection.
string
[REQUIRED]
The ID of the LAG.
dict
Response Syntax
{
'ownerAccount': 'string',
'connectionId': 'string',
'connectionName': 'string',
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'vlan': 123,
'partnerName': 'string',
'loaIssueTime': datetime(2015, 1, 1),
'lagId': 'string',
'awsDevice': 'string',
'jumboFrameCapable': True|False,
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string',
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string',
'macSecCapable': True|False,
'portEncryptionStatus': 'string',
'encryptionMode': 'string',
'macSecKeys': [
{
'secretARN': 'string',
'ckn': 'string',
'state': 'string',
'startOn': 'string'
},
],
'rateLimiterStatus': {
'maxAllowed': 123,
'inUse': 123,
'remaining': 123,
'totalBandwidth': 'string'
},
'partnerInterconnectMacSecCapable': True|False,
'prefixPoolSizeIpv4': 123,
'prefixPoolSizeIpv6': 123,
'prefixPoolUnallocatedCountIpv4': 123,
'prefixPoolUnallocatedCountIpv6': 123,
'billingMode': 'PayAsYouGo'|'FlatRateTier1'|'FlatRateTier2'|'FlatRateTier3'|'FlatRateTier4'|'FlatRateTier5'|'PortPairFlatRateTier1'|'PortPairFlatRateTier2'|'PortPairFlatRateTier3'|'PortPairFlatRateTier4'|'PortPairFlatRateTier5'
}
Response Structure
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending: The connection has been approved and is being initialized.
available: The network link is up and the connection is ready for use.
down: The network link is down.
deleting: The connection is being deleted.
deleted: The connection has been deleted.
rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown: The state of the connection is not available.
region (string) --
The Amazon Web Services Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
hasLogicalRedundancy (string) --
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags (list) --
The tags associated with the connection.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
providerName (string) --
The name of the service provider associated with the connection.
macSecCapable (boolean) --
Indicates whether the connection supports MAC Security (MACsec).
portEncryptionStatus (string) --
The MAC Security (MACsec) port link status of the connection.
The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.
encryptionMode (string) --
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
macSecKeys (list) --
The MAC Security (MACsec) security keys associated with the connection.
(dict) --
Information about the MAC Security (MACsec) secret key.
secretARN (string) --
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
ckn (string) --
The Connection Key Name (CKN) for the MAC Security secret key.
state (string) --
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
startOn (string) --
The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
rateLimiterStatus (dict) --
The rate limiter status for the connection, including how many rate limiters are in use and the maximum allowed.
maxAllowed (integer) --
The maximum number of rate limiters allowed on the connection.
inUse (integer) --
The number of rate limiters currently in use on the connection.
remaining (integer) --
The number of rate limiters remaining (available) on the connection.
totalBandwidth (string) --
The total bandwidth allocated across all rate limiters on the connection.
partnerInterconnectMacSecCapable (boolean) --
Indicates whether the interconnect hosting this connection supports MAC Security (MACsec).
prefixPoolSizeIpv4 (integer) --
The total number of inbound IPv4 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolSizeIpv6 (integer) --
The total number of inbound IPv6 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv4 (integer) --
The number of inbound IPv4 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv6 (integer) --
The number of inbound IPv6 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
billingMode (string) --
The billing mode of the connection.
{'billingMode': 'PayAsYouGo | FlatRateTier1 | FlatRateTier2 | FlatRateTier3 | '
'FlatRateTier4 | FlatRateTier5 | PortPairFlatRateTier1 | '
'PortPairFlatRateTier2 | PortPairFlatRateTier3 | '
'PortPairFlatRateTier4 | PortPairFlatRateTier5'}
Updates the Direct Connect connection configuration.
You can update the following parameters for a connection:
The connection name
The connection's MAC Security (MACsec) encryption mode.
See also: AWS API Documentation
Request Syntax
client.update_connection(
connectionId='string',
connectionName='string',
encryptionMode='string'
)
string
[REQUIRED]
The ID of the connection.
You can use DescribeConnections to retrieve the connection ID.
string
The name of the connection.
string
The connection MAC Security (MACsec) encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
dict
Response Syntax
{
'ownerAccount': 'string',
'connectionId': 'string',
'connectionName': 'string',
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'vlan': 123,
'partnerName': 'string',
'loaIssueTime': datetime(2015, 1, 1),
'lagId': 'string',
'awsDevice': 'string',
'jumboFrameCapable': True|False,
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string',
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string',
'macSecCapable': True|False,
'portEncryptionStatus': 'string',
'encryptionMode': 'string',
'macSecKeys': [
{
'secretARN': 'string',
'ckn': 'string',
'state': 'string',
'startOn': 'string'
},
],
'rateLimiterStatus': {
'maxAllowed': 123,
'inUse': 123,
'remaining': 123,
'totalBandwidth': 'string'
},
'partnerInterconnectMacSecCapable': True|False,
'prefixPoolSizeIpv4': 123,
'prefixPoolSizeIpv6': 123,
'prefixPoolUnallocatedCountIpv4': 123,
'prefixPoolUnallocatedCountIpv6': 123,
'billingMode': 'PayAsYouGo'|'FlatRateTier1'|'FlatRateTier2'|'FlatRateTier3'|'FlatRateTier4'|'FlatRateTier5'|'PortPairFlatRateTier1'|'PortPairFlatRateTier2'|'PortPairFlatRateTier3'|'PortPairFlatRateTier4'|'PortPairFlatRateTier5'
}
Response Structure
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending: The connection has been approved and is being initialized.
available: The network link is up and the connection is ready for use.
down: The network link is down.
deleting: The connection is being deleted.
deleted: The connection has been deleted.
rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown: The state of the connection is not available.
region (string) --
The Amazon Web Services Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
hasLogicalRedundancy (string) --
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags (list) --
The tags associated with the connection.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
providerName (string) --
The name of the service provider associated with the connection.
macSecCapable (boolean) --
Indicates whether the connection supports MAC Security (MACsec).
portEncryptionStatus (string) --
The MAC Security (MACsec) port link status of the connection.
The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.
encryptionMode (string) --
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
macSecKeys (list) --
The MAC Security (MACsec) security keys associated with the connection.
(dict) --
Information about the MAC Security (MACsec) secret key.
secretARN (string) --
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
ckn (string) --
The Connection Key Name (CKN) for the MAC Security secret key.
state (string) --
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
startOn (string) --
The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
rateLimiterStatus (dict) --
The rate limiter status for the connection, including how many rate limiters are in use and the maximum allowed.
maxAllowed (integer) --
The maximum number of rate limiters allowed on the connection.
inUse (integer) --
The number of rate limiters currently in use on the connection.
remaining (integer) --
The number of rate limiters remaining (available) on the connection.
totalBandwidth (string) --
The total bandwidth allocated across all rate limiters on the connection.
partnerInterconnectMacSecCapable (boolean) --
Indicates whether the interconnect hosting this connection supports MAC Security (MACsec).
prefixPoolSizeIpv4 (integer) --
The total number of inbound IPv4 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolSizeIpv6 (integer) --
The total number of inbound IPv6 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv4 (integer) --
The number of inbound IPv4 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv6 (integer) --
The number of inbound IPv6 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
billingMode (string) --
The billing mode of the connection.
{'billingMode': 'PayAsYouGo | FlatRateTier1 | FlatRateTier2 | FlatRateTier3 | '
'FlatRateTier4 | FlatRateTier5 | PortPairFlatRateTier1 | '
'PortPairFlatRateTier2 | PortPairFlatRateTier3 | '
'PortPairFlatRateTier4 | PortPairFlatRateTier5',
'connections': {'billingMode': 'PayAsYouGo | FlatRateTier1 | FlatRateTier2 | '
'FlatRateTier3 | FlatRateTier4 | FlatRateTier5 '
'| PortPairFlatRateTier1 | '
'PortPairFlatRateTier2 | PortPairFlatRateTier3 '
'| PortPairFlatRateTier4 | '
'PortPairFlatRateTier5'}}
Updates the attributes of the specified link aggregation group (LAG).
You can update the following LAG attributes:
The name of the LAG.
The value for the minimum number of connections that must be operational for the LAG itself to be operational.
The LAG's MACsec encryption mode. Amazon Web Services assigns this value to each connection which is part of the LAG.
The tags
See also: AWS API Documentation
Request Syntax
client.update_lag(
lagId='string',
lagName='string',
minimumLinks=123,
encryptionMode='string'
)
string
[REQUIRED]
The ID of the LAG.
string
The name of the LAG.
integer
The minimum number of physical connections that must be operational for the LAG itself to be operational.
string
The LAG MAC Security (MACsec) encryption mode.
Amazon Web Services applies the value to all connections which are part of the LAG.
dict
Response Syntax
{
'connectionsBandwidth': 'string',
'numberOfConnections': 123,
'lagId': 'string',
'ownerAccount': 'string',
'lagName': 'string',
'lagState': 'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'unknown',
'location': 'string',
'region': 'string',
'minimumLinks': 123,
'awsDevice': 'string',
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string',
'connections': [
{
'ownerAccount': 'string',
'connectionId': 'string',
'connectionName': 'string',
'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
'region': 'string',
'location': 'string',
'bandwidth': 'string',
'vlan': 123,
'partnerName': 'string',
'loaIssueTime': datetime(2015, 1, 1),
'lagId': 'string',
'awsDevice': 'string',
'jumboFrameCapable': True|False,
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string',
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string',
'macSecCapable': True|False,
'portEncryptionStatus': 'string',
'encryptionMode': 'string',
'macSecKeys': [
{
'secretARN': 'string',
'ckn': 'string',
'state': 'string',
'startOn': 'string'
},
],
'rateLimiterStatus': {
'maxAllowed': 123,
'inUse': 123,
'remaining': 123,
'totalBandwidth': 'string'
},
'partnerInterconnectMacSecCapable': True|False,
'prefixPoolSizeIpv4': 123,
'prefixPoolSizeIpv6': 123,
'prefixPoolUnallocatedCountIpv4': 123,
'prefixPoolUnallocatedCountIpv6': 123,
'billingMode': 'PayAsYouGo'|'FlatRateTier1'|'FlatRateTier2'|'FlatRateTier3'|'FlatRateTier4'|'FlatRateTier5'|'PortPairFlatRateTier1'|'PortPairFlatRateTier2'|'PortPairFlatRateTier3'|'PortPairFlatRateTier4'|'PortPairFlatRateTier5'
},
],
'allowsHostedConnections': True|False,
'jumboFrameCapable': True|False,
'hasLogicalRedundancy': 'unknown'|'yes'|'no',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'providerName': 'string',
'macSecCapable': True|False,
'encryptionMode': 'string',
'macSecKeys': [
{
'secretARN': 'string',
'ckn': 'string',
'state': 'string',
'startOn': 'string'
},
],
'prefixPoolSizeIpv4': 123,
'prefixPoolSizeIpv6': 123,
'prefixPoolUnallocatedCountIpv4': 123,
'prefixPoolUnallocatedCountIpv6': 123,
'rateLimiterStatus': {
'maxAllowed': 123,
'inUse': 123,
'remaining': 123,
'totalBandwidth': 'string'
},
'billingMode': 'PayAsYouGo'|'FlatRateTier1'|'FlatRateTier2'|'FlatRateTier3'|'FlatRateTier4'|'FlatRateTier5'|'PortPairFlatRateTier1'|'PortPairFlatRateTier2'|'PortPairFlatRateTier3'|'PortPairFlatRateTier4'|'PortPairFlatRateTier5'
}
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, 10Gbps, 100Gbps, or 400 Gbps..
numberOfConnections (integer) --
The number of physical dedicated connections initially provisioned and bundled by the LAG. You can have a maximum of four connections when the port speed is 1 Gbps or 10 Gbps, or two when the port speed is 100 Gbps or 400 Gbps.
lagId (string) --
The ID of the LAG.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the LAG.
lagName (string) --
The name of the LAG.
lagState (string) --
The state of the LAG. The following are the possible values:
requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.
pending: The LAG has been approved and is being initialized.
available: The network link is established and the LAG is ready for use.
down: The network link is down.
deleting: The LAG is being deleted.
deleted: The LAG is deleted.
unknown: The state of the LAG is not available.
location (string) --
The location of the LAG.
region (string) --
The Amazon Web Services Region where the connection is located.
minimumLinks (integer) --
The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.
awsDevice (string) --
The Direct Connect endpoint that hosts the LAG.
awsDeviceV2 (string) --
The Direct Connect endpoint that hosts the LAG.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
connections (list) --
The connections bundled by the LAG.
(dict) --
Information about an Direct Connect connection.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the connection.
connectionId (string) --
The ID of the connection.
connectionName (string) --
The name of the connection.
connectionState (string) --
The state of the connection. The following are the possible values:
ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending: The connection has been approved and is being initialized.
available: The network link is up and the connection is ready for use.
down: The network link is down.
deleting: The connection is being deleted.
deleted: The connection has been deleted.
rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown: The state of the connection is not available.
region (string) --
The Amazon Web Services Region where the connection is located.
location (string) --
The location of the connection.
bandwidth (string) --
The bandwidth of the connection.
vlan (integer) --
The ID of the VLAN.
partnerName (string) --
The name of the Direct Connect service provider associated with the connection.
loaIssueTime (datetime) --
The time of the most recent call to DescribeLoa for this connection.
lagId (string) --
The ID of the LAG.
awsDevice (string) --
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames are supported.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
hasLogicalRedundancy (string) --
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags (list) --
The tags associated with the connection.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
providerName (string) --
The name of the service provider associated with the connection.
macSecCapable (boolean) --
Indicates whether the connection supports MAC Security (MACsec).
portEncryptionStatus (string) --
The MAC Security (MACsec) port link status of the connection.
The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.
encryptionMode (string) --
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
macSecKeys (list) --
The MAC Security (MACsec) security keys associated with the connection.
(dict) --
Information about the MAC Security (MACsec) secret key.
secretARN (string) --
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
ckn (string) --
The Connection Key Name (CKN) for the MAC Security secret key.
state (string) --
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
startOn (string) --
The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
rateLimiterStatus (dict) --
The rate limiter status for the connection, including how many rate limiters are in use and the maximum allowed.
maxAllowed (integer) --
The maximum number of rate limiters allowed on the connection.
inUse (integer) --
The number of rate limiters currently in use on the connection.
remaining (integer) --
The number of rate limiters remaining (available) on the connection.
totalBandwidth (string) --
The total bandwidth allocated across all rate limiters on the connection.
partnerInterconnectMacSecCapable (boolean) --
Indicates whether the interconnect hosting this connection supports MAC Security (MACsec).
prefixPoolSizeIpv4 (integer) --
The total number of inbound IPv4 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolSizeIpv6 (integer) --
The total number of inbound IPv6 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv4 (integer) --
The number of inbound IPv4 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
prefixPoolUnallocatedCountIpv6 (integer) --
The number of inbound IPv6 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.
billingMode (string) --
The billing mode of the connection.
allowsHostedConnections (boolean) --
Indicates whether the LAG can host other connections.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames are supported.
hasLogicalRedundancy (string) --
Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags (list) --
The tags associated with the LAG.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
providerName (string) --
The name of the service provider associated with the LAG.
macSecCapable (boolean) --
Indicates whether the LAG supports MAC Security (MACsec).
encryptionMode (string) --
The LAG MAC Security (MACsec) encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
macSecKeys (list) --
The MAC Security (MACsec) security keys associated with the LAG.
(dict) --
Information about the MAC Security (MACsec) secret key.
secretARN (string) --
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
ckn (string) --
The Connection Key Name (CKN) for the MAC Security secret key.
state (string) --
The state of the MAC Security (MACsec) secret key.
The possible values are:
associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
startOn (string) --
The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
prefixPoolSizeIpv4 (integer) --
The total number of inbound IPv4 route prefixes you can allocate across the virtual interfaces on the LAG. Not applicable to LAGs that are interconnects and support hosted connections.
prefixPoolSizeIpv6 (integer) --
The total number of inbound IPv6 route prefixes you can allocate across the virtual interfaces on the LAG. Not applicable to LAGs that are interconnects and support hosted connections.
prefixPoolUnallocatedCountIpv4 (integer) --
The number of inbound IPv4 route prefixes in the LAG prefix pool not yet allocated to a virtual interface. Not applicable to LAGs that are interconnects and support hosted connections.
prefixPoolUnallocatedCountIpv6 (integer) --
The number of inbound IPv6 route prefixes in the LAG prefix pool not yet allocated to a virtual interface. Not applicable to LAGs that are interconnects and support hosted connections.
rateLimiterStatus (dict) --
The rate limiter status for the LAG, including how many rate limiters are in use and the maximum allowed.
maxAllowed (integer) --
The maximum number of rate limiters allowed on the connection.
inUse (integer) --
The number of rate limiters currently in use on the connection.
remaining (integer) --
The number of rate limiters remaining (available) on the connection.
totalBandwidth (string) --
The total bandwidth allocated across all rate limiters on the connection.
billingMode (string) --
The billing mode of the LAG.