mypy-boto3-ecs 1.12.29.0

Type annotations for boto3.ECS 1.12.29 service, generated by mypy-boto3-buider 1.0.6

mypy-boto3-ecs

Type annotations for boto3.ECS 1.12.29 service compatible with mypy, VSCode, PyCharm and other tools.

Generated by mypy-boto3-buider 1.0.6.

More information can be found on boto3-stubs page.

• mypy-boto3-ecs
  • How to use
    • Type checking
  • How it works

How to use

Type checking

Make sure you have mypy installed and activated in your IDE.

Install boto3-stubs for ECS service.

python -m pip install boto3-stubs[mypy-boto3-ecs]

Use boto3 with mypy_boto3 in your project and enjoy type checking and auto-complete.

import boto3

from mypy_boto3 import ecs
# alternative import if you do not want to install mypy_boto3 package
# import mypy_boto3_ecs as ecs

# Use this client as usual, now mypy can check if your code is valid.
# Check if your IDE supports function overloads,
# you probably do not need explicit type annotations
# client = boto3.client("ecs")
client: ecs.ECSClient = boto3.client("ecs")

# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: ecs.ECSClient = session.client("ecs")


# Waiters need type annotation on creation
services_inactive_waiter: ecs.ServicesInactiveWaiter = client.get_waiter("services_inactive")
services_stable_waiter: ecs.ServicesStableWaiter = client.get_waiter("services_stable")
tasks_running_waiter: ecs.TasksRunningWaiter = client.get_waiter("tasks_running")
tasks_stopped_waiter: ecs.TasksStoppedWaiter = client.get_waiter("tasks_stopped")

# Paginators need type annotation on creation
list_account_settings_paginator: ecs.ListAccountSettingsPaginator = client.get_paginator("list_account_settings")
list_attributes_paginator: ecs.ListAttributesPaginator = client.get_paginator("list_attributes")
list_clusters_paginator: ecs.ListClustersPaginator = client.get_paginator("list_clusters")
list_container_instances_paginator: ecs.ListContainerInstancesPaginator = client.get_paginator("list_container_instances")
list_services_paginator: ecs.ListServicesPaginator = client.get_paginator("list_services")
list_task_definition_families_paginator: ecs.ListTaskDefinitionFamiliesPaginator = client.get_paginator("list_task_definition_families")
list_task_definitions_paginator: ecs.ListTaskDefinitionsPaginator = client.get_paginator("list_task_definitions")
list_tasks_paginator: ecs.ListTasksPaginator = client.get_paginator("list_tasks")

How it works

Fully automated builder carefully generates type annotations for each service, patiently waiting for boto3 updates. It delivers a 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 the documentation (blame botocore docs if types are incorrect).
• Type annotations include up-to-date documentation.
• Link to documentation is provided for every method.
• Code is processed by black for readability.