AWS Direct Connect

{'awsDeviceV2': 'string'}

Deprecated in favor of AllocateHostedConnection .

Creates a hosted connection on an interconnect.

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

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]

Bandwidth of the connection.

Example: "500Mbps "

Default: None

Values: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, or 500Mbps

type connectionName

string

param connectionName

[REQUIRED]

Name of the provisioned connection.

Example: "500M Connection to AWS "

Default: None

type ownerAccount

string

param ownerAccount

[REQUIRED]

Numeric account Id of the customer for whom the connection will be provisioned.

Example: 123443215678

Default: None

type interconnectId

string

param interconnectId

[REQUIRED]

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

Example: dxcon-456abc78

Default: None

type vlan

integer

param vlan

[REQUIRED]

The dedicated VLAN provisioned to the connection.

Example: 101

Default: None

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'connectionId': 'string',
    'connectionName': 'string',
    'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
    'region': 'string',
    'location': 'string',
    'bandwidth': 'string',
    'vlan': 123,
    'partnerName': 'string',
    'loaIssueTime': datetime(2015, 1, 1),
    'lagId': 'string',
    'awsDevice': 'string',
    'awsDeviceV2': 'string'
}

Response Structure

• (dict) --

  A connection represents the physical network connection between the AWS Direct Connect location and the customer.

  • ownerAccount (string) --

    The AWS account that will own the new connection.

  • connectionId (string) --

    The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

    Example: dxcon-fg5678gh

    Default: None

  • connectionName (string) --

    The name of the connection.

    Example: "My Connection to AWS "

    Default: None

  • connectionState (string) --

    State of the connection.

    • Ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

    • Requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

    • Pending : The connection has been approved, and is being initialized.

    • Available : The network link is up, and the connection is ready for use.

    • Down : The network link is down.

    • Deleting : The connection is in the process of being deleted.

    • Deleted : The connection has been deleted.

    • Rejected : A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

  • region (string) --

    The AWS region where the connection is located.

    Example: us-east-1

    Default: None

  • location (string) --

    Where the connection is located.

    Example: EqSV5

    Default: None

  • bandwidth (string) --

    Bandwidth of the connection.

    Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

    Default: None

  • vlan (integer) --

    The VLAN ID.

    Example: 101

  • partnerName (string) --

    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.

    Example: dxlag-fg5678gh

  • awsDevice (string) --

    Deprecated in favor of awsDeviceV2.

    The Direct Connection endpoint which the physical connection terminates on.

  • awsDeviceV2 (string) --

    The Direct Connection endpoint which the physical connection terminates on.

{'awsDeviceV2': 'string'}

Creates a hosted connection on an interconnect or a link aggregation group (LAG).

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

See also: AWS API Documentation

Request Syntax

client.allocate_hosted_connection(
    connectionId='string',
    ownerAccount='string',
    bandwidth='string',
    connectionName='string',
    vlan=123
)

type connectionId

string

param connectionId

[REQUIRED]

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

Example: dxcon-456abc78 or dxlag-abc123

Default: None

type ownerAccount

string

param ownerAccount

[REQUIRED]

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

Example: 123443215678

Default: None

type bandwidth

string

param bandwidth

[REQUIRED]

The bandwidth of the connection.

Example: 500Mbps

Default: None

Values: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, or 500Mbps

type connectionName

string

param connectionName

[REQUIRED]

The name of the provisioned connection.

Example: "500M Connection to AWS "

Default: None

type vlan

integer

param vlan

[REQUIRED]

The dedicated VLAN provisioned to the hosted connection.

Example: 101

Default: None

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'connectionId': 'string',
    'connectionName': 'string',
    'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
    'region': 'string',
    'location': 'string',
    'bandwidth': 'string',
    'vlan': 123,
    'partnerName': 'string',
    'loaIssueTime': datetime(2015, 1, 1),
    'lagId': 'string',
    'awsDevice': 'string',
    'awsDeviceV2': 'string'
}

Response Structure

• (dict) --

  A connection represents the physical network connection between the AWS Direct Connect location and the customer.

  • ownerAccount (string) --

    The AWS account that will own the new connection.

  • connectionId (string) --

    The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

    Example: dxcon-fg5678gh

    Default: None

  • connectionName (string) --

    The name of the connection.

    Example: "My Connection to AWS "

    Default: None

  • connectionState (string) --

    State of the connection.

    • Ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

    • Requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

    • Pending : The connection has been approved, and is being initialized.

    • Available : The network link is up, and the connection is ready for use.

    • Down : The network link is down.

    • Deleting : The connection is in the process of being deleted.

    • Deleted : The connection has been deleted.

    • Rejected : A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

  • region (string) --

    The AWS region where the connection is located.

    Example: us-east-1

    Default: None

  • location (string) --

    Where the connection is located.

    Example: EqSV5

    Default: None

  • bandwidth (string) --

    Bandwidth of the connection.

    Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

    Default: None

  • vlan (integer) --

    The VLAN ID.

    Example: 101

  • partnerName (string) --

    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.

    Example: dxlag-fg5678gh

  • awsDevice (string) --

    Deprecated in favor of awsDeviceV2.

    The Direct Connection endpoint which the physical connection terminates on.

  • awsDeviceV2 (string) --

    The Direct Connection endpoint which the physical connection terminates on.

{'awsDeviceV2': 'string',
 'bgpPeers': {'awsDeviceV2': 'string'},
 'region': 'string'}

Provisions a private virtual interface to be owned by another AWS customer.

Virtual interfaces created using this action must be confirmed by the virtual interface owner by using the ConfirmPrivateVirtualInterface action. Until then, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic.

See also: AWS API Documentation

Request Syntax

client.allocate_private_virtual_interface(
    connectionId='string',
    ownerAccount='string',
    newPrivateVirtualInterfaceAllocation={
        'virtualInterfaceName': 'string',
        'vlan': 123,
        'asn': 123,
        'authKey': 'string',
        'amazonAddress': 'string',
        'addressFamily': 'ipv4'|'ipv6',
        'customerAddress': 'string'
    }
)

type connectionId

string

param connectionId

[REQUIRED]

The connection ID on which the private virtual interface is provisioned.

Default: None

type ownerAccount

string

param ownerAccount

[REQUIRED]

The AWS account that will own the new private virtual interface.

Default: None

type newPrivateVirtualInterfaceAllocation

dict

param newPrivateVirtualInterfaceAllocation

[REQUIRED]

Detailed information for the private virtual interface to be provisioned.

Default: None

• virtualInterfaceName (string) -- [REQUIRED]

  The name of the virtual interface assigned by the customer.

  Example: "My VPC"

• vlan (integer) -- [REQUIRED]

  The VLAN ID.

  Example: 101

• asn (integer) -- [REQUIRED]

  The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

  Example: 65000

• authKey (string) --

  The authentication key for BGP configuration.

  Example: asdf34example

• amazonAddress (string) --

  IP address assigned to the Amazon interface.

  Example: 192.168.1.1/30 or 2001:db8::1/125

• addressFamily (string) --

  Indicates the address family for the BGP peer.

  • ipv4 : IPv4 address family

  • ipv6 : IPv6 address family

• customerAddress (string) --

  IP address assigned to the customer interface.

  Example: 192.168.1.2/30 or 2001:db8::2/125

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'virtualInterfaceId': 'string',
    'location': 'string',
    'connectionId': 'string',
    'virtualInterfaceType': 'string',
    'virtualInterfaceName': 'string',
    'vlan': 123,
    'asn': 123,
    'amazonSideAsn': 123,
    'authKey': 'string',
    'amazonAddress': 'string',
    'customerAddress': 'string',
    'addressFamily': 'ipv4'|'ipv6',
    'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
    'customerRouterConfig': 'string',
    'virtualGatewayId': 'string',
    'directConnectGatewayId': 'string',
    'routeFilterPrefixes': [
        {
            'cidr': 'string'
        },
    ],
    'bgpPeers': [
        {
            'asn': 123,
            'authKey': 'string',
            'addressFamily': 'ipv4'|'ipv6',
            'amazonAddress': 'string',
            'customerAddress': 'string',
            'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
            'bgpStatus': 'up'|'down',
            'awsDeviceV2': 'string'
        },
    ],
    'region': 'string',
    'awsDeviceV2': 'string'
}

Response Structure

• (dict) --

  A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

  • ownerAccount (string) --

    The AWS account that will own the new virtual interface.

  • virtualInterfaceId (string) --

    The ID of the virtual interface.

    Example: dxvif-123dfg56

    Default: None

  • location (string) --

    Where the connection is located.

    Example: EqSV5

    Default: None

  • connectionId (string) --

    The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

    Example: dxcon-fg5678gh

    Default: None

  • virtualInterfaceType (string) --

    The type of virtual interface.

    Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)

  • virtualInterfaceName (string) --

    The name of the virtual interface assigned by the customer.

    Example: "My VPC"

  • vlan (integer) --

    The VLAN ID.

    Example: 101

  • asn (integer) --

    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

    Example: 65000

  • amazonSideAsn (integer) --

    The autonomous system number (ASN) for the Amazon side of the connection.

  • authKey (string) --

    The authentication key for BGP configuration.

    Example: asdf34example

  • amazonAddress (string) --

    IP address assigned to the Amazon interface.

    Example: 192.168.1.1/30 or 2001:db8::1/125

  • customerAddress (string) --

    IP address assigned to the customer interface.

    Example: 192.168.1.2/30 or 2001:db8::2/125

  • addressFamily (string) --

    Indicates the address family for the BGP peer.

    • ipv4 : IPv4 address family

    • ipv6 : IPv6 address family

  • virtualInterfaceState (string) --

    State of the virtual interface.

    • Confirming : The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

    • Verifying : This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

    • Pending : A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

    • Available : A virtual interface that is able to forward traffic.

    • Down : A virtual interface that is BGP down.

    • Deleting : A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

    • Deleted : A virtual interface that cannot forward traffic.

    • Rejected : The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.

  • customerRouterConfig (string) --

    Information for generating the customer router configuration.

  • virtualGatewayId (string) --

    The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

    Example: vgw-123er56

  • directConnectGatewayId (string) --

    The ID of the direct connect gateway.

    Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

  • routeFilterPrefixes (list) --

    A list of routes to be advertised to the AWS network in this region (public virtual interface).

    • (dict) --

      A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

      • cidr (string) --

        CIDR notation for the advertised route. Multiple routes are separated by commas.

        IPv6 CIDRs must be at least a /64 or shorter

        Example: 10.10.10.0/24,10.10.11.0/24,2001:db8::/64

  • bgpPeers (list) --

    A list of the BGP peers configured on this virtual interface.

    • (dict) --

      A structure containing information about a BGP peer.

      • asn (integer) --

        The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

        Example: 65000

      • authKey (string) --

        The authentication key for BGP configuration.

        Example: asdf34example

      • addressFamily (string) --

        Indicates the address family for the BGP peer.

        • ipv4 : IPv4 address family

        • ipv6 : IPv6 address family

      • amazonAddress (string) --

        IP address assigned to the Amazon interface.

        Example: 192.168.1.1/30 or 2001:db8::1/125

      • customerAddress (string) --

        IP address assigned to the customer interface.

        Example: 192.168.1.2/30 or 2001:db8::2/125

      • bgpPeerState (string) --

        The state of the BGP peer.

        • Verifying : The BGP peering addresses or ASN require validation before the BGP peer can be created. This state only applies to BGP peers on a public virtual interface.

        • Pending : The BGP peer has been created, and is in this state until it is ready to be established.

        • Available : The BGP peer can be established.

        • Deleting : The BGP peer is in the process of being deleted.

        • Deleted : The BGP peer has been deleted and cannot be established.

      • bgpStatus (string) --

        The Up/Down state of the BGP peer.

        • Up : The BGP peer is established.

        Note

        A state of up does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.

        • Down : The BGP peer is down.

      • awsDeviceV2 (string) --

        The Direct Connection endpoint which the BGP peer terminates on.

  • region (string) --

    The AWS region where the virtual interface is located.

    Example: us-east-1

    Default: None

  • awsDeviceV2 (string) --

    The Direct Connection endpoint which the virtual interface terminates on.

{'awsDeviceV2': 'string',
 'bgpPeers': {'awsDeviceV2': 'string'},
 'region': 'string'}

Provisions a public virtual interface to be owned by a different customer.

The owner of a connection calls this function to provision a public virtual interface which will be owned by another AWS customer.

Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic.

When creating an IPv6 public virtual interface (addressFamily is 'ipv6'), the customer and amazon address fields should be left blank to use auto-assigned IPv6 space. Custom IPv6 Addresses are currently not supported.

See also: AWS API Documentation

Request Syntax

