workspacesweb/aws.sdk.kotlin.services.workspacesweb

Package-level declarations

Types

interface WorkSpacesWebClient : SdkClient

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

associateBrowserSettings

inline suspend fun WorkSpacesWebClient.associateBrowserSettings(crossinline block: AssociateBrowserSettingsRequest.Builder.() -> Unit): AssociateBrowserSettingsResponse

Associates a browser settings resource with a web portal.

associateDataProtectionSettings

inline suspend fun WorkSpacesWebClient.associateDataProtectionSettings(crossinline block: AssociateDataProtectionSettingsRequest.Builder.() -> Unit): AssociateDataProtectionSettingsResponse

Associates a data protection settings resource with a web portal.

associateIpAccessSettings

inline suspend fun WorkSpacesWebClient.associateIpAccessSettings(crossinline block: AssociateIpAccessSettingsRequest.Builder.() -> Unit): AssociateIpAccessSettingsResponse

Associates an IP access settings resource with a web portal.

associateNetworkSettings

inline suspend fun WorkSpacesWebClient.associateNetworkSettings(crossinline block: AssociateNetworkSettingsRequest.Builder.() -> Unit): AssociateNetworkSettingsResponse

Associates a network settings resource with a web portal.

associateTrustStore

inline suspend fun WorkSpacesWebClient.associateTrustStore(crossinline block: AssociateTrustStoreRequest.Builder.() -> Unit): AssociateTrustStoreResponse

Associates a trust store with a web portal.

associateUserAccessLoggingSettings

inline suspend fun WorkSpacesWebClient.associateUserAccessLoggingSettings(crossinline block: AssociateUserAccessLoggingSettingsRequest.Builder.() -> Unit): AssociateUserAccessLoggingSettingsResponse

Associates a user access logging settings resource with a web portal.

associateUserSettings

inline suspend fun WorkSpacesWebClient.associateUserSettings(crossinline block: AssociateUserSettingsRequest.Builder.() -> Unit): AssociateUserSettingsResponse

Associates a user settings resource with a web portal.

createBrowserSettings

inline suspend fun WorkSpacesWebClient.createBrowserSettings(crossinline block: CreateBrowserSettingsRequest.Builder.() -> Unit): CreateBrowserSettingsResponse

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.

createDataProtectionSettings

inline suspend fun WorkSpacesWebClient.createDataProtectionSettings(crossinline block: CreateDataProtectionSettingsRequest.Builder.() -> Unit): CreateDataProtectionSettingsResponse

Creates a data protection settings resource that can be associated with a web portal.

createIdentityProvider

inline suspend fun WorkSpacesWebClient.createIdentityProvider(crossinline block: CreateIdentityProviderRequest.Builder.() -> Unit): CreateIdentityProviderResponse

Creates an identity provider resource that is then associated with a web portal.

createIpAccessSettings

inline suspend fun WorkSpacesWebClient.createIpAccessSettings(crossinline block: CreateIpAccessSettingsRequest.Builder.() -> Unit): CreateIpAccessSettingsResponse

Creates an IP access settings resource that can be associated with a web portal.

createNetworkSettings

inline suspend fun WorkSpacesWebClient.createNetworkSettings(crossinline block: CreateNetworkSettingsRequest.Builder.() -> Unit): CreateNetworkSettingsResponse

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.

createPortal

inline suspend fun WorkSpacesWebClient.createPortal(crossinline block: CreatePortalRequest.Builder.() -> Unit): CreatePortalResponse

Creates a web portal.

createTrustStore

inline suspend fun WorkSpacesWebClient.createTrustStore(crossinline block: CreateTrustStoreRequest.Builder.() -> Unit): CreateTrustStoreResponse

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.

createUserAccessLoggingSettings

inline suspend fun WorkSpacesWebClient.createUserAccessLoggingSettings(crossinline block: CreateUserAccessLoggingSettingsRequest.Builder.() -> Unit): CreateUserAccessLoggingSettingsResponse

Creates a user access logging settings resource that can be associated with a web portal.

createUserSettings

inline suspend fun WorkSpacesWebClient.createUserSettings(crossinline block: CreateUserSettingsRequest.Builder.() -> Unit): CreateUserSettingsResponse

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.

