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-aiobotocore for SFN service.

# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[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-aiobotocore-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.create_client("stepfunctions") as SFNClient boto3 documentation

# SFNClient usage example

from aiobotocore.session import get_session

from types_aiobotocore_stepfunctions.client import SFNClient


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

Paginators#

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

# GetExecutionHistoryPaginator 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.

# ExecutionStatusType usage example

from types_aiobotocore_stepfunctions.literals import ExecutionStatusType

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

Type definitions#

Type annotations for type definitions used in methods and schema.