client.allocate_public_virtual_interface(
    connectionId='string',
    ownerAccount='string',
    newPublicVirtualInterfaceAllocation={
        'virtualInterfaceName': 'string',
        'vlan': 123,
        'asn': 123,
        'authKey': 'string',
        'amazonAddress': 'string',
        'customerAddress': 'string',
        'addressFamily': 'ipv4'|'ipv6',
        'routeFilterPrefixes': [
            {
                'cidr': 'string'
            },
        ]
    }
)

type connectionId

string

param connectionId

[REQUIRED]

The connection ID on which the public virtual interface is provisioned.

Default: None

type ownerAccount

string

param ownerAccount

[REQUIRED]

The AWS account that will own the new public virtual interface.

Default: None

type newPublicVirtualInterfaceAllocation

dict

param newPublicVirtualInterfaceAllocation

[REQUIRED]

Detailed information for the public virtual interface to be provisioned.

Default: None

• virtualInterfaceName (string) -- [REQUIRED]

  The name of the virtual interface assigned by the customer.

  Example: "My VPC"

• vlan (integer) -- [REQUIRED]

  The VLAN ID.

  Example: 101

• asn (integer) -- [REQUIRED]

  The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

  Example: 65000

• authKey (string) --

  The authentication key for BGP configuration.

  Example: asdf34example

• amazonAddress (string) --

  IP address assigned to the Amazon interface.

  Example: 192.168.1.1/30 or 2001:db8::1/125

• customerAddress (string) --

  IP address assigned to the customer interface.

  Example: 192.168.1.2/30 or 2001:db8::2/125

• addressFamily (string) --

  Indicates the address family for the BGP peer.

  • ipv4 : IPv4 address family

  • ipv6 : IPv6 address family

• routeFilterPrefixes (list) --

  A list of routes to be advertised to the AWS network in this region (public virtual interface).

  • (dict) --

    A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

    • cidr (string) --

      CIDR notation for the advertised route. Multiple routes are separated by commas.

      IPv6 CIDRs must be at least a /64 or shorter

      Example: 10.10.10.0/24,10.10.11.0/24,2001:db8::/64

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'virtualInterfaceId': 'string',
    'location': 'string',
    'connectionId': 'string',
    'virtualInterfaceType': 'string',
    'virtualInterfaceName': 'string',
    'vlan': 123,
    'asn': 123,
    'amazonSideAsn': 123,
    'authKey': 'string',
    'amazonAddress': 'string',
    'customerAddress': 'string',
    'addressFamily': 'ipv4'|'ipv6',
    'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
    'customerRouterConfig': 'string',
    'virtualGatewayId': 'string',
    'directConnectGatewayId': 'string',
    'routeFilterPrefixes': [
        {
            'cidr': 'string'
        },
    ],
    'bgpPeers': [
        {
            'asn': 123,
            'authKey': 'string',
            'addressFamily': 'ipv4'|'ipv6',
            'amazonAddress': 'string',
            'customerAddress': 'string',
            'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
            'bgpStatus': 'up'|'down',
            'awsDeviceV2': 'string'
        },
    ],
    'region': 'string',
    'awsDeviceV2': 'string'
}

Response Structure

• (dict) --

  A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

  • ownerAccount (string) --

    The AWS account that will own the new virtual interface.

  • virtualInterfaceId (string) --

    The ID of the virtual interface.

    Example: dxvif-123dfg56

    Default: None

  • location (string) --

    Where the connection is located.

    Example: EqSV5

    Default: None

  • connectionId (string) --

    The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

    Example: dxcon-fg5678gh

    Default: None

  • virtualInterfaceType (string) --

    The type of virtual interface.

    Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)

  • virtualInterfaceName (string) --

    The name of the virtual interface assigned by the customer.

    Example: "My VPC"

  • vlan (integer) --

    The VLAN ID.

    Example: 101

  • asn (integer) --

    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

    Example: 65000

  • amazonSideAsn (integer) --

    The autonomous system number (ASN) for the Amazon side of the connection.

  • authKey (string) --

    The authentication key for BGP configuration.

    Example: asdf34example

  • amazonAddress (string) --

    IP address assigned to the Amazon interface.

    Example: 192.168.1.1/30 or 2001:db8::1/125

  • customerAddress (string) --

    IP address assigned to the customer interface.

    Example: 192.168.1.2/30 or 2001:db8::2/125

  • addressFamily (string) --

    Indicates the address family for the BGP peer.

    • ipv4 : IPv4 address family

    • ipv6 : IPv6 address family

  • virtualInterfaceState (string) --

    State of the virtual interface.

    • Confirming : The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

    • Verifying : This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

    • Pending : A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

    • Available : A virtual interface that is able to forward traffic.

    • Down : A virtual interface that is BGP down.

    • Deleting : A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

    • Deleted : A virtual interface that cannot forward traffic.

    • Rejected : The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.

  • customerRouterConfig (string) --

    Information for generating the customer router configuration.

  • virtualGatewayId (string) --

    The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

    Example: vgw-123er56

  • directConnectGatewayId (string) --

    The ID of the direct connect gateway.

    Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

  • routeFilterPrefixes (list) --

    A list of routes to be advertised to the AWS network in this region (public virtual interface).

    • (dict) --

      A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

      • cidr (string) --

        CIDR notation for the advertised route. Multiple routes are separated by commas.

        IPv6 CIDRs must be at least a /64 or shorter

        Example: 10.10.10.0/24,10.10.11.0/24,2001:db8::/64

  • bgpPeers (list) --

    A list of the BGP peers configured on this virtual interface.

    • (dict) --

      A structure containing information about a BGP peer.

      • asn (integer) --

        The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

        Example: 65000

      • authKey (string) --

        The authentication key for BGP configuration.

        Example: asdf34example

      • addressFamily (string) --

        Indicates the address family for the BGP peer.

        • ipv4 : IPv4 address family

        • ipv6 : IPv6 address family

      • amazonAddress (string) --

        IP address assigned to the Amazon interface.

        Example: 192.168.1.1/30 or 2001:db8::1/125

      • customerAddress (string) --

        IP address assigned to the customer interface.

        Example: 192.168.1.2/30 or 2001:db8::2/125

      • bgpPeerState (string) --

        The state of the BGP peer.

        • Verifying : The BGP peering addresses or ASN require validation before the BGP peer can be created. This state only applies to BGP peers on a public virtual interface.

        • Pending : The BGP peer has been created, and is in this state until it is ready to be established.

        • Available : The BGP peer can be established.

        • Deleting : The BGP peer is in the process of being deleted.

        • Deleted : The BGP peer has been deleted and cannot be established.

      • bgpStatus (string) --

        The Up/Down state of the BGP peer.

        • Up : The BGP peer is established.

        Note

        A state of up does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.

        • Down : The BGP peer is down.

      • awsDeviceV2 (string) --

        The Direct Connection endpoint which the BGP peer terminates on.

  • region (string) --

    The AWS region where the virtual interface is located.

    Example: us-east-1

    Default: None

  • awsDeviceV2 (string) --

    The Direct Connection endpoint which the virtual interface terminates on.

{'awsDeviceV2': '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 will be 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 reassociate a connection that's currently associated with a different LAG; however, if removing the connection will 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.

Example: dxcon-abc123

Default: None

type lagId

string

param lagId

[REQUIRED]

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

Example: dxlag-abc123

Default: None

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'connectionId': 'string',
    'connectionName': 'string',
    'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
    'region': 'string',
    'location': 'string',
    'bandwidth': 'string',
    'vlan': 123,
    'partnerName': 'string',
    'loaIssueTime': datetime(2015, 1, 1),
    'lagId': 'string',
    'awsDevice': 'string',
    'awsDeviceV2': 'string'
}

Response Structure

• (dict) --

  A connection represents the physical network connection between the AWS Direct Connect location and the customer.

  • ownerAccount (string) --

    The AWS account that will own the new connection.

  • connectionId (string) --

    The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

    Example: dxcon-fg5678gh

    Default: None

  • connectionName (string) --

    The name of the connection.

    Example: "My Connection to AWS "

    Default: None

  • connectionState (string) --

    State of the connection.

    • Ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

    • Requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

    • Pending : The connection has been approved, and is being initialized.

    • Available : The network link is up, and the connection is ready for use.

    • Down : The network link is down.

    • Deleting : The connection is in the process of being deleted.

    • Deleted : The connection has been deleted.

    • Rejected : A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

  • region (string) --

    The AWS region where the connection is located.

    Example: us-east-1

    Default: None

  • location (string) --

    Where the connection is located.

    Example: EqSV5

    Default: None

  • bandwidth (string) --

    Bandwidth of the connection.

    Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

    Default: None

  • vlan (integer) --

    The VLAN ID.

    Example: 101

  • partnerName (string) --

    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.

    Example: dxlag-fg5678gh

  • awsDevice (string) --

    Deprecated in favor of awsDeviceV2.

    The Direct Connection endpoint which the physical connection terminates on.

  • awsDeviceV2 (string) --

    The Direct Connection endpoint which the physical connection terminates on.

{'awsDeviceV2': '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.

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.

Example: dxcon-abc123

Default: None

type parentConnectionId

string

param parentConnectionId

[REQUIRED]

The ID of the interconnect or the LAG.

Example: dxcon-abc123 or dxlag-abc123

Default: None

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'connectionId': 'string',
    'connectionName': 'string',
    'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
    'region': 'string',
    'location': 'string',
    'bandwidth': 'string',
    'vlan': 123,
    'partnerName': 'string',
    'loaIssueTime': datetime(2015, 1, 1),
    'lagId': 'string',
    'awsDevice': 'string',
    'awsDeviceV2': 'string'
}

Response Structure

• (dict) --

  A connection represents the physical network connection between the AWS Direct Connect location and the customer.

  • ownerAccount (string) --

    The AWS account that will own the new connection.

  • connectionId (string) --

    The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

    Example: dxcon-fg5678gh

    Default: None

  • connectionName (string) --

    The name of the connection.

    Example: "My Connection to AWS "

    Default: None

  • connectionState (string) --

    State of the connection.

    • Ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

    • Requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

    • Pending : The connection has been approved, and is being initialized.

    • Available : The network link is up, and the connection is ready for use.

    • Down : The network link is down.

    • Deleting : The connection is in the process of being deleted.

    • Deleted : The connection has been deleted.

    • Rejected : A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

  • region (string) --

    The AWS region where the connection is located.

    Example: us-east-1

    Default: None

  • location (string) --

    Where the connection is located.

    Example: EqSV5

    Default: None

  • bandwidth (string) --

    Bandwidth of the connection.

    Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

    Default: None

  • vlan (integer) --

    The VLAN ID.

    Example: 101

  • partnerName (string) --

    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.

    Example: dxlag-fg5678gh

  • awsDevice (string) --

    Deprecated in favor of awsDeviceV2.

    The Direct Connection endpoint which the physical connection terminates on.

  • awsDeviceV2 (string) --

    The Direct Connection endpoint which the physical connection terminates on.

{'awsDeviceV2': 'string',
 'bgpPeers': {'awsDeviceV2': 'string'},
 'region': 'string'}

Associates a virtual interface with a specified link aggregation group (LAG) or connection. Connectivity to AWS is temporarily interrupted as the virtual interface is being migrated. If the target connection or LAG has an associated virtual interface with a conflicting VLAN number or a conflicting IP address, the operation fails.

Virtual interfaces associated with a hosted connection cannot be associated with a LAG; hosted connections must be migrated along with their virtual interfaces using AssociateHostedConnection .

In order to reassociate a virtual interface to a new connection or LAG, the requester must own either the virtual interface itself or the connection to which the virtual interface is currently associated. Additionally, the requester must own the connection or LAG to which the virtual interface will be newly associated.

See also: AWS API Documentation

Request Syntax

client.associate_virtual_interface(
    virtualInterfaceId='string',
    connectionId='string'
)

type virtualInterfaceId

string

param virtualInterfaceId

[REQUIRED]

The ID of the virtual interface.

Example: dxvif-123dfg56

Default: None

type connectionId

string

param connectionId

[REQUIRED]

The ID of the LAG or connection with which to associate the virtual interface.

Example: dxlag-abc123 or dxcon-abc123

Default: None

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'virtualInterfaceId': 'string',
    'location': 'string',
    'connectionId': 'string',
    'virtualInterfaceType': 'string',
    'virtualInterfaceName': 'string',
    'vlan': 123,
    'asn': 123,
    'amazonSideAsn': 123,
    'authKey': 'string',
    'amazonAddress': 'string',
    'customerAddress': 'string',
    'addressFamily': 'ipv4'|'ipv6',
    'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
    'customerRouterConfig': 'string',
    'virtualGatewayId': 'string',
    'directConnectGatewayId': 'string',
    'routeFilterPrefixes': [
        {
            'cidr': 'string'
        },
    ],
    'bgpPeers': [
        {
            'asn': 123,
            'authKey': 'string',
            'addressFamily': 'ipv4'|'ipv6',
            'amazonAddress': 'string',
            'customerAddress': 'string',
            'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
            'bgpStatus': 'up'|'down',
            'awsDeviceV2': 'string'
        },
    ],
    'region': 'string',
    'awsDeviceV2': 'string'
}

