@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

$3

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:

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

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

$3

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.

`js
// 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:

`js
// 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.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

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

`js
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.

`js
// 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

`ts
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) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listAccountLinks(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
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

Command API Reference / Input / Output

AssociateConnectionAlias

Command API Reference / Input / Output

AssociateIpGroups

Command API Reference / Input / Output

AssociateWorkspaceApplication

Command API Reference / Input / Output

AuthorizeIpRules

Command API Reference / Input / Output

CopyWorkspaceImage

Command API Reference / Input / Output

CreateAccountLinkInvitation

Command API Reference / Input / Output

CreateConnectClientAddIn

Command API Reference / Input / Output

CreateConnectionAlias

Command API Reference / Input / Output

CreateIpGroup

Command API Reference / Input / Output

CreateStandbyWorkspaces

Command API Reference / Input / Output

CreateTags

Command API Reference / Input / Output

CreateUpdatedWorkspaceImage

Command API Reference / Input / Output

CreateWorkspaceBundle

Command API Reference / Input / Output

CreateWorkspaceImage

Command API Reference / Input / Output

CreateWorkspaces

Command API Reference / Input / Output

CreateWorkspacesPool

Command API Reference / Input / Output

DeleteAccountLinkInvitation

Command API Reference / Input / Output

DeleteClientBranding

Command API Reference / Input / Output

DeleteConnectClientAddIn

Command API Reference / Input / Output

DeleteConnectionAlias

Command API Reference / Input / Output

DeleteIpGroup

Command API Reference / Input / Output

DeleteTags

Command API Reference / Input / Output

DeleteWorkspaceBundle

Command API Reference / Input / Output

DeleteWorkspaceImage

Command API Reference / Input / Output

DeployWorkspaceApplications

Command API Reference / Input / Output

DeregisterWorkspaceDirectory

Command API Reference / Input / Output

DescribeAccount

Command API Reference / Input / Output

DescribeAccountModifications

Command API Reference / Input / Output

DescribeApplicationAssociations

Command API Reference / Input / Output

DescribeApplications

Command API Reference / Input / Output

DescribeBundleAssociations

Command API Reference / Input / Output

DescribeClientBranding

Command API Reference / Input / Output

DescribeClientProperties

Command API Reference / Input / Output

DescribeConnectClientAddIns

Command API Reference / Input / Output

DescribeConnectionAliases

Command API Reference / Input / Output

DescribeConnectionAliasPermissions

Command API Reference / Input / Output

DescribeCustomWorkspaceImageImport

Command API Reference / Input / Output

DescribeImageAssociations

Command API Reference / Input / Output

DescribeIpGroups

Command API Reference / Input / Output

DescribeTags

Command API Reference / Input / Output

DescribeWorkspaceAssociations

Command API Reference / Input / Output

DescribeWorkspaceBundles

Command API Reference / Input / Output

DescribeWorkspaceDirectories

Command API Reference / Input / Output

DescribeWorkspaceImagePermissions

Command API Reference / Input / Output

DescribeWorkspaceImages

Command API Reference / Input / Output

DescribeWorkspaces

Command API Reference / Input / Output

DescribeWorkspacesConnectionStatus

Command API Reference / Input / Output

DescribeWorkspaceSnapshots

Command API Reference / Input / Output

DescribeWorkspacesPools

Command API Reference / Input / Output

DescribeWorkspacesPoolSessions

Command API Reference / Input / Output

DisassociateConnectionAlias

Command API Reference / Input / Output

DisassociateIpGroups

Command API Reference / Input / Output

DisassociateWorkspaceApplication

Command API Reference / Input / Output

GetAccountLink

Command API Reference / Input / Output

ImportClientBranding

Command API Reference / Input / Output

ImportCustomWorkspaceImage

Command API Reference / Input / Output

ImportWorkspaceImage

Command API Reference / Input / Output

ListAccountLinks

Command API Reference / Input / Output

ListAvailableManagementCidrRanges

Command API Reference / Input / Output

MigrateWorkspace

Command API Reference / Input / Output

ModifyAccount

Command API Reference / Input / Output

ModifyCertificateBasedAuthProperties

Command API Reference / Input / Output

ModifyClientProperties

Command API Reference / Input / Output

ModifyEndpointEncryptionMode

Command API Reference / Input / Output

ModifySamlProperties

Command API Reference / Input / Output

ModifySelfservicePermissions

Command API Reference / Input / Output

ModifyStreamingProperties

Command API Reference / Input / Output

ModifyWorkspaceAccessProperties

Command API Reference / Input / Output

ModifyWorkspaceCreationProperties

Command API Reference / Input / Output

ModifyWorkspaceProperties

Command API Reference / Input / Output

ModifyWorkspaceState

Command API Reference / Input / Output

RebootWorkspaces

Command API Reference / Input / Output

RebuildWorkspaces

Command API Reference / Input / Output

RegisterWorkspaceDirectory

Command API Reference / Input / Output

RejectAccountLinkInvitation

Command API Reference / Input / Output

RestoreWorkspace

Command API Reference / Input / Output

RevokeIpRules

Command API Reference / Input / Output

StartWorkspaces

Command API Reference / Input / Output

StartWorkspacesPool

Command API Reference / Input / Output

StopWorkspaces

Command API Reference / Input / Output

StopWorkspacesPool

Command API Reference / Input / Output

TerminateWorkspaces

Command API Reference / Input / Output

TerminateWorkspacesPool

Command API Reference / Input / Output

TerminateWorkspacesPoolSession

Command API Reference / Input / Output

UpdateConnectClientAddIn

Command API Reference / Input / Output

UpdateConnectionAliasPermission

Command API Reference / Input / Output

UpdateRulesOfIpGroup

Command API Reference / Input / Output

UpdateWorkspaceBundle

Command API Reference / Input / Output

UpdateWorkspaceImagePermission

Command API Reference / Input / Output

UpdateWorkspacesPool

Command API Reference / Input / Output