Navigation Guide
You are on the package index page for the Client of a service. Return to the Client landing page

@aws-sdk/client-swf

Description

Amazon Simple Workflow Service

The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to coordinate work across distributed components. In Amazon SWF, a task represents a logical unit of work that is performed by a component of your workflow. Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and concurrency in accordance with the logical flow of the application.

Amazon SWF gives you full control over implementing tasks and coordinating them without worrying about underlying complexities such as tracking their progress and maintaining their state.

This documentation serves as reference only. For a broader overview of the Amazon SWF programming model, see the Amazon SWF Developer Guide .

Installation

NPM

npm install @aws-sdk/client-swf

Yarn

yarn add @aws-sdk/client-swf

pnpm

pnpm add @aws-sdk/client-swf

Types

Type Name	Type
ActivityTask	Interface
ActivityTaskCanceledEventAttributes	Interface
ActivityTaskCancelRequestedEventAttributes	Interface
ActivityTaskCompletedEventAttributes	Interface
ActivityTaskFailedEventAttributes	Interface
ActivityTaskScheduledEventAttributes	Interface
ActivityTaskStartedEventAttributes	Interface
ActivityTaskStatus	Interface
ActivityTaskTimedOutEventAttributes	Interface
ActivityTaskTimeoutType	TypeAlias
ActivityTaskTimeoutTypeenum	Variable
ActivityType	Interface
ActivityTypeConfiguration	Interface
ActivityTypeDetail	Interface
ActivityTypeInfo	Interface
ActivityTypeInfos	Interface
CancelTimerDecisionAttributes	Interface
CancelTimerFailedCause	TypeAlias
CancelTimerFailedCauseenum	Variable
CancelTimerFailedEventAttributes	Interface
CancelWorkflowExecutionDecisionAttributes	Interface
CancelWorkflowExecutionFailedCause	TypeAlias
CancelWorkflowExecutionFailedCauseenum	Variable
CancelWorkflowExecutionFailedEventAttributes	Interface
ChildPolicy	TypeAlias
ChildPolicyenum	Variable
ChildWorkflowExecutionCanceledEventAttributes	Interface
ChildWorkflowExecutionCompletedEventAttributes	Interface
ChildWorkflowExecutionFailedEventAttributes	Interface
ChildWorkflowExecutionStartedEventAttributes	Interface
ChildWorkflowExecutionTerminatedEventAttributes	Interface
ChildWorkflowExecutionTimedOutEventAttributes	Interface
ClientDefaults	Interface
ClientInputEndpointParameters	Interface
CloseStatus	TypeAlias
CloseStatusenum	Variable
CloseStatusFilter	Interface
CompleteWorkflowExecutionDecisionAttributes	Interface
CompleteWorkflowExecutionFailedCause	TypeAlias
CompleteWorkflowExecutionFailedCauseenum	Variable
CompleteWorkflowExecutionFailedEventAttributes	Interface
ContinueAsNewWorkflowExecutionDecisionAttributes	Interface
ContinueAsNewWorkflowExecutionFailedCause	TypeAlias
ContinueAsNewWorkflowExecutionFailedCauseenum	Variable
ContinueAsNewWorkflowExecutionFailedEventAttributes	Interface
CountClosedWorkflowExecutionsCommand	Class
CountClosedWorkflowExecutionsCommandInput	Interface
CountClosedWorkflowExecutionsCommandOutput	Interface
CountClosedWorkflowExecutionsInput	Interface
CountOpenWorkflowExecutionsCommand	Class
CountOpenWorkflowExecutionsCommandInput	Interface
CountOpenWorkflowExecutionsCommandOutput	Interface
CountOpenWorkflowExecutionsInput	Interface
CountPendingActivityTasksCommand	Class
CountPendingActivityTasksCommandInput	Interface
CountPendingActivityTasksCommandOutput	Interface
CountPendingActivityTasksInput	Interface
CountPendingDecisionTasksCommand	Class
CountPendingDecisionTasksCommandInput	Interface
CountPendingDecisionTasksCommandOutput	Interface
CountPendingDecisionTasksInput	Interface
Decision	Interface
DecisionTask	Interface
DecisionTaskCompletedEventAttributes	Interface
DecisionTaskScheduledEventAttributes	Interface
DecisionTaskStartedEventAttributes	Interface
DecisionTaskTimedOutEventAttributes	Interface
DecisionTaskTimeoutType	TypeAlias
DecisionTaskTimeoutTypeenum	Variable
DecisionType	TypeAlias
DecisionTypeenum	Variable
DefaultUndefinedFault	Class
DeleteActivityTypeCommand	Class
DeleteActivityTypeCommandInput	Interface
DeleteActivityTypeCommandOutput	Interface
DeleteActivityTypeInput	Interface
DeleteWorkflowTypeCommand	Class
DeleteWorkflowTypeCommandInput	Interface
DeleteWorkflowTypeCommandOutput	Interface
DeleteWorkflowTypeInput	Interface
DeprecateActivityTypeCommand	Class
DeprecateActivityTypeCommandInput	Interface
DeprecateActivityTypeCommandOutput	Interface
DeprecateActivityTypeInput	Interface
DeprecateDomainCommand	Class
DeprecateDomainCommandInput	Interface
DeprecateDomainCommandOutput	Interface
DeprecateDomainInput	Interface
DeprecateWorkflowTypeCommand	Class
DeprecateWorkflowTypeCommandInput	Interface
DeprecateWorkflowTypeCommandOutput	Interface
DeprecateWorkflowTypeInput	Interface
DescribeActivityTypeCommand	Class
DescribeActivityTypeCommandInput	Interface
DescribeActivityTypeCommandOutput	Interface
DescribeActivityTypeInput	Interface
DescribeDomainCommand	Class
DescribeDomainCommandInput	Interface
DescribeDomainCommandOutput	Interface
DescribeDomainInput	Interface
DescribeWorkflowExecutionCommand	Class
DescribeWorkflowExecutionCommandInput	Interface
DescribeWorkflowExecutionCommandOutput	Interface
DescribeWorkflowExecutionInput	Interface
DescribeWorkflowTypeCommand	Class
DescribeWorkflowTypeCommandInput	Interface
DescribeWorkflowTypeCommandOutput	Interface
DescribeWorkflowTypeInput	Interface
DomainAlreadyExistsFault	Class
DomainConfiguration	Interface
DomainDeprecatedFault	Class
DomainDetail	Interface
DomainInfo	Interface
DomainInfos	Interface
EventType	TypeAlias
EventTypeenum	Variable
ExecutionStatus	TypeAlias
ExecutionStatusenum	Variable
ExecutionTimeFilter	Interface
ExternalWorkflowExecutionCancelRequestedEventAttributes	Interface
ExternalWorkflowExecutionSignaledEventAttributes	Interface
FailWorkflowExecutionDecisionAttributes	Interface
FailWorkflowExecutionFailedCause	TypeAlias
FailWorkflowExecutionFailedCauseenum	Variable
FailWorkflowExecutionFailedEventAttributes	Interface
GetWorkflowExecutionHistoryCommand	Class
GetWorkflowExecutionHistoryCommandInput	Interface
GetWorkflowExecutionHistoryCommandOutput	Interface
GetWorkflowExecutionHistoryInput	Interface
History	Interface
HistoryEvent	Interface
LambdaFunctionCompletedEventAttributes	Interface
LambdaFunctionFailedEventAttributes	Interface
LambdaFunctionScheduledEventAttributes	Interface
LambdaFunctionStartedEventAttributes	Interface
LambdaFunctionTimedOutEventAttributes	Interface
LambdaFunctionTimeoutType	TypeAlias
LambdaFunctionTimeoutTypeenum	Variable
LimitExceededFault	Class
ListActivityTypesCommand	Class
ListActivityTypesCommandInput	Interface
ListActivityTypesCommandOutput	Interface
ListActivityTypesInput	Interface
ListClosedWorkflowExecutionsCommand	Class
ListClosedWorkflowExecutionsCommandInput	Interface
ListClosedWorkflowExecutionsCommandOutput	Interface
ListClosedWorkflowExecutionsInput	Interface
ListDomainsCommand	Class
ListDomainsCommandInput	Interface
ListDomainsCommandOutput	Interface
ListDomainsInput	Interface
ListOpenWorkflowExecutionsCommand	Class
ListOpenWorkflowExecutionsCommandInput	Interface
ListOpenWorkflowExecutionsCommandOutput	Interface
ListOpenWorkflowExecutionsInput	Interface
ListTagsForResourceCommand	Class
ListTagsForResourceCommandInput	Interface
ListTagsForResourceCommandOutput	Interface
ListTagsForResourceInput	Interface
ListTagsForResourceOutput	Interface
ListWorkflowTypesCommand	Class
ListWorkflowTypesCommandInput	Interface
ListWorkflowTypesCommandOutput	Interface
ListWorkflowTypesInput	Interface
MarkerRecordedEventAttributes	Interface
OperationNotPermittedFault	Class
paginateGetWorkflowExecutionHistory	Variable
paginateListActivityTypes	Variable
paginateListClosedWorkflowExecutions	Variable
paginateListDomains	Variable
paginateListOpenWorkflowExecutions	Variable
paginateListWorkflowTypes	Variable
paginatePollForDecisionTask	Variable
PendingTaskCount	Interface
PollForActivityTaskCommand	Class
PollForActivityTaskCommandInput	Interface
PollForActivityTaskCommandOutput	Interface
PollForActivityTaskInput	Interface
PollForDecisionTaskCommand	Class
PollForDecisionTaskCommandInput	Interface
PollForDecisionTaskCommandOutput	Interface
PollForDecisionTaskInput	Interface
RecordActivityTaskHeartbeatCommand	Class
RecordActivityTaskHeartbeatCommandInput	Interface
RecordActivityTaskHeartbeatCommandOutput	Interface
RecordActivityTaskHeartbeatInput	Interface
RecordMarkerDecisionAttributes	Interface
RecordMarkerFailedCause	TypeAlias
RecordMarkerFailedCauseenum	Variable
RecordMarkerFailedEventAttributes	Interface
RegisterActivityTypeCommand	Class
RegisterActivityTypeCommandInput	Interface
RegisterActivityTypeCommandOutput	Interface
RegisterActivityTypeInput	Interface
RegisterDomainCommand	Class
RegisterDomainCommandInput	Interface
RegisterDomainCommandOutput	Interface
RegisterDomainInput	Interface
RegisterWorkflowTypeCommand	Class
RegisterWorkflowTypeCommandInput	Interface
RegisterWorkflowTypeCommandOutput	Interface
RegisterWorkflowTypeInput	Interface
RegistrationStatus	TypeAlias
RegistrationStatusenum	Variable
RequestCancelActivityTaskDecisionAttributes	Interface
RequestCancelActivityTaskFailedCause	TypeAlias
RequestCancelActivityTaskFailedCauseenum	Variable
RequestCancelActivityTaskFailedEventAttributes	Interface
RequestCancelExternalWorkflowExecutionDecisionAttributes	Interface
RequestCancelExternalWorkflowExecutionFailedCause	TypeAlias
RequestCancelExternalWorkflowExecutionFailedCauseenum	Variable
RequestCancelExternalWorkflowExecutionFailedEventAttributes	Interface
RequestCancelExternalWorkflowExecutionInitiatedEventAttributes	Interface
RequestCancelWorkflowExecutionCommand	Class
RequestCancelWorkflowExecutionCommandInput	Interface
RequestCancelWorkflowExecutionCommandOutput	Interface
RequestCancelWorkflowExecutionInput	Interface
ResourceTag	Interface
RespondActivityTaskCanceledCommand	Class
RespondActivityTaskCanceledCommandInput	Interface
RespondActivityTaskCanceledCommandOutput	Interface
RespondActivityTaskCanceledInput	Interface
RespondActivityTaskCompletedCommand	Class
RespondActivityTaskCompletedCommandInput	Interface
RespondActivityTaskCompletedCommandOutput	Interface
RespondActivityTaskCompletedInput	Interface
RespondActivityTaskFailedCommand	Class
RespondActivityTaskFailedCommandInput	Interface
RespondActivityTaskFailedCommandOutput	Interface
RespondActivityTaskFailedInput	Interface
RespondDecisionTaskCompletedCommand	Class
RespondDecisionTaskCompletedCommandInput	Interface
RespondDecisionTaskCompletedCommandOutput	Interface
RespondDecisionTaskCompletedInput	Interface
Run	Interface
RuntimeExtension	Interface
ScheduleActivityTaskDecisionAttributes	Interface
ScheduleActivityTaskFailedCause	TypeAlias
ScheduleActivityTaskFailedCauseenum	Variable
ScheduleActivityTaskFailedEventAttributes	Interface
ScheduleLambdaFunctionDecisionAttributes	Interface
ScheduleLambdaFunctionFailedCause	TypeAlias
ScheduleLambdaFunctionFailedCauseenum	Variable
ScheduleLambdaFunctionFailedEventAttributes	Interface
ServiceInputTypes	TypeAlias
ServiceOutputTypes	TypeAlias
SignalExternalWorkflowExecutionDecisionAttributes	Interface
SignalExternalWorkflowExecutionFailedCause	TypeAlias
SignalExternalWorkflowExecutionFailedCauseenum	Variable
SignalExternalWorkflowExecutionFailedEventAttributes	Interface
SignalExternalWorkflowExecutionInitiatedEventAttributes	Interface
SignalWorkflowExecutionCommand	Class
SignalWorkflowExecutionCommandInput	Interface
SignalWorkflowExecutionCommandOutput	Interface
SignalWorkflowExecutionInput	Interface
StartChildWorkflowExecutionDecisionAttributes	Interface
StartChildWorkflowExecutionFailedCause	TypeAlias
StartChildWorkflowExecutionFailedCauseenum	Variable
StartChildWorkflowExecutionFailedEventAttributes	Interface
StartChildWorkflowExecutionInitiatedEventAttributes	Interface
StartLambdaFunctionFailedCause	TypeAlias
StartLambdaFunctionFailedCauseenum	Variable
StartLambdaFunctionFailedEventAttributes	Interface
StartTimerDecisionAttributes	Interface
StartTimerFailedCause	TypeAlias
StartTimerFailedCauseenum	Variable
StartTimerFailedEventAttributes	Interface
StartWorkflowExecutionCommand	Class
StartWorkflowExecutionCommandInput	Interface
StartWorkflowExecutionCommandOutput	Interface
StartWorkflowExecutionInput	Interface
SWF	Class
SWF	Interface
SWFClient	Class
SWFClientConfig	Interface
SWFClientConfigType	TypeAlias
SWFClientResolvedConfig	Interface
SWFClientResolvedConfigType	TypeAlias
SWFPaginationConfiguration	Interface
SWFServiceException	Class
TagFilter	Interface
TagResourceCommand	Class
TagResourceCommandInput	Interface
TagResourceCommandOutput	Interface
TagResourceInput	Interface
TaskList	Interface
TerminateWorkflowExecutionCommand	Class
TerminateWorkflowExecutionCommandInput	Interface
TerminateWorkflowExecutionCommandOutput	Interface
TerminateWorkflowExecutionInput	Interface
TimerCanceledEventAttributes	Interface
TimerFiredEventAttributes	Interface
TimerStartedEventAttributes	Interface
TooManyTagsFault	Class
TypeAlreadyExistsFault	Class
TypeDeprecatedFault	Class
TypeNotDeprecatedFault	Class
UndeprecateActivityTypeCommand	Class
UndeprecateActivityTypeCommandInput	Interface
UndeprecateActivityTypeCommandOutput	Interface
UndeprecateActivityTypeInput	Interface
UndeprecateDomainCommand	Class
UndeprecateDomainCommandInput	Interface
UndeprecateDomainCommandOutput	Interface
UndeprecateDomainInput	Interface
UndeprecateWorkflowTypeCommand	Class
UndeprecateWorkflowTypeCommandInput	Interface
UndeprecateWorkflowTypeCommandOutput	Interface
UndeprecateWorkflowTypeInput	Interface
UnknownResourceFault	Class
UntagResourceCommand	Class
UntagResourceCommandInput	Interface
UntagResourceCommandOutput	Interface
UntagResourceInput	Interface
WorkflowExecution	Interface
WorkflowExecutionAlreadyStartedFault	Class
WorkflowExecutionCanceledEventAttributes	Interface
WorkflowExecutionCancelRequestedCause	TypeAlias
WorkflowExecutionCancelRequestedCauseenum	Variable
WorkflowExecutionCancelRequestedEventAttributes	Interface
WorkflowExecutionCompletedEventAttributes	Interface
WorkflowExecutionConfiguration	Interface
WorkflowExecutionContinuedAsNewEventAttributes	Interface
WorkflowExecutionCount	Interface
WorkflowExecutionDetail	Interface
WorkflowExecutionFailedEventAttributes	Interface
WorkflowExecutionFilter	Interface
WorkflowExecutionInfo	Interface
WorkflowExecutionInfos	Interface
WorkflowExecutionOpenCounts	Interface
WorkflowExecutionSignaledEventAttributes	Interface
WorkflowExecutionStartedEventAttributes	Interface
WorkflowExecutionTerminatedCause	TypeAlias
WorkflowExecutionTerminatedCauseenum	Variable
WorkflowExecutionTerminatedEventAttributes	Interface
WorkflowExecutionTimedOutEventAttributes	Interface
WorkflowExecutionTimeoutType	TypeAlias
WorkflowExecutionTimeoutTypeenum	Variable
WorkflowType	Interface
WorkflowTypeConfiguration	Interface
WorkflowTypeDetail	Interface
WorkflowTypeFilter	Interface
WorkflowTypeInfo	Interface
WorkflowTypeInfos	Interface

Item	Package	Type
Access	@aws-sdk/client-accessanalyzer	Interface
AccessAnalyzer	@aws-sdk/client-accessanalyzer	Interface
AccessAnalyzerClientConfig	@aws-sdk/client-accessanalyzer	Interface
AccessAnalyzerClientResolvedConfig	@aws-sdk/client-accessanalyzer	Interface
AccessAnalyzerPaginationConfiguration	@aws-sdk/client-accessanalyzer	Interface
AccessPreview	@aws-sdk/client-accessanalyzer	Interface
AccessPreviewFinding	@aws-sdk/client-accessanalyzer	Interface
AccessPreviewStatusReason	@aws-sdk/client-accessanalyzer	Interface
AccessPreviewSummary	@aws-sdk/client-accessanalyzer	Interface
AnalysisRule	@aws-sdk/client-accessanalyzer	Interface

Select your cookie preferences

Customize cookie preferences

Essential

Performance

Functional

Advertising

Unable to save cookie preferences

Getting Started

References

@aws-sdk/client-swf

Description

Installation

Types

Table of Contents

Search