Response Structure

• (dict) --

  A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

  • ownerAccount (string) --

    The AWS account that will own the new virtual interface.

  • virtualInterfaceId (string) --

    The ID of the virtual interface.

    Example: dxvif-123dfg56

    Default: None

  • location (string) --

    Where the connection is located.

    Example: EqSV5

    Default: None

  • connectionId (string) --

    The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

    Example: dxcon-fg5678gh

    Default: None

  • virtualInterfaceType (string) --

    The type of virtual interface.

    Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)

  • virtualInterfaceName (string) --

    The name of the virtual interface assigned by the customer.

    Example: "My VPC"

  • vlan (integer) --

    The VLAN ID.

    Example: 101

  • asn (integer) --

    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

    Example: 65000

  • amazonSideAsn (integer) --

    The autonomous system number (ASN) for the Amazon side of the connection.

  • authKey (string) --

    The authentication key for BGP configuration.

    Example: asdf34example

  • amazonAddress (string) --

    IP address assigned to the Amazon interface.

    Example: 192.168.1.1/30 or 2001:db8::1/125

  • customerAddress (string) --

    IP address assigned to the customer interface.

    Example: 192.168.1.2/30 or 2001:db8::2/125

  • addressFamily (string) --

    Indicates the address family for the BGP peer.

    • ipv4 : IPv4 address family

    • ipv6 : IPv6 address family

  • virtualInterfaceState (string) --

    State of the virtual interface.

    • Confirming : The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

    • Verifying : This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

    • Pending : A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

    • Available : A virtual interface that is able to forward traffic.

    • Down : A virtual interface that is BGP down.

    • Deleting : A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

    • Deleted : A virtual interface that cannot forward traffic.

    • Rejected : The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.

  • customerRouterConfig (string) --

    Information for generating the customer router configuration.

  • virtualGatewayId (string) --

    The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

    Example: vgw-123er56

  • directConnectGatewayId (string) --

    The ID of the direct connect gateway.

    Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

  • routeFilterPrefixes (list) --

    A list of routes to be advertised to the AWS network in this region (public virtual interface).

    • (dict) --

      A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

      • cidr (string) --

        CIDR notation for the advertised route. Multiple routes are separated by commas.

        IPv6 CIDRs must be at least a /64 or shorter

        Example: 10.10.10.0/24,10.10.11.0/24,2001:db8::/64

  • bgpPeers (list) --

    A list of the BGP peers configured on this virtual interface.

    • (dict) --

      A structure containing information about a BGP peer.

      • asn (integer) --

        The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

        Example: 65000

      • authKey (string) --

        The authentication key for BGP configuration.

        Example: asdf34example

      • addressFamily (string) --

        Indicates the address family for the BGP peer.

        • ipv4 : IPv4 address family

        • ipv6 : IPv6 address family

      • amazonAddress (string) --

        IP address assigned to the Amazon interface.

        Example: 192.168.1.1/30 or 2001:db8::1/125

      • customerAddress (string) --

        IP address assigned to the customer interface.

        Example: 192.168.1.2/30 or 2001:db8::2/125

      • bgpPeerState (string) --

        The state of the BGP peer.

        • Verifying : The BGP peering addresses or ASN require validation before the BGP peer can be created. This state only applies to BGP peers on a public virtual interface.

        • Pending : The BGP peer has been created, and is in this state until it is ready to be established.

        • Available : The BGP peer can be established.

        • Deleting : The BGP peer is in the process of being deleted.

        • Deleted : The BGP peer has been deleted and cannot be established.

      • bgpStatus (string) --

        The Up/Down state of the BGP peer.

        • Up : The BGP peer is established.

        Note

        A state of up does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.

        • Down : The BGP peer is down.

      • awsDeviceV2 (string) --

        The Direct Connection endpoint which the BGP peer terminates on.

  • region (string) --

    The AWS region where the virtual interface is located.

    Example: us-east-1

    Default: None

  • awsDeviceV2 (string) --

    The Direct Connection endpoint which the virtual interface terminates on.

{'virtualInterface': {'awsDeviceV2': 'string',
                      'bgpPeers': {'awsDeviceV2': 'string'},
                      'region': 'string'}}

Creates a new BGP peer on a specified virtual interface. The BGP peer cannot be in the same address family (IPv4/IPv6) of an existing BGP peer on the virtual interface.

You must create a BGP peer for the corresponding address family in order to access AWS resources that also use that address family.

When creating a IPv6 BGP peer, the Amazon address and customer address fields must be left blank. IPv6 addresses are automatically assigned from Amazon's pool of IPv6 addresses; you cannot specify custom IPv6 addresses.

For a public virtual interface, the Autonomous System Number (ASN) must be private or already whitelisted for the virtual interface.

See also: AWS API Documentation

Request Syntax

client.create_bgp_peer(
    virtualInterfaceId='string',
    newBGPPeer={
        'asn': 123,
        'authKey': 'string',
        'addressFamily': 'ipv4'|'ipv6',
        'amazonAddress': 'string',
        'customerAddress': 'string'
    }
)

type virtualInterfaceId

string

param virtualInterfaceId

The ID of the virtual interface on which the BGP peer will be provisioned.

Example: dxvif-456abc78

Default: None

type newBGPPeer

dict

param newBGPPeer

Detailed information for the BGP peer to be created.

Default: None

• asn (integer) --

  The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

  Example: 65000

• authKey (string) --

  The authentication key for BGP configuration.

  Example: asdf34example

• addressFamily (string) --

  Indicates the address family for the BGP peer.

  • ipv4 : IPv4 address family

  • ipv6 : IPv6 address family

• amazonAddress (string) --

  IP address assigned to the Amazon interface.

  Example: 192.168.1.1/30 or 2001:db8::1/125

• customerAddress (string) --

  IP address assigned to the customer interface.

  Example: 192.168.1.2/30 or 2001:db8::2/125

rtype

dict

returns

Response Syntax

{
    'virtualInterface': {
        'ownerAccount': 'string',
        'virtualInterfaceId': 'string',
        'location': 'string',
        'connectionId': 'string',
        'virtualInterfaceType': 'string',
        'virtualInterfaceName': 'string',
        'vlan': 123,
        'asn': 123,
        'amazonSideAsn': 123,
        'authKey': 'string',
        'amazonAddress': 'string',
        'customerAddress': 'string',
        'addressFamily': 'ipv4'|'ipv6',
        'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
        'customerRouterConfig': 'string',
        'virtualGatewayId': 'string',
        'directConnectGatewayId': 'string',
        'routeFilterPrefixes': [
            {
                'cidr': 'string'
            },
        ],
        'bgpPeers': [
            {
                'asn': 123,
                'authKey': 'string',
                'addressFamily': 'ipv4'|'ipv6',
                'amazonAddress': 'string',
                'customerAddress': 'string',
                'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
                'bgpStatus': 'up'|'down',
                'awsDeviceV2': 'string'
            },
        ],
        'region': 'string',
        'awsDeviceV2': 'string'
    }
}

Response Structure

• (dict) --

  The response received when CreateBGPPeer is called.

  • virtualInterface (dict) --

    A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

    • ownerAccount (string) --

      The AWS account that will own the new virtual interface.

    • virtualInterfaceId (string) --

      The ID of the virtual interface.

      Example: dxvif-123dfg56

      Default: None

    • location (string) --

      Where the connection is located.

      Example: EqSV5

      Default: None

    • connectionId (string) --

      The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

      Example: dxcon-fg5678gh

      Default: None

    • virtualInterfaceType (string) --

      The type of virtual interface.

      Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)

    • virtualInterfaceName (string) --

      The name of the virtual interface assigned by the customer.

      Example: "My VPC"

    • vlan (integer) --

      The VLAN ID.

      Example: 101

    • asn (integer) --

      The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

      Example: 65000

    • amazonSideAsn (integer) --

      The autonomous system number (ASN) for the Amazon side of the connection.

    • authKey (string) --

      The authentication key for BGP configuration.

      Example: asdf34example

    • amazonAddress (string) --

      IP address assigned to the Amazon interface.

      Example: 192.168.1.1/30 or 2001:db8::1/125

    • customerAddress (string) --

      IP address assigned to the customer interface.

      Example: 192.168.1.2/30 or 2001:db8::2/125

    • addressFamily (string) --

      Indicates the address family for the BGP peer.

      • ipv4 : IPv4 address family

      • ipv6 : IPv6 address family

    • virtualInterfaceState (string) --

      State of the virtual interface.

      • Confirming : The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

      • Verifying : This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

      • Pending : A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

      • Available : A virtual interface that is able to forward traffic.

      • Down : A virtual interface that is BGP down.

      • Deleting : A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

      • Deleted : A virtual interface that cannot forward traffic.

      • Rejected : The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.

    • customerRouterConfig (string) --

      Information for generating the customer router configuration.

    • virtualGatewayId (string) --

      The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

      Example: vgw-123er56

    • directConnectGatewayId (string) --

      The ID of the direct connect gateway.

      Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

    • routeFilterPrefixes (list) --

      A list of routes to be advertised to the AWS network in this region (public virtual interface).

      • (dict) --

        A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

        • cidr (string) --

          CIDR notation for the advertised route. Multiple routes are separated by commas.

          IPv6 CIDRs must be at least a /64 or shorter

          Example: 10.10.10.0/24,10.10.11.0/24,2001:db8::/64

    • bgpPeers (list) --

      A list of the BGP peers configured on this virtual interface.

      • (dict) --

        A structure containing information about a BGP peer.

        • asn (integer) --

          The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

          Example: 65000

        • authKey (string) --

          The authentication key for BGP configuration.

          Example: asdf34example

        • addressFamily (string) --

          Indicates the address family for the BGP peer.

          • ipv4 : IPv4 address family

          • ipv6 : IPv6 address family

        • amazonAddress (string) --

          IP address assigned to the Amazon interface.

          Example: 192.168.1.1/30 or 2001:db8::1/125

        • customerAddress (string) --

          IP address assigned to the customer interface.

          Example: 192.168.1.2/30 or 2001:db8::2/125

        • bgpPeerState (string) --

          The state of the BGP peer.

          • Verifying : The BGP peering addresses or ASN require validation before the BGP peer can be created. This state only applies to BGP peers on a public virtual interface.

          • Pending : The BGP peer has been created, and is in this state until it is ready to be established.

          • Available : The BGP peer can be established.

          • Deleting : The BGP peer is in the process of being deleted.

          • Deleted : The BGP peer has been deleted and cannot be established.

        • bgpStatus (string) --

          The Up/Down state of the BGP peer.

          • Up : The BGP peer is established.

          Note

          A state of up does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.

          • Down : The BGP peer is down.

        • awsDeviceV2 (string) --

          The Direct Connection endpoint which the BGP peer terminates on.

    • region (string) --

      The AWS region where the virtual interface is located.

      Example: us-east-1

      Default: None

    • awsDeviceV2 (string) --

      The Direct Connection endpoint which the virtual interface terminates on.

{'awsDeviceV2': 'string'}

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

A connection links your internal network to an AWS Direct Connect location over a standard 1 gigabit or 10 gigabit Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router. An AWS Direct Connect location provides access to Amazon Web Services in the region it is associated with. You can establish connections with AWS Direct Connect locations in multiple regions, but a connection in one region does not provide connectivity to other regions.

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 will be created.

See also: AWS API Documentation

Request Syntax

client.create_connection(
    location='string',
    bandwidth='string',
    connectionName='string',
    lagId='string'
)

type location

string

param location

[REQUIRED]

Where the connection is located.

Example: EqSV5

Default: None

type bandwidth

string

param bandwidth

[REQUIRED]

Bandwidth of the connection.

Example: 1Gbps

Default: None

type connectionName

string

param connectionName

[REQUIRED]

The name of the connection.

Example: "My Connection to AWS "

Default: None

type lagId

string

param lagId

The ID of the LAG.

Example: dxlag-fg5678gh

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'connectionId': 'string',
    'connectionName': 'string',
    'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
    'region': 'string',
    'location': 'string',
    'bandwidth': 'string',
    'vlan': 123,
    'partnerName': 'string',
    'loaIssueTime': datetime(2015, 1, 1),
    'lagId': 'string',
    'awsDevice': 'string',
    'awsDeviceV2': 'string'
}

Response Structure

