DirectConnect module#
Index > DirectConnect
Auto-generated documentation for DirectConnect type annotations stubs module types-boto3-directconnect.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy_boto3_builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.35.86' mypy_boto3_builder
- Select
boto3
AWS SDK. - Add
DirectConnect
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and DirectConnect
.
From PyPI with pip#
Install types-boto3
for DirectConnect
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[directconnect]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[directconnect]'
# standalone installation
python -m pip install types-boto3-directconnect
How to uninstall#
python -m pip uninstall -y types-boto3-directconnect
Usage#
Code samples can be found in Examples.
DirectConnectClient#
Type annotations and code completion for boto3.client("directconnect")
as DirectConnectClient
boto3 documentation
# DirectConnectClient usage example
from boto3.session import Session
from types_boto3_directconnect.client import DirectConnectClient
def get_client() -> DirectConnectClient:
return Session().client("directconnect")
Paginators#
Type annotations and code completion for paginators
from boto3.client("directconnect").get_paginator("...")
.
# DescribeDirectConnectGatewayAssociationsPaginator usage example
from boto3.session import Session
from types_boto3_directconnect.paginator import DescribeDirectConnectGatewayAssociationsPaginator
def get_describe_direct_connect_gateway_associations_paginator() -> DescribeDirectConnectGatewayAssociationsPaginator:
return Session().client("directconnect").get_paginator("describe_direct_connect_gateway_associations"))
- DescribeDirectConnectGatewayAssociationsPaginator
- DescribeDirectConnectGatewayAttachmentsPaginator
- DescribeDirectConnectGatewaysPaginator
Literals#
Type annotations for literals used in methods and schema.
# AddressFamilyType usage example
from types_boto3_directconnect.literals import AddressFamilyType
def get_value() -> AddressFamilyType:
return "ipv4"
- AddressFamilyType
- BGPPeerStateType
- BGPStatusType
- ConnectionStateType
- DescribeDirectConnectGatewayAssociationsPaginatorName
- DescribeDirectConnectGatewayAttachmentsPaginatorName
- DescribeDirectConnectGatewaysPaginatorName
- DirectConnectGatewayAssociationProposalStateType
- DirectConnectGatewayAssociationStateType
- DirectConnectGatewayAttachmentStateType
- DirectConnectGatewayAttachmentTypeType
- DirectConnectGatewayStateType
- GatewayTypeType
- HasLogicalRedundancyType
- InterconnectStateType
- LagStateType
- LoaContentTypeType
- NniPartnerTypeType
- VirtualInterfaceStateType
- DirectConnectServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- RouteFilterPrefixTypeDef
- ResponseMetadataTypeDef
- AllocateConnectionOnInterconnectRequestRequestTypeDef
- TagTypeDef
- AssociateConnectionWithLagRequestRequestTypeDef
- AssociateHostedConnectionRequestRequestTypeDef
- AssociateMacSecKeyRequestRequestTypeDef
- MacSecKeyTypeDef
- AssociateVirtualInterfaceRequestRequestTypeDef
- AssociatedCoreNetworkTypeDef
- AssociatedGatewayTypeDef
- BGPPeerTypeDef
- ConfirmConnectionRequestRequestTypeDef
- ConfirmCustomerAgreementRequestRequestTypeDef
- ConfirmPrivateVirtualInterfaceRequestRequestTypeDef
- ConfirmPublicVirtualInterfaceRequestRequestTypeDef
- ConfirmTransitVirtualInterfaceRequestRequestTypeDef
- NewBGPPeerTypeDef
- CreateDirectConnectGatewayRequestRequestTypeDef
- DirectConnectGatewayTypeDef
- CustomerAgreementTypeDef
- DeleteBGPPeerRequestRequestTypeDef
- DeleteConnectionRequestRequestTypeDef
- DeleteDirectConnectGatewayAssociationProposalRequestRequestTypeDef
- DeleteDirectConnectGatewayAssociationRequestRequestTypeDef
- DeleteDirectConnectGatewayRequestRequestTypeDef
- DeleteInterconnectRequestRequestTypeDef
- DeleteLagRequestRequestTypeDef
- DeleteVirtualInterfaceRequestRequestTypeDef
- DescribeConnectionLoaRequestRequestTypeDef
- LoaTypeDef
- DescribeConnectionsOnInterconnectRequestRequestTypeDef
- DescribeConnectionsRequestRequestTypeDef
- DescribeDirectConnectGatewayAssociationProposalsRequestRequestTypeDef
- PaginatorConfigTypeDef
- DescribeDirectConnectGatewayAssociationsRequestRequestTypeDef
- DescribeDirectConnectGatewayAttachmentsRequestRequestTypeDef
- DirectConnectGatewayAttachmentTypeDef
- DescribeDirectConnectGatewaysRequestRequestTypeDef
- DescribeHostedConnectionsRequestRequestTypeDef
- DescribeInterconnectLoaRequestRequestTypeDef
- DescribeInterconnectsRequestRequestTypeDef
- DescribeLagsRequestRequestTypeDef
- DescribeLoaRequestRequestTypeDef
- DescribeRouterConfigurationRequestRequestTypeDef
- RouterTypeTypeDef
- DescribeTagsRequestRequestTypeDef
- DescribeVirtualInterfacesRequestRequestTypeDef
- DisassociateConnectionFromLagRequestRequestTypeDef
- DisassociateMacSecKeyRequestRequestTypeDef
- ListVirtualInterfaceTestHistoryRequestRequestTypeDef
- VirtualInterfaceTestHistoryTypeDef
- LocationTypeDef
- StartBgpFailoverTestRequestRequestTypeDef
- StopBgpFailoverTestRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateConnectionRequestRequestTypeDef
- UpdateDirectConnectGatewayRequestRequestTypeDef
- UpdateLagRequestRequestTypeDef
- UpdateVirtualInterfaceAttributesRequestRequestTypeDef
- VirtualGatewayTypeDef
- AcceptDirectConnectGatewayAssociationProposalRequestRequestTypeDef
- CreateDirectConnectGatewayAssociationProposalRequestRequestTypeDef
- CreateDirectConnectGatewayAssociationRequestRequestTypeDef
- UpdateDirectConnectGatewayAssociationRequestRequestTypeDef
- ConfirmConnectionResponseTypeDef
- ConfirmCustomerAgreementResponseTypeDef
- ConfirmPrivateVirtualInterfaceResponseTypeDef
- ConfirmPublicVirtualInterfaceResponseTypeDef
- ConfirmTransitVirtualInterfaceResponseTypeDef
- DeleteInterconnectResponseTypeDef
- DeleteVirtualInterfaceResponseTypeDef
- LoaResponseTypeDef
- AllocateHostedConnectionRequestRequestTypeDef
- CreateConnectionRequestRequestTypeDef
- CreateInterconnectRequestRequestTypeDef
- CreateLagRequestRequestTypeDef
- InterconnectResponseTypeDef
- InterconnectTypeDef
- NewPrivateVirtualInterfaceAllocationTypeDef
- NewPrivateVirtualInterfaceTypeDef
- NewPublicVirtualInterfaceAllocationTypeDef
- NewPublicVirtualInterfaceTypeDef
- NewTransitVirtualInterfaceAllocationTypeDef
- NewTransitVirtualInterfaceTypeDef
- ResourceTagTypeDef
- TagResourceRequestRequestTypeDef
- AssociateMacSecKeyResponseTypeDef
- ConnectionResponseTypeDef
- ConnectionTypeDef
- DisassociateMacSecKeyResponseTypeDef
- DirectConnectGatewayAssociationProposalTypeDef
- DirectConnectGatewayAssociationTypeDef
- VirtualInterfaceResponseTypeDef
- VirtualInterfaceTypeDef
- CreateBGPPeerRequestRequestTypeDef
- CreateDirectConnectGatewayResultTypeDef
- DeleteDirectConnectGatewayResultTypeDef
- DescribeDirectConnectGatewaysResultTypeDef
- UpdateDirectConnectGatewayResponseTypeDef
- DescribeCustomerMetadataResponseTypeDef
- DescribeConnectionLoaResponseTypeDef
- DescribeInterconnectLoaResponseTypeDef
- DescribeDirectConnectGatewayAssociationsRequestPaginateTypeDef
- DescribeDirectConnectGatewayAttachmentsRequestPaginateTypeDef
- DescribeDirectConnectGatewaysRequestPaginateTypeDef
- DescribeDirectConnectGatewayAttachmentsResultTypeDef
- DescribeRouterConfigurationResponseTypeDef
- ListVirtualInterfaceTestHistoryResponseTypeDef
- StartBgpFailoverTestResponseTypeDef
- StopBgpFailoverTestResponseTypeDef
- LocationsTypeDef
- VirtualGatewaysTypeDef
- InterconnectsTypeDef
- AllocatePrivateVirtualInterfaceRequestRequestTypeDef
- CreatePrivateVirtualInterfaceRequestRequestTypeDef
- AllocatePublicVirtualInterfaceRequestRequestTypeDef
- CreatePublicVirtualInterfaceRequestRequestTypeDef
- AllocateTransitVirtualInterfaceRequestRequestTypeDef
- CreateTransitVirtualInterfaceRequestRequestTypeDef
- DescribeTagsResponseTypeDef
- ConnectionsTypeDef
- LagResponseTypeDef
- LagTypeDef
- CreateDirectConnectGatewayAssociationProposalResultTypeDef
- DeleteDirectConnectGatewayAssociationProposalResultTypeDef
- DescribeDirectConnectGatewayAssociationProposalsResultTypeDef
- AcceptDirectConnectGatewayAssociationProposalResultTypeDef
- CreateDirectConnectGatewayAssociationResultTypeDef
- DeleteDirectConnectGatewayAssociationResultTypeDef
- DescribeDirectConnectGatewayAssociationsResultTypeDef
- UpdateDirectConnectGatewayAssociationResultTypeDef
- AllocateTransitVirtualInterfaceResultTypeDef
- CreateBGPPeerResponseTypeDef
- CreateTransitVirtualInterfaceResultTypeDef
- DeleteBGPPeerResponseTypeDef
- VirtualInterfacesTypeDef
- LagsTypeDef