Skip to content

MQ module#

Index > MQ

Auto-generated documentation for MQ type annotations stubs module mypy-boto3-mq.

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

From PyPI with pip#

Install boto3-stubs for MQ service.

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

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

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

How to uninstall#

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


Code samples can be found in Examples.


Type annotations and code completion for boto3.client("mq") as MQClient boto3 documentation

# MQClient usage example

from boto3.session import Session

from mypy_boto3_mq.client import MQClient

def get_client() -> MQClient:
    return Session().client("mq")


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

# ListBrokersPaginator usage example

from boto3.session import Session

from mypy_boto3_mq.paginator import ListBrokersPaginator

def get_list_brokers_paginator() -> ListBrokersPaginator:
    return Session().client("mq").get_paginator("list_brokers"))


Type annotations for literals used in methods and schemas.

# AuthenticationStrategyType usage example

from mypy_boto3_mq.literals import AuthenticationStrategyType

def get_value() -> AuthenticationStrategyType:
    return "LDAP"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# ActionRequiredTypeDef usage example

from mypy_boto3_mq.type_defs import ActionRequiredTypeDef

def get_value() -> ActionRequiredTypeDef:
    return {
        "ActionRequiredCode": ...,