• (dict) --

  A connection represents the physical network connection between the AWS Direct Connect location and the customer.

  • ownerAccount (string) --

    The AWS account that will own the new connection.

  • connectionId (string) --

    The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

    Example: dxcon-fg5678gh

    Default: None

  • connectionName (string) --

    The name of the connection.

    Example: "My Connection to AWS "

    Default: None

  • connectionState (string) --

    State of the connection.

    • Ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

    • Requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

    • Pending : The connection has been approved, and is being initialized.

    • Available : The network link is up, and the connection is ready for use.

    • Down : The network link is down.

    • Deleting : The connection is in the process of being deleted.

    • Deleted : The connection has been deleted.

    • Rejected : A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

  • region (string) --

    The AWS region where the connection is located.

    Example: us-east-1

    Default: None

  • location (string) --

    Where the connection is located.

    Example: EqSV5

    Default: None

  • bandwidth (string) --

    Bandwidth of the connection.

    Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

    Default: None

  • vlan (integer) --

    The VLAN ID.

    Example: 101

  • partnerName (string) --

    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.

    Example: dxlag-fg5678gh

  • awsDevice (string) --

    Deprecated in favor of awsDeviceV2.

    The Direct Connection endpoint which the physical connection terminates on.

  • awsDeviceV2 (string) --

    The Direct Connection endpoint which the physical connection terminates on.

{'awsDeviceV2': 'string'}

Creates a new interconnect between a AWS Direct Connect partner's network and a specific AWS Direct Connect location.

An interconnect is a connection which is capable of hosting other connections. The AWS Direct Connect partner can use an interconnect to provide sub-1Gbps AWS Direct Connect service to tier 2 customers who do not have their own connections. Like a standard connection, an interconnect links the AWS Direct Connect partner's network to an AWS Direct Connect location over a standard 1 Gbps or 10 Gbps Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an AWS Direct Connect router.

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

For each end customer, the AWS Direct Connect partner provisions a connection on their interconnect by calling AllocateConnectionOnInterconnect. The end customer can then connect to AWS resources by creating a virtual interface on their connection, using the VLAN assigned to them by the AWS Direct Connect partner.

See also: AWS API Documentation

Request Syntax

client.create_interconnect(
    interconnectName='string',
    bandwidth='string',
    location='string',
    lagId='string'
)

type interconnectName

string

param interconnectName

[REQUIRED]

The name of the interconnect.

Example: "1G Interconnect to AWS "

Default: None

type bandwidth

string

param bandwidth

[REQUIRED]

The port bandwidth

Example: 1Gbps

Default: None

Available values: 1Gbps,10Gbps

type location

string

param location

[REQUIRED]

Where the interconnect is located

Example: EqSV5

Default: None

type lagId

string

param lagId

The ID of the LAG.

Example: dxlag-fg5678gh

rtype

dict

returns

Response Syntax

{
    'interconnectId': 'string',
    'interconnectName': 'string',
    'interconnectState': 'requested'|'pending'|'available'|'down'|'deleting'|'deleted',
    'region': 'string',
    'location': 'string',
    'bandwidth': 'string',
    'loaIssueTime': datetime(2015, 1, 1),
    'lagId': 'string',
    'awsDevice': 'string',
    'awsDeviceV2': 'string'
}

Response Structure

• (dict) --

  An interconnect is a connection that can host other connections.

  Like a standard AWS Direct Connect connection, an interconnect represents the physical connection between an AWS Direct Connect partner's network and a specific Direct Connect location. An AWS Direct Connect partner who owns an interconnect can provision hosted connections on the interconnect for their end customers, thereby providing the end customers with connectivity to AWS services.

  The resources of the interconnect, including bandwidth and VLAN numbers, are shared by all of the hosted connections on the interconnect, and the owner of the interconnect determines how these resources are assigned.

  • interconnectId (string) --

    The ID of the interconnect.

    Example: dxcon-abc123

  • interconnectName (string) --

    The name of the interconnect.

    Example: "1G Interconnect to AWS "

  • interconnectState (string) --

    State of the interconnect.

    • Requested : The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

    • Pending : The interconnect has been approved, and is being initialized.

    • Available : The network link is up, and the interconnect is ready for use.

    • Down : The network link is down.

    • Deleting : The interconnect is in the process of being deleted.

    • Deleted : The interconnect has been deleted.

  • region (string) --

    The AWS region where the connection is located.

    Example: us-east-1

    Default: None

  • location (string) --

    Where the connection is located.

    Example: EqSV5

    Default: None

  • bandwidth (string) --

    Bandwidth of the connection.

    Example: 1Gbps

    Default: None

  • loaIssueTime (datetime) --

    The time of the most recent call to DescribeInterconnectLoa for this Interconnect.

  • lagId (string) --

    The ID of the LAG.

    Example: dxlag-fg5678gh

  • awsDevice (string) --

    Deprecated in favor of awsDeviceV2.

    The Direct Connection endpoint which the physical connection terminates on.

  • awsDeviceV2 (string) --

    The Direct Connection endpoint which the physical connection terminates on.

{'awsDeviceV2': 'string', 'connections': {'awsDeviceV2': 'string'}}

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

All connections in a LAG must use the same bandwidth (for example, 10 Gbps), and must terminate at the same AWS Direct Connect endpoint.

You can have up to 10 connections per LAG. Regardless of this limit, if you request more connections for the LAG than AWS Direct Connect can allocate on a single endpoint, no LAG is created.

You can specify an existing physical connection or interconnect to include in the LAG (which counts towards the total number of connections). Doing so interrupts the current physical connection or hosted connections, and re-establishes them as a member of the LAG. The LAG will be created on the same AWS Direct Connect endpoint to which the connection terminates. Any virtual interfaces associated with the connection are automatically disassociated and re-associated with the LAG. The connection ID does not change.

If the AWS account used to create a LAG is a registered AWS Direct Connect partner, the LAG is automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual interfaces cannot be directly configured.

See also: AWS API Documentation

Request Syntax

client.create_lag(
    numberOfConnections=123,
    location='string',
    connectionsBandwidth='string',
    lagName='string',
    connectionId='string'
)

type numberOfConnections

integer

param numberOfConnections

[REQUIRED]

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

Default: None

type location

string

param location

[REQUIRED]

The AWS Direct Connect location in which the LAG should be allocated.

Example: EqSV5

Default: None

type connectionsBandwidth

string

param connectionsBandwidth

[REQUIRED]

The bandwidth of the individual physical connections bundled by the LAG.

Default: None

Available values: 1Gbps, 10Gbps

type lagName

string

param lagName

[REQUIRED]

The name of the LAG.

Example: "3x10G LAG to AWS "

Default: None

type connectionId

string

param connectionId

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

Default: None

rtype

dict

returns

Response Syntax

{
    'connectionsBandwidth': 'string',
    'numberOfConnections': 123,
    'lagId': 'string',
    'ownerAccount': 'string',
    'lagName': 'string',
    'lagState': 'requested'|'pending'|'available'|'down'|'deleting'|'deleted',
    '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',
            'region': 'string',
            'location': 'string',
            'bandwidth': 'string',
            'vlan': 123,
            'partnerName': 'string',
            'loaIssueTime': datetime(2015, 1, 1),
            'lagId': 'string',
            'awsDevice': 'string',
            'awsDeviceV2': 'string'
        },
    ],
    'allowsHostedConnections': True|False
}

Response Structure

• (dict) --

  Describes a link aggregation group (LAG). A LAG is a connection that uses the Link Aggregation Control Protocol (LACP) to logically aggregate a bundle of physical connections. Like an interconnect, it can host other connections. All connections in a LAG must terminate on the same physical AWS Direct Connect endpoint, and must be the same bandwidth.

  • connectionsBandwidth (string) --

    The individual bandwidth of the physical connections bundled by the LAG.

    Available values: 1Gbps, 10Gbps

  • numberOfConnections (integer) --

    The number of physical connections bundled by the LAG, up to a maximum of 10.

  • lagId (string) --

    The ID of the LAG.

    Example: dxlag-fg5678gh

  • ownerAccount (string) --

    The owner of the LAG.

  • lagName (string) --

    The name of the LAG.

  • lagState (string) --

    The state of the LAG.

    • 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 in the process of being deleted.

    • Deleted : The LAG has been deleted.

  • location (string) --

    Where the connection is located.

    Example: EqSV5

    Default: None

  • region (string) --

    The AWS region where the connection is located.

    Example: us-east-1

    Default: None

  • minimumLinks (integer) --

    The minimum number of physical connections that must be operational for the LAG itself to be operational. If the number of operational connections drops below this setting, the LAG state changes to down . This value can help to ensure that a LAG is not overutilized if a significant number of its bundled connections go down.

  • awsDevice (string) --

    Deprecated in favor of awsDeviceV2.

    The AWS Direct Connection endpoint that hosts the LAG.

  • awsDeviceV2 (string) --

    The AWS Direct Connection endpoint that hosts the LAG.

  • connections (list) --

    A list of connections bundled by this LAG.

    • (dict) --

      A connection represents the physical network connection between the AWS Direct Connect location and the customer.

      • ownerAccount (string) --

        The AWS account that will own the new connection.

      • connectionId (string) --

        The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

        Example: dxcon-fg5678gh

        Default: None

      • connectionName (string) --

        The name of the connection.

        Example: "My Connection to AWS "

        Default: None

      • connectionState (string) --

        State of the connection.

        • Ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

        • Requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

        • Pending : The connection has been approved, and is being initialized.

        • Available : The network link is up, and the connection is ready for use.

        • Down : The network link is down.

        • Deleting : The connection is in the process of being deleted.

        • Deleted : The connection has been deleted.

        • Rejected : A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

      • region (string) --

        The AWS region where the connection is located.

        Example: us-east-1

        Default: None

      • location (string) --

        Where the connection is located.

        Example: EqSV5

        Default: None

      • bandwidth (string) --

        Bandwidth of the connection.

        Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

        Default: None

      • vlan (integer) --

        The VLAN ID.

        Example: 101

      • partnerName (string) --

        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.

        Example: dxlag-fg5678gh

      • awsDevice (string) --

        Deprecated in favor of awsDeviceV2.

        The Direct Connection endpoint which the physical connection terminates on.

      • awsDeviceV2 (string) --

        The Direct Connection endpoint which the physical connection terminates on.

  • allowsHostedConnections (boolean) --

    Indicates whether the LAG can host other connections.

    Note

    This is intended for use by AWS Direct Connect partners only.

{'awsDeviceV2': 'string',
 'bgpPeers': {'awsDeviceV2': 'string'},
 'region': 'string'}

Creates a new private virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A private virtual interface supports sending traffic to a single virtual private cloud (VPC).

See also: AWS API Documentation

Request Syntax

client.create_private_virtual_interface(
    connectionId='string',
    newPrivateVirtualInterface={
        'virtualInterfaceName': 'string',
        'vlan': 123,
        'asn': 123,
        'authKey': 'string',
        'amazonAddress': 'string',
        'customerAddress': 'string',
        'addressFamily': 'ipv4'|'ipv6',
        'virtualGatewayId': 'string',
        'directConnectGatewayId': 'string'
    }
)

type connectionId

string

param connectionId

[REQUIRED]

The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

Example: dxcon-fg5678gh

Default: None

type newPrivateVirtualInterface

dict

param newPrivateVirtualInterface

[REQUIRED]

Detailed information for the private virtual interface to be created.

Default: None

• virtualInterfaceName (string) -- [REQUIRED]

  The name of the virtual interface assigned by the customer.

  Example: "My VPC"

• vlan (integer) -- [REQUIRED]

  The VLAN ID.

  Example: 101

• asn (integer) -- [REQUIRED]

  The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

  Example: 65000

• authKey (string) --

  The authentication key for BGP configuration.

  Example: asdf34example

• amazonAddress (string) --

  IP address assigned to the Amazon interface.

  Example: 192.168.1.1/30 or 2001:db8::1/125

• customerAddress (string) --

  IP address assigned to the customer interface.

  Example: 192.168.1.2/30 or 2001:db8::2/125

• addressFamily (string) --

  Indicates the address family for the BGP peer.

  • ipv4 : IPv4 address family

  • ipv6 : IPv6 address family

• virtualGatewayId (string) --

  The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

  Example: vgw-123er56

• directConnectGatewayId (string) --

  The ID of the direct connect gateway.

  Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'virtualInterfaceId': 'string',
    'location': 'string',
    'connectionId': 'string',
    'virtualInterfaceType': 'string',
    'virtualInterfaceName': 'string',
    'vlan': 123,
    'asn': 123,
    'amazonSideAsn': 123,
    'authKey': 'string',
    'amazonAddress': 'string',
    'customerAddress': 'string',
    'addressFamily': 'ipv4'|'ipv6',
    'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
    'customerRouterConfig': 'string',
    'virtualGatewayId': 'string',
    'directConnectGatewayId': 'string',
    'routeFilterPrefixes': [
        {
            'cidr': 'string'
        },
    ],
    'bgpPeers': [
        {
            'asn': 123,
            'authKey': 'string',
            'addressFamily': 'ipv4'|'ipv6',
            'amazonAddress': 'string',
            'customerAddress': 'string',
            'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
            'bgpStatus': 'up'|'down',
            'awsDeviceV2': 'string'
        },
    ],
    'region': 'string',
    'awsDeviceV2': 'string'
}