deleteBrowserSettings

inline suspend fun WorkSpacesWebClient.deleteBrowserSettings(crossinline block: DeleteBrowserSettingsRequest.Builder.() -> Unit): DeleteBrowserSettingsResponse

Deletes browser settings.

deleteDataProtectionSettings

inline suspend fun WorkSpacesWebClient.deleteDataProtectionSettings(crossinline block: DeleteDataProtectionSettingsRequest.Builder.() -> Unit): DeleteDataProtectionSettingsResponse

Deletes data protection settings.

deleteIdentityProvider

inline suspend fun WorkSpacesWebClient.deleteIdentityProvider(crossinline block: DeleteIdentityProviderRequest.Builder.() -> Unit): DeleteIdentityProviderResponse

Deletes the identity provider.

deleteIpAccessSettings

inline suspend fun WorkSpacesWebClient.deleteIpAccessSettings(crossinline block: DeleteIpAccessSettingsRequest.Builder.() -> Unit): DeleteIpAccessSettingsResponse

Deletes IP access settings.

deleteNetworkSettings

inline suspend fun WorkSpacesWebClient.deleteNetworkSettings(crossinline block: DeleteNetworkSettingsRequest.Builder.() -> Unit): DeleteNetworkSettingsResponse

Deletes network settings.

deletePortal

inline suspend fun WorkSpacesWebClient.deletePortal(crossinline block: DeletePortalRequest.Builder.() -> Unit): DeletePortalResponse

Deletes a web portal.

deleteTrustStore

inline suspend fun WorkSpacesWebClient.deleteTrustStore(crossinline block: DeleteTrustStoreRequest.Builder.() -> Unit): DeleteTrustStoreResponse

Deletes the trust store.

deleteUserAccessLoggingSettings

inline suspend fun WorkSpacesWebClient.deleteUserAccessLoggingSettings(crossinline block: DeleteUserAccessLoggingSettingsRequest.Builder.() -> Unit): DeleteUserAccessLoggingSettingsResponse

Deletes user access logging settings.

deleteUserSettings

inline suspend fun WorkSpacesWebClient.deleteUserSettings(crossinline block: DeleteUserSettingsRequest.Builder.() -> Unit): DeleteUserSettingsResponse

Deletes user settings.

disassociateBrowserSettings

inline suspend fun WorkSpacesWebClient.disassociateBrowserSettings(crossinline block: DisassociateBrowserSettingsRequest.Builder.() -> Unit): DisassociateBrowserSettingsResponse

Disassociates browser settings from a web portal.

disassociateDataProtectionSettings

inline suspend fun WorkSpacesWebClient.disassociateDataProtectionSettings(crossinline block: DisassociateDataProtectionSettingsRequest.Builder.() -> Unit): DisassociateDataProtectionSettingsResponse

Disassociates data protection settings from a web portal.

disassociateIpAccessSettings

inline suspend fun WorkSpacesWebClient.disassociateIpAccessSettings(crossinline block: DisassociateIpAccessSettingsRequest.Builder.() -> Unit): DisassociateIpAccessSettingsResponse

Disassociates IP access settings from a web portal.

disassociateNetworkSettings

inline suspend fun WorkSpacesWebClient.disassociateNetworkSettings(crossinline block: DisassociateNetworkSettingsRequest.Builder.() -> Unit): DisassociateNetworkSettingsResponse

Disassociates network settings from a web portal.

disassociateTrustStore

inline suspend fun WorkSpacesWebClient.disassociateTrustStore(crossinline block: DisassociateTrustStoreRequest.Builder.() -> Unit): DisassociateTrustStoreResponse

Disassociates a trust store from a web portal.

disassociateUserAccessLoggingSettings

inline suspend fun WorkSpacesWebClient.disassociateUserAccessLoggingSettings(crossinline block: DisassociateUserAccessLoggingSettingsRequest.Builder.() -> Unit): DisassociateUserAccessLoggingSettingsResponse

Disassociates user access logging settings from a web portal.

disassociateUserSettings

inline suspend fun WorkSpacesWebClient.disassociateUserSettings(crossinline block: DisassociateUserSettingsRequest.Builder.() -> Unit): DisassociateUserSettingsResponse

