This package has been deprecated

Author message:

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

@aws-sdk/client-opsworks-browser

Description

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 CLI

• AWS SDK for Java

• AWS SDK for .NET

• AWS SDK for PHP 2

• AWS SDK for Ruby

• AWS SDK for Node.js

• AWS SDK for Python(Boto)

Endpoints

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.

Installing

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

npm install @aws-sdk/client-opsworks-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(OpsWorksClient) and the commands you need, for example AssignInstanceCommand:

//JavaScript
const {
  OpsWorksClient
} = require("@aws-sdk/client-opsworks-browser/OpsWorksClient");
const {
  AssignInstanceCommand
} = require("@aws-sdk/client-opsworks-browser/commands/AssignInstanceCommand");

//TypeScript
import { OpsWorksClient } from "@aws-sdk/client-opsworks-browser/OpsWorksClient";
import { AssignInstanceCommand } from "@aws-sdk/client-opsworks-browser/commands/AssignInstanceCommand";

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 opsWorks = new OpsWorksClient({region: 'region'});
//clients can be shared by different commands
const params = {
  InstanceId: /**a string value*/,
  LayerIds: [ /**a list of string*/ ],
};
const assignInstanceCommand = new AssignInstanceCommand(params);
opsWorks.send(assignInstanceCommand).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 opsWorks.send(assignInstanceCommand);
  // do something
} catch (error) {
  // error handling
}

// callback
opsWorks.send(assignInstanceCommand, (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-opsworks-browser/OpsWorks";
const opsWorks = new AWS.OpsWorks({ region: "region" });
opsWorks.assignInstance(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 opsWorks.send(assignInstanceCommand);
  // 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-opsworks-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.