Skip to content

Type definitions#

Index > SWF > Type definitions

Auto-generated documentation for SWF type annotations stubs module mypy-boto3-swf.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

ActivityTaskCancelRequestedEventAttributesTypeDef#

# ActivityTaskCancelRequestedEventAttributesTypeDef definition

class ActivityTaskCancelRequestedEventAttributesTypeDef(TypedDict):
    decisionTaskCompletedEventId: int,
    activityId: str,

ActivityTaskCanceledEventAttributesTypeDef#

# ActivityTaskCanceledEventAttributesTypeDef definition

class ActivityTaskCanceledEventAttributesTypeDef(TypedDict):
    scheduledEventId: int,
    startedEventId: int,
    details: NotRequired[str],
    latestCancelRequestedEventId: NotRequired[int],

ActivityTaskCompletedEventAttributesTypeDef#

# ActivityTaskCompletedEventAttributesTypeDef definition

class ActivityTaskCompletedEventAttributesTypeDef(TypedDict):
    scheduledEventId: int,
    startedEventId: int,
    result: NotRequired[str],

ActivityTaskFailedEventAttributesTypeDef#

# ActivityTaskFailedEventAttributesTypeDef definition

class ActivityTaskFailedEventAttributesTypeDef(TypedDict):
    scheduledEventId: int,
    startedEventId: int,
    reason: NotRequired[str],
    details: NotRequired[str],

ActivityTypeTypeDef#

# ActivityTypeTypeDef definition

class ActivityTypeTypeDef(TypedDict):
    name: str,
    version: str,

TaskListTypeDef#

# TaskListTypeDef definition

class TaskListTypeDef(TypedDict):
    name: str,

ActivityTaskStartedEventAttributesTypeDef#

# ActivityTaskStartedEventAttributesTypeDef definition

class ActivityTaskStartedEventAttributesTypeDef(TypedDict):
    scheduledEventId: int,
    identity: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

ActivityTaskTimedOutEventAttributesTypeDef#

# ActivityTaskTimedOutEventAttributesTypeDef definition

class ActivityTaskTimedOutEventAttributesTypeDef(TypedDict):
    timeoutType: ActivityTaskTimeoutTypeType,  # (1)
    scheduledEventId: int,
    startedEventId: int,
    details: NotRequired[str],
  1. See ActivityTaskTimeoutTypeType

WorkflowExecutionTypeDef#

# WorkflowExecutionTypeDef definition

class WorkflowExecutionTypeDef(TypedDict):
    workflowId: str,
    runId: str,

CancelTimerDecisionAttributesTypeDef#

# CancelTimerDecisionAttributesTypeDef definition

class CancelTimerDecisionAttributesTypeDef(TypedDict):
    timerId: str,

CancelTimerFailedEventAttributesTypeDef#

# CancelTimerFailedEventAttributesTypeDef definition

class CancelTimerFailedEventAttributesTypeDef(TypedDict):
    timerId: str,
    cause: CancelTimerFailedCauseType,  # (1)
    decisionTaskCompletedEventId: int,
  1. See CancelTimerFailedCauseType

CancelWorkflowExecutionDecisionAttributesTypeDef#

# CancelWorkflowExecutionDecisionAttributesTypeDef definition

class CancelWorkflowExecutionDecisionAttributesTypeDef(TypedDict):
    details: NotRequired[str],

CancelWorkflowExecutionFailedEventAttributesTypeDef#

# CancelWorkflowExecutionFailedEventAttributesTypeDef definition

class CancelWorkflowExecutionFailedEventAttributesTypeDef(TypedDict):
    cause: CancelWorkflowExecutionFailedCauseType,  # (1)
    decisionTaskCompletedEventId: int,
  1. See CancelWorkflowExecutionFailedCauseType

WorkflowTypeTypeDef#

# WorkflowTypeTypeDef definition

class WorkflowTypeTypeDef(TypedDict):
    name: str,
    version: str,

CloseStatusFilterTypeDef#

# CloseStatusFilterTypeDef definition

class CloseStatusFilterTypeDef(TypedDict):
    status: CloseStatusType,  # (1)
  1. See CloseStatusType

CompleteWorkflowExecutionDecisionAttributesTypeDef#

# CompleteWorkflowExecutionDecisionAttributesTypeDef definition

class CompleteWorkflowExecutionDecisionAttributesTypeDef(TypedDict):
    result: NotRequired[str],

CompleteWorkflowExecutionFailedEventAttributesTypeDef#

# CompleteWorkflowExecutionFailedEventAttributesTypeDef definition

