• Public
  • Public/Protected
  • All

OpsWorks Client - AWS SDK for JavaScript v3


NPM version NPM downloads


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

AWS OpsWorks

Welcome to the AWS OpsWorks Stacks API Reference. This guide provides descriptions, syntax, and usage examples for AWS OpsWorks Stacks actions and data types, including common parameters and error codes.

AWS OpsWorks Stacks is an application management service that provides an integrated experience for overseeing the complete application lifecycle. For information about this product, go to the AWS OpsWorks details page.

SDKs and CLI

The most common way to use the AWS OpsWorks Stacks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:


AWS OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks can only be accessed or managed within the endpoint in which they are created.

  • opsworks.us-east-1.amazonaws.com

  • opsworks.us-east-2.amazonaws.com

  • opsworks.us-west-1.amazonaws.com

  • opsworks.us-west-2.amazonaws.com

  • opsworks.ca-central-1.amazonaws.com (API only; not available in the AWS console)

  • opsworks.eu-west-1.amazonaws.com

  • opsworks.eu-west-2.amazonaws.com

  • opsworks.eu-west-3.amazonaws.com

  • opsworks.eu-central-1.amazonaws.com

  • opsworks.ap-northeast-1.amazonaws.com

  • opsworks.ap-northeast-2.amazonaws.com

  • opsworks.ap-south-1.amazonaws.com

  • opsworks.ap-southeast-1.amazonaws.com

  • opsworks.ap-southeast-2.amazonaws.com

  • opsworks.sa-east-1.amazonaws.com

Chef Versions

When you call CreateStack, CloneStack, or UpdateStack we recommend you use the ConfigurationManager parameter to specify the Chef version. The recommended and default value for Linux stacks is currently 12. Windows stacks use Chef 12.2. For more information, see Chef Versions.

You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks to Chef 12 as soon as possible.


To install the this package, simply type add or install @aws-sdk/client-opsworks using your favorite package manager:

  • npm install @aws-sdk/client-opsworks
  • yarn add @aws-sdk/client-opsworks
  • pnpm add @aws-sdk/client-opsworks

Getting Started


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

// ES5 example
const { OpsWorksClient, AssignInstanceCommand } = require("@aws-sdk/client-opsworks");
// ES6+ example
import { OpsWorksClient, AssignInstanceCommand } from "@aws-sdk/client-opsworks";


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.
// a client can be shared by different commands.
const client = new OpsWorksClient({ region: "REGION" });

const params = {
  /** input parameters */
const command = new AssignInstanceCommand(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.

  (data) => {
    // process data.
  (error) => {
    // error handling.

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

  .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.

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

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

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

// Promises.
  .then((data) => {
    // process data.
  .catch((error) => {
    // error handling.

// callbacks.
client.assignInstance(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;
   * }

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.

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-opsworks 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.