@aws-sdk/client-workspaces

v3.692.0

AWS SDK for JavaScript Workspaces Client for Node.js, Browser and React Native For more information about how to use this package see README

Latest version published 1 month ago

License: Apache-2.0

NPM

GitHub

Package Health Score

92 / 100

security
No known security issues
popularity
Popular
maintenance
Healthy
community
Active

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
3.691.0	\|	11/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.692.0	\|	11/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.641.0	\|	08/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.639.0	\|	08/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.405.0	\|	09/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Popular

Weekly Downloads (19,648)

GitHub Stars: 3.09K
Forks: 577
Contributors: 150

Direct Usage Popularity

The npm package @aws-sdk/client-workspaces receives a total of 19,648 downloads a week. As such, we scored @aws-sdk/client-workspaces popularity level to be Popular.

Based on project statistics from the GitHub repository for the npm package @aws-sdk/client-workspaces, we found that it has been starred 3,092 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 150
Funding: No

A good and healthy external contribution signal for @aws-sdk/client-workspaces project, which invites more than one hundred open source maintainers to collaborate on the repository.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 163
Open PR: 15
Last Release: 1 month ago
Last Commit: 2 months ago

Further analysis of the maintenance status of @aws-sdk/client-workspaces based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that @aws-sdk/client-workspaces demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=16.0.0

Age: 5 years
Dependencies: 41 Direct
Versions: 435
Install Size: 1.69 MB
Dist-tags: 5
# of Files: 359
Maintainers: 5
TS Typings: No

@aws-sdk/client-workspaces has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

@aws-sdk/client-workspaces

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 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 ListAccountLinksCommand:

// ES5 example
const { WorkSpacesClient, ListAccountLinksCommand } = require("@aws-sdk/client-workspaces");

// ES6+ example
import { WorkSpacesClient, ListAccountLinksCommand } 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 ListAccountLinksCommand(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) =&gt; {
    // process data.
  },
  (error) =&gt; {
    // error handling.
  }
);

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

client
  .send(command)
  .then((data) =&gt; {
    // process data.
  })
  .catch((error) =&gt; {
    // error handling.
  })
  .finally(() =&gt; {
    // 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) =&gt; {
  // 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.listAccountLinks(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listAccountLinks(params)
  .then((data) =&gt; {
    // process data.
  })
  .catch((error) =&gt; {
    // error handling.
  });

// callbacks.
client.listAccountLinks(params, (err, data) =&gt; {
  // 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.

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

Client Commands (Operations List)

AcceptAccountLinkInvitation

Package Health Score

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (19,648)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

@aws-sdk/client-workspaces

Description

Installing

Getting Started

Import

Usage

Async/await

Promises

Callbacks

v2 compatible style

Troubleshooting

Getting Help

Contributing

License

Client Commands (Operations List)

@aws-sdk/client-workspaces dependencies

@aws-sdk/client-workspaces development dependencies

FAQs

What is @aws-sdk/client-workspaces?

Is @aws-sdk/client-workspaces popular?

Is @aws-sdk/client-workspaces well maintained?

Is @aws-sdk/client-workspaces safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues