mypy-boto3-savingsplans: Type Annotations for AWS Boto3 SavingsPlans

1.42.62 · active · verified Sat Apr 11

mypy-boto3-savingsplans provides drop-in type annotations for the `boto3` AWS SDK's SavingsPlans service. It enhances static type checking and IDE auto-completion for `boto3.client('savingsplans')` calls. This package, currently at version `1.42.62`, is generated by `mypy-boto3-builder` and its releases are typically synchronized with `boto3` versions and `mypy-boto3-builder` updates.

Warnings

breaking Support for Python 3.8 was removed starting with `mypy-boto3-builder` version 8.12.0. Ensure your project uses Python 3.9 or higher for compatibility.
Fix: Upgrade your Python environment to 3.9 or newer. The `mypy-boto3-savingsplans` package itself requires `Python >=3.9`.
breaking All `mypy-boto3` packages, including `mypy-boto3-savingsplans`, migrated to PEP 561 compatible packages with `mypy-boto3-builder` 8.12.0. This changes how type checkers discover stubs.
Fix: For most modern `mypy` and IDE setups, stubs should be automatically discovered. Ensure `mypy` is configured to find installed packages (`--no-site-packages` should NOT be used). In some cases, installing the umbrella `boto3-stubs` package might be preferred (`pip install 'boto3-stubs[savingsplans]'`).
gotcha For optimal IDE auto-completion and static type checking, explicitly type your `boto3` client instance using the imported `SavingsPlansClient` type, especially when using `boto3.session.Session().client(...)`.
Fix: Instead of `client = boto3.client('savingsplans')`, use `from mypy_boto3_savingsplans.client import SavingsPlansClient; client: SavingsPlansClient = boto3.client('savingsplans')`.
breaking TypeDef naming conventions were changed in `mypy-boto3-builder` 8.9.0. This could affect code that directly references generated `TypedDict` names (e.g., `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`).
Fix: Review your code for direct references to `TypeDef` names and adjust them according to the new naming conventions if they clash with changes. Consult the changelog for specific service updates.
gotcha The `mypy-boto3` ecosystem offers individual service packages (e.g., `mypy-boto3-savingsplans`) and an umbrella `boto3-stubs` package with extras (e.g., `boto3-stubs[savingsplans]`). Choose the installation method that best suits your project's dependency management.
Fix: Both methods provide the same type-checking benefits. `boto3-stubs` with extras is often simpler for multiple services, while individual packages can be lighter for single-service projects. Avoid installing both for the same service to prevent conflicts.
gotcha Mypy itself has evolving Python version support. While `mypy-boto3-savingsplans` requires Python 3.9+, ensure your `mypy` version is compatible with your target Python runtime.
Fix: Regularly update `mypy` to its latest version to maintain compatibility with new Python features and `typeshed` updates. Check `mypy`'s release notes for its current Python support matrix.

Install

pip install boto3 mypy mypy-boto3-savingsplans Install specific service stubs
pip install boto3 mypy 'boto3-stubs[savingsplans]' Install via boto3-stubs umbrella package

Imports

SavingsPlansClient
```
from mypy_boto3_savingsplans.client import SavingsPlansClient
```
Type stubs are provided by `mypy-boto3-savingsplans`, not directly from `boto3` or its `client` module.

Quickstart

This example demonstrates how to explicitly type a `boto3` SavingsPlans client using `mypy-boto3-savingsplans` for improved static analysis and IDE auto-completion. It then calls a sample API method.

import boto3
from boto3.session import Session
from mypy_boto3_savingsplans.client import SavingsPlansClient
from typing import TYPE_CHECKING

# Ensure AWS credentials are configured (e.g., via environment variables, ~/.aws/credentials)
# For example, using environment variables for demonstration:
# import os
# os.environ['AWS_ACCESS_KEY_ID'] = os.environ.get('AWS_ACCESS_KEY_ID', 'YOUR_ACCESS_KEY')
# os.environ['AWS_SECRET_ACCESS_KEY'] = os.environ.get('AWS_SECRET_ACCESS_KEY', 'YOUR_SECRET_KEY')
# os.environ['AWS_REGION'] = os.environ.get('AWS_REGION', 'us-east-1')

# Recommended: Explicitly type the client for full IDE support and static analysis
if TYPE_CHECKING:
    client: SavingsPlansClient = Session().client('savingsplans')
else:
    client = Session().client('savingsplans')

# Example usage with type-checked methods
try:
    response = client.describe_savings_plans(maxResults=10)
    print("Successfully described Savings Plans:")
    for sp in response.get('savingsPlans', []):
        print(f"  - {sp.get('savingsPlanArn')}")
except client.exceptions.ClientError as e:
    print(f"Error describing Savings Plans: {e}")

view raw JSON →