Disassociates user settings from a web portal.

expireSession

inline suspend fun WorkSpacesWebClient.expireSession(crossinline block: ExpireSessionRequest.Builder.() -> Unit): ExpireSessionResponse

Expires an active secure browser session.

getBrowserSettings

inline suspend fun WorkSpacesWebClient.getBrowserSettings(crossinline block: GetBrowserSettingsRequest.Builder.() -> Unit): GetBrowserSettingsResponse

Gets browser settings.

getDataProtectionSettings

inline suspend fun WorkSpacesWebClient.getDataProtectionSettings(crossinline block: GetDataProtectionSettingsRequest.Builder.() -> Unit): GetDataProtectionSettingsResponse

Gets the data protection settings.

getIdentityProvider

inline suspend fun WorkSpacesWebClient.getIdentityProvider(crossinline block: GetIdentityProviderRequest.Builder.() -> Unit): GetIdentityProviderResponse

Gets the identity provider.

getIpAccessSettings

inline suspend fun WorkSpacesWebClient.getIpAccessSettings(crossinline block: GetIpAccessSettingsRequest.Builder.() -> Unit): GetIpAccessSettingsResponse

Gets the IP access settings.

getNetworkSettings

inline suspend fun WorkSpacesWebClient.getNetworkSettings(crossinline block: GetNetworkSettingsRequest.Builder.() -> Unit): GetNetworkSettingsResponse

Gets the network settings.

getPortal

inline suspend fun WorkSpacesWebClient.getPortal(crossinline block: GetPortalRequest.Builder.() -> Unit): GetPortalResponse

Gets the web portal.

getPortalServiceProviderMetadata

inline suspend fun WorkSpacesWebClient.getPortalServiceProviderMetadata(crossinline block: GetPortalServiceProviderMetadataRequest.Builder.() -> Unit): GetPortalServiceProviderMetadataResponse

Gets the service provider metadata.

getSession

inline suspend fun WorkSpacesWebClient.getSession(crossinline block: GetSessionRequest.Builder.() -> Unit): GetSessionResponse

Gets information for a secure browser session.

getTrustStore

inline suspend fun WorkSpacesWebClient.getTrustStore(crossinline block: GetTrustStoreRequest.Builder.() -> Unit): GetTrustStoreResponse

Gets the trust store.

getTrustStoreCertificate

inline suspend fun WorkSpacesWebClient.getTrustStoreCertificate(crossinline block: GetTrustStoreCertificateRequest.Builder.() -> Unit): GetTrustStoreCertificateResponse

Gets the trust store certificate.

getUserAccessLoggingSettings

inline suspend fun WorkSpacesWebClient.getUserAccessLoggingSettings(crossinline block: GetUserAccessLoggingSettingsRequest.Builder.() -> Unit): GetUserAccessLoggingSettingsResponse

Gets user access logging settings.

getUserSettings

inline suspend fun WorkSpacesWebClient.getUserSettings(crossinline block: GetUserSettingsRequest.Builder.() -> Unit): GetUserSettingsResponse

Gets user settings.

listBrowserSettings

inline suspend fun WorkSpacesWebClient.listBrowserSettings(crossinline block: ListBrowserSettingsRequest.Builder.() -> Unit): ListBrowserSettingsResponse

Retrieves a list of browser settings.

listDataProtectionSettings

inline suspend fun WorkSpacesWebClient.listDataProtectionSettings(crossinline block: ListDataProtectionSettingsRequest.Builder.() -> Unit): ListDataProtectionSettingsResponse

Retrieves a list of data protection settings.

listIdentityProviders

inline suspend fun WorkSpacesWebClient.listIdentityProviders(crossinline block: ListIdentityProvidersRequest.Builder.() -> Unit): ListIdentityProvidersResponse

Retrieves a list of identity providers for a specific web portal.

listIpAccessSettings

inline suspend fun WorkSpacesWebClient.listIpAccessSettings(crossinline block: ListIpAccessSettingsRequest.Builder.() -> Unit): ListIpAccessSettingsResponse

Retrieves a list of IP access settings.

listNetworkSettings

inline suspend fun WorkSpacesWebClient.listNetworkSettings(crossinline block: ListNetworkSettingsRequest.Builder.() -> Unit): ListNetworkSettingsResponse

