Skip to content

Examples#

Index > TimestreamInfluxDB > Examples

Auto-generated documentation for TimestreamInfluxDB type annotations stubs module mypy-boto3-timestream-influxdb.

Client#

Implicit type annotations#

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

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

# TimestreamInfluxDBClient usage example

from boto3.session import Session


session = Session()

client = session.client("timestream-influxdb")  # (1)
result = client.create_db_instance()  # (2)
  1. client: TimestreamInfluxDBClient
  2. result: CreateDbInstanceOutputTypeDef
# ListDbInstancesPaginator usage example

from boto3.session import Session


session = Session()
client = session.client("timestream-influxdb")  # (1)

paginator = client.get_paginator("list_db_instances")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: TimestreamInfluxDBClient
  2. paginator: ListDbInstancesPaginator
  3. item: ListDbInstancesOutputTypeDef

Explicit type annotations#

With boto3-stubs-lite[timestream-influxdb] or a standalone mypy_boto3_timestream_influxdb package, you have to explicitly specify client: TimestreamInfluxDBClient 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.

# TimestreamInfluxDBClient usage example with type annotations

from boto3.session import Session

from mypy_boto3_timestream_influxdb.client import TimestreamInfluxDBClient
from mypy_boto3_timestream_influxdb.type_defs import CreateDbInstanceOutputTypeDef
from mypy_boto3_timestream_influxdb.type_defs import CreateDbInstanceInputRequestTypeDef


session = Session()

client: TimestreamInfluxDBClient = session.client("timestream-influxdb")

kwargs: CreateDbInstanceInputRequestTypeDef = {...}
result: CreateDbInstanceOutputTypeDef = client.create_db_instance(**kwargs)
# ListDbInstancesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_timestream_influxdb.client import TimestreamInfluxDBClient
from mypy_boto3_timestream_influxdb.paginator import ListDbInstancesPaginator
from mypy_boto3_timestream_influxdb.type_defs import ListDbInstancesOutputTypeDef


session = Session()
client: TimestreamInfluxDBClient = session.client("timestream-influxdb")

paginator: ListDbInstancesPaginator = client.get_paginator("list_db_instances")
for item in paginator.paginate(...):
    item: ListDbInstancesOutputTypeDef
    print(item)