Response Structure

• (dict) --

  A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

  • ownerAccount (string) --

    The AWS account that will own the new virtual interface.

  • virtualInterfaceId (string) --

    The ID of the virtual interface.

    Example: dxvif-123dfg56

    Default: None

  • location (string) --

    Where the connection is located.

    Example: EqSV5

    Default: None

  • connectionId (string) --

    The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

    Example: dxcon-fg5678gh

    Default: None

  • virtualInterfaceType (string) --

    The type of virtual interface.

    Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)

  • virtualInterfaceName (string) --

    The name of the virtual interface assigned by the customer.

    Example: "My VPC"

  • vlan (integer) --

    The VLAN ID.

    Example: 101

  • asn (integer) --

    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

    Example: 65000

  • amazonSideAsn (integer) --

    The autonomous system number (ASN) for the Amazon side of the connection.

  • authKey (string) --

    The authentication key for BGP configuration.

    Example: asdf34example

  • amazonAddress (string) --

    IP address assigned to the Amazon interface.

    Example: 192.168.1.1/30 or 2001:db8::1/125

  • customerAddress (string) --

    IP address assigned to the customer interface.

    Example: 192.168.1.2/30 or 2001:db8::2/125

  • addressFamily (string) --

    Indicates the address family for the BGP peer.

    • ipv4 : IPv4 address family

    • ipv6 : IPv6 address family

  • virtualInterfaceState (string) --

    State of the virtual interface.

    • Confirming : The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

    • Verifying : This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

    • Pending : A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

    • Available : A virtual interface that is able to forward traffic.

    • Down : A virtual interface that is BGP down.

    • Deleting : A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

    • Deleted : A virtual interface that cannot forward traffic.

    • Rejected : The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.

  • customerRouterConfig (string) --

    Information for generating the customer router configuration.

  • virtualGatewayId (string) --

    The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

    Example: vgw-123er56

  • directConnectGatewayId (string) --

    The ID of the direct connect gateway.

    Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

  • routeFilterPrefixes (list) --

    A list of routes to be advertised to the AWS network in this region (public virtual interface).

    • (dict) --

      A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

      • cidr (string) --

        CIDR notation for the advertised route. Multiple routes are separated by commas.

        IPv6 CIDRs must be at least a /64 or shorter

        Example: 10.10.10.0/24,10.10.11.0/24,2001:db8::/64

  • bgpPeers (list) --

    A list of the BGP peers configured on this virtual interface.

    • (dict) --

      A structure containing information about a BGP peer.

      • asn (integer) --

        The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

        Example: 65000

      • authKey (string) --

        The authentication key for BGP configuration.

        Example: asdf34example

      • addressFamily (string) --

        Indicates the address family for the BGP peer.

        • ipv4 : IPv4 address family

        • ipv6 : IPv6 address family

      • amazonAddress (string) --

        IP address assigned to the Amazon interface.

        Example: 192.168.1.1/30 or 2001:db8::1/125

      • customerAddress (string) --

        IP address assigned to the customer interface.

        Example: 192.168.1.2/30 or 2001:db8::2/125

      • bgpPeerState (string) --

        The state of the BGP peer.

        • Verifying : The BGP peering addresses or ASN require validation before the BGP peer can be created. This state only applies to BGP peers on a public virtual interface.

        • Pending : The BGP peer has been created, and is in this state until it is ready to be established.

        • Available : The BGP peer can be established.

        • Deleting : The BGP peer is in the process of being deleted.

        • Deleted : The BGP peer has been deleted and cannot be established.

      • bgpStatus (string) --

        The Up/Down state of the BGP peer.

        • Up : The BGP peer is established.

        Note

        A state of up does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.

        • Down : The BGP peer is down.

      • awsDeviceV2 (string) --

        The Direct Connection endpoint which the BGP peer terminates on.

  • region (string) --

    The AWS region where the virtual interface is located.

    Example: us-east-1

    Default: None

  • awsDeviceV2 (string) --

    The Direct Connection endpoint which the virtual interface terminates on.

{'awsDeviceV2': 'string',
 'bgpPeers': {'awsDeviceV2': 'string'},
 'region': 'string'}

Creates a new public virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A public virtual interface supports sending traffic to public services of AWS such as Amazon Simple Storage Service (Amazon S3).

When creating an IPv6 public virtual interface (addressFamily is 'ipv6'), the customer and amazon address fields should be left blank to use auto-assigned IPv6 space. Custom IPv6 Addresses are currently not supported.

See also: AWS API Documentation

Request Syntax

client.create_public_virtual_interface(
    connectionId='string',
    newPublicVirtualInterface={
        'virtualInterfaceName': 'string',
        'vlan': 123,
        'asn': 123,
        'authKey': 'string',
        'amazonAddress': 'string',
        'customerAddress': 'string',
        'addressFamily': 'ipv4'|'ipv6',
        'routeFilterPrefixes': [
            {
                'cidr': 'string'
            },
        ]
    }
)

type connectionId

string

param connectionId

[REQUIRED]

The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

Example: dxcon-fg5678gh

Default: None

type newPublicVirtualInterface

dict

param newPublicVirtualInterface

[REQUIRED]

Detailed information for the public virtual interface to be created.

Default: None

• virtualInterfaceName (string) -- [REQUIRED]

  The name of the virtual interface assigned by the customer.

  Example: "My VPC"

• vlan (integer) -- [REQUIRED]

  The VLAN ID.

  Example: 101

• asn (integer) -- [REQUIRED]

  The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

  Example: 65000

• authKey (string) --

  The authentication key for BGP configuration.

  Example: asdf34example

• amazonAddress (string) --

  IP address assigned to the Amazon interface.

  Example: 192.168.1.1/30 or 2001:db8::1/125

• customerAddress (string) --

  IP address assigned to the customer interface.

  Example: 192.168.1.2/30 or 2001:db8::2/125

• addressFamily (string) --

  Indicates the address family for the BGP peer.

  • ipv4 : IPv4 address family

  • ipv6 : IPv6 address family

• routeFilterPrefixes (list) --

  A list of routes to be advertised to the AWS network in this region (public virtual interface).

  • (dict) --

    A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

    • cidr (string) --

      CIDR notation for the advertised route. Multiple routes are separated by commas.

      IPv6 CIDRs must be at least a /64 or shorter

      Example: 10.10.10.0/24,10.10.11.0/24,2001:db8::/64

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'virtualInterfaceId': 'string',
    'location': 'string',
    'connectionId': 'string',
    'virtualInterfaceType': 'string',
    'virtualInterfaceName': 'string',
    'vlan': 123,
    'asn': 123,
    'amazonSideAsn': 123,
    'authKey': 'string',
    'amazonAddress': 'string',
    'customerAddress': 'string',
    'addressFamily': 'ipv4'|'ipv6',
    'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
    'customerRouterConfig': 'string',
    'virtualGatewayId': 'string',
    'directConnectGatewayId': 'string',
    'routeFilterPrefixes': [
        {
            'cidr': 'string'
        },
    ],
    'bgpPeers': [
        {
            'asn': 123,
            'authKey': 'string',
            'addressFamily': 'ipv4'|'ipv6',
            'amazonAddress': 'string',
            'customerAddress': 'string',
            'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
            'bgpStatus': 'up'|'down',
            'awsDeviceV2': 'string'
        },
    ],
    'region': 'string',
    'awsDeviceV2': 'string'
}

Response Structure

• (dict) --

  A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

  • ownerAccount (string) --

    The AWS account that will own the new virtual interface.

  • virtualInterfaceId (string) --

    The ID of the virtual interface.

    Example: dxvif-123dfg56

    Default: None

  • location (string) --

    Where the connection is located.

    Example: EqSV5

    Default: None

  • connectionId (string) --

    The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

    Example: dxcon-fg5678gh

    Default: None

  • virtualInterfaceType (string) --

    The type of virtual interface.

    Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)

  • virtualInterfaceName (string) --

    The name of the virtual interface assigned by the customer.

    Example: "My VPC"

  • vlan (integer) --

    The VLAN ID.

    Example: 101

  • asn (integer) --

    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

    Example: 65000

  • amazonSideAsn (integer) --

    The autonomous system number (ASN) for the Amazon side of the connection.

  • authKey (string) --

    The authentication key for BGP configuration.

    Example: asdf34example

  • amazonAddress (string) --

    IP address assigned to the Amazon interface.

    Example: 192.168.1.1/30 or 2001:db8::1/125

  • customerAddress (string) --

    IP address assigned to the customer interface.

    Example: 192.168.1.2/30 or 2001:db8::2/125

  • addressFamily (string) --

    Indicates the address family for the BGP peer.

    • ipv4 : IPv4 address family

    • ipv6 : IPv6 address family

  • virtualInterfaceState (string) --

    State of the virtual interface.

    • Confirming : The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

    • Verifying : This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

    • Pending : A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

    • Available : A virtual interface that is able to forward traffic.

    • Down : A virtual interface that is BGP down.

    • Deleting : A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

    • Deleted : A virtual interface that cannot forward traffic.

    • Rejected : The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.

  • customerRouterConfig (string) --

    Information for generating the customer router configuration.

  • virtualGatewayId (string) --

    The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

    Example: vgw-123er56

  • directConnectGatewayId (string) --

    The ID of the direct connect gateway.

    Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

  • routeFilterPrefixes (list) --

    A list of routes to be advertised to the AWS network in this region (public virtual interface).

    • (dict) --

      A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

      • cidr (string) --

        CIDR notation for the advertised route. Multiple routes are separated by commas.

        IPv6 CIDRs must be at least a /64 or shorter

        Example: 10.10.10.0/24,10.10.11.0/24,2001:db8::/64

  • bgpPeers (list) --

    A list of the BGP peers configured on this virtual interface.

    • (dict) --

      A structure containing information about a BGP peer.

      • asn (integer) --

        The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

        Example: 65000

      • authKey (string) --

        The authentication key for BGP configuration.

        Example: asdf34example

      • addressFamily (string) --

        Indicates the address family for the BGP peer.

        • ipv4 : IPv4 address family

        • ipv6 : IPv6 address family

      • amazonAddress (string) --

        IP address assigned to the Amazon interface.

        Example: 192.168.1.1/30 or 2001:db8::1/125

      • customerAddress (string) --

        IP address assigned to the customer interface.

        Example: 192.168.1.2/30 or 2001:db8::2/125

      • bgpPeerState (string) --

        The state of the BGP peer.

        • Verifying : The BGP peering addresses or ASN require validation before the BGP peer can be created. This state only applies to BGP peers on a public virtual interface.

        • Pending : The BGP peer has been created, and is in this state until it is ready to be established.

        • Available : The BGP peer can be established.

        • Deleting : The BGP peer is in the process of being deleted.

        • Deleted : The BGP peer has been deleted and cannot be established.

      • bgpStatus (string) --

        The Up/Down state of the BGP peer.

        • Up : The BGP peer is established.

        Note

        A state of up does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.

        • Down : The BGP peer is down.

      • awsDeviceV2 (string) --

        The Direct Connection endpoint which the BGP peer terminates on.

  • region (string) --

    The AWS region where the virtual interface is located.

    Example: us-east-1

    Default: None

  • awsDeviceV2 (string) --

    The Direct Connection endpoint which the virtual interface terminates on.

{'virtualInterface': {'awsDeviceV2': 'string',
                      'bgpPeers': {'awsDeviceV2': 'string'},
                      'region': 'string'}}

Deletes a BGP peer on the specified virtual interface that matches the specified customer address and ASN. You cannot delete the last BGP peer from a virtual interface.

See also: AWS API Documentation

Request Syntax

client.delete_bgp_peer(
    virtualInterfaceId='string',
    asn=123,
    customerAddress='string'
)

type virtualInterfaceId

string

param virtualInterfaceId

The ID of the virtual interface from which the BGP peer will be deleted.

Example: dxvif-456abc78

Default: None

type asn

integer

param asn

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

Example: 65000

type customerAddress

string

param customerAddress

IP address assigned to the customer interface.

Example: 192.168.1.2/30 or 2001:db8::2/125

rtype

dict

returns

Response Syntax

