Examples

Index > ElastiCache > Examples

Auto-generated documentation for ElastiCache type annotations stubs module types-aiobotocore-elasticache.

Client

Implicit type annotations

Can be used with types-aioboto3[elasticache] package installed.

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

# ElastiCacheClient usage example

from aioboto3.session import Session


session = Session()

async with session.client("elasticache") as client:  # (1)
    result = await client.add_tags_to_resource()  # (2)

1. client: ElastiCacheClient
2. result: TagListMessageTypeDef

# DescribeCacheClustersPaginator usage example

from aioboto3.session import Session


session = Session()

async with session.client("elasticache") as client:  # (1)
    paginator = client.get_paginator("describe_cache_clusters")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)

1. client: ElastiCacheClient
2. paginator: DescribeCacheClustersPaginator
3. item: CacheClusterMessageTypeDef

# CacheClusterAvailableWaiter usage example

from aioboto3.session import Session


session = Session()

async with session.client("elasticache") as client:  # (1)
    waiter = client.get_waiter("cache_cluster_available")  # (2)
    await waiter.wait()

1. client: ElastiCacheClient
2. waiter: CacheClusterAvailableWaiter

Explicit type annotations

With types-aioboto3-lite[elasticache] or a standalone types_aiobotocore_elasticache package, you have to explicitly specify client: ElastiCacheClient 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.

# ElastiCacheClient usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_elasticache.client import ElastiCacheClient
from types_aiobotocore_elasticache.type_defs import TagListMessageTypeDef
from types_aiobotocore_elasticache.type_defs import AddTagsToResourceMessageRequestTypeDef


session = Session()

client: ElastiCacheClient
async with session.client("elasticache") as client:  # (1)
    kwargs: AddTagsToResourceMessageRequestTypeDef = {...}  # (2)
    result: TagListMessageTypeDef = await client.add_tags_to_resource(**kwargs)  # (3)

1. client: ElastiCacheClient
2. kwargs: AddTagsToResourceMessageRequestTypeDef
3. result: TagListMessageTypeDef

# DescribeCacheClustersPaginator usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_elasticache.client import ElastiCacheClient
from types_aiobotocore_elasticache.paginator import DescribeCacheClustersPaginator
from types_aiobotocore_elasticache.type_defs import CacheClusterMessageTypeDef


session = Session()

client: ElastiCacheClient
async with session.client("elasticache") as client:  # (1)
    paginator: DescribeCacheClustersPaginator = client.get_paginator("describe_cache_clusters")  # (2)
    async for item in paginator.paginate(...):
        item: CacheClusterMessageTypeDef
        print(item)  # (3)

1. client: ElastiCacheClient
2. paginator: DescribeCacheClustersPaginator
3. item: CacheClusterMessageTypeDef

# CacheClusterAvailableWaiter usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_elasticache.client import ElastiCacheClient
from types_aiobotocore_elasticache.waiter import CacheClusterAvailableWaiter


session = Session()

async with session.client("elasticache") as client:  # (1)
    waiter = client.get_waiter("cache_cluster_available")  # (2)
    await waiter.wait()

1. client: ElastiCacheClient
2. waiter: CacheClusterAvailableWaiter