Skip to content

DirectConnect module#

Index > DirectConnect

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

How to install#

You can generate type annotations for boto3 package locally with mypy_boto3_builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.35.86' mypy_boto3_builder
  2. Select boto3-stubs AWS SDK.
  3. Add DirectConnect service.
  4. 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 boto3-stubs for DirectConnect service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[directconnect]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[directconnect]'

# standalone installation
python -m pip install mypy-boto3-directconnect

How to uninstall#

python -m pip uninstall -y mypy-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 mypy_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 mypy_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"))

Literals#

Type annotations for literals used in methods and schema.

# AddressFamilyType usage example

from mypy_boto3_directconnect.literals import AddressFamilyType

def get_value() -> AddressFamilyType:
    return "ipv4"

Type definitions#

Type annotations for type definitions used in methods and schema.