AmazonWorkSpacesWebClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.workspacesweb.AmazonWorkSpacesWebClient

All Implemented Interfaces:

AmazonWorkSpacesWeb

Direct Known Subclasses:

AmazonWorkSpacesWebAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonWorkSpacesWebClient
extends AmazonWebServiceClient
implements AmazonWorkSpacesWeb
```
Client for accessing Amazon WorkSpaces Web. All service calls made using this client are blocking, and will not return until the service call completes.

WorkSpaces Web is a low cost, fully managed WorkSpace built specifically to facilitate secure, web-based workloads. WorkSpaces Web 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 Web provides simple policy tools tailored for user interactions, while offloading common tasks like capacity management, scaling, and maintaining browser images.

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.workspacesweb.AmazonWorkSpacesWeb
  ENDPOINT_PREFIX

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssociateBrowserSettingsResult`	`associateBrowserSettings(AssociateBrowserSettingsRequest request)` Associates a browser settings resource with a web portal.
`AssociateNetworkSettingsResult`	`associateNetworkSettings(AssociateNetworkSettingsRequest request)` Associates a network settings resource with a web portal.
`AssociateTrustStoreResult`	`associateTrustStore(AssociateTrustStoreRequest request)` Associates a trust store with a web portal.
`AssociateUserSettingsResult`	`associateUserSettings(AssociateUserSettingsRequest request)` Associates a user settings resource with a web portal.
`static AmazonWorkSpacesWebClientBuilder`	`builder()`
`CreateBrowserSettingsResult`	`createBrowserSettings(CreateBrowserSettingsRequest request)` Creates a browser settings resource that can be associated with a web portal.
`CreateIdentityProviderResult`	`createIdentityProvider(CreateIdentityProviderRequest request)` Creates an identity provider resource that is then associated with a web portal.
`CreateNetworkSettingsResult`	`createNetworkSettings(CreateNetworkSettingsRequest request)` Creates a network settings resource that can be associated with a web portal.
`CreatePortalResult`	`createPortal(CreatePortalRequest request)` Creates a web portal.
`CreateTrustStoreResult`	`createTrustStore(CreateTrustStoreRequest request)` Creates a trust store that can be associated with a web portal.
`CreateUserSettingsResult`	`createUserSettings(CreateUserSettingsRequest request)` Creates a user settings resource that can be associated with a web portal.
`DeleteBrowserSettingsResult`	`deleteBrowserSettings(DeleteBrowserSettingsRequest request)` Deletes browser settings.
`DeleteIdentityProviderResult`	`deleteIdentityProvider(DeleteIdentityProviderRequest request)` Deletes the identity provider.
`DeleteNetworkSettingsResult`	`deleteNetworkSettings(DeleteNetworkSettingsRequest request)` Deletes network settings.
`DeletePortalResult`	`deletePortal(DeletePortalRequest request)` Deletes a web portal.
`DeleteTrustStoreResult`	`deleteTrustStore(DeleteTrustStoreRequest request)` Deletes the trust store.
`DeleteUserSettingsResult`	`deleteUserSettings(DeleteUserSettingsRequest request)` Deletes user settings.
`DisassociateBrowserSettingsResult`	`disassociateBrowserSettings(DisassociateBrowserSettingsRequest request)` Disassociates browser settings from a web portal.
`DisassociateNetworkSettingsResult`	`disassociateNetworkSettings(DisassociateNetworkSettingsRequest request)` Disassociates network settings from a web portal.
`DisassociateTrustStoreResult`	`disassociateTrustStore(DisassociateTrustStoreRequest request)` Disassociates a trust store from a web portal.
`DisassociateUserSettingsResult`	`disassociateUserSettings(DisassociateUserSettingsRequest request)` Disassociates user settings from a web portal.
`GetBrowserSettingsResult`	`getBrowserSettings(GetBrowserSettingsRequest request)` Gets browser settings.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
`GetIdentityProviderResult`	`getIdentityProvider(GetIdentityProviderRequest request)` Gets the identity provider.
`GetNetworkSettingsResult`	`getNetworkSettings(GetNetworkSettingsRequest request)` Gets the network settings.
`GetPortalResult`	`getPortal(GetPortalRequest request)` Gets the web portal.
`GetPortalServiceProviderMetadataResult`	`getPortalServiceProviderMetadata(GetPortalServiceProviderMetadataRequest request)` Gets the service provider metadata.
`GetTrustStoreResult`	`getTrustStore(GetTrustStoreRequest request)` Gets the trust store.
`GetTrustStoreCertificateResult`	`getTrustStoreCertificate(GetTrustStoreCertificateRequest request)` Gets the trust store certificate.
`GetUserSettingsResult`	`getUserSettings(GetUserSettingsRequest request)` Gets user settings.
`ListBrowserSettingsResult`	`listBrowserSettings(ListBrowserSettingsRequest request)` Retrieves a list of browser settings.
`ListIdentityProvidersResult`	`listIdentityProviders(ListIdentityProvidersRequest request)` Retrieves a list of identity providers for a specific web portal.
`ListNetworkSettingsResult`	`listNetworkSettings(ListNetworkSettingsRequest request)` Retrieves a list of network settings.
`ListPortalsResult`	`listPortals(ListPortalsRequest request)` Retrieves a list or web portals.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Retrieves a list of tags for a resource.
`ListTrustStoreCertificatesResult`	`listTrustStoreCertificates(ListTrustStoreCertificatesRequest request)` Retrieves a list of trust store certificates.
`ListTrustStoresResult`	`listTrustStores(ListTrustStoresRequest request)` Retrieves a list of trust stores.
`ListUserSettingsResult`	`listUserSettings(ListUserSettingsRequest request)` Retrieves a list of user settings.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Adds or overwrites one or more tags for the specified resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes one or more tags from the specified resource.
`UpdateBrowserSettingsResult`	`updateBrowserSettings(UpdateBrowserSettingsRequest request)` Updates browser settings.
`UpdateIdentityProviderResult`	`updateIdentityProvider(UpdateIdentityProviderRequest request)` Updates the identity provider.
`UpdateNetworkSettingsResult`	`updateNetworkSettings(UpdateNetworkSettingsRequest request)` Updates network settings.
`UpdatePortalResult`	`updatePortal(UpdatePortalRequest request)` Updates a web portal.
`UpdateTrustStoreResult`	`updateTrustStore(UpdateTrustStoreRequest request)` Updates the trust store.
`UpdateUserSettingsResult`	`updateUserSettings(UpdateUserSettingsRequest request)` Updates the user settings.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - builder
```
public static AmazonWorkSpacesWebClientBuilder builder()
```
  - associateBrowserSettings
