This package has been deprecated

Author message:

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

@aws-sdk/client-workspaces-node

Description

Amazon WorkSpaces Service

Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows and Amazon Linux desktops for your users.

Installing

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

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

//JavaScript
const {
  WorkSpacesClient
} = require("@aws-sdk/client-workspaces-node/WorkSpacesClient");
const {
  AssociateIpGroupsCommand
} = require("@aws-sdk/client-workspaces-node/commands/AssociateIpGroupsCommand");

//TypeScript
import { WorkSpacesClient } from "@aws-sdk/client-workspaces-node/WorkSpacesClient";
import { AssociateIpGroupsCommand } from "@aws-sdk/client-workspaces-node/commands/AssociateIpGroupsCommand";

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 workSpaces = new WorkSpacesClient({region: 'region'});
//clients can be shared by different commands
const params = {
  DirectoryId: /**a string value*/,
  GroupIds: [ /**a list of string*/ ],
};
const associateIpGroupsCommand = new AssociateIpGroupsCommand(params);
workSpaces.send(associateIpGroupsCommand).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 workSpaces.send(associateIpGroupsCommand);
  // do something
} catch (error) {
  // error handling
}

// callback
workSpaces.send(associateIpGroupsCommand, (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-workspaces-node/WorkSpaces";
const workSpaces = new AWS.WorkSpaces({ region: "region" });
workSpaces.associateIpGroups(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 workSpaces.send(associateIpGroupsCommand);
  // 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-workspaces-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.