Skip to content

RDS module#

Index > RDS

Auto-generated documentation for RDS type annotations stubs module mypy-boto3-rds.

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

From PyPI with pip#

Install boto3-stubs for RDS service.

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


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


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

From conda-forge#

Installing mypy-boto3-rds from the conda-forge channel can be achieved by adding conda-forge to your channels with:

conda config --add channels conda-forge
conda config --set channel_priority strict

Once the conda-forge channel has been enabled, mypy-boto3-rds can be installed with:

conda install mypy-boto3-rds

It is possible to list all of the versions of mypy-boto3-rds available on your platform with:

conda search mypy-boto3-rds --channel conda-forge

How to uninstall#

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

Usage#

Code samples can be found in Examples.

RDSClient#

Type annotations and code completion for boto3.client("rds") as RDSClient boto3 documentation

# RDSClient usage example

from boto3.session import Session

from mypy_boto3_rds.client import RDSClient

def get_client() -> RDSClient:
    return Session().client("rds")

Paginators#

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

# DescribeBlueGreenDeploymentsPaginator usage example

from boto3.session import Session

from mypy_boto3_rds.paginator import DescribeBlueGreenDeploymentsPaginator

def get_describe_blue_green_deployments_paginator() -> DescribeBlueGreenDeploymentsPaginator:
    return Session().client("rds").get_paginator("describe_blue_green_deployments"))

Waiters#

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

# DBClusterAvailableWaiter usage example

from boto3.session import Session

from mypy_boto3_rds.waiter import DBClusterAvailableWaiter

def get_db_cluster_available_waiter() -> DBClusterAvailableWaiter:
    return Session().client("rds").get_waiter("db_cluster_available")

Literals#

Type annotations for literals used in methods and schemas.

# ActivityStreamModeType usage example

from mypy_boto3_rds.literals import ActivityStreamModeType

def get_value() -> ActivityStreamModeType:
    return "async"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# AccountQuotaTypeDef usage example

from mypy_boto3_rds.type_defs import AccountQuotaTypeDef

def get_value() -> AccountQuotaTypeDef:
    return {
        "AccountQuotaName": ...,
    }