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,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

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,

MapRunItemCountsTypeDef#

# MapRunItemCountsTypeDef definition

class MapRunItemCountsTypeDef(TypedDict):
    pending: int,
    running: int,
    succeeded: int,
    failed: int,
    timedOut: int,
    aborted: int,
    total: int,
    resultsWritten: 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],
  1. See ExecutionStatusType

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],

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],

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],
  1. See ExecutionStatusType

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#

# StateMachineListItemTypeDef definition

class StateMachineListItemTypeDef(TypedDict):
    stateMachineArn: str,
    name: str,
    type: StateMachineTypeType,  # (1)
    creationDate: datetime,
  1. See StateMachineTypeType

ListTagsForResourceInputRequestTypeDef#

# ListTagsForResourceInputRequestTypeDef definition

class ListTagsForResourceInputRequestTypeDef(TypedDict):
    resourceArn: str,

PublishStateMachineVersionInputRequestTypeDef#

# PublishStateMachineVersionInputRequestTypeDef definition

class PublishStateMachineVersionInputRequestTypeDef(TypedDict):
    stateMachineArn: str,
    revisionId: NotRequired[str],
    description: NotRequired[str],

SendTaskFailureInputRequestTypeDef#

# SendTaskFailureInputRequestTypeDef definition

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

SendTaskHeartbeatInputRequestTypeDef#

# SendTaskHeartbeatInputRequestTypeDef definition

class SendTaskHeartbeatInputRequestTypeDef(TypedDict):
    taskToken: str,

SendTaskSuccessInputRequestTypeDef#

# SendTaskSuccessInputRequestTypeDef definition

class SendTaskSuccessInputRequestTypeDef(TypedDict):
    taskToken: str,
    output: str,

StartExecutionInputRequestTypeDef#

# StartExecutionInputRequestTypeDef definition

class StartExecutionInputRequestTypeDef(TypedDict):
    stateMachineArn: str,
    name: NotRequired[str],
    input: NotRequired[str],
    traceHeader: NotRequired[str],

StartSyncExecutionInputRequestTypeDef#

# StartSyncExecutionInputRequestTypeDef definition

class StartSyncExecutionInputRequestTypeDef(TypedDict):
    stateMachineArn: str,
    name: NotRequired[str],
    input: NotRequired[str],
    traceHeader: NotRequired[str],

StopExecutionInputRequestTypeDef#

# StopExecutionInputRequestTypeDef definition

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

UntagResourceInputRequestTypeDef#

# UntagResourceInputRequestTypeDef definition

class UntagResourceInputRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

UpdateMapRunInputRequestTypeDef#

# UpdateMapRunInputRequestTypeDef definition

class UpdateMapRunInputRequestTypeDef(TypedDict):
    mapRunArn: str,
    maxConcurrency: NotRequired[int],
    toleratedFailurePercentage: NotRequired[float],
    toleratedFailureCount: NotRequired[int],

ActivityScheduledEventDetailsTypeDef#

# ActivityScheduledEventDetailsTypeDef definition

class ActivityScheduledEventDetailsTypeDef(TypedDict):
    resource: str,
    input: NotRequired[str],
    inputDetails: NotRequired[HistoryEventExecutionDataDetailsTypeDef],  # (1)
    timeoutInSeconds: NotRequired[int],
    heartbeatInSeconds: NotRequired[int],
  1. See HistoryEventExecutionDataDetailsTypeDef

ActivitySucceededEventDetailsTypeDef#

# ActivitySucceededEventDetailsTypeDef definition

class ActivitySucceededEventDetailsTypeDef(TypedDict):
    output: NotRequired[str],
    outputDetails: NotRequired[HistoryEventExecutionDataDetailsTypeDef],  # (1)
  1. See HistoryEventExecutionDataDetailsTypeDef

ExecutionStartedEventDetailsTypeDef#

# ExecutionStartedEventDetailsTypeDef definition

