Skip to content

ElastiCache module#

Index > ElastiCache

Auto-generated documentation for ElastiCache type annotations stubs module mypy-boto3-elasticache.

How to install#

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and ElastiCache.

From PyPI with pip#

Install boto3-stubs for ElastiCache service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[elasticache]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[elasticache]'


# standalone installation
python -m pip install mypy-boto3-elasticache

How to uninstall#

python -m pip uninstall -y mypy-boto3-elasticache

Usage#

Code samples can be found in Examples.

ElastiCacheClient#

Type annotations and code completion for boto3.client("elasticache") as ElastiCacheClient boto3 documentation

# ElastiCacheClient usage example

from boto3.session import Session

from mypy_boto3_elasticache.client import ElastiCacheClient

def get_client() -> ElastiCacheClient:
    return Session().client("elasticache")

Paginators#

Type annotations and code completion for paginators from boto3.client("elasticache").get_paginator("...").

# DescribeCacheClustersPaginator usage example

from boto3.session import Session

from mypy_boto3_elasticache.paginator import DescribeCacheClustersPaginator

def get_describe_cache_clusters_paginator() -> DescribeCacheClustersPaginator:
    return Session().client("elasticache").get_paginator("describe_cache_clusters"))

Waiters#

Type annotations and code completion for waiters from boto3.client("elasticache").get_waiter("...").

# CacheClusterAvailableWaiter usage example

from boto3.session import Session

from mypy_boto3_elasticache.waiter import CacheClusterAvailableWaiter

def get_cache_cluster_available_waiter() -> CacheClusterAvailableWaiter:
    return Session().client("elasticache").get_waiter("cache_cluster_available")

Literals#

Type annotations for literals used in methods and schemas.

# AZModeType usage example

from mypy_boto3_elasticache.literals import AZModeType

def get_value() -> AZModeType:
    return "cross-az"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# TagTypeDef usage example

from mypy_boto3_elasticache.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
    }