@aws-sdk/client-sfn

Description

AWS SDK for JavaScript SFN Client for Node.js, Browser and React Native.

Step Functions

With Step Functions, you can create workflows, also called state machines, to build distributed applications, automate processes, orchestrate microservices, and create data and machine learning pipelines.

Through the Step Functions API, you can create, list, update, and delete state machines, activities, and other data types. You can start, stop, and redrive your state machines. Your activity workers can send task success, heartbeat, and failure responses.

With API calls, you can also manage other aspects of your workflow, such as tags, versions, and aliases.

For more information about developing solutions with Step Functions, see the
Step Functions Developer Guide
.

If you use the Step Functions API actions using Amazon Web Services SDK integrations, make sure the API actions are in camel case and parameter names are in Pascal case. For example, you might use Step Functions API action startSyncExecution and specify its parameter as StateMachineArn.

Installing

To install this package, simply type add or install @aws-sdk/client-sfn
using your favorite package manager:
- npm install @aws-sdk/client-sfn
- yarn add @aws-sdk/client-sfn
- pnpm add @aws-sdk/client-sfn

Getting Started

$3

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the SFNClient and
the commands you need, for example ListActivitiesCommand:

``js
// ES5 example
const { SFNClient, ListActivitiesCommand } = require("@aws-sdk/client-sfn");
`

`ts
// ES6+ example
import { SFNClient, ListActivitiesCommand } from "@aws-sdk/client-sfn";
`

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.
- If you are using a custom http handler, you may call destroy() to close open connections.

`js
// a client can be shared by different commands.
const client = new SFNClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListActivitiesCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// 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.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

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

`ts
import * as AWS from "@aws-sdk/client-sfn";
const client = new AWS.SFN({ region: "REGION" });

// async/await.
try {
const data = await client.listActivities(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listActivities(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listActivities(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
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;
* }
*/
}
`

Getting Help

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.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-sfn` package is updated.
To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.

Client Commands (Operations List)

CreateActivity

Command API Reference / Input / Output

CreateStateMachine

Command API Reference / Input / Output

CreateStateMachineAlias

Command API Reference / Input / Output

DeleteActivity

Command API Reference / Input / Output

DeleteStateMachine

Command API Reference / Input / Output

DeleteStateMachineAlias

Command API Reference / Input / Output

DeleteStateMachineVersion

Command API Reference / Input / Output

DescribeActivity

Command API Reference / Input / Output

DescribeExecution

Command API Reference / Input / Output

DescribeMapRun

Command API Reference / Input / Output

DescribeStateMachine

Command API Reference / Input / Output

DescribeStateMachineAlias

Command API Reference / Input / Output

DescribeStateMachineForExecution

Command API Reference / Input / Output

GetActivityTask

Command API Reference / Input / Output

GetExecutionHistory

Command API Reference / Input / Output

ListActivities

Command API Reference / Input / Output

ListExecutions

Command API Reference / Input / Output

ListMapRuns

Command API Reference / Input / Output

ListStateMachineAliases

Command API Reference / Input / Output

ListStateMachines

Command API Reference / Input / Output

ListStateMachineVersions

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

PublishStateMachineVersion

Command API Reference / Input / Output

RedriveExecution

Command API Reference / Input / Output

SendTaskFailure

Command API Reference / Input / Output

SendTaskHeartbeat

Command API Reference / Input / Output

SendTaskSuccess

Command API Reference / Input / Output

StartExecution

Command API Reference / Input / Output

StartSyncExecution

Command API Reference / Input / Output

StopExecution

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

TestState

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateMapRun

Command API Reference / Input / Output

UpdateStateMachine

Command API Reference / Input / Output

UpdateStateMachineAlias

Command API Reference / Input / Output

ValidateStateMachineDefinition

Command API Reference / Input / Output