@aws-sdk/client-cloud9

Description

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

<fullname>Cloud9</fullname>

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 <a href="https://docs.aws.amazon.com/cloud9/latest/user-guide">Cloud9 User Guide</a>. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. <a href="http://aws.amazon.com/blogs/devops/how-to-migrate-from-aws-cloud9-to-aws-ide-toolkits-or-aws-cloudshell/">Learn more"</a> Cloud9 supports these operations: <ul> <li> <code>CreateEnvironmentEC2</code>: Creates an Cloud9 development environment, launches an Amazon EC2 instance, and then connects from the instance to the environment. </li> <li> <code>CreateEnvironmentMembership</code>: Adds an environment member to an environment. </li> <li> <code>DeleteEnvironment</code>: Deletes an environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance. </li> <li> <code>DeleteEnvironmentMembership</code>: Deletes an environment member from an environment. </li> <li> <code>DescribeEnvironmentMemberships</code>: Gets information about environment members for an environment. </li> <li> <code>DescribeEnvironments</code>: Gets information about environments. </li> <li> <code>DescribeEnvironmentStatus</code>: Gets status information for an environment. </li> <li> <code>ListEnvironments</code>: Gets a list of environment identifiers. </li> <li> <code>ListTagsForResource</code>: Gets the tags for an environment. </li> <li> <code>TagResource</code>: Adds tags to an environment. </li> <li> <code>UntagResource</code>: Removes tags from an environment. </li> <li> <code>UpdateEnvironment</code>: Changes the settings of an existing environment. </li> <li> <code>UpdateEnvironmentMembership</code>: Changes the settings of an existing environment member for an environment. </li> </ul>

Installing

To install this package, use the CLI of 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:

Instantiate a client with configuration (e.g. credentials, region).
- See docs/CLIENTS for configuration details.
- See @aws-sdk/config for additional options.
Instantiate a command with input parameters.
Call the send operation on the client, providing the command object as input.

const client = new Cloud9Client({ region: "REGION" });

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

Async/await

We recommend using the 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.
}

Promises

You can also use Promise chaining.

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

Aggregated client

The aggregated client class is exported from the same package, but without the "Client" suffix.

Cloud9 extends Cloud9Client and additionally supports all operations, waiters, and paginators as methods. This style may be familiar to you from the AWS SDK for JavaScript v2.

If you are bundling the AWS SDK, we recommend using only the bare-bones client (Cloud9Client). More details are in the blog post on modular packages in AWS SDK for JavaScript.

import { Cloud9 } from "@aws-sdk/client-cloud9";

const client = new 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 (not recommended).
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 GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

Visit the Developer Guide or API Reference.
Check out the blog posts tagged with aws-sdk-js on AWS Developer Blog.
Ask a question on StackOverflow and tag it with aws-sdk-js.
Join the AWS JavaScript community on gitter.
If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-cloud9 package is updated. To contribute to client you can check our generate clients scripts.