Skip to content

Odb module#

Index > Odb

Auto-generated documentation for Odb type annotations stubs module mypy-boto3-odb.

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.43.29' mypy-boto3-builder
  2. Select boto3-stubs AWS SDK.
  3. Add Odb 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 Odb.

From PyPI with pip#

Install boto3-stubs for Odb service.

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

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

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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

OdbClient#

Type annotations and code completion for boto3.client("odb") as OdbClient boto3 documentation

# OdbClient usage example

from boto3.session import Session

from mypy_boto3_odb.client import OdbClient

def get_client() -> OdbClient:
    return Session().client("odb")

Paginators#

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

# ListAutonomousDatabaseBackupsPaginator usage example

from boto3.session import Session

from mypy_boto3_odb.paginator import ListAutonomousDatabaseBackupsPaginator

def get_list_autonomous_database_backups_paginator() -> ListAutonomousDatabaseBackupsPaginator:
    return Session().client("odb").get_paginator("list_autonomous_database_backups"))

Literals#

Type annotations for literals used in methods and schema.

# AccessType usage example

from mypy_boto3_odb.literals import AccessType

def get_value() -> AccessType:
    return "DISABLED"

Type definitions#

Type annotations for type definitions used in methods and schema.