MQ module#
Index > MQ
Auto-generated documentation for MQ type annotations stubs module types-boto3-mq.
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
MQ
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 MQ
.
From PyPI with pip#
Install types-boto3
for MQ
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[mq]'
# 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[mq]'
# standalone installation
python -m pip install types-boto3-mq
How to uninstall#
python -m pip uninstall -y types-boto3-mq
Usage#
Code samples can be found in Examples.
MQClient#
Type annotations and code completion for boto3.client("mq")
as MQClient
boto3 documentation
# MQClient usage example
from boto3.session import Session
from types_boto3_mq.client import MQClient
def get_client() -> MQClient:
return Session().client("mq")
Paginators#
Type annotations and code completion for paginators
from boto3.client("mq").get_paginator("...")
.
# ListBrokersPaginator usage example
from boto3.session import Session
from types_boto3_mq.paginator import ListBrokersPaginator
def get_list_brokers_paginator() -> ListBrokersPaginator:
return Session().client("mq").get_paginator("list_brokers"))
Literals#
Type annotations for literals used in methods and schema.
# AuthenticationStrategyType usage example
from types_boto3_mq.literals import AuthenticationStrategyType
def get_value() -> AuthenticationStrategyType:
return "LDAP"
- AuthenticationStrategyType
- BrokerStateType
- BrokerStorageTypeType
- ChangeTypeType
- DataReplicationModeType
- DayOfWeekType
- DeploymentModeType
- EngineTypeType
- ListBrokersPaginatorName
- PromoteModeType
- SanitizationWarningReasonType
- MQServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- ActionRequiredTypeDef
- AvailabilityZoneTypeDef
- EngineVersionTypeDef
- BrokerInstanceTypeDef
- BrokerSummaryTypeDef
- ConfigurationIdTypeDef
- ConfigurationRevisionTypeDef
- EncryptionOptionsTypeDef
- LdapServerMetadataInputTypeDef
- LogsTypeDef
- UserTypeDef
- WeeklyStartTimeTypeDef
- ResponseMetadataTypeDef
- CreateConfigurationRequestRequestTypeDef
- CreateTagsRequestRequestTypeDef
- CreateUserRequestRequestTypeDef
- DataReplicationCounterpartTypeDef
- DeleteBrokerRequestRequestTypeDef
- DeleteTagsRequestRequestTypeDef
- DeleteUserRequestRequestTypeDef
- DescribeBrokerEngineTypesRequestRequestTypeDef
- DescribeBrokerInstanceOptionsRequestRequestTypeDef
- DescribeBrokerRequestRequestTypeDef
- LdapServerMetadataOutputTypeDef
- UserSummaryTypeDef
- DescribeConfigurationRequestRequestTypeDef
- DescribeConfigurationRevisionRequestRequestTypeDef
- DescribeUserRequestRequestTypeDef
- UserPendingChangesTypeDef
- PaginatorConfigTypeDef
- ListBrokersRequestRequestTypeDef
- ListConfigurationRevisionsRequestRequestTypeDef
- ListConfigurationsRequestRequestTypeDef
- ListTagsRequestRequestTypeDef
- ListUsersRequestRequestTypeDef
- PendingLogsTypeDef
- PromoteRequestRequestTypeDef
- RebootBrokerRequestRequestTypeDef
- SanitizationWarningTypeDef
- UpdateConfigurationRequestRequestTypeDef
- UpdateUserRequestRequestTypeDef
- BrokerInstanceOptionTypeDef
- BrokerEngineTypeTypeDef
- ConfigurationsTypeDef
- ConfigurationTypeDef
- CreateBrokerRequestRequestTypeDef
- UpdateBrokerRequestRequestTypeDef
- CreateBrokerResponseTypeDef
- CreateConfigurationResponseTypeDef
- DeleteBrokerResponseTypeDef
- DescribeConfigurationResponseTypeDef
- DescribeConfigurationRevisionResponseTypeDef
- EmptyResponseMetadataTypeDef
- ListBrokersResponseTypeDef
- ListConfigurationRevisionsResponseTypeDef
- ListTagsResponseTypeDef
- PromoteResponseTypeDef
- DataReplicationMetadataOutputTypeDef
- ListUsersResponseTypeDef
- DescribeUserResponseTypeDef
- ListBrokersRequestPaginateTypeDef
- LogsSummaryTypeDef
- UpdateConfigurationResponseTypeDef
- DescribeBrokerInstanceOptionsResponseTypeDef
- DescribeBrokerEngineTypesResponseTypeDef
- ListConfigurationsResponseTypeDef
- UpdateBrokerResponseTypeDef
- DescribeBrokerResponseTypeDef