@aws-sdk/client-cloud9-node v0.1.0-preview.2

@aws-sdk/client-cloud9-node

Description

AWS Cloud9 AWS 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 AWS Cloud9, see the AWS Cloud9 User Guide. AWS Cloud9 supports these operations: CreateEnvironmentEC2: Creates an AWS 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. 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 using NPM, simply type the following into a terminal window:

npm install @aws-sdk/client-cloud9-node

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(Cloud9Client) and the commands you need, for example CreateEnvironmentEC2Command:

//JavaScript
const { Cloud9Client } = require("@aws-sdk/client-cloud9-node/Cloud9Client");
const {
  CreateEnvironmentEC2Command
} = require("@aws-sdk/client-cloud9-node/commands/CreateEnvironmentEC2Command");

//TypeScript
import { Cloud9Client } from "@aws-sdk/client-cloud9-node/Cloud9Client";
import { CreateEnvironmentEC2Command } from "@aws-sdk/client-cloud9-node/commands/CreateEnvironmentEC2Command";

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 cloud9 = new Cloud9Client({region: 'region'});
//clients can be shared by different commands
const params = {
  name: /**a string value*/,
  instanceType: /**a string value*/,
};
const createEnvironmentEC2Command = new CreateEnvironmentEC2Command(params);
cloud9.send(createEnvironmentEC2Command).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 cloud9.send(createEnvironmentEC2Command);
  // do something
} catch (error) {
  // error handling
}

// callback
cloud9.send(createEnvironmentEC2Command, (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-cloud9-node/Cloud9";
const cloud9 = new AWS.Cloud9({ region: "region" });
cloud9.createEnvironmentEC2(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 cloud9.send(createEnvironmentEC2Command);
  // 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-cloud9-node' 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.