Skip to content

Type definitions#

Index > SFN > Type definitions

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

ActivityFailedEventDetailsTypeDef#

# ActivityFailedEventDetailsTypeDef definition

class ActivityFailedEventDetailsTypeDef(TypedDict):
    error: NotRequired[str],
    cause: NotRequired[str],

ActivityListItemTypeDef#

# ActivityListItemTypeDef definition

class ActivityListItemTypeDef(TypedDict):
    activityArn: str,
    name: str,
    creationDate: datetime,

ActivityScheduleFailedEventDetailsTypeDef#

# ActivityScheduleFailedEventDetailsTypeDef definition

class ActivityScheduleFailedEventDetailsTypeDef(TypedDict):
    error: NotRequired[str],
    cause: NotRequired[str],

HistoryEventExecutionDataDetailsTypeDef#

# HistoryEventExecutionDataDetailsTypeDef definition

class HistoryEventExecutionDataDetailsTypeDef(TypedDict):
    truncated: NotRequired[bool],

ActivityStartedEventDetailsTypeDef#

# ActivityStartedEventDetailsTypeDef definition

class ActivityStartedEventDetailsTypeDef(TypedDict):
    workerName: NotRequired[str],

ActivityTimedOutEventDetailsTypeDef#

# ActivityTimedOutEventDetailsTypeDef definition

class ActivityTimedOutEventDetailsTypeDef(TypedDict):
    error: NotRequired[str],
    cause: NotRequired[str],

BillingDetailsTypeDef#

# BillingDetailsTypeDef definition

class BillingDetailsTypeDef(TypedDict):
    billedMemoryUsedInMB: NotRequired[int],
    billedDurationInMilliseconds: NotRequired[int],

CloudWatchEventsExecutionDataDetailsTypeDef#

# CloudWatchEventsExecutionDataDetailsTypeDef definition

class CloudWatchEventsExecutionDataDetailsTypeDef(TypedDict):
    included: NotRequired[bool],

CloudWatchLogsLogGroupTypeDef#

# CloudWatchLogsLogGroupTypeDef definition

class CloudWatchLogsLogGroupTypeDef(TypedDict):
    logGroupArn: NotRequired[str],

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    key: NotRequired[str],
    value: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

RoutingConfigurationListItemTypeDef#

# RoutingConfigurationListItemTypeDef definition

class RoutingConfigurationListItemTypeDef(TypedDict):
    stateMachineVersionArn: str,
    weight: int,

TracingConfigurationTypeDef#

# TracingConfigurationTypeDef definition

class TracingConfigurationTypeDef(TypedDict):
    enabled: NotRequired[bool],

DeleteActivityInputRequestTypeDef#

# DeleteActivityInputRequestTypeDef definition

class DeleteActivityInputRequestTypeDef(TypedDict):
    activityArn: str,

DeleteStateMachineAliasInputRequestTypeDef#

# DeleteStateMachineAliasInputRequestTypeDef definition

class DeleteStateMachineAliasInputRequestTypeDef(TypedDict):
    stateMachineAliasArn: str,

DeleteStateMachineInputRequestTypeDef#

# DeleteStateMachineInputRequestTypeDef definition

class DeleteStateMachineInputRequestTypeDef(TypedDict):
    stateMachineArn: str,

DeleteStateMachineVersionInputRequestTypeDef#

# DeleteStateMachineVersionInputRequestTypeDef definition

class DeleteStateMachineVersionInputRequestTypeDef(TypedDict):
    stateMachineVersionArn: str,

DescribeActivityInputRequestTypeDef#

# DescribeActivityInputRequestTypeDef definition

class DescribeActivityInputRequestTypeDef(TypedDict):
    activityArn: str,

DescribeExecutionInputRequestTypeDef#

# DescribeExecutionInputRequestTypeDef definition

class DescribeExecutionInputRequestTypeDef(TypedDict):
    executionArn: str,

DescribeMapRunInputRequestTypeDef#

# DescribeMapRunInputRequestTypeDef definition

class DescribeMapRunInputRequestTypeDef(TypedDict):
    mapRunArn: str,

MapRunExecutionCountsTypeDef#

# MapRunExecutionCountsTypeDef definition

class MapRunExecutionCountsTypeDef(TypedDict):
    pending: int,
    running: int,
    succeeded: int,
    failed: int,
    timedOut: int,
    aborted: int,
    total: int,
    resultsWritten: int,
    failuresNotRedrivable: NotRequired[int],
    pendingRedrive: NotRequired[int],

MapRunItemCountsTypeDef#

# MapRunItemCountsTypeDef definition

class MapRunItemCountsTypeDef(TypedDict):
    pending: int,
    running: int,
    succeeded: int,
    failed: int,
    timedOut: int,
    aborted: int,
    total: int,
    resultsWritten: int,
    failuresNotRedrivable: NotRequired[int],
    pendingRedrive: NotRequired[int],