```
public AssociateBrowserSettingsResult associateBrowserSettings(AssociateBrowserSettingsRequest request)
```
    Associates a browser settings resource with a web portal.
    
    Specified by:
    
    associateBrowserSettings in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    associateBrowserSettingsRequest -
    
    Returns:
    
    Result of the AssociateBrowserSettings operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    ResourceNotFoundException - The resource cannot be found.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    ConflictException - There is a conflict.
    
    See Also:
    
    AWS API Documentation
  - associateNetworkSettings
```
public AssociateNetworkSettingsResult associateNetworkSettings(AssociateNetworkSettingsRequest request)
```
    Associates a network settings resource with a web portal.
    
    Specified by:
    
    associateNetworkSettings in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    associateNetworkSettingsRequest -
    
    Returns:
    
    Result of the AssociateNetworkSettings operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    ResourceNotFoundException - The resource cannot be found.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    ConflictException - There is a conflict.
    
    See Also:
    
    AWS API Documentation
  - associateTrustStore
```
public AssociateTrustStoreResult associateTrustStore(AssociateTrustStoreRequest request)
```
    Associates a trust store with a web portal.
    
    Specified by:
    
    associateTrustStore in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    associateTrustStoreRequest -
    
    Returns:
    
    Result of the AssociateTrustStore operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    ResourceNotFoundException - The resource cannot be found.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    See Also:
    
    AWS API Documentation
  - associateUserSettings
```
public AssociateUserSettingsResult associateUserSettings(AssociateUserSettingsRequest request)
```
    Associates a user settings resource with a web portal.
    
    Specified by:
    
    associateUserSettings in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    associateUserSettingsRequest -
    
    Returns:
    
    Result of the AssociateUserSettings operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    ResourceNotFoundException - The resource cannot be found.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    ConflictException - There is a conflict.
    
    See Also:
    
    AWS API Documentation
  - createBrowserSettings