class CompleteWorkflowExecutionFailedEventAttributesTypeDef(TypedDict):
    cause: CompleteWorkflowExecutionFailedCauseType,  # (1)
    decisionTaskCompletedEventId: int,
  1. See CompleteWorkflowExecutionFailedCauseType

ContinueAsNewWorkflowExecutionFailedEventAttributesTypeDef#

# ContinueAsNewWorkflowExecutionFailedEventAttributesTypeDef definition

class ContinueAsNewWorkflowExecutionFailedEventAttributesTypeDef(TypedDict):
    cause: ContinueAsNewWorkflowExecutionFailedCauseType,  # (1)
    decisionTaskCompletedEventId: int,
  1. See ContinueAsNewWorkflowExecutionFailedCauseType

TagFilterTypeDef#

# TagFilterTypeDef definition

class TagFilterTypeDef(TypedDict):
    tag: str,

WorkflowExecutionFilterTypeDef#

# WorkflowExecutionFilterTypeDef definition

class WorkflowExecutionFilterTypeDef(TypedDict):
    workflowId: str,

WorkflowTypeFilterTypeDef#

# WorkflowTypeFilterTypeDef definition

class WorkflowTypeFilterTypeDef(TypedDict):
    name: str,
    version: NotRequired[str],

DecisionTaskStartedEventAttributesTypeDef#

# DecisionTaskStartedEventAttributesTypeDef definition

class DecisionTaskStartedEventAttributesTypeDef(TypedDict):
    scheduledEventId: int,
    identity: NotRequired[str],

DecisionTaskTimedOutEventAttributesTypeDef#

# DecisionTaskTimedOutEventAttributesTypeDef definition

class DecisionTaskTimedOutEventAttributesTypeDef(TypedDict):
    timeoutType: DecisionTaskTimeoutTypeType,  # (1)
    scheduledEventId: int,
    startedEventId: int,
  1. See DecisionTaskTimeoutTypeType

FailWorkflowExecutionDecisionAttributesTypeDef#

# FailWorkflowExecutionDecisionAttributesTypeDef definition

class FailWorkflowExecutionDecisionAttributesTypeDef(TypedDict):
    reason: NotRequired[str],
    details: NotRequired[str],

RecordMarkerDecisionAttributesTypeDef#

# RecordMarkerDecisionAttributesTypeDef definition

class RecordMarkerDecisionAttributesTypeDef(TypedDict):
    markerName: str,
    details: NotRequired[str],

RequestCancelActivityTaskDecisionAttributesTypeDef#

# RequestCancelActivityTaskDecisionAttributesTypeDef definition

class RequestCancelActivityTaskDecisionAttributesTypeDef(TypedDict):
    activityId: str,

RequestCancelExternalWorkflowExecutionDecisionAttributesTypeDef#

# RequestCancelExternalWorkflowExecutionDecisionAttributesTypeDef definition

class RequestCancelExternalWorkflowExecutionDecisionAttributesTypeDef(TypedDict):
    workflowId: str,
    runId: NotRequired[str],
    control: NotRequired[str],

ScheduleLambdaFunctionDecisionAttributesTypeDef#

# ScheduleLambdaFunctionDecisionAttributesTypeDef definition

class ScheduleLambdaFunctionDecisionAttributesTypeDef(TypedDict):
    id: str,
    name: str,
    control: NotRequired[str],
    input: NotRequired[str],
    startToCloseTimeout: NotRequired[str],

SignalExternalWorkflowExecutionDecisionAttributesTypeDef#

# SignalExternalWorkflowExecutionDecisionAttributesTypeDef definition

class SignalExternalWorkflowExecutionDecisionAttributesTypeDef(TypedDict):
    workflowId: str,
    signalName: str,
    runId: NotRequired[str],
    input: NotRequired[str],
    control: NotRequired[str],

StartTimerDecisionAttributesTypeDef#

# StartTimerDecisionAttributesTypeDef definition

class StartTimerDecisionAttributesTypeDef(TypedDict):
    timerId: str,
    startToFireTimeout: str,
    control: NotRequired[str],

DeprecateDomainInputRequestTypeDef#

# DeprecateDomainInputRequestTypeDef definition

class DeprecateDomainInputRequestTypeDef(TypedDict):
    name: str,

DescribeDomainInputRequestTypeDef#

# DescribeDomainInputRequestTypeDef definition

class DescribeDomainInputRequestTypeDef(TypedDict):
    name: str,

DomainConfigurationTypeDef#

# DomainConfigurationTypeDef definition

class DomainConfigurationTypeDef(TypedDict):
    workflowExecutionRetentionPeriodInDays: str,

