AWS SDK for JavaScript Workspaces Web Client for Node.js, Browser and React Native
npm install @aws-sdk/client-workspaces-webAWS SDK for JavaScript WorkSpacesWeb Client for Node.js, Browser and React Native.
Amazon WorkSpaces Secure Browser is a low cost, fully managed WorkSpace built specifically to facilitate secure, web-based workloads. WorkSpaces Secure Browser makes it easy for customers to safely provide their employees with access to internal websites and SaaS web applications without the administrative burden of appliances or specialized client software. WorkSpaces Secure Browser provides simple policy tools tailored for user interactions, while offloading common tasks like capacity management, scaling, and maintaining browser images.
npm install @aws-sdk/client-workspaces-webyarn add @aws-sdk/client-workspaces-webpnpm add @aws-sdk/client-workspaces-webThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the WorkSpacesWebClient and
the commands you need, for example ListPortalsCommand:
``js`
// ES5 example
const { WorkSpacesWebClient, ListPortalsCommand } = require("@aws-sdk/client-workspaces-web");
`ts`
// ES6+ example
import { WorkSpacesWebClient, ListPortalsCommand } from "@aws-sdk/client-workspaces-web";
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.destroy()
- If you are using a custom http handler, you may call to close open connections.
`js
// a client can be shared by different commands.
const client = new WorkSpacesWebClient({ region: "REGION" });
const params = { /* input parameters / };
const command = new ListPortalsCommand(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-web";
const client = new AWS.WorkSpacesWeb({ region: "REGION" });
// async/await.
try {
const data = await client.listPortals(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listPortals(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listPortals(params, (err, data) => {
// process err and data.
});
`
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;
* }
*/
}
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.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-workspaces-web` package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.
AssociateBrowserSettings
Command API Reference / Input / Output
AssociateDataProtectionSettings
Command API Reference / Input / Output
AssociateIpAccessSettings
Command API Reference / Input / Output
AssociateNetworkSettings
Command API Reference / Input / Output
AssociateSessionLogger
Command API Reference / Input / Output
AssociateTrustStore
Command API Reference / Input / Output
AssociateUserAccessLoggingSettings
Command API Reference / Input / Output
AssociateUserSettings
Command API Reference / Input / Output
CreateBrowserSettings
Command API Reference / Input / Output
CreateDataProtectionSettings
Command API Reference / Input / Output
CreateIdentityProvider
Command API Reference / Input / Output
CreateIpAccessSettings
Command API Reference / Input / Output
CreateNetworkSettings
Command API Reference / Input / Output
CreatePortal
Command API Reference / Input / Output
CreateSessionLogger
Command API Reference / Input / Output
CreateTrustStore
Command API Reference / Input / Output
CreateUserAccessLoggingSettings
Command API Reference / Input / Output
CreateUserSettings
Command API Reference / Input / Output
DeleteBrowserSettings
Command API Reference / Input / Output
DeleteDataProtectionSettings
Command API Reference / Input / Output
DeleteIdentityProvider
Command API Reference / Input / Output
DeleteIpAccessSettings
Command API Reference / Input / Output
DeleteNetworkSettings
Command API Reference / Input / Output
DeletePortal
Command API Reference / Input / Output
DeleteSessionLogger
Command API Reference / Input / Output
DeleteTrustStore
Command API Reference / Input / Output
DeleteUserAccessLoggingSettings
Command API Reference / Input / Output
DeleteUserSettings
Command API Reference / Input / Output
DisassociateBrowserSettings
Command API Reference / Input / Output
DisassociateDataProtectionSettings
Command API Reference / Input / Output
DisassociateIpAccessSettings
Command API Reference / Input / Output
DisassociateNetworkSettings
Command API Reference / Input / Output
DisassociateSessionLogger
Command API Reference / Input / Output
DisassociateTrustStore
Command API Reference / Input / Output
DisassociateUserAccessLoggingSettings
Command API Reference / Input / Output
DisassociateUserSettings
Command API Reference / Input / Output
ExpireSession
Command API Reference / Input / Output
GetBrowserSettings
Command API Reference / Input / Output
GetDataProtectionSettings
Command API Reference / Input / Output
GetIdentityProvider
Command API Reference / Input / Output
GetIpAccessSettings
Command API Reference / Input / Output
GetNetworkSettings
Command API Reference / Input / Output
GetPortal
Command API Reference / Input / Output
GetPortalServiceProviderMetadata
Command API Reference / Input / Output
GetSession
Command API Reference / Input / Output
GetSessionLogger
Command API Reference / Input / Output
GetTrustStore
Command API Reference / Input / Output
GetTrustStoreCertificate
Command API Reference / Input / Output
GetUserAccessLoggingSettings
Command API Reference / Input / Output
GetUserSettings
Command API Reference / Input / Output
ListBrowserSettings
Command API Reference / Input / Output
ListDataProtectionSettings
Command API Reference / Input / Output
ListIdentityProviders
Command API Reference / Input / Output
ListIpAccessSettings
Command API Reference / Input / Output
ListNetworkSettings
Command API Reference / Input / Output
ListPortals
Command API Reference / Input / Output
ListSessionLoggers
Command API Reference / Input / Output
ListSessions
Command API Reference / Input / Output
ListTagsForResource
Command API Reference / Input / Output
ListTrustStoreCertificates
Command API Reference / Input / Output
ListTrustStores
Command API Reference / Input / Output
ListUserAccessLoggingSettings
Command API Reference / Input / Output
ListUserSettings
Command API Reference / Input / Output
TagResource
Command API Reference / Input / Output
UntagResource
Command API Reference / Input / Output
UpdateBrowserSettings
Command API Reference / Input / Output
UpdateDataProtectionSettings
Command API Reference / Input / Output
UpdateIdentityProvider
Command API Reference / Input / Output
UpdateIpAccessSettings
Command API Reference / Input / Output
UpdateNetworkSettings
Command API Reference / Input / Output
UpdatePortal
Command API Reference / Input / Output
UpdateSessionLogger
Command API Reference / Input / Output
UpdateTrustStore
Command API Reference / Input / Output
UpdateUserAccessLoggingSettings
Command API Reference / Input / Output
UpdateUserSettings