```
public CreateBrowserSettingsResult createBrowserSettings(CreateBrowserSettingsRequest request)
```
    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.
    
    Specified by:
    
    createBrowserSettings in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    createBrowserSettingsRequest -
    
    Returns:
    
    Result of the CreateBrowserSettings operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    ResourceNotFoundException - The resource cannot be found.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ServiceQuotaExceededException - The service quota has been exceeded.
    
    ValidationException - There is a validation error.
    
    ConflictException - There is a conflict.
    
    See Also:
    
    AWS API Documentation
  - createIdentityProvider
```
public CreateIdentityProviderResult createIdentityProvider(CreateIdentityProviderRequest request)
```
    Creates an identity provider resource that is then associated with a web portal.
    
    Specified by:
    
    createIdentityProvider in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    createIdentityProviderRequest -
    
    Returns:
    
    Result of the CreateIdentityProvider operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    ResourceNotFoundException - The resource cannot be found.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ServiceQuotaExceededException - The service quota has been exceeded.
    
    ValidationException - There is a validation error.
    
    ConflictException - There is a conflict.
    
    See Also:
    
    AWS API Documentation
  - createNetworkSettings
```
public CreateNetworkSettingsResult createNetworkSettings(CreateNetworkSettingsRequest request)
```
    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.
    
    Specified by:
    
    createNetworkSettings in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    createNetworkSettingsRequest -
    
    Returns:
    
    Result of the CreateNetworkSettings operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ServiceQuotaExceededException - The service quota has been exceeded.
    
    ValidationException - There is a validation error.
    
    ConflictException - There is a conflict.
    
    See Also:
    
    AWS API Documentation
  - createPortal
```
public CreatePortalResult createPortal(CreatePortalRequest request)
```
    Creates a web portal.
    
    Specified by:
    
    createPortal in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    createPortalRequest -
    
    Returns:
    
    Result of the CreatePortal operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    ResourceNotFoundException - The resource cannot be found.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ServiceQuotaExceededException - The service quota has been exceeded.
    
    ValidationException - There is a validation error.
    
    ConflictException - There is a conflict.
    
    See Also:
    
    AWS API Documentation
  - createTrustStore
```
public CreateTrustStoreResult createTrustStore(CreateTrustStoreRequest request)
```
    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.
    
    Specified by:
    
    createTrustStore in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    createTrustStoreRequest -
    
    Returns:
    
    Result of the CreateTrustStore operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ServiceQuotaExceededException - The service quota has been exceeded.
    
    ValidationException - There is a validation error.
    
    ConflictException - There is a conflict.
    
    See Also:
    
    AWS API Documentation
  - createUserSettings
```
public CreateUserSettingsResult createUserSettings(CreateUserSettingsRequest request)
```
    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.
    
    Specified by:
    
    createUserSettings in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    createUserSettingsRequest -
    
    Returns:
    
    Result of the CreateUserSettings operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ServiceQuotaExceededException - The service quota has been exceeded.
    
    ValidationException - There is a validation error.
    
    ConflictException - There is a conflict.
    
    See Also:
    
    AWS API Documentation
  - deleteBrowserSettings
```
public DeleteBrowserSettingsResult deleteBrowserSettings(DeleteBrowserSettingsRequest request)
```
    Deletes browser settings.
    
    Specified by:
    
    deleteBrowserSettings in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    deleteBrowserSettingsRequest -
    
    Returns:
    
    Result of the DeleteBrowserSettings operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    ConflictException - There is a conflict.
    
    See Also:
    
    AWS API Documentation
  - deleteIdentityProvider
```
public DeleteIdentityProviderResult deleteIdentityProvider(DeleteIdentityProviderRequest request)
```
    Deletes the identity provider.
    
    Specified by:
    
    deleteIdentityProvider in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    deleteIdentityProviderRequest -
    
    Returns:
    
    Result of the DeleteIdentityProvider operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    ConflictException - There is a conflict.
    
    See Also:
    
    AWS API Documentation
  - deleteNetworkSettings
```
public DeleteNetworkSettingsResult deleteNetworkSettings(DeleteNetworkSettingsRequest request)
```
    Deletes network settings.
    
    Specified by:
    
    deleteNetworkSettings in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    deleteNetworkSettingsRequest -
    
    Returns:
    
    Result of the DeleteNetworkSettings operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    ConflictException - There is a conflict.
    
    See Also:
    
    AWS API Documentation
  - deletePortal
```
public DeletePortalResult deletePortal(DeletePortalRequest request)
```
    Deletes a web portal.
    
    Specified by:
    
    deletePortal in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    deletePortalRequest -
    
    Returns:
    
    Result of the DeletePortal operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    ConflictException - There is a conflict.
    
    See Also:
    
    AWS API Documentation
  - deleteTrustStore