{
    'virtualInterface': {
        'ownerAccount': 'string',
        'virtualInterfaceId': 'string',
        'location': 'string',
        'connectionId': 'string',
        'virtualInterfaceType': 'string',
        'virtualInterfaceName': 'string',
        'vlan': 123,
        'asn': 123,
        'amazonSideAsn': 123,
        'authKey': 'string',
        'amazonAddress': 'string',
        'customerAddress': 'string',
        'addressFamily': 'ipv4'|'ipv6',
        'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
        'customerRouterConfig': 'string',
        'virtualGatewayId': 'string',
        'directConnectGatewayId': 'string',
        'routeFilterPrefixes': [
            {
                'cidr': 'string'
            },
        ],
        'bgpPeers': [
            {
                'asn': 123,
                'authKey': 'string',
                'addressFamily': 'ipv4'|'ipv6',
                'amazonAddress': 'string',
                'customerAddress': 'string',
                'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
                'bgpStatus': 'up'|'down',
                'awsDeviceV2': 'string'
            },
        ],
        'region': 'string',
        'awsDeviceV2': 'string'
    }
}

Response Structure

• (dict) --

  The response received when DeleteBGPPeer is called.

  • virtualInterface (dict) --

    A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

    • ownerAccount (string) --

      The AWS account that will own the new virtual interface.

    • virtualInterfaceId (string) --

      The ID of the virtual interface.

      Example: dxvif-123dfg56

      Default: None

    • location (string) --

      Where the connection is located.

      Example: EqSV5

      Default: None

    • connectionId (string) --

      The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

      Example: dxcon-fg5678gh

      Default: None

    • virtualInterfaceType (string) --

      The type of virtual interface.

      Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)

    • virtualInterfaceName (string) --

      The name of the virtual interface assigned by the customer.

      Example: "My VPC"

    • vlan (integer) --

      The VLAN ID.

      Example: 101

    • asn (integer) --

      The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

      Example: 65000

    • amazonSideAsn (integer) --

      The autonomous system number (ASN) for the Amazon side of the connection.

    • authKey (string) --

      The authentication key for BGP configuration.

      Example: asdf34example

    • amazonAddress (string) --

      IP address assigned to the Amazon interface.

      Example: 192.168.1.1/30 or 2001:db8::1/125

    • customerAddress (string) --

      IP address assigned to the customer interface.

      Example: 192.168.1.2/30 or 2001:db8::2/125

    • addressFamily (string) --

      Indicates the address family for the BGP peer.

      • ipv4 : IPv4 address family

      • ipv6 : IPv6 address family

    • virtualInterfaceState (string) --

      State of the virtual interface.

      • Confirming : The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

      • Verifying : This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

      • Pending : A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

      • Available : A virtual interface that is able to forward traffic.

      • Down : A virtual interface that is BGP down.

      • Deleting : A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

      • Deleted : A virtual interface that cannot forward traffic.

      • Rejected : The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.

    • customerRouterConfig (string) --

      Information for generating the customer router configuration.

    • virtualGatewayId (string) --

      The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

      Example: vgw-123er56

    • directConnectGatewayId (string) --

      The ID of the direct connect gateway.

      Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

    • routeFilterPrefixes (list) --

      A list of routes to be advertised to the AWS network in this region (public virtual interface).

      • (dict) --

        A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

        • cidr (string) --

          CIDR notation for the advertised route. Multiple routes are separated by commas.

          IPv6 CIDRs must be at least a /64 or shorter

          Example: 10.10.10.0/24,10.10.11.0/24,2001:db8::/64

    • bgpPeers (list) --

      A list of the BGP peers configured on this virtual interface.

      • (dict) --

        A structure containing information about a BGP peer.

        • asn (integer) --

          The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

          Example: 65000

        • authKey (string) --

          The authentication key for BGP configuration.

          Example: asdf34example

        • addressFamily (string) --

          Indicates the address family for the BGP peer.

          • ipv4 : IPv4 address family

          • ipv6 : IPv6 address family

        • amazonAddress (string) --

          IP address assigned to the Amazon interface.

          Example: 192.168.1.1/30 or 2001:db8::1/125

        • customerAddress (string) --

          IP address assigned to the customer interface.

          Example: 192.168.1.2/30 or 2001:db8::2/125

        • bgpPeerState (string) --

          The state of the BGP peer.

          • Verifying : The BGP peering addresses or ASN require validation before the BGP peer can be created. This state only applies to BGP peers on a public virtual interface.

          • Pending : The BGP peer has been created, and is in this state until it is ready to be established.

          • Available : The BGP peer can be established.

          • Deleting : The BGP peer is in the process of being deleted.

          • Deleted : The BGP peer has been deleted and cannot be established.

        • bgpStatus (string) --

          The Up/Down state of the BGP peer.

          • Up : The BGP peer is established.

          Note

          A state of up does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.

          • Down : The BGP peer is down.

        • awsDeviceV2 (string) --

          The Direct Connection endpoint which the BGP peer terminates on.

    • region (string) --

      The AWS region where the virtual interface is located.

      Example: us-east-1

      Default: None

    • awsDeviceV2 (string) --

      The Direct Connection endpoint which the virtual interface terminates on.

{'awsDeviceV2': 'string'}

Deletes the connection.

Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. You need to cancel separately with the providers any services or charges for cross-connects or network circuits that connect you to the AWS Direct Connect location.

See also: AWS API Documentation

Request Syntax

client.delete_connection(
    connectionId='string'
)

type connectionId

string

param connectionId

[REQUIRED]

The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

Example: dxcon-fg5678gh

Default: None

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'connectionId': 'string',
    'connectionName': 'string',
    'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
    'region': 'string',
    'location': 'string',
    'bandwidth': 'string',
    'vlan': 123,
    'partnerName': 'string',
    'loaIssueTime': datetime(2015, 1, 1),
    'lagId': 'string',
    'awsDevice': 'string',
    'awsDeviceV2': 'string'
}

Response Structure

• (dict) --

  A connection represents the physical network connection between the AWS Direct Connect location and the customer.

  • ownerAccount (string) --

    The AWS account that will own the new connection.

  • connectionId (string) --

    The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

    Example: dxcon-fg5678gh

    Default: None

  • connectionName (string) --

    The name of the connection.

    Example: "My Connection to AWS "

    Default: None

  • connectionState (string) --

    State of the connection.

    • Ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

    • Requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

    • Pending : The connection has been approved, and is being initialized.

    • Available : The network link is up, and the connection is ready for use.

    • Down : The network link is down.

    • Deleting : The connection is in the process of being deleted.

    • Deleted : The connection has been deleted.

    • Rejected : A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

  • region (string) --

    The AWS region where the connection is located.

    Example: us-east-1

    Default: None

  • location (string) --

    Where the connection is located.

    Example: EqSV5

    Default: None

  • bandwidth (string) --

    Bandwidth of the connection.

    Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

    Default: None

  • vlan (integer) --

    The VLAN ID.

    Example: 101

  • partnerName (string) --

    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.

    Example: dxlag-fg5678gh

  • awsDevice (string) --

    Deprecated in favor of awsDeviceV2.

    The Direct Connection endpoint which the physical connection terminates on.

  • awsDeviceV2 (string) --

    The Direct Connection endpoint which the physical connection terminates on.

{'awsDeviceV2': 'string', 'connections': {'awsDeviceV2': 'string'}}

Deletes a 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 to delete.

Example: dxlag-abc123

Default: None

rtype

dict

returns

Response Syntax

{
    'connectionsBandwidth': 'string',
    'numberOfConnections': 123,
    'lagId': 'string',
    'ownerAccount': 'string',
    'lagName': 'string',
    'lagState': 'requested'|'pending'|'available'|'down'|'deleting'|'deleted',
    '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',
            'region': 'string',
            'location': 'string',
            'bandwidth': 'string',
            'vlan': 123,
            'partnerName': 'string',
            'loaIssueTime': datetime(2015, 1, 1),
            'lagId': 'string',
            'awsDevice': 'string',
            'awsDeviceV2': 'string'
        },
    ],
    'allowsHostedConnections': True|False
}

Response Structure

• (dict) --

  Describes a link aggregation group (LAG). A LAG is a connection that uses the Link Aggregation Control Protocol (LACP) to logically aggregate a bundle of physical connections. Like an interconnect, it can host other connections. All connections in a LAG must terminate on the same physical AWS Direct Connect endpoint, and must be the same bandwidth.

  • connectionsBandwidth (string) --

    The individual bandwidth of the physical connections bundled by the LAG.

    Available values: 1Gbps, 10Gbps

  • numberOfConnections (integer) --

    The number of physical connections bundled by the LAG, up to a maximum of 10.

  • lagId (string) --

    The ID of the LAG.

    Example: dxlag-fg5678gh

  • ownerAccount (string) --

    The owner of the LAG.

  • lagName (string) --

    The name of the LAG.

  • lagState (string) --

    The state of the LAG.

    • 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 in the process of being deleted.

    • Deleted : The LAG has been deleted.

  • location (string) --

    Where the connection is located.

    Example: EqSV5

    Default: None

  • region (string) --

    The AWS region where the connection is located.

    Example: us-east-1

    Default: None

  • minimumLinks (integer) --

    The minimum number of physical connections that must be operational for the LAG itself to be operational. If the number of operational connections drops below this setting, the LAG state changes to down . This value can help to ensure that a LAG is not overutilized if a significant number of its bundled connections go down.

  • awsDevice (string) --

    Deprecated in favor of awsDeviceV2.

    The AWS Direct Connection endpoint that hosts the LAG.

  • awsDeviceV2 (string) --

    The AWS Direct Connection endpoint that hosts the LAG.

  • connections (list) --

    A list of connections bundled by this LAG.

    • (dict) --

      A connection represents the physical network connection between the AWS Direct Connect location and the customer.

      • ownerAccount (string) --

        The AWS account that will own the new connection.

      • connectionId (string) --

        The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

        Example: dxcon-fg5678gh

        Default: None

      • connectionName (string) --

        The name of the connection.

        Example: "My Connection to AWS "

        Default: None

      • connectionState (string) --

        State of the connection.

        • Ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

        • Requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

        • Pending : The connection has been approved, and is being initialized.

        • Available : The network link is up, and the connection is ready for use.

        • Down : The network link is down.

        • Deleting : The connection is in the process of being deleted.

        • Deleted : The connection has been deleted.

        • Rejected : A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

      • region (string) --

        The AWS region where the connection is located.

        Example: us-east-1

        Default: None

      • location (string) --

        Where the connection is located.

        Example: EqSV5

        Default: None

      • bandwidth (string) --

        Bandwidth of the connection.

        Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

        Default: None

      • vlan (integer) --

        The VLAN ID.

        Example: 101

      • partnerName (string) --

        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.

        Example: dxlag-fg5678gh

      • awsDevice (string) --

        Deprecated in favor of awsDeviceV2.

        The Direct Connection endpoint which the physical connection terminates on.

      • awsDeviceV2 (string) --

        The Direct Connection endpoint which the physical connection terminates on.

  • allowsHostedConnections (boolean) --

    Indicates whether the LAG can host other connections.

    Note

    This is intended for use by AWS Direct Connect partners only.

{'connections': {'awsDeviceV2': 'string'}}

Displays all connections in this region.

If a connection ID is provided, the call returns only that particular connection.

See also: AWS API Documentation

Request Syntax

client.describe_connections(
    connectionId='string'
)

type connectionId

string

param connectionId

The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

Example: dxcon-fg5678gh

Default: None

rtype

dict

returns

Response Syntax

{
    'connections': [
        {
            'ownerAccount': 'string',
            'connectionId': 'string',
            'connectionName': 'string',
            'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
            'region': 'string',
            'location': 'string',
            'bandwidth': 'string',
            'vlan': 123,
            'partnerName': 'string',
            'loaIssueTime': datetime(2015, 1, 1),
            'lagId': 'string',
            'awsDevice': 'string',
            'awsDeviceV2': 'string'
        },
    ]
}

Response Structure

• (dict) --

  A structure containing a list of connections.

  • connections (list) --

    A list of connections.

    • (dict) --

      A connection represents the physical network connection between the AWS Direct Connect location and the customer.

      • ownerAccount (string) --

        The AWS account that will own the new connection.

      • connectionId (string) --

        The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

        Example: dxcon-fg5678gh

        Default: None

      • connectionName (string) --

        The name of the connection.

        Example: "My Connection to AWS "

        Default: None

      • connectionState (string) --

        State of the connection.

        • Ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

        • Requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

        • Pending : The connection has been approved, and is being initialized.

        • Available : The network link is up, and the connection is ready for use.

        • Down : The network link is down.

        • Deleting : The connection is in the process of being deleted.

        • Deleted : The connection has been deleted.

        • Rejected : A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

      • region (string) --

        The AWS region where the connection is located.

        Example: us-east-1

        Default: None

      • location (string) --

        Where the connection is located.

        Example: EqSV5

        Default: None

      • bandwidth (string) --

        Bandwidth of the connection.

        Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

        Default: None

      • vlan (integer) --

        The VLAN ID.

        Example: 101

      • partnerName (string) --

        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.

        Example: dxlag-fg5678gh

      • awsDevice (string) --

        Deprecated in favor of awsDeviceV2.

        The Direct Connection endpoint which the physical connection terminates on.

      • awsDeviceV2 (string) --

        The Direct Connection endpoint which the physical connection terminates on.

