AWS API Changes

2021/03/31 - AWS Direct Connect - 3 new 16 updated api methods

Changes This release adds MACsec support to AWS Direct Connect

DisassociateMacSecKey (new)

Removes the association between a MAC Security (MACsec) security key and an AWS Direct Connect dedicated connection.

Request Syntax

client.disassociate_mac_sec_key(
    connectionId='string',
    secretARN='string'
)

type connectionId

string

param connectionId

[REQUIRED]

The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

You can use DescribeConnections or DescribeLags to retrieve connection ID.

type secretARN

string

param secretARN

[REQUIRED]

The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.

You can use DescribeConnections to retrieve the ARN of the MAC Security (MACsec) secret key.

rtype

dict

returns

Response Syntax

{
    'connectionId': 'string',
    'macSecKeys': [
        {
            'secretARN': 'string',
            'ckn': 'string',
            'state': 'string',
            'startOn': 'string'
        },
    ]
}

Response Structure

(dict) --
- connectionId (string) --
  
  The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).
- macSecKeys (list) --
  
  The MAC Security (MACsec) security keys no longer associated with the dedicated connection.
  - (dict) --
    
    Information about the MAC Security (MACsec) secret key.
    - secretARN (string) --
      
      The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
    - ckn (string) --
      
      The Connection Key Name (CKN) for the MAC Security secret key.
    - state (string) --
      
      The state of the MAC Security (MACsec) secret key.
      
      The possible values are:
      - associating : The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
      - associated : The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
      - disassociating : The MAC Security (MACsec) secret key is being disassociated from the connection or 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.

AssociateMacSecKey (new)

Link ¶

Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with an AWS Direct Connect dedicated connection.

You must supply either the secretARN, or the CKN/CAK (ckn and cak ) pair in the request.

For information about MAC Security (MACsec) key considerations, see MACsec pre-shared CKN/CAK key considerations in the AWS Direct Connect User Guide .

See also: AWS API Documentation

Request Syntax

client.associate_mac_sec_key(
    connectionId='string',
    secretARN='string',
    ckn='string',
    cak='string'
)

type connectionId

string

param connectionId

[REQUIRED]

The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

You can use DescribeConnections or DescribeLags to retrieve connection ID.

type secretARN

string

param secretARN

The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key to associate with the dedicated connection.

You can use DescribeConnections or DescribeLags to retrieve the MAC Security (MACsec) secret key.

If you use this request parameter, you do not use the ckn and cak request parameters.

type ckn

string

param ckn

The MAC Security (MACsec) CKN to associate with the dedicated connection.

You can create the CKN/CAK pair using an industry standard tool.

The valid values are 64 hexadecimal characters (0-9, A-E).

If you use this request parameter, you must use the cak request parameter and not use the secretARN request parameter.

type cak

string

param cak

The MAC Security (MACsec) CAK to associate with the dedicated connection.

You can create the CKN/CAK pair using an industry standard tool.

The valid values are 64 hexadecimal characters (0-9, A-E).

If you use this request parameter, you must use the ckn request parameter and not use the secretARN request parameter.

rtype

dict

returns

Response Syntax

{
    'connectionId': 'string',
    'macSecKeys': [
        {
            'secretARN': 'string',
            'ckn': 'string',
            'state': 'string',
            'startOn': 'string'
        },
    ]
}

Response Structure

(dict) --
- connectionId (string) --
  
  The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).
- macSecKeys (list) --
  
  The MAC Security (MACsec) security keys associated with the dedicated connection.
  - (dict) --
    
    Information about the MAC Security (MACsec) secret key.
    - secretARN (string) --
      
      The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
    - ckn (string) --
      
      The Connection Key Name (CKN) for the MAC Security secret key.
    - state (string) --
      
      The state of the MAC Security (MACsec) secret key.
      
      The possible values are:
      - associating : The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
      - associated : The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
      - disassociating : The MAC Security (MACsec) secret key is being disassociated from the connection or 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.

UpdateConnection (new)

Link ¶

Updates the AWS Direct Connect dedicated connection configuration.

You can update the following parameters for a connection:

The connection name
The connection's MAC Security (MACsec) encryption mode.

See also: AWS API Documentation

Request Syntax

client.update_connection(
    connectionId='string',
    connectionName='string',
    encryptionMode='string'
)

type connectionId

string

param connectionId

[REQUIRED]

The ID of the dedicated connection.

You can use DescribeConnections to retrieve the connection ID.

type connectionName

string

param connectionName

The name of the connection.

type encryptionMode

string

param encryptionMode

The connection MAC Security (MACsec) encryption mode.

The valid values are no_encrypt , should_encrypt , and must_encrypt .

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'connectionId': 'string',
    'connectionName': 'string',
    'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
    'region': 'string',
    'location': 'string',
    'bandwidth': 'string',
    'vlan': 123,
    'partnerName': 'string',
    'loaIssueTime': datetime(2015, 1, 1),
    'lagId': 'string',
    'awsDevice': 'string',
    'jumboFrameCapable': True|False,
    'awsDeviceV2': 'string',
    'hasLogicalRedundancy': 'unknown'|'yes'|'no',
    'tags': [
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    'providerName': 'string',
    'macSecCapable': True|False,
    'portEncryptionStatus': 'string',
    'encryptionMode': 'string',
    'macSecKeys': [
        {
            'secretARN': 'string',
            'ckn': 'string',
            'state': 'string',
            'startOn': 'string'
        },
    ]
}

Response Structure

(dict) --

Information about an AWS Direct Connect connection.
- ownerAccount (string) --
  
  The ID of the AWS account that owns the connection.
- connectionId (string) --
  
  The ID of the connection.
- connectionName (string) --
  
  The name of the connection.
- connectionState (string) --
  
  The state of the connection. The following are the possible values:
  - ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
  - requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  - pending : The connection has been approved and is being initialized.
  - available : The network link is up and the connection is ready for use.
  - down : The network link is down.
  - deleting : The connection is being deleted.
  - deleted : The connection has been deleted.
  - rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
  - unknown : The state of the connection is not available.
- region (string) --
  
  The AWS Region where the connection is located.
- location (string) --
  
  The location of the connection.
- bandwidth (string) --
  
  The bandwidth of the connection.
- vlan (integer) --
  
  The ID of the VLAN.
- partnerName (string) --
  
  The name of the AWS Direct Connect service provider associated with the connection.
- loaIssueTime (datetime) --
  
  The time of the most recent call to DescribeLoa for this connection.
- lagId (string) --
  
  The ID of the LAG.
