Skip to content

Examples#

Index > DAX > Examples

Auto-generated documentation for DAX type annotations stubs module types-aiobotocore-dax.

Client#

Implicit type annotations#

Can be used with types-aiobotocore[dax] package installed.

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

# DAXClient usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("dax") as client:  # (1)
    result = await client.create_cluster()  # (2)
  1. client: DAXClient
  2. result: CreateClusterResponseTypeDef
# DescribeClustersPaginator usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("dax") as client:  # (1)
    paginator = client.get_paginator("describe_clusters")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)
  1. client: DAXClient
  2. paginator: DescribeClustersPaginator
  3. item: DescribeClustersResponseTypeDef

Explicit type annotations#

With types-aiobotocore-lite[dax] or a standalone types_aiobotocore_dax package, you have to explicitly specify client: DAXClient 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.

# DAXClient usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_dax.client import DAXClient
from types_aiobotocore_dax.type_defs import CreateClusterResponseTypeDef
from types_aiobotocore_dax.type_defs import CreateClusterRequestRequestTypeDef


session = get_session()

async with session.create_client("dax") as client:
    client: DAXClient
    kwargs: CreateClusterRequestRequestTypeDef = {...}
    result: CreateClusterResponseTypeDef = await client.create_cluster(**kwargs)
# DescribeClustersPaginator usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_dax.client import DAXClient
from types_aiobotocore_dax.paginator import DescribeClustersPaginator
from types_aiobotocore_dax.type_defs import DescribeClustersResponseTypeDef


session = get_session()

async with session.create_client("dax") as client:
    client: DAXClient
    paginator: DescribeClustersPaginator = client.get_paginator("describe_clusters")
    async for item in paginator.paginate(...):
        item: DescribeClustersResponseTypeDef
        print(item)