Skip to content

Connect module#

Index > Connect

Auto-generated documentation for Connect type annotations stubs module mypy-boto3-connect.

How to install#

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and Connect.

From PyPI with pip#

Install boto3-stubs for Connect service.

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


# 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[connect]'


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

How to uninstall#

python -m pip uninstall -y mypy-boto3-connect

Usage#

Code samples can be found in Examples.

ConnectClient#

Type annotations and code completion for boto3.client("connect") as ConnectClient boto3 documentation

# ConnectClient usage example

from boto3.session import Session

from mypy_boto3_connect.client import ConnectClient

def get_client() -> ConnectClient:
    return Session().client("connect")

Paginators#

Type annotations and code completion for paginators from boto3.client("connect").get_paginator("...").

# GetMetricDataPaginator usage example

from boto3.session import Session

from mypy_boto3_connect.paginator import GetMetricDataPaginator

def get_get_metric_data_paginator() -> GetMetricDataPaginator:
    return Session().client("connect").get_paginator("get_metric_data"))

Literals#

Type annotations for literals used in methods and schemas.

# ActionTypeType usage example

from mypy_boto3_connect.literals import ActionTypeType

def get_value() -> ActionTypeType:
    return "ASSIGN_CONTACT_CATEGORY"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# ActionSummaryTypeDef usage example

from mypy_boto3_connect.type_defs import ActionSummaryTypeDef

def get_value() -> ActionSummaryTypeDef:
    return {
        "ActionType": ...,
    }