This package has been deprecated

Author message:

The package @aws-sdk/client-sfn-browser has been renamed to @aws-sdk/client-sfn. Please install the renamed package.

@aws-sdk/client-sfn-browser

Description

AWS Step Functions

AWS Step Functions is a service that lets you coordinate the components of distributed applications and microservices using visual workflows.

You can use Step Functions to build applications from individual components, each of which performs a discrete function, or task, allowing you to scale and change applications quickly. Step Functions provides a console that helps visualize the components of your application as a series of steps. Step Functions automatically triggers and tracks each step, and retries steps when there are errors, so your application executes predictably and in the right order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any issues.

Step Functions manages operations and underlying infrastructure to ensure your application is available at any scale. You can run tasks on AWS, your own servers, or any system that has access to AWS. You can access and use Step Functions using the console, the AWS SDKs, or an HTTP API. For more information about Step Functions, see the AWS Step Functions Developer Guide .

Installing

To install the this package using NPM, simply type the following into a terminal window:

npm install @aws-sdk/client-sfn-browser

Getting Started

Import

The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(SFNClient) and the commands you need, for example CreateActivityCommand:

//JavaScript
const { SFNClient } = require("@aws-sdk/client-sfn-browser/SFNClient");
const {
  CreateActivityCommand
} = require("@aws-sdk/client-sfn-browser/commands/CreateActivityCommand");

//TypeScript
import { SFNClient } from "@aws-sdk/client-sfn-browser/SFNClient";
import { CreateActivityCommand } from "@aws-sdk/client-sfn-browser/commands/CreateActivityCommand";

Usage

To send a request, you:

• Initiate client with configuration (e.g. credentials, region). For more information you can refer to the API reference.
• 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.

const sFN = new SFNClient({region: 'region'});
//clients can be shared by different commands
const params = {
  name: /**a string value*/,
};
const createActivityCommand = new CreateActivityCommand(params);
sFN.send(createActivityCommand).then(data => {
    // do something
}).catch(error => {
    // error handling
})

In addition to using promises, there are 2 other ways to send a request:

// async/await
try {
  const data = await sFN.send(createActivityCommand);
  // do something
} catch (error) {
  // error handling
}

// callback
sFN.send(createActivityCommand, (err, data) => {
  //do something
});

The SDK can also send requests using the simplified callback style from version 2 of the SDK.

import * as AWS from "@aws-sdk/@aws-sdk/client-sfn-browser/SFN";
const sFN = new AWS.SFN({ region: "region" });
sFN.createActivity(params, (err, data) => {
  //do something
});

Troubleshooting

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 sFN.send(createActivityCommand);
  // do something
} catch (error) {
  const metadata = error.$metadata;
  console.log(
    `requestId: ${metadata.requestId}
cfId: ${metadata.cfId}
extendedRequestId: ${metadata.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 and have limited bandwidth to address them.

• Ask a question on StackOverflow and tag it with aws-sdk-js
• Come join the AWS JavaScript community on gitter
• If it turns out that you may have found a bug, please open an issue

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-sfn-browser' package is updated. To contribute to SDK you can checkout our code generator package.

License

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