DomainInfoTypeDef#

# DomainInfoTypeDef definition

class DomainInfoTypeDef(TypedDict):
    name: str,
    status: RegistrationStatusType,  # (1)
    description: NotRequired[str],
    arn: NotRequired[str],
  1. See RegistrationStatusType

FailWorkflowExecutionFailedEventAttributesTypeDef#

# FailWorkflowExecutionFailedEventAttributesTypeDef definition

class FailWorkflowExecutionFailedEventAttributesTypeDef(TypedDict):
    cause: FailWorkflowExecutionFailedCauseType,  # (1)
    decisionTaskCompletedEventId: int,
  1. See FailWorkflowExecutionFailedCauseType

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

LambdaFunctionCompletedEventAttributesTypeDef#

# LambdaFunctionCompletedEventAttributesTypeDef definition

class LambdaFunctionCompletedEventAttributesTypeDef(TypedDict):
    scheduledEventId: int,
    startedEventId: int,
    result: NotRequired[str],

LambdaFunctionFailedEventAttributesTypeDef#

# LambdaFunctionFailedEventAttributesTypeDef definition

class LambdaFunctionFailedEventAttributesTypeDef(TypedDict):
    scheduledEventId: int,
    startedEventId: int,
    reason: NotRequired[str],
    details: NotRequired[str],

LambdaFunctionScheduledEventAttributesTypeDef#

# LambdaFunctionScheduledEventAttributesTypeDef definition

class LambdaFunctionScheduledEventAttributesTypeDef(TypedDict):
    id: str,
    name: str,
    decisionTaskCompletedEventId: int,
    control: NotRequired[str],
    input: NotRequired[str],
    startToCloseTimeout: NotRequired[str],

LambdaFunctionStartedEventAttributesTypeDef#

# LambdaFunctionStartedEventAttributesTypeDef definition

class LambdaFunctionStartedEventAttributesTypeDef(TypedDict):
    scheduledEventId: int,

LambdaFunctionTimedOutEventAttributesTypeDef#

# LambdaFunctionTimedOutEventAttributesTypeDef definition

class LambdaFunctionTimedOutEventAttributesTypeDef(TypedDict):
    scheduledEventId: int,
    startedEventId: int,
    timeoutType: NotRequired[LambdaFunctionTimeoutTypeType],  # (1)
  1. See LambdaFunctionTimeoutTypeType

MarkerRecordedEventAttributesTypeDef#

# MarkerRecordedEventAttributesTypeDef definition

class MarkerRecordedEventAttributesTypeDef(TypedDict):
    markerName: str,
    decisionTaskCompletedEventId: int,
    details: NotRequired[str],

RecordMarkerFailedEventAttributesTypeDef#

# RecordMarkerFailedEventAttributesTypeDef definition

class RecordMarkerFailedEventAttributesTypeDef(TypedDict):
    markerName: str,
    cause: RecordMarkerFailedCauseType,  # (1)
    decisionTaskCompletedEventId: int,
  1. See RecordMarkerFailedCauseType

RequestCancelActivityTaskFailedEventAttributesTypeDef#

# RequestCancelActivityTaskFailedEventAttributesTypeDef definition

class RequestCancelActivityTaskFailedEventAttributesTypeDef(TypedDict):
    activityId: str,
    cause: RequestCancelActivityTaskFailedCauseType,  # (1)
    decisionTaskCompletedEventId: int,
  1. See RequestCancelActivityTaskFailedCauseType

RequestCancelExternalWorkflowExecutionFailedEventAttributesTypeDef#

# RequestCancelExternalWorkflowExecutionFailedEventAttributesTypeDef definition

class RequestCancelExternalWorkflowExecutionFailedEventAttributesTypeDef(TypedDict):
    workflowId: str,
    cause: RequestCancelExternalWorkflowExecutionFailedCauseType,  # (1)
    initiatedEventId: int,
    decisionTaskCompletedEventId: int,
    runId: NotRequired[str],
    control: NotRequired[str],
  1. See RequestCancelExternalWorkflowExecutionFailedCauseType

RequestCancelExternalWorkflowExecutionInitiatedEventAttributesTypeDef#

# RequestCancelExternalWorkflowExecutionInitiatedEventAttributesTypeDef definition

class RequestCancelExternalWorkflowExecutionInitiatedEventAttributesTypeDef(TypedDict):
    workflowId: str,
    decisionTaskCompletedEventId: int,
    runId: NotRequired[str],
    control: NotRequired[str],

ScheduleLambdaFunctionFailedEventAttributesTypeDef