```
public DeleteTrustStoreResult deleteTrustStore(DeleteTrustStoreRequest request)
```
    Deletes the trust store.
    
    Specified by:
    
    deleteTrustStore in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    deleteTrustStoreRequest -
    
    Returns:
    
    Result of the DeleteTrustStore operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    ConflictException - There is a conflict.
    
    See Also:
    
    AWS API Documentation
  - deleteUserSettings
```
public DeleteUserSettingsResult deleteUserSettings(DeleteUserSettingsRequest request)
```
    Deletes user settings.
    
    Specified by:
    
    deleteUserSettings in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    deleteUserSettingsRequest -
    
    Returns:
    
    Result of the DeleteUserSettings operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    ConflictException - There is a conflict.
    
    See Also:
    
    AWS API Documentation
  - disassociateBrowserSettings
```
public DisassociateBrowserSettingsResult disassociateBrowserSettings(DisassociateBrowserSettingsRequest request)
```
    Disassociates browser settings from a web portal.
    
    Specified by:
    
    disassociateBrowserSettings in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    disassociateBrowserSettingsRequest -
    
    Returns:
    
    Result of the DisassociateBrowserSettings operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    ResourceNotFoundException - The resource cannot be found.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    See Also:
    
    AWS API Documentation
  - disassociateNetworkSettings
```
public DisassociateNetworkSettingsResult disassociateNetworkSettings(DisassociateNetworkSettingsRequest request)
```
    Disassociates network settings from a web portal.
    
    Specified by:
    
    disassociateNetworkSettings in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    disassociateNetworkSettingsRequest -
    
    Returns:
    
    Result of the DisassociateNetworkSettings operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    ResourceNotFoundException - The resource cannot be found.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    See Also:
    
    AWS API Documentation
  - disassociateTrustStore
```
public DisassociateTrustStoreResult disassociateTrustStore(DisassociateTrustStoreRequest request)
```
    Disassociates a trust store from a web portal.
    
    Specified by:
    
    disassociateTrustStore in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    disassociateTrustStoreRequest -
    
    Returns:
    
    Result of the DisassociateTrustStore operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    ResourceNotFoundException - The resource cannot be found.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    See Also:
    
    AWS API Documentation
  - disassociateUserSettings
```
public DisassociateUserSettingsResult disassociateUserSettings(DisassociateUserSettingsRequest request)
```
    Disassociates user settings from a web portal.
    
    Specified by:
    
    disassociateUserSettings in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    disassociateUserSettingsRequest -
    
    Returns:
    
    Result of the DisassociateUserSettings operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    ResourceNotFoundException - The resource cannot be found.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    See Also:
    
    AWS API Documentation
  - getBrowserSettings
```
public GetBrowserSettingsResult getBrowserSettings(GetBrowserSettingsRequest request)
```
    Gets browser settings.
    
    Specified by:
    
    getBrowserSettings in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    getBrowserSettingsRequest -
    
    Returns:
    
    Result of the GetBrowserSettings operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    ResourceNotFoundException - The resource cannot be found.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    See Also:
    
    AWS API Documentation
  - getIdentityProvider
```
public GetIdentityProviderResult getIdentityProvider(GetIdentityProviderRequest request)
```
    Gets the identity provider.
    
    Specified by:
    
    getIdentityProvider in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    getIdentityProviderRequest -
    
    Returns:
    
    Result of the GetIdentityProvider operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    ResourceNotFoundException - The resource cannot be found.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    See Also:
    
    AWS API Documentation
  - getNetworkSettings
```
public GetNetworkSettingsResult getNetworkSettings(GetNetworkSettingsRequest request)
```
    Gets the network settings.
    
    Specified by:
    
    getNetworkSettings in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    getNetworkSettingsRequest -
    
    Returns:
    
    Result of the GetNetworkSettings operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    ResourceNotFoundException - The resource cannot be found.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    See Also:
    
    AWS API Documentation
  - getPortal
```
public GetPortalResult getPortal(GetPortalRequest request)
```
    Gets the web portal.
    
    Specified by:
    
    getPortal in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    getPortalRequest -
    
    Returns:
    
    Result of the GetPortal operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    ResourceNotFoundException - The resource cannot be found.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    See Also:
    
    AWS API Documentation
  - getPortalServiceProviderMetadata
