Skip to content

Examples#

Index > AutoScalingPlans > Examples

Auto-generated documentation for AutoScalingPlans type annotations stubs module mypy-boto3-autoscaling-plans.

Client#

Implicit type annotations#

Can be used with boto3-stubs[autoscaling-plans] package installed.

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

# AutoScalingPlansClient usage example

from boto3.session import Session


session = Session()

client = session.client("autoscaling-plans")  # (1)
result = client.create_scaling_plan()  # (2)
  1. client: AutoScalingPlansClient
  2. result: CreateScalingPlanResponseTypeDef 
# DescribeScalingPlanResourcesPaginator usage example

from boto3.session import Session


session = Session()
client = session.client("autoscaling-plans")  # (1)

paginator = client.get_paginator("describe_scaling_plan_resources")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AutoScalingPlansClient
  2. paginator: DescribeScalingPlanResourcesPaginator
  3. item: DescribeScalingPlanResourcesResponseTypeDef

Explicit type annotations#

With boto3-stubs-lite[autoscaling-plans] or a standalone mypy_boto3_autoscaling_plans package, you have to explicitly specify client: AutoScalingPlansClient 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.

# AutoScalingPlansClient usage example with type annotations

from boto3.session import Session

from mypy_boto3_autoscaling_plans.client import AutoScalingPlansClient
from mypy_boto3_autoscaling_plans.type_defs import CreateScalingPlanResponseTypeDef
from mypy_boto3_autoscaling_plans.type_defs import CreateScalingPlanRequestRequestTypeDef


session = Session()

client: AutoScalingPlansClient = session.client("autoscaling-plans")

kwargs: CreateScalingPlanRequestRequestTypeDef = {...}
result: CreateScalingPlanResponseTypeDef = client.create_scaling_plan(**kwargs)
# DescribeScalingPlanResourcesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_autoscaling_plans.client import AutoScalingPlansClient
from mypy_boto3_autoscaling_plans.paginator import DescribeScalingPlanResourcesPaginator
from mypy_boto3_autoscaling_plans.type_defs import DescribeScalingPlanResourcesResponseTypeDef


session = Session()
client: AutoScalingPlansClient = session.client("autoscaling-plans")

paginator: DescribeScalingPlanResourcesPaginator = client.get_paginator("describe_scaling_plan_resources")
for item in paginator.paginate(...):
    item: DescribeScalingPlanResourcesResponseTypeDef
    print(item)