class ExecutionStartedEventDetailsTypeDef(TypedDict):
    input: NotRequired[str],
    inputDetails: NotRequired[HistoryEventExecutionDataDetailsTypeDef],  # (1)
    roleArn: NotRequired[str],
    stateMachineAliasArn: NotRequired[str],
    stateMachineVersionArn: NotRequired[str],
  1. See HistoryEventExecutionDataDetailsTypeDef

ExecutionSucceededEventDetailsTypeDef#

# ExecutionSucceededEventDetailsTypeDef definition

class ExecutionSucceededEventDetailsTypeDef(TypedDict):
    output: NotRequired[str],
    outputDetails: NotRequired[HistoryEventExecutionDataDetailsTypeDef],  # (1)
  1. See HistoryEventExecutionDataDetailsTypeDef

LambdaFunctionSucceededEventDetailsTypeDef#

# LambdaFunctionSucceededEventDetailsTypeDef definition

class LambdaFunctionSucceededEventDetailsTypeDef(TypedDict):
    output: NotRequired[str],
    outputDetails: NotRequired[HistoryEventExecutionDataDetailsTypeDef],  # (1)
  1. See HistoryEventExecutionDataDetailsTypeDef

StateEnteredEventDetailsTypeDef#

# StateEnteredEventDetailsTypeDef definition

class StateEnteredEventDetailsTypeDef(TypedDict):
    name: str,
    input: NotRequired[str],
    inputDetails: NotRequired[HistoryEventExecutionDataDetailsTypeDef],  # (1)
  1. See HistoryEventExecutionDataDetailsTypeDef

StateExitedEventDetailsTypeDef#

# StateExitedEventDetailsTypeDef definition

class StateExitedEventDetailsTypeDef(TypedDict):
    name: str,
    output: NotRequired[str],
    outputDetails: NotRequired[HistoryEventExecutionDataDetailsTypeDef],  # (1)
  1. See HistoryEventExecutionDataDetailsTypeDef

TaskSubmittedEventDetailsTypeDef#

# TaskSubmittedEventDetailsTypeDef definition

class TaskSubmittedEventDetailsTypeDef(TypedDict):
    resourceType: str,
    resource: str,
    output: NotRequired[str],
    outputDetails: NotRequired[HistoryEventExecutionDataDetailsTypeDef],  # (1)
  1. See HistoryEventExecutionDataDetailsTypeDef

TaskSucceededEventDetailsTypeDef#

# TaskSucceededEventDetailsTypeDef definition

class TaskSucceededEventDetailsTypeDef(TypedDict):
    resourceType: str,
    resource: str,
    output: NotRequired[str],
    outputDetails: NotRequired[HistoryEventExecutionDataDetailsTypeDef],  # (1)
  1. See HistoryEventExecutionDataDetailsTypeDef

LogDestinationTypeDef#

# LogDestinationTypeDef definition

class LogDestinationTypeDef(TypedDict):
    cloudWatchLogsLogGroup: NotRequired[CloudWatchLogsLogGroupTypeDef],  # (1)
  1. See CloudWatchLogsLogGroupTypeDef

CreateActivityInputRequestTypeDef#

# CreateActivityInputRequestTypeDef definition

class CreateActivityInputRequestTypeDef(TypedDict):
    name: str,
    tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

TagResourceInputRequestTypeDef#

# TagResourceInputRequestTypeDef definition

class TagResourceInputRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateActivityOutputTypeDef#

# CreateActivityOutputTypeDef definition

class CreateActivityOutputTypeDef(TypedDict):
    activityArn: str,
    creationDate: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateStateMachineAliasOutputTypeDef#

# CreateStateMachineAliasOutputTypeDef definition

class CreateStateMachineAliasOutputTypeDef(TypedDict):
    stateMachineAliasArn: str,
    creationDate: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateStateMachineOutputTypeDef#

# CreateStateMachineOutputTypeDef definition

