Examples

Index > DAX > Examples

Auto-generated documentation for DAX type annotations stubs module mypy-boto3-dax.

Client

Implicit type annotations

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

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

# DAXClient usage example

from boto3.session import Session


session = Session()

client = session.client("dax")  # (1)
result = client.create_cluster()  # (2)

1. client: DAXClient
2. result: CreateClusterResponseTypeDef

# DescribeClustersPaginator usage example

from boto3.session import Session


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

paginator = client.get_paginator("describe_clusters")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: DAXClient
2. paginator: DescribeClustersPaginator
3. item: DescribeClustersResponseTypeDef

Explicit type annotations

With boto3-stubs-lite[dax] or a standalone mypy_boto3_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 boto3.session import Session

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


session = Session()

client: DAXClient = session.client("dax")

kwargs: CreateClusterRequestRequestTypeDef = {...}
result: CreateClusterResponseTypeDef = client.create_cluster(**kwargs)

# DescribeClustersPaginator usage example with type annotations

from boto3.session import Session

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


session = Session()
client: DAXClient = session.client("dax")

paginator: DescribeClustersPaginator = client.get_paginator("describe_clusters")
for item in paginator.paginate(...):
    item: DescribeClustersResponseTypeDef
    print(item)