Retrieves a list of network settings.

listPortals

inline suspend fun WorkSpacesWebClient.listPortals(crossinline block: ListPortalsRequest.Builder.() -> Unit): ListPortalsResponse

Retrieves a list or web portals.

listSessions

inline suspend fun WorkSpacesWebClient.listSessions(crossinline block: ListSessionsRequest.Builder.() -> Unit): ListSessionsResponse

Lists information for multiple secure browser sessions from a specific portal.

listTagsForResource

inline suspend fun WorkSpacesWebClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Retrieves a list of tags for a resource.

listTrustStoreCertificates

inline suspend fun WorkSpacesWebClient.listTrustStoreCertificates(crossinline block: ListTrustStoreCertificatesRequest.Builder.() -> Unit): ListTrustStoreCertificatesResponse

Retrieves a list of trust store certificates.

listTrustStores

inline suspend fun WorkSpacesWebClient.listTrustStores(crossinline block: ListTrustStoresRequest.Builder.() -> Unit): ListTrustStoresResponse

Retrieves a list of trust stores.

listUserAccessLoggingSettings

inline suspend fun WorkSpacesWebClient.listUserAccessLoggingSettings(crossinline block: ListUserAccessLoggingSettingsRequest.Builder.() -> Unit): ListUserAccessLoggingSettingsResponse

Retrieves a list of user access logging settings.

listUserSettings

inline suspend fun WorkSpacesWebClient.listUserSettings(crossinline block: ListUserSettingsRequest.Builder.() -> Unit): ListUserSettingsResponse

Retrieves a list of user settings.

tagResource

inline suspend fun WorkSpacesWebClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds or overwrites one or more tags for the specified resource.

untagResource

inline suspend fun WorkSpacesWebClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes one or more tags from the specified resource.

updateBrowserSettings

inline suspend fun WorkSpacesWebClient.updateBrowserSettings(crossinline block: UpdateBrowserSettingsRequest.Builder.() -> Unit): UpdateBrowserSettingsResponse

Updates browser settings.

updateDataProtectionSettings

inline suspend fun WorkSpacesWebClient.updateDataProtectionSettings(crossinline block: UpdateDataProtectionSettingsRequest.Builder.() -> Unit): UpdateDataProtectionSettingsResponse

Updates data protection settings.

updateIdentityProvider

inline suspend fun WorkSpacesWebClient.updateIdentityProvider(crossinline block: UpdateIdentityProviderRequest.Builder.() -> Unit): UpdateIdentityProviderResponse

Updates the identity provider.

updateIpAccessSettings

inline suspend fun WorkSpacesWebClient.updateIpAccessSettings(crossinline block: UpdateIpAccessSettingsRequest.Builder.() -> Unit): UpdateIpAccessSettingsResponse

Updates IP access settings.

updateNetworkSettings

inline suspend fun WorkSpacesWebClient.updateNetworkSettings(crossinline block: UpdateNetworkSettingsRequest.Builder.() -> Unit): UpdateNetworkSettingsResponse

Updates network settings.

updatePortal

inline suspend fun WorkSpacesWebClient.updatePortal(crossinline block: UpdatePortalRequest.Builder.() -> Unit): UpdatePortalResponse

Updates a web portal.

updateTrustStore

inline suspend fun WorkSpacesWebClient.updateTrustStore(crossinline block: UpdateTrustStoreRequest.Builder.() -> Unit): UpdateTrustStoreResponse

Updates the trust store.

updateUserAccessLoggingSettings

inline suspend fun WorkSpacesWebClient.updateUserAccessLoggingSettings(crossinline block: UpdateUserAccessLoggingSettingsRequest.Builder.() -> Unit): UpdateUserAccessLoggingSettingsResponse

Updates the user access logging settings.

updateUserSettings

inline suspend fun WorkSpacesWebClient.updateUserSettings(crossinline block: UpdateUserSettingsRequest.Builder.() -> Unit): UpdateUserSettingsResponse

Updates the user settings.

withConfig

fun WorkSpacesWebClient.withConfig(block: WorkSpacesWebClient.Config.Builder.() -> Unit): WorkSpacesWebClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.