```
public GetPortalServiceProviderMetadataResult getPortalServiceProviderMetadata(GetPortalServiceProviderMetadataRequest request)
```
    Gets the service provider metadata.
    
    Specified by:
    
    getPortalServiceProviderMetadata in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    getPortalServiceProviderMetadataRequest -
    
    Returns:
    
    Result of the GetPortalServiceProviderMetadata operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    ResourceNotFoundException - The resource cannot be found.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    See Also:
    
    AWS API Documentation
  - getTrustStore
```
public GetTrustStoreResult getTrustStore(GetTrustStoreRequest request)
```
    Gets the trust store.
    
    Specified by:
    
    getTrustStore in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    getTrustStoreRequest -
    
    Returns:
    
    Result of the GetTrustStore operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    ResourceNotFoundException - The resource cannot be found.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    See Also:
    
    AWS API Documentation
  - getTrustStoreCertificate
```
public GetTrustStoreCertificateResult getTrustStoreCertificate(GetTrustStoreCertificateRequest request)
```
    Gets the trust store certificate.
    
    Specified by:
    
    getTrustStoreCertificate in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    getTrustStoreCertificateRequest -
    
    Returns:
    
    Result of the GetTrustStoreCertificate operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    ResourceNotFoundException - The resource cannot be found.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    See Also:
    
    AWS API Documentation
  - getUserSettings
```
public GetUserSettingsResult getUserSettings(GetUserSettingsRequest request)
```
    Gets user settings.
    
    Specified by:
    
    getUserSettings in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    getUserSettingsRequest -
    
    Returns:
    
    Result of the GetUserSettings operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    ResourceNotFoundException - The resource cannot be found.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    See Also:
    
    AWS API Documentation
  - listBrowserSettings
```
public ListBrowserSettingsResult listBrowserSettings(ListBrowserSettingsRequest request)
```
    Retrieves a list of browser settings.
    
    Specified by:
    
    listBrowserSettings in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    listBrowserSettingsRequest -
    
    Returns:
    
    Result of the ListBrowserSettings operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    See Also:
    
    AWS API Documentation
  - listIdentityProviders
```
public ListIdentityProvidersResult listIdentityProviders(ListIdentityProvidersRequest request)
```
    Retrieves a list of identity providers for a specific web portal.
    
    Specified by:
    
    listIdentityProviders in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    listIdentityProvidersRequest -
    
    Returns:
    
    Result of the ListIdentityProviders operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    See Also:
    
    AWS API Documentation
  - listNetworkSettings
```
public ListNetworkSettingsResult listNetworkSettings(ListNetworkSettingsRequest request)
```
    Retrieves a list of network settings.
    
    Specified by:
    
    listNetworkSettings in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    listNetworkSettingsRequest -
    
    Returns:
    
    Result of the ListNetworkSettings operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    See Also:
    
    AWS API Documentation
  - listPortals
```
public ListPortalsResult listPortals(ListPortalsRequest request)
```
    Retrieves a list or web portals.
    
    Specified by:
    
    listPortals in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    listPortalsRequest -
    
    Returns:
    
    Result of the ListPortals operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Retrieves a list of tags for a resource.
    
    Specified by:
    
    listTagsForResource in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    ResourceNotFoundException - The resource cannot be found.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    See Also:
    
    AWS API Documentation
  - listTrustStoreCertificates
```
public ListTrustStoreCertificatesResult listTrustStoreCertificates(ListTrustStoreCertificatesRequest request)
```
    Retrieves a list of trust store certificates.
    
    Specified by:
    
    listTrustStoreCertificates in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    listTrustStoreCertificatesRequest -
    
    Returns:
    
    Result of the ListTrustStoreCertificates operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    ResourceNotFoundException - The resource cannot be found.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    See Also:
    
    AWS API Documentation
  - listTrustStores
```
public ListTrustStoresResult listTrustStores(ListTrustStoresRequest request)
```
    Retrieves a list of trust stores.
    
    Specified by:
    
    listTrustStores in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    listTrustStoresRequest -
    
    Returns:
    
    Result of the ListTrustStores operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    See Also:
    
    AWS API Documentation
  - listUserSettings
