Skip to content

DirectConnectClient

Index > DirectConnect > DirectConnectClient

Auto-generated documentation for DirectConnect type annotations stubs module mypy-boto3-directconnect.

DirectConnectClient

Type annotations and code completion for boto3.client("directconnect"). boto3 documentation

Usage example
from boto3.session import Session
from mypy_boto3_directconnect.client import DirectConnectClient

def get_directconnect_client() -> DirectConnectClient:
    return Session().client("directconnect")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("directconnect").exceptions structure.

Usage example
client = boto3.client("directconnect")

try:
    do_something(client)
except (
    client.ClientError,
    client.DirectConnectClientException,
    client.DirectConnectServerException,
    client.DuplicateTagKeysException,
    client.TooManyTagsException,
) as e:
    print(e)
Type checking example
from mypy_boto3_directconnect.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods

accept_direct_connect_gateway_association_proposal

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

Type annotations and code completion for boto3.client("directconnect").accept_direct_connect_gateway_association_proposal method. boto3 documentation

Method definition
def accept_direct_connect_gateway_association_proposal(
    self,
    *,
    directConnectGatewayId: str,
    proposalId: str,
    associatedGatewayOwnerAccount: str,
    overrideAllowedPrefixesToDirectConnectGateway: Sequence[RouteFilterPrefixTypeDef] = ...,  # (1)
) -> AcceptDirectConnectGatewayAssociationProposalResultTypeDef:  # (2)
    ...
  1. See RouteFilterPrefixTypeDef
  2. See AcceptDirectConnectGatewayAssociationProposalResultTypeDef
Usage example with kwargs
kwargs: AcceptDirectConnectGatewayAssociationProposalRequestRequestTypeDef = {  # (1)
    "directConnectGatewayId": ...,
    "proposalId": ...,
    "associatedGatewayOwnerAccount": ...,
}

parent.accept_direct_connect_gateway_association_proposal(**kwargs)
  1. See AcceptDirectConnectGatewayAssociationProposalRequestRequestTypeDef

allocate_connection_on_interconnect

Deprecated.

Type annotations and code completion for boto3.client("directconnect").allocate_connection_on_interconnect method. boto3 documentation

Method definition
def allocate_connection_on_interconnect(
    self,
    *,
    bandwidth: str,
    connectionName: str,
    ownerAccount: str,
    interconnectId: str,
    vlan: int,
) -> ConnectionResponseMetadataTypeDef:  # (1)
    ...
  1. See ConnectionResponseMetadataTypeDef
Usage example with kwargs
kwargs: AllocateConnectionOnInterconnectRequestRequestTypeDef = {  # (1)
    "bandwidth": ...,
    "connectionName": ...,
    "ownerAccount": ...,
    "interconnectId": ...,
    "vlan": ...,
}

parent.allocate_connection_on_interconnect(**kwargs)
  1. See AllocateConnectionOnInterconnectRequestRequestTypeDef

allocate_hosted_connection

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

Type annotations and code completion for boto3.client("directconnect").allocate_hosted_connection method. boto3 documentation

