Skip to content

Proton module#

Index > Proton

Auto-generated documentation for Proton type annotations stubs module mypy-boto3-proton.

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.35.86' mypy_boto3_builder
  2. Select boto3-stubs AWS SDK.
  3. Add Proton 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 Proton.

From PyPI with pip#

Install boto3-stubs for Proton service.

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

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

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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

ProtonClient#

Type annotations and code completion for boto3.client("proton") as ProtonClient boto3 documentation

# ProtonClient usage example

from boto3.session import Session

from mypy_boto3_proton.client import ProtonClient

def get_client() -> ProtonClient:
    return Session().client("proton")

Paginators#

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

# ListComponentOutputsPaginator usage example

from boto3.session import Session

from mypy_boto3_proton.paginator import ListComponentOutputsPaginator

def get_list_component_outputs_paginator() -> ListComponentOutputsPaginator:
    return Session().client("proton").get_paginator("list_component_outputs"))

Waiters#

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

# ComponentDeletedWaiter usage example

from boto3.session import Session

from mypy_boto3_proton.waiter import ComponentDeletedWaiter

def get_component_deleted_waiter() -> ComponentDeletedWaiter:
    return Session().client("proton").get_waiter("component_deleted")

Literals#

Type annotations for literals used in methods and schema.

# BlockerStatusType usage example

from mypy_boto3_proton.literals import BlockerStatusType

def get_value() -> BlockerStatusType:
    return "ACTIVE"

Type definitions#

Type annotations for type definitions used in methods and schema.