{'connections': {'awsDeviceV2': 'string'}}

Deprecated in favor of DescribeHostedConnections .

Returns a list of connections that have been provisioned on the given interconnect.

See also: AWS API Documentation

Request Syntax

client.describe_connections_on_interconnect(
    interconnectId='string'
)

type interconnectId

string

param interconnectId

[REQUIRED]

ID of the interconnect on which a list of connection is provisioned.

Example: dxcon-abc123

Default: None

rtype

dict

returns

Response Syntax

{
    'connections': [
        {
            'ownerAccount': 'string',
            'connectionId': 'string',
            'connectionName': 'string',
            'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
            'region': 'string',
            'location': 'string',
            'bandwidth': 'string',
            'vlan': 123,
            'partnerName': 'string',
            'loaIssueTime': datetime(2015, 1, 1),
            'lagId': 'string',
            'awsDevice': 'string',
            'awsDeviceV2': 'string'
        },
    ]
}

Response Structure

• (dict) --

  A structure containing a list of connections.

  • connections (list) --

    A list of connections.

    • (dict) --

      A connection represents the physical network connection between the AWS Direct Connect location and the customer.

      • ownerAccount (string) --

        The AWS account that will own the new connection.

      • connectionId (string) --

        The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

        Example: dxcon-fg5678gh

        Default: None

      • connectionName (string) --

        The name of the connection.

        Example: "My Connection to AWS "

        Default: None

      • connectionState (string) --

        State of the connection.

        • Ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

        • Requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

        • Pending : The connection has been approved, and is being initialized.

        • Available : The network link is up, and the connection is ready for use.

        • Down : The network link is down.

        • Deleting : The connection is in the process of being deleted.

        • Deleted : The connection has been deleted.

        • Rejected : A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

      • region (string) --

        The AWS region where the connection is located.

        Example: us-east-1

        Default: None

      • location (string) --

        Where the connection is located.

        Example: EqSV5

        Default: None

      • bandwidth (string) --

        Bandwidth of the connection.

        Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

        Default: None

      • vlan (integer) --

        The VLAN ID.

        Example: 101

      • partnerName (string) --

        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.

        Example: dxlag-fg5678gh

      • awsDevice (string) --

        Deprecated in favor of awsDeviceV2.

        The Direct Connection endpoint which the physical connection terminates on.

      • awsDeviceV2 (string) --

        The Direct Connection endpoint which the physical connection terminates on.

{'connections': {'awsDeviceV2': 'string'}}

Returns a list of hosted connections that have been provisioned on the given interconnect or link aggregation group (LAG).

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 on which the hosted connections are provisioned.

Example: dxcon-abc123 or dxlag-abc123

Default: None

rtype

dict

returns

Response Syntax

{
    'connections': [
        {
            'ownerAccount': 'string',
            'connectionId': 'string',
            'connectionName': 'string',
            'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
            'region': 'string',
            'location': 'string',
            'bandwidth': 'string',
            'vlan': 123,
            'partnerName': 'string',
            'loaIssueTime': datetime(2015, 1, 1),
            'lagId': 'string',
            'awsDevice': 'string',
            'awsDeviceV2': 'string'
        },
    ]
}

Response Structure

• (dict) --

  A structure containing a list of connections.

  • connections (list) --

    A list of connections.

    • (dict) --

      A connection represents the physical network connection between the AWS Direct Connect location and the customer.

      • ownerAccount (string) --

        The AWS account that will own the new connection.

      • connectionId (string) --

        The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

        Example: dxcon-fg5678gh

        Default: None

      • connectionName (string) --

        The name of the connection.

        Example: "My Connection to AWS "

        Default: None

      • connectionState (string) --

        State of the connection.

        • Ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

        • Requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

        • Pending : The connection has been approved, and is being initialized.

        • Available : The network link is up, and the connection is ready for use.

        • Down : The network link is down.

        • Deleting : The connection is in the process of being deleted.

        • Deleted : The connection has been deleted.

        • Rejected : A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

      • region (string) --

        The AWS region where the connection is located.

        Example: us-east-1

        Default: None

      • location (string) --

        Where the connection is located.

        Example: EqSV5

        Default: None

      • bandwidth (string) --

        Bandwidth of the connection.

        Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

        Default: None

      • vlan (integer) --

        The VLAN ID.

        Example: 101

      • partnerName (string) --

        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.

        Example: dxlag-fg5678gh

      • awsDevice (string) --

        Deprecated in favor of awsDeviceV2.

        The Direct Connection endpoint which the physical connection terminates on.

      • awsDeviceV2 (string) --

        The Direct Connection endpoint which the physical connection terminates on.

{'interconnects': {'awsDeviceV2': 'string'}}

Returns a list of interconnects owned by the AWS account.

If an interconnect ID is provided, it will only return this particular interconnect.

See also: AWS API Documentation

Request Syntax

client.describe_interconnects(
    interconnectId='string'
)

type interconnectId

string

param interconnectId

The ID of the interconnect.

Example: dxcon-abc123

rtype

dict

returns

Response Syntax

{
    'interconnects': [
        {
            'interconnectId': 'string',
            'interconnectName': 'string',
            'interconnectState': 'requested'|'pending'|'available'|'down'|'deleting'|'deleted',
            'region': 'string',
            'location': 'string',
            'bandwidth': 'string',
            'loaIssueTime': datetime(2015, 1, 1),
            'lagId': 'string',
            'awsDevice': 'string',
            'awsDeviceV2': 'string'
        },
    ]
}

Response Structure

• (dict) --

  A structure containing a list of interconnects.

  • interconnects (list) --

    A list of interconnects.

    • (dict) --

      An interconnect is a connection that can host other connections.

      Like a standard AWS Direct Connect connection, an interconnect represents the physical connection between an AWS Direct Connect partner's network and a specific Direct Connect location. An AWS Direct Connect partner who owns an interconnect can provision hosted connections on the interconnect for their end customers, thereby providing the end customers with connectivity to AWS services.

      The resources of the interconnect, including bandwidth and VLAN numbers, are shared by all of the hosted connections on the interconnect, and the owner of the interconnect determines how these resources are assigned.

      • interconnectId (string) --

        The ID of the interconnect.

        Example: dxcon-abc123

      • interconnectName (string) --

        The name of the interconnect.

        Example: "1G Interconnect to AWS "

      • interconnectState (string) --

        State of the interconnect.

        • Requested : The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

        • Pending : The interconnect has been approved, and is being initialized.

        • Available : The network link is up, and the interconnect is ready for use.

        • Down : The network link is down.

        • Deleting : The interconnect is in the process of being deleted.

        • Deleted : The interconnect has been deleted.

      • region (string) --

        The AWS region where the connection is located.

        Example: us-east-1

        Default: None

      • location (string) --

        Where the connection is located.

        Example: EqSV5

        Default: None

      • bandwidth (string) --

        Bandwidth of the connection.

        Example: 1Gbps

        Default: None

      • loaIssueTime (datetime) --

        The time of the most recent call to DescribeInterconnectLoa for this Interconnect.

      • lagId (string) --

        The ID of the LAG.

        Example: dxlag-fg5678gh

      • awsDevice (string) --

        Deprecated in favor of awsDeviceV2.

        The Direct Connection endpoint which the physical connection terminates on.

      • awsDeviceV2 (string) --

        The Direct Connection endpoint which the physical connection terminates on.

{'lags': {'awsDeviceV2': 'string', 'connections': {'awsDeviceV2': 'string'}}}

Describes the link aggregation groups (LAGs) in your account.

If a LAG ID is provided, only information about the specified LAG is returned.

See also: AWS API Documentation

Request Syntax

client.describe_lags(
    lagId='string'
)

type lagId

string

param lagId

The ID of the LAG.

Example: dxlag-abc123

Default: None

rtype

dict

returns

Response Syntax

{
    'lags': [
        {
            'connectionsBandwidth': 'string',
            'numberOfConnections': 123,
            'lagId': 'string',
            'ownerAccount': 'string',
            'lagName': 'string',
            'lagState': 'requested'|'pending'|'available'|'down'|'deleting'|'deleted',
            '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',
                    'region': 'string',
                    'location': 'string',
                    'bandwidth': 'string',
                    'vlan': 123,
                    'partnerName': 'string',
                    'loaIssueTime': datetime(2015, 1, 1),
                    'lagId': 'string',
                    'awsDevice': 'string',
                    'awsDeviceV2': 'string'
                },
            ],
            'allowsHostedConnections': True|False
        },
    ]
}

Response Structure

• (dict) --

  A structure containing a list of LAGs.

  • lags (list) --

    A list of LAGs.

    • (dict) --

      Describes a link aggregation group (LAG). A LAG is a connection that uses the Link Aggregation Control Protocol (LACP) to logically aggregate a bundle of physical connections. Like an interconnect, it can host other connections. All connections in a LAG must terminate on the same physical AWS Direct Connect endpoint, and must be the same bandwidth.

      • connectionsBandwidth (string) --

        The individual bandwidth of the physical connections bundled by the LAG.

        Available values: 1Gbps, 10Gbps

      • numberOfConnections (integer) --

        The number of physical connections bundled by the LAG, up to a maximum of 10.

      • lagId (string) --

        The ID of the LAG.

        Example: dxlag-fg5678gh

      • ownerAccount (string) --

        The owner of the LAG.

      • lagName (string) --

        The name of the LAG.

      • lagState (string) --

        The state of the LAG.

        • 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 in the process of being deleted.

        • Deleted : The LAG has been deleted.

      • location (string) --

        Where the connection is located.

        Example: EqSV5

        Default: None

      • region (string) --

        The AWS region where the connection is located.

        Example: us-east-1

        Default: None

      • minimumLinks (integer) --

        The minimum number of physical connections that must be operational for the LAG itself to be operational. If the number of operational connections drops below this setting, the LAG state changes to down . This value can help to ensure that a LAG is not overutilized if a significant number of its bundled connections go down.

      • awsDevice (string) --

        Deprecated in favor of awsDeviceV2.

        The AWS Direct Connection endpoint that hosts the LAG.

      • awsDeviceV2 (string) --

        The AWS Direct Connection endpoint that hosts the LAG.

      • connections (list) --

        A list of connections bundled by this LAG.

        • (dict) --

          A connection represents the physical network connection between the AWS Direct Connect location and the customer.

          • ownerAccount (string) --

            The AWS account that will own the new connection.

          • connectionId (string) --

            The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

            Example: dxcon-fg5678gh

            Default: None

          • connectionName (string) --

            The name of the connection.

            Example: "My Connection to AWS "

            Default: None

          • connectionState (string) --

            State of the connection.

            • Ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

            • Requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

            • Pending : The connection has been approved, and is being initialized.

            • Available : The network link is up, and the connection is ready for use.

            • Down : The network link is down.

            • Deleting : The connection is in the process of being deleted.

            • Deleted : The connection has been deleted.

            • Rejected : A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

          • region (string) --

            The AWS region where the connection is located.

            Example: us-east-1

            Default: None

          • location (string) --

            Where the connection is located.

            Example: EqSV5

            Default: None

          • bandwidth (string) --

            Bandwidth of the connection.

            Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

            Default: None

          • vlan (integer) --

            The VLAN ID.

            Example: 101

          • partnerName (string) --

            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.

            Example: dxlag-fg5678gh

          • awsDevice (string) --

            Deprecated in favor of awsDeviceV2.

            The Direct Connection endpoint which the physical connection terminates on.

          • awsDeviceV2 (string) --

            The Direct Connection endpoint which the physical connection terminates on.

      • allowsHostedConnections (boolean) --

        Indicates whether the LAG can host other connections.

        Note

        This is intended for use by AWS Direct Connect partners only.

{'locations': {'region': 'string'}}

Returns the list of AWS Direct Connect locations in the current AWS region. These are the locations that may be selected when calling CreateConnection or CreateInterconnect .

See also: AWS API Documentation

Request Syntax

client.describe_locations()

rtype

dict

returns

Response Syntax

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

Response Structure

• (dict) --

  A location is a network facility where AWS Direct Connect routers are available to be connected. Generally, these are colocation hubs where many network providers have equipment, and where cross connects can be delivered. Locations include a name and facility code, and must be provided when creating a connection.

  • locations (list) --

    A list of colocation hubs where network providers have equipment. Most regions have multiple locations available.

    • (dict) --

      An AWS Direct Connect location where connections and interconnects can be requested.

      • locationCode (string) --

        The code used to indicate the AWS Direct Connect location.

      • locationName (string) --

        The name of the AWS Direct Connect location. The name includes the colocation partner name and the physical site of the lit building.

      • region (string) --

        The AWS region where the AWS Direct connect location is located.

        Example: us-east-1

        Default: None

