Interface WorkSpacesWebAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface WorkSpacesWebAsyncClient extends AwsClient
Service client for accessing Amazon WorkSpaces Web asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

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 Details

  • Method Details

    • associateBrowserSettings

      default CompletableFuture<AssociateBrowserSettingsResponse> associateBrowserSettings(AssociateBrowserSettingsRequest associateBrowserSettingsRequest)

      Associates a browser settings resource with a web portal.

      Parameters:
      associateBrowserSettingsRequest -
      Returns:
      A Java Future containing the result of the AssociateBrowserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • associateBrowserSettings

      default CompletableFuture<AssociateBrowserSettingsResponse> associateBrowserSettings(Consumer<AssociateBrowserSettingsRequest.Builder> associateBrowserSettingsRequest)

      Associates a browser settings resource with a web portal.


      This is a convenience which creates an instance of the AssociateBrowserSettingsRequest.Builder avoiding the need to create one manually via AssociateBrowserSettingsRequest.builder()

      Parameters:
      associateBrowserSettingsRequest - A Consumer that will call methods on AssociateBrowserSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateBrowserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • associateIpAccessSettings

      default CompletableFuture<AssociateIpAccessSettingsResponse> associateIpAccessSettings(AssociateIpAccessSettingsRequest associateIpAccessSettingsRequest)

      Associates an IP access settings resource with a web portal.

      Parameters:
      associateIpAccessSettingsRequest -
      Returns:
      A Java Future containing the result of the AssociateIpAccessSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • associateIpAccessSettings

      default CompletableFuture<AssociateIpAccessSettingsResponse> associateIpAccessSettings(Consumer<AssociateIpAccessSettingsRequest.Builder> associateIpAccessSettingsRequest)

      Associates an IP access settings resource with a web portal.


      This is a convenience which creates an instance of the AssociateIpAccessSettingsRequest.Builder avoiding the need to create one manually via AssociateIpAccessSettingsRequest.builder()

      Parameters:
      associateIpAccessSettingsRequest - A Consumer that will call methods on AssociateIpAccessSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateIpAccessSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • associateNetworkSettings

      default CompletableFuture<AssociateNetworkSettingsResponse> associateNetworkSettings(AssociateNetworkSettingsRequest associateNetworkSettingsRequest)

      Associates a network settings resource with a web portal.

      Parameters:
      associateNetworkSettingsRequest -
      Returns:
      A Java Future containing the result of the AssociateNetworkSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • associateNetworkSettings

      default CompletableFuture<AssociateNetworkSettingsResponse> associateNetworkSettings(Consumer<AssociateNetworkSettingsRequest.Builder> associateNetworkSettingsRequest)

      Associates a network settings resource with a web portal.


      This is a convenience which creates an instance of the AssociateNetworkSettingsRequest.Builder avoiding the need to create one manually via AssociateNetworkSettingsRequest.builder()

      Parameters:
      associateNetworkSettingsRequest - A Consumer that will call methods on AssociateNetworkSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateNetworkSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • associateTrustStore

      default CompletableFuture<AssociateTrustStoreResponse> associateTrustStore(AssociateTrustStoreRequest associateTrustStoreRequest)

      Associates a trust store with a web portal.

      Parameters:
      associateTrustStoreRequest -
      Returns:
      A Java Future containing the result of the AssociateTrustStore operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • associateTrustStore

      default CompletableFuture<AssociateTrustStoreResponse> associateTrustStore(Consumer<AssociateTrustStoreRequest.Builder> associateTrustStoreRequest)

      Associates a trust store with a web portal.


      This is a convenience which creates an instance of the AssociateTrustStoreRequest.Builder avoiding the need to create one manually via AssociateTrustStoreRequest.builder()

      Parameters:
      associateTrustStoreRequest - A Consumer that will call methods on AssociateTrustStoreRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateTrustStore operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • associateUserAccessLoggingSettings

      default CompletableFuture<AssociateUserAccessLoggingSettingsResponse> associateUserAccessLoggingSettings(AssociateUserAccessLoggingSettingsRequest associateUserAccessLoggingSettingsRequest)

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

      Parameters:
      associateUserAccessLoggingSettingsRequest -
      Returns:
      A Java Future containing the result of the AssociateUserAccessLoggingSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • associateUserAccessLoggingSettings

      default CompletableFuture<AssociateUserAccessLoggingSettingsResponse> associateUserAccessLoggingSettings(Consumer<AssociateUserAccessLoggingSettingsRequest.Builder> associateUserAccessLoggingSettingsRequest)

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


      This is a convenience which creates an instance of the AssociateUserAccessLoggingSettingsRequest.Builder avoiding the need to create one manually via AssociateUserAccessLoggingSettingsRequest.builder()

      Parameters:
      associateUserAccessLoggingSettingsRequest - A Consumer that will call methods on AssociateUserAccessLoggingSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateUserAccessLoggingSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • associateUserSettings

      default CompletableFuture<AssociateUserSettingsResponse> associateUserSettings(AssociateUserSettingsRequest associateUserSettingsRequest)

      Associates a user settings resource with a web portal.

      Parameters:
      associateUserSettingsRequest -
      Returns:
      A Java Future containing the result of the AssociateUserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • associateUserSettings

      default CompletableFuture<AssociateUserSettingsResponse> associateUserSettings(Consumer<AssociateUserSettingsRequest.Builder> associateUserSettingsRequest)

      Associates a user settings resource with a web portal.


      This is a convenience which creates an instance of the AssociateUserSettingsRequest.Builder avoiding the need to create one manually via AssociateUserSettingsRequest.builder()

      Parameters:
      associateUserSettingsRequest - A Consumer that will call methods on AssociateUserSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateUserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createBrowserSettings

      default CompletableFuture<CreateBrowserSettingsResponse> createBrowserSettings(CreateBrowserSettingsRequest createBrowserSettingsRequest)

      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.

      Parameters:
      createBrowserSettingsRequest -
      Returns:
      A Java Future containing the result of the CreateBrowserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createBrowserSettings

      default CompletableFuture<CreateBrowserSettingsResponse> createBrowserSettings(Consumer<CreateBrowserSettingsRequest.Builder> createBrowserSettingsRequest)

      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.


      This is a convenience which creates an instance of the CreateBrowserSettingsRequest.Builder avoiding the need to create one manually via CreateBrowserSettingsRequest.builder()

      Parameters:
      createBrowserSettingsRequest - A Consumer that will call methods on CreateBrowserSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateBrowserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createIdentityProvider

      default CompletableFuture<CreateIdentityProviderResponse> createIdentityProvider(CreateIdentityProviderRequest createIdentityProviderRequest)

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

      Parameters:
      createIdentityProviderRequest -
      Returns:
      A Java Future containing the result of the CreateIdentityProvider operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createIdentityProvider

      default CompletableFuture<CreateIdentityProviderResponse> createIdentityProvider(Consumer<CreateIdentityProviderRequest.Builder> createIdentityProviderRequest)

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


      This is a convenience which creates an instance of the CreateIdentityProviderRequest.Builder avoiding the need to create one manually via CreateIdentityProviderRequest.builder()

      Parameters:
      createIdentityProviderRequest - A Consumer that will call methods on CreateIdentityProviderRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateIdentityProvider operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createIpAccessSettings

      default CompletableFuture<CreateIpAccessSettingsResponse> createIpAccessSettings(CreateIpAccessSettingsRequest createIpAccessSettingsRequest)

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

      Parameters:
      createIpAccessSettingsRequest -
      Returns:
      A Java Future containing the result of the CreateIpAccessSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createIpAccessSettings

      default CompletableFuture<CreateIpAccessSettingsResponse> createIpAccessSettings(Consumer<CreateIpAccessSettingsRequest.Builder> createIpAccessSettingsRequest)

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


      This is a convenience which creates an instance of the CreateIpAccessSettingsRequest.Builder avoiding the need to create one manually via CreateIpAccessSettingsRequest.builder()

      Parameters:
      createIpAccessSettingsRequest - A Consumer that will call methods on CreateIpAccessSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateIpAccessSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createNetworkSettings

      default CompletableFuture<CreateNetworkSettingsResponse> createNetworkSettings(CreateNetworkSettingsRequest createNetworkSettingsRequest)

      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.

      Parameters:
      createNetworkSettingsRequest -
      Returns:
      A Java Future containing the result of the CreateNetworkSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createNetworkSettings

      default CompletableFuture<CreateNetworkSettingsResponse> createNetworkSettings(Consumer<CreateNetworkSettingsRequest.Builder> createNetworkSettingsRequest)

      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.


      This is a convenience which creates an instance of the CreateNetworkSettingsRequest.Builder avoiding the need to create one manually via CreateNetworkSettingsRequest.builder()

      Parameters:
      createNetworkSettingsRequest - A Consumer that will call methods on CreateNetworkSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateNetworkSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createPortal

      default CompletableFuture<CreatePortalResponse> createPortal(CreatePortalRequest createPortalRequest)

      Creates a web portal.

      Parameters:
      createPortalRequest -
      Returns:
      A Java Future containing the result of the CreatePortal operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createPortal

      default CompletableFuture<CreatePortalResponse> createPortal(Consumer<CreatePortalRequest.Builder> createPortalRequest)

      Creates a web portal.


      This is a convenience which creates an instance of the CreatePortalRequest.Builder avoiding the need to create one manually via CreatePortalRequest.builder()

      Parameters:
      createPortalRequest - A Consumer that will call methods on CreatePortalRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreatePortal operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createTrustStore

      default CompletableFuture<CreateTrustStoreResponse> createTrustStore(CreateTrustStoreRequest createTrustStoreRequest)

      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.

      Parameters:
      createTrustStoreRequest -
      Returns:
      A Java Future containing the result of the CreateTrustStore operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createTrustStore

      default CompletableFuture<CreateTrustStoreResponse> createTrustStore(Consumer<CreateTrustStoreRequest.Builder> createTrustStoreRequest)

      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.


      This is a convenience which creates an instance of the CreateTrustStoreRequest.Builder avoiding the need to create one manually via CreateTrustStoreRequest.builder()

      Parameters:
      createTrustStoreRequest - A Consumer that will call methods on CreateTrustStoreRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateTrustStore operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createUserAccessLoggingSettings

      default CompletableFuture<CreateUserAccessLoggingSettingsResponse> createUserAccessLoggingSettings(CreateUserAccessLoggingSettingsRequest createUserAccessLoggingSettingsRequest)

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

      Parameters:
      createUserAccessLoggingSettingsRequest -
      Returns:
      A Java Future containing the result of the CreateUserAccessLoggingSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createUserAccessLoggingSettings

      default CompletableFuture<CreateUserAccessLoggingSettingsResponse> createUserAccessLoggingSettings(Consumer<CreateUserAccessLoggingSettingsRequest.Builder> createUserAccessLoggingSettingsRequest)

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


      This is a convenience which creates an instance of the CreateUserAccessLoggingSettingsRequest.Builder avoiding the need to create one manually via CreateUserAccessLoggingSettingsRequest.builder()

      Parameters:
      createUserAccessLoggingSettingsRequest - A Consumer that will call methods on CreateUserAccessLoggingSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateUserAccessLoggingSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createUserSettings

      default CompletableFuture<CreateUserSettingsResponse> createUserSettings(CreateUserSettingsRequest createUserSettingsRequest)

      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.

      Parameters:
      createUserSettingsRequest -
      Returns:
      A Java Future containing the result of the CreateUserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createUserSettings

      default CompletableFuture<CreateUserSettingsResponse> createUserSettings(Consumer<CreateUserSettingsRequest.Builder> createUserSettingsRequest)

      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.


      This is a convenience which creates an instance of the CreateUserSettingsRequest.Builder avoiding the need to create one manually via CreateUserSettingsRequest.builder()

      Parameters:
      createUserSettingsRequest - A Consumer that will call methods on CreateUserSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateUserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteBrowserSettings

      default CompletableFuture<DeleteBrowserSettingsResponse> deleteBrowserSettings(DeleteBrowserSettingsRequest deleteBrowserSettingsRequest)

      Deletes browser settings.

      Parameters:
      deleteBrowserSettingsRequest -
      Returns:
      A Java Future containing the result of the DeleteBrowserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteBrowserSettings

      default CompletableFuture<DeleteBrowserSettingsResponse> deleteBrowserSettings(Consumer<DeleteBrowserSettingsRequest.Builder> deleteBrowserSettingsRequest)

      Deletes browser settings.


      This is a convenience which creates an instance of the DeleteBrowserSettingsRequest.Builder avoiding the need to create one manually via DeleteBrowserSettingsRequest.builder()

      Parameters:
      deleteBrowserSettingsRequest - A Consumer that will call methods on DeleteBrowserSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteBrowserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteIdentityProvider

      default CompletableFuture<DeleteIdentityProviderResponse> deleteIdentityProvider(DeleteIdentityProviderRequest deleteIdentityProviderRequest)

      Deletes the identity provider.

      Parameters:
      deleteIdentityProviderRequest -
      Returns:
      A Java Future containing the result of the DeleteIdentityProvider operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteIdentityProvider

      default CompletableFuture<DeleteIdentityProviderResponse> deleteIdentityProvider(Consumer<DeleteIdentityProviderRequest.Builder> deleteIdentityProviderRequest)

      Deletes the identity provider.


      This is a convenience which creates an instance of the DeleteIdentityProviderRequest.Builder avoiding the need to create one manually via DeleteIdentityProviderRequest.builder()

      Parameters:
      deleteIdentityProviderRequest - A Consumer that will call methods on DeleteIdentityProviderRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteIdentityProvider operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteIpAccessSettings

      default CompletableFuture<DeleteIpAccessSettingsResponse> deleteIpAccessSettings(DeleteIpAccessSettingsRequest deleteIpAccessSettingsRequest)

      Deletes IP access settings.

      Parameters:
      deleteIpAccessSettingsRequest -
      Returns:
      A Java Future containing the result of the DeleteIpAccessSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteIpAccessSettings

      default CompletableFuture<DeleteIpAccessSettingsResponse> deleteIpAccessSettings(Consumer<DeleteIpAccessSettingsRequest.Builder> deleteIpAccessSettingsRequest)

      Deletes IP access settings.


      This is a convenience which creates an instance of the DeleteIpAccessSettingsRequest.Builder avoiding the need to create one manually via DeleteIpAccessSettingsRequest.builder()

      Parameters:
      deleteIpAccessSettingsRequest - A Consumer that will call methods on DeleteIpAccessSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteIpAccessSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteNetworkSettings

      default CompletableFuture<DeleteNetworkSettingsResponse> deleteNetworkSettings(DeleteNetworkSettingsRequest deleteNetworkSettingsRequest)

      Deletes network settings.

      Parameters:
      deleteNetworkSettingsRequest -
      Returns:
      A Java Future containing the result of the DeleteNetworkSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteNetworkSettings

      default CompletableFuture<DeleteNetworkSettingsResponse> deleteNetworkSettings(Consumer<DeleteNetworkSettingsRequest.Builder> deleteNetworkSettingsRequest)

      Deletes network settings.


      This is a convenience which creates an instance of the DeleteNetworkSettingsRequest.Builder avoiding the need to create one manually via DeleteNetworkSettingsRequest.builder()

      Parameters:
      deleteNetworkSettingsRequest - A Consumer that will call methods on DeleteNetworkSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteNetworkSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deletePortal

      default CompletableFuture<DeletePortalResponse> deletePortal(DeletePortalRequest deletePortalRequest)

      Deletes a web portal.

      Parameters:
      deletePortalRequest -
      Returns:
      A Java Future containing the result of the DeletePortal operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deletePortal

      default CompletableFuture<DeletePortalResponse> deletePortal(Consumer<DeletePortalRequest.Builder> deletePortalRequest)

      Deletes a web portal.


      This is a convenience which creates an instance of the DeletePortalRequest.Builder avoiding the need to create one manually via DeletePortalRequest.builder()

      Parameters:
      deletePortalRequest - A Consumer that will call methods on DeletePortalRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeletePortal operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteTrustStore

      default CompletableFuture<DeleteTrustStoreResponse> deleteTrustStore(DeleteTrustStoreRequest deleteTrustStoreRequest)

      Deletes the trust store.

      Parameters:
      deleteTrustStoreRequest -
      Returns:
      A Java Future containing the result of the DeleteTrustStore operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteTrustStore

      default CompletableFuture<DeleteTrustStoreResponse> deleteTrustStore(Consumer<DeleteTrustStoreRequest.Builder> deleteTrustStoreRequest)

      Deletes the trust store.


      This is a convenience which creates an instance of the DeleteTrustStoreRequest.Builder avoiding the need to create one manually via DeleteTrustStoreRequest.builder()

      Parameters:
      deleteTrustStoreRequest - A Consumer that will call methods on DeleteTrustStoreRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteTrustStore operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteUserAccessLoggingSettings

      default CompletableFuture<DeleteUserAccessLoggingSettingsResponse> deleteUserAccessLoggingSettings(DeleteUserAccessLoggingSettingsRequest deleteUserAccessLoggingSettingsRequest)

      Deletes user access logging settings.

      Parameters:
      deleteUserAccessLoggingSettingsRequest -
      Returns:
      A Java Future containing the result of the DeleteUserAccessLoggingSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteUserAccessLoggingSettings

      default CompletableFuture<DeleteUserAccessLoggingSettingsResponse> deleteUserAccessLoggingSettings(Consumer<DeleteUserAccessLoggingSettingsRequest.Builder> deleteUserAccessLoggingSettingsRequest)

      Deletes user access logging settings.


      This is a convenience which creates an instance of the DeleteUserAccessLoggingSettingsRequest.Builder avoiding the need to create one manually via DeleteUserAccessLoggingSettingsRequest.builder()

      Parameters:
      deleteUserAccessLoggingSettingsRequest - A Consumer that will call methods on DeleteUserAccessLoggingSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteUserAccessLoggingSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteUserSettings

      default CompletableFuture<DeleteUserSettingsResponse> deleteUserSettings(DeleteUserSettingsRequest deleteUserSettingsRequest)

      Deletes user settings.

      Parameters:
      deleteUserSettingsRequest -
      Returns:
      A Java Future containing the result of the DeleteUserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteUserSettings

      default CompletableFuture<DeleteUserSettingsResponse> deleteUserSettings(Consumer<DeleteUserSettingsRequest.Builder> deleteUserSettingsRequest)

      Deletes user settings.


      This is a convenience which creates an instance of the DeleteUserSettingsRequest.Builder avoiding the need to create one manually via DeleteUserSettingsRequest.builder()

      Parameters:
      deleteUserSettingsRequest - A Consumer that will call methods on DeleteUserSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteUserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • disassociateBrowserSettings

      default CompletableFuture<DisassociateBrowserSettingsResponse> disassociateBrowserSettings(DisassociateBrowserSettingsRequest disassociateBrowserSettingsRequest)

      Disassociates browser settings from a web portal.

      Parameters:
      disassociateBrowserSettingsRequest -
      Returns:
      A Java Future containing the result of the DisassociateBrowserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • disassociateBrowserSettings

      default CompletableFuture<DisassociateBrowserSettingsResponse> disassociateBrowserSettings(Consumer<DisassociateBrowserSettingsRequest.Builder> disassociateBrowserSettingsRequest)

      Disassociates browser settings from a web portal.


      This is a convenience which creates an instance of the DisassociateBrowserSettingsRequest.Builder avoiding the need to create one manually via DisassociateBrowserSettingsRequest.builder()

      Parameters:
      disassociateBrowserSettingsRequest - A Consumer that will call methods on DisassociateBrowserSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateBrowserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • disassociateIpAccessSettings

      default CompletableFuture<DisassociateIpAccessSettingsResponse> disassociateIpAccessSettings(DisassociateIpAccessSettingsRequest disassociateIpAccessSettingsRequest)

      Disassociates IP access settings from a web portal.

      Parameters:
      disassociateIpAccessSettingsRequest -
      Returns:
      A Java Future containing the result of the DisassociateIpAccessSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • disassociateIpAccessSettings

      default CompletableFuture<DisassociateIpAccessSettingsResponse> disassociateIpAccessSettings(Consumer<DisassociateIpAccessSettingsRequest.Builder> disassociateIpAccessSettingsRequest)

      Disassociates IP access settings from a web portal.


      This is a convenience which creates an instance of the DisassociateIpAccessSettingsRequest.Builder avoiding the need to create one manually via DisassociateIpAccessSettingsRequest.builder()

      Parameters:
      disassociateIpAccessSettingsRequest - A Consumer that will call methods on DisassociateIpAccessSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateIpAccessSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • disassociateNetworkSettings

      default CompletableFuture<DisassociateNetworkSettingsResponse> disassociateNetworkSettings(DisassociateNetworkSettingsRequest disassociateNetworkSettingsRequest)

      Disassociates network settings from a web portal.

      Parameters:
      disassociateNetworkSettingsRequest -
      Returns:
      A Java Future containing the result of the DisassociateNetworkSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • disassociateNetworkSettings

      default CompletableFuture<DisassociateNetworkSettingsResponse> disassociateNetworkSettings(Consumer<DisassociateNetworkSettingsRequest.Builder> disassociateNetworkSettingsRequest)

      Disassociates network settings from a web portal.


      This is a convenience which creates an instance of the DisassociateNetworkSettingsRequest.Builder avoiding the need to create one manually via DisassociateNetworkSettingsRequest.builder()

      Parameters:
      disassociateNetworkSettingsRequest - A Consumer that will call methods on DisassociateNetworkSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateNetworkSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • disassociateTrustStore

      default CompletableFuture<DisassociateTrustStoreResponse> disassociateTrustStore(DisassociateTrustStoreRequest disassociateTrustStoreRequest)

      Disassociates a trust store from a web portal.

      Parameters:
      disassociateTrustStoreRequest -
      Returns:
      A Java Future containing the result of the DisassociateTrustStore operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • disassociateTrustStore

      default CompletableFuture<DisassociateTrustStoreResponse> disassociateTrustStore(Consumer<DisassociateTrustStoreRequest.Builder> disassociateTrustStoreRequest)

      Disassociates a trust store from a web portal.


      This is a convenience which creates an instance of the DisassociateTrustStoreRequest.Builder avoiding the need to create one manually via DisassociateTrustStoreRequest.builder()

      Parameters:
      disassociateTrustStoreRequest - A Consumer that will call methods on DisassociateTrustStoreRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateTrustStore operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • disassociateUserAccessLoggingSettings

      default CompletableFuture<DisassociateUserAccessLoggingSettingsResponse> disassociateUserAccessLoggingSettings(DisassociateUserAccessLoggingSettingsRequest disassociateUserAccessLoggingSettingsRequest)

      Disassociates user access logging settings from a web portal.

      Parameters:
      disassociateUserAccessLoggingSettingsRequest -
      Returns:
      A Java Future containing the result of the DisassociateUserAccessLoggingSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • disassociateUserAccessLoggingSettings

      default CompletableFuture<DisassociateUserAccessLoggingSettingsResponse> disassociateUserAccessLoggingSettings(Consumer<DisassociateUserAccessLoggingSettingsRequest.Builder> disassociateUserAccessLoggingSettingsRequest)

      Disassociates user access logging settings from a web portal.


      This is a convenience which creates an instance of the DisassociateUserAccessLoggingSettingsRequest.Builder avoiding the need to create one manually via DisassociateUserAccessLoggingSettingsRequest.builder()

      Parameters:
      disassociateUserAccessLoggingSettingsRequest - A Consumer that will call methods on DisassociateUserAccessLoggingSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateUserAccessLoggingSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • disassociateUserSettings

      default CompletableFuture<DisassociateUserSettingsResponse> disassociateUserSettings(DisassociateUserSettingsRequest disassociateUserSettingsRequest)

      Disassociates user settings from a web portal.

      Parameters:
      disassociateUserSettingsRequest -
      Returns:
      A Java Future containing the result of the DisassociateUserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • disassociateUserSettings

      default CompletableFuture<DisassociateUserSettingsResponse> disassociateUserSettings(Consumer<DisassociateUserSettingsRequest.Builder> disassociateUserSettingsRequest)

      Disassociates user settings from a web portal.


      This is a convenience which creates an instance of the DisassociateUserSettingsRequest.Builder avoiding the need to create one manually via DisassociateUserSettingsRequest.builder()

      Parameters:
      disassociateUserSettingsRequest - A Consumer that will call methods on DisassociateUserSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateUserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getBrowserSettings

      default CompletableFuture<GetBrowserSettingsResponse> getBrowserSettings(GetBrowserSettingsRequest getBrowserSettingsRequest)

      Gets browser settings.

      Parameters:
      getBrowserSettingsRequest -
      Returns:
      A Java Future containing the result of the GetBrowserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getBrowserSettings

      default CompletableFuture<GetBrowserSettingsResponse> getBrowserSettings(Consumer<GetBrowserSettingsRequest.Builder> getBrowserSettingsRequest)

      Gets browser settings.


      This is a convenience which creates an instance of the GetBrowserSettingsRequest.Builder avoiding the need to create one manually via GetBrowserSettingsRequest.builder()

      Parameters:
      getBrowserSettingsRequest - A Consumer that will call methods on GetBrowserSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetBrowserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getIdentityProvider

      default CompletableFuture<GetIdentityProviderResponse> getIdentityProvider(GetIdentityProviderRequest getIdentityProviderRequest)

      Gets the identity provider.

      Parameters:
      getIdentityProviderRequest -
      Returns:
      A Java Future containing the result of the GetIdentityProvider operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getIdentityProvider

      default CompletableFuture<GetIdentityProviderResponse> getIdentityProvider(Consumer<GetIdentityProviderRequest.Builder> getIdentityProviderRequest)

      Gets the identity provider.


      This is a convenience which creates an instance of the GetIdentityProviderRequest.Builder avoiding the need to create one manually via GetIdentityProviderRequest.builder()

      Parameters:
      getIdentityProviderRequest - A Consumer that will call methods on GetIdentityProviderRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetIdentityProvider operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getIpAccessSettings

      default CompletableFuture<GetIpAccessSettingsResponse> getIpAccessSettings(GetIpAccessSettingsRequest getIpAccessSettingsRequest)

      Gets the IP access settings.

      Parameters:
      getIpAccessSettingsRequest -
      Returns:
      A Java Future containing the result of the GetIpAccessSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getIpAccessSettings

      default CompletableFuture<GetIpAccessSettingsResponse> getIpAccessSettings(Consumer<GetIpAccessSettingsRequest.Builder> getIpAccessSettingsRequest)

      Gets the IP access settings.


      This is a convenience which creates an instance of the GetIpAccessSettingsRequest.Builder avoiding the need to create one manually via GetIpAccessSettingsRequest.builder()

      Parameters:
      getIpAccessSettingsRequest - A Consumer that will call methods on GetIpAccessSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetIpAccessSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getNetworkSettings

      default CompletableFuture<GetNetworkSettingsResponse> getNetworkSettings(GetNetworkSettingsRequest getNetworkSettingsRequest)

      Gets the network settings.

      Parameters:
      getNetworkSettingsRequest -
      Returns:
      A Java Future containing the result of the GetNetworkSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getNetworkSettings

      default CompletableFuture<GetNetworkSettingsResponse> getNetworkSettings(Consumer<GetNetworkSettingsRequest.Builder> getNetworkSettingsRequest)

      Gets the network settings.


      This is a convenience which creates an instance of the GetNetworkSettingsRequest.Builder avoiding the need to create one manually via GetNetworkSettingsRequest.builder()

      Parameters:
      getNetworkSettingsRequest - A Consumer that will call methods on GetNetworkSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetNetworkSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getPortal

      default CompletableFuture<GetPortalResponse> getPortal(GetPortalRequest getPortalRequest)

      Gets the web portal.

      Parameters:
      getPortalRequest -
      Returns:
      A Java Future containing the result of the GetPortal operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getPortal

      default CompletableFuture<GetPortalResponse> getPortal(Consumer<GetPortalRequest.Builder> getPortalRequest)

      Gets the web portal.


      This is a convenience which creates an instance of the GetPortalRequest.Builder avoiding the need to create one manually via GetPortalRequest.builder()

      Parameters:
      getPortalRequest - A Consumer that will call methods on GetPortalRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetPortal operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getPortalServiceProviderMetadata

      default CompletableFuture<GetPortalServiceProviderMetadataResponse> getPortalServiceProviderMetadata(GetPortalServiceProviderMetadataRequest getPortalServiceProviderMetadataRequest)

      Gets the service provider metadata.

      Parameters:
      getPortalServiceProviderMetadataRequest -
      Returns:
      A Java Future containing the result of the GetPortalServiceProviderMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getPortalServiceProviderMetadata

      default CompletableFuture<GetPortalServiceProviderMetadataResponse> getPortalServiceProviderMetadata(Consumer<GetPortalServiceProviderMetadataRequest.Builder> getPortalServiceProviderMetadataRequest)

      Gets the service provider metadata.


      This is a convenience which creates an instance of the GetPortalServiceProviderMetadataRequest.Builder avoiding the need to create one manually via GetPortalServiceProviderMetadataRequest.builder()

      Parameters:
      getPortalServiceProviderMetadataRequest - A Consumer that will call methods on GetPortalServiceProviderMetadataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetPortalServiceProviderMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getTrustStore

      default CompletableFuture<GetTrustStoreResponse> getTrustStore(GetTrustStoreRequest getTrustStoreRequest)

      Gets the trust store.

      Parameters:
      getTrustStoreRequest -
      Returns:
      A Java Future containing the result of the GetTrustStore operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getTrustStore

      default CompletableFuture<GetTrustStoreResponse> getTrustStore(Consumer<GetTrustStoreRequest.Builder> getTrustStoreRequest)

      Gets the trust store.


      This is a convenience which creates an instance of the GetTrustStoreRequest.Builder avoiding the need to create one manually via GetTrustStoreRequest.builder()

      Parameters:
      getTrustStoreRequest - A Consumer that will call methods on GetTrustStoreRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetTrustStore operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getTrustStoreCertificate

      default CompletableFuture<GetTrustStoreCertificateResponse> getTrustStoreCertificate(GetTrustStoreCertificateRequest getTrustStoreCertificateRequest)

      Gets the trust store certificate.

      Parameters:
      getTrustStoreCertificateRequest -
      Returns:
      A Java Future containing the result of the GetTrustStoreCertificate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getTrustStoreCertificate

      default CompletableFuture<GetTrustStoreCertificateResponse> getTrustStoreCertificate(Consumer<GetTrustStoreCertificateRequest.Builder> getTrustStoreCertificateRequest)

      Gets the trust store certificate.


      This is a convenience which creates an instance of the GetTrustStoreCertificateRequest.Builder avoiding the need to create one manually via GetTrustStoreCertificateRequest.builder()

      Parameters:
      getTrustStoreCertificateRequest - A Consumer that will call methods on GetTrustStoreCertificateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetTrustStoreCertificate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getUserAccessLoggingSettings

      default CompletableFuture<GetUserAccessLoggingSettingsResponse> getUserAccessLoggingSettings(GetUserAccessLoggingSettingsRequest getUserAccessLoggingSettingsRequest)

      Gets user access logging settings.

      Parameters:
      getUserAccessLoggingSettingsRequest -
      Returns:
      A Java Future containing the result of the GetUserAccessLoggingSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getUserAccessLoggingSettings

      default CompletableFuture<GetUserAccessLoggingSettingsResponse> getUserAccessLoggingSettings(Consumer<GetUserAccessLoggingSettingsRequest.Builder> getUserAccessLoggingSettingsRequest)

      Gets user access logging settings.


      This is a convenience which creates an instance of the GetUserAccessLoggingSettingsRequest.Builder avoiding the need to create one manually via GetUserAccessLoggingSettingsRequest.builder()

      Parameters:
      getUserAccessLoggingSettingsRequest - A Consumer that will call methods on GetUserAccessLoggingSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetUserAccessLoggingSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getUserSettings

      default CompletableFuture<GetUserSettingsResponse> getUserSettings(GetUserSettingsRequest getUserSettingsRequest)

      Gets user settings.

      Parameters:
      getUserSettingsRequest -
      Returns:
      A Java Future containing the result of the GetUserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getUserSettings

      default CompletableFuture<GetUserSettingsResponse> getUserSettings(Consumer<GetUserSettingsRequest.Builder> getUserSettingsRequest)

      Gets user settings.


      This is a convenience which creates an instance of the GetUserSettingsRequest.Builder avoiding the need to create one manually via GetUserSettingsRequest.builder()

      Parameters:
      getUserSettingsRequest - A Consumer that will call methods on GetUserSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetUserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listBrowserSettings

      default CompletableFuture<ListBrowserSettingsResponse> listBrowserSettings(ListBrowserSettingsRequest listBrowserSettingsRequest)

      Retrieves a list of browser settings.

      Parameters:
      listBrowserSettingsRequest -
      Returns:
      A Java Future containing the result of the ListBrowserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listBrowserSettings

      default CompletableFuture<ListBrowserSettingsResponse> listBrowserSettings(Consumer<ListBrowserSettingsRequest.Builder> listBrowserSettingsRequest)

      Retrieves a list of browser settings.


      This is a convenience which creates an instance of the ListBrowserSettingsRequest.Builder avoiding the need to create one manually via ListBrowserSettingsRequest.builder()

      Parameters:
      listBrowserSettingsRequest - A Consumer that will call methods on ListBrowserSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListBrowserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listBrowserSettingsPaginator

      default ListBrowserSettingsPublisher listBrowserSettingsPaginator(ListBrowserSettingsRequest listBrowserSettingsRequest)

      This is a variant of listBrowserSettings(software.amazon.awssdk.services.workspacesweb.model.ListBrowserSettingsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListBrowserSettingsPublisher publisher = client.listBrowserSettingsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListBrowserSettingsPublisher publisher = client.listBrowserSettingsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspacesweb.model.ListBrowserSettingsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workspacesweb.model.ListBrowserSettingsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listBrowserSettings(software.amazon.awssdk.services.workspacesweb.model.ListBrowserSettingsRequest) operation.

      Parameters:
      listBrowserSettingsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listBrowserSettingsPaginator

      default ListBrowserSettingsPublisher listBrowserSettingsPaginator(Consumer<ListBrowserSettingsRequest.Builder> listBrowserSettingsRequest)

      This is a variant of listBrowserSettings(software.amazon.awssdk.services.workspacesweb.model.ListBrowserSettingsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListBrowserSettingsPublisher publisher = client.listBrowserSettingsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListBrowserSettingsPublisher publisher = client.listBrowserSettingsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspacesweb.model.ListBrowserSettingsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workspacesweb.model.ListBrowserSettingsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listBrowserSettings(software.amazon.awssdk.services.workspacesweb.model.ListBrowserSettingsRequest) operation.


      This is a convenience which creates an instance of the ListBrowserSettingsRequest.Builder avoiding the need to create one manually via ListBrowserSettingsRequest.builder()

      Parameters:
      listBrowserSettingsRequest - A Consumer that will call methods on ListBrowserSettingsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listIdentityProviders

      default CompletableFuture<ListIdentityProvidersResponse> listIdentityProviders(ListIdentityProvidersRequest listIdentityProvidersRequest)

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

      Parameters:
      listIdentityProvidersRequest -
      Returns:
      A Java Future containing the result of the ListIdentityProviders operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listIdentityProviders

      default CompletableFuture<ListIdentityProvidersResponse> listIdentityProviders(Consumer<ListIdentityProvidersRequest.Builder> listIdentityProvidersRequest)

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


      This is a convenience which creates an instance of the ListIdentityProvidersRequest.Builder avoiding the need to create one manually via ListIdentityProvidersRequest.builder()

      Parameters:
      listIdentityProvidersRequest - A Consumer that will call methods on ListIdentityProvidersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListIdentityProviders operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listIdentityProvidersPaginator

      default ListIdentityProvidersPublisher listIdentityProvidersPaginator(ListIdentityProvidersRequest listIdentityProvidersRequest)

      This is a variant of listIdentityProviders(software.amazon.awssdk.services.workspacesweb.model.ListIdentityProvidersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListIdentityProvidersPublisher publisher = client.listIdentityProvidersPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListIdentityProvidersPublisher publisher = client.listIdentityProvidersPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspacesweb.model.ListIdentityProvidersResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workspacesweb.model.ListIdentityProvidersResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listIdentityProviders(software.amazon.awssdk.services.workspacesweb.model.ListIdentityProvidersRequest) operation.

      Parameters:
      listIdentityProvidersRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listIdentityProvidersPaginator

      default ListIdentityProvidersPublisher listIdentityProvidersPaginator(Consumer<ListIdentityProvidersRequest.Builder> listIdentityProvidersRequest)

      This is a variant of listIdentityProviders(software.amazon.awssdk.services.workspacesweb.model.ListIdentityProvidersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListIdentityProvidersPublisher publisher = client.listIdentityProvidersPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListIdentityProvidersPublisher publisher = client.listIdentityProvidersPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspacesweb.model.ListIdentityProvidersResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workspacesweb.model.ListIdentityProvidersResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listIdentityProviders(software.amazon.awssdk.services.workspacesweb.model.ListIdentityProvidersRequest) operation.


      This is a convenience which creates an instance of the ListIdentityProvidersRequest.Builder avoiding the need to create one manually via ListIdentityProvidersRequest.builder()

      Parameters:
      listIdentityProvidersRequest - A Consumer that will call methods on ListIdentityProvidersRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listIpAccessSettings

      default CompletableFuture<ListIpAccessSettingsResponse> listIpAccessSettings(ListIpAccessSettingsRequest listIpAccessSettingsRequest)

      Retrieves a list of IP access settings.

      Parameters:
      listIpAccessSettingsRequest -
      Returns:
      A Java Future containing the result of the ListIpAccessSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listIpAccessSettings

      default CompletableFuture<ListIpAccessSettingsResponse> listIpAccessSettings(Consumer<ListIpAccessSettingsRequest.Builder> listIpAccessSettingsRequest)

      Retrieves a list of IP access settings.


      This is a convenience which creates an instance of the ListIpAccessSettingsRequest.Builder avoiding the need to create one manually via ListIpAccessSettingsRequest.builder()

      Parameters:
      listIpAccessSettingsRequest - A Consumer that will call methods on ListIpAccessSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListIpAccessSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listIpAccessSettingsPaginator

      default ListIpAccessSettingsPublisher listIpAccessSettingsPaginator(ListIpAccessSettingsRequest listIpAccessSettingsRequest)

      This is a variant of listIpAccessSettings(software.amazon.awssdk.services.workspacesweb.model.ListIpAccessSettingsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListIpAccessSettingsPublisher publisher = client.listIpAccessSettingsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListIpAccessSettingsPublisher publisher = client.listIpAccessSettingsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspacesweb.model.ListIpAccessSettingsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workspacesweb.model.ListIpAccessSettingsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listIpAccessSettings(software.amazon.awssdk.services.workspacesweb.model.ListIpAccessSettingsRequest) operation.

      Parameters:
      listIpAccessSettingsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listIpAccessSettingsPaginator

      default ListIpAccessSettingsPublisher listIpAccessSettingsPaginator(Consumer<ListIpAccessSettingsRequest.Builder> listIpAccessSettingsRequest)

      This is a variant of listIpAccessSettings(software.amazon.awssdk.services.workspacesweb.model.ListIpAccessSettingsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListIpAccessSettingsPublisher publisher = client.listIpAccessSettingsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListIpAccessSettingsPublisher publisher = client.listIpAccessSettingsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspacesweb.model.ListIpAccessSettingsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workspacesweb.model.ListIpAccessSettingsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listIpAccessSettings(software.amazon.awssdk.services.workspacesweb.model.ListIpAccessSettingsRequest) operation.


      This is a convenience which creates an instance of the ListIpAccessSettingsRequest.Builder avoiding the need to create one manually via ListIpAccessSettingsRequest.builder()

      Parameters:
      listIpAccessSettingsRequest - A Consumer that will call methods on ListIpAccessSettingsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listNetworkSettings

      default CompletableFuture<ListNetworkSettingsResponse> listNetworkSettings(ListNetworkSettingsRequest listNetworkSettingsRequest)

      Retrieves a list of network settings.

      Parameters:
      listNetworkSettingsRequest -
      Returns:
      A Java Future containing the result of the ListNetworkSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listNetworkSettings

      default CompletableFuture<ListNetworkSettingsResponse> listNetworkSettings(Consumer<ListNetworkSettingsRequest.Builder> listNetworkSettingsRequest)

      Retrieves a list of network settings.


      This is a convenience which creates an instance of the ListNetworkSettingsRequest.Builder avoiding the need to create one manually via ListNetworkSettingsRequest.builder()

      Parameters:
      listNetworkSettingsRequest - A Consumer that will call methods on ListNetworkSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListNetworkSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listNetworkSettingsPaginator

      default ListNetworkSettingsPublisher listNetworkSettingsPaginator(ListNetworkSettingsRequest listNetworkSettingsRequest)

      This is a variant of listNetworkSettings(software.amazon.awssdk.services.workspacesweb.model.ListNetworkSettingsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListNetworkSettingsPublisher publisher = client.listNetworkSettingsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListNetworkSettingsPublisher publisher = client.listNetworkSettingsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspacesweb.model.ListNetworkSettingsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workspacesweb.model.ListNetworkSettingsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listNetworkSettings(software.amazon.awssdk.services.workspacesweb.model.ListNetworkSettingsRequest) operation.

      Parameters:
      listNetworkSettingsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listNetworkSettingsPaginator

      default ListNetworkSettingsPublisher listNetworkSettingsPaginator(Consumer<ListNetworkSettingsRequest.Builder> listNetworkSettingsRequest)

      This is a variant of listNetworkSettings(software.amazon.awssdk.services.workspacesweb.model.ListNetworkSettingsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListNetworkSettingsPublisher publisher = client.listNetworkSettingsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListNetworkSettingsPublisher publisher = client.listNetworkSettingsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspacesweb.model.ListNetworkSettingsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workspacesweb.model.ListNetworkSettingsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listNetworkSettings(software.amazon.awssdk.services.workspacesweb.model.ListNetworkSettingsRequest) operation.


      This is a convenience which creates an instance of the ListNetworkSettingsRequest.Builder avoiding the need to create one manually via ListNetworkSettingsRequest.builder()

      Parameters:
      listNetworkSettingsRequest - A Consumer that will call methods on ListNetworkSettingsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listPortals

      default CompletableFuture<ListPortalsResponse> listPortals(ListPortalsRequest listPortalsRequest)

      Retrieves a list or web portals.

      Parameters:
      listPortalsRequest -
      Returns:
      A Java Future containing the result of the ListPortals operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listPortals

      default CompletableFuture<ListPortalsResponse> listPortals(Consumer<ListPortalsRequest.Builder> listPortalsRequest)

      Retrieves a list or web portals.


      This is a convenience which creates an instance of the ListPortalsRequest.Builder avoiding the need to create one manually via ListPortalsRequest.builder()

      Parameters:
      listPortalsRequest - A Consumer that will call methods on ListPortalsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListPortals operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listPortalsPaginator

      default ListPortalsPublisher listPortalsPaginator(ListPortalsRequest listPortalsRequest)

      This is a variant of listPortals(software.amazon.awssdk.services.workspacesweb.model.ListPortalsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListPortalsPublisher publisher = client.listPortalsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListPortalsPublisher publisher = client.listPortalsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspacesweb.model.ListPortalsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workspacesweb.model.ListPortalsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listPortals(software.amazon.awssdk.services.workspacesweb.model.ListPortalsRequest) operation.

      Parameters:
      listPortalsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listPortalsPaginator

      default ListPortalsPublisher listPortalsPaginator(Consumer<ListPortalsRequest.Builder> listPortalsRequest)

      This is a variant of listPortals(software.amazon.awssdk.services.workspacesweb.model.ListPortalsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListPortalsPublisher publisher = client.listPortalsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListPortalsPublisher publisher = client.listPortalsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspacesweb.model.ListPortalsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workspacesweb.model.ListPortalsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listPortals(software.amazon.awssdk.services.workspacesweb.model.ListPortalsRequest) operation.


      This is a convenience which creates an instance of the ListPortalsRequest.Builder avoiding the need to create one manually via ListPortalsRequest.builder()

      Parameters:
      listPortalsRequest - A Consumer that will call methods on ListPortalsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Retrieves a list of tags for a resource.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Retrieves a list of tags for a resource.


      This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listTrustStoreCertificates

      default CompletableFuture<ListTrustStoreCertificatesResponse> listTrustStoreCertificates(ListTrustStoreCertificatesRequest listTrustStoreCertificatesRequest)

      Retrieves a list of trust store certificates.

      Parameters:
      listTrustStoreCertificatesRequest -
      Returns:
      A Java Future containing the result of the ListTrustStoreCertificates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listTrustStoreCertificates

      default CompletableFuture<ListTrustStoreCertificatesResponse> listTrustStoreCertificates(Consumer<ListTrustStoreCertificatesRequest.Builder> listTrustStoreCertificatesRequest)

      Retrieves a list of trust store certificates.


      This is a convenience which creates an instance of the ListTrustStoreCertificatesRequest.Builder avoiding the need to create one manually via ListTrustStoreCertificatesRequest.builder()

      Parameters:
      listTrustStoreCertificatesRequest - A Consumer that will call methods on ListTrustStoreCertificatesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTrustStoreCertificates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listTrustStoreCertificatesPaginator

      default ListTrustStoreCertificatesPublisher listTrustStoreCertificatesPaginator(ListTrustStoreCertificatesRequest listTrustStoreCertificatesRequest)

      This is a variant of listTrustStoreCertificates(software.amazon.awssdk.services.workspacesweb.model.ListTrustStoreCertificatesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListTrustStoreCertificatesPublisher publisher = client.listTrustStoreCertificatesPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListTrustStoreCertificatesPublisher publisher = client.listTrustStoreCertificatesPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspacesweb.model.ListTrustStoreCertificatesResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workspacesweb.model.ListTrustStoreCertificatesResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTrustStoreCertificates(software.amazon.awssdk.services.workspacesweb.model.ListTrustStoreCertificatesRequest) operation.

      Parameters:
      listTrustStoreCertificatesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listTrustStoreCertificatesPaginator

      default ListTrustStoreCertificatesPublisher listTrustStoreCertificatesPaginator(Consumer<ListTrustStoreCertificatesRequest.Builder> listTrustStoreCertificatesRequest)

      This is a variant of listTrustStoreCertificates(software.amazon.awssdk.services.workspacesweb.model.ListTrustStoreCertificatesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListTrustStoreCertificatesPublisher publisher = client.listTrustStoreCertificatesPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListTrustStoreCertificatesPublisher publisher = client.listTrustStoreCertificatesPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspacesweb.model.ListTrustStoreCertificatesResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workspacesweb.model.ListTrustStoreCertificatesResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTrustStoreCertificates(software.amazon.awssdk.services.workspacesweb.model.ListTrustStoreCertificatesRequest) operation.


      This is a convenience which creates an instance of the ListTrustStoreCertificatesRequest.Builder avoiding the need to create one manually via ListTrustStoreCertificatesRequest.builder()

      Parameters:
      listTrustStoreCertificatesRequest - A Consumer that will call methods on ListTrustStoreCertificatesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listTrustStores

      default CompletableFuture<ListTrustStoresResponse> listTrustStores(ListTrustStoresRequest listTrustStoresRequest)

      Retrieves a list of trust stores.

      Parameters:
      listTrustStoresRequest -
      Returns:
      A Java Future containing the result of the ListTrustStores operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listTrustStores

      default CompletableFuture<ListTrustStoresResponse> listTrustStores(Consumer<ListTrustStoresRequest.Builder> listTrustStoresRequest)

      Retrieves a list of trust stores.


      This is a convenience which creates an instance of the ListTrustStoresRequest.Builder avoiding the need to create one manually via ListTrustStoresRequest.builder()

      Parameters:
      listTrustStoresRequest - A Consumer that will call methods on ListTrustStoresRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTrustStores operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listTrustStoresPaginator

      default ListTrustStoresPublisher listTrustStoresPaginator(ListTrustStoresRequest listTrustStoresRequest)

      This is a variant of listTrustStores(software.amazon.awssdk.services.workspacesweb.model.ListTrustStoresRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListTrustStoresPublisher publisher = client.listTrustStoresPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListTrustStoresPublisher publisher = client.listTrustStoresPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspacesweb.model.ListTrustStoresResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workspacesweb.model.ListTrustStoresResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTrustStores(software.amazon.awssdk.services.workspacesweb.model.ListTrustStoresRequest) operation.

      Parameters:
      listTrustStoresRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listTrustStoresPaginator

      default ListTrustStoresPublisher listTrustStoresPaginator(Consumer<ListTrustStoresRequest.Builder> listTrustStoresRequest)

      This is a variant of listTrustStores(software.amazon.awssdk.services.workspacesweb.model.ListTrustStoresRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListTrustStoresPublisher publisher = client.listTrustStoresPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListTrustStoresPublisher publisher = client.listTrustStoresPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspacesweb.model.ListTrustStoresResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workspacesweb.model.ListTrustStoresResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTrustStores(software.amazon.awssdk.services.workspacesweb.model.ListTrustStoresRequest) operation.


      This is a convenience which creates an instance of the ListTrustStoresRequest.Builder avoiding the need to create one manually via ListTrustStoresRequest.builder()

      Parameters:
      listTrustStoresRequest - A Consumer that will call methods on ListTrustStoresRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listUserAccessLoggingSettings

      default CompletableFuture<ListUserAccessLoggingSettingsResponse> listUserAccessLoggingSettings(ListUserAccessLoggingSettingsRequest listUserAccessLoggingSettingsRequest)

      Retrieves a list of user access logging settings.

      Parameters:
      listUserAccessLoggingSettingsRequest -
      Returns:
      A Java Future containing the result of the ListUserAccessLoggingSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listUserAccessLoggingSettings

      default CompletableFuture<ListUserAccessLoggingSettingsResponse> listUserAccessLoggingSettings(Consumer<ListUserAccessLoggingSettingsRequest.Builder> listUserAccessLoggingSettingsRequest)

      Retrieves a list of user access logging settings.


      This is a convenience which creates an instance of the ListUserAccessLoggingSettingsRequest.Builder avoiding the need to create one manually via ListUserAccessLoggingSettingsRequest.builder()

      Parameters:
      listUserAccessLoggingSettingsRequest - A Consumer that will call methods on ListUserAccessLoggingSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListUserAccessLoggingSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listUserAccessLoggingSettingsPaginator

      default ListUserAccessLoggingSettingsPublisher listUserAccessLoggingSettingsPaginator(ListUserAccessLoggingSettingsRequest listUserAccessLoggingSettingsRequest)

      This is a variant of listUserAccessLoggingSettings(software.amazon.awssdk.services.workspacesweb.model.ListUserAccessLoggingSettingsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListUserAccessLoggingSettingsPublisher publisher = client.listUserAccessLoggingSettingsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListUserAccessLoggingSettingsPublisher publisher = client.listUserAccessLoggingSettingsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspacesweb.model.ListUserAccessLoggingSettingsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workspacesweb.model.ListUserAccessLoggingSettingsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listUserAccessLoggingSettings(software.amazon.awssdk.services.workspacesweb.model.ListUserAccessLoggingSettingsRequest) operation.

      Parameters:
      listUserAccessLoggingSettingsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listUserAccessLoggingSettingsPaginator

      default ListUserAccessLoggingSettingsPublisher listUserAccessLoggingSettingsPaginator(Consumer<ListUserAccessLoggingSettingsRequest.Builder> listUserAccessLoggingSettingsRequest)

      This is a variant of listUserAccessLoggingSettings(software.amazon.awssdk.services.workspacesweb.model.ListUserAccessLoggingSettingsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListUserAccessLoggingSettingsPublisher publisher = client.listUserAccessLoggingSettingsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListUserAccessLoggingSettingsPublisher publisher = client.listUserAccessLoggingSettingsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspacesweb.model.ListUserAccessLoggingSettingsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workspacesweb.model.ListUserAccessLoggingSettingsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listUserAccessLoggingSettings(software.amazon.awssdk.services.workspacesweb.model.ListUserAccessLoggingSettingsRequest) operation.


      This is a convenience which creates an instance of the ListUserAccessLoggingSettingsRequest.Builder avoiding the need to create one manually via ListUserAccessLoggingSettingsRequest.builder()

      Parameters:
      listUserAccessLoggingSettingsRequest - A Consumer that will call methods on ListUserAccessLoggingSettingsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listUserSettings

      default CompletableFuture<ListUserSettingsResponse> listUserSettings(ListUserSettingsRequest listUserSettingsRequest)

      Retrieves a list of user settings.

      Parameters:
      listUserSettingsRequest -
      Returns:
      A Java Future containing the result of the ListUserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listUserSettings

      default CompletableFuture<ListUserSettingsResponse> listUserSettings(Consumer<ListUserSettingsRequest.Builder> listUserSettingsRequest)

      Retrieves a list of user settings.


      This is a convenience which creates an instance of the ListUserSettingsRequest.Builder avoiding the need to create one manually via ListUserSettingsRequest.builder()

      Parameters:
      listUserSettingsRequest - A Consumer that will call methods on ListUserSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListUserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listUserSettingsPaginator

      default ListUserSettingsPublisher listUserSettingsPaginator(ListUserSettingsRequest listUserSettingsRequest)

      This is a variant of listUserSettings(software.amazon.awssdk.services.workspacesweb.model.ListUserSettingsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListUserSettingsPublisher publisher = client.listUserSettingsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListUserSettingsPublisher publisher = client.listUserSettingsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspacesweb.model.ListUserSettingsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workspacesweb.model.ListUserSettingsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listUserSettings(software.amazon.awssdk.services.workspacesweb.model.ListUserSettingsRequest) operation.

      Parameters:
      listUserSettingsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listUserSettingsPaginator

      default ListUserSettingsPublisher listUserSettingsPaginator(Consumer<ListUserSettingsRequest.Builder> listUserSettingsRequest)

      This is a variant of listUserSettings(software.amazon.awssdk.services.workspacesweb.model.ListUserSettingsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListUserSettingsPublisher publisher = client.listUserSettingsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workspacesweb.paginators.ListUserSettingsPublisher publisher = client.listUserSettingsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspacesweb.model.ListUserSettingsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workspacesweb.model.ListUserSettingsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listUserSettings(software.amazon.awssdk.services.workspacesweb.model.ListUserSettingsRequest) operation.


      This is a convenience which creates an instance of the ListUserSettingsRequest.Builder avoiding the need to create one manually via ListUserSettingsRequest.builder()

      Parameters:
      listUserSettingsRequest - A Consumer that will call methods on ListUserSettingsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException There is an internal server error.
      • AccessDeniedException Access is denied.
      • ThrottlingException There is a throttling error.
      • ValidationException There is a validation error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

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

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

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


      This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes one or more tags from the specified resource.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      Removes one or more tags from the specified resource.


      This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateBrowserSettings

      default CompletableFuture<UpdateBrowserSettingsResponse> updateBrowserSettings(UpdateBrowserSettingsRequest updateBrowserSettingsRequest)

      Updates browser settings.

      Parameters:
      updateBrowserSettingsRequest -
      Returns:
      A Java Future containing the result of the UpdateBrowserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateBrowserSettings

      default CompletableFuture<UpdateBrowserSettingsResponse> updateBrowserSettings(Consumer<UpdateBrowserSettingsRequest.Builder> updateBrowserSettingsRequest)

      Updates browser settings.


      This is a convenience which creates an instance of the UpdateBrowserSettingsRequest.Builder avoiding the need to create one manually via UpdateBrowserSettingsRequest.builder()

      Parameters:
      updateBrowserSettingsRequest - A Consumer that will call methods on UpdateBrowserSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateBrowserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateIdentityProvider

      default CompletableFuture<UpdateIdentityProviderResponse> updateIdentityProvider(UpdateIdentityProviderRequest updateIdentityProviderRequest)

      Updates the identity provider.

      Parameters:
      updateIdentityProviderRequest -
      Returns:
      A Java Future containing the result of the UpdateIdentityProvider operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateIdentityProvider

      default CompletableFuture<UpdateIdentityProviderResponse> updateIdentityProvider(Consumer<UpdateIdentityProviderRequest.Builder> updateIdentityProviderRequest)

      Updates the identity provider.


      This is a convenience which creates an instance of the UpdateIdentityProviderRequest.Builder avoiding the need to create one manually via UpdateIdentityProviderRequest.builder()

      Parameters:
      updateIdentityProviderRequest - A Consumer that will call methods on UpdateIdentityProviderRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateIdentityProvider operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateIpAccessSettings

      default CompletableFuture<UpdateIpAccessSettingsResponse> updateIpAccessSettings(UpdateIpAccessSettingsRequest updateIpAccessSettingsRequest)

      Updates IP access settings.

      Parameters:
      updateIpAccessSettingsRequest -
      Returns:
      A Java Future containing the result of the UpdateIpAccessSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateIpAccessSettings

      default CompletableFuture<UpdateIpAccessSettingsResponse> updateIpAccessSettings(Consumer<UpdateIpAccessSettingsRequest.Builder> updateIpAccessSettingsRequest)

      Updates IP access settings.


      This is a convenience which creates an instance of the UpdateIpAccessSettingsRequest.Builder avoiding the need to create one manually via UpdateIpAccessSettingsRequest.builder()

      Parameters:
      updateIpAccessSettingsRequest - A Consumer that will call methods on UpdateIpAccessSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateIpAccessSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateNetworkSettings

      default CompletableFuture<UpdateNetworkSettingsResponse> updateNetworkSettings(UpdateNetworkSettingsRequest updateNetworkSettingsRequest)

      Updates network settings.

      Parameters:
      updateNetworkSettingsRequest -
      Returns:
      A Java Future containing the result of the UpdateNetworkSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateNetworkSettings

      default CompletableFuture<UpdateNetworkSettingsResponse> updateNetworkSettings(Consumer<UpdateNetworkSettingsRequest.Builder> updateNetworkSettingsRequest)

      Updates network settings.


      This is a convenience which creates an instance of the UpdateNetworkSettingsRequest.Builder avoiding the need to create one manually via UpdateNetworkSettingsRequest.builder()

      Parameters:
      updateNetworkSettingsRequest - A Consumer that will call methods on UpdateNetworkSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateNetworkSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updatePortal

      default CompletableFuture<UpdatePortalResponse> updatePortal(UpdatePortalRequest updatePortalRequest)

      Updates a web portal.

      Parameters:
      updatePortalRequest -
      Returns:
      A Java Future containing the result of the UpdatePortal operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updatePortal

      default CompletableFuture<UpdatePortalResponse> updatePortal(Consumer<UpdatePortalRequest.Builder> updatePortalRequest)

      Updates a web portal.


      This is a convenience which creates an instance of the UpdatePortalRequest.Builder avoiding the need to create one manually via UpdatePortalRequest.builder()

      Parameters:
      updatePortalRequest - A Consumer that will call methods on UpdatePortalRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdatePortal operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateTrustStore

      default CompletableFuture<UpdateTrustStoreResponse> updateTrustStore(UpdateTrustStoreRequest updateTrustStoreRequest)

      Updates the trust store.

      Parameters:
      updateTrustStoreRequest -
      Returns:
      A Java Future containing the result of the UpdateTrustStore operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateTrustStore

      default CompletableFuture<UpdateTrustStoreResponse> updateTrustStore(Consumer<UpdateTrustStoreRequest.Builder> updateTrustStoreRequest)

      Updates the trust store.


      This is a convenience which creates an instance of the UpdateTrustStoreRequest.Builder avoiding the need to create one manually via UpdateTrustStoreRequest.builder()

      Parameters:
      updateTrustStoreRequest - A Consumer that will call methods on UpdateTrustStoreRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateTrustStore operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateUserAccessLoggingSettings

      default CompletableFuture<UpdateUserAccessLoggingSettingsResponse> updateUserAccessLoggingSettings(UpdateUserAccessLoggingSettingsRequest updateUserAccessLoggingSettingsRequest)

      Updates the user access logging settings.

      Parameters:
      updateUserAccessLoggingSettingsRequest -
      Returns:
      A Java Future containing the result of the UpdateUserAccessLoggingSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateUserAccessLoggingSettings

      default CompletableFuture<UpdateUserAccessLoggingSettingsResponse> updateUserAccessLoggingSettings(Consumer<UpdateUserAccessLoggingSettingsRequest.Builder> updateUserAccessLoggingSettingsRequest)

      Updates the user access logging settings.


      This is a convenience which creates an instance of the UpdateUserAccessLoggingSettingsRequest.Builder avoiding the need to create one manually via UpdateUserAccessLoggingSettingsRequest.builder()

      Parameters:
      updateUserAccessLoggingSettingsRequest - A Consumer that will call methods on UpdateUserAccessLoggingSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateUserAccessLoggingSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateUserSettings

      default CompletableFuture<UpdateUserSettingsResponse> updateUserSettings(UpdateUserSettingsRequest updateUserSettingsRequest)

      Updates the user settings.

      Parameters:
      updateUserSettingsRequest -
      Returns:
      A Java Future containing the result of the UpdateUserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateUserSettings

      default CompletableFuture<UpdateUserSettingsResponse> updateUserSettings(Consumer<UpdateUserSettingsRequest.Builder> updateUserSettingsRequest)

      Updates the user settings.


      This is a convenience which creates an instance of the UpdateUserSettingsRequest.Builder avoiding the need to create one manually via UpdateUserSettingsRequest.builder()

      Parameters:
      updateUserSettingsRequest - A Consumer that will call methods on UpdateUserSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateUserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkSpacesWebException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • serviceClientConfiguration

      default WorkSpacesWebServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration
    • create

      static WorkSpacesWebAsyncClient create()
      Create a WorkSpacesWebAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
    • builder

      Create a builder that can be used to configure and create a WorkSpacesWebAsyncClient.