%global _empty_manifest_terminate_build 0
Name: python-mypy-boto3-autoscaling
Version: 1.26.106
Release: 1
Summary: Type annotations for boto3.AutoScaling 1.26.106 service generated with mypy-boto3-builder 7.14.5
License: MIT License
URL: https://github.com/youtype/mypy_boto3_builder
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/5b/05/4604636b030fae277d8bd5ec157765c01d5e58a3a49db1944ed7e1ce0f30/mypy-boto3-autoscaling-1.26.106.tar.gz
BuildArch: noarch
Requires: python3-typing-extensions
%description
# mypy-boto3-autoscaling
[![PyPI - mypy-boto3-autoscaling](https://img.shields.io/pypi/v/mypy-boto3-autoscaling.svg?color=blue)](https://pypi.org/project/mypy-boto3-autoscaling)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-autoscaling.svg?color=blue)](https://pypi.org/project/mypy-boto3-autoscaling)
[![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_autoscaling/)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/mypy-boto3-autoscaling?color=blue)](https://pypistats.org/packages/mypy-boto3-autoscaling)
![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)
Type annotations for
[boto3.AutoScaling 1.26.106](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/autoscaling.html#AutoScaling)
service compatible with [VSCode](https://code.visualstudio.com/),
[PyCharm](https://www.jetbrains.com/pycharm/),
[Emacs](https://www.gnu.org/software/emacs/),
[Sublime Text](https://www.sublimetext.com/),
[mypy](https://github.com/python/mypy),
[pyright](https://github.com/microsoft/pyright) and other tools.
Generated by
[mypy-boto3-builder 7.14.5](https://github.com/youtype/mypy_boto3_builder).
More information can be found on
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
[mypy-boto3-autoscaling docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_autoscaling/).
See how it helps to find and fix potential bugs:
![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)
- [mypy-boto3-autoscaling](#mypy-boto3-autoscaling)
- [How to install](#how-to-install)
- [VSCode extension](#vscode-extension)
- [From PyPI with pip](#from-pypi-with-pip)
- [How to uninstall](#how-to-uninstall)
- [Usage](#usage)
- [VSCode](#vscode)
- [PyCharm](#pycharm)
- [Emacs](#emacs)
- [Sublime Text](#sublime-text)
- [Other IDEs](#other-ides)
- [mypy](#mypy)
- [pyright](#pyright)
- [Explicit type annotations](#explicit-type-annotations)
- [Client annotations](#client-annotations)
- [Paginators annotations](#paginators-annotations)
- [Literals](#literals)
- [Typed dictionaries](#typed-dictionaries)
- [How it works](#how-it-works)
- [What's new](#what's-new)
- [Implemented features](#implemented-features)
- [Latest changes](#latest-changes)
- [Versioning](#versioning)
- [Thank you](#thank-you)
- [Documentation](#documentation)
- [Support and contributing](#support-and-contributing)
## How to install
### VSCode extension
Add
[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)
extension to your VSCode and run `AWS boto3: Quick Start` command.
Click `Modify` and select `boto3 common` and `AutoScaling`.
### From PyPI with pip
Install `boto3-stubs` for `AutoScaling` service.
```bash
# install with boto3 type annotations
python -m pip install 'boto3-stubs[autoscaling]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[autoscaling]'
# standalone installation
python -m pip install mypy-boto3-autoscaling
```
## How to uninstall
```bash
python -m pip uninstall -y mypy-boto3-autoscaling
```
## Usage
### VSCode
- Install
[Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
- Install
[Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
- Set `Pylance` as your Python Language Server
- Install `boto3-stubs[autoscaling]` in your environment:
```bash
python -m pip install 'boto3-stubs[autoscaling]'
```
Both type checking and code completion should now work. No explicit type
annotations required, write your `boto3` code as usual.
### PyCharm
Install `boto3-stubs-lite[autoscaling]` in your environment:
```bash
python -m pip install 'boto3-stubs-lite[autoscaling]'`
```
Both type checking and code completion should now work. Explicit type
annotations **are required**.
Use `boto3-stubs` package instead for implicit type discovery.
### Emacs
- Install `boto3-stubs` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[autoscaling]'
```
- Install [use-package](https://github.com/jwiegley/use-package),
[lsp](https://github.com/emacs-lsp/lsp-mode/),
[company](https://github.com/company-mode/company-mode) and
[flycheck](https://github.com/flycheck/flycheck) packages
- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package
```elisp
(use-package lsp-pyright
:ensure t
:hook (python-mode . (lambda ()
(require 'lsp-pyright)
(lsp))) ; or lsp-deferred
:init (when (executable-find "python3")
(setq lsp-pyright-python-executable-cmd "python3"))
)
```
- Make sure emacs uses the environment where you have installed `boto3-stubs`
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### Sublime Text
- Install `boto3-stubs[autoscaling]` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[autoscaling]'
```
- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### Other IDEs
Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
should work.
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto3-stubs[autoscaling]` in your environment:
```bash
python -m pip install 'boto3-stubs[autoscaling]'`
```
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### pyright
- Install `pyright`: `npm i -g pyright`
- Install `boto3-stubs[autoscaling]` in your environment:
```bash
python -m pip install 'boto3-stubs[autoscaling]'
```
Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
## Explicit type annotations
### Client annotations
`AutoScalingClient` provides annotations for `boto3.client("autoscaling")`.
```python
from boto3.session import Session
from mypy_boto3_autoscaling import AutoScalingClient
client: AutoScalingClient = Session().client("autoscaling")
# now client usage is checked by mypy and IDE should provide code completion
```
### Paginators annotations
`mypy_boto3_autoscaling.paginator` module contains type annotations for all
paginators.
```python
from boto3.session import Session
from mypy_boto3_autoscaling import AutoScalingClient
from mypy_boto3_autoscaling.paginator import (
DescribeAutoScalingGroupsPaginator,
DescribeAutoScalingInstancesPaginator,
DescribeLaunchConfigurationsPaginator,
DescribeLoadBalancerTargetGroupsPaginator,
DescribeLoadBalancersPaginator,
DescribeNotificationConfigurationsPaginator,
DescribePoliciesPaginator,
DescribeScalingActivitiesPaginator,
DescribeScheduledActionsPaginator,
DescribeTagsPaginator,
)
client: AutoScalingClient = Session().client("autoscaling")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
describe_auto_scaling_groups_paginator: DescribeAutoScalingGroupsPaginator = client.get_paginator(
"describe_auto_scaling_groups"
)
describe_auto_scaling_instances_paginator: DescribeAutoScalingInstancesPaginator = (
client.get_paginator("describe_auto_scaling_instances")
)
describe_launch_configurations_paginator: DescribeLaunchConfigurationsPaginator = (
client.get_paginator("describe_launch_configurations")
)
describe_load_balancer_target_groups_paginator: DescribeLoadBalancerTargetGroupsPaginator = (
client.get_paginator("describe_load_balancer_target_groups")
)
describe_load_balancers_paginator: DescribeLoadBalancersPaginator = client.get_paginator(
"describe_load_balancers"
)
describe_notification_configurations_paginator: DescribeNotificationConfigurationsPaginator = (
client.get_paginator("describe_notification_configurations")
)
describe_policies_paginator: DescribePoliciesPaginator = client.get_paginator("describe_policies")
describe_scaling_activities_paginator: DescribeScalingActivitiesPaginator = client.get_paginator(
"describe_scaling_activities"
)
describe_scheduled_actions_paginator: DescribeScheduledActionsPaginator = client.get_paginator(
"describe_scheduled_actions"
)
describe_tags_paginator: DescribeTagsPaginator = client.get_paginator("describe_tags")
```
### Literals
`mypy_boto3_autoscaling.literals` module contains literals extracted from
shapes that can be used in user code for type checking.
```python
from mypy_boto3_autoscaling.literals import (
AcceleratorManufacturerType,
AcceleratorNameType,
AcceleratorTypeType,
BareMetalType,
BurstablePerformanceType,
CpuManufacturerType,
DescribeAutoScalingGroupsPaginatorName,
DescribeAutoScalingInstancesPaginatorName,
DescribeLaunchConfigurationsPaginatorName,
DescribeLoadBalancerTargetGroupsPaginatorName,
DescribeLoadBalancersPaginatorName,
DescribeNotificationConfigurationsPaginatorName,
DescribePoliciesPaginatorName,
DescribeScalingActivitiesPaginatorName,
DescribeScheduledActionsPaginatorName,
DescribeTagsPaginatorName,
InstanceGenerationType,
InstanceMetadataEndpointStateType,
InstanceMetadataHttpTokensStateType,
InstanceRefreshStatusType,
LifecycleStateType,
LocalStorageType,
LocalStorageTypeType,
MetricStatisticType,
MetricTypeType,
PredefinedLoadMetricTypeType,
PredefinedMetricPairTypeType,
PredefinedScalingMetricTypeType,
PredictiveScalingMaxCapacityBreachBehaviorType,
PredictiveScalingModeType,
RefreshStrategyType,
ScaleInProtectedInstancesType,
ScalingActivityStatusCodeType,
StandbyInstancesType,
WarmPoolStateType,
WarmPoolStatusType,
AutoScalingServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
RegionName,
)
def check_value(value: AcceleratorManufacturerType) -> bool:
...
```
### Typed dictionaries
`mypy_boto3_autoscaling.type_defs` module contains structures and shapes
assembled to typed dictionaries for additional type checking.
```python
from mypy_boto3_autoscaling.type_defs import (
AcceleratorCountRequestTypeDef,
AcceleratorTotalMemoryMiBRequestTypeDef,
ActivityTypeDef,
AdjustmentTypeTypeDef,
AlarmTypeDef,
AttachInstancesQueryRequestTypeDef,
AttachLoadBalancerTargetGroupsTypeRequestTypeDef,
AttachLoadBalancersTypeRequestTypeDef,
TrafficSourceIdentifierTypeDef,
FilterTypeDef,
EnabledMetricTypeDef,
LaunchTemplateSpecificationTypeDef,
SuspendedProcessTypeDef,
TagDescriptionTypeDef,
BaselineEbsBandwidthMbpsRequestTypeDef,
FailedScheduledUpdateGroupActionRequestTypeDef,
BatchDeleteScheduledActionTypeRequestTypeDef,
ScheduledUpdateGroupActionRequestTypeDef,
EbsTypeDef,
CancelInstanceRefreshAnswerTypeDef,
CancelInstanceRefreshTypeRequestTypeDef,
CapacityForecastTypeDef,
CompleteLifecycleActionTypeRequestTypeDef,
LifecycleHookSpecificationTypeDef,
TagTypeDef,
InstanceMetadataOptionsTypeDef,
InstanceMonitoringTypeDef,
MetricDimensionTypeDef,
DeleteAutoScalingGroupTypeRequestTypeDef,
DeleteLifecycleHookTypeRequestTypeDef,
DeleteNotificationConfigurationTypeRequestTypeDef,
DeletePolicyTypeRequestTypeDef,
DeleteScheduledActionTypeRequestTypeDef,
DeleteWarmPoolTypeRequestTypeDef,
DescribeAccountLimitsAnswerTypeDef,
DescribeAutoScalingInstancesTypeDescribeAutoScalingInstancesPaginateTypeDef,
DescribeAutoScalingInstancesTypeRequestTypeDef,
DescribeAutoScalingNotificationTypesAnswerTypeDef,
DescribeInstanceRefreshesTypeRequestTypeDef,
DescribeLifecycleHookTypesAnswerTypeDef,
LifecycleHookTypeDef,
DescribeLifecycleHooksTypeRequestTypeDef,
DescribeLoadBalancerTargetGroupsRequestDescribeLoadBalancerTargetGroupsPaginateTypeDef,
DescribeLoadBalancerTargetGroupsRequestRequestTypeDef,
LoadBalancerTargetGroupStateTypeDef,
DescribeLoadBalancersRequestDescribeLoadBalancersPaginateTypeDef,
DescribeLoadBalancersRequestRequestTypeDef,
LoadBalancerStateTypeDef,
MetricCollectionTypeTypeDef,
MetricGranularityTypeTypeDef,
NotificationConfigurationTypeDef,
DescribeNotificationConfigurationsTypeDescribeNotificationConfigurationsPaginateTypeDef,
DescribeNotificationConfigurationsTypeRequestTypeDef,
DescribePoliciesTypeDescribePoliciesPaginateTypeDef,
DescribePoliciesTypeRequestTypeDef,
DescribeScalingActivitiesTypeDescribeScalingActivitiesPaginateTypeDef,
DescribeScalingActivitiesTypeRequestTypeDef,
DescribeScheduledActionsTypeDescribeScheduledActionsPaginateTypeDef,
DescribeScheduledActionsTypeRequestTypeDef,
DescribeTerminationPolicyTypesAnswerTypeDef,
DescribeTrafficSourcesRequestRequestTypeDef,
TrafficSourceStateTypeDef,
DescribeWarmPoolTypeRequestTypeDef,
DetachInstancesQueryRequestTypeDef,
DetachLoadBalancerTargetGroupsTypeRequestTypeDef,
DetachLoadBalancersTypeRequestTypeDef,
DisableMetricsCollectionQueryRequestTypeDef,
EmptyResponseMetadataTypeDef,
EnableMetricsCollectionQueryRequestTypeDef,
EnterStandbyQueryRequestTypeDef,
ExecutePolicyTypeRequestTypeDef,
ExitStandbyQueryRequestTypeDef,
GetPredictiveScalingForecastTypeRequestTypeDef,
InstanceRefreshLivePoolProgressTypeDef,
InstanceRefreshWarmPoolProgressTypeDef,
RefreshPreferencesTypeDef,
MemoryGiBPerVCpuRequestTypeDef,
MemoryMiBRequestTypeDef,
NetworkBandwidthGbpsRequestTypeDef,
NetworkInterfaceCountRequestTypeDef,
TotalLocalStorageGBRequestTypeDef,
VCpuCountRequestTypeDef,
InstanceReusePolicyTypeDef,
InstancesDistributionTypeDef,
LaunchConfigurationNameTypeRequestTypeDef,
LaunchConfigurationNamesTypeDescribeLaunchConfigurationsPaginateTypeDef,
LaunchConfigurationNamesTypeRequestTypeDef,
PaginatorConfigTypeDef,
PredefinedMetricSpecificationTypeDef,
PredictiveScalingPredefinedLoadMetricTypeDef,
PredictiveScalingPredefinedMetricPairTypeDef,
PredictiveScalingPredefinedScalingMetricTypeDef,
ProcessTypeTypeDef,
PutLifecycleHookTypeRequestTypeDef,
PutNotificationConfigurationTypeRequestTypeDef,
StepAdjustmentTypeDef,
PutScheduledUpdateGroupActionTypeRequestTypeDef,
RecordLifecycleActionHeartbeatTypeRequestTypeDef,
ResponseMetadataTypeDef,
RollbackInstanceRefreshAnswerTypeDef,
RollbackInstanceRefreshTypeRequestTypeDef,
ScalingProcessQueryRequestTypeDef,
ScheduledUpdateGroupActionTypeDef,
SetDesiredCapacityTypeRequestTypeDef,
SetInstanceHealthQueryRequestTypeDef,
SetInstanceProtectionQueryRequestTypeDef,
StartInstanceRefreshAnswerTypeDef,
TerminateInstanceInAutoScalingGroupTypeRequestTypeDef,
ActivitiesTypeTypeDef,
ActivityTypeTypeDef,
DetachInstancesAnswerTypeDef,
EnterStandbyAnswerTypeDef,
ExitStandbyAnswerTypeDef,
DescribeAdjustmentTypesAnswerTypeDef,
PolicyARNTypeTypeDef,
AttachTrafficSourcesTypeRequestTypeDef,
DetachTrafficSourcesTypeRequestTypeDef,
AutoScalingGroupNamesTypeDescribeAutoScalingGroupsPaginateTypeDef,
AutoScalingGroupNamesTypeRequestTypeDef,
DescribeTagsTypeDescribeTagsPaginateTypeDef,
DescribeTagsTypeRequestTypeDef,
AutoScalingInstanceDetailsTypeDef,
InstanceTypeDef,
TagsTypeTypeDef,
BatchDeleteScheduledActionAnswerTypeDef,
BatchPutScheduledUpdateGroupActionAnswerTypeDef,
BatchPutScheduledUpdateGroupActionTypeRequestTypeDef,
BlockDeviceMappingTypeDef,
CreateOrUpdateTagsTypeRequestTypeDef,
DeleteTagsTypeRequestTypeDef,
MetricTypeDef,
DescribeLifecycleHooksAnswerTypeDef,
DescribeLoadBalancerTargetGroupsResponseTypeDef,
DescribeLoadBalancersResponseTypeDef,
DescribeMetricCollectionTypesAnswerTypeDef,
DescribeNotificationConfigurationsAnswerTypeDef,
DescribeTrafficSourcesResponseTypeDef,
InstanceRefreshProgressDetailsTypeDef,
InstanceRequirementsTypeDef,
PutWarmPoolTypeRequestTypeDef,
WarmPoolConfigurationTypeDef,
ProcessesTypeTypeDef,
ScheduledActionsTypeTypeDef,
AutoScalingInstancesTypeTypeDef,
CreateLaunchConfigurationTypeRequestTypeDef,
LaunchConfigurationTypeDef,
MetricStatTypeDef,
TargetTrackingMetricStatTypeDef,
RollbackDetailsTypeDef,
LaunchTemplateOverridesTypeDef,
DescribeWarmPoolAnswerTypeDef,
LaunchConfigurationsTypeTypeDef,
MetricDataQueryTypeDef,
TargetTrackingMetricDataQueryTypeDef,
LaunchTemplateTypeDef,
PredictiveScalingCustomizedCapacityMetricTypeDef,
PredictiveScalingCustomizedLoadMetricTypeDef,
PredictiveScalingCustomizedScalingMetricTypeDef,
CustomizedMetricSpecificationTypeDef,
MixedInstancesPolicyTypeDef,
PredictiveScalingMetricSpecificationTypeDef,
TargetTrackingConfigurationTypeDef,
AutoScalingGroupTypeDef,
CreateAutoScalingGroupTypeRequestTypeDef,
DesiredConfigurationTypeDef,
UpdateAutoScalingGroupTypeRequestTypeDef,
LoadForecastTypeDef,
PredictiveScalingConfigurationTypeDef,
AutoScalingGroupsTypeTypeDef,
InstanceRefreshTypeDef,
StartInstanceRefreshTypeRequestTypeDef,
GetPredictiveScalingForecastAnswerTypeDef,
PutScalingPolicyTypeRequestTypeDef,
ScalingPolicyTypeDef,
DescribeInstanceRefreshesAnswerTypeDef,
PoliciesTypeTypeDef,
)
def get_structure() -> AcceleratorCountRequestTypeDef:
return {...}
```
## How it works
Fully automated
[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully
generates type annotations for each service, patiently waiting for `boto3`
updates. It delivers drop-in type annotations for you and makes sure that:
- All available `boto3` services are covered.
- Each public class and method of every `boto3` service gets valid type
annotations extracted from `botocore` schemas.
- Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by [black](https://github.com/psf/black) and
[isort](https://github.com/PyCQA/isort) for readability.
## What's new
### Implemented features
- Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3`
libraries
- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`
compatibility
- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type
annotations for each service
- Generated `TypeDefs` for each service
- Generated `Literals` for each service
- Auto discovery of types for `boto3.client` and `boto3.resource` calls
- Auto discovery of types for `session.client` and `session.resource` calls
- Auto discovery of types for `client.get_waiter` and `client.get_paginator`
calls
- Auto discovery of types for `ServiceResource` and `Resource` collections
- Auto discovery of types for `aiobotocore.Session.create_client` calls
### Latest changes
Builder changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).
## Versioning
`mypy-boto3-autoscaling` version is the same as related `boto3` version and
follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
## Thank you
- [Allie Fitter](https://github.com/alliefitter) for
[boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),
this package is based on top of his work
- [black](https://github.com/psf/black) developers for an awesome formatting
tool
- [Timothy Edmund Crosley](https://github.com/timothycrosley) for
[isort](https://github.com/PyCQA/isort) and how flexible it is
- [mypy](https://github.com/python/mypy) developers for doing all dirty work
for us
- [pyright](https://github.com/microsoft/pyright) team for the new era of typed
Python
## Documentation
All services type annotations can be found in
[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_autoscaling/)
## Support and contributing
This package is auto-generated. Please reports any bugs or request new features
in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)
repository.
%package -n python3-mypy-boto3-autoscaling
Summary: Type annotations for boto3.AutoScaling 1.26.106 service generated with mypy-boto3-builder 7.14.5
Provides: python-mypy-boto3-autoscaling
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-mypy-boto3-autoscaling
# mypy-boto3-autoscaling
[![PyPI - mypy-boto3-autoscaling](https://img.shields.io/pypi/v/mypy-boto3-autoscaling.svg?color=blue)](https://pypi.org/project/mypy-boto3-autoscaling)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-autoscaling.svg?color=blue)](https://pypi.org/project/mypy-boto3-autoscaling)
[![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_autoscaling/)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/mypy-boto3-autoscaling?color=blue)](https://pypistats.org/packages/mypy-boto3-autoscaling)
![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)
Type annotations for
[boto3.AutoScaling 1.26.106](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/autoscaling.html#AutoScaling)
service compatible with [VSCode](https://code.visualstudio.com/),
[PyCharm](https://www.jetbrains.com/pycharm/),
[Emacs](https://www.gnu.org/software/emacs/),
[Sublime Text](https://www.sublimetext.com/),
[mypy](https://github.com/python/mypy),
[pyright](https://github.com/microsoft/pyright) and other tools.
Generated by
[mypy-boto3-builder 7.14.5](https://github.com/youtype/mypy_boto3_builder).
More information can be found on
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
[mypy-boto3-autoscaling docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_autoscaling/).
See how it helps to find and fix potential bugs:
![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)
- [mypy-boto3-autoscaling](#mypy-boto3-autoscaling)
- [How to install](#how-to-install)
- [VSCode extension](#vscode-extension)
- [From PyPI with pip](#from-pypi-with-pip)
- [How to uninstall](#how-to-uninstall)
- [Usage](#usage)
- [VSCode](#vscode)
- [PyCharm](#pycharm)
- [Emacs](#emacs)
- [Sublime Text](#sublime-text)
- [Other IDEs](#other-ides)
- [mypy](#mypy)
- [pyright](#pyright)
- [Explicit type annotations](#explicit-type-annotations)
- [Client annotations](#client-annotations)
- [Paginators annotations](#paginators-annotations)
- [Literals](#literals)
- [Typed dictionaries](#typed-dictionaries)
- [How it works](#how-it-works)
- [What's new](#what's-new)
- [Implemented features](#implemented-features)
- [Latest changes](#latest-changes)
- [Versioning](#versioning)
- [Thank you](#thank-you)
- [Documentation](#documentation)
- [Support and contributing](#support-and-contributing)
## How to install
### VSCode extension
Add
[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)
extension to your VSCode and run `AWS boto3: Quick Start` command.
Click `Modify` and select `boto3 common` and `AutoScaling`.
### From PyPI with pip
Install `boto3-stubs` for `AutoScaling` service.
```bash
# install with boto3 type annotations
python -m pip install 'boto3-stubs[autoscaling]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[autoscaling]'
# standalone installation
python -m pip install mypy-boto3-autoscaling
```
## How to uninstall
```bash
python -m pip uninstall -y mypy-boto3-autoscaling
```
## Usage
### VSCode
- Install
[Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
- Install
[Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
- Set `Pylance` as your Python Language Server
- Install `boto3-stubs[autoscaling]` in your environment:
```bash
python -m pip install 'boto3-stubs[autoscaling]'
```
Both type checking and code completion should now work. No explicit type
annotations required, write your `boto3` code as usual.
### PyCharm
Install `boto3-stubs-lite[autoscaling]` in your environment:
```bash
python -m pip install 'boto3-stubs-lite[autoscaling]'`
```
Both type checking and code completion should now work. Explicit type
annotations **are required**.
Use `boto3-stubs` package instead for implicit type discovery.
### Emacs
- Install `boto3-stubs` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[autoscaling]'
```
- Install [use-package](https://github.com/jwiegley/use-package),
[lsp](https://github.com/emacs-lsp/lsp-mode/),
[company](https://github.com/company-mode/company-mode) and
[flycheck](https://github.com/flycheck/flycheck) packages
- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package
```elisp
(use-package lsp-pyright
:ensure t
:hook (python-mode . (lambda ()
(require 'lsp-pyright)
(lsp))) ; or lsp-deferred
:init (when (executable-find "python3")
(setq lsp-pyright-python-executable-cmd "python3"))
)
```
- Make sure emacs uses the environment where you have installed `boto3-stubs`
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### Sublime Text
- Install `boto3-stubs[autoscaling]` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[autoscaling]'
```
- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### Other IDEs
Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
should work.
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto3-stubs[autoscaling]` in your environment:
```bash
python -m pip install 'boto3-stubs[autoscaling]'`
```
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### pyright
- Install `pyright`: `npm i -g pyright`
- Install `boto3-stubs[autoscaling]` in your environment:
```bash
python -m pip install 'boto3-stubs[autoscaling]'
```
Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
## Explicit type annotations
### Client annotations
`AutoScalingClient` provides annotations for `boto3.client("autoscaling")`.
```python
from boto3.session import Session
from mypy_boto3_autoscaling import AutoScalingClient
client: AutoScalingClient = Session().client("autoscaling")
# now client usage is checked by mypy and IDE should provide code completion
```
### Paginators annotations
`mypy_boto3_autoscaling.paginator` module contains type annotations for all
paginators.
```python
from boto3.session import Session
from mypy_boto3_autoscaling import AutoScalingClient
from mypy_boto3_autoscaling.paginator import (
DescribeAutoScalingGroupsPaginator,
DescribeAutoScalingInstancesPaginator,
DescribeLaunchConfigurationsPaginator,
DescribeLoadBalancerTargetGroupsPaginator,
DescribeLoadBalancersPaginator,
DescribeNotificationConfigurationsPaginator,
DescribePoliciesPaginator,
DescribeScalingActivitiesPaginator,
DescribeScheduledActionsPaginator,
DescribeTagsPaginator,
)
client: AutoScalingClient = Session().client("autoscaling")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
describe_auto_scaling_groups_paginator: DescribeAutoScalingGroupsPaginator = client.get_paginator(
"describe_auto_scaling_groups"
)
describe_auto_scaling_instances_paginator: DescribeAutoScalingInstancesPaginator = (
client.get_paginator("describe_auto_scaling_instances")
)
describe_launch_configurations_paginator: DescribeLaunchConfigurationsPaginator = (
client.get_paginator("describe_launch_configurations")
)
describe_load_balancer_target_groups_paginator: DescribeLoadBalancerTargetGroupsPaginator = (
client.get_paginator("describe_load_balancer_target_groups")
)
describe_load_balancers_paginator: DescribeLoadBalancersPaginator = client.get_paginator(
"describe_load_balancers"
)
describe_notification_configurations_paginator: DescribeNotificationConfigurationsPaginator = (
client.get_paginator("describe_notification_configurations")
)
describe_policies_paginator: DescribePoliciesPaginator = client.get_paginator("describe_policies")
describe_scaling_activities_paginator: DescribeScalingActivitiesPaginator = client.get_paginator(
"describe_scaling_activities"
)
describe_scheduled_actions_paginator: DescribeScheduledActionsPaginator = client.get_paginator(
"describe_scheduled_actions"
)
describe_tags_paginator: DescribeTagsPaginator = client.get_paginator("describe_tags")
```
### Literals
`mypy_boto3_autoscaling.literals` module contains literals extracted from
shapes that can be used in user code for type checking.
```python
from mypy_boto3_autoscaling.literals import (
AcceleratorManufacturerType,
AcceleratorNameType,
AcceleratorTypeType,
BareMetalType,
BurstablePerformanceType,
CpuManufacturerType,
DescribeAutoScalingGroupsPaginatorName,
DescribeAutoScalingInstancesPaginatorName,
DescribeLaunchConfigurationsPaginatorName,
DescribeLoadBalancerTargetGroupsPaginatorName,
DescribeLoadBalancersPaginatorName,
DescribeNotificationConfigurationsPaginatorName,
DescribePoliciesPaginatorName,
DescribeScalingActivitiesPaginatorName,
DescribeScheduledActionsPaginatorName,
DescribeTagsPaginatorName,
InstanceGenerationType,
InstanceMetadataEndpointStateType,
InstanceMetadataHttpTokensStateType,
InstanceRefreshStatusType,
LifecycleStateType,
LocalStorageType,
LocalStorageTypeType,
MetricStatisticType,
MetricTypeType,
PredefinedLoadMetricTypeType,
PredefinedMetricPairTypeType,
PredefinedScalingMetricTypeType,
PredictiveScalingMaxCapacityBreachBehaviorType,
PredictiveScalingModeType,
RefreshStrategyType,
ScaleInProtectedInstancesType,
ScalingActivityStatusCodeType,
StandbyInstancesType,
WarmPoolStateType,
WarmPoolStatusType,
AutoScalingServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
RegionName,
)
def check_value(value: AcceleratorManufacturerType) -> bool:
...
```
### Typed dictionaries
`mypy_boto3_autoscaling.type_defs` module contains structures and shapes
assembled to typed dictionaries for additional type checking.
```python
from mypy_boto3_autoscaling.type_defs import (
AcceleratorCountRequestTypeDef,
AcceleratorTotalMemoryMiBRequestTypeDef,
ActivityTypeDef,
AdjustmentTypeTypeDef,
AlarmTypeDef,
AttachInstancesQueryRequestTypeDef,
AttachLoadBalancerTargetGroupsTypeRequestTypeDef,
AttachLoadBalancersTypeRequestTypeDef,
TrafficSourceIdentifierTypeDef,
FilterTypeDef,
EnabledMetricTypeDef,
LaunchTemplateSpecificationTypeDef,
SuspendedProcessTypeDef,
TagDescriptionTypeDef,
BaselineEbsBandwidthMbpsRequestTypeDef,
FailedScheduledUpdateGroupActionRequestTypeDef,
BatchDeleteScheduledActionTypeRequestTypeDef,
ScheduledUpdateGroupActionRequestTypeDef,
EbsTypeDef,
CancelInstanceRefreshAnswerTypeDef,
CancelInstanceRefreshTypeRequestTypeDef,
CapacityForecastTypeDef,
CompleteLifecycleActionTypeRequestTypeDef,
LifecycleHookSpecificationTypeDef,
TagTypeDef,
InstanceMetadataOptionsTypeDef,
InstanceMonitoringTypeDef,
MetricDimensionTypeDef,
DeleteAutoScalingGroupTypeRequestTypeDef,
DeleteLifecycleHookTypeRequestTypeDef,
DeleteNotificationConfigurationTypeRequestTypeDef,
DeletePolicyTypeRequestTypeDef,
DeleteScheduledActionTypeRequestTypeDef,
DeleteWarmPoolTypeRequestTypeDef,
DescribeAccountLimitsAnswerTypeDef,
DescribeAutoScalingInstancesTypeDescribeAutoScalingInstancesPaginateTypeDef,
DescribeAutoScalingInstancesTypeRequestTypeDef,
DescribeAutoScalingNotificationTypesAnswerTypeDef,
DescribeInstanceRefreshesTypeRequestTypeDef,
DescribeLifecycleHookTypesAnswerTypeDef,
LifecycleHookTypeDef,
DescribeLifecycleHooksTypeRequestTypeDef,
DescribeLoadBalancerTargetGroupsRequestDescribeLoadBalancerTargetGroupsPaginateTypeDef,
DescribeLoadBalancerTargetGroupsRequestRequestTypeDef,
LoadBalancerTargetGroupStateTypeDef,
DescribeLoadBalancersRequestDescribeLoadBalancersPaginateTypeDef,
DescribeLoadBalancersRequestRequestTypeDef,
LoadBalancerStateTypeDef,
MetricCollectionTypeTypeDef,
MetricGranularityTypeTypeDef,
NotificationConfigurationTypeDef,
DescribeNotificationConfigurationsTypeDescribeNotificationConfigurationsPaginateTypeDef,
DescribeNotificationConfigurationsTypeRequestTypeDef,
DescribePoliciesTypeDescribePoliciesPaginateTypeDef,
DescribePoliciesTypeRequestTypeDef,
DescribeScalingActivitiesTypeDescribeScalingActivitiesPaginateTypeDef,
DescribeScalingActivitiesTypeRequestTypeDef,
DescribeScheduledActionsTypeDescribeScheduledActionsPaginateTypeDef,
DescribeScheduledActionsTypeRequestTypeDef,
DescribeTerminationPolicyTypesAnswerTypeDef,
DescribeTrafficSourcesRequestRequestTypeDef,
TrafficSourceStateTypeDef,
DescribeWarmPoolTypeRequestTypeDef,
DetachInstancesQueryRequestTypeDef,
DetachLoadBalancerTargetGroupsTypeRequestTypeDef,
DetachLoadBalancersTypeRequestTypeDef,
DisableMetricsCollectionQueryRequestTypeDef,
EmptyResponseMetadataTypeDef,
EnableMetricsCollectionQueryRequestTypeDef,
EnterStandbyQueryRequestTypeDef,
ExecutePolicyTypeRequestTypeDef,
ExitStandbyQueryRequestTypeDef,
GetPredictiveScalingForecastTypeRequestTypeDef,
InstanceRefreshLivePoolProgressTypeDef,
InstanceRefreshWarmPoolProgressTypeDef,
RefreshPreferencesTypeDef,
MemoryGiBPerVCpuRequestTypeDef,
MemoryMiBRequestTypeDef,
NetworkBandwidthGbpsRequestTypeDef,
NetworkInterfaceCountRequestTypeDef,
TotalLocalStorageGBRequestTypeDef,
VCpuCountRequestTypeDef,
InstanceReusePolicyTypeDef,
InstancesDistributionTypeDef,
LaunchConfigurationNameTypeRequestTypeDef,
LaunchConfigurationNamesTypeDescribeLaunchConfigurationsPaginateTypeDef,
LaunchConfigurationNamesTypeRequestTypeDef,
PaginatorConfigTypeDef,
PredefinedMetricSpecificationTypeDef,
PredictiveScalingPredefinedLoadMetricTypeDef,
PredictiveScalingPredefinedMetricPairTypeDef,
PredictiveScalingPredefinedScalingMetricTypeDef,
ProcessTypeTypeDef,
PutLifecycleHookTypeRequestTypeDef,
PutNotificationConfigurationTypeRequestTypeDef,
StepAdjustmentTypeDef,
PutScheduledUpdateGroupActionTypeRequestTypeDef,
RecordLifecycleActionHeartbeatTypeRequestTypeDef,
ResponseMetadataTypeDef,
RollbackInstanceRefreshAnswerTypeDef,
RollbackInstanceRefreshTypeRequestTypeDef,
ScalingProcessQueryRequestTypeDef,
ScheduledUpdateGroupActionTypeDef,
SetDesiredCapacityTypeRequestTypeDef,
SetInstanceHealthQueryRequestTypeDef,
SetInstanceProtectionQueryRequestTypeDef,
StartInstanceRefreshAnswerTypeDef,
TerminateInstanceInAutoScalingGroupTypeRequestTypeDef,
ActivitiesTypeTypeDef,
ActivityTypeTypeDef,
DetachInstancesAnswerTypeDef,
EnterStandbyAnswerTypeDef,
ExitStandbyAnswerTypeDef,
DescribeAdjustmentTypesAnswerTypeDef,
PolicyARNTypeTypeDef,
AttachTrafficSourcesTypeRequestTypeDef,
DetachTrafficSourcesTypeRequestTypeDef,
AutoScalingGroupNamesTypeDescribeAutoScalingGroupsPaginateTypeDef,
AutoScalingGroupNamesTypeRequestTypeDef,
DescribeTagsTypeDescribeTagsPaginateTypeDef,
DescribeTagsTypeRequestTypeDef,
AutoScalingInstanceDetailsTypeDef,
InstanceTypeDef,
TagsTypeTypeDef,
BatchDeleteScheduledActionAnswerTypeDef,
BatchPutScheduledUpdateGroupActionAnswerTypeDef,
BatchPutScheduledUpdateGroupActionTypeRequestTypeDef,
BlockDeviceMappingTypeDef,
CreateOrUpdateTagsTypeRequestTypeDef,
DeleteTagsTypeRequestTypeDef,
MetricTypeDef,
DescribeLifecycleHooksAnswerTypeDef,
DescribeLoadBalancerTargetGroupsResponseTypeDef,
DescribeLoadBalancersResponseTypeDef,
DescribeMetricCollectionTypesAnswerTypeDef,
DescribeNotificationConfigurationsAnswerTypeDef,
DescribeTrafficSourcesResponseTypeDef,
InstanceRefreshProgressDetailsTypeDef,
InstanceRequirementsTypeDef,
PutWarmPoolTypeRequestTypeDef,
WarmPoolConfigurationTypeDef,
ProcessesTypeTypeDef,
ScheduledActionsTypeTypeDef,
AutoScalingInstancesTypeTypeDef,
CreateLaunchConfigurationTypeRequestTypeDef,
LaunchConfigurationTypeDef,
MetricStatTypeDef,
TargetTrackingMetricStatTypeDef,
RollbackDetailsTypeDef,
LaunchTemplateOverridesTypeDef,
DescribeWarmPoolAnswerTypeDef,
LaunchConfigurationsTypeTypeDef,
MetricDataQueryTypeDef,
TargetTrackingMetricDataQueryTypeDef,
LaunchTemplateTypeDef,
PredictiveScalingCustomizedCapacityMetricTypeDef,
PredictiveScalingCustomizedLoadMetricTypeDef,
PredictiveScalingCustomizedScalingMetricTypeDef,
CustomizedMetricSpecificationTypeDef,
MixedInstancesPolicyTypeDef,
PredictiveScalingMetricSpecificationTypeDef,
TargetTrackingConfigurationTypeDef,
AutoScalingGroupTypeDef,
CreateAutoScalingGroupTypeRequestTypeDef,
DesiredConfigurationTypeDef,
UpdateAutoScalingGroupTypeRequestTypeDef,
LoadForecastTypeDef,
PredictiveScalingConfigurationTypeDef,
AutoScalingGroupsTypeTypeDef,
InstanceRefreshTypeDef,
StartInstanceRefreshTypeRequestTypeDef,
GetPredictiveScalingForecastAnswerTypeDef,
PutScalingPolicyTypeRequestTypeDef,
ScalingPolicyTypeDef,
DescribeInstanceRefreshesAnswerTypeDef,
PoliciesTypeTypeDef,
)
def get_structure() -> AcceleratorCountRequestTypeDef:
return {...}
```
## How it works
Fully automated
[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully
generates type annotations for each service, patiently waiting for `boto3`
updates. It delivers drop-in type annotations for you and makes sure that:
- All available `boto3` services are covered.
- Each public class and method of every `boto3` service gets valid type
annotations extracted from `botocore` schemas.
- Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by [black](https://github.com/psf/black) and
[isort](https://github.com/PyCQA/isort) for readability.
## What's new
### Implemented features
- Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3`
libraries
- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`
compatibility
- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type
annotations for each service
- Generated `TypeDefs` for each service
- Generated `Literals` for each service
- Auto discovery of types for `boto3.client` and `boto3.resource` calls
- Auto discovery of types for `session.client` and `session.resource` calls
- Auto discovery of types for `client.get_waiter` and `client.get_paginator`
calls
- Auto discovery of types for `ServiceResource` and `Resource` collections
- Auto discovery of types for `aiobotocore.Session.create_client` calls
### Latest changes
Builder changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).
## Versioning
`mypy-boto3-autoscaling` version is the same as related `boto3` version and
follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
## Thank you
- [Allie Fitter](https://github.com/alliefitter) for
[boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),
this package is based on top of his work
- [black](https://github.com/psf/black) developers for an awesome formatting
tool
- [Timothy Edmund Crosley](https://github.com/timothycrosley) for
[isort](https://github.com/PyCQA/isort) and how flexible it is
- [mypy](https://github.com/python/mypy) developers for doing all dirty work
for us
- [pyright](https://github.com/microsoft/pyright) team for the new era of typed
Python
## Documentation
All services type annotations can be found in
[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_autoscaling/)
## Support and contributing
This package is auto-generated. Please reports any bugs or request new features
in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)
repository.
%package help
Summary: Development documents and examples for mypy-boto3-autoscaling
Provides: python3-mypy-boto3-autoscaling-doc
%description help
# mypy-boto3-autoscaling
[![PyPI - mypy-boto3-autoscaling](https://img.shields.io/pypi/v/mypy-boto3-autoscaling.svg?color=blue)](https://pypi.org/project/mypy-boto3-autoscaling)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-autoscaling.svg?color=blue)](https://pypi.org/project/mypy-boto3-autoscaling)
[![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_autoscaling/)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/mypy-boto3-autoscaling?color=blue)](https://pypistats.org/packages/mypy-boto3-autoscaling)
![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)
Type annotations for
[boto3.AutoScaling 1.26.106](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/autoscaling.html#AutoScaling)
service compatible with [VSCode](https://code.visualstudio.com/),
[PyCharm](https://www.jetbrains.com/pycharm/),
[Emacs](https://www.gnu.org/software/emacs/),
[Sublime Text](https://www.sublimetext.com/),
[mypy](https://github.com/python/mypy),
[pyright](https://github.com/microsoft/pyright) and other tools.
Generated by
[mypy-boto3-builder 7.14.5](https://github.com/youtype/mypy_boto3_builder).
More information can be found on
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
[mypy-boto3-autoscaling docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_autoscaling/).
See how it helps to find and fix potential bugs:
![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)
- [mypy-boto3-autoscaling](#mypy-boto3-autoscaling)
- [How to install](#how-to-install)
- [VSCode extension](#vscode-extension)
- [From PyPI with pip](#from-pypi-with-pip)
- [How to uninstall](#how-to-uninstall)
- [Usage](#usage)
- [VSCode](#vscode)
- [PyCharm](#pycharm)
- [Emacs](#emacs)
- [Sublime Text](#sublime-text)
- [Other IDEs](#other-ides)
- [mypy](#mypy)
- [pyright](#pyright)
- [Explicit type annotations](#explicit-type-annotations)
- [Client annotations](#client-annotations)
- [Paginators annotations](#paginators-annotations)
- [Literals](#literals)
- [Typed dictionaries](#typed-dictionaries)
- [How it works](#how-it-works)
- [What's new](#what's-new)
- [Implemented features](#implemented-features)
- [Latest changes](#latest-changes)
- [Versioning](#versioning)
- [Thank you](#thank-you)
- [Documentation](#documentation)
- [Support and contributing](#support-and-contributing)
## How to install
### VSCode extension
Add
[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)
extension to your VSCode and run `AWS boto3: Quick Start` command.
Click `Modify` and select `boto3 common` and `AutoScaling`.
### From PyPI with pip
Install `boto3-stubs` for `AutoScaling` service.
```bash
# install with boto3 type annotations
python -m pip install 'boto3-stubs[autoscaling]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[autoscaling]'
# standalone installation
python -m pip install mypy-boto3-autoscaling
```
## How to uninstall
```bash
python -m pip uninstall -y mypy-boto3-autoscaling
```
## Usage
### VSCode
- Install
[Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
- Install
[Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
- Set `Pylance` as your Python Language Server
- Install `boto3-stubs[autoscaling]` in your environment:
```bash
python -m pip install 'boto3-stubs[autoscaling]'
```
Both type checking and code completion should now work. No explicit type
annotations required, write your `boto3` code as usual.
### PyCharm
Install `boto3-stubs-lite[autoscaling]` in your environment:
```bash
python -m pip install 'boto3-stubs-lite[autoscaling]'`
```
Both type checking and code completion should now work. Explicit type
annotations **are required**.
Use `boto3-stubs` package instead for implicit type discovery.
### Emacs
- Install `boto3-stubs` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[autoscaling]'
```
- Install [use-package](https://github.com/jwiegley/use-package),
[lsp](https://github.com/emacs-lsp/lsp-mode/),
[company](https://github.com/company-mode/company-mode) and
[flycheck](https://github.com/flycheck/flycheck) packages
- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package
```elisp
(use-package lsp-pyright
:ensure t
:hook (python-mode . (lambda ()
(require 'lsp-pyright)
(lsp))) ; or lsp-deferred
:init (when (executable-find "python3")
(setq lsp-pyright-python-executable-cmd "python3"))
)
```
- Make sure emacs uses the environment where you have installed `boto3-stubs`
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### Sublime Text
- Install `boto3-stubs[autoscaling]` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[autoscaling]'
```
- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### Other IDEs
Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
should work.
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto3-stubs[autoscaling]` in your environment:
```bash
python -m pip install 'boto3-stubs[autoscaling]'`
```
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### pyright
- Install `pyright`: `npm i -g pyright`
- Install `boto3-stubs[autoscaling]` in your environment:
```bash
python -m pip install 'boto3-stubs[autoscaling]'
```
Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
## Explicit type annotations
### Client annotations
`AutoScalingClient` provides annotations for `boto3.client("autoscaling")`.
```python
from boto3.session import Session
from mypy_boto3_autoscaling import AutoScalingClient
client: AutoScalingClient = Session().client("autoscaling")
# now client usage is checked by mypy and IDE should provide code completion
```
### Paginators annotations
`mypy_boto3_autoscaling.paginator` module contains type annotations for all
paginators.
```python
from boto3.session import Session
from mypy_boto3_autoscaling import AutoScalingClient
from mypy_boto3_autoscaling.paginator import (
DescribeAutoScalingGroupsPaginator,
DescribeAutoScalingInstancesPaginator,
DescribeLaunchConfigurationsPaginator,
DescribeLoadBalancerTargetGroupsPaginator,
DescribeLoadBalancersPaginator,
DescribeNotificationConfigurationsPaginator,
DescribePoliciesPaginator,
DescribeScalingActivitiesPaginator,
DescribeScheduledActionsPaginator,
DescribeTagsPaginator,
)
client: AutoScalingClient = Session().client("autoscaling")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
describe_auto_scaling_groups_paginator: DescribeAutoScalingGroupsPaginator = client.get_paginator(
"describe_auto_scaling_groups"
)
describe_auto_scaling_instances_paginator: DescribeAutoScalingInstancesPaginator = (
client.get_paginator("describe_auto_scaling_instances")
)
describe_launch_configurations_paginator: DescribeLaunchConfigurationsPaginator = (
client.get_paginator("describe_launch_configurations")
)
describe_load_balancer_target_groups_paginator: DescribeLoadBalancerTargetGroupsPaginator = (
client.get_paginator("describe_load_balancer_target_groups")
)
describe_load_balancers_paginator: DescribeLoadBalancersPaginator = client.get_paginator(
"describe_load_balancers"
)
describe_notification_configurations_paginator: DescribeNotificationConfigurationsPaginator = (
client.get_paginator("describe_notification_configurations")
)
describe_policies_paginator: DescribePoliciesPaginator = client.get_paginator("describe_policies")
describe_scaling_activities_paginator: DescribeScalingActivitiesPaginator = client.get_paginator(
"describe_scaling_activities"
)
describe_scheduled_actions_paginator: DescribeScheduledActionsPaginator = client.get_paginator(
"describe_scheduled_actions"
)
describe_tags_paginator: DescribeTagsPaginator = client.get_paginator("describe_tags")
```
### Literals
`mypy_boto3_autoscaling.literals` module contains literals extracted from
shapes that can be used in user code for type checking.
```python
from mypy_boto3_autoscaling.literals import (
AcceleratorManufacturerType,
AcceleratorNameType,
AcceleratorTypeType,
BareMetalType,
BurstablePerformanceType,
CpuManufacturerType,
DescribeAutoScalingGroupsPaginatorName,
DescribeAutoScalingInstancesPaginatorName,
DescribeLaunchConfigurationsPaginatorName,
DescribeLoadBalancerTargetGroupsPaginatorName,
DescribeLoadBalancersPaginatorName,
DescribeNotificationConfigurationsPaginatorName,
DescribePoliciesPaginatorName,
DescribeScalingActivitiesPaginatorName,
DescribeScheduledActionsPaginatorName,
DescribeTagsPaginatorName,
InstanceGenerationType,
InstanceMetadataEndpointStateType,
InstanceMetadataHttpTokensStateType,
InstanceRefreshStatusType,
LifecycleStateType,
LocalStorageType,
LocalStorageTypeType,
MetricStatisticType,
MetricTypeType,
PredefinedLoadMetricTypeType,
PredefinedMetricPairTypeType,
PredefinedScalingMetricTypeType,
PredictiveScalingMaxCapacityBreachBehaviorType,
PredictiveScalingModeType,
RefreshStrategyType,
ScaleInProtectedInstancesType,
ScalingActivityStatusCodeType,
StandbyInstancesType,
WarmPoolStateType,
WarmPoolStatusType,
AutoScalingServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
RegionName,
)
def check_value(value: AcceleratorManufacturerType) -> bool:
...
```
### Typed dictionaries
`mypy_boto3_autoscaling.type_defs` module contains structures and shapes
assembled to typed dictionaries for additional type checking.
```python
from mypy_boto3_autoscaling.type_defs import (
AcceleratorCountRequestTypeDef,
AcceleratorTotalMemoryMiBRequestTypeDef,
ActivityTypeDef,
AdjustmentTypeTypeDef,
AlarmTypeDef,
AttachInstancesQueryRequestTypeDef,
AttachLoadBalancerTargetGroupsTypeRequestTypeDef,
AttachLoadBalancersTypeRequestTypeDef,
TrafficSourceIdentifierTypeDef,
FilterTypeDef,
EnabledMetricTypeDef,
LaunchTemplateSpecificationTypeDef,
SuspendedProcessTypeDef,
TagDescriptionTypeDef,
BaselineEbsBandwidthMbpsRequestTypeDef,
FailedScheduledUpdateGroupActionRequestTypeDef,
BatchDeleteScheduledActionTypeRequestTypeDef,
ScheduledUpdateGroupActionRequestTypeDef,
EbsTypeDef,
CancelInstanceRefreshAnswerTypeDef,
CancelInstanceRefreshTypeRequestTypeDef,
CapacityForecastTypeDef,
CompleteLifecycleActionTypeRequestTypeDef,
LifecycleHookSpecificationTypeDef,
TagTypeDef,
InstanceMetadataOptionsTypeDef,
InstanceMonitoringTypeDef,
MetricDimensionTypeDef,
DeleteAutoScalingGroupTypeRequestTypeDef,
DeleteLifecycleHookTypeRequestTypeDef,
DeleteNotificationConfigurationTypeRequestTypeDef,
DeletePolicyTypeRequestTypeDef,
DeleteScheduledActionTypeRequestTypeDef,
DeleteWarmPoolTypeRequestTypeDef,
DescribeAccountLimitsAnswerTypeDef,
DescribeAutoScalingInstancesTypeDescribeAutoScalingInstancesPaginateTypeDef,
DescribeAutoScalingInstancesTypeRequestTypeDef,
DescribeAutoScalingNotificationTypesAnswerTypeDef,
DescribeInstanceRefreshesTypeRequestTypeDef,
DescribeLifecycleHookTypesAnswerTypeDef,
LifecycleHookTypeDef,
DescribeLifecycleHooksTypeRequestTypeDef,
DescribeLoadBalancerTargetGroupsRequestDescribeLoadBalancerTargetGroupsPaginateTypeDef,
DescribeLoadBalancerTargetGroupsRequestRequestTypeDef,
LoadBalancerTargetGroupStateTypeDef,
DescribeLoadBalancersRequestDescribeLoadBalancersPaginateTypeDef,
DescribeLoadBalancersRequestRequestTypeDef,
LoadBalancerStateTypeDef,
MetricCollectionTypeTypeDef,
MetricGranularityTypeTypeDef,
NotificationConfigurationTypeDef,
DescribeNotificationConfigurationsTypeDescribeNotificationConfigurationsPaginateTypeDef,
DescribeNotificationConfigurationsTypeRequestTypeDef,
DescribePoliciesTypeDescribePoliciesPaginateTypeDef,
DescribePoliciesTypeRequestTypeDef,
DescribeScalingActivitiesTypeDescribeScalingActivitiesPaginateTypeDef,
DescribeScalingActivitiesTypeRequestTypeDef,
DescribeScheduledActionsTypeDescribeScheduledActionsPaginateTypeDef,
DescribeScheduledActionsTypeRequestTypeDef,
DescribeTerminationPolicyTypesAnswerTypeDef,
DescribeTrafficSourcesRequestRequestTypeDef,
TrafficSourceStateTypeDef,
DescribeWarmPoolTypeRequestTypeDef,
DetachInstancesQueryRequestTypeDef,
DetachLoadBalancerTargetGroupsTypeRequestTypeDef,
DetachLoadBalancersTypeRequestTypeDef,
DisableMetricsCollectionQueryRequestTypeDef,
EmptyResponseMetadataTypeDef,
EnableMetricsCollectionQueryRequestTypeDef,
EnterStandbyQueryRequestTypeDef,
ExecutePolicyTypeRequestTypeDef,
ExitStandbyQueryRequestTypeDef,
GetPredictiveScalingForecastTypeRequestTypeDef,
InstanceRefreshLivePoolProgressTypeDef,
InstanceRefreshWarmPoolProgressTypeDef,
RefreshPreferencesTypeDef,
MemoryGiBPerVCpuRequestTypeDef,
MemoryMiBRequestTypeDef,
NetworkBandwidthGbpsRequestTypeDef,
NetworkInterfaceCountRequestTypeDef,
TotalLocalStorageGBRequestTypeDef,
VCpuCountRequestTypeDef,
InstanceReusePolicyTypeDef,
InstancesDistributionTypeDef,
LaunchConfigurationNameTypeRequestTypeDef,
LaunchConfigurationNamesTypeDescribeLaunchConfigurationsPaginateTypeDef,
LaunchConfigurationNamesTypeRequestTypeDef,
PaginatorConfigTypeDef,
PredefinedMetricSpecificationTypeDef,
PredictiveScalingPredefinedLoadMetricTypeDef,
PredictiveScalingPredefinedMetricPairTypeDef,
PredictiveScalingPredefinedScalingMetricTypeDef,
ProcessTypeTypeDef,
PutLifecycleHookTypeRequestTypeDef,
PutNotificationConfigurationTypeRequestTypeDef,
StepAdjustmentTypeDef,
PutScheduledUpdateGroupActionTypeRequestTypeDef,
RecordLifecycleActionHeartbeatTypeRequestTypeDef,
ResponseMetadataTypeDef,
RollbackInstanceRefreshAnswerTypeDef,
RollbackInstanceRefreshTypeRequestTypeDef,
ScalingProcessQueryRequestTypeDef,
ScheduledUpdateGroupActionTypeDef,
SetDesiredCapacityTypeRequestTypeDef,
SetInstanceHealthQueryRequestTypeDef,
SetInstanceProtectionQueryRequestTypeDef,
StartInstanceRefreshAnswerTypeDef,
TerminateInstanceInAutoScalingGroupTypeRequestTypeDef,
ActivitiesTypeTypeDef,
ActivityTypeTypeDef,
DetachInstancesAnswerTypeDef,
EnterStandbyAnswerTypeDef,
ExitStandbyAnswerTypeDef,
DescribeAdjustmentTypesAnswerTypeDef,
PolicyARNTypeTypeDef,
AttachTrafficSourcesTypeRequestTypeDef,
DetachTrafficSourcesTypeRequestTypeDef,
AutoScalingGroupNamesTypeDescribeAutoScalingGroupsPaginateTypeDef,
AutoScalingGroupNamesTypeRequestTypeDef,
DescribeTagsTypeDescribeTagsPaginateTypeDef,
DescribeTagsTypeRequestTypeDef,
AutoScalingInstanceDetailsTypeDef,
InstanceTypeDef,
TagsTypeTypeDef,
BatchDeleteScheduledActionAnswerTypeDef,
BatchPutScheduledUpdateGroupActionAnswerTypeDef,
BatchPutScheduledUpdateGroupActionTypeRequestTypeDef,
BlockDeviceMappingTypeDef,
CreateOrUpdateTagsTypeRequestTypeDef,
DeleteTagsTypeRequestTypeDef,
MetricTypeDef,
DescribeLifecycleHooksAnswerTypeDef,
DescribeLoadBalancerTargetGroupsResponseTypeDef,
DescribeLoadBalancersResponseTypeDef,
DescribeMetricCollectionTypesAnswerTypeDef,
DescribeNotificationConfigurationsAnswerTypeDef,
DescribeTrafficSourcesResponseTypeDef,
InstanceRefreshProgressDetailsTypeDef,
InstanceRequirementsTypeDef,
PutWarmPoolTypeRequestTypeDef,
WarmPoolConfigurationTypeDef,
ProcessesTypeTypeDef,
ScheduledActionsTypeTypeDef,
AutoScalingInstancesTypeTypeDef,
CreateLaunchConfigurationTypeRequestTypeDef,
LaunchConfigurationTypeDef,
MetricStatTypeDef,
TargetTrackingMetricStatTypeDef,
RollbackDetailsTypeDef,
LaunchTemplateOverridesTypeDef,
DescribeWarmPoolAnswerTypeDef,
LaunchConfigurationsTypeTypeDef,
MetricDataQueryTypeDef,
TargetTrackingMetricDataQueryTypeDef,
LaunchTemplateTypeDef,
PredictiveScalingCustomizedCapacityMetricTypeDef,
PredictiveScalingCustomizedLoadMetricTypeDef,
PredictiveScalingCustomizedScalingMetricTypeDef,
CustomizedMetricSpecificationTypeDef,
MixedInstancesPolicyTypeDef,
PredictiveScalingMetricSpecificationTypeDef,
TargetTrackingConfigurationTypeDef,
AutoScalingGroupTypeDef,
CreateAutoScalingGroupTypeRequestTypeDef,
DesiredConfigurationTypeDef,
UpdateAutoScalingGroupTypeRequestTypeDef,
LoadForecastTypeDef,
PredictiveScalingConfigurationTypeDef,
AutoScalingGroupsTypeTypeDef,
InstanceRefreshTypeDef,
StartInstanceRefreshTypeRequestTypeDef,
GetPredictiveScalingForecastAnswerTypeDef,
PutScalingPolicyTypeRequestTypeDef,
ScalingPolicyTypeDef,
DescribeInstanceRefreshesAnswerTypeDef,
PoliciesTypeTypeDef,
)
def get_structure() -> AcceleratorCountRequestTypeDef:
return {...}
```
## How it works
Fully automated
[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully
generates type annotations for each service, patiently waiting for `boto3`
updates. It delivers drop-in type annotations for you and makes sure that:
- All available `boto3` services are covered.
- Each public class and method of every `boto3` service gets valid type
annotations extracted from `botocore` schemas.
- Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by [black](https://github.com/psf/black) and
[isort](https://github.com/PyCQA/isort) for readability.
## What's new
### Implemented features
- Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3`
libraries
- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`
compatibility
- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type
annotations for each service
- Generated `TypeDefs` for each service
- Generated `Literals` for each service
- Auto discovery of types for `boto3.client` and `boto3.resource` calls
- Auto discovery of types for `session.client` and `session.resource` calls
- Auto discovery of types for `client.get_waiter` and `client.get_paginator`
calls
- Auto discovery of types for `ServiceResource` and `Resource` collections
- Auto discovery of types for `aiobotocore.Session.create_client` calls
### Latest changes
Builder changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).
## Versioning
`mypy-boto3-autoscaling` version is the same as related `boto3` version and
follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
## Thank you
- [Allie Fitter](https://github.com/alliefitter) for
[boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),
this package is based on top of his work
- [black](https://github.com/psf/black) developers for an awesome formatting
tool
- [Timothy Edmund Crosley](https://github.com/timothycrosley) for
[isort](https://github.com/PyCQA/isort) and how flexible it is
- [mypy](https://github.com/python/mypy) developers for doing all dirty work
for us
- [pyright](https://github.com/microsoft/pyright) team for the new era of typed
Python
## Documentation
All services type annotations can be found in
[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_autoscaling/)
## Support and contributing
This package is auto-generated. Please reports any bugs or request new features
in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)
repository.
%prep
%autosetup -n mypy-boto3-autoscaling-1.26.106
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-mypy-boto3-autoscaling -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Tue Apr 11 2023 Python_Bot - 1.26.106-1
- Package Spec generated