{'virtualInterfaces': {'awsDeviceV2': 'string',
                       'bgpPeers': {'awsDeviceV2': 'string'},
                       'region': 'string'}}

Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before you make the request are also returned. If you specify a connection ID, only the virtual interfaces associated with the connection are returned. If you specify a virtual interface ID, then only a single virtual interface is returned.

A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

See also: AWS API Documentation

Request Syntax

client.describe_virtual_interfaces(
    connectionId='string',
    virtualInterfaceId='string'
)

type connectionId

string

param connectionId

The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

Example: dxcon-fg5678gh

Default: None

type virtualInterfaceId

string

param virtualInterfaceId

The ID of the virtual interface.

Example: dxvif-123dfg56

Default: None

rtype

dict

returns

Response Syntax

{
    'virtualInterfaces': [
        {
            'ownerAccount': 'string',
            'virtualInterfaceId': 'string',
            'location': 'string',
            'connectionId': 'string',
            'virtualInterfaceType': 'string',
            'virtualInterfaceName': 'string',
            'vlan': 123,
            'asn': 123,
            'amazonSideAsn': 123,
            'authKey': 'string',
            'amazonAddress': 'string',
            'customerAddress': 'string',
            'addressFamily': 'ipv4'|'ipv6',
            'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
            'customerRouterConfig': 'string',
            'virtualGatewayId': 'string',
            'directConnectGatewayId': 'string',
            'routeFilterPrefixes': [
                {
                    'cidr': 'string'
                },
            ],
            'bgpPeers': [
                {
                    'asn': 123,
                    'authKey': 'string',
                    'addressFamily': 'ipv4'|'ipv6',
                    'amazonAddress': 'string',
                    'customerAddress': 'string',
                    'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
                    'bgpStatus': 'up'|'down',
                    'awsDeviceV2': 'string'
                },
            ],
            'region': 'string',
            'awsDeviceV2': 'string'
        },
    ]
}

Response Structure

• (dict) --

  A structure containing a list of virtual interfaces.

  • virtualInterfaces (list) --

    A list of virtual interfaces.

    • (dict) --

      A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

      • ownerAccount (string) --

        The AWS account that will own the new virtual interface.

      • virtualInterfaceId (string) --

        The ID of the virtual interface.

        Example: dxvif-123dfg56

        Default: None

      • location (string) --

        Where the connection is located.

        Example: EqSV5

        Default: None

      • connectionId (string) --

        The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

        Example: dxcon-fg5678gh

        Default: None

      • virtualInterfaceType (string) --

        The type of virtual interface.

        Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)

      • virtualInterfaceName (string) --

        The name of the virtual interface assigned by the customer.

        Example: "My VPC"

      • vlan (integer) --

        The VLAN ID.

        Example: 101

      • asn (integer) --

        The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

        Example: 65000

      • amazonSideAsn (integer) --

        The autonomous system number (ASN) for the Amazon side of the connection.

      • authKey (string) --

        The authentication key for BGP configuration.

        Example: asdf34example

      • amazonAddress (string) --

        IP address assigned to the Amazon interface.

        Example: 192.168.1.1/30 or 2001:db8::1/125

      • customerAddress (string) --

        IP address assigned to the customer interface.

        Example: 192.168.1.2/30 or 2001:db8::2/125

      • addressFamily (string) --

        Indicates the address family for the BGP peer.

        • ipv4 : IPv4 address family

        • ipv6 : IPv6 address family

      • virtualInterfaceState (string) --

        State of the virtual interface.

        • Confirming : The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

        • Verifying : This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

        • Pending : A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

        • Available : A virtual interface that is able to forward traffic.

        • Down : A virtual interface that is BGP down.

        • Deleting : A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

        • Deleted : A virtual interface that cannot forward traffic.

        • Rejected : The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.

      • customerRouterConfig (string) --

        Information for generating the customer router configuration.

      • virtualGatewayId (string) --

        The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

        Example: vgw-123er56

      • directConnectGatewayId (string) --

        The ID of the direct connect gateway.

        Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

      • routeFilterPrefixes (list) --

        A list of routes to be advertised to the AWS network in this region (public virtual interface).

        • (dict) --

          A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

          • cidr (string) --

            CIDR notation for the advertised route. Multiple routes are separated by commas.

            IPv6 CIDRs must be at least a /64 or shorter

            Example: 10.10.10.0/24,10.10.11.0/24,2001:db8::/64

      • bgpPeers (list) --

        A list of the BGP peers configured on this virtual interface.

        • (dict) --

          A structure containing information about a BGP peer.

          • asn (integer) --

            The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

            Example: 65000

          • authKey (string) --

            The authentication key for BGP configuration.

            Example: asdf34example

          • addressFamily (string) --

            Indicates the address family for the BGP peer.

            • ipv4 : IPv4 address family

            • ipv6 : IPv6 address family

          • amazonAddress (string) --

            IP address assigned to the Amazon interface.

            Example: 192.168.1.1/30 or 2001:db8::1/125

          • customerAddress (string) --

            IP address assigned to the customer interface.

            Example: 192.168.1.2/30 or 2001:db8::2/125

          • bgpPeerState (string) --

            The state of the BGP peer.

            • Verifying : The BGP peering addresses or ASN require validation before the BGP peer can be created. This state only applies to BGP peers on a public virtual interface.

            • Pending : The BGP peer has been created, and is in this state until it is ready to be established.

            • Available : The BGP peer can be established.

            • Deleting : The BGP peer is in the process of being deleted.

            • Deleted : The BGP peer has been deleted and cannot be established.

          • bgpStatus (string) --

            The Up/Down state of the BGP peer.

            • Up : The BGP peer is established.

            Note

            A state of up does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.

            • Down : The BGP peer is down.

          • awsDeviceV2 (string) --

            The Direct Connection endpoint which the BGP peer terminates on.

      • region (string) --

        The AWS region where the virtual interface is located.

        Example: us-east-1

        Default: None

      • awsDeviceV2 (string) --

        The Direct Connection endpoint which the virtual interface terminates on.

{'awsDeviceV2': '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 will 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 to disassociate from the LAG.

Example: dxcon-abc123

Default: None

type lagId

string

param lagId

[REQUIRED]

The ID of the LAG.

Example: dxlag-abc123

Default: None

rtype

dict

returns

Response Syntax

{
    'ownerAccount': 'string',
    'connectionId': 'string',
    'connectionName': 'string',
    'connectionState': 'ordering'|'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
    'region': 'string',
    'location': 'string',
    'bandwidth': 'string',
    'vlan': 123,
    'partnerName': 'string',
    'loaIssueTime': datetime(2015, 1, 1),
    'lagId': 'string',
    'awsDevice': 'string',
    'awsDeviceV2': 'string'
}

Response Structure

• (dict) --

  A connection represents the physical network connection between the AWS Direct Connect location and the customer.

  • ownerAccount (string) --

    The AWS account that will own the new connection.

  • connectionId (string) --

    The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

    Example: dxcon-fg5678gh

    Default: None

  • connectionName (string) --

    The name of the connection.

    Example: "My Connection to AWS "

    Default: None

  • connectionState (string) --

    State of the connection.

    • Ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

    • Requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

    • Pending : The connection has been approved, and is being initialized.

    • Available : The network link is up, and the connection is ready for use.

    • Down : The network link is down.

    • Deleting : The connection is in the process of being deleted.

    • Deleted : The connection has been deleted.

    • Rejected : A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

  • region (string) --

    The AWS region where the connection is located.

    Example: us-east-1

    Default: None

  • location (string) --

    Where the connection is located.

    Example: EqSV5

    Default: None

  • bandwidth (string) --

    Bandwidth of the connection.

    Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

    Default: None

  • vlan (integer) --

    The VLAN ID.

    Example: 101

  • partnerName (string) --

    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.

    Example: dxlag-fg5678gh

  • awsDevice (string) --

    Deprecated in favor of awsDeviceV2.

    The Direct Connection endpoint which the physical connection terminates on.

  • awsDeviceV2 (string) --

    The Direct Connection endpoint which the physical connection terminates on.

{'awsDeviceV2': 'string', 'connections': {'awsDeviceV2': 'string'}}

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

You can update the following attributes:

• The name of the LAG.

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

When you create a LAG, the default value for the minimum number of operational connections is zero (0). If you update this value, and the number of operational connections falls below the specified value, the LAG will automatically go down to avoid overutilization of the remaining connections. Adjusting this value should be done with care as it could force the LAG down if the value is set higher than the current number of operational connections.

See also: AWS API Documentation

Request Syntax

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

type lagId

string

param lagId

[REQUIRED]

The ID of the LAG to update.

Example: dxlag-abc123

Default: None

type lagName

string

param lagName

The name for the LAG.

Example: "3x10G LAG to AWS "

Default: None

type minimumLinks

integer

param minimumLinks

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

Default: None

rtype

dict

returns

Response Syntax

{
    'connectionsBandwidth': 'string',
    'numberOfConnections': 123,
    'lagId': 'string',
    'ownerAccount': 'string',
    'lagName': 'string',
    'lagState': 'requested'|'pending'|'available'|'down'|'deleting'|'deleted',
    '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',
            'region': 'string',
            'location': 'string',
            'bandwidth': 'string',
            'vlan': 123,
            'partnerName': 'string',
            'loaIssueTime': datetime(2015, 1, 1),
            'lagId': 'string',
            'awsDevice': 'string',
            'awsDeviceV2': 'string'
        },
    ],
    'allowsHostedConnections': True|False
}

Response Structure

• (dict) --

  Describes a link aggregation group (LAG). A LAG is a connection that uses the Link Aggregation Control Protocol (LACP) to logically aggregate a bundle of physical connections. Like an interconnect, it can host other connections. All connections in a LAG must terminate on the same physical AWS Direct Connect endpoint, and must be the same bandwidth.

  • connectionsBandwidth (string) --

    The individual bandwidth of the physical connections bundled by the LAG.

    Available values: 1Gbps, 10Gbps

  • numberOfConnections (integer) --

    The number of physical connections bundled by the LAG, up to a maximum of 10.

  • lagId (string) --

    The ID of the LAG.

    Example: dxlag-fg5678gh

  • ownerAccount (string) --

    The owner of the LAG.

  • lagName (string) --

    The name of the LAG.

  • lagState (string) --

    The state of the LAG.

    • 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 in the process of being deleted.

    • Deleted : The LAG has been deleted.

  • location (string) --

    Where the connection is located.

    Example: EqSV5

    Default: None

  • region (string) --

    The AWS region where the connection is located.

    Example: us-east-1

    Default: None

  • minimumLinks (integer) --

    The minimum number of physical connections that must be operational for the LAG itself to be operational. If the number of operational connections drops below this setting, the LAG state changes to down . This value can help to ensure that a LAG is not overutilized if a significant number of its bundled connections go down.

  • awsDevice (string) --

    Deprecated in favor of awsDeviceV2.

    The AWS Direct Connection endpoint that hosts the LAG.

  • awsDeviceV2 (string) --

    The AWS Direct Connection endpoint that hosts the LAG.

  • connections (list) --

    A list of connections bundled by this LAG.

    • (dict) --

      A connection represents the physical network connection between the AWS Direct Connect location and the customer.

      • ownerAccount (string) --

        The AWS account that will own the new connection.

      • connectionId (string) --

        The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

        Example: dxcon-fg5678gh

        Default: None

      • connectionName (string) --

        The name of the connection.

        Example: "My Connection to AWS "

        Default: None

      • connectionState (string) --

        State of the connection.

        • Ordering : The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

        • Requested : The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

        • Pending : The connection has been approved, and is being initialized.

        • Available : The network link is up, and the connection is ready for use.

        • Down : The network link is down.

        • Deleting : The connection is in the process of being deleted.

        • Deleted : The connection has been deleted.

        • Rejected : A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

      • region (string) --

        The AWS region where the connection is located.

        Example: us-east-1

        Default: None

      • location (string) --

        Where the connection is located.

        Example: EqSV5

        Default: None

      • bandwidth (string) --

        Bandwidth of the connection.

        Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

        Default: None

      • vlan (integer) --

        The VLAN ID.

        Example: 101

      • partnerName (string) --

        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.

        Example: dxlag-fg5678gh

      • awsDevice (string) --

        Deprecated in favor of awsDeviceV2.

        The Direct Connection endpoint which the physical connection terminates on.

      • awsDeviceV2 (string) --

        The Direct Connection endpoint which the physical connection terminates on.

  • allowsHostedConnections (boolean) --

    Indicates whether the LAG can host other connections.

    Note

    This is intended for use by AWS Direct Connect partners only.