Skip to content

Examples#

Index > AutoScaling > Examples

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

Client#

Implicit type annotations#

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

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

# AutoScalingClient usage example

from boto3.session import Session


session = Session()

client = session.client("autoscaling")  # (1)
result = client.attach_instances()  # (2)
  1. client: AutoScalingClient
  2. result: EmptyResponseMetadataTypeDef 
# DescribeAutoScalingGroupsPaginator usage example

from boto3.session import Session


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

paginator = client.get_paginator("describe_auto_scaling_groups")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AutoScalingClient
  2. paginator: DescribeAutoScalingGroupsPaginator
  3. item: AutoScalingGroupsTypeTypeDef

Explicit type annotations#

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

# AutoScalingClient usage example with type annotations

from boto3.session import Session

from mypy_boto3_autoscaling.client import AutoScalingClient
from mypy_boto3_autoscaling.type_defs import EmptyResponseMetadataTypeDef
from mypy_boto3_autoscaling.type_defs import AttachInstancesQueryRequestTypeDef


session = Session()

client: AutoScalingClient = session.client("autoscaling")

kwargs: AttachInstancesQueryRequestTypeDef = {...}
result: EmptyResponseMetadataTypeDef = client.attach_instances(**kwargs)
# DescribeAutoScalingGroupsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_autoscaling.client import AutoScalingClient
from mypy_boto3_autoscaling.paginator import DescribeAutoScalingGroupsPaginator
from mypy_boto3_autoscaling.type_defs import AutoScalingGroupsTypeTypeDef


session = Session()
client: AutoScalingClient = session.client("autoscaling")

paginator: DescribeAutoScalingGroupsPaginator = client.get_paginator("describe_auto_scaling_groups")
for item in paginator.paginate(...):
    item: AutoScalingGroupsTypeTypeDef
    print(item)