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_cloud_autonomous_vm_cluster()  # (2)
  1. client: OdbClient
  2. result: CreateCloudAutonomousVmClusterOutputTypeDef

Paginator usage example#

# ListAutonomousVirtualMachinesPaginator usage example

from boto3.session import Session


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

paginator = client.get_paginator("list_autonomous_virtual_machines")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: OdbClient
  2. paginator: ListAutonomousVirtualMachinesPaginator
  3. item: ListAutonomousVirtualMachinesOutputTypeDef

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 CreateCloudAutonomousVmClusterOutputTypeDef
from mypy_boto3_odb.type_defs import CreateCloudAutonomousVmClusterInputTypeDef


session = Session()

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

kwargs: CreateCloudAutonomousVmClusterInputTypeDef = {...}
result: CreateCloudAutonomousVmClusterOutputTypeDef = client.create_cloud_autonomous_vm_cluster(**kwargs)

Paginator usage example#

# ListAutonomousVirtualMachinesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_odb.client import OdbClient
from mypy_boto3_odb.paginator import ListAutonomousVirtualMachinesPaginator
from mypy_boto3_odb.type_defs import ListAutonomousVirtualMachinesOutputTypeDef


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

paginator: ListAutonomousVirtualMachinesPaginator = client.get_paginator("list_autonomous_virtual_machines")
for item in paginator.paginate(...):
    item: ListAutonomousVirtualMachinesOutputTypeDef
    print(item)