class CreateStateMachineOutputTypeDef(TypedDict):
    stateMachineArn: str,
    creationDate: datetime,
    stateMachineVersionArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeActivityOutputTypeDef#

# DescribeActivityOutputTypeDef definition

class DescribeActivityOutputTypeDef(TypedDict):
    activityArn: str,
    name: str,
    creationDate: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeExecutionOutputTypeDef#

# DescribeExecutionOutputTypeDef definition

class DescribeExecutionOutputTypeDef(TypedDict):
    executionArn: str,
    stateMachineArn: str,
    name: str,
    status: ExecutionStatusType,  # (1)
    startDate: datetime,
    stopDate: datetime,
    input: str,
    inputDetails: CloudWatchEventsExecutionDataDetailsTypeDef,  # (2)
    output: str,
    outputDetails: CloudWatchEventsExecutionDataDetailsTypeDef,  # (2)
    traceHeader: str,
    mapRunArn: str,
    error: str,
    cause: str,
    stateMachineVersionArn: str,
    stateMachineAliasArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ExecutionStatusType
  2. See CloudWatchEventsExecutionDataDetailsTypeDef
  3. See CloudWatchEventsExecutionDataDetailsTypeDef
  4. See ResponseMetadataTypeDef

GetActivityTaskOutputTypeDef#

# GetActivityTaskOutputTypeDef definition

class GetActivityTaskOutputTypeDef(TypedDict):
    taskToken: str,
    input: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListActivitiesOutputTypeDef#

# ListActivitiesOutputTypeDef definition

