- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
WorkSpacesWebClient
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.
Installation
npm install @aws-sdk/client-workspaces-webyarn add @aws-sdk/client-workspaces-webpnpm add @aws-sdk/client-workspaces-webWorkSpacesWebClient Operations
Command | Summary |
|---|
Command | Summary |
|---|---|
| AssociateBrowserSettingsCommand | Associates a browser settings resource with a web portal. |
| AssociateDataProtectionSettingsCommand | Associates a data protection settings resource with a web portal. |
| AssociateIpAccessSettingsCommand | Associates an IP access settings resource with a web portal. |
| AssociateNetworkSettingsCommand | Associates a network settings resource with a web portal. |
| AssociateTrustStoreCommand | Associates a trust store with a web portal. |
| AssociateUserAccessLoggingSettingsCommand | Associates a user access logging settings resource with a web portal. |
| AssociateUserSettingsCommand | Associates a user settings resource with a web portal. |
| CreateBrowserSettingsCommand | Creates a browser settings resource that can be associated with a web portal. Once associated with a web portal, browser settings control how the browser will behave once a user starts a streaming session for the web portal. |
| CreateDataProtectionSettingsCommand | Creates a data protection settings resource that can be associated with a web portal. |
| CreateIdentityProviderCommand | Creates an identity provider resource that is then associated with a web portal. |
| CreateIpAccessSettingsCommand | Creates an IP access settings resource that can be associated with a web portal. |
| CreateNetworkSettingsCommand | Creates a network settings resource that can be associated with a web portal. Once associated with a web portal, network settings define how streaming instances will connect with your specified VPC. |
| CreatePortalCommand | Creates a web portal. |
| CreateTrustStoreCommand | Creates a trust store that can be associated with a web portal. A trust store contains certificate authority (CA) certificates. Once associated with a web portal, the browser in a streaming session will recognize certificates that have been issued using any of the CAs in the trust store. If your organization has internal websites that use certificates issued by private CAs, you should add the private CA certificate to the trust store. |
| CreateUserAccessLoggingSettingsCommand | Creates a user access logging settings resource that can be associated with a web portal. |
| CreateUserSettingsCommand | Creates a user settings resource that can be associated with a web portal. Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices. |
| DeleteBrowserSettingsCommand | Deletes browser settings. |
| DeleteDataProtectionSettingsCommand | Deletes data protection settings. |
| DeleteIdentityProviderCommand | Deletes the identity provider. |
| DeleteIpAccessSettingsCommand | Deletes IP access settings. |
| DeleteNetworkSettingsCommand | Deletes network settings. |
| DeletePortalCommand | Deletes a web portal. |
| DeleteTrustStoreCommand | Deletes the trust store. |
| DeleteUserAccessLoggingSettingsCommand | Deletes user access logging settings. |
| DeleteUserSettingsCommand | Deletes user settings. |
| DisassociateBrowserSettingsCommand | Disassociates browser settings from a web portal. |
| DisassociateDataProtectionSettingsCommand | Disassociates data protection settings from a web portal. |
| DisassociateIpAccessSettingsCommand | Disassociates IP access settings from a web portal. |
| DisassociateNetworkSettingsCommand | Disassociates network settings from a web portal. |
| DisassociateTrustStoreCommand | Disassociates a trust store from a web portal. |
| DisassociateUserAccessLoggingSettingsCommand | Disassociates user access logging settings from a web portal. |
| DisassociateUserSettingsCommand | Disassociates user settings from a web portal. |
| ExpireSessionCommand | Expires an active secure browser session. |
| GetBrowserSettingsCommand | Gets browser settings. |
| GetDataProtectionSettingsCommand | Gets the data protection settings. |
| GetIdentityProviderCommand | Gets the identity provider. |
| GetIpAccessSettingsCommand | Gets the IP access settings. |
| GetNetworkSettingsCommand | Gets the network settings. |
| GetPortalCommand | Gets the web portal. |
| GetPortalServiceProviderMetadataCommand | Gets the service provider metadata. |
| GetSessionCommand | Gets information for a secure browser session. |
| GetTrustStoreCertificateCommand | Gets the trust store certificate. |
| GetTrustStoreCommand | Gets the trust store. |
| GetUserAccessLoggingSettingsCommand | Gets user access logging settings. |
| GetUserSettingsCommand | Gets user settings. |
| ListBrowserSettingsCommand | Retrieves a list of browser settings. |
| ListDataProtectionSettingsCommand | Retrieves a list of data protection settings. |
| ListIdentityProvidersCommand | Retrieves a list of identity providers for a specific web portal. |
| ListIpAccessSettingsCommand | Retrieves a list of IP access settings. |
| ListNetworkSettingsCommand | Retrieves a list of network settings. |
| ListPortalsCommand | Retrieves a list or web portals. |
| ListSessionsCommand | Lists information for multiple secure browser sessions from a specific portal. |
| ListTagsForResourceCommand | Retrieves a list of tags for a resource. |
| ListTrustStoreCertificatesCommand | Retrieves a list of trust store certificates. |
| ListTrustStoresCommand | Retrieves a list of trust stores. |
| ListUserAccessLoggingSettingsCommand | Retrieves a list of user access logging settings. |
| ListUserSettingsCommand | Retrieves a list of user settings. |
| TagResourceCommand | Adds or overwrites one or more tags for the specified resource. |
| UntagResourceCommand | Removes one or more tags from the specified resource. |
| UpdateBrowserSettingsCommand | Updates browser settings. |
| UpdateDataProtectionSettingsCommand | Updates data protection settings. |
| UpdateIdentityProviderCommand | Updates the identity provider. |
| UpdateIpAccessSettingsCommand | Updates IP access settings. |
| UpdateNetworkSettingsCommand | Updates network settings. |
| UpdatePortalCommand | Updates a web portal. |
| UpdateTrustStoreCommand | Updates the trust store. |
| UpdateUserAccessLoggingSettingsCommand | Updates the user access logging settings. |
| UpdateUserSettingsCommand | Updates the user settings. |
WorkSpacesWebClient Configuration
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
defaultsModeOptional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefixOptional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensionsOptional | RuntimeExtension[] | Optional extensions |
loggerOptional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttemptsOptional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profileOptional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
regionOptional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandlerOptional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryModeOptional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpointOptional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpointOptional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: WorkSpacesWebClientConfig