DescribeStateMachineAliasInputRequestTypeDef#

# DescribeStateMachineAliasInputRequestTypeDef definition

class DescribeStateMachineAliasInputRequestTypeDef(TypedDict):
    stateMachineAliasArn: str,

DescribeStateMachineForExecutionInputRequestTypeDef#

# DescribeStateMachineForExecutionInputRequestTypeDef definition

class DescribeStateMachineForExecutionInputRequestTypeDef(TypedDict):
    executionArn: str,

DescribeStateMachineInputRequestTypeDef#

# DescribeStateMachineInputRequestTypeDef definition

class DescribeStateMachineInputRequestTypeDef(TypedDict):
    stateMachineArn: str,

ExecutionAbortedEventDetailsTypeDef#

# ExecutionAbortedEventDetailsTypeDef definition

class ExecutionAbortedEventDetailsTypeDef(TypedDict):
    error: NotRequired[str],
    cause: NotRequired[str],

ExecutionFailedEventDetailsTypeDef#

# ExecutionFailedEventDetailsTypeDef definition

class ExecutionFailedEventDetailsTypeDef(TypedDict):
    error: NotRequired[str],
    cause: NotRequired[str],

ExecutionListItemTypeDef#

# ExecutionListItemTypeDef definition

class ExecutionListItemTypeDef(TypedDict):
    executionArn: str,
    stateMachineArn: str,
    name: str,
    status: ExecutionStatusType,  # (1)
    startDate: datetime,
    stopDate: NotRequired[datetime],
    mapRunArn: NotRequired[str],
    itemCount: NotRequired[int],
    stateMachineVersionArn: NotRequired[str],
    stateMachineAliasArn: NotRequired[str],
    redriveCount: NotRequired[int],
    redriveDate: NotRequired[datetime],
  1. See ExecutionStatusType

ExecutionRedrivenEventDetailsTypeDef#

# ExecutionRedrivenEventDetailsTypeDef definition

class ExecutionRedrivenEventDetailsTypeDef(TypedDict):
    redriveCount: NotRequired[int],

ExecutionTimedOutEventDetailsTypeDef#

# ExecutionTimedOutEventDetailsTypeDef definition

class ExecutionTimedOutEventDetailsTypeDef(TypedDict):
    error: NotRequired[str],
    cause: NotRequired[str],

GetActivityTaskInputRequestTypeDef#

# GetActivityTaskInputRequestTypeDef definition

class GetActivityTaskInputRequestTypeDef(TypedDict):
    activityArn: str,
    workerName: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

GetExecutionHistoryInputRequestTypeDef#

# GetExecutionHistoryInputRequestTypeDef definition

class GetExecutionHistoryInputRequestTypeDef(TypedDict):
    executionArn: str,
    maxResults: NotRequired[int],
    reverseOrder: NotRequired[bool],
    nextToken: NotRequired[str],
    includeExecutionData: NotRequired[bool],

LambdaFunctionFailedEventDetailsTypeDef#

# LambdaFunctionFailedEventDetailsTypeDef definition

class LambdaFunctionFailedEventDetailsTypeDef(TypedDict):
    error: NotRequired[str],
    cause: NotRequired[str],

LambdaFunctionScheduleFailedEventDetailsTypeDef#

# LambdaFunctionScheduleFailedEventDetailsTypeDef definition

class LambdaFunctionScheduleFailedEventDetailsTypeDef(TypedDict):
    error: NotRequired[str],
    cause: NotRequired[str],

LambdaFunctionStartFailedEventDetailsTypeDef#

# LambdaFunctionStartFailedEventDetailsTypeDef definition

class LambdaFunctionStartFailedEventDetailsTypeDef(TypedDict):
    error: NotRequired[str],
    cause: NotRequired[str],

LambdaFunctionTimedOutEventDetailsTypeDef#

# LambdaFunctionTimedOutEventDetailsTypeDef definition

class LambdaFunctionTimedOutEventDetailsTypeDef(TypedDict):
    error: NotRequired[str],
    cause: NotRequired[str],

MapIterationEventDetailsTypeDef#

# MapIterationEventDetailsTypeDef definition

class MapIterationEventDetailsTypeDef(TypedDict):
    name: NotRequired[str],
    index: NotRequired[int],

MapRunFailedEventDetailsTypeDef#

# MapRunFailedEventDetailsTypeDef definition

class MapRunFailedEventDetailsTypeDef(TypedDict):
    error: NotRequired[str],
    cause: NotRequired[str],

MapRunRedrivenEventDetailsTypeDef#

# MapRunRedrivenEventDetailsTypeDef definition

