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"))
- GetExecutionHistoryPaginator
- ListActivitiesPaginator
- ListExecutionsPaginator
- ListMapRunsPaginator
- ListStateMachinesPaginator
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"
- ExecutionStatusType
- GetExecutionHistoryPaginatorName
- HistoryEventTypeType
- ListActivitiesPaginatorName
- ListExecutionsPaginatorName
- ListMapRunsPaginatorName
- ListStateMachinesPaginatorName
- LogLevelType
- MapRunStatusType
- StateMachineStatusType
- StateMachineTypeType
- SyncExecutionStatusType
- SFNServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
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": ...,
}
- ActivityFailedEventDetailsTypeDef
- ActivityListItemTypeDef
- ActivityScheduleFailedEventDetailsTypeDef
- HistoryEventExecutionDataDetailsTypeDef
- ActivityStartedEventDetailsTypeDef
- ActivityTimedOutEventDetailsTypeDef
- BillingDetailsTypeDef
- CloudWatchEventsExecutionDataDetailsTypeDef
- CloudWatchLogsLogGroupTypeDef
- TagTypeDef
- CreateActivityOutputTypeDef
- TracingConfigurationTypeDef
- CreateStateMachineOutputTypeDef
- DeleteActivityInputRequestTypeDef
- DeleteStateMachineInputRequestTypeDef
- DescribeActivityInputRequestTypeDef
- DescribeActivityOutputTypeDef
- DescribeExecutionInputRequestTypeDef
- DescribeMapRunInputRequestTypeDef
- MapRunExecutionCountsTypeDef
- MapRunItemCountsTypeDef
- DescribeStateMachineForExecutionInputRequestTypeDef
- DescribeStateMachineInputRequestTypeDef
- ExecutionAbortedEventDetailsTypeDef
- ExecutionFailedEventDetailsTypeDef
- ExecutionListItemTypeDef
- ExecutionTimedOutEventDetailsTypeDef
- GetActivityTaskInputRequestTypeDef
- GetActivityTaskOutputTypeDef
- GetExecutionHistoryInputGetExecutionHistoryPaginateTypeDef
- GetExecutionHistoryInputRequestTypeDef
- LambdaFunctionFailedEventDetailsTypeDef
- LambdaFunctionScheduleFailedEventDetailsTypeDef
- LambdaFunctionStartFailedEventDetailsTypeDef
- LambdaFunctionTimedOutEventDetailsTypeDef
- MapIterationEventDetailsTypeDef
- MapRunFailedEventDetailsTypeDef
- MapRunStartedEventDetailsTypeDef
- MapStateStartedEventDetailsTypeDef
- TaskFailedEventDetailsTypeDef
- TaskStartFailedEventDetailsTypeDef
- TaskStartedEventDetailsTypeDef
- TaskSubmitFailedEventDetailsTypeDef
- TaskTimedOutEventDetailsTypeDef
- TaskCredentialsTypeDef
- ListActivitiesInputListActivitiesPaginateTypeDef
- ListActivitiesInputRequestTypeDef
- ListExecutionsInputListExecutionsPaginateTypeDef
- ListExecutionsInputRequestTypeDef
- ListMapRunsInputListMapRunsPaginateTypeDef
- ListMapRunsInputRequestTypeDef
- MapRunListItemTypeDef
- ListStateMachinesInputListStateMachinesPaginateTypeDef
- ListStateMachinesInputRequestTypeDef
- StateMachineListItemTypeDef
- ListTagsForResourceInputRequestTypeDef
- PaginatorConfigTypeDef
- ResponseMetadataTypeDef
- SendTaskFailureInputRequestTypeDef
- SendTaskHeartbeatInputRequestTypeDef
- SendTaskSuccessInputRequestTypeDef
- StartExecutionInputRequestTypeDef
- StartExecutionOutputTypeDef
- StartSyncExecutionInputRequestTypeDef
- StopExecutionInputRequestTypeDef
- StopExecutionOutputTypeDef
- UntagResourceInputRequestTypeDef
- UpdateMapRunInputRequestTypeDef
- UpdateStateMachineOutputTypeDef
- ListActivitiesOutputTypeDef
- ActivityScheduledEventDetailsTypeDef
- ActivitySucceededEventDetailsTypeDef
- ExecutionStartedEventDetailsTypeDef
- ExecutionSucceededEventDetailsTypeDef
- LambdaFunctionSucceededEventDetailsTypeDef
- StateEnteredEventDetailsTypeDef
- StateExitedEventDetailsTypeDef
- TaskSubmittedEventDetailsTypeDef
- TaskSucceededEventDetailsTypeDef
- DescribeExecutionOutputTypeDef
- StartSyncExecutionOutputTypeDef
- LogDestinationTypeDef
- CreateActivityInputRequestTypeDef
- ListTagsForResourceOutputTypeDef
- TagResourceInputRequestTypeDef
- DescribeMapRunOutputTypeDef
- ListExecutionsOutputTypeDef
- LambdaFunctionScheduledEventDetailsTypeDef
- TaskScheduledEventDetailsTypeDef
- ListMapRunsOutputTypeDef
- ListStateMachinesOutputTypeDef
- LoggingConfigurationTypeDef
- HistoryEventTypeDef
- CreateStateMachineInputRequestTypeDef
- DescribeStateMachineForExecutionOutputTypeDef
- DescribeStateMachineOutputTypeDef
- UpdateStateMachineInputRequestTypeDef
- GetExecutionHistoryOutputTypeDef