Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@aws-sdk/client-sfn

Package Overview
Dependencies
Maintainers
4
Versions
422
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@aws-sdk/client-sfn

@aws-sdk/client-sfn client

  • 1.0.0-beta.2
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
1.8M
increased by34.63%
Maintainers
4
Weekly downloads
 
Created

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

FAQs

Package last updated on 28 Mar 2020

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc