@aws-sdk/client-workspaces

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

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@aws-sdk/client-workspaces
1,8873393.186.021 hours ago3 years agoMinified + gzip package size for @aws-sdk/client-workspaces in KB

Readme

@aws-sdk/client-workspaces
NPM version NPM downloads

Description

AWS SDK for JavaScript WorkSpaces Client for Node.js, Browser and React Native.
Amazon WorkSpaces Service

Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows or Amazon Linux desktops for your users, known as WorkSpaces. WorkSpaces eliminates the need to procure and deploy hardware or install complex software. You can quickly add or remove users as your needs change. Users can access their virtual desktops from multiple devices or web browsers.

This API Reference provides detailed information about the actions, data types, parameters, and errors of the WorkSpaces service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Amazon WorkSpaces service, see WorkSpaces endpoints and quotas in the Amazon Web Services General Reference.

You can also manage your WorkSpaces resources using the WorkSpaces console, Command Line Interface (CLI), and SDKs. For more information about administering WorkSpaces, see the Amazon WorkSpaces Administration Guide. For more information about using the Amazon WorkSpaces client application or web browser to access provisioned WorkSpaces, see the Amazon WorkSpaces User Guide. For more information about using the CLI to manage your WorkSpaces resources, see the WorkSpaces section of the CLI Reference.

Installing

To install the this package, simply type add or install @aws-sdk/client-workspaces using your favorite package manager:
  • npm install @aws-sdk/client-workspaces
  • yarn add @aws-sdk/client-workspaces
  • pnpm add @aws-sdk/client-workspaces

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the WorkSpacesClient and the commands you need, for example AssociateConnectionAliasCommand:
// ES5 example
const { WorkSpacesClient, AssociateConnectionAliasCommand } = require("@aws-sdk/client-workspaces");

// ES6+ example
import { WorkSpacesClient, AssociateConnectionAliasCommand } from "@aws-sdk/client-workspaces";

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

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

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

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

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

// callbacks.
client.associateConnectionAlias(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.
or API Reference. 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-workspaces package is updated. To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.