class ListActivitiesOutputTypeDef(TypedDict):
    activities: List[ActivityListItemTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ActivityListItemTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForResourceOutputTypeDef#

# ListTagsForResourceOutputTypeDef definition

class ListTagsForResourceOutputTypeDef(TypedDict):
    tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

PublishStateMachineVersionOutputTypeDef#

# PublishStateMachineVersionOutputTypeDef definition

class PublishStateMachineVersionOutputTypeDef(TypedDict):
    creationDate: datetime,
    stateMachineVersionArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartExecutionOutputTypeDef#

# StartExecutionOutputTypeDef definition

class StartExecutionOutputTypeDef(TypedDict):
    executionArn: str,
    startDate: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartSyncExecutionOutputTypeDef#

# StartSyncExecutionOutputTypeDef definition

class StartSyncExecutionOutputTypeDef(TypedDict):
    executionArn: str,
    stateMachineArn: str,
    name: str,
    startDate: datetime,
    stopDate: datetime,
    status: SyncExecutionStatusType,  # (1)
    error: str,
    cause: str,
    input: str,
    inputDetails: CloudWatchEventsExecutionDataDetailsTypeDef,  # (2)
    output: str,
    outputDetails: CloudWatchEventsExecutionDataDetailsTypeDef,  # (2)
    traceHeader: str,
    billingDetails: BillingDetailsTypeDef,  # (4)
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See SyncExecutionStatusType
  2. See CloudWatchEventsExecutionDataDetailsTypeDef
  3. See CloudWatchEventsExecutionDataDetailsTypeDef
  4. See BillingDetailsTypeDef
  5. See ResponseMetadataTypeDef

StopExecutionOutputTypeDef#

# StopExecutionOutputTypeDef definition

class StopExecutionOutputTypeDef(TypedDict):
    stopDate: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateStateMachineAliasOutputTypeDef#

# UpdateStateMachineAliasOutputTypeDef definition

class UpdateStateMachineAliasOutputTypeDef(TypedDict):
    updateDate: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateStateMachineOutputTypeDef#

# UpdateStateMachineOutputTypeDef definition

class UpdateStateMachineOutputTypeDef(TypedDict):
    updateDate: datetime,
    revisionId: str,
    stateMachineVersionArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateStateMachineAliasInputRequestTypeDef#

# CreateStateMachineAliasInputRequestTypeDef definition

class CreateStateMachineAliasInputRequestTypeDef(TypedDict):
    name: str,
    routingConfiguration: Sequence[RoutingConfigurationListItemTypeDef],  # (1)
    description: NotRequired[str],
  1. See RoutingConfigurationListItemTypeDef

DescribeStateMachineAliasOutputTypeDef#

# DescribeStateMachineAliasOutputTypeDef definition

class DescribeStateMachineAliasOutputTypeDef(TypedDict):
    stateMachineAliasArn: str,
    name: str,
    description: str,
    routingConfiguration: List[RoutingConfigurationListItemTypeDef],  # (1)
    creationDate: datetime,
    updateDate: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RoutingConfigurationListItemTypeDef
  2. See ResponseMetadataTypeDef

UpdateStateMachineAliasInputRequestTypeDef#

# UpdateStateMachineAliasInputRequestTypeDef definition

class UpdateStateMachineAliasInputRequestTypeDef(TypedDict):
    stateMachineAliasArn: str,
    description: NotRequired[str],
    routingConfiguration: NotRequired[Sequence[RoutingConfigurationListItemTypeDef]],  # (1)
  1. See RoutingConfigurationListItemTypeDef

DescribeMapRunOutputTypeDef#

# DescribeMapRunOutputTypeDef definition

class DescribeMapRunOutputTypeDef(TypedDict):
    mapRunArn: str,
    executionArn: str,
    status: MapRunStatusType,  # (1)
    startDate: datetime,
    stopDate: datetime,
    maxConcurrency: int,
    toleratedFailurePercentage: float,
    toleratedFailureCount: int,
    itemCounts: MapRunItemCountsTypeDef,  # (2)
    executionCounts: MapRunExecutionCountsTypeDef,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See MapRunStatusType
  2. See MapRunItemCountsTypeDef
  3. See MapRunExecutionCountsTypeDef
  4. See ResponseMetadataTypeDef

ListExecutionsOutputTypeDef#

# ListExecutionsOutputTypeDef definition

class ListExecutionsOutputTypeDef(TypedDict):
    executions: List[ExecutionListItemTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ExecutionListItemTypeDef
  2. See ResponseMetadataTypeDef

GetExecutionHistoryInputGetExecutionHistoryPaginateTypeDef#

# GetExecutionHistoryInputGetExecutionHistoryPaginateTypeDef definition

class GetExecutionHistoryInputGetExecutionHistoryPaginateTypeDef(TypedDict):
    executionArn: str,
    reverseOrder: NotRequired[bool],
    includeExecutionData: NotRequired[bool],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListActivitiesInputListActivitiesPaginateTypeDef#

# ListActivitiesInputListActivitiesPaginateTypeDef definition

class ListActivitiesInputListActivitiesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListExecutionsInputListExecutionsPaginateTypeDef#

# ListExecutionsInputListExecutionsPaginateTypeDef definition

class ListExecutionsInputListExecutionsPaginateTypeDef(TypedDict):
    stateMachineArn: NotRequired[str],
    statusFilter: NotRequired[ExecutionStatusType],  # (1)
    mapRunArn: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ExecutionStatusType
  2. See PaginatorConfigTypeDef

ListMapRunsInputListMapRunsPaginateTypeDef#

# ListMapRunsInputListMapRunsPaginateTypeDef definition

class ListMapRunsInputListMapRunsPaginateTypeDef(TypedDict):
    executionArn: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListStateMachinesInputListStateMachinesPaginateTypeDef#

# ListStateMachinesInputListStateMachinesPaginateTypeDef definition

class ListStateMachinesInputListStateMachinesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

LambdaFunctionScheduledEventDetailsTypeDef#

# LambdaFunctionScheduledEventDetailsTypeDef definition

class LambdaFunctionScheduledEventDetailsTypeDef(TypedDict):
    resource: str,
    input: NotRequired[str],
    inputDetails: NotRequired[HistoryEventExecutionDataDetailsTypeDef],  # (1)
    timeoutInSeconds: NotRequired[int],
    taskCredentials: NotRequired[TaskCredentialsTypeDef],  # (2)
  1. See HistoryEventExecutionDataDetailsTypeDef
  2. See TaskCredentialsTypeDef

TaskScheduledEventDetailsTypeDef#

# TaskScheduledEventDetailsTypeDef definition

class TaskScheduledEventDetailsTypeDef(TypedDict):
    resourceType: str,
    resource: str,
    region: str,
    parameters: str,
    timeoutInSeconds: NotRequired[int],
    heartbeatInSeconds: NotRequired[int],
    taskCredentials: NotRequired[TaskCredentialsTypeDef],  # (1)
  1. See TaskCredentialsTypeDef

ListMapRunsOutputTypeDef#

# ListMapRunsOutputTypeDef definition

class ListMapRunsOutputTypeDef(TypedDict):
    mapRuns: List[MapRunListItemTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MapRunListItemTypeDef
  2. See ResponseMetadataTypeDef

ListStateMachineAliasesOutputTypeDef#

# ListStateMachineAliasesOutputTypeDef definition

class ListStateMachineAliasesOutputTypeDef(TypedDict):
    stateMachineAliases: List[StateMachineAliasListItemTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StateMachineAliasListItemTypeDef
  2. See ResponseMetadataTypeDef

ListStateMachineVersionsOutputTypeDef#

# ListStateMachineVersionsOutputTypeDef definition

class ListStateMachineVersionsOutputTypeDef(TypedDict):
    stateMachineVersions: List[StateMachineVersionListItemTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StateMachineVersionListItemTypeDef
  2. See ResponseMetadataTypeDef

ListStateMachinesOutputTypeDef#

# ListStateMachinesOutputTypeDef definition

class ListStateMachinesOutputTypeDef(TypedDict):
    stateMachines: List[StateMachineListItemTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StateMachineListItemTypeDef
  2. See ResponseMetadataTypeDef

LoggingConfigurationTypeDef#

# LoggingConfigurationTypeDef definition

class LoggingConfigurationTypeDef(TypedDict):
    level: NotRequired[LogLevelType],  # (1)
    includeExecutionData: NotRequired[bool],
    destinations: NotRequired[Sequence[LogDestinationTypeDef]],  # (2)
  1. See LogLevelType
  2. See LogDestinationTypeDef

HistoryEventTypeDef#

# HistoryEventTypeDef definition

class HistoryEventTypeDef(TypedDict):
    timestamp: datetime,
    type: HistoryEventTypeType,  # (1)
    id: int,
    previousEventId: NotRequired[int],
    activityFailedEventDetails: NotRequired[ActivityFailedEventDetailsTypeDef],  # (2)
    activityScheduleFailedEventDetails: NotRequired[ActivityScheduleFailedEventDetailsTypeDef],  # (3)
    activityScheduledEventDetails: NotRequired[ActivityScheduledEventDetailsTypeDef],  # (4)
    activityStartedEventDetails: NotRequired[ActivityStartedEventDetailsTypeDef],  # (5)
    activitySucceededEventDetails: NotRequired[ActivitySucceededEventDetailsTypeDef],  # (6)
    activityTimedOutEventDetails: NotRequired[ActivityTimedOutEventDetailsTypeDef],  # (7)
    taskFailedEventDetails: NotRequired[TaskFailedEventDetailsTypeDef],  # (8)
    taskScheduledEventDetails: NotRequired[TaskScheduledEventDetailsTypeDef],  # (9)
    taskStartFailedEventDetails: NotRequired[TaskStartFailedEventDetailsTypeDef],  # (10)
    taskStartedEventDetails: NotRequired[TaskStartedEventDetailsTypeDef],  # (11)
    taskSubmitFailedEventDetails: NotRequired[TaskSubmitFailedEventDetailsTypeDef],  # (12)
    taskSubmittedEventDetails: NotRequired[TaskSubmittedEventDetailsTypeDef],  # (13)
    taskSucceededEventDetails: NotRequired[TaskSucceededEventDetailsTypeDef],  # (14)
    taskTimedOutEventDetails: NotRequired[TaskTimedOutEventDetailsTypeDef],  # (15)
    executionFailedEventDetails: NotRequired[ExecutionFailedEventDetailsTypeDef],  # (16)
    executionStartedEventDetails: NotRequired[ExecutionStartedEventDetailsTypeDef],  # (17)
    executionSucceededEventDetails: NotRequired[ExecutionSucceededEventDetailsTypeDef],  # (18)
    executionAbortedEventDetails: NotRequired[ExecutionAbortedEventDetailsTypeDef],  # (19)
    executionTimedOutEventDetails: NotRequired[ExecutionTimedOutEventDetailsTypeDef],  # (20)
    mapStateStartedEventDetails: NotRequired[MapStateStartedEventDetailsTypeDef],  # (21)
    mapIterationStartedEventDetails: NotRequired[MapIterationEventDetailsTypeDef],  # (22)
    mapIterationSucceededEventDetails: NotRequired[MapIterationEventDetailsTypeDef],  # (22)
    mapIterationFailedEventDetails: NotRequired[MapIterationEventDetailsTypeDef],  # (22)
    mapIterationAbortedEventDetails: NotRequired[MapIterationEventDetailsTypeDef],  # (22)
    lambdaFunctionFailedEventDetails: NotRequired[LambdaFunctionFailedEventDetailsTypeDef],  # (26)
    lambdaFunctionScheduleFailedEventDetails: NotRequired[LambdaFunctionScheduleFailedEventDetailsTypeDef],  # (27)
    lambdaFunctionScheduledEventDetails: NotRequired[LambdaFunctionScheduledEventDetailsTypeDef],  # (28)
    lambdaFunctionStartFailedEventDetails: NotRequired[LambdaFunctionStartFailedEventDetailsTypeDef],  # (29)
    lambdaFunctionSucceededEventDetails: NotRequired[LambdaFunctionSucceededEventDetailsTypeDef],  # (30)
    lambdaFunctionTimedOutEventDetails: NotRequired[LambdaFunctionTimedOutEventDetailsTypeDef],  # (31)
    stateEnteredEventDetails: NotRequired[StateEnteredEventDetailsTypeDef],  # (32)
    stateExitedEventDetails: NotRequired[StateExitedEventDetailsTypeDef],  # (33)
    mapRunStartedEventDetails: NotRequired[MapRunStartedEventDetailsTypeDef],  # (34)
    mapRunFailedEventDetails: NotRequired[MapRunFailedEventDetailsTypeDef],  # (35)
  1. See HistoryEventTypeType
  2. See ActivityFailedEventDetailsTypeDef
  3. See ActivityScheduleFailedEventDetailsTypeDef
  4. See ActivityScheduledEventDetailsTypeDef
  5. See ActivityStartedEventDetailsTypeDef
  6. See ActivitySucceededEventDetailsTypeDef
  7. See ActivityTimedOutEventDetailsTypeDef
  8. See TaskFailedEventDetailsTypeDef
  9. See TaskScheduledEventDetailsTypeDef
  10. See TaskStartFailedEventDetailsTypeDef
  11. See TaskStartedEventDetailsTypeDef
  12. See TaskSubmitFailedEventDetailsTypeDef
  13. See TaskSubmittedEventDetailsTypeDef
  14. See TaskSucceededEventDetailsTypeDef
  15. See TaskTimedOutEventDetailsTypeDef
  16. See ExecutionFailedEventDetailsTypeDef
  17. See ExecutionStartedEventDetailsTypeDef
  18. See ExecutionSucceededEventDetailsTypeDef
  19. See ExecutionAbortedEventDetailsTypeDef
  20. See ExecutionTimedOutEventDetailsTypeDef
  21. See MapStateStartedEventDetailsTypeDef
  22. See MapIterationEventDetailsTypeDef
  23. See MapIterationEventDetailsTypeDef
  24. See MapIterationEventDetailsTypeDef
  25. See MapIterationEventDetailsTypeDef
  26. See LambdaFunctionFailedEventDetailsTypeDef
  27. See LambdaFunctionScheduleFailedEventDetailsTypeDef
  28. See LambdaFunctionScheduledEventDetailsTypeDef
  29. See LambdaFunctionStartFailedEventDetailsTypeDef
  30. See LambdaFunctionSucceededEventDetailsTypeDef
  31. See LambdaFunctionTimedOutEventDetailsTypeDef
  32. See StateEnteredEventDetailsTypeDef
  33. See StateExitedEventDetailsTypeDef
  34. See MapRunStartedEventDetailsTypeDef
  35. See MapRunFailedEventDetailsTypeDef

CreateStateMachineInputRequestTypeDef#

# CreateStateMachineInputRequestTypeDef definition

class CreateStateMachineInputRequestTypeDef(TypedDict):
    name: str,
    definition: str,
    roleArn: str,
    type: NotRequired[StateMachineTypeType],  # (1)
    loggingConfiguration: NotRequired[LoggingConfigurationTypeDef],  # (2)
    tags: NotRequired[Sequence[TagTypeDef]],  # (3)
    tracingConfiguration: NotRequired[TracingConfigurationTypeDef],  # (4)
    publish: NotRequired[bool],
    versionDescription: NotRequired[str],
  1. See StateMachineTypeType
  2. See LoggingConfigurationTypeDef
  3. See TagTypeDef
  4. See TracingConfigurationTypeDef

DescribeStateMachineForExecutionOutputTypeDef#

# DescribeStateMachineForExecutionOutputTypeDef definition

class DescribeStateMachineForExecutionOutputTypeDef(TypedDict):
    stateMachineArn: str,
    name: str,
    definition: str,
    roleArn: str,
    updateDate: datetime,
    loggingConfiguration: LoggingConfigurationTypeDef,  # (1)
    tracingConfiguration: TracingConfigurationTypeDef,  # (2)
    mapRunArn: str,
    label: str,
    revisionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See LoggingConfigurationTypeDef
  2. See TracingConfigurationTypeDef
  3. See ResponseMetadataTypeDef

DescribeStateMachineOutputTypeDef#

# DescribeStateMachineOutputTypeDef definition

class DescribeStateMachineOutputTypeDef(TypedDict):
    stateMachineArn: str,
    name: str,
    status: StateMachineStatusType,  # (1)
    definition: str,
    roleArn: str,
    type: StateMachineTypeType,  # (2)
    creationDate: datetime,
    loggingConfiguration: LoggingConfigurationTypeDef,  # (3)
    tracingConfiguration: TracingConfigurationTypeDef,  # (4)
    label: str,
    revisionId: str,
    description: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See StateMachineStatusType
  2. See StateMachineTypeType
  3. See LoggingConfigurationTypeDef
  4. See TracingConfigurationTypeDef
  5. See ResponseMetadataTypeDef

UpdateStateMachineInputRequestTypeDef#

# UpdateStateMachineInputRequestTypeDef definition

class UpdateStateMachineInputRequestTypeDef(TypedDict):
    stateMachineArn: str,
    definition: NotRequired[str],
    roleArn: NotRequired[str],
    loggingConfiguration: NotRequired[LoggingConfigurationTypeDef],  # (1)
    tracingConfiguration: NotRequired[TracingConfigurationTypeDef],  # (2)
    publish: NotRequired[bool],
    versionDescription: NotRequired[str],
  1. See LoggingConfigurationTypeDef
  2. See TracingConfigurationTypeDef

GetExecutionHistoryOutputTypeDef#

# GetExecutionHistoryOutputTypeDef definition

class GetExecutionHistoryOutputTypeDef(TypedDict):
    events: List[HistoryEventTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See HistoryEventTypeDef
  2. See ResponseMetadataTypeDef