@aws-sdk/client-swf
Advanced tools
AWS SDK for JavaScript Swf Client for Node.js, Browser and React Native
Package description
@aws-sdk/client-swf is an AWS SDK for JavaScript package that allows developers to interact with the Amazon Simple Workflow Service (SWF). SWF helps developers build, run, and scale background jobs that have parallel or sequential steps. It provides a way to coordinate work across distributed components and track the progress of workflows.
Start a Workflow Execution
This feature allows you to start a new workflow execution in a specified domain. You need to provide the domain, workflow ID, workflow type, task list, and any input data required for the workflow.
const { SWFClient, StartWorkflowExecutionCommand } = require('@aws-sdk/client-swf');
const client = new SWFClient({ region: 'us-west-2' });
const params = {
domain: 'example-domain',
workflowId: 'example-workflow-id',
workflowType: {
name: 'example-workflow-type',
version: '1.0'
},
taskList: { name: 'example-task-list' },
input: JSON.stringify({ key: 'value' })
};
const command = new StartWorkflowExecutionCommand(params);
client.send(command).then(
(data) => console.log('Workflow started:', data),
(error) => console.error('Error starting workflow:', error)
);Poll for a Decision Task
This feature allows you to poll for a decision task from a specified task list. Decision tasks are used to determine the next steps in a workflow execution.
const { SWFClient, PollForDecisionTaskCommand } = require('@aws-sdk/client-swf');
const client = new SWFClient({ region: 'us-west-2' });
const params = {
domain: 'example-domain',
taskList: { name: 'example-task-list' }
};
const command = new PollForDecisionTaskCommand(params);
client.send(command).then(
(data) => console.log('Decision task:', data),
(error) => console.error('Error polling for decision task:', error)
);Respond to a Decision Task
This feature allows you to respond to a decision task by providing the task token and the decisions made. In this example, the decision is to complete the workflow execution with a specified result.
const { SWFClient, RespondDecisionTaskCompletedCommand } = require('@aws-sdk/client-swf');
const client = new SWFClient({ region: 'us-west-2' });
const params = {
taskToken: 'example-task-token',
decisions: [
{
decisionType: 'CompleteWorkflowExecution',
completeWorkflowExecutionDecisionAttributes: {
result: JSON.stringify({ key: 'value' })
}
}
]
};
const command = new RespondDecisionTaskCompletedCommand(params);
client.send(command).then(
(data) => console.log('Decision task completed:', data),
(error) => console.error('Error responding to decision task:', error)
);The aws-sdk package is the older version of the AWS SDK for JavaScript. It provides a comprehensive set of tools for interacting with AWS services, including SWF. However, it is not modular like the @aws-sdk/client-swf package, which means you have to include the entire SDK even if you only need SWF functionality.
Temporal is an open-source workflow orchestration engine that provides similar functionality to SWF. It allows you to build and manage complex workflows with a focus on reliability and scalability. Unlike SWF, Temporal is not tied to AWS and can be run on any infrastructure.
Zeebe is a workflow engine for microservices orchestration. The zeebe-node package allows you to interact with the Zeebe engine from Node.js applications. Zeebe focuses on high throughput and scalability, making it suitable for large-scale workflow automation. It is an alternative to SWF for users who prefer open-source solutions.
Changelog
3.477.0 (2023-12-19)
Readme
AWS SDK for JavaScript SWF Client for Node.js, Browser and React Native.
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 .
To install the this package, simply type add or install @aws-sdk/client-swf using your favorite package manager:
npm install @aws-sdk/client-swfyarn add @aws-sdk/client-swfpnpm add @aws-sdk/client-swfThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the SWFClient and
the commands you need, for example ListDomainsCommand:
// ES5 example
const { SWFClient, ListDomainsCommand } = require("@aws-sdk/client-swf");
// ES6+ example
import { SWFClient, ListDomainsCommand } from "@aws-sdk/client-swf";
To send a request, you:
send operation on client with command object as input.destroy() to close open connections.// a client can be shared by different commands.
const client = new SWFClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new ListDomainsCommand(params);
We recommend using await operator to wait for the promise returned by send operation as follows:
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.
You can also use Promise chaining to execute send operation.
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-swf";
const client = new AWS.SWF({ region: "REGION" });
// async/await.
try {
const data = await client.listDomains(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listDomains(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listDomains(params, (err, data) => {
// process err and data.
});
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-swf package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
FAQs
AWS SDK for JavaScript Swf Client for Node.js, Browser and React Native
The npm package @aws-sdk/client-swf receives a total of 90,306 weekly downloads. As such, @aws-sdk/client-swf popularity was classified as popular.
We found that @aws-sdk/client-swf demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Git dependencies in open source packages can introduce significant risks, including lack of version control, stability issues, dependency drift, and difficulty in auditing, making them potential targets for supply chain attacks.
Security News
Node.js has added experimental support for TypeScript, a move that highlights the growing importance of TypeScript in modern development.
Product
Check out what's new at Socket with our Product Changelog. It tracks all public-facing updates, improvements, and fixes so you can take full advantage of our features.