AuroraDSQL module#
Index > AuroraDSQL
Auto-generated documentation for AuroraDSQL type annotations stubs module types-aiobotocore-dsql.
How to install#
Generate locally (recommended)#
You can generate type annotations for aioboto3 package locally with mypy-boto3-builder.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'aioboto3==14.1.0' mypy-boto3-builder - Select
aioboto3AWS SDK. - Add
AuroraDSQLservice. - Use provided commands to install generated packages.
From PyPI with pip#
Install types-aioboto3 for AuroraDSQL service.
# install with aioboto3 type annotations
python -m pip install 'types-aioboto3[dsql]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aioboto3-lite[dsql]'
# standalone installation
python -m pip install types-aiobotocore-dsql
How to uninstall#
python -m pip uninstall -y types-aiobotocore-dsql
Usage#
Code samples can be found in Examples.
AuroraDSQLClient#
Type annotations and code completion for session.client("dsql") as AuroraDSQLClient
boto3 documentation
# AuroraDSQLClient usage example
from aioboto3.session import Session
from types_aiobotocore_dsql.client import AuroraDSQLClient
session = Session()
async with session.client("dsql") as client:
client: AuroraDSQLClient
Paginators#
Type annotations and code completion for
paginators
from session.client("dsql").get_paginator("...").
# ListClustersPaginator usage example
from types_aiobotocore_dsql.paginator import ListClustersPaginator
def get_list_clusters_paginator() -> ListClustersPaginator:
return client.get_paginator("list_clusters"))
Waiters#
Type annotations and code completion for
waiters
from session.client("dsql").get_waiter("...").
# ClusterActiveWaiter usage example
from types_aiobotocore_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 types_aiobotocore_dsql.literals import ClusterActiveWaiterName
def get_value() -> ClusterActiveWaiterName:
return "cluster_active"
- ClusterActiveWaiterName
- ClusterNotExistsWaiterName
- ClusterStatusType
- ListClustersPaginatorName
- AuroraDSQLServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- WaiterName
Type definitions#
Type annotations for type definitions used in methods and schema.
- ClusterSummaryTypeDef
- CreateClusterInputTypeDef
- ResponseMetadataTypeDef
- LinkedClusterPropertiesTypeDef
- DeleteClusterInputTypeDef
- DeleteMultiRegionClustersInputTypeDef
- GetClusterInputTypeDef
- WaiterConfigTypeDef
- PaginatorConfigTypeDef
- ListClustersInputTypeDef
- ListTagsForResourceInputTypeDef
- TagResourceInputTypeDef
- UntagResourceInputTypeDef
- UpdateClusterInputTypeDef
- CreateClusterOutputTypeDef
- CreateMultiRegionClustersOutputTypeDef
- DeleteClusterOutputTypeDef
- EmptyResponseMetadataTypeDef
- GetClusterOutputTypeDef
- ListClustersOutputTypeDef
- ListTagsForResourceOutputTypeDef
- UpdateClusterOutputTypeDef
- CreateMultiRegionClustersInputTypeDef
- GetClusterInputWaitExtraTypeDef
- GetClusterInputWaitTypeDef
- ListClustersInputPaginateTypeDef