Skip to content

SFN module

Index > SFN

Auto-generated documentation for SFN type annotations stubs module types-aiobotocore-stepfunctions.

How to install

From PyPI with pip

Install types-aioboto3 for SFN service.

# install with aioboto3 type annotations
python -m pip install 'types-aioboto3[stepfunctions]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aioboto3-lite[stepfunctions]'


# standalone installation
python -m pip install types-aiobotocore-stepfunctions

How to uninstall

python -m pip uninstall -y types-aiobotocore-stepfunctions

Usage

Code samples can be found in Examples.

SFNClient

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

Usage example
from aioboto3.session import Session

from types_aiobotocore_stepfunctions.client import SFNClient


session = Session()
async with session.client("stepfunctions") as client:
    client: SFNClient

Paginators

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

Usage example
from types_aiobotocore_stepfunctions.paginator import GetExecutionHistoryPaginator

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

Literals

Type annotations for literals used in methods and schema.

Usage example
from types_aiobotocore_stepfunctions.literals import ExecutionStatusType

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

Typed dictionaries

Type annotations for typed dictionaries used in methods and schema.

Usage example
from types_aiobotocore_stepfunctions.type_defs import ActivityFailedEventDetailsTypeDef

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