Skip to content

AuroraDSQL module#

Index > AuroraDSQL

Auto-generated documentation for AuroraDSQL type annotations stubs module mypy-boto3-dsql.

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.97' mypy_boto3_builder
  2. Select boto3-stubs AWS SDK.
  3. Add AuroraDSQL 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 AuroraDSQL.

From PyPI with pip#

Install boto3-stubs for AuroraDSQL service.

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

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

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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

AuroraDSQLClient#

Type annotations and code completion for boto3.client("dsql") as AuroraDSQLClient boto3 documentation

# AuroraDSQLClient usage example

from boto3.session import Session

from mypy_boto3_dsql.client import AuroraDSQLClient

def get_client() -> AuroraDSQLClient:
    return Session().client("dsql")

Paginators#

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

# ListClustersPaginator usage example

from boto3.session import Session

from mypy_boto3_dsql.paginator import ListClustersPaginator

def get_list_clusters_paginator() -> ListClustersPaginator:
    return Session().client("dsql").get_paginator("list_clusters"))

Waiters#

Type annotations and code completion for waiters from boto3.client("dsql").get_waiter("...").

# ClusterActiveWaiter usage example

from boto3.session import Session

from mypy_boto3_dsql.waiter import ClusterActiveWaiter

def get_cluster_active_waiter() -> ClusterActiveWaiter:
    return Session().client("dsql").get_waiter("cluster_active")

Literals#

Type annotations for literals used in methods and schema.

# ClusterActiveWaiterName usage example

from mypy_boto3_dsql.literals import ClusterActiveWaiterName

def get_value() -> ClusterActiveWaiterName:
    return "cluster_active"