Skip to content

QBusiness module#

Index > QBusiness

Auto-generated documentation for QBusiness type annotations stubs module mypy-boto3-qbusiness.

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 QBusiness.

From PyPI with pip#

Install boto3-stubs for QBusiness service.

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


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


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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

QBusinessClient#

Type annotations and code completion for boto3.client("qbusiness") as QBusinessClient boto3 documentation

# QBusinessClient usage example

from boto3.session import Session

from mypy_boto3_qbusiness.client import QBusinessClient

def get_client() -> QBusinessClient:
    return Session().client("qbusiness")

Paginators#

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

# GetChatControlsConfigurationPaginator usage example

from boto3.session import Session

from mypy_boto3_qbusiness.paginator import GetChatControlsConfigurationPaginator

def get_get_chat_controls_configuration_paginator() -> GetChatControlsConfigurationPaginator:
    return Session().client("qbusiness").get_paginator("get_chat_controls_configuration"))

Literals#

Type annotations for literals used in methods and schema.

# ActionPayloadFieldTypeType usage example

from mypy_boto3_qbusiness.literals import ActionPayloadFieldTypeType

def get_value() -> ActionPayloadFieldTypeType:
    return "ARRAY"

Type definitions#

Type annotations for type definitions used in methods and schema.