@aws-sdk/client-cloud9

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

@aws-sdk/client-cloud9

Description

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

Cloud9

Cloud9 is a collection of tools that you can use to code, build, run, test, debug, and release software in the cloud.

For more information about Cloud9, see the Cloud9 User Guide.

Cloud9 supports these operations:

CreateEnvironmentEC2: Creates an Cloud9 development environment, launches an Amazon EC2 instance, and then connects from the instance to the environment.
CreateEnvironmentMembership: Adds an environment member to an environment.
DeleteEnvironment: Deletes an environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.
DeleteEnvironmentMembership: Deletes an environment member from an environment.
DescribeEnvironmentMemberships: Gets information about environment members for an environment.
DescribeEnvironments: Gets information about environments.
DescribeEnvironmentStatus: Gets status information for an environment.
ListEnvironments: Gets a list of environment identifiers.
ListTagsForResource: Gets the tags for an environment.
TagResource: Adds tags to an environment.
UntagResource: Removes tags from an environment.
UpdateEnvironment: Changes the settings of an existing environment.
UpdateEnvironmentMembership: Changes the settings of an existing environment member for an environment.

Installing

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

npm install @aws-sdk/client-cloud9
yarn add @aws-sdk/client-cloud9
pnpm add @aws-sdk/client-cloud9

Getting Started

Import

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

// ES5 example
const { Cloud9Client, ListEnvironmentsCommand } = require("@aws-sdk/client-cloud9");

// ES6+ example
import { Cloud9Client, ListEnvironmentsCommand } from "@aws-sdk/client-cloud9";

Usage

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 Cloud9Client({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new ListEnvironmentsCommand(params);

Async/await

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.

Promises

You can also use Promise chaining to execute send operation.

client.send(command).then(
  (data) => {
    // process data.
  },
  (error) => {
    // error handling.
  }
);

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

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

Callbacks

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.
});

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-cloud9";
const client = new AWS.Cloud9({ region: "REGION" });

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

// Promises.
client
  .listEnvironments(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks.
client.listEnvironments(params, (err, data) => {
  // process err and data.
});

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