Skip to content

SWF module#

Index > SWF

Auto-generated documentation for SWF type annotations stubs module mypy-boto3-swf.

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 SWF 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 SWF.

From PyPI with pip#

Install boto3-stubs for SWF service.

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

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

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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

SWFClient#

Type annotations and code completion for boto3.client("swf") as SWFClient boto3 documentation

# SWFClient usage example

from boto3.session import Session

from mypy_boto3_swf.client import SWFClient

def get_client() -> SWFClient:
    return Session().client("swf")

Paginators#

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

# GetWorkflowExecutionHistoryPaginator usage example

from boto3.session import Session

from mypy_boto3_swf.paginator import GetWorkflowExecutionHistoryPaginator

def get_get_workflow_execution_history_paginator() -> GetWorkflowExecutionHistoryPaginator:
    return Session().client("swf").get_paginator("get_workflow_execution_history"))

Literals#

Type annotations for literals used in methods and schema.

# ActivityTaskTimeoutTypeType usage example

from mypy_boto3_swf.literals import ActivityTaskTimeoutTypeType

def get_value() -> ActivityTaskTimeoutTypeType:
    return "HEARTBEAT"

Type definitions#

Type annotations for type definitions used in methods and schema.