AcceptDirectConnectGatewayAssociationProposal

$result = $client->acceptDirectConnectGatewayAssociationProposal([/* ... */]);
$promise = $client->acceptDirectConnectGatewayAssociationProposalAsync([/* ... */]);

Accepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway.

Parameter Syntax

$result = $client->acceptDirectConnectGatewayAssociationProposal([
    'associatedGatewayOwnerAccount' => '<string>', // REQUIRED
    'directConnectGatewayId' => '<string>', // REQUIRED
    'overrideAllowedPrefixesToDirectConnectGateway' => [
        [
            'cidr' => '<string>',
        ],
        // ...
    ],
    'proposalId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'directConnectGatewayAssociation' => [
        'allowedPrefixesToDirectConnectGateway' => [
            [
                'cidr' => '<string>',
            ],
            // ...
        ],
        'associatedGateway' => [
            'id' => '<string>',
            'ownerAccount' => '<string>',
            'region' => '<string>',
            'type' => 'virtualPrivateGateway|transitGateway',
        ],
        'associationId' => '<string>',
        'associationState' => 'associating|associated|disassociating|disassociated|updating',
        'directConnectGatewayId' => '<string>',
        'directConnectGatewayOwnerAccount' => '<string>',
        'stateChangeError' => '<string>',
        'virtualGatewayId' => '<string>',
        'virtualGatewayOwnerAccount' => '<string>',
        'virtualGatewayRegion' => '<string>',
    ],
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

AllocateConnectionOnInterconnect

$result = $client->allocateConnectionOnInterconnect([/* ... */]);
$promise = $client->allocateConnectionOnInterconnectAsync([/* ... */]);

Deprecated. Use AllocateHostedConnection instead.

Creates a hosted connection on an interconnect.

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

Parameter Syntax

$result = $client->allocateConnectionOnInterconnect([
    'bandwidth' => '<string>', // REQUIRED
    'connectionName' => '<string>', // REQUIRED
    'interconnectId' => '<string>', // REQUIRED
    'ownerAccount' => '<string>', // REQUIRED
    'vlan' => <integer>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'awsDevice' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'bandwidth' => '<string>',
    'connectionId' => '<string>',
    'connectionName' => '<string>',
    'connectionState' => 'ordering|requested|pending|available|down|deleting|deleted|rejected|unknown',
    'encryptionMode' => '<string>',
    'hasLogicalRedundancy' => 'unknown|yes|no',
    'jumboFrameCapable' => true || false,
    'lagId' => '<string>',
    'loaIssueTime' => <DateTime>,
    'location' => '<string>',
    'macSecCapable' => true || false,
    'macSecKeys' => [
        [
            'ckn' => '<string>',
            'secretARN' => '<string>',
            'startOn' => '<string>',
            'state' => '<string>',
        ],
        // ...
    ],
    'ownerAccount' => '<string>',
    'partnerName' => '<string>',
    'portEncryptionStatus' => '<string>',
    'providerName' => '<string>',
    'region' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'vlan' => <integer>,
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

AllocateHostedConnection

$result = $client->allocateHostedConnection([/* ... */]);
$promise = $client->allocateHostedConnectionAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->allocateHostedConnection([
    'bandwidth' => '<string>', // REQUIRED
    'connectionId' => '<string>', // REQUIRED
    'connectionName' => '<string>', // REQUIRED
    'ownerAccount' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>',
        ],
        // ...
    ],
    'vlan' => <integer>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'awsDevice' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'bandwidth' => '<string>',
    'connectionId' => '<string>',
    'connectionName' => '<string>',
    'connectionState' => 'ordering|requested|pending|available|down|deleting|deleted|rejected|unknown',
    'encryptionMode' => '<string>',
    'hasLogicalRedundancy' => 'unknown|yes|no',
    'jumboFrameCapable' => true || false,
    'lagId' => '<string>',
    'loaIssueTime' => <DateTime>,
    'location' => '<string>',
    'macSecCapable' => true || false,
    'macSecKeys' => [
        [
            'ckn' => '<string>',
            'secretARN' => '<string>',
            'startOn' => '<string>',
            'state' => '<string>',
        ],
        // ...
    ],
    'ownerAccount' => '<string>',
    'partnerName' => '<string>',
    'portEncryptionStatus' => '<string>',
    'providerName' => '<string>',
    'region' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'vlan' => <integer>,
]

Result Details

Errors

DuplicateTagKeysException:

A tag key was specified more than once.

TooManyTagsException:

You have reached the limit on the number of tags that can be assigned.

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

AllocatePrivateVirtualInterface

$result = $client->allocatePrivateVirtualInterface([/* ... */]);
$promise = $client->allocatePrivateVirtualInterfaceAsync([/* ... */]);

Provisions a private virtual interface to be owned by the specified Amazon Web Services account.

Virtual interfaces created using this action must be confirmed by the owner using ConfirmPrivateVirtualInterface. Until then, the virtual interface is in the Confirming state and is not available to handle traffic.

Parameter Syntax

$result = $client->allocatePrivateVirtualInterface([
    'connectionId' => '<string>', // REQUIRED
    'newPrivateVirtualInterfaceAllocation' => [ // REQUIRED
        'addressFamily' => 'ipv4|ipv6',
        'amazonAddress' => '<string>',
        'asn' => <integer>, // REQUIRED
        'authKey' => '<string>',
        'customerAddress' => '<string>',
        'mtu' => <integer>,
        'tags' => [
            [
                'key' => '<string>', // REQUIRED
                'value' => '<string>',
            ],
            // ...
        ],
        'virtualInterfaceName' => '<string>', // REQUIRED
        'vlan' => <integer>, // REQUIRED
    ],
    'ownerAccount' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'addressFamily' => 'ipv4|ipv6',
    'amazonAddress' => '<string>',
    'amazonSideAsn' => <integer>,
    'asn' => <integer>,
    'authKey' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'bgpPeers' => [
        [
            'addressFamily' => 'ipv4|ipv6',
            'amazonAddress' => '<string>',
            'asn' => <integer>,
            'authKey' => '<string>',
            'awsDeviceV2' => '<string>',
            'awsLogicalDeviceId' => '<string>',
            'bgpPeerId' => '<string>',
            'bgpPeerState' => 'verifying|pending|available|deleting|deleted',
            'bgpStatus' => 'up|down|unknown',
            'customerAddress' => '<string>',
        ],
        // ...
    ],
    'connectionId' => '<string>',
    'customerAddress' => '<string>',
    'customerRouterConfig' => '<string>',
    'directConnectGatewayId' => '<string>',
    'jumboFrameCapable' => true || false,
    'location' => '<string>',
    'mtu' => <integer>,
    'ownerAccount' => '<string>',
    'region' => '<string>',
    'routeFilterPrefixes' => [
        [
            'cidr' => '<string>',
        ],
        // ...
    ],
    'siteLinkEnabled' => true || false,
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'virtualGatewayId' => '<string>',
    'virtualInterfaceId' => '<string>',
    'virtualInterfaceName' => '<string>',
    'virtualInterfaceState' => 'confirming|verifying|pending|available|down|deleting|deleted|rejected|unknown',
    'virtualInterfaceType' => '<string>',
    'vlan' => <integer>,
]

Result Details

Errors

DuplicateTagKeysException:

A tag key was specified more than once.

TooManyTagsException:

You have reached the limit on the number of tags that can be assigned.

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

AllocatePublicVirtualInterface

$result = $client->allocatePublicVirtualInterface([/* ... */]);
$promise = $client->allocatePublicVirtualInterfaceAsync([/* ... */]);

Provisions a public virtual interface to be owned by the specified Amazon Web Services account.

The owner of a connection calls this function to provision a public virtual interface to be owned by the specified Amazon Web Services account.

Virtual interfaces created using this function must be confirmed by the owner using ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface is in the confirming state and is not available to handle traffic.

When creating an IPv6 public virtual interface, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.

Parameter Syntax

$result = $client->allocatePublicVirtualInterface([
    'connectionId' => '<string>', // REQUIRED
    'newPublicVirtualInterfaceAllocation' => [ // REQUIRED
        'addressFamily' => 'ipv4|ipv6',
        'amazonAddress' => '<string>',
        'asn' => <integer>, // REQUIRED
        'authKey' => '<string>',
        'customerAddress' => '<string>',
        'routeFilterPrefixes' => [
            [
                'cidr' => '<string>',
            ],
            // ...
        ],
        'tags' => [
            [
                'key' => '<string>', // REQUIRED
                'value' => '<string>',
            ],
            // ...
        ],
        'virtualInterfaceName' => '<string>', // REQUIRED
        'vlan' => <integer>, // REQUIRED
    ],
    'ownerAccount' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'addressFamily' => 'ipv4|ipv6',
    'amazonAddress' => '<string>',
    'amazonSideAsn' => <integer>,
    'asn' => <integer>,
    'authKey' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'bgpPeers' => [
        [
            'addressFamily' => 'ipv4|ipv6',
            'amazonAddress' => '<string>',
            'asn' => <integer>,
            'authKey' => '<string>',
            'awsDeviceV2' => '<string>',
            'awsLogicalDeviceId' => '<string>',
            'bgpPeerId' => '<string>',
            'bgpPeerState' => 'verifying|pending|available|deleting|deleted',
            'bgpStatus' => 'up|down|unknown',
            'customerAddress' => '<string>',
        ],
        // ...
    ],
    'connectionId' => '<string>',
    'customerAddress' => '<string>',
    'customerRouterConfig' => '<string>',
    'directConnectGatewayId' => '<string>',
    'jumboFrameCapable' => true || false,
    'location' => '<string>',
    'mtu' => <integer>,
    'ownerAccount' => '<string>',
    'region' => '<string>',
    'routeFilterPrefixes' => [
        [
            'cidr' => '<string>',
        ],
        // ...
    ],
    'siteLinkEnabled' => true || false,
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'virtualGatewayId' => '<string>',
    'virtualInterfaceId' => '<string>',
    'virtualInterfaceName' => '<string>',
    'virtualInterfaceState' => 'confirming|verifying|pending|available|down|deleting|deleted|rejected|unknown',
    'virtualInterfaceType' => '<string>',
    'vlan' => <integer>,
]

Result Details

Errors

DuplicateTagKeysException:

A tag key was specified more than once.

TooManyTagsException:

You have reached the limit on the number of tags that can be assigned.

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

AllocateTransitVirtualInterface

$result = $client->allocateTransitVirtualInterface([/* ... */]);
$promise = $client->allocateTransitVirtualInterfaceAsync([/* ... */]);

Provisions a transit virtual interface to be owned by the specified Amazon Web Services account. Use this type of interface to connect a transit gateway to your Direct Connect gateway.

The owner of a connection provisions a transit virtual interface to be owned by the specified Amazon Web Services account.

After you create a transit virtual interface, it must be confirmed by the owner using ConfirmTransitVirtualInterface. Until this step has been completed, the transit virtual interface is in the requested state and is not available to handle traffic.

Parameter Syntax

$result = $client->allocateTransitVirtualInterface([
    'connectionId' => '<string>', // REQUIRED
    'newTransitVirtualInterfaceAllocation' => [ // REQUIRED
        'addressFamily' => 'ipv4|ipv6',
        'amazonAddress' => '<string>',
        'asn' => <integer>,
        'authKey' => '<string>',
        'customerAddress' => '<string>',
        'mtu' => <integer>,
        'tags' => [
            [
                'key' => '<string>', // REQUIRED
                'value' => '<string>',
            ],
            // ...
        ],
        'virtualInterfaceName' => '<string>',
        'vlan' => <integer>,
    ],
    'ownerAccount' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'virtualInterface' => [
        'addressFamily' => 'ipv4|ipv6',
        'amazonAddress' => '<string>',
        'amazonSideAsn' => <integer>,
        'asn' => <integer>,
        'authKey' => '<string>',
        'awsDeviceV2' => '<string>',
        'awsLogicalDeviceId' => '<string>',
        'bgpPeers' => [
            [
                'addressFamily' => 'ipv4|ipv6',
                'amazonAddress' => '<string>',
                'asn' => <integer>,
                'authKey' => '<string>',
                'awsDeviceV2' => '<string>',
                'awsLogicalDeviceId' => '<string>',
                'bgpPeerId' => '<string>',
                'bgpPeerState' => 'verifying|pending|available|deleting|deleted',
                'bgpStatus' => 'up|down|unknown',
                'customerAddress' => '<string>',
            ],
            // ...
        ],
        'connectionId' => '<string>',
        'customerAddress' => '<string>',
        'customerRouterConfig' => '<string>',
        'directConnectGatewayId' => '<string>',
        'jumboFrameCapable' => true || false,
        'location' => '<string>',
        'mtu' => <integer>,
        'ownerAccount' => '<string>',
        'region' => '<string>',
        'routeFilterPrefixes' => [
            [
                'cidr' => '<string>',
            ],
            // ...
        ],
        'siteLinkEnabled' => true || false,
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'virtualGatewayId' => '<string>',
        'virtualInterfaceId' => '<string>',
        'virtualInterfaceName' => '<string>',
        'virtualInterfaceState' => 'confirming|verifying|pending|available|down|deleting|deleted|rejected|unknown',
        'virtualInterfaceType' => '<string>',
        'vlan' => <integer>,
    ],
]

Result Details

Errors

DuplicateTagKeysException:

A tag key was specified more than once.

TooManyTagsException:

You have reached the limit on the number of tags that can be assigned.

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

AssociateConnectionWithLag

$result = $client->associateConnectionWithLag([/* ... */]);
$promise = $client->associateConnectionWithLagAsync([/* ... */]);

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

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

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

Parameter Syntax

$result = $client->associateConnectionWithLag([
    'connectionId' => '<string>', // REQUIRED
    'lagId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'awsDevice' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'bandwidth' => '<string>',
    'connectionId' => '<string>',
    'connectionName' => '<string>',
    'connectionState' => 'ordering|requested|pending|available|down|deleting|deleted|rejected|unknown',
    'encryptionMode' => '<string>',
    'hasLogicalRedundancy' => 'unknown|yes|no',
    'jumboFrameCapable' => true || false,
    'lagId' => '<string>',
    'loaIssueTime' => <DateTime>,
    'location' => '<string>',
    'macSecCapable' => true || false,
    'macSecKeys' => [
        [
            'ckn' => '<string>',
            'secretARN' => '<string>',
            'startOn' => '<string>',
            'state' => '<string>',
        ],
        // ...
    ],
    'ownerAccount' => '<string>',
    'partnerName' => '<string>',
    'portEncryptionStatus' => '<string>',
    'providerName' => '<string>',
    'region' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'vlan' => <integer>,
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

AssociateHostedConnection

$result = $client->associateHostedConnection([/* ... */]);
$promise = $client->associateHostedConnectionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->associateHostedConnection([
    'connectionId' => '<string>', // REQUIRED
    'parentConnectionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'awsDevice' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'bandwidth' => '<string>',
    'connectionId' => '<string>',
    'connectionName' => '<string>',
    'connectionState' => 'ordering|requested|pending|available|down|deleting|deleted|rejected|unknown',
    'encryptionMode' => '<string>',
    'hasLogicalRedundancy' => 'unknown|yes|no',
    'jumboFrameCapable' => true || false,
    'lagId' => '<string>',
    'loaIssueTime' => <DateTime>,
    'location' => '<string>',
    'macSecCapable' => true || false,
    'macSecKeys' => [
        [
            'ckn' => '<string>',
            'secretARN' => '<string>',
            'startOn' => '<string>',
            'state' => '<string>',
        ],
        // ...
    ],
    'ownerAccount' => '<string>',
    'partnerName' => '<string>',
    'portEncryptionStatus' => '<string>',
    'providerName' => '<string>',
    'region' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'vlan' => <integer>,
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

AssociateMacSecKey

$result = $client->associateMacSecKey([/* ... */]);
$promise = $client->associateMacSecKeyAsync([/* ... */]);

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

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

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

Parameter Syntax

$result = $client->associateMacSecKey([
    'cak' => '<string>',
    'ckn' => '<string>',
    'connectionId' => '<string>', // REQUIRED
    'secretARN' => '<string>',
]);

Parameter Details

Result Syntax

[
    'connectionId' => '<string>',
    'macSecKeys' => [
        [
            'ckn' => '<string>',
            'secretARN' => '<string>',
            'startOn' => '<string>',
            'state' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

AssociateVirtualInterface

$result = $client->associateVirtualInterface([/* ... */]);
$promise = $client->associateVirtualInterfaceAsync([/* ... */]);

Associates a virtual interface with a specified link aggregation group (LAG) or connection. Connectivity to Amazon Web Services 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.

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 for the association.

Parameter Syntax

$result = $client->associateVirtualInterface([
    'connectionId' => '<string>', // REQUIRED
    'virtualInterfaceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'addressFamily' => 'ipv4|ipv6',
    'amazonAddress' => '<string>',
    'amazonSideAsn' => <integer>,
    'asn' => <integer>,
    'authKey' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'bgpPeers' => [
        [
            'addressFamily' => 'ipv4|ipv6',
            'amazonAddress' => '<string>',
            'asn' => <integer>,
            'authKey' => '<string>',
            'awsDeviceV2' => '<string>',
            'awsLogicalDeviceId' => '<string>',
            'bgpPeerId' => '<string>',
            'bgpPeerState' => 'verifying|pending|available|deleting|deleted',
            'bgpStatus' => 'up|down|unknown',
            'customerAddress' => '<string>',
        ],
        // ...
    ],
    'connectionId' => '<string>',
    'customerAddress' => '<string>',
    'customerRouterConfig' => '<string>',
    'directConnectGatewayId' => '<string>',
    'jumboFrameCapable' => true || false,
    'location' => '<string>',
    'mtu' => <integer>,
    'ownerAccount' => '<string>',
    'region' => '<string>',
    'routeFilterPrefixes' => [
        [
            'cidr' => '<string>',
        ],
        // ...
    ],
    'siteLinkEnabled' => true || false,
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'virtualGatewayId' => '<string>',
    'virtualInterfaceId' => '<string>',
    'virtualInterfaceName' => '<string>',
    'virtualInterfaceState' => 'confirming|verifying|pending|available|down|deleting|deleted|rejected|unknown',
    'virtualInterfaceType' => '<string>',
    'vlan' => <integer>,
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

ConfirmConnection

$result = $client->confirmConnection([/* ... */]);
$promise = $client->confirmConnectionAsync([/* ... */]);

Confirms the creation of the specified hosted connection on an interconnect.

Upon creation, the hosted connection is initially in the Ordering state, and remains in this state until the owner confirms creation of the hosted connection.

Parameter Syntax

$result = $client->confirmConnection([
    'connectionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'connectionState' => 'ordering|requested|pending|available|down|deleting|deleted|rejected|unknown',
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

ConfirmCustomerAgreement

$result = $client->confirmCustomerAgreement([/* ... */]);
$promise = $client->confirmCustomerAgreementAsync([/* ... */]);

The confirmation of the terms of agreement when creating the connection/link aggregation group (LAG).

Parameter Syntax

$result = $client->confirmCustomerAgreement([
    'agreementName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'status' => '<string>',
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

ConfirmPrivateVirtualInterface

$result = $client->confirmPrivateVirtualInterface([/* ... */]);
$promise = $client->confirmPrivateVirtualInterfaceAsync([/* ... */]);

Accepts ownership of a private virtual interface created by another Amazon Web Services account.

After the virtual interface owner makes this call, the virtual interface is created and attached to the specified virtual private gateway or Direct Connect gateway, and is made available to handle traffic.

Parameter Syntax

$result = $client->confirmPrivateVirtualInterface([
    'directConnectGatewayId' => '<string>',
    'virtualGatewayId' => '<string>',
    'virtualInterfaceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'virtualInterfaceState' => 'confirming|verifying|pending|available|down|deleting|deleted|rejected|unknown',
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

ConfirmPublicVirtualInterface

$result = $client->confirmPublicVirtualInterface([/* ... */]);
$promise = $client->confirmPublicVirtualInterfaceAsync([/* ... */]);

Accepts ownership of a public virtual interface created by another Amazon Web Services account.

After the virtual interface owner makes this call, the specified virtual interface is created and made available to handle traffic.

Parameter Syntax

$result = $client->confirmPublicVirtualInterface([
    'virtualInterfaceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'virtualInterfaceState' => 'confirming|verifying|pending|available|down|deleting|deleted|rejected|unknown',
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

ConfirmTransitVirtualInterface

$result = $client->confirmTransitVirtualInterface([/* ... */]);
$promise = $client->confirmTransitVirtualInterfaceAsync([/* ... */]);

Accepts ownership of a transit virtual interface created by another Amazon Web Services account.

After the owner of the transit virtual interface makes this call, the specified transit virtual interface is created and made available to handle traffic.

Parameter Syntax

$result = $client->confirmTransitVirtualInterface([
    'directConnectGatewayId' => '<string>', // REQUIRED
    'virtualInterfaceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'virtualInterfaceState' => 'confirming|verifying|pending|available|down|deleting|deleted|rejected|unknown',
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

CreateBGPPeer

$result = $client->createBGPPeer([/* ... */]);
$promise = $client->createBGPPeerAsync([/* ... */]);

Creates a BGP peer on the specified virtual interface.

You must create a BGP peer for the corresponding address family (IPv4/IPv6) in order to access Amazon Web Services resources that also use that address family.

If logical redundancy is not supported by the connection, interconnect, or LAG, the BGP peer cannot be in the same address family as an existing BGP peer on the virtual interface.

When creating a IPv6 BGP peer, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon 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 on the allow list for the virtual interface.

Parameter Syntax

$result = $client->createBGPPeer([
    'newBGPPeer' => [
        'addressFamily' => 'ipv4|ipv6',
        'amazonAddress' => '<string>',
        'asn' => <integer>,
        'authKey' => '<string>',
        'customerAddress' => '<string>',
    ],
    'virtualInterfaceId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'virtualInterface' => [
        'addressFamily' => 'ipv4|ipv6',
        'amazonAddress' => '<string>',
        'amazonSideAsn' => <integer>,
        'asn' => <integer>,
        'authKey' => '<string>',
        'awsDeviceV2' => '<string>',
        'awsLogicalDeviceId' => '<string>',
        'bgpPeers' => [
            [
                'addressFamily' => 'ipv4|ipv6',
                'amazonAddress' => '<string>',
                'asn' => <integer>,
                'authKey' => '<string>',
                'awsDeviceV2' => '<string>',
                'awsLogicalDeviceId' => '<string>',
                'bgpPeerId' => '<string>',
                'bgpPeerState' => 'verifying|pending|available|deleting|deleted',
                'bgpStatus' => 'up|down|unknown',
                'customerAddress' => '<string>',
            ],
            // ...
        ],
        'connectionId' => '<string>',
        'customerAddress' => '<string>',
        'customerRouterConfig' => '<string>',
        'directConnectGatewayId' => '<string>',
        'jumboFrameCapable' => true || false,
        'location' => '<string>',
        'mtu' => <integer>,
        'ownerAccount' => '<string>',
        'region' => '<string>',
        'routeFilterPrefixes' => [
            [
                'cidr' => '<string>',
            ],
            // ...
        ],
        'siteLinkEnabled' => true || false,
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'virtualGatewayId' => '<string>',
        'virtualInterfaceId' => '<string>',
        'virtualInterfaceName' => '<string>',
        'virtualInterfaceState' => 'confirming|verifying|pending|available|down|deleting|deleted|rejected|unknown',
        'virtualInterfaceType' => '<string>',
        'vlan' => <integer>,
    ],
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

CreateConnection

$result = $client->createConnection([/* ... */]);
$promise = $client->createConnectionAsync([/* ... */]);

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

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

To find the locations for your Region, use DescribeLocations.

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

Parameter Syntax

$result = $client->createConnection([
    'bandwidth' => '<string>', // REQUIRED
    'connectionName' => '<string>', // REQUIRED
    'lagId' => '<string>',
    'location' => '<string>', // REQUIRED
    'providerName' => '<string>',
    'requestMACSec' => true || false,
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'awsDevice' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'bandwidth' => '<string>',
    'connectionId' => '<string>',
    'connectionName' => '<string>',
    'connectionState' => 'ordering|requested|pending|available|down|deleting|deleted|rejected|unknown',
    'encryptionMode' => '<string>',
    'hasLogicalRedundancy' => 'unknown|yes|no',
    'jumboFrameCapable' => true || false,
    'lagId' => '<string>',
    'loaIssueTime' => <DateTime>,
    'location' => '<string>',
    'macSecCapable' => true || false,
    'macSecKeys' => [
        [
            'ckn' => '<string>',
            'secretARN' => '<string>',
            'startOn' => '<string>',
            'state' => '<string>',
        ],
        // ...
    ],
    'ownerAccount' => '<string>',
    'partnerName' => '<string>',
    'portEncryptionStatus' => '<string>',
    'providerName' => '<string>',
    'region' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'vlan' => <integer>,
]

Result Details

Errors

DuplicateTagKeysException:

A tag key was specified more than once.

TooManyTagsException:

You have reached the limit on the number of tags that can be assigned.

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

CreateDirectConnectGateway

$result = $client->createDirectConnectGateway([/* ... */]);
$promise = $client->createDirectConnectGatewayAsync([/* ... */]);

Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways. A Direct Connect gateway is global and visible in any Amazon Web Services Region after it is created. The virtual interfaces and virtual private gateways that are connected through a Direct Connect gateway can be in different Amazon Web Services Regions. This enables you to connect to a VPC in any Region, regardless of the Region in which the virtual interfaces are located, and pass traffic between them.

Parameter Syntax

$result = $client->createDirectConnectGateway([
    'amazonSideAsn' => <integer>,
    'directConnectGatewayName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'directConnectGateway' => [
        'amazonSideAsn' => <integer>,
        'directConnectGatewayId' => '<string>',
        'directConnectGatewayName' => '<string>',
        'directConnectGatewayState' => 'pending|available|deleting|deleted',
        'ownerAccount' => '<string>',
        'stateChangeError' => '<string>',
    ],
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

CreateDirectConnectGatewayAssociation

$result = $client->createDirectConnectGatewayAssociation([/* ... */]);
$promise = $client->createDirectConnectGatewayAssociationAsync([/* ... */]);

Creates an association between a Direct Connect gateway and a virtual private gateway. The virtual private gateway must be attached to a VPC and must not be associated with another Direct Connect gateway.

Parameter Syntax

$result = $client->createDirectConnectGatewayAssociation([
    'addAllowedPrefixesToDirectConnectGateway' => [
        [
            'cidr' => '<string>',
        ],
        // ...
    ],
    'directConnectGatewayId' => '<string>', // REQUIRED
    'gatewayId' => '<string>',
    'virtualGatewayId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'directConnectGatewayAssociation' => [
        'allowedPrefixesToDirectConnectGateway' => [
            [
                'cidr' => '<string>',
            ],
            // ...
        ],
        'associatedGateway' => [
            'id' => '<string>',
            'ownerAccount' => '<string>',
            'region' => '<string>',
            'type' => 'virtualPrivateGateway|transitGateway',
        ],
        'associationId' => '<string>',
        'associationState' => 'associating|associated|disassociating|disassociated|updating',
        'directConnectGatewayId' => '<string>',
        'directConnectGatewayOwnerAccount' => '<string>',
        'stateChangeError' => '<string>',
        'virtualGatewayId' => '<string>',
        'virtualGatewayOwnerAccount' => '<string>',
        'virtualGatewayRegion' => '<string>',
    ],
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

CreateDirectConnectGatewayAssociationProposal

$result = $client->createDirectConnectGatewayAssociationProposal([/* ... */]);
$promise = $client->createDirectConnectGatewayAssociationProposalAsync([/* ... */]);

Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway.

You can associate a Direct Connect gateway and virtual private gateway or transit gateway that is owned by any Amazon Web Services account.

Parameter Syntax

$result = $client->createDirectConnectGatewayAssociationProposal([
    'addAllowedPrefixesToDirectConnectGateway' => [
        [
            'cidr' => '<string>',
        ],
        // ...
    ],
    'directConnectGatewayId' => '<string>', // REQUIRED
    'directConnectGatewayOwnerAccount' => '<string>', // REQUIRED
    'gatewayId' => '<string>', // REQUIRED
    'removeAllowedPrefixesToDirectConnectGateway' => [
        [
            'cidr' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'directConnectGatewayAssociationProposal' => [
        'associatedGateway' => [
            'id' => '<string>',
            'ownerAccount' => '<string>',
            'region' => '<string>',
            'type' => 'virtualPrivateGateway|transitGateway',
        ],
        'directConnectGatewayId' => '<string>',
        'directConnectGatewayOwnerAccount' => '<string>',
        'existingAllowedPrefixesToDirectConnectGateway' => [
            [
                'cidr' => '<string>',
            ],
            // ...
        ],
        'proposalId' => '<string>',
        'proposalState' => 'requested|accepted|deleted',
        'requestedAllowedPrefixesToDirectConnectGateway' => [
            [
                'cidr' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

CreateInterconnect

$result = $client->createInterconnect([/* ... */]);
$promise = $client->createInterconnectAsync([/* ... */]);

Creates an interconnect between an Direct Connect Partner's network and a specific Direct Connect location.

An interconnect is a connection that is capable of hosting other connections. The Direct Connect Partner can use an interconnect to provide Direct Connect hosted connections to customers through their own network services. Like a standard connection, an interconnect links the partner's network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an 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 Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no interconnect is created.

For each end customer, the Direct Connect Partner provisions a connection on their interconnect by calling AllocateHostedConnection. The end customer can then connect to Amazon Web Services resources by creating a virtual interface on their connection, using the VLAN assigned to them by the Direct Connect Partner.

Parameter Syntax

$result = $client->createInterconnect([
    'bandwidth' => '<string>', // REQUIRED
    'interconnectName' => '<string>', // REQUIRED
    'lagId' => '<string>',
    'location' => '<string>', // REQUIRED
    'providerName' => '<string>',
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'awsDevice' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'bandwidth' => '<string>',
    'hasLogicalRedundancy' => 'unknown|yes|no',
    'interconnectId' => '<string>',
    'interconnectName' => '<string>',
    'interconnectState' => 'requested|pending|available|down|deleting|deleted|unknown',
    'jumboFrameCapable' => true || false,
    'lagId' => '<string>',
    'loaIssueTime' => <DateTime>,
    'location' => '<string>',
    'providerName' => '<string>',
    'region' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

DuplicateTagKeysException:

A tag key was specified more than once.

TooManyTagsException:

You have reached the limit on the number of tags that can be assigned.

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

CreateLag

$result = $client->createLag([/* ... */]);
$promise = $client->createLagAsync([/* ... */]);

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

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

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

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

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

Parameter Syntax

$result = $client->createLag([
    'childConnectionTags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>',
        ],
        // ...
    ],
    'connectionId' => '<string>',
    'connectionsBandwidth' => '<string>', // REQUIRED
    'lagName' => '<string>', // REQUIRED
    'location' => '<string>', // REQUIRED
    'numberOfConnections' => <integer>, // REQUIRED
    'providerName' => '<string>',
    'requestMACSec' => true || false,
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'allowsHostedConnections' => true || false,
    'awsDevice' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'connections' => [
        [
            'awsDevice' => '<string>',
            'awsDeviceV2' => '<string>',
            'awsLogicalDeviceId' => '<string>',
            'bandwidth' => '<string>',
            'connectionId' => '<string>',
            'connectionName' => '<string>',
            'connectionState' => 'ordering|requested|pending|available|down|deleting|deleted|rejected|unknown',
            'encryptionMode' => '<string>',
            'hasLogicalRedundancy' => 'unknown|yes|no',
            'jumboFrameCapable' => true || false,
            'lagId' => '<string>',
            'loaIssueTime' => <DateTime>,
            'location' => '<string>',
            'macSecCapable' => true || false,
            'macSecKeys' => [
                [
                    'ckn' => '<string>',
                    'secretARN' => '<string>',
                    'startOn' => '<string>',
                    'state' => '<string>',
                ],
                // ...
            ],
            'ownerAccount' => '<string>',
            'partnerName' => '<string>',
            'portEncryptionStatus' => '<string>',
            'providerName' => '<string>',
            'region' => '<string>',
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'vlan' => <integer>,
        ],
        // ...
    ],
    'connectionsBandwidth' => '<string>',
    'encryptionMode' => '<string>',
    'hasLogicalRedundancy' => 'unknown|yes|no',
    'jumboFrameCapable' => true || false,
    'lagId' => '<string>',
    'lagName' => '<string>',
    'lagState' => 'requested|pending|available|down|deleting|deleted|unknown',
    'location' => '<string>',
    'macSecCapable' => true || false,
    'macSecKeys' => [
        [
            'ckn' => '<string>',
            'secretARN' => '<string>',
            'startOn' => '<string>',
            'state' => '<string>',
        ],
        // ...
    ],
    'minimumLinks' => <integer>,
    'numberOfConnections' => <integer>,
    'ownerAccount' => '<string>',
    'providerName' => '<string>',
    'region' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

DuplicateTagKeysException:

A tag key was specified more than once.

TooManyTagsException:

You have reached the limit on the number of tags that can be assigned.

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

CreatePrivateVirtualInterface

$result = $client->createPrivateVirtualInterface([/* ... */]);
$promise = $client->createPrivateVirtualInterfaceAsync([/* ... */]);

Creates a private virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. A private virtual interface can be connected to either a Direct Connect gateway or a Virtual Private Gateway (VGW). Connecting the private virtual interface to a Direct Connect gateway enables the possibility for connecting to multiple VPCs, including VPCs in different Amazon Web Services Regions. Connecting the private virtual interface to a VGW only provides access to a single VPC within the same Region.

Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces.

Parameter Syntax

$result = $client->createPrivateVirtualInterface([
    'connectionId' => '<string>', // REQUIRED
    'newPrivateVirtualInterface' => [ // REQUIRED
        'addressFamily' => 'ipv4|ipv6',
        'amazonAddress' => '<string>',
        'asn' => <integer>, // REQUIRED
        'authKey' => '<string>',
        'customerAddress' => '<string>',
        'directConnectGatewayId' => '<string>',
        'enableSiteLink' => true || false,
        'mtu' => <integer>,
        'tags' => [
            [
                'key' => '<string>', // REQUIRED
                'value' => '<string>',
            ],
            // ...
        ],
        'virtualGatewayId' => '<string>',
        'virtualInterfaceName' => '<string>', // REQUIRED
        'vlan' => <integer>, // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'addressFamily' => 'ipv4|ipv6',
    'amazonAddress' => '<string>',
    'amazonSideAsn' => <integer>,
    'asn' => <integer>,
    'authKey' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'bgpPeers' => [
        [
            'addressFamily' => 'ipv4|ipv6',
            'amazonAddress' => '<string>',
            'asn' => <integer>,
            'authKey' => '<string>',
            'awsDeviceV2' => '<string>',
            'awsLogicalDeviceId' => '<string>',
            'bgpPeerId' => '<string>',
            'bgpPeerState' => 'verifying|pending|available|deleting|deleted',
            'bgpStatus' => 'up|down|unknown',
            'customerAddress' => '<string>',
        ],
        // ...
    ],
    'connectionId' => '<string>',
    'customerAddress' => '<string>',
    'customerRouterConfig' => '<string>',
    'directConnectGatewayId' => '<string>',
    'jumboFrameCapable' => true || false,
    'location' => '<string>',
    'mtu' => <integer>,
    'ownerAccount' => '<string>',
    'region' => '<string>',
    'routeFilterPrefixes' => [
        [
            'cidr' => '<string>',
        ],
        // ...
    ],
    'siteLinkEnabled' => true || false,
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'virtualGatewayId' => '<string>',
    'virtualInterfaceId' => '<string>',
    'virtualInterfaceName' => '<string>',
    'virtualInterfaceState' => 'confirming|verifying|pending|available|down|deleting|deleted|rejected|unknown',
    'virtualInterfaceType' => '<string>',
    'vlan' => <integer>,
]

Result Details

Errors

DuplicateTagKeysException:

A tag key was specified more than once.

TooManyTagsException:

You have reached the limit on the number of tags that can be assigned.

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

CreatePublicVirtualInterface

$result = $client->createPublicVirtualInterface([/* ... */]);
$promise = $client->createPublicVirtualInterfaceAsync([/* ... */]);

Creates a public virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. A public virtual interface supports sending traffic to public services of Amazon Web Services such as Amazon S3.

When creating an IPv6 public virtual interface (addressFamily is ipv6), leave the customer and amazon address fields blank to use auto-assigned IPv6 space. Custom IPv6 addresses are not supported.

Parameter Syntax

$result = $client->createPublicVirtualInterface([
    'connectionId' => '<string>', // REQUIRED
    'newPublicVirtualInterface' => [ // REQUIRED
        'addressFamily' => 'ipv4|ipv6',
        'amazonAddress' => '<string>',
        'asn' => <integer>, // REQUIRED
        'authKey' => '<string>',
        'customerAddress' => '<string>',
        'routeFilterPrefixes' => [
            [
                'cidr' => '<string>',
            ],
            // ...
        ],
        'tags' => [
            [
                'key' => '<string>', // REQUIRED
                'value' => '<string>',
            ],
            // ...
        ],
        'virtualInterfaceName' => '<string>', // REQUIRED
        'vlan' => <integer>, // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'addressFamily' => 'ipv4|ipv6',
    'amazonAddress' => '<string>',
    'amazonSideAsn' => <integer>,
    'asn' => <integer>,
    'authKey' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'bgpPeers' => [
        [
            'addressFamily' => 'ipv4|ipv6',
            'amazonAddress' => '<string>',
            'asn' => <integer>,
            'authKey' => '<string>',
            'awsDeviceV2' => '<string>',
            'awsLogicalDeviceId' => '<string>',
            'bgpPeerId' => '<string>',
            'bgpPeerState' => 'verifying|pending|available|deleting|deleted',
            'bgpStatus' => 'up|down|unknown',
            'customerAddress' => '<string>',
        ],
        // ...
    ],
    'connectionId' => '<string>',
    'customerAddress' => '<string>',
    'customerRouterConfig' => '<string>',
    'directConnectGatewayId' => '<string>',
    'jumboFrameCapable' => true || false,
    'location' => '<string>',
    'mtu' => <integer>,
    'ownerAccount' => '<string>',
    'region' => '<string>',
    'routeFilterPrefixes' => [
        [
            'cidr' => '<string>',
        ],
        // ...
    ],
    'siteLinkEnabled' => true || false,
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'virtualGatewayId' => '<string>',
    'virtualInterfaceId' => '<string>',
    'virtualInterfaceName' => '<string>',
    'virtualInterfaceState' => 'confirming|verifying|pending|available|down|deleting|deleted|rejected|unknown',
    'virtualInterfaceType' => '<string>',
    'vlan' => <integer>,
]

Result Details

Errors

DuplicateTagKeysException:

A tag key was specified more than once.

TooManyTagsException:

You have reached the limit on the number of tags that can be assigned.

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

CreateTransitVirtualInterface

$result = $client->createTransitVirtualInterface([/* ... */]);
$promise = $client->createTransitVirtualInterfaceAsync([/* ... */]);

Creates a transit virtual interface. A transit virtual interface should be used to access one or more transit gateways associated with Direct Connect gateways. A transit virtual interface enables the connection of multiple VPCs attached to a transit gateway to a Direct Connect gateway.

A jumbo MTU value must be either 1500 or 8500. No other values will be accepted. Setting the MTU of a virtual interface to 8500 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces.

Parameter Syntax

$result = $client->createTransitVirtualInterface([
    'connectionId' => '<string>', // REQUIRED
    'newTransitVirtualInterface' => [ // REQUIRED
        'addressFamily' => 'ipv4|ipv6',
        'amazonAddress' => '<string>',
        'asn' => <integer>,
        'authKey' => '<string>',
        'customerAddress' => '<string>',
        'directConnectGatewayId' => '<string>',
        'enableSiteLink' => true || false,
        'mtu' => <integer>,
        'tags' => [
            [
                'key' => '<string>', // REQUIRED
                'value' => '<string>',
            ],
            // ...
        ],
        'virtualInterfaceName' => '<string>',
        'vlan' => <integer>,
    ],
]);

Parameter Details

Result Syntax

[
    'virtualInterface' => [
        'addressFamily' => 'ipv4|ipv6',
        'amazonAddress' => '<string>',
        'amazonSideAsn' => <integer>,
        'asn' => <integer>,
        'authKey' => '<string>',
        'awsDeviceV2' => '<string>',
        'awsLogicalDeviceId' => '<string>',
        'bgpPeers' => [
            [
                'addressFamily' => 'ipv4|ipv6',
                'amazonAddress' => '<string>',
                'asn' => <integer>,
                'authKey' => '<string>',
                'awsDeviceV2' => '<string>',
                'awsLogicalDeviceId' => '<string>',
                'bgpPeerId' => '<string>',
                'bgpPeerState' => 'verifying|pending|available|deleting|deleted',
                'bgpStatus' => 'up|down|unknown',
                'customerAddress' => '<string>',
            ],
            // ...
        ],
        'connectionId' => '<string>',
        'customerAddress' => '<string>',
        'customerRouterConfig' => '<string>',
        'directConnectGatewayId' => '<string>',
        'jumboFrameCapable' => true || false,
        'location' => '<string>',
        'mtu' => <integer>,
        'ownerAccount' => '<string>',
        'region' => '<string>',
        'routeFilterPrefixes' => [
            [
                'cidr' => '<string>',
            ],
            // ...
        ],
        'siteLinkEnabled' => true || false,
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'virtualGatewayId' => '<string>',
        'virtualInterfaceId' => '<string>',
        'virtualInterfaceName' => '<string>',
        'virtualInterfaceState' => 'confirming|verifying|pending|available|down|deleting|deleted|rejected|unknown',
        'virtualInterfaceType' => '<string>',
        'vlan' => <integer>,
    ],
]

Result Details

Errors

DuplicateTagKeysException:

A tag key was specified more than once.

TooManyTagsException:

You have reached the limit on the number of tags that can be assigned.

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DeleteBGPPeer

$result = $client->deleteBGPPeer([/* ... */]);
$promise = $client->deleteBGPPeerAsync([/* ... */]);

Deletes the specified BGP peer on the specified virtual interface with the specified customer address and ASN.

You cannot delete the last BGP peer from a virtual interface.

Parameter Syntax

$result = $client->deleteBGPPeer([
    'asn' => <integer>,
    'bgpPeerId' => '<string>',
    'customerAddress' => '<string>',
    'virtualInterfaceId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'virtualInterface' => [
        'addressFamily' => 'ipv4|ipv6',
        'amazonAddress' => '<string>',
        'amazonSideAsn' => <integer>,
        'asn' => <integer>,
        'authKey' => '<string>',
        'awsDeviceV2' => '<string>',
        'awsLogicalDeviceId' => '<string>',
        'bgpPeers' => [
            [
                'addressFamily' => 'ipv4|ipv6',
                'amazonAddress' => '<string>',
                'asn' => <integer>,
                'authKey' => '<string>',
                'awsDeviceV2' => '<string>',
                'awsLogicalDeviceId' => '<string>',
                'bgpPeerId' => '<string>',
                'bgpPeerState' => 'verifying|pending|available|deleting|deleted',
                'bgpStatus' => 'up|down|unknown',
                'customerAddress' => '<string>',
            ],
            // ...
        ],
        'connectionId' => '<string>',
        'customerAddress' => '<string>',
        'customerRouterConfig' => '<string>',
        'directConnectGatewayId' => '<string>',
        'jumboFrameCapable' => true || false,
        'location' => '<string>',
        'mtu' => <integer>,
        'ownerAccount' => '<string>',
        'region' => '<string>',
        'routeFilterPrefixes' => [
            [
                'cidr' => '<string>',
            ],
            // ...
        ],
        'siteLinkEnabled' => true || false,
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'virtualGatewayId' => '<string>',
        'virtualInterfaceId' => '<string>',
        'virtualInterfaceName' => '<string>',
        'virtualInterfaceState' => 'confirming|verifying|pending|available|down|deleting|deleted|rejected|unknown',
        'virtualInterfaceType' => '<string>',
        'vlan' => <integer>,
    ],
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DeleteConnection

$result = $client->deleteConnection([/* ... */]);
$promise = $client->deleteConnectionAsync([/* ... */]);

Deletes the specified connection.

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

Parameter Syntax

$result = $client->deleteConnection([
    'connectionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'awsDevice' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'bandwidth' => '<string>',
    'connectionId' => '<string>',
    'connectionName' => '<string>',
    'connectionState' => 'ordering|requested|pending|available|down|deleting|deleted|rejected|unknown',
    'encryptionMode' => '<string>',
    'hasLogicalRedundancy' => 'unknown|yes|no',
    'jumboFrameCapable' => true || false,
    'lagId' => '<string>',
    'loaIssueTime' => <DateTime>,
    'location' => '<string>',
    'macSecCapable' => true || false,
    'macSecKeys' => [
        [
            'ckn' => '<string>',
            'secretARN' => '<string>',
            'startOn' => '<string>',
            'state' => '<string>',
        ],
        // ...
    ],
    'ownerAccount' => '<string>',
    'partnerName' => '<string>',
    'portEncryptionStatus' => '<string>',
    'providerName' => '<string>',
    'region' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'vlan' => <integer>,
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DeleteDirectConnectGateway

$result = $client->deleteDirectConnectGateway([/* ... */]);
$promise = $client->deleteDirectConnectGatewayAsync([/* ... */]);

Deletes the specified Direct Connect gateway. You must first delete all virtual interfaces that are attached to the Direct Connect gateway and disassociate all virtual private gateways associated with the Direct Connect gateway.

Parameter Syntax

$result = $client->deleteDirectConnectGateway([
    'directConnectGatewayId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'directConnectGateway' => [
        'amazonSideAsn' => <integer>,
        'directConnectGatewayId' => '<string>',
        'directConnectGatewayName' => '<string>',
        'directConnectGatewayState' => 'pending|available|deleting|deleted',
        'ownerAccount' => '<string>',
        'stateChangeError' => '<string>',
    ],
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DeleteDirectConnectGatewayAssociation

$result = $client->deleteDirectConnectGatewayAssociation([/* ... */]);
$promise = $client->deleteDirectConnectGatewayAssociationAsync([/* ... */]);

Deletes the association between the specified Direct Connect gateway and virtual private gateway.

We recommend that you specify the associationID to delete the association. Alternatively, if you own virtual gateway and a Direct Connect gateway association, you can specify the virtualGatewayId and directConnectGatewayId to delete an association.

Parameter Syntax

$result = $client->deleteDirectConnectGatewayAssociation([
    'associationId' => '<string>',
    'directConnectGatewayId' => '<string>',
    'virtualGatewayId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'directConnectGatewayAssociation' => [
        'allowedPrefixesToDirectConnectGateway' => [
            [
                'cidr' => '<string>',
            ],
            // ...
        ],
        'associatedGateway' => [
            'id' => '<string>',
            'ownerAccount' => '<string>',
            'region' => '<string>',
            'type' => 'virtualPrivateGateway|transitGateway',
        ],
        'associationId' => '<string>',
        'associationState' => 'associating|associated|disassociating|disassociated|updating',
        'directConnectGatewayId' => '<string>',
        'directConnectGatewayOwnerAccount' => '<string>',
        'stateChangeError' => '<string>',
        'virtualGatewayId' => '<string>',
        'virtualGatewayOwnerAccount' => '<string>',
        'virtualGatewayRegion' => '<string>',
    ],
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DeleteDirectConnectGatewayAssociationProposal

$result = $client->deleteDirectConnectGatewayAssociationProposal([/* ... */]);
$promise = $client->deleteDirectConnectGatewayAssociationProposalAsync([/* ... */]);

Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway or transit gateway.

Parameter Syntax

$result = $client->deleteDirectConnectGatewayAssociationProposal([
    'proposalId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'directConnectGatewayAssociationProposal' => [
        'associatedGateway' => [
            'id' => '<string>',
            'ownerAccount' => '<string>',
            'region' => '<string>',
            'type' => 'virtualPrivateGateway|transitGateway',
        ],
        'directConnectGatewayId' => '<string>',
        'directConnectGatewayOwnerAccount' => '<string>',
        'existingAllowedPrefixesToDirectConnectGateway' => [
            [
                'cidr' => '<string>',
            ],
            // ...
        ],
        'proposalId' => '<string>',
        'proposalState' => 'requested|accepted|deleted',
        'requestedAllowedPrefixesToDirectConnectGateway' => [
            [
                'cidr' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DeleteInterconnect

$result = $client->deleteInterconnect([/* ... */]);
$promise = $client->deleteInterconnectAsync([/* ... */]);

Deletes the specified interconnect.

Parameter Syntax

$result = $client->deleteInterconnect([
    'interconnectId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'interconnectState' => 'requested|pending|available|down|deleting|deleted|unknown',
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DeleteLag

$result = $client->deleteLag([/* ... */]);
$promise = $client->deleteLagAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteLag([
    'lagId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'allowsHostedConnections' => true || false,
    'awsDevice' => '<string>',
    'awsDeviceV2' => '<string>',
    'awsLogicalDeviceId' => '<string>',
    'connections' => [
        [
            'awsDevice' => '<string>',
            'awsDeviceV2' => '<string>',
            'awsLogicalDeviceId' => '<string>',
            'bandwidth' => '<string>',
            'connectionId' => '<string>',
            'connectionName' => '<string>',
            'connectionState' => 'ordering|requested|pending|available|down|deleting|deleted|rejected|unknown',
            'encryptionMode' => '<string>',
            'hasLogicalRedundancy' => 'unknown|yes|no',
            'jumboFrameCapable' => true || false,
            'lagId' => '<string>',
            'loaIssueTime' => <DateTime>,
            'location' => '<string>',
            'macSecCapable' => true || false,
            'macSecKeys' => [
                [
                    'ckn' => '<string>',
                    'secretARN' => '<string>',
                    'startOn' => '<string>',
                    'state' => '<string>',
                ],
                // ...
            ],
            'ownerAccount' => '<string>',
            'partnerName' => '<string>',
            'portEncryptionStatus' => '<string>',
            'providerName' => '<string>',
            'region' => '<string>',
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'vlan' => <integer>,
        ],
        // ...
    ],
    'connectionsBandwidth' => '<string>',
    'encryptionMode' => '<string>',
    'hasLogicalRedundancy' => 'unknown|yes|no',
    'jumboFrameCapable' => true || false,
    'lagId' => '<string>',
    'lagName' => '<string>',
    'lagState' => 'requested|pending|available|down|deleting|deleted|unknown',
    'location' => '<string>',
    'macSecCapable' => true || false,
    'macSecKeys' => [
        [
            'ckn' => '<string>',
            'secretARN' => '<string>',
            'startOn' => '<string>',
            'state' => '<string>',
        ],
        // ...
    ],
    'minimumLinks' => <integer>,
    'numberOfConnections' => <integer>,
    'ownerAccount' => '<string>',
    'providerName' => '<string>',
    'region' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DeleteVirtualInterface

$result = $client->deleteVirtualInterface([/* ... */]);
$promise = $client->deleteVirtualInterfaceAsync([/* ... */]);

Deletes a virtual interface.

Parameter Syntax

$result = $client->deleteVirtualInterface([
    'virtualInterfaceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'virtualInterfaceState' => 'confirming|verifying|pending|available|down|deleting|deleted|rejected|unknown',
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DescribeConnectionLoa

$result = $client->describeConnectionLoa([/* ... */]);
$promise = $client->describeConnectionLoaAsync([/* ... */]);

Deprecated. Use DescribeLoa instead.

Gets the LOA-CFA for a connection.

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that your APN partner or service provider uses when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations in the Direct Connect User Guide.

Parameter Syntax

$result = $client->describeConnectionLoa([
    'connectionId' => '<string>', // REQUIRED
    'loaContentType' => 'application/pdf',
    'providerName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'loa' => [
        'loaContent' => <string || resource || Psr\Http\Message\StreamInterface>,
        'loaContentType' => 'application/pdf',
    ],
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DescribeConnections

$result = $client->describeConnections([/* ... */]);
$promise = $client->describeConnectionsAsync([/* ... */]);

Displays the specified connection or all connections in this Region.

Parameter Syntax

$result = $client->describeConnections([
    'connectionId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'connections' => [
        [
            'awsDevice' => '<string>',
            'awsDeviceV2' => '<string>',
            'awsLogicalDeviceId' => '<string>',
            'bandwidth' => '<string>',
            'connectionId' => '<string>',
            'connectionName' => '<string>',
            'connectionState' => 'ordering|requested|pending|available|down|deleting|deleted|rejected|unknown',
            'encryptionMode' => '<string>',
            'hasLogicalRedundancy' => 'unknown|yes|no',
            'jumboFrameCapable' => true || false,
            'lagId' => '<string>',
            'loaIssueTime' => <DateTime>,
            'location' => '<string>',
            'macSecCapable' => true || false,
            'macSecKeys' => [
                [
                    'ckn' => '<string>',
                    'secretARN' => '<string>',
                    'startOn' => '<string>',
                    'state' => '<string>',
                ],
                // ...
            ],
            'ownerAccount' => '<string>',
            'partnerName' => '<string>',
            'portEncryptionStatus' => '<string>',
            'providerName' => '<string>',
            'region' => '<string>',
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'vlan' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DescribeConnectionsOnInterconnect

$result = $client->describeConnectionsOnInterconnect([/* ... */]);
$promise = $client->describeConnectionsOnInterconnectAsync([/* ... */]);

Deprecated. Use DescribeHostedConnections instead.

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

Parameter Syntax

$result = $client->describeConnectionsOnInterconnect([
    'interconnectId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'connections' => [
        [
            'awsDevice' => '<string>',
            'awsDeviceV2' => '<string>',
            'awsLogicalDeviceId' => '<string>',
            'bandwidth' => '<string>',
            'connectionId' => '<string>',
            'connectionName' => '<string>',
            'connectionState' => 'ordering|requested|pending|available|down|deleting|deleted|rejected|unknown',
            'encryptionMode' => '<string>',
            'hasLogicalRedundancy' => 'unknown|yes|no',
            'jumboFrameCapable' => true || false,
            'lagId' => '<string>',
            'loaIssueTime' => <DateTime>,
            'location' => '<string>',
            'macSecCapable' => true || false,
            'macSecKeys' => [
                [
                    'ckn' => '<string>',
                    'secretARN' => '<string>',
                    'startOn' => '<string>',
                    'state' => '<string>',
                ],
                // ...
            ],
            'ownerAccount' => '<string>',
            'partnerName' => '<string>',
            'portEncryptionStatus' => '<string>',
            'providerName' => '<string>',
            'region' => '<string>',
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'vlan' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DescribeCustomerMetadata

$result = $client->describeCustomerMetadata([/* ... */]);
$promise = $client->describeCustomerMetadataAsync([/* ... */]);

Get and view a list of customer agreements, along with their signed status and whether the customer is an NNIPartner, NNIPartnerV2, or a nonPartner.

Parameter Syntax

$result = $client->describeCustomerMetadata([
]);

Parameter Details

Result Syntax

[
    'agreements' => [
        [
            'agreementName' => '<string>',
            'status' => '<string>',
        ],
        // ...
    ],
    'nniPartnerType' => 'v1|v2|nonPartner',
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DescribeDirectConnectGatewayAssociationProposals

$result = $client->describeDirectConnectGatewayAssociationProposals([/* ... */]);
$promise = $client->describeDirectConnectGatewayAssociationProposalsAsync([/* ... */]);

Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway.

Parameter Syntax

$result = $client->describeDirectConnectGatewayAssociationProposals([
    'associatedGatewayId' => '<string>',
    'directConnectGatewayId' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'proposalId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'directConnectGatewayAssociationProposals' => [
        [
            'associatedGateway' => [
                'id' => '<string>',
                'ownerAccount' => '<string>',
                'region' => '<string>',
                'type' => 'virtualPrivateGateway|transitGateway',
            ],
            'directConnectGatewayId' => '<string>',
            'directConnectGatewayOwnerAccount' => '<string>',
            'existingAllowedPrefixesToDirectConnectGateway' => [
                [
                    'cidr' => '<string>',
                ],
                // ...
            ],
            'proposalId' => '<string>',
            'proposalState' => 'requested|accepted|deleted',
            'requestedAllowedPrefixesToDirectConnectGateway' => [
                [
                    'cidr' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DescribeDirectConnectGatewayAssociations

$result = $client->describeDirectConnectGatewayAssociations([/* ... */]);
$promise = $client->describeDirectConnectGatewayAssociationsAsync([/* ... */]);

Lists the associations between your Direct Connect gateways and virtual private gateways and transit gateways. You must specify one of the following:

• A Direct Connect gateway

  The response contains all virtual private gateways and transit gateways associated with the Direct Connect gateway.

• A virtual private gateway

  The response contains the Direct Connect gateway.

• A transit gateway

  The response contains the Direct Connect gateway.

• A Direct Connect gateway and a virtual private gateway

  The response contains the association between the Direct Connect gateway and virtual private gateway.

• A Direct Connect gateway and a transit gateway

  The response contains the association between the Direct Connect gateway and transit gateway.

Parameter Syntax

$result = $client->describeDirectConnectGatewayAssociations([
    'associatedGatewayId' => '<string>',
    'associationId' => '<string>',
    'directConnectGatewayId' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'virtualGatewayId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'directConnectGatewayAssociations' => [
        [
            'allowedPrefixesToDirectConnectGateway' => [
                [
                    'cidr' => '<string>',
                ],
                // ...
            ],
            'associatedGateway' => [
                'id' => '<string>',
                'ownerAccount' => '<string>',
                'region' => '<string>',
                'type' => 'virtualPrivateGateway|transitGateway',
            ],
            'associationId' => '<string>',
            'associationState' => 'associating|associated|disassociating|disassociated|updating',
            'directConnectGatewayId' => '<string>',
            'directConnectGatewayOwnerAccount' => '<string>',
            'stateChangeError' => '<string>',
            'virtualGatewayId' => '<string>',
            'virtualGatewayOwnerAccount' => '<string>',
            'virtualGatewayRegion' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DescribeDirectConnectGatewayAttachments

$result = $client->describeDirectConnectGatewayAttachments([/* ... */]);
$promise = $client->describeDirectConnectGatewayAttachmentsAsync([/* ... */]);

Lists the attachments between your Direct Connect gateways and virtual interfaces. You must specify a Direct Connect gateway, a virtual interface, or both. If you specify a Direct Connect gateway, the response contains all virtual interfaces attached to the Direct Connect gateway. If you specify a virtual interface, the response contains all Direct Connect gateways attached to the virtual interface. If you specify both, the response contains the attachment between the Direct Connect gateway and the virtual interface.

Parameter Syntax

$result = $client->describeDirectConnectGatewayAttachments([
    'directConnectGatewayId' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'virtualInterfaceId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'directConnectGatewayAttachments' => [
        [
            'attachmentState' => 'attaching|attached|detaching|detached',
            'attachmentType' => 'TransitVirtualInterface|PrivateVirtualInterface',
            'directConnectGatewayId' => '<string>',
            'stateChangeError' => '<string>',
            'virtualInterfaceId' => '<string>',
            'virtualInterfaceOwnerAccount' => '<string>',
            'virtualInterfaceRegion' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DescribeDirectConnectGateways

$result = $client->describeDirectConnectGateways([/* ... */]);
$promise = $client->describeDirectConnectGatewaysAsync([/* ... */]);

Lists all your Direct Connect gateways or only the specified Direct Connect gateway. Deleted Direct Connect gateways are not returned.

Parameter Syntax

$result = $client->describeDirectConnectGateways([
    'directConnectGatewayId' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'directConnectGateways' => [
        [
            'amazonSideAsn' => <integer>,
            'directConnectGatewayId' => '<string>',
            'directConnectGatewayName' => '<string>',
            'directConnectGatewayState' => 'pending|available|deleting|deleted',
            'ownerAccount' => '<string>',
            'stateChangeError' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DescribeHostedConnections

$result = $client->describeHostedConnections([/* ... */]);
$promise = $client->describeHostedConnectionsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeHostedConnections([
    'connectionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'connections' => [
        [
            'awsDevice' => '<string>',
            'awsDeviceV2' => '<string>',
            'awsLogicalDeviceId' => '<string>',
            'bandwidth' => '<string>',
            'connectionId' => '<string>',
            'connectionName' => '<string>',
            'connectionState' => 'ordering|requested|pending|available|down|deleting|deleted|rejected|unknown',
            'encryptionMode' => '<string>',
            'hasLogicalRedundancy' => 'unknown|yes|no',
            'jumboFrameCapable' => true || false,
            'lagId' => '<string>',
            'loaIssueTime' => <DateTime>,
            'location' => '<string>',
            'macSecCapable' => true || false,
            'macSecKeys' => [
                [
                    'ckn' => '<string>',
                    'secretARN' => '<string>',
                    'startOn' => '<string>',
                    'state' => '<string>',
                ],
                // ...
            ],
            'ownerAccount' => '<string>',
            'partnerName' => '<string>',
            'portEncryptionStatus' => '<string>',
            'providerName' => '<string>',
            'region' => '<string>',
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'vlan' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DescribeInterconnectLoa

$result = $client->describeInterconnectLoa([/* ... */]);
$promise = $client->describeInterconnectLoaAsync([/* ... */]);

Deprecated. Use DescribeLoa instead.

Gets the LOA-CFA for the specified interconnect.

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations in the Direct Connect User Guide.

Parameter Syntax

$result = $client->describeInterconnectLoa([
    'interconnectId' => '<string>', // REQUIRED
    'loaContentType' => 'application/pdf',
    'providerName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'loa' => [
        'loaContent' => <string || resource || Psr\Http\Message\StreamInterface>,
        'loaContentType' => 'application/pdf',
    ],
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DescribeInterconnects

$result = $client->describeInterconnects([/* ... */]);
$promise = $client->describeInterconnectsAsync([/* ... */]);

Lists the interconnects owned by the Amazon Web Services account or only the specified interconnect.

Parameter Syntax

$result = $client->describeInterconnects([
    'interconnectId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'interconnects' => [
        [
            'awsDevice' => '<string>',
            'awsDeviceV2' => '<string>',
            'awsLogicalDeviceId' => '<string>',
            'bandwidth' => '<string>',
            'hasLogicalRedundancy' => 'unknown|yes|no',
            'interconnectId' => '<string>',
            'interconnectName' => '<string>',
            'interconnectState' => 'requested|pending|available|down|deleting|deleted|unknown',
            'jumboFrameCapable' => true || false,
            'lagId' => '<string>',
            'loaIssueTime' => <DateTime>,
            'location' => '<string>',
            'providerName' => '<string>',
            'region' => '<string>',
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DescribeLags

$result = $client->describeLags([/* ... */]);
$promise = $client->describeLagsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeLags([
    'lagId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'lags' => [
        [
            'allowsHostedConnections' => true || false,
            'awsDevice' => '<string>',
            'awsDeviceV2' => '<string>',
            'awsLogicalDeviceId' => '<string>',
            'connections' => [
                [
                    'awsDevice' => '<string>',
                    'awsDeviceV2' => '<string>',
                    'awsLogicalDeviceId' => '<string>',
                    'bandwidth' => '<string>',
                    'connectionId' => '<string>',
                    'connectionName' => '<string>',
                    'connectionState' => 'ordering|requested|pending|available|down|deleting|deleted|rejected|unknown',
                    'encryptionMode' => '<string>',
                    'hasLogicalRedundancy' => 'unknown|yes|no',
                    'jumboFrameCapable' => true || false,
                    'lagId' => '<string>',
                    'loaIssueTime' => <DateTime>,
                    'location' => '<string>',
                    'macSecCapable' => true || false,
                    'macSecKeys' => [
                        [
                            'ckn' => '<string>',
                            'secretARN' => '<string>',
                            'startOn' => '<string>',
                            'state' => '<string>',
                        ],
                        // ...
                    ],
                    'ownerAccount' => '<string>',
                    'partnerName' => '<string>',
                    'portEncryptionStatus' => '<string>',
                    'providerName' => '<string>',
                    'region' => '<string>',
                    'tags' => [
                        [
                            'key' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'vlan' => <integer>,
                ],
                // ...
            ],
            'connectionsBandwidth' => '<string>',
            'encryptionMode' => '<string>',
            'hasLogicalRedundancy' => 'unknown|yes|no',
            'jumboFrameCapable' => true || false,
            'lagId' => '<string>',
            'lagName' => '<string>',
            'lagState' => 'requested|pending|available|down|deleting|deleted|unknown',
            'location' => '<string>',
            'macSecCapable' => true || false,
            'macSecKeys' => [
                [
                    'ckn' => '<string>',
                    'secretARN' => '<string>',
                    'startOn' => '<string>',
                    'state' => '<string>',
                ],
                // ...
            ],
            'minimumLinks' => <integer>,
            'numberOfConnections' => <integer>,
            'ownerAccount' => '<string>',
            'providerName' => '<string>',
            'region' => '<string>',
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

DirectConnectServerException:

A server-side error occurred.

DirectConnectClientException:

One or more parameters are not valid.

DescribeLoa

$result = $client->describeLoa([/* ... */]);
$promise = $client->describeLoaAsync([/* ... */]);

Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations in the Direct Connect User Guide.