```
public ListUserSettingsResult listUserSettings(ListUserSettingsRequest request)
```
    Retrieves a list of user settings.
    
    Specified by:
    
    listUserSettings in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    listUserSettingsRequest -
    
    Returns:
    
    Result of the ListUserSettings operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Adds or overwrites one or more tags for the specified resource.
    
    Specified by:
    
    tagResource in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    ResourceNotFoundException - The resource cannot be found.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    TooManyTagsException - There are too many tags.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Removes one or more tags from the specified resource.
    
    Specified by:
    
    untagResource in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    ResourceNotFoundException - The resource cannot be found.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    See Also:
    
    AWS API Documentation
  - updateBrowserSettings
```
public UpdateBrowserSettingsResult updateBrowserSettings(UpdateBrowserSettingsRequest request)
```
    Updates browser settings.
    
    Specified by:
    
    updateBrowserSettings in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    updateBrowserSettingsRequest -
    
    Returns:
    
    Result of the UpdateBrowserSettings operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    ResourceNotFoundException - The resource cannot be found.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    See Also:
    
    AWS API Documentation
  - updateIdentityProvider
```
public UpdateIdentityProviderResult updateIdentityProvider(UpdateIdentityProviderRequest request)
```
    Updates the identity provider.
    
    Specified by:
    
    updateIdentityProvider in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    updateIdentityProviderRequest -
    
    Returns:
    
    Result of the UpdateIdentityProvider operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    ResourceNotFoundException - The resource cannot be found.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    See Also:
    
    AWS API Documentation
  - updateNetworkSettings
```
public UpdateNetworkSettingsResult updateNetworkSettings(UpdateNetworkSettingsRequest request)
```
    Updates network settings.
    
    Specified by:
    
    updateNetworkSettings in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    updateNetworkSettingsRequest -
    
    Returns:
    
    Result of the UpdateNetworkSettings operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    ResourceNotFoundException - The resource cannot be found.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    See Also:
    
    AWS API Documentation
  - updatePortal
```
public UpdatePortalResult updatePortal(UpdatePortalRequest request)
```
    Updates a web portal.
    
    Specified by:
    
    updatePortal in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    updatePortalRequest -
    
    Returns:
    
    Result of the UpdatePortal operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    ResourceNotFoundException - The resource cannot be found.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    See Also:
    
    AWS API Documentation
  - updateTrustStore
```
public UpdateTrustStoreResult updateTrustStore(UpdateTrustStoreRequest request)
```
    Updates the trust store.
    
    Specified by:
    
    updateTrustStore in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    updateTrustStoreRequest -
    
    Returns:
    
    Result of the UpdateTrustStore operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    ResourceNotFoundException - The resource cannot be found.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ServiceQuotaExceededException - The service quota has been exceeded.
    
    ValidationException - There is a validation error.
    
    See Also:
    
    AWS API Documentation
  - updateUserSettings
```
public UpdateUserSettingsResult updateUserSettings(UpdateUserSettingsRequest request)
```
    Updates the user settings.
    
    Specified by:
    
    updateUserSettings in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    updateUserSettingsRequest -
    
    Returns:
    
    Result of the UpdateUserSettings operation returned by the service.
    
    Throws:
    
    InternalServerException - There is an internal server error.
    
    ResourceNotFoundException - The resource cannot be found.
    
    AccessDeniedException - Access is denied.
    
    ThrottlingException - There is a throttling error.
    
    ValidationException - There is a validation error.
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonWorkSpacesWeb
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from class: AmazonWebServiceClient
    
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonWorkSpacesWeb
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Did this page help you?

Class AmazonWorkSpacesWebClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.workspacesweb.AmazonWorkSpacesWeb

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Method Detail

builder

associateBrowserSettings

associateNetworkSettings

associateTrustStore

associateUserSettings

createBrowserSettings

createIdentityProvider

createNetworkSettings

createPortal

createTrustStore

createUserSettings

deleteBrowserSettings

deleteIdentityProvider

deleteNetworkSettings

deletePortal

deleteTrustStore

deleteUserSettings

disassociateBrowserSettings

disassociateNetworkSettings

disassociateTrustStore

disassociateUserSettings

getBrowserSettings

getIdentityProvider

getNetworkSettings

getPortal

getPortalServiceProviderMetadata

getTrustStore

getTrustStoreCertificate

getUserSettings

listBrowserSettings

listIdentityProviders

listNetworkSettings

listPortals

listTagsForResource

listTrustStoreCertificates

listTrustStores

listUserSettings

tagResource

untagResource

updateBrowserSettings

updateIdentityProvider

updateNetworkSettings

updatePortal

updateTrustStore

updateUserSettings

getCachedResponseMetadata

shutdown