mypy-boto3-autoscaling-plans Type Annotations

1.42.3 · active · verified Sat Apr 11

This library provides PEP 561 compliant type annotations for the boto3 AutoScalingPlans service. It enhances static analysis for boto3 users, allowing tools like MyPy to catch type-related errors before runtime. The current version is 1.42.3, which corresponds to boto3 1.42.3, and it receives frequent updates in sync with boto3 releases and the underlying mypy-boto3-builder project.

Warnings

breaking Starting with `mypy-boto3-builder` version 8.12.0 (which generated `mypy-boto3-autoscaling-plans 1.42.3`), Python 3.8 is no longer supported for any `mypy-boto3` stub packages.
Fix: Upgrade your Python environment to 3.9 or higher. If you must use Python 3.8, you will need to use an older version of `mypy-boto3-autoscaling-plans` (e.g., <1.42.0) that was built with an older builder version.
gotcha These packages provide type stubs, not the actual runtime. You must have `boto3` installed alongside `mypy-boto3-autoscaling-plans` for your application to run.
Fix: Ensure both `boto3` and `mypy-boto3-autoscaling-plans` are included in your project dependencies (e.g., `pip install boto3 mypy-boto3-autoscaling-plans`).
gotcha For accurate type checking, the minor version of `mypy-boto3-autoscaling-plans` should match your `boto3` runtime version. Significant mismatches can lead to incorrect type hints or missing attributes.
Fix: Align the `mypy-boto3-autoscaling-plans` version with your installed `boto3` version. For example, if you use `boto3==1.28.x`, install `mypy-boto3-autoscaling-plans==1.28.x`.
breaking The `mypy-boto3-builder` (which this package is based on) changed TypeDef naming conventions in version 8.9.0. If upgrading from very old `mypy-boto3` versions, custom TypeDef imports might break.
Fix: Review and update any direct imports of `type_defs` (e.g., `from mypy_boto3_autoscaling_plans.type_defs import OldNameTypeDef` to `NewNameTypeDef`) after upgrading.

Install

pip install boto3 mypy-boto3-autoscaling-plans Install runtime and type stubs

Imports

AutoScalingPlansClient
```
from mypy_boto3_autoscaling_plans import AutoScalingPlansClient
```
The primary import for typing the boto3 client for Auto Scaling Plans.
AutoScalingPlansServiceName
```
from mypy_boto3_autoscaling_plans import AutoScalingPlansServiceName
```
For Literal type of the service name, useful for client creation.
DescribeScalingPlansOutputTypeDef
```
from mypy_boto3_autoscaling_plans.type_defs import DescribeScalingPlansOutputTypeDef
```
Example for importing specific TypeDefs for request/response payloads.

Quickstart

This quickstart demonstrates how to import and use the `AutoScalingPlansClient` type for static analysis. It shows the creation of a typed boto3 client and a simple call to `describe_scaling_plans`, benefiting from type hints for parameters and return values.

import boto3
from mypy_boto3_autoscaling_plans import AutoScalingPlansClient

# Initialize a typed boto3 client for Auto Scaling Plans
client: AutoScalingPlansClient = boto3.client("autoscaling-plans")

try:
    # Example: List existing scaling plans
    response = client.describe_scaling_plans(
        ScalingPlanNames=['my-scaling-plan'],
        MaxResults=5
    )
    print(f"Found {len(response.get('ScalingPlans', []))} scaling plans.")
    for plan in response.get('ScalingPlans', []):
        print(f"  - Plan Name: {plan['ScalingPlanName']}")
except Exception as e:
    print(f"Error describing scaling plans: {e}")

view raw JSON →