Method definition
def allocate_hosted_connection(
    self,
    *,
    connectionId: str,
    ownerAccount: str,
    bandwidth: str,
    connectionName: str,
    vlan: int,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> ConnectionResponseMetadataTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See ConnectionResponseMetadataTypeDef
Usage example with kwargs
kwargs: AllocateHostedConnectionRequestRequestTypeDef = {  # (1)
    "connectionId": ...,
    "ownerAccount": ...,
    "bandwidth": ...,
    "connectionName": ...,
    "vlan": ...,
}

parent.allocate_hosted_connection(**kwargs)
  1. See AllocateHostedConnectionRequestRequestTypeDef

allocate_private_virtual_interface

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

Type annotations and code completion for boto3.client("directconnect").allocate_private_virtual_interface method. boto3 documentation

Method definition
def allocate_private_virtual_interface(
    self,
    *,
    connectionId: str,
    ownerAccount: str,
    newPrivateVirtualInterfaceAllocation: NewPrivateVirtualInterfaceAllocationTypeDef,  # (1)
) -> VirtualInterfaceResponseMetadataTypeDef:  # (2)
    ...
  1. See NewPrivateVirtualInterfaceAllocationTypeDef
  2. See VirtualInterfaceResponseMetadataTypeDef
Usage example with kwargs
kwargs: AllocatePrivateVirtualInterfaceRequestRequestTypeDef = {  # (1)
    "connectionId": ...,
    "ownerAccount": ...,
    "newPrivateVirtualInterfaceAllocation": ...,
}

parent.allocate_private_virtual_interface(**kwargs)
  1. See AllocatePrivateVirtualInterfaceRequestRequestTypeDef

allocate_public_virtual_interface

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

Type annotations and code completion for boto3.client("directconnect").allocate_public_virtual_interface method. boto3 documentation

Method definition
def allocate_public_virtual_interface(
    self,
    *,
    connectionId: str,
    ownerAccount: str,
    newPublicVirtualInterfaceAllocation: NewPublicVirtualInterfaceAllocationTypeDef,  # (1)
) -> VirtualInterfaceResponseMetadataTypeDef:  # (2)
    ...
  1. See NewPublicVirtualInterfaceAllocationTypeDef
  2. See VirtualInterfaceResponseMetadataTypeDef
Usage example with kwargs
kwargs: AllocatePublicVirtualInterfaceRequestRequestTypeDef = {  # (1)
    "connectionId": ...,
    "ownerAccount": ...,
    "newPublicVirtualInterfaceAllocation": ...,
}

parent.allocate_public_virtual_interface(**kwargs)
  1. See AllocatePublicVirtualInterfaceRequestRequestTypeDef

allocate_transit_virtual_interface

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

Type annotations and code completion for boto3.client("directconnect").allocate_transit_virtual_interface method. boto3 documentation

Method definition
def allocate_transit_virtual_interface(
    self,
    *,
    connectionId: str,
    ownerAccount: str,
    newTransitVirtualInterfaceAllocation: NewTransitVirtualInterfaceAllocationTypeDef,  # (1)
) -> AllocateTransitVirtualInterfaceResultTypeDef:  # (2)
    ...
  1. See NewTransitVirtualInterfaceAllocationTypeDef
  2. See AllocateTransitVirtualInterfaceResultTypeDef
Usage example with kwargs
kwargs: AllocateTransitVirtualInterfaceRequestRequestTypeDef = {  # (1)
    "connectionId": ...,
    "ownerAccount": ...,
    "newTransitVirtualInterfaceAllocation": ...,
}

parent.allocate_transit_virtual_interface(**kwargs)
  1. See AllocateTransitVirtualInterfaceRequestRequestTypeDef

associate_connection_with_lag

Associates an existing connection with a link aggregation group (LAG).

Type annotations and code completion for boto3.client("directconnect").associate_connection_with_lag method. boto3 documentation

Method definition
def associate_connection_with_lag(
    self,
    *,
    connectionId: str,
    lagId: str,
) -> ConnectionResponseMetadataTypeDef:  # (1)
    ...
  1. See ConnectionResponseMetadataTypeDef
Usage example with kwargs
kwargs: AssociateConnectionWithLagRequestRequestTypeDef = {  # (1)
    "connectionId": ...,
    "lagId": ...,
}

parent.associate_connection_with_lag(**kwargs)
  1. See AssociateConnectionWithLagRequestRequestTypeDef

associate_hosted_connection

Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect.

Type annotations and code completion for boto3.client("directconnect").associate_hosted_connection method. boto3 documentation

Method definition
def associate_hosted_connection(
    self,
    *,
    connectionId: str,
    parentConnectionId: str,
) -> ConnectionResponseMetadataTypeDef:  # (1)
    ...
  1. See ConnectionResponseMetadataTypeDef
Usage example with kwargs
kwargs: AssociateHostedConnectionRequestRequestTypeDef = {  # (1)
    "connectionId": ...,
    "parentConnectionId": ...,
}

parent.associate_hosted_connection(**kwargs)
  1. See AssociateHostedConnectionRequestRequestTypeDef

associate_mac_sec_key

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

Type annotations and code completion for boto3.client("directconnect").associate_mac_sec_key method. boto3 documentation

Method definition
def associate_mac_sec_key(
    self,
    *,
    connectionId: str,
    secretARN: str = ...,
    ckn: str = ...,
    cak: str = ...,
) -> AssociateMacSecKeyResponseTypeDef:  # (1)
    ...
  1. See AssociateMacSecKeyResponseTypeDef
Usage example with kwargs
kwargs: AssociateMacSecKeyRequestRequestTypeDef = {  # (1)
    "connectionId": ...,
}

parent.associate_mac_sec_key(**kwargs)
  1. See AssociateMacSecKeyRequestRequestTypeDef

associate_virtual_interface

Associates a virtual interface with a specified link aggregation group (LAG) or connection.

Type annotations and code completion for boto3.client("directconnect").associate_virtual_interface method. boto3 documentation

Method definition
def associate_virtual_interface(
    self,
    *,
    virtualInterfaceId: str,
    connectionId: str,
) -> VirtualInterfaceResponseMetadataTypeDef:  # (1)
    ...
  1. See VirtualInterfaceResponseMetadataTypeDef
Usage example with kwargs
kwargs: AssociateVirtualInterfaceRequestRequestTypeDef = {  # (1)
    "virtualInterfaceId": ...,
    "connectionId": ...,
}

parent.associate_virtual_interface(**kwargs)
  1. See AssociateVirtualInterfaceRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("directconnect").can_paginate method. boto3 documentation

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("directconnect").close method. boto3 documentation

Method definition
def close(
    self,
) -> None:
    ...

confirm_connection

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

Type annotations and code completion for boto3.client("directconnect").confirm_connection method. boto3 documentation

Method definition
def confirm_connection(
    self,
    *,
    connectionId: str,
) -> ConfirmConnectionResponseTypeDef:  # (1)
    ...
  1. See ConfirmConnectionResponseTypeDef
Usage example with kwargs
kwargs: ConfirmConnectionRequestRequestTypeDef = {  # (1)
    "connectionId": ...,
}

parent.confirm_connection(**kwargs)
  1. See ConfirmConnectionRequestRequestTypeDef

confirm_customer_agreement

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

Type annotations and code completion for boto3.client("directconnect").confirm_customer_agreement method. boto3 documentation

Method definition
def confirm_customer_agreement(
    self,
    *,
    agreementName: str = ...,
) -> ConfirmCustomerAgreementResponseTypeDef:  # (1)
    ...
  1. See ConfirmCustomerAgreementResponseTypeDef
Usage example with kwargs
kwargs: ConfirmCustomerAgreementRequestRequestTypeDef = {  # (1)
    "agreementName": ...,
}

parent.confirm_customer_agreement(**kwargs)
  1. See ConfirmCustomerAgreementRequestRequestTypeDef

confirm_private_virtual_interface

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

Type annotations and code completion for boto3.client("directconnect").confirm_private_virtual_interface method. boto3 documentation

Method definition
def confirm_private_virtual_interface(
    self,
    *,
    virtualInterfaceId: str,
    virtualGatewayId: str = ...,
    directConnectGatewayId: str = ...,
) -> ConfirmPrivateVirtualInterfaceResponseTypeDef:  # (1)
    ...
  1. See ConfirmPrivateVirtualInterfaceResponseTypeDef
Usage example with kwargs
kwargs: ConfirmPrivateVirtualInterfaceRequestRequestTypeDef = {  # (1)
    "virtualInterfaceId": ...,
}

parent.confirm_private_virtual_interface(**kwargs)
  1. See ConfirmPrivateVirtualInterfaceRequestRequestTypeDef

confirm_public_virtual_interface

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

Type annotations and code completion for boto3.client("directconnect").confirm_public_virtual_interface method. boto3 documentation

Method definition
def confirm_public_virtual_interface(
    self,
    *,
    virtualInterfaceId: str,
) -> ConfirmPublicVirtualInterfaceResponseTypeDef:  # (1)
    ...
  1. See ConfirmPublicVirtualInterfaceResponseTypeDef
Usage example with kwargs
kwargs: ConfirmPublicVirtualInterfaceRequestRequestTypeDef = {  # (1)
    "virtualInterfaceId": ...,
}

parent.confirm_public_virtual_interface(**kwargs)
  1. See ConfirmPublicVirtualInterfaceRequestRequestTypeDef

confirm_transit_virtual_interface

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

Type annotations and code completion for boto3.client("directconnect").confirm_transit_virtual_interface method. boto3 documentation

Method definition
def confirm_transit_virtual_interface(
    self,
    *,
    virtualInterfaceId: str,
    directConnectGatewayId: str,
) -> ConfirmTransitVirtualInterfaceResponseTypeDef:  # (1)
    ...
  1. See ConfirmTransitVirtualInterfaceResponseTypeDef
Usage example with kwargs
kwargs: ConfirmTransitVirtualInterfaceRequestRequestTypeDef = {  # (1)
    "virtualInterfaceId": ...,
    "directConnectGatewayId": ...,
}

parent.confirm_transit_virtual_interface(**kwargs)
  1. See ConfirmTransitVirtualInterfaceRequestRequestTypeDef

create_bgp_peer

Creates a BGP peer on the specified virtual interface.

Type annotations and code completion for boto3.client("directconnect").create_bgp_peer method. boto3 documentation

Method definition
def create_bgp_peer(
    self,
    *,
    virtualInterfaceId: str = ...,
    newBGPPeer: NewBGPPeerTypeDef = ...,  # (1)
) -> CreateBGPPeerResponseTypeDef:  # (2)
    ...
  1. See NewBGPPeerTypeDef
  2. See CreateBGPPeerResponseTypeDef
Usage example with kwargs
kwargs: CreateBGPPeerRequestRequestTypeDef = {  # (1)
    "virtualInterfaceId": ...,
}

parent.create_bgp_peer(**kwargs)
  1. See CreateBGPPeerRequestRequestTypeDef

create_connection

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

Type annotations and code completion for boto3.client("directconnect").create_connection method. boto3 documentation

Method definition
def create_connection(
    self,
    *,
    location: str,
    bandwidth: str,
    connectionName: str,
    lagId: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
    providerName: str = ...,
    requestMACSec: bool = ...,
) -> ConnectionResponseMetadataTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See ConnectionResponseMetadataTypeDef
Usage example with kwargs
kwargs: CreateConnectionRequestRequestTypeDef = {  # (1)
    "location": ...,
    "bandwidth": ...,
    "connectionName": ...,
}

parent.create_connection(**kwargs)
  1. See CreateConnectionRequestRequestTypeDef

create_direct_connect_gateway

Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways.

Type annotations and code completion for boto3.client("directconnect").create_direct_connect_gateway method. boto3 documentation

Method definition
def create_direct_connect_gateway(
    self,
    *,
    directConnectGatewayName: str,
    amazonSideAsn: int = ...,
) -> CreateDirectConnectGatewayResultTypeDef:  # (1)
    ...
  1. See CreateDirectConnectGatewayResultTypeDef
Usage example with kwargs
kwargs: CreateDirectConnectGatewayRequestRequestTypeDef = {  # (1)
    "directConnectGatewayName": ...,
}

parent.create_direct_connect_gateway(**kwargs)
  1. See CreateDirectConnectGatewayRequestRequestTypeDef

create_direct_connect_gateway_association

Creates an association between a Direct Connect gateway and a virtual private gateway.

Type annotations and code completion for boto3.client("directconnect").create_direct_connect_gateway_association method. boto3 documentation

Method definition
def create_direct_connect_gateway_association(
    self,
    *,
    directConnectGatewayId: str,
    gatewayId: str = ...,
    addAllowedPrefixesToDirectConnectGateway: Sequence[RouteFilterPrefixTypeDef] = ...,  # (1)
    virtualGatewayId: str = ...,
) -> CreateDirectConnectGatewayAssociationResultTypeDef:  # (2)
    ...
  1. See RouteFilterPrefixTypeDef
  2. See CreateDirectConnectGatewayAssociationResultTypeDef
Usage example with kwargs
kwargs: CreateDirectConnectGatewayAssociationRequestRequestTypeDef = {  # (1)
    "directConnectGatewayId": ...,
}

parent.create_direct_connect_gateway_association(**kwargs)
  1. See CreateDirectConnectGatewayAssociationRequestRequestTypeDef

create_direct_connect_gateway_association_proposal

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

Type annotations and code completion for boto3.client("directconnect").create_direct_connect_gateway_association_proposal method. boto3 documentation

Method definition
def create_direct_connect_gateway_association_proposal(
    self,
    *,
    directConnectGatewayId: str,
    directConnectGatewayOwnerAccount: str,
    gatewayId: str,
    addAllowedPrefixesToDirectConnectGateway: Sequence[RouteFilterPrefixTypeDef] = ...,  # (1)
    removeAllowedPrefixesToDirectConnectGateway: Sequence[RouteFilterPrefixTypeDef] = ...,  # (1)
) -> CreateDirectConnectGatewayAssociationProposalResultTypeDef:  # (3)
    ...
  1. See RouteFilterPrefixTypeDef
  2. See RouteFilterPrefixTypeDef
  3. See CreateDirectConnectGatewayAssociationProposalResultTypeDef
Usage example with kwargs
kwargs: CreateDirectConnectGatewayAssociationProposalRequestRequestTypeDef = {  # (1)
    "directConnectGatewayId": ...,
    "directConnectGatewayOwnerAccount": ...,
    "gatewayId": ...,
}

parent.create_direct_connect_gateway_association_proposal(**kwargs)
  1. See CreateDirectConnectGatewayAssociationProposalRequestRequestTypeDef

create_interconnect

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

Type annotations and code completion for boto3.client("directconnect").create_interconnect method. boto3 documentation

Method definition
def create_interconnect(
    self,
    *,
    interconnectName: str,
    bandwidth: str,
    location: str,
    lagId: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
    providerName: str = ...,
) -> InterconnectResponseMetadataTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See InterconnectResponseMetadataTypeDef
Usage example with kwargs
kwargs: CreateInterconnectRequestRequestTypeDef = {  # (1)
    "interconnectName": ...,
    "bandwidth": ...,
    "location": ...,
}

parent.create_interconnect(**kwargs)
  1. See CreateInterconnectRequestRequestTypeDef

create_lag

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.

Type annotations and code completion for boto3.client("directconnect").create_lag method. boto3 documentation

Method definition
def create_lag(
    self,
    *,
    numberOfConnections: int,
    location: str,
    connectionsBandwidth: str,
    lagName: str,
    connectionId: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
    childConnectionTags: Sequence[TagTypeDef] = ...,  # (1)
    providerName: str = ...,
    requestMACSec: bool = ...,
) -> LagResponseMetadataTypeDef:  # (3)
    ...
  1. See TagTypeDef
  2. See TagTypeDef
  3. See LagResponseMetadataTypeDef
Usage example with kwargs
kwargs: CreateLagRequestRequestTypeDef = {  # (1)
    "numberOfConnections": ...,
    "location": ...,
    "connectionsBandwidth": ...,
    "lagName": ...,
}

parent.create_lag(**kwargs)
  1. See CreateLagRequestRequestTypeDef

create_private_virtual_interface

Creates a private virtual interface.

Type annotations and code completion for boto3.client("directconnect").create_private_virtual_interface method. boto3 documentation

Method definition
def create_private_virtual_interface(
    self,
    *,
    connectionId: str,
    newPrivateVirtualInterface: NewPrivateVirtualInterfaceTypeDef,  # (1)
) -> VirtualInterfaceResponseMetadataTypeDef:  # (2)
    ...
  1. See NewPrivateVirtualInterfaceTypeDef
  2. See VirtualInterfaceResponseMetadataTypeDef
Usage example with kwargs
kwargs: CreatePrivateVirtualInterfaceRequestRequestTypeDef = {  # (1)
    "connectionId": ...,
    "newPrivateVirtualInterface": ...,
}

parent.create_private_virtual_interface(**kwargs)
  1. See CreatePrivateVirtualInterfaceRequestRequestTypeDef

create_public_virtual_interface

Creates a public virtual interface.

Type annotations and code completion for boto3.client("directconnect").create_public_virtual_interface method. boto3 documentation

Method definition
def create_public_virtual_interface(
    self,
    *,
    connectionId: str,
    newPublicVirtualInterface: NewPublicVirtualInterfaceTypeDef,  # (1)
) -> VirtualInterfaceResponseMetadataTypeDef:  # (2)
    ...
  1. See NewPublicVirtualInterfaceTypeDef
  2. See VirtualInterfaceResponseMetadataTypeDef
Usage example with kwargs
kwargs: CreatePublicVirtualInterfaceRequestRequestTypeDef = {  # (1)
    "connectionId": ...,
    "newPublicVirtualInterface": ...,
}

parent.create_public_virtual_interface(**kwargs)
  1. See CreatePublicVirtualInterfaceRequestRequestTypeDef

create_transit_virtual_interface

Creates a transit virtual interface.

Type annotations and code completion for boto3.client("directconnect").create_transit_virtual_interface method. boto3 documentation

Method definition
def create_transit_virtual_interface(
    self,
    *,
    connectionId: str,
    newTransitVirtualInterface: NewTransitVirtualInterfaceTypeDef,  # (1)
) -> CreateTransitVirtualInterfaceResultTypeDef:  # (2)
    ...
  1. See NewTransitVirtualInterfaceTypeDef
  2. See CreateTransitVirtualInterfaceResultTypeDef
Usage example with kwargs
kwargs: CreateTransitVirtualInterfaceRequestRequestTypeDef = {  # (1)
    "connectionId": ...,
    "newTransitVirtualInterface": ...,
}

parent.create_transit_virtual_interface(**kwargs)
  1. See CreateTransitVirtualInterfaceRequestRequestTypeDef

delete_bgp_peer

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

Type annotations and code completion for boto3.client("directconnect").delete_bgp_peer method. boto3 documentation

Method definition
def delete_bgp_peer(
    self,
    *,
    virtualInterfaceId: str = ...,
    asn: int = ...,
    customerAddress: str = ...,
    bgpPeerId: str = ...,
) -> DeleteBGPPeerResponseTypeDef:  # (1)
    ...
  1. See DeleteBGPPeerResponseTypeDef
Usage example with kwargs
kwargs: DeleteBGPPeerRequestRequestTypeDef = {  # (1)
    "virtualInterfaceId": ...,
}

parent.delete_bgp_peer(**kwargs)
  1. See DeleteBGPPeerRequestRequestTypeDef

delete_connection

Deletes the specified connection.

Type annotations and code completion for boto3.client("directconnect").delete_connection method. boto3 documentation

Method definition
def delete_connection(
    self,
    *,
    connectionId: str,
) -> ConnectionResponseMetadataTypeDef:  # (1)
    ...
  1. See ConnectionResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteConnectionRequestRequestTypeDef = {  # (1)
    "connectionId": ...,
}

parent.delete_connection(**kwargs)
  1. See DeleteConnectionRequestRequestTypeDef

delete_direct_connect_gateway

Deletes the specified Direct Connect gateway.

Type annotations and code completion for boto3.client("directconnect").delete_direct_connect_gateway method. boto3 documentation

Method definition
def delete_direct_connect_gateway(
    self,
    *,
    directConnectGatewayId: str,
) -> DeleteDirectConnectGatewayResultTypeDef:  # (1)
    ...
  1. See DeleteDirectConnectGatewayResultTypeDef
Usage example with kwargs
kwargs: DeleteDirectConnectGatewayRequestRequestTypeDef = {  # (1)
    "directConnectGatewayId": ...,
}

parent.delete_direct_connect_gateway(**kwargs)
  1. See DeleteDirectConnectGatewayRequestRequestTypeDef

delete_direct_connect_gateway_association

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

Type annotations and code completion for boto3.client("directconnect").delete_direct_connect_gateway_association method. boto3 documentation

Method definition
def delete_direct_connect_gateway_association(
    self,
    *,
    associationId: str = ...,
    directConnectGatewayId: str = ...,
    virtualGatewayId: str = ...,
) -> DeleteDirectConnectGatewayAssociationResultTypeDef:  # (1)
    ...
  1. See DeleteDirectConnectGatewayAssociationResultTypeDef
Usage example with kwargs
kwargs: DeleteDirectConnectGatewayAssociationRequestRequestTypeDef = {  # (1)
    "associationId": ...,
}

parent.delete_direct_connect_gateway_association(**kwargs)
  1. See DeleteDirectConnectGatewayAssociationRequestRequestTypeDef

delete_direct_connect_gateway_association_proposal

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

Type annotations and code completion for boto3.client("directconnect").delete_direct_connect_gateway_association_proposal method. boto3 documentation

Method definition
def delete_direct_connect_gateway_association_proposal(
    self,
    *,
    proposalId: str,
) -> DeleteDirectConnectGatewayAssociationProposalResultTypeDef:  # (1)
    ...
  1. See DeleteDirectConnectGatewayAssociationProposalResultTypeDef
Usage example with kwargs
kwargs: DeleteDirectConnectGatewayAssociationProposalRequestRequestTypeDef = {  # (1)
    "proposalId": ...,
}

parent.delete_direct_connect_gateway_association_proposal(**kwargs)
  1. See DeleteDirectConnectGatewayAssociationProposalRequestRequestTypeDef

delete_interconnect

Deletes the specified interconnect.

Type annotations and code completion for boto3.client("directconnect").delete_interconnect method. boto3 documentation

Method definition
def delete_interconnect(
    self,
    *,
    interconnectId: str,
) -> DeleteInterconnectResponseTypeDef:  # (1)
    ...
  1. See DeleteInterconnectResponseTypeDef
Usage example with kwargs
kwargs: DeleteInterconnectRequestRequestTypeDef = {  # (1)
    "interconnectId": ...,
}

parent.delete_interconnect(**kwargs)
  1. See DeleteInterconnectRequestRequestTypeDef

delete_lag

Deletes the specified link aggregation group (LAG).

Type annotations and code completion for boto3.client("directconnect").delete_lag method. boto3 documentation

Method definition
def delete_lag(
    self,
    *,
    lagId: str,
) -> LagResponseMetadataTypeDef:  # (1)
    ...
  1. See LagResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteLagRequestRequestTypeDef = {  # (1)
    "lagId": ...,
}

parent.delete_lag(**kwargs)
  1. See DeleteLagRequestRequestTypeDef

delete_virtual_interface

Deletes a virtual interface.

Type annotations and code completion for boto3.client("directconnect").delete_virtual_interface method. boto3 documentation

Method definition
def delete_virtual_interface(
    self,
    *,
    virtualInterfaceId: str,
) -> DeleteVirtualInterfaceResponseTypeDef:  # (1)
    ...
  1. See DeleteVirtualInterfaceResponseTypeDef
Usage example with kwargs
kwargs: DeleteVirtualInterfaceRequestRequestTypeDef = {  # (1)
    "virtualInterfaceId": ...,
}

parent.delete_virtual_interface(**kwargs)
  1. See DeleteVirtualInterfaceRequestRequestTypeDef

describe_connection_loa

Deprecated.

Type annotations and code completion for boto3.client("directconnect").describe_connection_loa method. boto3 documentation

Method definition
def describe_connection_loa(
    self,
    *,
    connectionId: str,
    providerName: str = ...,
    loaContentType: LoaContentTypeType = ...,  # (1)
) -> DescribeConnectionLoaResponseTypeDef:  # (2)
    ...
  1. See LoaContentTypeType
  2. See DescribeConnectionLoaResponseTypeDef
Usage example with kwargs
kwargs: DescribeConnectionLoaRequestRequestTypeDef = {  # (1)
    "connectionId": ...,
}

parent.describe_connection_loa(**kwargs)
  1. See DescribeConnectionLoaRequestRequestTypeDef

describe_connections

Displays the specified connection or all connections in this Region.

Type annotations and code completion for boto3.client("directconnect").describe_connections method. boto3 documentation

Method definition
def describe_connections(
    self,
    *,
    connectionId: str = ...,
) -> ConnectionsTypeDef:  # (1)
    ...
  1. See ConnectionsTypeDef
Usage example with kwargs
kwargs: DescribeConnectionsRequestRequestTypeDef = {  # (1)
    "connectionId": ...,
}

parent.describe_connections(**kwargs)
  1. See DescribeConnectionsRequestRequestTypeDef

describe_connections_on_interconnect

Deprecated.

Type annotations and code completion for boto3.client("directconnect").describe_connections_on_interconnect method. boto3 documentation

Method definition
def describe_connections_on_interconnect(
    self,
    *,
    interconnectId: str,
) -> ConnectionsTypeDef:  # (1)
    ...
  1. See ConnectionsTypeDef
Usage example with kwargs
kwargs: DescribeConnectionsOnInterconnectRequestRequestTypeDef = {  # (1)
    "interconnectId": ...,
}

parent.describe_connections_on_interconnect(**kwargs)
  1. See DescribeConnectionsOnInterconnectRequestRequestTypeDef

describe_customer_metadata

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

Type annotations and code completion for boto3.client("directconnect").describe_customer_metadata method. boto3 documentation

Method definition
def describe_customer_metadata(
    self,
) -> DescribeCustomerMetadataResponseTypeDef:  # (1)
    ...
  1. See DescribeCustomerMetadataResponseTypeDef

describe_direct_connect_gateway_association_proposals

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

Type annotations and code completion for boto3.client("directconnect").describe_direct_connect_gateway_association_proposals method. boto3 documentation

Method definition
def describe_direct_connect_gateway_association_proposals(
    self,
    *,
    directConnectGatewayId: str = ...,
    proposalId: str = ...,
    associatedGatewayId: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> DescribeDirectConnectGatewayAssociationProposalsResultTypeDef:  # (1)
    ...
  1. See DescribeDirectConnectGatewayAssociationProposalsResultTypeDef
Usage example with kwargs
kwargs: DescribeDirectConnectGatewayAssociationProposalsRequestRequestTypeDef = {  # (1)
    "directConnectGatewayId": ...,
}

parent.describe_direct_connect_gateway_association_proposals(**kwargs)
  1. See DescribeDirectConnectGatewayAssociationProposalsRequestRequestTypeDef

describe_direct_connect_gateway_associations

Lists the associations between your Direct Connect gateways and virtual private gateways and transit gateways.

Type annotations and code completion for boto3.client("directconnect").describe_direct_connect_gateway_associations method. boto3 documentation

Method definition
def describe_direct_connect_gateway_associations(
    self,
    *,
    associationId: str = ...,
    associatedGatewayId: str = ...,
    directConnectGatewayId: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
    virtualGatewayId: str = ...,
) -> DescribeDirectConnectGatewayAssociationsResultTypeDef:  # (1)
    ...
  1. See DescribeDirectConnectGatewayAssociationsResultTypeDef
Usage example with kwargs
kwargs: DescribeDirectConnectGatewayAssociationsRequestRequestTypeDef = {  # (1)
    "associationId": ...,
}

parent.describe_direct_connect_gateway_associations(**kwargs)
  1. See DescribeDirectConnectGatewayAssociationsRequestRequestTypeDef

describe_direct_connect_gateway_attachments

Lists the attachments between your Direct Connect gateways and virtual interfaces.

Type annotations and code completion for boto3.client("directconnect").describe_direct_connect_gateway_attachments method. boto3 documentation

Method definition
def describe_direct_connect_gateway_attachments(
    self,
    *,
    directConnectGatewayId: str = ...,
    virtualInterfaceId: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> DescribeDirectConnectGatewayAttachmentsResultTypeDef:  # (1)
    ...
  1. See DescribeDirectConnectGatewayAttachmentsResultTypeDef
Usage example with kwargs
kwargs: DescribeDirectConnectGatewayAttachmentsRequestRequestTypeDef = {  # (1)
    "directConnectGatewayId": ...,
}

parent.describe_direct_connect_gateway_attachments(**kwargs)
  1. See DescribeDirectConnectGatewayAttachmentsRequestRequestTypeDef

describe_direct_connect_gateways

Lists all your Direct Connect gateways or only the specified Direct Connect gateway.

Type annotations and code completion for boto3.client("directconnect").describe_direct_connect_gateways method. boto3 documentation

Method definition
def describe_direct_connect_gateways(
    self,
    *,
    directConnectGatewayId: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> DescribeDirectConnectGatewaysResultTypeDef:  # (1)
    ...
  1. See DescribeDirectConnectGatewaysResultTypeDef
Usage example with kwargs
kwargs: DescribeDirectConnectGatewaysRequestRequestTypeDef = {  # (1)
    "directConnectGatewayId": ...,
}

parent.describe_direct_connect_gateways(**kwargs)
  1. See DescribeDirectConnectGatewaysRequestRequestTypeDef

describe_hosted_connections

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

Type annotations and code completion for boto3.client("directconnect").describe_hosted_connections method. boto3 documentation

Method definition
def describe_hosted_connections(
    self,
    *,
    connectionId: str,
) -> ConnectionsTypeDef:  # (1)
    ...
  1. See ConnectionsTypeDef
Usage example with kwargs
kwargs: DescribeHostedConnectionsRequestRequestTypeDef = {  # (1)
    "connectionId": ...,
}

parent.describe_hosted_connections(**kwargs)
  1. See DescribeHostedConnectionsRequestRequestTypeDef

describe_interconnect_loa

Deprecated.

Type annotations and code completion for boto3.client("directconnect").describe_interconnect_loa method. boto3 documentation

Method definition
def describe_interconnect_loa(
    self,
    *,
    interconnectId: str,
    providerName: str = ...,
    loaContentType: LoaContentTypeType = ...,  # (1)
) -> DescribeInterconnectLoaResponseTypeDef:  # (2)
    ...
  1. See LoaContentTypeType
  2. See DescribeInterconnectLoaResponseTypeDef
Usage example with kwargs
kwargs: DescribeInterconnectLoaRequestRequestTypeDef = {  # (1)
    "interconnectId": ...,
}

parent.describe_interconnect_loa(**kwargs)
  1. See DescribeInterconnectLoaRequestRequestTypeDef

describe_interconnects

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

Type annotations and code completion for boto3.client("directconnect").describe_interconnects method. boto3 documentation

Method definition
def describe_interconnects(
    self,
    *,
    interconnectId: str = ...,
) -> InterconnectsTypeDef:  # (1)
    ...
  1. See InterconnectsTypeDef
Usage example with kwargs
kwargs: DescribeInterconnectsRequestRequestTypeDef = {  # (1)
    "interconnectId": ...,
}

parent.describe_interconnects(**kwargs)
  1. See DescribeInterconnectsRequestRequestTypeDef

describe_lags

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

Type annotations and code completion for boto3.client("directconnect").describe_lags method. boto3 documentation

Method definition
def describe_lags(
    self,
    *,
    lagId: str = ...,
) -> LagsTypeDef:  # (1)
    ...
  1. See LagsTypeDef
Usage example with kwargs
kwargs: DescribeLagsRequestRequestTypeDef = {  # (1)
    "lagId": ...,
}

parent.describe_lags(**kwargs)
  1. See DescribeLagsRequestRequestTypeDef

describe_loa

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

Type annotations and code completion for boto3.client("directconnect").describe_loa method. boto3 documentation

Method definition
def describe_loa(
    self,
    *,
    connectionId: str,
    providerName: str = ...,
    loaContentType: LoaContentTypeType = ...,  # (1)
) -> LoaResponseMetadataTypeDef:  # (2)
    ...
  1. See LoaContentTypeType
  2. See LoaResponseMetadataTypeDef
Usage example with kwargs
kwargs: DescribeLoaRequestRequestTypeDef = {  # (1)
    "connectionId": ...,
}

parent.describe_loa(**kwargs)
  1. See DescribeLoaRequestRequestTypeDef

describe_locations

Lists the Direct Connect locations in the current Amazon Web Services Region.

Type annotations and code completion for boto3.client("directconnect").describe_locations method. boto3 documentation

Method definition
def describe_locations(
    self,
) -> LocationsTypeDef:  # (1)
    ...
  1. See LocationsTypeDef

describe_router_configuration

Details about the router.

Type annotations and code completion for boto3.client("directconnect").describe_router_configuration method. boto3 documentation

Method definition
def describe_router_configuration(
    self,
    *,
    virtualInterfaceId: str,
    routerTypeIdentifier: str = ...,
) -> DescribeRouterConfigurationResponseTypeDef:  # (1)
    ...
  1. See DescribeRouterConfigurationResponseTypeDef
Usage example with kwargs
kwargs: DescribeRouterConfigurationRequestRequestTypeDef = {  # (1)
    "virtualInterfaceId": ...,
}

parent.describe_router_configuration(**kwargs)
  1. See DescribeRouterConfigurationRequestRequestTypeDef

describe_tags

Describes the tags associated with the specified Direct Connect resources.

Type annotations and code completion for boto3.client("directconnect").describe_tags method. boto3 documentation

Method definition
def describe_tags(
    self,
    *,
    resourceArns: Sequence[str],
) -> DescribeTagsResponseTypeDef:  # (1)
    ...
  1. See DescribeTagsResponseTypeDef
Usage example with kwargs
kwargs: DescribeTagsRequestRequestTypeDef = {  # (1)
    "resourceArns": ...,
}

parent.describe_tags(**kwargs)
  1. See DescribeTagsRequestRequestTypeDef

describe_virtual_gateways

Lists the virtual private gateways owned by the Amazon Web Services account.

Type annotations and code completion for boto3.client("directconnect").describe_virtual_gateways method. boto3 documentation

Method definition
def describe_virtual_gateways(
    self,
) -> VirtualGatewaysTypeDef:  # (1)
    ...
  1. See VirtualGatewaysTypeDef

describe_virtual_interfaces

Displays all virtual interfaces for an Amazon Web Services account.

Type annotations and code completion for boto3.client("directconnect").describe_virtual_interfaces method. boto3 documentation

Method definition
def describe_virtual_interfaces(
    self,
    *,
    connectionId: str = ...,
    virtualInterfaceId: str = ...,
) -> VirtualInterfacesTypeDef:  # (1)
    ...
  1. See VirtualInterfacesTypeDef
Usage example with kwargs
kwargs: DescribeVirtualInterfacesRequestRequestTypeDef = {  # (1)
    "connectionId": ...,
}

parent.describe_virtual_interfaces(**kwargs)
  1. See DescribeVirtualInterfacesRequestRequestTypeDef

disassociate_connection_from_lag

Disassociates a connection from a link aggregation group (LAG).

Type annotations and code completion for boto3.client("directconnect").disassociate_connection_from_lag method. boto3 documentation

Method definition
def disassociate_connection_from_lag(
    self,
    *,
    connectionId: str,
    lagId: str,
) -> ConnectionResponseMetadataTypeDef:  # (1)
    ...
  1. See ConnectionResponseMetadataTypeDef
Usage example with kwargs
kwargs: DisassociateConnectionFromLagRequestRequestTypeDef = {  # (1)
    "connectionId": ...,
    "lagId": ...,
}

parent.disassociate_connection_from_lag(**kwargs)
  1. See DisassociateConnectionFromLagRequestRequestTypeDef

disas