mypy-boto3-elasticache

1.42.81 · active · verified Sat Apr 11

mypy-boto3-elasticache provides comprehensive type annotations for the `boto3` ElastiCache service. It enables static type checking with tools like MyPy for `boto3` users, improving code reliability and developer experience. The library is generated by `mypy-boto3-builder` and is updated frequently, often in sync with `boto3` releases and builder improvements. The current version is 1.42.81.

Warnings

breaking Starting with `mypy-boto3-builder` version 8.12.0, support for Python 3.8 has been removed for all generated packages, including `mypy-boto3-elasticache`. Minimum required Python version is now 3.9.
Fix: Upgrade your Python environment to 3.9 or newer.
breaking Beginning with `mypy-boto3-builder` version 8.9.0, there were breaking changes to `TypeDef` naming conventions (e.g., `CreateDistributionRequestRequestTypeDef` -> `CreateDistributionRequestTypeDef`). If you explicitly import and use these generated types, your code may require updates.
Fix: Review your explicit `TypeDef` imports and update them according to the new naming conventions if type checking errors occur.
gotcha These packages provide only type stubs. Do not attempt to instantiate clients or resources directly from `mypy_boto3_elasticache` modules at runtime. Always use `boto3.client('elasticache')` or `boto3.resource('elasticache')` for runtime operations.
Fix: Use `boto3.client()` or `boto3.resource()` for runtime operations. The `mypy_boto3_elasticache` imports are solely for static type annotations.
gotcha AWS service names can change or be deprecated (e.g., `sms-voice` was replaced by `pinpoint-sms-voice`). While this specific change doesn't affect ElastiCache, be aware that service module names in `mypy-boto3` packages may evolve with AWS service updates.
Fix: Refer to AWS documentation and `mypy-boto3` release notes for changes in service names or available modules, especially after `boto3` or `mypy-boto3` upgrades.

Install

pip install mypy-boto3-elasticache Install library

Imports

ElastiCacheClient
```
from mypy_boto3_elasticache.client import ElastiCacheClient
import boto3

client: ElastiCacheClient = boto3.client('elasticache')
```
mypy-boto3-* packages provide type stubs, not runtime implementations. The actual client should be obtained via `boto3.client()`, with the stub type used for annotation only.
DescribeCacheClustersResultTypeDef
```
from mypy_boto3_elasticache.type_defs import DescribeCacheClustersResultTypeDef
```
Type definitions for service responses and request parameters are available for explicit annotation, though MyPy often infers them when stubs are installed.

Quickstart

This quickstart demonstrates how to use `mypy-boto3-elasticache` with `boto3`. The type stubs are automatically picked up by MyPy, allowing you to annotate your `boto3` client and response objects for better static analysis. Ensure your AWS credentials are configured for the `boto3` client to function.

import boto3
import os
from mypy_boto3_elasticache.client import ElastiCacheClient
from mypy_boto3_elasticache.type_defs import DescribeCacheClustersResultTypeDef

# mypy-boto3-elasticache provides type annotations for boto3. 
# The actual boto3 library handles runtime interactions.

aws_region = os.environ.get("AWS_REGION", "us-east-1")

try:
    # Initialize ElastiCache client with type annotation for improved type checking
    client: ElastiCacheClient = boto3.client("elasticache", region_name=aws_region)

    # Example: Describe cache clusters
    # The return type is automatically inferred by MyPy if stubs are installed,
    # but can be explicitly annotated for clarity.
    response: DescribeCacheClustersResultTypeDef = client.describe_cache_clusters()

    print(f"Successfully described {len(response.get('CacheClusters', []))} ElastiCache clusters.")
    for cluster in response.get('CacheClusters', []):
        print(f"  - {cluster['CacheClusterId']} ({cluster['Engine']})")

except Exception as e:
    print(f"An error occurred: {e}")
    print("Ensure AWS credentials and region are configured (e.g., via environment variables or ~/.aws/credentials).")

view raw JSON →