Skip to content

Examples#

Index > Odb > Examples

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

Client#

Implicit type annotations#

Can be used with boto3-stubs[odb] package installed.

Write your Odb code as usual, type checking and code completion should work out of the box.

Client method usage example#

# OdbClient usage example

from boto3.session import Session


session = Session()

client = session.client("odb")  # (1)
result = client.create_autonomous_database()  # (2)
  1. client: OdbClient
  2. result: CreateAutonomousDatabaseOutputTypeDef

Paginator usage example#

# ListAutonomousDatabaseBackupsPaginator usage example

from boto3.session import Session


session = Session()
client = session.client("odb")  # (1)

paginator = client.get_paginator("list_autonomous_database_backups")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: OdbClient
  2. paginator: ListAutonomousDatabaseBackupsPaginator
  3. item: ListAutonomousDatabaseBackupsOutputTypeDef

Explicit type annotations#

With boto3-stubs-lite[odb] or a standalone mypy_boto3_odb package, you have to explicitly specify client: OdbClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

Client method usage example#

# OdbClient usage example with type annotations

from boto3.session import Session

from mypy_boto3_odb.client import OdbClient
from mypy_boto3_odb.type_defs import CreateAutonomousDatabaseOutputTypeDef
from mypy_boto3_odb.type_defs import CreateAutonomousDatabaseInputTypeDef


session = Session()

client: OdbClient = session.client("odb")

kwargs: CreateAutonomousDatabaseInputTypeDef = {...}
result: CreateAutonomousDatabaseOutputTypeDef = client.create_autonomous_database(**kwargs)

Paginator usage example#

# ListAutonomousDatabaseBackupsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_odb.client import OdbClient
from mypy_boto3_odb.paginator import ListAutonomousDatabaseBackupsPaginator
from mypy_boto3_odb.type_defs import ListAutonomousDatabaseBackupsOutputTypeDef


session = Session()
client: OdbClient = session.client("odb")

paginator: ListAutonomousDatabaseBackupsPaginator = client.get_paginator("list_autonomous_database_backups")
for item in paginator.paginate(...):
    item: ListAutonomousDatabaseBackupsOutputTypeDef
    print(item)