Skip to content

ECS module#

Index > ECS

Auto-generated documentation for ECS type annotations stubs module mypy-boto3-ecs.

How to install#

You can generate type annotations for boto3 package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.38.19' mypy-boto3-builder
  2. Select boto3-stubs AWS SDK.
  3. Add ECS service.
  4. Use provided commands to install generated packages.

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and ECS.

From PyPI with pip#

Install boto3-stubs for ECS service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[ecs]'

# 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[ecs]'

# standalone installation
python -m pip install mypy-boto3-ecs

How to uninstall#

python -m pip uninstall -y mypy-boto3-ecs

Usage#

Code samples can be found in Examples.

ECSClient#

Type annotations and code completion for boto3.client("ecs") as ECSClient boto3 documentation

# ECSClient usage example

from boto3.session import Session

from mypy_boto3_ecs.client import ECSClient

def get_client() -> ECSClient:
    return Session().client("ecs")

Paginators#

Type annotations and code completion for paginators from boto3.client("ecs").get_paginator("...").

# ListAccountSettingsPaginator usage example

from boto3.session import Session

from mypy_boto3_ecs.paginator import ListAccountSettingsPaginator

def get_list_account_settings_paginator() -> ListAccountSettingsPaginator:
    return Session().client("ecs").get_paginator("list_account_settings"))

Waiters#

Type annotations and code completion for waiters from boto3.client("ecs").get_waiter("...").

# ServicesInactiveWaiter usage example

from boto3.session import Session

from mypy_boto3_ecs.waiter import ServicesInactiveWaiter

def get_services_inactive_waiter() -> ServicesInactiveWaiter:
    return Session().client("ecs").get_waiter("services_inactive")

Literals#

Type annotations for literals used in methods and schema.

# AgentUpdateStatusType usage example

from mypy_boto3_ecs.literals import AgentUpdateStatusType

def get_value() -> AgentUpdateStatusType:
    return "FAILED"

Type definitions#

Type annotations for type definitions used in methods and schema.