# mypy-boto3-ecs
[![PyPI - mypy-boto3-ecs](https://img.shields.io/pypi/v/mypy-boto3-ecs.svg?color=blue)](https://pypi.org/project/mypy-boto3-ecs)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-ecs.svg?color=blue)](https://pypi.org/project/mypy-boto3-ecs)
[![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
[![PyPI - Downloads](https://img.shields.io/pypi/dw/mypy-boto3-ecs?color=blue)](https://pypistats.org/packages/mypy-boto3-ecs)
![boto3.typed](https://github.com/vemel/mypy_boto3_builder/raw/master/logo.png)
Type annotations for
[boto3.ECS 1.17.53](https://boto3.amazonaws.com/v1/documentation/api/1.17.53/reference/services/ecs.html#ECS) 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-buider 4.5.0](https://github.com/vemel/mypy_boto3_builder).
More information can be found on [boto3-stubs](https://pypi.org/project/boto3-stubs/) page.
See how it helps to find and fix potential bugs:
![boto3-stubs demo](https://github.com/vemel/mypy_boto3_builder/raw/master/demo.gif)
- [mypy-boto3-ecs](#mypy-boto3-ecs)
- [How to install](#how-to-install)
- [Usage](#usage)
- [VSCode](#vscode)
- [PyCharm](#pycharm)
- [Other IDEs](#other-ides)
- [mypy](#mypy)
- [pyright](#pyright)
- [Explicit type annotations](#explicit-type-annotations)
- [Client annotations](#client-annotations)
- [Paginators annotations](#paginators-annotations)
- [Waiters annotations](#waiters-annotations)
- [Service Resource annotations](#service-resource-annotations)
- [Other resources annotations](#other-resources-annotations)
- [Collections annotations](#collections-annotations)
- [Typed dictionations](#typed-dictionations)
## How to install
Install `boto3-stubs` for `ECS` service.
```bash
python -m pip install boto3-stubs[ecs]
```
## 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 `boto-stubs[ecs]` in your environment: `python -m pip install 'boto3-stubs[ecs]'`
Both type checking and auto-complete should work for `ECS` service.
No explicit type annotations required, write your `boto3` code as usual.
### PyCharm
- Install `boto-stubs[ecs]` in your environment: `python -m pip install 'boto3-stubs[ecs]'`
Both type checking and auto-complete should work for `ECS` service.
No explicit type annotations required, write your `boto3` code as usual.
Auto-complete can be slow on big projects or if you have a lot of installed `boto3-stubs` submodules.
### Other IDEs
Not tested, but as long as your IDE support `mypy` or `pyright`, everything should work.
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto-stubs[ecs]` in your environment: `python -m pip install 'boto3-stubs[ecs]'`
- Run `mypy` as usual
Type checking should work for `ECS` service.
No explicit type annotations required, write your `boto3` code as usual.
### pyright
- Install `pyright`: `yarn global add pyright`
- Install `boto-stubs[ecs]` in your environment: `python -m pip install 'boto3-stubs[ecs]'`
- Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should work for `ECS` service.
No explicit type annotations required, write your `boto3` code as usual.
## Explicit type annotations
### Client annotations
`ECSClient` provides annotations for `boto3.client("ecs")`.
```python
import boto3
from mypy_boto3_ecs import ECSClient
client: ECSClient = boto3.client("ecs")
# now client usage is checked by mypy and IDE should provide code auto-complete
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: ECSClient = session.client("ecs")
```
### Paginators annotations
`mypy_boto3_ecs.paginator` module contains type annotations for all paginators.
```python
from mypy_boto3_ecs import ECSClient
from mypy_boto3_ecs.paginator import (
ListAccountSettingsPaginator,
ListAttributesPaginator,
ListClustersPaginator,
ListContainerInstancesPaginator,
ListServicesPaginator,
ListTaskDefinitionFamiliesPaginator,
ListTaskDefinitionsPaginator,
ListTasksPaginator,
)
client: ECSClient = boto3.client("ecs")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_account_settings_paginator: ListAccountSettingsPaginator = client.get_paginator("list_account_settings")
list_attributes_paginator: ListAttributesPaginator = client.get_paginator("list_attributes")
list_clusters_paginator: ListClustersPaginator = client.get_paginator("list_clusters")
list_container_instances_paginator: ListContainerInstancesPaginator = client.get_paginator("list_container_instances")
list_services_paginator: ListServicesPaginator = client.get_paginator("list_services")
list_task_definition_families_paginator: ListTaskDefinitionFamiliesPaginator = client.get_paginator("list_task_definition_families")
list_task_definitions_paginator: ListTaskDefinitionsPaginator = client.get_paginator("list_task_definitions")
list_tasks_paginator: ListTasksPaginator = client.get_paginator("list_tasks")
```
### Waiters annotations
`mypy_boto3_ecs.waiter` module contains type annotations for all waiters.
```python
from mypy_boto3_ecs import ECSClient
from mypy_boto3_ecs.waiter import (
ServicesInactiveWaiter,
ServicesStableWaiter,
TasksRunningWaiter,
TasksStoppedWaiter,
)
client: ECSClient = boto3.client("ecs")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
services_inactive_waiter: ServicesInactiveWaiter = client.get_waiter("services_inactive")
services_stable_waiter: ServicesStableWaiter = client.get_waiter("services_stable")
tasks_running_waiter: TasksRunningWaiter = client.get_waiter("tasks_running")
tasks_stopped_waiter: TasksStoppedWaiter = client.get_waiter("tasks_stopped")
```
### Typed dictionations
`mypy_boto3_ecs.type_defs` module contains structures and shapes assembled
to typed dictionaries for additional type checking.
```python
from mypy_boto3_ecs.type_defs import (
AttachmentTypeDef,
AttributeTypeDef,
AutoScalingGroupProviderTypeDef,
AwsVpcConfigurationTypeDef,
CapacityProviderStrategyItemTypeDef,
CapacityProviderTypeDef,
ClusterConfigurationTypeDef,
ClusterSettingTypeDef,
ClusterTypeDef,
ContainerDefinitionTypeDef,
ContainerDependencyTypeDef,
ContainerInstanceTypeDef,
ContainerOverrideTypeDef,
ContainerTypeDef,
DeploymentCircuitBreakerTypeDef,
DeploymentConfigurationTypeDef,
DeploymentControllerTypeDef,
DeploymentTypeDef,
DeviceTypeDef,
DockerVolumeConfigurationTypeDef,
EFSAuthorizationConfigTypeDef,
EFSVolumeConfigurationTypeDef,
EnvironmentFileTypeDef,
ExecuteCommandConfigurationTypeDef,
ExecuteCommandLogConfigurationTypeDef,
FSxWindowsFileServerAuthorizationConfigTypeDef,
FSxWindowsFileServerVolumeConfigurationTypeDef,
FailureTypeDef,
FirelensConfigurationTypeDef,
HealthCheckTypeDef,
HostEntryTypeDef,
HostVolumePropertiesTypeDef,
InferenceAcceleratorOverrideTypeDef,
InferenceAcceleratorTypeDef,
KernelCapabilitiesTypeDef,
KeyValuePairTypeDef,
LinuxParametersTypeDef,
LoadBalancerTypeDef,
LogConfigurationTypeDef,
ManagedAgentTypeDef,
ManagedScalingTypeDef,
MountPointTypeDef,
NetworkBindingTypeDef,
挣扎的蓝藻
- 粉丝: 14w+
- 资源: 15万+
最新资源
- 华彩-舜宇项目—公司年度培训计划表.doc
- 华彩-舜宇项目—联想---规划培训.ppt
- Screenshot_20241218_134907.jpg
- 华彩-舜宇项目—培训管理制度.doc
- 华彩-舜宇项目—培训管理体系.doc
- 基于flink (SQL)的特征加工平台详细文档+全部资料.zip
- 基于Flink+ClickHouse实时计算平台详细文档+全部资料.zip
- 华彩-舜宇项目—如何进行战略与年度规划培训.ppt
- 基于Flink 的商品实时推荐系统。当用户产生评分行为时,数据由 kafka 发送到 flink,根据用户历史评分行为进行实时和离线推荐。实时推荐包括:基于行为
- 基于Flink+ClickHouse构建亿级电商实时数据分析平台(PC、移动、小程序)详细文档+全部资料.zip
- 基于flink1.9.1,flink-sql-client模块SDK单独实现,支持Yarn集群的远程SQL任务发布,可以支撑flink sql任务的远程化执行详细文档+全部资料.zip
- 基于flink-sql在flink上运行sql构建数据流的平台详细文档+全部资料.zip
- 华彩咨询—杭挂集团—杭挂企业集团培训管理办法--外派培训.doc
- 华彩咨询—杭挂集团—杭挂企业集团培训管理办法(总则).doc
- 华彩咨询—杭挂集团—杭挂企业集团培训管理办法--新员工培训.doc
- 华彩咨询—杭挂集团—教育培训制度.doc
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