@aws-sdk/client-sfn

What is @aws-sdk/client-sfn?

@aws-sdk/client-sfn is an AWS SDK for JavaScript package that allows developers to interact with AWS Step Functions. AWS Step Functions is a service that lets you coordinate multiple AWS services into serverless workflows, making it easier to build and manage complex applications.

What are @aws-sdk/client-sfn's main functionalities?

Create State Machine

This feature allows you to create a new state machine in AWS Step Functions. The code sample demonstrates how to define a simple state machine and create it using the AWS SDK.

const { SFNClient, CreateStateMachineCommand } = require('@aws-sdk/client-sfn');

const client = new SFNClient({ region: 'us-west-2' });

const params = {
  name: 'MyStateMachine',
  definition: JSON.stringify({
    Comment: 'A Hello World example of the Amazon States Language using a Pass state',
    StartAt: 'HelloWorld',
    States: {
      HelloWorld: {
        Type: 'Pass',
        Result: 'Hello, World!',
        End: true
      }
    }
  }),
  roleArn: 'arn:aws:iam::123456789012:role/service-role/MyRole'
};

const run = async () => {
  try {
    const data = await client.send(new CreateStateMachineCommand(params));
    console.log('State Machine ARN:', data.stateMachineArn);
  } catch (err) {
    console.error(err);
  }
};

run();

Start Execution

This feature allows you to start an execution of a state machine. The code sample demonstrates how to start an execution with input parameters.

const { SFNClient, StartExecutionCommand } = require('@aws-sdk/client-sfn');

const client = new SFNClient({ region: 'us-west-2' });

const params = {
  stateMachineArn: 'arn:aws:states:us-west-2:123456789012:stateMachine:MyStateMachine',
  input: JSON.stringify({
    key1: 'value1',
    key2: 'value2'
  })
};

const run = async () => {
  try {
    const data = await client.send(new StartExecutionCommand(params));
    console.log('Execution ARN:', data.executionArn);
  } catch (err) {
    console.error(err);
  }
};

run();

Describe Execution

This feature allows you to describe an execution of a state machine. The code sample demonstrates how to retrieve details of a specific execution.

const { SFNClient, DescribeExecutionCommand } = require('@aws-sdk/client-sfn');

const client = new SFNClient({ region: 'us-west-2' });

const params = {
  executionArn: 'arn:aws:states:us-west-2:123456789012:execution:MyStateMachine:MyExecution'
};

const run = async () => {
  try {
    const data = await client.send(new DescribeExecutionCommand(params));
    console.log('Execution Details:', data);
  } catch (err) {
    console.error(err);
  }
};

run();

Other packages similar to @aws-sdk/client-sfn

aws-sdk

The 'aws-sdk' package is the official AWS SDK for JavaScript, which includes support for all AWS services, including Step Functions. It is a more comprehensive package compared to @aws-sdk/client-sfn, which is specialized for Step Functions.

serverless-step-functions

The 'serverless-step-functions' package is a Serverless Framework plugin that simplifies the deployment and management of AWS Step Functions. It provides a higher-level abstraction compared to @aws-sdk/client-sfn, making it easier to define and deploy state machines using the Serverless Framework.

README

@aws-sdk/client-sfn

For SDK usage, please step to SDK readme.