Skip to content

SFN module#

Index > SFN

Auto-generated documentation for SFN type annotations stubs module mypy-boto3-stepfunctions.

How to install#

VSCode extension#

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

Click Modify and select boto3 common and SFN.

From PyPI with pip#

Install boto3-stubs for SFN service.

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


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


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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

SFNClient#

Type annotations and code completion for boto3.client("stepfunctions") as SFNClient boto3 documentation

# SFNClient usage example

from boto3.session import Session

from mypy_boto3_stepfunctions.client import SFNClient

def get_client() -> SFNClient:
    return Session().client("stepfunctions")

Paginators#

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

# GetExecutionHistoryPaginator usage example

from boto3.session import Session

from mypy_boto3_stepfunctions.paginator import GetExecutionHistoryPaginator

def get_get_execution_history_paginator() -> GetExecutionHistoryPaginator:
    return Session().client("stepfunctions").get_paginator("get_execution_history"))

Literals#

Type annotations for literals used in methods and schemas.

# ExecutionStatusType usage example

from mypy_boto3_stepfunctions.literals import ExecutionStatusType

def get_value() -> ExecutionStatusType:
    return "ABORTED"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# ActivityFailedEventDetailsTypeDef usage example

from mypy_boto3_stepfunctions.type_defs import ActivityFailedEventDetailsTypeDef

def get_value() -> ActivityFailedEventDetailsTypeDef:
    return {
        "error": ...,
    }