- awsDevice (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames (9001 MTU) are supported.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.
- hasLogicalRedundancy (string) --
  
  Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
- tags (list) --
  
  The tags associated with the connection.
  - (dict) --
    
    Information about a tag.
    - key (string) --
      
      The key.
    - value (string) --
      
      The value.
- providerName (string) --
  
  The name of the service provider associated with the connection.
- 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.

AllocateConnectionOnInterconnect (updated)

Link ¶
Changes (response)

{'encryptionMode': 'string',
 'macSecCapable': 'boolean',
 'macSecKeys': [{'ckn': 'string',
                 'secretARN': 'string',
                 'startOn': 'string',
                 'state': 'string'}],
 'portEncryptionStatus': 'string'}

Deprecated. Use AllocateHostedConnection instead.

Creates a hosted connection on an interconnect.

Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the specified interconnect.

Note

Intended for use by AWS Direct Connect Partners only.

!DANGER!

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

client.allocate_connection_on_interconnect(
    bandwidth='string',
    connectionName='string',
    ownerAccount='string',
    interconnectId='string',
    vlan=123
)

type bandwidth

string

param bandwidth

[REQUIRED]

The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those AWS Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.

type connectionName

string

param connectionName

[REQUIRED]

The name of the provisioned connection.

type ownerAccount

string

param ownerAccount

[REQUIRED]

The ID of the AWS account of the customer for whom the connection will be provisioned.

type interconnectId

string

param interconnectId

[REQUIRED]

The ID of the interconnect on which the connection will be provisioned.

type vlan

integer

param vlan

[REQUIRED]

The dedicated VLAN provisioned to the connection.

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'connectionId': 'string',
    'connectionName': 'string',
    'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
    'region': 'string',
    'location': 'string',
    'bandwidth': 'string',
    'vlan': 123,
    'partnerName': 'string',
    'loaIssueTime': datetime(2015, 1, 1),
    'lagId': 'string',
    'awsDevice': 'string',
    'jumboFrameCapable': True|False,
    'awsDeviceV2': 'string',
    'hasLogicalRedundancy': 'unknown'|'yes'|'no',
    'tags': [
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    'providerName': 'string',
    'macSecCapable': True|False,
    'portEncryptionStatus': 'string',
    'encryptionMode': 'string',
    'macSecKeys': [
        {
            'secretARN': 'string',
            'ckn': 'string',
            'state': 'string',
            'startOn': 'string'
        },
    ]
}

Response Structure

(dict) --

Information about an AWS Direct Connect connection.
- ownerAccount (string) --
  
  The ID of the AWS account that owns the connection.
- connectionId (string) --
  
  The ID of the connection.
- connectionName (string) --
  
  The name of the connection.
- connectionState (string) --
  
  The state of the connection. The following are the possible values:
  - ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
  - requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  - pending : The connection has been approved and is being initialized.
  - available : The network link is up and the connection is ready for use.
  - down : The network link is down.
  - deleting : The connection is being deleted.
  - deleted : The connection has been deleted.
  - rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
  - unknown : The state of the connection is not available.
- region (string) --
  
  The AWS Region where the connection is located.
- location (string) --
  
  The location of the connection.
- bandwidth (string) --
  
  The bandwidth of the connection.
- vlan (integer) --
  
  The ID of the VLAN.
- partnerName (string) --
  
  The name of the AWS Direct Connect service provider associated with the connection.
- loaIssueTime (datetime) --
  
  The time of the most recent call to DescribeLoa for this connection.
- lagId (string) --
  
  The ID of the LAG.
- awsDevice (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames (9001 MTU) are supported.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.
- hasLogicalRedundancy (string) --
  
  Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
- tags (list) --
  
  The tags associated with the connection.
  - (dict) --
    
    Information about a tag.
    - key (string) --
      
      The key.
    - value (string) --
      
      The value.
- providerName (string) --
  
  The name of the service provider associated with the connection.
- 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.

AllocateHostedConnection (updated)

Link ¶
Changes (response)

{'encryptionMode': 'string',
 'macSecCapable': 'boolean',
 'macSecKeys': [{'ckn': 'string',
                 'secretARN': 'string',
                 'startOn': 'string',
                 'state': 'string'}],
 'portEncryptionStatus': 'string'}

Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects.

Allocates a VLAN number and a specified amount of capacity (bandwidth) for use by a hosted connection on the specified interconnect or LAG of interconnects. AWS polices the hosted connection for the specified capacity and the AWS Direct Connect Partner must also police the hosted connection for the specified capacity.

Note

Intended for use by AWS Direct Connect Partners only.

See also: AWS API Documentation

Request Syntax

client.allocate_hosted_connection(
    connectionId='string',
    ownerAccount='string',
    bandwidth='string',
    connectionName='string',
    vlan=123,
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

type connectionId

string

param connectionId

[REQUIRED]

The ID of the interconnect or LAG.

type ownerAccount

string

param ownerAccount

[REQUIRED]

The ID of the AWS account ID of the customer for the connection.

type bandwidth

string

param bandwidth

[REQUIRED]

type connectionName

string

param connectionName

[REQUIRED]

The name of the hosted connection.

type vlan

integer

param vlan

[REQUIRED]

The dedicated VLAN provisioned to the hosted connection.

type tags

list

param tags

The tags associated with the connection.

(dict) --

Information about a tag.
- key (string) -- [REQUIRED]
  
  The key.
- value (string) --
  
  The value.

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'connectionId': 'string',
    'connectionName': 'string',
    'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
    'region': 'string',
    'location': 'string',
    'bandwidth': 'string',
    'vlan': 123,
    'partnerName': 'string',
    'loaIssueTime': datetime(2015, 1, 1),
    'lagId': 'string',
    'awsDevice': 'string',
    'jumboFrameCapable': True|False,
    'awsDeviceV2': 'string',
    'hasLogicalRedundancy': 'unknown'|'yes'|'no',
    'tags': [
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    'providerName': 'string',
    'macSecCapable': True|False,
    'portEncryptionStatus': 'string',
    'encryptionMode': 'string',
    'macSecKeys': [
        {
            'secretARN': 'string',
            'ckn': 'string',
            'state': 'string',
            'startOn': 'string'
        },
    ]
}

Response Structure

(dict) --

Information about an AWS Direct Connect connection.
- ownerAccount (string) --
  
  The ID of the AWS account that owns the connection.
- connectionId (string) --
  
  The ID of the connection.
- connectionName (string) --
  
  The name of the connection.
- connectionState (string) --
  
  The state of the connection. The following are the possible values:
  - ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
  - requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  - pending : The connection has been approved and is being initialized.
  - available : The network link is up and the connection is ready for use.
  - down : The network link is down.
  - deleting : The connection is being deleted.
  - deleted : The connection has been deleted.
  - rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
  - unknown : The state of the connection is not available.
- region (string) --
  
  The AWS Region where the connection is located.
- location (string) --
  
  The location of the connection.
- bandwidth (string) --
  
  The bandwidth of the connection.
- vlan (integer) --
  
  The ID of the VLAN.
- partnerName (string) --
  
  The name of the AWS Direct Connect service provider associated with the connection.
- loaIssueTime (datetime) --
  
  The time of the most recent call to DescribeLoa for this connection.
- lagId (string) --
  
  The ID of the LAG.
- awsDevice (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames (9001 MTU) are supported.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.
- hasLogicalRedundancy (string) --
  
  Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
- tags (list) --
  
  The tags associated with the connection.
  - (dict) --
    
    Information about a tag.
    - key (string) --
      
      The key.
    - value (string) --
      
      The value.
- providerName (string) --
  
  The name of the service provider associated with the connection.
- 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.

AssociateConnectionWithLag (updated)

Link ¶
Changes (response)

{'encryptionMode': 'string',
 'macSecCapable': 'boolean',
 'macSecKeys': [{'ckn': 'string',
                 'secretARN': 'string',
                 'startOn': 'string',
                 'state': 'string'}],
 'portEncryptionStatus': 'string'}

Associates an existing connection with a link aggregation group (LAG). The connection is interrupted and re-established as a member of the LAG (connectivity to AWS is interrupted). The connection must be hosted on the same AWS Direct Connect endpoint as the LAG, and its bandwidth must match the bandwidth for the LAG. You can re-associate a connection that's currently associated with a different LAG; however, if removing the connection would cause the original LAG to fall below its setting for minimum number of operational connections, the request fails.

Any virtual interfaces that are directly associated with the connection are automatically re-associated with the LAG. If the connection was originally associated with a different LAG, the virtual interfaces remain associated with the original LAG.

For interconnects, any hosted connections are automatically re-associated with the LAG. If the interconnect was originally associated with a different LAG, the hosted connections remain associated with the original LAG.

See also: AWS API Documentation

Request Syntax

client.associate_connection_with_lag(
    connectionId='string',
    lagId='string'
)

type connectionId

string

param connectionId

[REQUIRED]

The ID of the connection.

type lagId

string

param lagId

[REQUIRED]

The ID of the LAG with which to associate the connection.

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'connectionId': 'string',
    'connectionName': 'string',
    'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
    'region': 'string',
    'location': 'string',
    'bandwidth': 'string',
    'vlan': 123,
    'partnerName': 'string',
    'loaIssueTime': datetime(2015, 1, 1),
    'lagId': 'string',
    'awsDevice': 'string',
    'jumboFrameCapable': True|False,
    'awsDeviceV2': 'string',
    'hasLogicalRedundancy': 'unknown'|'yes'|'no',
    'tags': [
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    'providerName': 'string',
    'macSecCapable': True|False,
    'portEncryptionStatus': 'string',
    'encryptionMode': 'string',
    'macSecKeys': [
        {
            'secretARN': 'string',
            'ckn': 'string',
            'state': 'string',
            'startOn': 'string'
        },
    ]
}

Response Structure

(dict) --

Information about an AWS Direct Connect connection.
- ownerAccount (string) --
  
  The ID of the AWS account that owns the connection.
- connectionId (string) --
  
  The ID of the connection.
- connectionName (string) --
  
  The name of the connection.
- connectionState (string) --
  
  The state of the connection. The following are the possible values:
  - ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
  - requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  - pending : The connection has been approved and is being initialized.
  - available : The network link is up and the connection is ready for use.
  - down : The network link is down.
  - deleting : The connection is being deleted.
  - deleted : The connection has been deleted.
  - rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
  - unknown : The state of the connection is not available.
- region (string) --
  
  The AWS Region where the connection is located.
- location (string) --
  
  The location of the connection.
- bandwidth (string) --
  
  The bandwidth of the connection.
- vlan (integer) --
  
  The ID of the VLAN.
- partnerName (string) --
  
  The name of the AWS Direct Connect service provider associated with the connection.
- loaIssueTime (datetime) --
  
  The time of the most recent call to DescribeLoa for this connection.
- lagId (string) --
  
  The ID of the LAG.
- awsDevice (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames (9001 MTU) are supported.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.
- hasLogicalRedundancy (string) --
  
  Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
- tags (list) --
  
  The tags associated with the connection.
  - (dict) --
    
    Information about a tag.
    - key (string) --
      
      The key.
    - value (string) --
      
      The value.
- providerName (string) --
  
  The name of the service provider associated with the connection.
- 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.

AssociateHostedConnection (updated)

Link ¶
Changes (response)

{'encryptionMode': 'string',
 'macSecCapable': 'boolean',
 'macSecKeys': [{'ckn': 'string',
                 'secretARN': 'string',
                 'startOn': 'string',
                 'state': 'string'}],
 'portEncryptionStatus': 'string'}

Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect. If the target interconnect or LAG has an existing hosted connection with a conflicting VLAN number or IP address, the operation fails. This action temporarily interrupts the hosted connection's connectivity to AWS as it is being migrated.

Note

Intended for use by AWS Direct Connect Partners only.

See also: AWS API Documentation

Request Syntax

client.associate_hosted_connection(
    connectionId='string',
    parentConnectionId='string'
)

type connectionId

string

param connectionId

[REQUIRED]

The ID of the hosted connection.

type parentConnectionId

string

param parentConnectionId

[REQUIRED]

The ID of the interconnect or the LAG.

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'connectionId': 'string',
    'connectionName': 'string',
    'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
    'region': 'string',
    'location': 'string',
    'bandwidth': 'string',
    'vlan': 123,
    'partnerName': 'string',
    'loaIssueTime': datetime(2015, 1, 1),
    'lagId': 'string',
    'awsDevice': 'string',
    'jumboFrameCapable': True|False,
    'awsDeviceV2': 'string',
    'hasLogicalRedundancy': 'unknown'|'yes'|'no',
    'tags': [
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    'providerName': 'string',
    'macSecCapable': True|False,
    'portEncryptionStatus': 'string',
    'encryptionMode': 'string',
    'macSecKeys': [
        {
            'secretARN': 'string',
            'ckn': 'string',
            'state': 'string',
            'startOn': 'string'
        },
    ]
}

Response Structure

(dict) --

Information about an AWS Direct Connect connection.
- ownerAccount (string) --
  
  The ID of the AWS account that owns the connection.
- connectionId (string) --
  
  The ID of the connection.
- connectionName (string) --
  
  The name of the connection.
- connectionState (string) --
  
  The state of the connection. The following are the possible values:
  - ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
  - requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  - pending : The connection has been approved and is being initialized.
  - available : The network link is up and the connection is ready for use.
  - down : The network link is down.
  - deleting : The connection is being deleted.
  - deleted : The connection has been deleted.
  - rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
  - unknown : The state of the connection is not available.
- region (string) --
  
  The AWS Region where the connection is located.
- location (string) --
  
  The location of the connection.
- bandwidth (string) --
  
  The bandwidth of the connection.
- vlan (integer) --
  
  The ID of the VLAN.
- partnerName (string) --
  
  The name of the AWS Direct Connect service provider associated with the connection.
- loaIssueTime (datetime) --
  
  The time of the most recent call to DescribeLoa for this connection.
- lagId (string) --
  
  The ID of the LAG.
- awsDevice (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames (9001 MTU) are supported.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.
- hasLogicalRedundancy (string) --
  
  Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
- tags (list) --
  
  The tags associated with the connection.
  - (dict) --
    
    Information about a tag.
    - key (string) --
      
      The key.
    - value (string) --
      
      The value.
- providerName (string) --
  
  The name of the service provider associated with the connection.
- 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.

CreateConnection (updated)

Link ¶
Changes (request, response)
Request

{'requestMACSec': 'boolean'}

Response

{'encryptionMode': 'string',
 'macSecCapable': 'boolean',
 'macSecKeys': [{'ckn': 'string',
                 'secretARN': 'string',
                 'startOn': 'string',
                 'state': 'string'}],
 'portEncryptionStatus': 'string'}

Creates a connection between a customer network and a specific AWS Direct Connect location.

A connection links your internal network to an AWS Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router.

To find the locations for your Region, use DescribeLocations .

You can automatically add the new connection to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new connection is allocated on the same AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no connection is created.

See also: AWS API Documentation

Request Syntax

client.create_connection(
    location='string',
    bandwidth='string',
    connectionName='string',
    lagId='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    providerName='string',
    requestMACSec=True|False
)

type location

string

param location

[REQUIRED]

The location of the connection.

type bandwidth

string

param bandwidth

[REQUIRED]

The bandwidth of the connection.

type connectionName

string

param connectionName

[REQUIRED]

The name of the connection.

type lagId

string

param lagId

The ID of the LAG.

type tags

list

param tags

The tags to associate with the lag.

(dict) --

Information about a tag.
- key (string) -- [REQUIRED]
  
  The key.
- value (string) --
  
  The value.

type providerName

string

param providerName

The name of the service provider associated with the requested connection.

type requestMACSec

boolean

param requestMACSec

Indicates whether you want the connection to support MAC Security (MACsec).

MAC Security (MACsec) is only available on dedicated connections. For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the AWS Direct Connect User Guide .

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'connectionId': 'string',
    'connectionName': 'string',
    'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
    'region': 'string',
    'location': 'string',
    'bandwidth': 'string',
    'vlan': 123,
    'partnerName': 'string',
    'loaIssueTime': datetime(2015, 1, 1),
    'lagId': 'string',
    'awsDevice': 'string',
    'jumboFrameCapable': True|False,
    'awsDeviceV2': 'string',
    'hasLogicalRedundancy': 'unknown'|'yes'|'no',
    'tags': [
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    'providerName': 'string',
    'macSecCapable': True|False,
    'portEncryptionStatus': 'string',
    'encryptionMode': 'string',
    'macSecKeys': [
        {
            'secretARN': 'string',
            'ckn': 'string',
            'state': 'string',
            'startOn': 'string'
        },
    ]
}

Response Structure

(dict) --

Information about an AWS Direct Connect connection.
- ownerAccount (string) --
  
  The ID of the AWS account that owns the connection.
- connectionId (string) --
  
  The ID of the connection.
- connectionName (string) --
  
  The name of the connection.
- connectionState (string) --
  
  The state of the connection. The following are the possible values:
  - ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
  - requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  - pending : The connection has been approved and is being initialized.
  - available : The network link is up and the connection is ready for use.
  - down : The network link is down.
  - deleting : The connection is being deleted.
  - deleted : The connection has been deleted.
  - rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
  - unknown : The state of the connection is not available.
- region (string) --
  
  The AWS Region where the connection is located.
- location (string) --
  
  The location of the connection.
- bandwidth (string) --
  
  The bandwidth of the connection.
- vlan (integer) --
  
  The ID of the VLAN.
- partnerName (string) --
  
  The name of the AWS Direct Connect service provider associated with the connection.
- loaIssueTime (datetime) --
  
  The time of the most recent call to DescribeLoa for this connection.
- lagId (string) --
  
  The ID of the LAG.
- awsDevice (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames (9001 MTU) are supported.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.
- hasLogicalRedundancy (string) --
  
  Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
- tags (list) --
  
  The tags associated with the connection.
  - (dict) --
    
    Information about a tag.
    - key (string) --
      
      The key.
    - value (string) --
      
      The value.
- providerName (string) --
  
  The name of the service provider associated with the connection.
- 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.

CreateLag (updated)

Link ¶
Changes (request, response)
Request

{'requestMACSec': 'boolean'}

Response

{'connections': {'encryptionMode': 'string',
                 'macSecCapable': 'boolean',
                 'macSecKeys': [{'ckn': 'string',
                                 'secretARN': 'string',
                                 'startOn': 'string',
                                 'state': 'string'}],
                 'portEncryptionStatus': 'string'},
 'encryptionMode': 'string',
 'macSecCapable': 'boolean',
 'macSecKeys': [{'ckn': 'string',
                 'secretARN': 'string',
                 'startOn': 'string',
                 'state': 'string'}]}

Creates a link aggregation group (LAG) with the specified number of bundled physical dedicated connections between the customer network and a specific AWS Direct Connect location. A LAG is a logical interface that uses the Link Aggregation Control Protocol (LACP) to aggregate multiple interfaces, enabling you to treat them as a single interface.

All connections in a LAG must use the same bandwidth (either 1Gbps or 10Gbps) and must terminate at the same AWS Direct Connect endpoint.

You can have up to 10 dedicated connections per LAG. Regardless of this limit, if you request more connections for the LAG than AWS 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 AWS 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 AWS account used to create a LAG is a registered AWS Direct Connect Partner, the LAG is automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual interfaces cannot be directly configured.

See also: AWS API Documentation

Request Syntax

client.create_lag(
    numberOfConnections=123,
    location='string',
    connectionsBandwidth='string',
    lagName='string',
    connectionId='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    childConnectionTags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    providerName='string',
    requestMACSec=True|False
)

type numberOfConnections

integer

param numberOfConnections

[REQUIRED]

The number of physical dedicated connections initially provisioned and bundled by the LAG.

type location

string

param location

[REQUIRED]

The location for the LAG.

type connectionsBandwidth

string

param connectionsBandwidth

[REQUIRED]

The bandwidth of the individual physical dedicated connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.

type lagName

string

param lagName

[REQUIRED]

The name of the LAG.

type connectionId

string

param connectionId

The ID of an existing dedicated connection to migrate to the LAG.

type tags

list

param tags

The tags to associate with the LAG.

(dict) --

Information about a tag.
- key (string) -- [REQUIRED]
  
  The key.
- value (string) --
  
  The value.

type childConnectionTags

list

param childConnectionTags

The tags to associate with the automtically created LAGs.

(dict) --

Information about a tag.
- key (string) -- [REQUIRED]
  
  The key.
- value (string) --
  
  The value.

type providerName

string

param providerName

The name of the service provider associated with the LAG.

type requestMACSec

boolean

param requestMACSec

Indicates whether the connection will support MAC Security (MACsec).

Note

All connections in the LAG must be capable of supporting MAC Security (MACsec). For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the AWS Direct Connect User Guide .

rtype

dict

returns

Response Syntax

{
    'connectionsBandwidth': 'string',
    'numberOfConnections': 123,
    'lagId': 'string',
    'ownerAccount': 'string',
    'lagName': 'string',
    'lagState': 'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'unknown',
    'location': 'string',
    'region': 'string',
    'minimumLinks': 123,
    'awsDevice': 'string',
    'awsDeviceV2': 'string',
    'connections': [
        {
            'ownerAccount': 'string',
            'connectionId': 'string',
            'connectionName': 'string',
            'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
            'region': 'string',
            'location': 'string',
            'bandwidth': 'string',
            'vlan': 123,
            'partnerName': 'string',
            'loaIssueTime': datetime(2015, 1, 1),
            'lagId': 'string',
            'awsDevice': 'string',
            'jumboFrameCapable': True|False,
            'awsDeviceV2': 'string',
            'hasLogicalRedundancy': 'unknown'|'yes'|'no',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'providerName': 'string',
            'macSecCapable': True|False,
            'portEncryptionStatus': 'string',
            'encryptionMode': 'string',
            'macSecKeys': [
                {
                    'secretARN': 'string',
                    'ckn': 'string',
                    'state': 'string',
                    'startOn': 'string'
                },
            ]
        },
    ],
    'allowsHostedConnections': True|False,
    'jumboFrameCapable': True|False,
    'hasLogicalRedundancy': 'unknown'|'yes'|'no',
    'tags': [
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    'providerName': 'string',
    'macSecCapable': True|False,
    'encryptionMode': 'string',
    'macSecKeys': [
        {
            'secretARN': 'string',
            'ckn': 'string',
            'state': 'string',
            'startOn': 'string'
        },
    ]
}

Response Structure

(dict) --

Information about a link aggregation group (LAG).
- connectionsBandwidth (string) --
  
  The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.
- numberOfConnections (integer) --
  
  The number of physical dedicated connections bundled by the LAG, up to a maximum of 10.
- lagId (string) --
  
  The ID of the LAG.
- ownerAccount (string) --
  
  The ID of the AWS account that owns the LAG.
- lagName (string) --
  
  The name of the LAG.
- lagState (string) --
  
  The state of the LAG. The following are the possible values:
  - requested : The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.
  - pending : The LAG has been approved and is being initialized.
  - available : The network link is established and the LAG is ready for use.
  - down : The network link is down.
  - deleting : The LAG is being deleted.
  - deleted : The LAG is deleted.
  - unknown : The state of the LAG is not available.
- location (string) --
  
  The location of the LAG.
- region (string) --
  
  The AWS Region where the connection is located.
- minimumLinks (integer) --
  
  The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.
- awsDevice (string) --
  
  The AWS Direct Connect endpoint that hosts the LAG.
- awsDeviceV2 (string) --
  
  The AWS Direct Connect endpoint that hosts the LAG.
- connections (list) --
  
  The connections bundled by the LAG.
  - (dict) --
    
    Information about an AWS Direct Connect connection.
    - ownerAccount (string) --
      
      The ID of the AWS account that owns the connection.
    - connectionId (string) --
      
      The ID of the connection.
    - connectionName (string) --
      
      The name of the connection.
    - connectionState (string) --
      
      The state of the connection. The following are the possible values:
      - ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
      - requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
      - pending : The connection has been approved and is being initialized.
      - available : The network link is up and the connection is ready for use.
      - down : The network link is down.
      - deleting : The connection is being deleted.
      - deleted : The connection has been deleted.
      - rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
      - unknown : The state of the connection is not available.
    - region (string) --
      
      The AWS Region where the connection is located.
    - location (string) --
      
      The location of the connection.
    - bandwidth (string) --
      
      The bandwidth of the connection.
    - vlan (integer) --
      
      The ID of the VLAN.
    - partnerName (string) --
      
      The name of the AWS Direct Connect service provider associated with the connection.
    - loaIssueTime (datetime) --
      
      The time of the most recent call to DescribeLoa for this connection.
    - lagId (string) --
      
      The ID of the LAG.
    - awsDevice (string) --
      
      The Direct Connect endpoint on which the physical connection terminates.
    - jumboFrameCapable (boolean) --
      
      Indicates whether jumbo frames (9001 MTU) are supported.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint on which the physical connection terminates.
    - hasLogicalRedundancy (string) --
      
      Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
    - tags (list) --
      
      The tags associated with the connection.
      - (dict) --
        
        Information about a tag.
        
        key (string) --
        
        The key.
        
        value (string) --
        
        The value.
    - providerName (string) --
      
      The name of the service provider associated with the connection.
    - macSecCapable (boolean) --
      
      Indicates whether the connection supports MAC Security (MACsec).
    - portEncryptionStatus (string) --
      
      The MAC Security (MACsec) port link status of the connection.
      
      The valid values are Encryption Up , which means that there is an active Connection Key Name, or Encryption Down .
    - encryptionMode (string) --
      
      The MAC Security (MACsec) connection encryption mode.
      
      The valid values are no_encrypt , should_encrypt , and must_encrypt .
    - macSecKeys (list) --
      
      The MAC Security (MACsec) security keys associated with the connection.
      - (dict) --
        
        Information about the MAC Security (MACsec) secret key.
        
        secretARN (string) --
        
        The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
        
        ckn (string) --
        
        The Connection Key Name (CKN) for the MAC Security secret key.
        
        state (string) --
        
        The state of the MAC Security (MACsec) secret key.
        
        The possible values are:
        
        associating : The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
        
        associated : The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
        
        disassociating : The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
        
        disassociated : The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
        
        startOn (string) --
        
        The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
- allowsHostedConnections (boolean) --
  
  Indicates whether the LAG can host other connections.
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames (9001 MTU) are supported.
- hasLogicalRedundancy (string) --
  
  Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).
- tags (list) --
  
  The tags associated with the LAG.
  - (dict) --
    
    Information about a tag.
    - key (string) --
      
      The key.
    - value (string) --
      
      The value.
- providerName (string) --
  
  The name of the service provider associated with the LAG.
- macSecCapable (boolean) --
  
  Indicates whether the LAG supports MAC Security (MACsec).
- encryptionMode (string) --
  
  The LAG MAC Security (MACsec) encryption mode.
  
  The valid values are no_encrypt , should_encrypt , and must_encrypt .
- macSecKeys (list) --
  
  The MAC Security (MACsec) security keys associated with the LAG.
  - (dict) --
    
    Information about the MAC Security (MACsec) secret key.
    - secretARN (string) --
      
      The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
    - ckn (string) --
      
      The Connection Key Name (CKN) for the MAC Security secret key.
    - state (string) --
      
      The state of the MAC Security (MACsec) secret key.
      
      The possible values are:
      - associating : The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
      - associated : The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
      - disassociating : The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
      - disassociated : The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
    - startOn (string) --
      
      The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.

DeleteConnection (updated)

Link ¶
Changes (response)

{'encryptionMode': 'string',
 'macSecCapable': 'boolean',
 'macSecKeys': [{'ckn': 'string',
                 'secretARN': 'string',
                 'startOn': 'string',
                 'state': 'string'}],
 'portEncryptionStatus': 'string'}

Deletes the specified connection.

Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. If you are partnering with any third parties to connect with the AWS Direct Connect location, you must cancel your service with them separately.

See also: AWS API Documentation

Request Syntax

client.delete_connection(
    connectionId='string'
)

type connectionId

string

param connectionId

[REQUIRED]

The ID of the connection.

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'connectionId': 'string',
    'connectionName': 'string',
    'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
    'region': 'string',
    'location': 'string',
    'bandwidth': 'string',
    'vlan': 123,
    'partnerName': 'string',
    'loaIssueTime': datetime(2015, 1, 1),
    'lagId': 'string',
    'awsDevice': 'string',
    'jumboFrameCapable': True|False,
    'awsDeviceV2': 'string',
    'hasLogicalRedundancy': 'unknown'|'yes'|'no',
    'tags': [
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    'providerName': 'string',
    'macSecCapable': True|False,
    'portEncryptionStatus': 'string',
    'encryptionMode': 'string',
    'macSecKeys': [
        {
            'secretARN': 'string',
            'ckn': 'string',
            'state': 'string',
            'startOn': 'string'
        },
    ]
}

Response Structure

(dict) --

Information about an AWS Direct Connect connection.
- ownerAccount (string) --
  
  The ID of the AWS account that owns the connection.
- connectionId (string) --
  
  The ID of the connection.
- connectionName (string) --
  
  The name of the connection.
- connectionState (string) --
  
  The state of the connection. The following are the possible values:
  - ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
  - requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  - pending : The connection has been approved and is being initialized.
  - available : The network link is up and the connection is ready for use.
  - down : The network link is down.
  - deleting : The connection is being deleted.
  - deleted : The connection has been deleted.
  - rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
  - unknown : The state of the connection is not available.
- region (string) --
  
  The AWS Region where the connection is located.
- location (string) --
  
  The location of the connection.
- bandwidth (string) --
  
  The bandwidth of the connection.
- vlan (integer) --
  
  The ID of the VLAN.
- partnerName (string) --
  
  The name of the AWS Direct Connect service provider associated with the connection.
- loaIssueTime (datetime) --
  
  The time of the most recent call to DescribeLoa for this connection.
- lagId (string) --
  
  The ID of the LAG.
- awsDevice (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames (9001 MTU) are supported.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.
- hasLogicalRedundancy (string) --
  
  Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
- tags (list) --
  
  The tags associated with the connection.
  - (dict) --
    
    Information about a tag.
    - key (string) --
      
      The key.
    - value (string) --
      
      The value.
- providerName (string) --
  
  The name of the service provider associated with the connection.
- 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.

DeleteLag (updated)

Link ¶
Changes (response)

{'connections': {'encryptionMode': 'string',
                 'macSecCapable': 'boolean',
                 'macSecKeys': [{'ckn': 'string',
                                 'secretARN': 'string',
                                 'startOn': 'string',
                                 'state': 'string'}],
                 'portEncryptionStatus': 'string'},
 'encryptionMode': 'string',
 'macSecCapable': 'boolean',
 'macSecKeys': [{'ckn': 'string',
                 'secretARN': 'string',
                 'startOn': 'string',
                 'state': 'string'}]}

Deletes the specified link aggregation group (LAG). You cannot delete a LAG if it has active virtual interfaces or hosted connections.

See also: AWS API Documentation

Request Syntax

client.delete_lag(
    lagId='string'
)

type lagId

string

param lagId

[REQUIRED]

The ID of the LAG.

rtype

dict

returns

Response Syntax

{
    'connectionsBandwidth': 'string',
    'numberOfConnections': 123,
    'lagId': 'string',
    'ownerAccount': 'string',
    'lagName': 'string',
    'lagState': 'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'unknown',
    'location': 'string',
    'region': 'string',
    'minimumLinks': 123,
    'awsDevice': 'string',
    'awsDeviceV2': 'string',
    'connections': [
        {
            'ownerAccount': 'string',
            'connectionId': 'string',
            'connectionName': 'string',
            'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
            'region': 'string',
            'location': 'string',
            'bandwidth': 'string',
            'vlan': 123,
            'partnerName': 'string',
            'loaIssueTime': datetime(2015, 1, 1),
            'lagId': 'string',
            'awsDevice': 'string',
            'jumboFrameCapable': True|False,
            'awsDeviceV2': 'string',
            'hasLogicalRedundancy': 'unknown'|'yes'|'no',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'providerName': 'string',
            'macSecCapable': True|False,
            'portEncryptionStatus': 'string',
            'encryptionMode': 'string',
            'macSecKeys': [
                {
                    'secretARN': 'string',
                    'ckn': 'string',
                    'state': 'string',
                    'startOn': 'string'
                },
            ]
        },
    ],
    'allowsHostedConnections': True|False,
    'jumboFrameCapable': True|False,
    'hasLogicalRedundancy': 'unknown'|'yes'|'no',
    'tags': [
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    'providerName': 'string',
    'macSecCapable': True|False,
    'encryptionMode': 'string',
    'macSecKeys': [
        {
            'secretARN': 'string',
            'ckn': 'string',
            'state': 'string',
            'startOn': 'string'
        },
    ]
}

Response Structure

(dict) --

Information about a link aggregation group (LAG).
- connectionsBandwidth (string) --
  
  The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.
- numberOfConnections (integer) --
  
  The number of physical dedicated connections bundled by the LAG, up to a maximum of 10.
- lagId (string) --
  
  The ID of the LAG.
- ownerAccount (string) --
  
  The ID of the AWS account that owns the LAG.
- lagName (string) --
  
  The name of the LAG.
- lagState (string) --
  
  The state of the LAG. The following are the possible values:
  - requested : The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.
  - pending : The LAG has been approved and is being initialized.
  - available : The network link is established and the LAG is ready for use.
  - down : The network link is down.
  - deleting : The LAG is being deleted.
  - deleted : The LAG is deleted.
  - unknown : The state of the LAG is not available.
- location (string) --
  
  The location of the LAG.
- region (string) --
  
  The AWS Region where the connection is located.
- minimumLinks (integer) --
  
  The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.
- awsDevice (string) --
  
  The AWS Direct Connect endpoint that hosts the LAG.
- awsDeviceV2 (string) --
  
  The AWS Direct Connect endpoint that hosts the LAG.
- connections (list) --
  
  The connections bundled by the LAG.
  - (dict) --
    
    Information about an AWS Direct Connect connection.
    - ownerAccount (string) --
      
      The ID of the AWS account that owns the connection.
    - connectionId (string) --
      
      The ID of the connection.
    - connectionName (string) --
      
      The name of the connection.
    - connectionState (string) --
      
      The state of the connection. The following are the possible values:
      - ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
      - requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
      - pending : The connection has been approved and is being initialized.
      - available : The network link is up and the connection is ready for use.
      - down : The network link is down.
      - deleting : The connection is being deleted.
      - deleted : The connection has been deleted.
      - rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
      - unknown : The state of the connection is not available.
    - region (string) --
      
      The AWS Region where the connection is located.
    - location (string) --
      
      The location of the connection.
    - bandwidth (string) --
      
      The bandwidth of the connection.
    - vlan (integer) --
      
      The ID of the VLAN.
    - partnerName (string) --
      
      The name of the AWS Direct Connect service provider associated with the connection.
    - loaIssueTime (datetime) --
      
      The time of the most recent call to DescribeLoa for this connection.
    - lagId (string) --
      
      The ID of the LAG.
    - awsDevice (string) --
      
      The Direct Connect endpoint on which the physical connection terminates.
    - jumboFrameCapable (boolean) --
      
      Indicates whether jumbo frames (9001 MTU) are supported.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint on which the physical connection terminates.
    - hasLogicalRedundancy (string) --
      
      Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
    - tags (list) --
      
      The tags associated with the connection.
      - (dict) --
        
        Information about a tag.
        
        key (string) --
        
        The key.
        
        value (string) --
        
        The value.
    - providerName (string) --
      
      The name of the service provider associated with the connection.
    - macSecCapable (boolean) --
      
      Indicates whether the connection supports MAC Security (MACsec).
    - portEncryptionStatus (string) --
      
      The MAC Security (MACsec) port link status of the connection.
      
      The valid values are Encryption Up , which means that there is an active Connection Key Name, or Encryption Down .
    - encryptionMode (string) --
      
      The MAC Security (MACsec) connection encryption mode.
      
      The valid values are no_encrypt , should_encrypt , and must_encrypt .
    - macSecKeys (list) --
      
      The MAC Security (MACsec) security keys associated with the connection.
      - (dict) --
        
        Information about the MAC Security (MACsec) secret key.
        
        secretARN (string) --
        
        The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
        
        ckn (string) --
        
        The Connection Key Name (CKN) for the MAC Security secret key.
        
        state (string) --
        
        The state of the MAC Security (MACsec) secret key.
        
        The possible values are:
        
        associating : The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
        
        associated : The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
        
        disassociating : The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
        
        disassociated : The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
        
        startOn (string) --
        
        The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
- allowsHostedConnections (boolean) --
  
  Indicates whether the LAG can host other connections.
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames (9001 MTU) are supported.
- hasLogicalRedundancy (string) --
  
  Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).
- tags (list) --
  
  The tags associated with the LAG.
  - (dict) --
    
    Information about a tag.
    - key (string) --
      
      The key.
    - value (string) --
      
      The value.
- providerName (string) --
  
  The name of the service provider associated with the LAG.
- macSecCapable (boolean) --
  
  Indicates whether the LAG supports MAC Security (MACsec).
- encryptionMode (string) --
  
  The LAG MAC Security (MACsec) encryption mode.
  
  The valid values are no_encrypt , should_encrypt , and must_encrypt .
- macSecKeys (list) --
  
  The MAC Security (MACsec) security keys associated with the LAG.
  - (dict) --
    
    Information about the MAC Security (MACsec) secret key.
    - secretARN (string) --
      
      The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
    - ckn (string) --
      
      The Connection Key Name (CKN) for the MAC Security secret key.
    - state (string) --
      
      The state of the MAC Security (MACsec) secret key.
      
      The possible values are:
      - associating : The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
      - associated : The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
      - disassociating : The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
      - disassociated : The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
    - startOn (string) --
      
      The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.

DescribeConnections (updated)

Link ¶
Changes (response)

{'connections': {'encryptionMode': 'string',
                 'macSecCapable': 'boolean',
                 'macSecKeys': [{'ckn': 'string',
                                 'secretARN': 'string',
                                 'startOn': 'string',
                                 'state': 'string'}],
                 'portEncryptionStatus': 'string'}}

Displays the specified connection or all connections in this Region.

See also: AWS API Documentation

Request Syntax

client.describe_connections(
    connectionId='string'
)

type connectionId

string

param connectionId

The ID of the connection.

rtype

dict

returns

Response Syntax

{
    'connections': [
        {
            'ownerAccount': 'string',
            'connectionId': 'string',
            'connectionName': 'string',
            'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
            'region': 'string',
            'location': 'string',
            'bandwidth': 'string',
            'vlan': 123,
            'partnerName': 'string',
            'loaIssueTime': datetime(2015, 1, 1),
            'lagId': 'string',
            'awsDevice': 'string',
            'jumboFrameCapable': True|False,
            'awsDeviceV2': 'string',
            'hasLogicalRedundancy': 'unknown'|'yes'|'no',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'providerName': 'string',
            'macSecCapable': True|False,
            'portEncryptionStatus': 'string',
            'encryptionMode': 'string',
            'macSecKeys': [
                {
                    'secretARN': 'string',
                    'ckn': 'string',
                    'state': 'string',
                    'startOn': 'string'
                },
            ]
        },
    ]
}

Response Structure

(dict) --
- connections (list) --
  
  The connections.
  - (dict) --
    
    Information about an AWS Direct Connect connection.
    - ownerAccount (string) --
      
      The ID of the AWS account that owns the connection.
    - connectionId (string) --
      
      The ID of the connection.
    - connectionName (string) --
      
      The name of the connection.
    - connectionState (string) --
      
      The state of the connection. The following are the possible values:
      - ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
      - requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
      - pending : The connection has been approved and is being initialized.
      - available : The network link is up and the connection is ready for use.
      - down : The network link is down.
      - deleting : The connection is being deleted.
      - deleted : The connection has been deleted.
      - rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
      - unknown : The state of the connection is not available.
    - region (string) --
      
      The AWS Region where the connection is located.
    - location (string) --
      
      The location of the connection.
    - bandwidth (string) --
      
      The bandwidth of the connection.
    - vlan (integer) --
      
      The ID of the VLAN.
    - partnerName (string) --
      
      The name of the AWS Direct Connect service provider associated with the connection.
    - loaIssueTime (datetime) --
      
      The time of the most recent call to DescribeLoa for this connection.
    - lagId (string) --
      
      The ID of the LAG.
    - awsDevice (string) --
      
      The Direct Connect endpoint on which the physical connection terminates.
    - jumboFrameCapable (boolean) --
      
      Indicates whether jumbo frames (9001 MTU) are supported.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint on which the physical connection terminates.
    - hasLogicalRedundancy (string) --
      
      Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
    - tags (list) --
      
      The tags associated with the connection.
      - (dict) --
        
        Information about a tag.
        
        key (string) --
        
        The key.
        
        value (string) --
        
        The value.
    - providerName (string) --
      
      The name of the service provider associated with the connection.
    - 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.

DescribeConnectionsOnInterconnect (updated)

Link ¶
Changes (response)

{'connections': {'encryptionMode': 'string',
                 'macSecCapable': 'boolean',
                 'macSecKeys': [{'ckn': 'string',
                                 'secretARN': 'string',
                                 'startOn': 'string',
                                 'state': 'string'}],
                 'portEncryptionStatus': 'string'}}

Deprecated. Use DescribeHostedConnections instead.

Lists the connections that have been provisioned on the specified interconnect.

Note

Intended for use by AWS Direct Connect Partners only.

!DANGER!

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

client.describe_connections_on_interconnect(
    interconnectId='string'
)

type interconnectId

string

param interconnectId

[REQUIRED]

The ID of the interconnect.

rtype

dict

returns

Response Syntax

{
    'connections': [
        {
            'ownerAccount': 'string',
            'connectionId': 'string',
            'connectionName': 'string',
            'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
            'region': 'string',
            'location': 'string',
            'bandwidth': 'string',
            'vlan': 123,
            'partnerName': 'string',
            'loaIssueTime': datetime(2015, 1, 1),
            'lagId': 'string',
            'awsDevice': 'string',
            'jumboFrameCapable': True|False,
            'awsDeviceV2': 'string',
            'hasLogicalRedundancy': 'unknown'|'yes'|'no',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'providerName': 'string',
            'macSecCapable': True|False,
            'portEncryptionStatus': 'string',
            'encryptionMode': 'string',
            'macSecKeys': [
                {
                    'secretARN': 'string',
                    'ckn': 'string',
                    'state': 'string',
                    'startOn': 'string'
                },
            ]
        },
    ]
}

Response Structure

(dict) --
- connections (list) --
  
  The connections.
  - (dict) --
    
    Information about an AWS Direct Connect connection.
    - ownerAccount (string) --
      
      The ID of the AWS account that owns the connection.
    - connectionId (string) --
      
      The ID of the connection.
    - connectionName (string) --
      
      The name of the connection.
    - connectionState (string) --
      
      The state of the connection. The following are the possible values:
      - ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
      - requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
      - pending : The connection has been approved and is being initialized.
      - available : The network link is up and the connection is ready for use.
      - down : The network link is down.
      - deleting : The connection is being deleted.
      - deleted : The connection has been deleted.
      - rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
      - unknown : The state of the connection is not available.
    - region (string) --
      
      The AWS Region where the connection is located.
    - location (string) --
      
      The location of the connection.
    - bandwidth (string) --
      
      The bandwidth of the connection.
    - vlan (integer) --
      
      The ID of the VLAN.
    - partnerName (string) --
      
      The name of the AWS Direct Connect service provider associated with the connection.
    - loaIssueTime (datetime) --
      
      The time of the most recent call to DescribeLoa for this connection.
    - lagId (string) --
      
      The ID of the LAG.
    - awsDevice (string) --
      
      The Direct Connect endpoint on which the physical connection terminates.
    - jumboFrameCapable (boolean) --
      
      Indicates whether jumbo frames (9001 MTU) are supported.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint on which the physical connection terminates.
    - hasLogicalRedundancy (string) --
      
      Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
    - tags (list) --
      
      The tags associated with the connection.
      - (dict) --
        
        Information about a tag.
        
        key (string) --
        
        The key.
        
        value (string) --
        
        The value.
    - providerName (string) --
      
      The name of the service provider associated with the connection.
    - 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.

DescribeHostedConnections (updated)

Link ¶
Changes (response)

{'connections': {'encryptionMode': 'string',
                 'macSecCapable': 'boolean',
                 'macSecKeys': [{'ckn': 'string',
                                 'secretARN': 'string',
                                 'startOn': 'string',
                                 'state': 'string'}],
                 'portEncryptionStatus': 'string'}}

Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG).

Note

Intended for use by AWS Direct Connect Partners only.

See also: AWS API Documentation

Request Syntax

client.describe_hosted_connections(
    connectionId='string'
)

type connectionId

string

param connectionId

[REQUIRED]

The ID of the interconnect or LAG.

rtype

dict

returns

Response Syntax

{
    'connections': [
        {
            'ownerAccount': 'string',
            'connectionId': 'string',
            'connectionName': 'string',
            'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
            'region': 'string',
            'location': 'string',
            'bandwidth': 'string',
            'vlan': 123,
            'partnerName': 'string',
            'loaIssueTime': datetime(2015, 1, 1),
            'lagId': 'string',
            'awsDevice': 'string',
            'jumboFrameCapable': True|False,
            'awsDeviceV2': 'string',
            'hasLogicalRedundancy': 'unknown'|'yes'|'no',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'providerName': 'string',
            'macSecCapable': True|False,
            'portEncryptionStatus': 'string',
            'encryptionMode': 'string',
            'macSecKeys': [
                {
                    'secretARN': 'string',
                    'ckn': 'string',
                    'state': 'string',
                    'startOn': 'string'
                },
            ]
        },
    ]
}

Response Structure

(dict) --
- connections (list) --
  
  The connections.
  - (dict) --
    
    Information about an AWS Direct Connect connection.
    - ownerAccount (string) --
      
      The ID of the AWS account that owns the connection.
    - connectionId (string) --
      
      The ID of the connection.
    - connectionName (string) --
      
      The name of the connection.
    - connectionState (string) --
      
      The state of the connection. The following are the possible values:
      - ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
      - requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
      - pending : The connection has been approved and is being initialized.
      - available : The network link is up and the connection is ready for use.
      - down : The network link is down.
      - deleting : The connection is being deleted.
      - deleted : The connection has been deleted.
      - rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
      - unknown : The state of the connection is not available.
    - region (string) --
      
      The AWS Region where the connection is located.
    - location (string) --
      
      The location of the connection.
    - bandwidth (string) --
      
      The bandwidth of the connection.
    - vlan (integer) --
      
      The ID of the VLAN.
    - partnerName (string) --
      
      The name of the AWS Direct Connect service provider associated with the connection.
    - loaIssueTime (datetime) --
      
      The time of the most recent call to DescribeLoa for this connection.
    - lagId (string) --
      
      The ID of the LAG.
    - awsDevice (string) --
      
      The Direct Connect endpoint on which the physical connection terminates.
    - jumboFrameCapable (boolean) --
      
      Indicates whether jumbo frames (9001 MTU) are supported.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint on which the physical connection terminates.
    - hasLogicalRedundancy (string) --
      
      Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
    - tags (list) --
      
      The tags associated with the connection.
      - (dict) --
        
        Information about a tag.
        
        key (string) --
        
        The key.
        
        value (string) --
        
        The value.
    - providerName (string) --
      
      The name of the service provider associated with the connection.
    - 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.

DescribeLags (updated)

Link ¶
Changes (response)

{'lags': {'connections': {'encryptionMode': 'string',
                          'macSecCapable': 'boolean',
                          'macSecKeys': [{'ckn': 'string',
                                          'secretARN': 'string',
                                          'startOn': 'string',
                                          'state': 'string'}],
                          'portEncryptionStatus': 'string'},
          'encryptionMode': 'string',
          'macSecCapable': 'boolean',
          'macSecKeys': [{'ckn': 'string',
                          'secretARN': 'string',
                          'startOn': 'string',
                          'state': 'string'}]}}

Describes all your link aggregation groups (LAG) or the specified LAG.

See also: AWS API Documentation

Request Syntax

client.describe_lags(
    lagId='string'
)

type lagId

string

param lagId

The ID of the LAG.

rtype

dict

returns

Response Syntax

{
    'lags': [
        {
            'connectionsBandwidth': 'string',
            'numberOfConnections': 123,
            'lagId': 'string',
            'ownerAccount': 'string',
            'lagName': 'string',
            'lagState': 'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'unknown',
            'location': 'string',
            'region': 'string',
            'minimumLinks': 123,
            'awsDevice': 'string',
            'awsDeviceV2': 'string',
            'connections': [
                {
                    'ownerAccount': 'string',
                    'connectionId': 'string',
                    'connectionName': 'string',
                    'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
                    'region': 'string',
                    'location': 'string',
                    'bandwidth': 'string',
                    'vlan': 123,
                    'partnerName': 'string',
                    'loaIssueTime': datetime(2015, 1, 1),
                    'lagId': 'string',
                    'awsDevice': 'string',
                    'jumboFrameCapable': True|False,
                    'awsDeviceV2': 'string',
                    'hasLogicalRedundancy': 'unknown'|'yes'|'no',
                    'tags': [
                        {
                            'key': 'string',
                            'value': 'string'
                        },
                    ],
                    'providerName': 'string',
                    'macSecCapable': True|False,
                    'portEncryptionStatus': 'string',
                    'encryptionMode': 'string',
                    'macSecKeys': [
                        {
                            'secretARN': 'string',
                            'ckn': 'string',
                            'state': 'string',
                            'startOn': 'string'
                        },
                    ]
                },
            ],
            'allowsHostedConnections': True|False,
            'jumboFrameCapable': True|False,
            'hasLogicalRedundancy': 'unknown'|'yes'|'no',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'providerName': 'string',
            'macSecCapable': True|False,
            'encryptionMode': 'string',
            'macSecKeys': [
                {
                    'secretARN': 'string',
                    'ckn': 'string',
                    'state': 'string',
                    'startOn': 'string'
                },
            ]
        },
    ]
}

Response Structure

(dict) --
- lags (list) --
  
  The LAGs.
  - (dict) --
    
    Information about a link aggregation group (LAG).
    - connectionsBandwidth (string) --
      
      The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.
    - numberOfConnections (integer) --
      
      The number of physical dedicated connections bundled by the LAG, up to a maximum of 10.
    - lagId (string) --
      
      The ID of the LAG.
    - ownerAccount (string) --
      
      The ID of the AWS account that owns the LAG.
    - lagName (string) --
      
      The name of the LAG.
    - lagState (string) --
      
      The state of the LAG. The following are the possible values:
      - requested : The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.
      - pending : The LAG has been approved and is being initialized.
      - available : The network link is established and the LAG is ready for use.
      - down : The network link is down.
      - deleting : The LAG is being deleted.
      - deleted : The LAG is deleted.
      - unknown : The state of the LAG is not available.
    - location (string) --
      
      The location of the LAG.
    - region (string) --
      
      The AWS Region where the connection is located.
    - minimumLinks (integer) --
      
      The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.
    - awsDevice (string) --
      
      The AWS Direct Connect endpoint that hosts the LAG.
    - awsDeviceV2 (string) --
      
      The AWS Direct Connect endpoint that hosts the LAG.
    - connections (list) --
      
      The connections bundled by the LAG.
      - (dict) --
        
        Information about an AWS Direct Connect connection.
        
        ownerAccount (string) --
        
        The ID of the AWS account that owns the connection.
        
        connectionId (string) --
        
        The ID of the connection.
        
        connectionName (string) --
        
        The name of the connection.
        
        connectionState (string) --
        
        The state of the connection. The following are the possible values:
        
        ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
        
        requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
        
        pending : The connection has been approved and is being initialized.
        
        available : The network link is up and the connection is ready for use.
        
        down : The network link is down.
        
        deleting : The connection is being deleted.
        
        deleted : The connection has been deleted.
        
        rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
        
        unknown : The state of the connection is not available.
        
        region (string) --
        
        The AWS Region where the connection is located.
        
        location (string) --
        
        The location of the connection.
        
        bandwidth (string) --
        
        The bandwidth of the connection.
        
        vlan (integer) --
        
        The ID of the VLAN.
        
        partnerName (string) --
        
        The name of the AWS Direct Connect service provider associated with the connection.
        
        loaIssueTime (datetime) --
        
        The time of the most recent call to DescribeLoa for this connection.
        
        lagId (string) --
        
        The ID of the LAG.
        
        awsDevice (string) --
        
        The Direct Connect endpoint on which the physical connection terminates.
        
        jumboFrameCapable (boolean) --
        
        Indicates whether jumbo frames (9001 MTU) are supported.
        
        awsDeviceV2 (string) --
        
        The Direct Connect endpoint on which the physical connection terminates.
        
        hasLogicalRedundancy (string) --
        
        Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
        
        tags (list) --
        
        The tags associated with the connection.
        
        (dict) --
        
        Information about a tag.
        
        key (string) --
        
        The key.
        
        value (string) --
        
        The value.
        
        providerName (string) --
        
        The name of the service provider associated with the connection.
        
        macSecCapable (boolean) --
        
        Indicates whether the connection supports MAC Security (MACsec).
        
        portEncryptionStatus (string) --
        
        The MAC Security (MACsec) port link status of the connection.
        
        The valid values are Encryption Up , which means that there is an active Connection Key Name, or Encryption Down .
        
        encryptionMode (string) --
        
        The MAC Security (MACsec) connection encryption mode.
        
        The valid values are no_encrypt , should_encrypt , and must_encrypt .
        
        macSecKeys (list) --
        
        The MAC Security (MACsec) security keys associated with the connection.
        
        (dict) --
        
        Information about the MAC Security (MACsec) secret key.
        
        secretARN (string) --
        
        The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
        
        ckn (string) --
        
        The Connection Key Name (CKN) for the MAC Security secret key.
        
        state (string) --
        
        The state of the MAC Security (MACsec) secret key.
        
        The possible values are:
        
        associating : The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
        
        associated : The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
        
        disassociating : The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
        
        disassociated : The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
        
        startOn (string) --
        
        The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
    - allowsHostedConnections (boolean) --
      
      Indicates whether the LAG can host other connections.
    - jumboFrameCapable (boolean) --
      
      Indicates whether jumbo frames (9001 MTU) are supported.
    - hasLogicalRedundancy (string) --
      
      Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).
    - tags (list) --
      
      The tags associated with the LAG.
      - (dict) --
        
        Information about a tag.
        
        key (string) --
        
        The key.
        
        value (string) --
        
        The value.
    - providerName (string) --
      
      The name of the service provider associated with the LAG.
    - macSecCapable (boolean) --
      
      Indicates whether the LAG supports MAC Security (MACsec).
    - encryptionMode (string) --
      
      The LAG MAC Security (MACsec) encryption mode.
      
      The valid values are no_encrypt , should_encrypt , and must_encrypt .
    - macSecKeys (list) --
      
      The MAC Security (MACsec) security keys associated with the LAG.
      - (dict) --
        
        Information about the MAC Security (MACsec) secret key.
        
        secretARN (string) --
        
        The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
        
        ckn (string) --
        
        The Connection Key Name (CKN) for the MAC Security secret key.
        
        state (string) --
        
        The state of the MAC Security (MACsec) secret key.
        
        The possible values are:
        
        associating : The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
        
        associated : The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
        
        disassociating : The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
        
        disassociated : The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
        
        startOn (string) --
        
        The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.

DescribeLocations (updated)

Link ¶
Changes (response)

{'locations': {'availableMacSecPortSpeeds': ['string']}}

Lists the AWS Direct Connect locations in the current AWS Region. These are the locations that can be selected when calling CreateConnection or CreateInterconnect .

See also: AWS API Documentation

Request Syntax

client.describe_locations()

rtype

dict

returns

Response Syntax

{
    'locations': [
        {
            'locationCode': 'string',
            'locationName': 'string',
            'region': 'string',
            'availablePortSpeeds': [
                'string',
            ],
            'availableProviders': [
                'string',
            ],
            'availableMacSecPortSpeeds': [
                'string',
            ]
        },
    ]
}

Response Structure

(dict) --
- locations (list) --
  
  The locations.
  - (dict) --
    
    Information about an AWS Direct Connect location.
    - locationCode (string) --
      
      The code for the location.
    - locationName (string) --
      
      The name of the location. This includes the name of the colocation partner and the physical site of the building.
    - region (string) --
      
      The AWS Region for the location.
    - availablePortSpeeds (list) --
      
      The available port speeds for the location.
      - (string) --
    - availableProviders (list) --
      
      The name of the service provider for the location.
      - (string) --
    - availableMacSecPortSpeeds (list) --
      
      The available MAC Security (MACsec) port speeds for the location.
      - (string) --

DisassociateConnectionFromLag (updated)

Link ¶
Changes (response)

{'encryptionMode': 'string',
 'macSecCapable': 'boolean',
 'macSecKeys': [{'ckn': 'string',
                 'secretARN': 'string',
                 'startOn': 'string',
                 'state': 'string'}],
 'portEncryptionStatus': 'string'}

Disassociates a connection from a link aggregation group (LAG). The connection is interrupted and re-established as a standalone connection (the connection is not deleted; to delete the connection, use the DeleteConnection request). If the LAG has associated virtual interfaces or hosted connections, they remain associated with the LAG. A disassociated connection owned by an AWS Direct Connect Partner is automatically converted to an interconnect.

If disassociating the connection would cause the LAG to fall below its setting for minimum number of operational connections, the request fails, except when it's the last member of the LAG. If all connections are disassociated, the LAG continues to exist as an empty LAG with no physical connections.

See also: AWS API Documentation

Request Syntax

client.disassociate_connection_from_lag(
    connectionId='string',
    lagId='string'
)

type connectionId

string

param connectionId

[REQUIRED]

The ID of the connection.

type lagId

string

param lagId

[REQUIRED]

The ID of the LAG.

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'connectionId': 'string',
    'connectionName': 'string',
    'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
    'region': 'string',
    'location': 'string',
    'bandwidth': 'string',
    'vlan': 123,
    'partnerName': 'string',
    'loaIssueTime': datetime(2015, 1, 1),
    'lagId': 'string',
    'awsDevice': 'string',
    'jumboFrameCapable': True|False,
    'awsDeviceV2': 'string',
    'hasLogicalRedundancy': 'unknown'|'yes'|'no',
    'tags': [
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    'providerName': 'string',
    'macSecCapable': True|False,
    'portEncryptionStatus': 'string',
    'encryptionMode': 'string',
    'macSecKeys': [
        {
            'secretARN': 'string',
            'ckn': 'string',
            'state': 'string',
            'startOn': 'string'
        },
    ]
}

Response Structure

(dict) --

Information about an AWS Direct Connect connection.
- ownerAccount (string) --
  
  The ID of the AWS account that owns the connection.
- connectionId (string) --
  
  The ID of the connection.
- connectionName (string) --
  
  The name of the connection.
- connectionState (string) --
  
  The state of the connection. The following are the possible values:
  - ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
  - requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  - pending : The connection has been approved and is being initialized.
  - available : The network link is up and the connection is ready for use.
  - down : The network link is down.
  - deleting : The connection is being deleted.
  - deleted : The connection has been deleted.
  - rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
  - unknown : The state of the connection is not available.
- region (string) --
  
  The AWS Region where the connection is located.
- location (string) --
  
  The location of the connection.
- bandwidth (string) --
  
  The bandwidth of the connection.
- vlan (integer) --
  
  The ID of the VLAN.
- partnerName (string) --
  
  The name of the AWS Direct Connect service provider associated with the connection.
- loaIssueTime (datetime) --
  
  The time of the most recent call to DescribeLoa for this connection.
- lagId (string) --
  
  The ID of the LAG.
- awsDevice (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames (9001 MTU) are supported.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.
- hasLogicalRedundancy (string) --
  
  Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
- tags (list) --
  
  The tags associated with the connection.
  - (dict) --
    
    Information about a tag.
    - key (string) --
      
      The key.
    - value (string) --
      
      The value.
- providerName (string) --
  
  The name of the service provider associated with the connection.
- 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.

UpdateConnection (updated)

Link ¶
Changes (response)

{'encryptionMode': 'string',
 'macSecCapable': 'boolean',
 'macSecKeys': [{'ckn': 'string',
                 'secretARN': 'string',
                 'startOn': 'string',
                 'state': 'string'}],
 'portEncryptionStatus': 'string'}

Updates the AWS Direct Connect dedicated connection configuration.

You can update the following parameters for a connection:

The connection name
The connection's MAC Security (MACsec) encryption mode.

See also: AWS API Documentation

Request Syntax

client.update_connection(
    connectionId='string',
    connectionName='string',
    encryptionMode='string'
)

type connectionId

string

param connectionId

[REQUIRED]

The ID of the dedicated connection.

You can use DescribeConnections to retrieve the connection ID.

type connectionName

string

param connectionName

The name of the connection.

type encryptionMode

string

param encryptionMode

The connection MAC Security (MACsec) encryption mode.

The valid values are no_encrypt , should_encrypt , and must_encrypt .

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'connectionId': 'string',
    'connectionName': 'string',
    'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
    'region': 'string',
    'location': 'string',
    'bandwidth': 'string',
    'vlan': 123,
    'partnerName': 'string',
    'loaIssueTime': datetime(2015, 1, 1),
    'lagId': 'string',
    'awsDevice': 'string',
    'jumboFrameCapable': True|False,
    'awsDeviceV2': 'string',
    'hasLogicalRedundancy': 'unknown'|'yes'|'no',
    'tags': [
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    'providerName': 'string',
    'macSecCapable': True|False,
    'portEncryptionStatus': 'string',
    'encryptionMode': 'string',
    'macSecKeys': [
        {
            'secretARN': 'string',
            'ckn': 'string',
            'state': 'string',
            'startOn': 'string'
        },
    ]
}

Response Structure

(dict) --

Information about an AWS Direct Connect connection.
- ownerAccount (string) --
  
  The ID of the AWS account that owns the connection.
- connectionId (string) --
  
  The ID of the connection.
- connectionName (string) --
  
  The name of the connection.
- connectionState (string) --
  
  The state of the connection. The following are the possible values:
  - ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
  - requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  - pending : The connection has been approved and is being initialized.
  - available : The network link is up and the connection is ready for use.
  - down : The network link is down.
  - deleting : The connection is being deleted.
  - deleted : The connection has been deleted.
  - rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
  - unknown : The state of the connection is not available.
- region (string) --
  
  The AWS Region where the connection is located.
- location (string) --
  
  The location of the connection.
- bandwidth (string) --
  
  The bandwidth of the connection.
- vlan (integer) --
  
  The ID of the VLAN.
- partnerName (string) --
  
  The name of the AWS Direct Connect service provider associated with the connection.
- loaIssueTime (datetime) --
  
  The time of the most recent call to DescribeLoa for this connection.
- lagId (string) --
  
  The ID of the LAG.
- awsDevice (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames (9001 MTU) are supported.
- awsDeviceV2 (string) --
  
  The Direct Connect endpoint on which the physical connection terminates.
- hasLogicalRedundancy (string) --
  
  Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
- tags (list) --
  
  The tags associated with the connection.
  - (dict) --
    
    Information about a tag.
    - key (string) --
      
      The key.
    - value (string) --
      
      The value.
- providerName (string) --
  
  The name of the service provider associated with the connection.
- 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.

UpdateLag (updated)

Link ¶
Changes (request, response)
Request

{'encryptionMode': 'string'}

Response

{'connections': {'encryptionMode': 'string',
                 'macSecCapable': 'boolean',
                 'macSecKeys': [{'ckn': 'string',
                                 'secretARN': 'string',
                                 'startOn': 'string',
                                 'state': 'string'}],
                 'portEncryptionStatus': 'string'},
 'encryptionMode': 'string',
 'macSecCapable': 'boolean',
 'macSecKeys': [{'ckn': 'string',
                 'secretARN': 'string',
                 'startOn': 'string',
                 'state': 'string'}]}

Updates the attributes of the specified link aggregation group (LAG).

You can update the following LAG attributes:

The name of the LAG.
The value for the minimum number of connections that must be operational for the LAG itself to be operational.
The LAG's MACsec encryption mode. AWS assigns this value to each connection which is part of the LAG.
The tags

Note

If you adjust the threshold value for the minimum number of operational connections, ensure that the new value does not cause the LAG to fall below the threshold and become non-operational.

See also: AWS API Documentation

Request Syntax

client.update_lag(
    lagId='string',
    lagName='string',
    minimumLinks=123,
    encryptionMode='string'
)

type lagId

string

param lagId

[REQUIRED]

The ID of the LAG.

type lagName

string

param lagName

The name of the LAG.

type minimumLinks

integer

param minimumLinks

The minimum number of physical connections that must be operational for the LAG itself to be operational.

type encryptionMode

string

param encryptionMode

The LAG MAC Security (MACsec) encryption mode.

AWS applies the value to all connections which are part of the LAG.

rtype

dict

returns

Response Syntax

{
    'connectionsBandwidth': 'string',
    'numberOfConnections': 123,
    'lagId': 'string',
    'ownerAccount': 'string',
    'lagName': 'string',
    'lagState': 'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'unknown',
    'location': 'string',
    'region': 'string',
    'minimumLinks': 123,
    'awsDevice': 'string',
    'awsDeviceV2': 'string',
    'connections': [
        {
            'ownerAccount': 'string',
            'connectionId': 'string',
            'connectionName': 'string',
            'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown',
            'region': 'string',
            'location': 'string',
            'bandwidth': 'string',
            'vlan': 123,
            'partnerName': 'string',
            'loaIssueTime': datetime(2015, 1, 1),
            'lagId': 'string',
            'awsDevice': 'string',
            'jumboFrameCapable': True|False,
            'awsDeviceV2': 'string',
            'hasLogicalRedundancy': 'unknown'|'yes'|'no',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'providerName': 'string',
            'macSecCapable': True|False,
            'portEncryptionStatus': 'string',
            'encryptionMode': 'string',
            'macSecKeys': [
                {
                    'secretARN': 'string',
                    'ckn': 'string',
                    'state': 'string',
                    'startOn': 'string'
                },
            ]
        },
    ],
    'allowsHostedConnections': True|False,
    'jumboFrameCapable': True|False,
    'hasLogicalRedundancy': 'unknown'|'yes'|'no',
    'tags': [
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    'providerName': 'string',
    'macSecCapable': True|False,
    'encryptionMode': 'string',
    'macSecKeys': [
        {
            'secretARN': 'string',
            'ckn': 'string',
            'state': 'string',
            'startOn': 'string'
        },
    ]
}

Response Structure

(dict) --

Information about a link aggregation group (LAG).
- connectionsBandwidth (string) --
  
  The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.
- numberOfConnections (integer) --
  
  The number of physical dedicated connections bundled by the LAG, up to a maximum of 10.
- lagId (string) --
  
  The ID of the LAG.
- ownerAccount (string) --
  
  The ID of the AWS account that owns the LAG.
- lagName (string) --
  
  The name of the LAG.
- lagState (string) --
  
  The state of the LAG. The following are the possible values:
  - requested : The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.
  - pending : The LAG has been approved and is being initialized.
  - available : The network link is established and the LAG is ready for use.
  - down : The network link is down.
  - deleting : The LAG is being deleted.
  - deleted : The LAG is deleted.
  - unknown : The state of the LAG is not available.
- location (string) --
  
  The location of the LAG.
- region (string) --
  
  The AWS Region where the connection is located.
- minimumLinks (integer) --
  
  The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.
- awsDevice (string) --
  
  The AWS Direct Connect endpoint that hosts the LAG.
- awsDeviceV2 (string) --
  
  The AWS Direct Connect endpoint that hosts the LAG.
- connections (list) --
  
  The connections bundled by the LAG.
  - (dict) --
    
    Information about an AWS Direct Connect connection.
    - ownerAccount (string) --
      
      The ID of the AWS account that owns the connection.
    - connectionId (string) --
      
      The ID of the connection.
    - connectionName (string) --
      
      The name of the connection.
    - connectionState (string) --
      
      The state of the connection. The following are the possible values:
      - ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
      - requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
      - pending : The connection has been approved and is being initialized.
      - available : The network link is up and the connection is ready for use.
      - down : The network link is down.
      - deleting : The connection is being deleted.
      - deleted : The connection has been deleted.
      - rejected : A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
      - unknown : The state of the connection is not available.
    - region (string) --
      
      The AWS Region where the connection is located.
    - location (string) --
      
      The location of the connection.
    - bandwidth (string) --
      
      The bandwidth of the connection.
    - vlan (integer) --
      
      The ID of the VLAN.
    - partnerName (string) --
      
      The name of the AWS Direct Connect service provider associated with the connection.
    - loaIssueTime (datetime) --
      
      The time of the most recent call to DescribeLoa for this connection.
    - lagId (string) --
      
      The ID of the LAG.
    - awsDevice (string) --
      
      The Direct Connect endpoint on which the physical connection terminates.
    - jumboFrameCapable (boolean) --
      
      Indicates whether jumbo frames (9001 MTU) are supported.
    - awsDeviceV2 (string) --
      
      The Direct Connect endpoint on which the physical connection terminates.
    - hasLogicalRedundancy (string) --
      
      Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
    - tags (list) --
      
      The tags associated with the connection.
      - (dict) --
        
        Information about a tag.
        
        key (string) --
        
        The key.
        
        value (string) --
        
        The value.
    - providerName (string) --
      
      The name of the service provider associated with the connection.
    - macSecCapable (boolean) --
      
      Indicates whether the connection supports MAC Security (MACsec).
    - portEncryptionStatus (string) --
      
      The MAC Security (MACsec) port link status of the connection.
      
      The valid values are Encryption Up , which means that there is an active Connection Key Name, or Encryption Down .
    - encryptionMode (string) --
      
      The MAC Security (MACsec) connection encryption mode.
      
      The valid values are no_encrypt , should_encrypt , and must_encrypt .
    - macSecKeys (list) --
      
      The MAC Security (MACsec) security keys associated with the connection.
      - (dict) --
        
        Information about the MAC Security (MACsec) secret key.
        
        secretARN (string) --
        
        The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
        
        ckn (string) --
        
        The Connection Key Name (CKN) for the MAC Security secret key.
        
        state (string) --
        
        The state of the MAC Security (MACsec) secret key.
        
        The possible values are:
        
        associating : The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
        
        associated : The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
        
        disassociating : The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
        
        disassociated : The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
        
        startOn (string) --
        
        The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
- allowsHostedConnections (boolean) --
  
  Indicates whether the LAG can host other connections.
- jumboFrameCapable (boolean) --
  
  Indicates whether jumbo frames (9001 MTU) are supported.
- hasLogicalRedundancy (string) --
  
  Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).
- tags (list) --
  
  The tags associated with the LAG.
  - (dict) --
    
    Information about a tag.
    - key (string) --
      
      The key.
    - value (string) --
      
      The value.
- providerName (string) --
  
  The name of the service provider associated with the LAG.
- macSecCapable (boolean) --
  
  Indicates whether the LAG supports MAC Security (MACsec).
- encryptionMode (string) --
  
  The LAG MAC Security (MACsec) encryption mode.
  
  The valid values are no_encrypt , should_encrypt , and must_encrypt .
- macSecKeys (list) --
  
  The MAC Security (MACsec) security keys associated with the LAG.
  - (dict) --
    
    Information about the MAC Security (MACsec) secret key.
    - secretARN (string) --
      
      The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
    - ckn (string) --
      
      The Connection Key Name (CKN) for the MAC Security secret key.
    - state (string) --
      
      The state of the MAC Security (MACsec) secret key.
      
      The possible values are:
      - associating : The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
      - associated : The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
      - disassociating : The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
      - disassociated : The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
    - startOn (string) --
      
      The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.