class MapRunRedrivenEventDetailsTypeDef(TypedDict):
    mapRunArn: NotRequired[str],
    redriveCount: NotRequired[int],

MapRunStartedEventDetailsTypeDef#

# MapRunStartedEventDetailsTypeDef definition

class MapRunStartedEventDetailsTypeDef(TypedDict):
    mapRunArn: NotRequired[str],

MapStateStartedEventDetailsTypeDef#

# MapStateStartedEventDetailsTypeDef definition

class MapStateStartedEventDetailsTypeDef(TypedDict):
    length: NotRequired[int],

TaskFailedEventDetailsTypeDef#

# TaskFailedEventDetailsTypeDef definition

class TaskFailedEventDetailsTypeDef(TypedDict):
    resourceType: str,
    resource: str,
    error: NotRequired[str],
    cause: NotRequired[str],

TaskStartFailedEventDetailsTypeDef#

# TaskStartFailedEventDetailsTypeDef definition

class TaskStartFailedEventDetailsTypeDef(TypedDict):
    resourceType: str,
    resource: str,
    error: NotRequired[str],
    cause: NotRequired[str],

TaskStartedEventDetailsTypeDef#

# TaskStartedEventDetailsTypeDef definition

class TaskStartedEventDetailsTypeDef(TypedDict):
    resourceType: str,
    resource: str,

TaskSubmitFailedEventDetailsTypeDef#

# TaskSubmitFailedEventDetailsTypeDef definition

class TaskSubmitFailedEventDetailsTypeDef(TypedDict):
    resourceType: str,
    resource: str,
    error: NotRequired[str],
    cause: NotRequired[str],

TaskTimedOutEventDetailsTypeDef#

# TaskTimedOutEventDetailsTypeDef definition

class TaskTimedOutEventDetailsTypeDef(TypedDict):
    resourceType: str,
    resource: str,
    error: NotRequired[str],
    cause: NotRequired[str],

InspectionDataRequestTypeDef#

# InspectionDataRequestTypeDef definition

class InspectionDataRequestTypeDef(TypedDict):
    protocol: NotRequired[str],
    method: NotRequired[str],
    url: NotRequired[str],
    headers: NotRequired[str],
    body: NotRequired[str],

InspectionDataResponseTypeDef#

# InspectionDataResponseTypeDef definition

class InspectionDataResponseTypeDef(TypedDict):
    protocol: NotRequired[str],
    statusCode: NotRequired[str],
    statusMessage: NotRequired[str],
    headers: NotRequired[str],
    body: NotRequired[str],

TaskCredentialsTypeDef#

# TaskCredentialsTypeDef definition

class TaskCredentialsTypeDef(TypedDict):
    roleArn: NotRequired[str],

ListActivitiesInputRequestTypeDef#

# ListActivitiesInputRequestTypeDef definition

class ListActivitiesInputRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListExecutionsInputRequestTypeDef#

# ListExecutionsInputRequestTypeDef definition

class ListExecutionsInputRequestTypeDef(TypedDict):
    stateMachineArn: NotRequired[str],
    statusFilter: NotRequired[ExecutionStatusType],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    mapRunArn: NotRequired[str],
    redriveFilter: NotRequired[ExecutionRedriveFilterType],  # (2)
  1. See ExecutionStatusType
  2. See ExecutionRedriveFilterType

ListMapRunsInputRequestTypeDef#

# ListMapRunsInputRequestTypeDef definition

class ListMapRunsInputRequestTypeDef(TypedDict):
    executionArn: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

MapRunListItemTypeDef#

# MapRunListItemTypeDef definition

class MapRunListItemTypeDef(TypedDict):
    executionArn: str,
    mapRunArn: str,
    stateMachineArn: str,
    startDate: datetime,
    stopDate: NotRequired[datetime],

ListStateMachineAliasesInputRequestTypeDef#

# ListStateMachineAliasesInputRequestTypeDef definition

class ListStateMachineAliasesInputRequestTypeDef(TypedDict):
    stateMachineArn: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

StateMachineAliasListItemTypeDef#

# StateMachineAliasListItemTypeDef definition

class StateMachineAliasListItemTypeDef(TypedDict):
    stateMachineAliasArn: str,
    creationDate: datetime,

ListStateMachineVersionsInputRequestTypeDef#

# ListStateMachineVersionsInputRequestTypeDef definition

class ListStateMachineVersionsInputRequestTypeDef(TypedDict):
    stateMachineArn: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

StateMachineVersionListItemTypeDef#

# StateMachineVersionListItemTypeDef definition

class StateMachineVersionListItemTypeDef(TypedDict):
    stateMachineVersionArn: str,
    creationDate: datetime,

ListStateMachinesInputRequestTypeDef#

# ListStateMachinesInputRequestTypeDef definition

class ListStateMachinesInputRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

StateMachineListItemTypeDef#

<