Interface WorkSpacesWebAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
WorkSpaces Web is a low cost, fully managed WorkSpace built specifically to facilitate secure, web-based workloads. WorkSpaces Web makes it easy for customers to safely provide their employees with access to internal websites and SaaS web applications without the administrative burden of appliances or specialized client software. WorkSpaces Web provides simple policy tools tailored for user interactions, while offloading common tasks like capacity management, scaling, and maintaining browser images.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionassociateBrowserSettings
(Consumer<AssociateBrowserSettingsRequest.Builder> associateBrowserSettingsRequest) Associates a browser settings resource with a web portal.associateBrowserSettings
(AssociateBrowserSettingsRequest associateBrowserSettingsRequest) Associates a browser settings resource with a web portal.associateIpAccessSettings
(Consumer<AssociateIpAccessSettingsRequest.Builder> associateIpAccessSettingsRequest) Associates an IP access settings resource with a web portal.associateIpAccessSettings
(AssociateIpAccessSettingsRequest associateIpAccessSettingsRequest) Associates an IP access settings resource with a web portal.associateNetworkSettings
(Consumer<AssociateNetworkSettingsRequest.Builder> associateNetworkSettingsRequest) Associates a network settings resource with a web portal.associateNetworkSettings
(AssociateNetworkSettingsRequest associateNetworkSettingsRequest) Associates a network settings resource with a web portal.associateTrustStore
(Consumer<AssociateTrustStoreRequest.Builder> associateTrustStoreRequest) Associates a trust store with a web portal.associateTrustStore
(AssociateTrustStoreRequest associateTrustStoreRequest) Associates a trust store with a web portal.associateUserAccessLoggingSettings
(Consumer<AssociateUserAccessLoggingSettingsRequest.Builder> associateUserAccessLoggingSettingsRequest) Associates a user access logging settings resource with a web portal.associateUserAccessLoggingSettings
(AssociateUserAccessLoggingSettingsRequest associateUserAccessLoggingSettingsRequest) Associates a user access logging settings resource with a web portal.associateUserSettings
(Consumer<AssociateUserSettingsRequest.Builder> associateUserSettingsRequest) Associates a user settings resource with a web portal.associateUserSettings
(AssociateUserSettingsRequest associateUserSettingsRequest) Associates a user settings resource with a web portal.builder()
Create a builder that can be used to configure and create aWorkSpacesWebAsyncClient
.static WorkSpacesWebAsyncClient
create()
Create aWorkSpacesWebAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createBrowserSettings
(Consumer<CreateBrowserSettingsRequest.Builder> createBrowserSettingsRequest) Creates a browser settings resource that can be associated with a web portal.createBrowserSettings
(CreateBrowserSettingsRequest createBrowserSettingsRequest) Creates a browser settings resource that can be associated with a web portal.createIdentityProvider
(Consumer<CreateIdentityProviderRequest.Builder> createIdentityProviderRequest) Creates an identity provider resource that is then associated with a web portal.createIdentityProvider
(CreateIdentityProviderRequest createIdentityProviderRequest) Creates an identity provider resource that is then associated with a web portal.createIpAccessSettings
(Consumer<CreateIpAccessSettingsRequest.Builder> createIpAccessSettingsRequest) Creates an IP access settings resource that can be associated with a web portal.createIpAccessSettings
(CreateIpAccessSettingsRequest createIpAccessSettingsRequest) Creates an IP access settings resource that can be associated with a web portal.createNetworkSettings
(Consumer<CreateNetworkSettingsRequest.Builder> createNetworkSettingsRequest) Creates a network settings resource that can be associated with a web portal.createNetworkSettings
(CreateNetworkSettingsRequest createNetworkSettingsRequest) Creates a network settings resource that can be associated with a web portal.default CompletableFuture
<CreatePortalResponse> createPortal
(Consumer<CreatePortalRequest.Builder> createPortalRequest) Creates a web portal.default CompletableFuture
<CreatePortalResponse> createPortal
(CreatePortalRequest createPortalRequest) Creates a web portal.createTrustStore
(Consumer<CreateTrustStoreRequest.Builder> createTrustStoreRequest) Creates a trust store that can be associated with a web portal.createTrustStore
(CreateTrustStoreRequest createTrustStoreRequest) Creates a trust store that can be associated with a web portal.createUserAccessLoggingSettings
(Consumer<CreateUserAccessLoggingSettingsRequest.Builder> createUserAccessLoggingSettingsRequest) Creates a user access logging settings resource that can be associated with a web portal.createUserAccessLoggingSettings
(CreateUserAccessLoggingSettingsRequest createUserAccessLoggingSettingsRequest) Creates a user access logging settings resource that can be associated with a web portal.createUserSettings
(Consumer<CreateUserSettingsRequest.Builder> createUserSettingsRequest) Creates a user settings resource that can be associated with a web portal.createUserSettings
(CreateUserSettingsRequest createUserSettingsRequest) Creates a user settings resource that can be associated with a web portal.deleteBrowserSettings
(Consumer<DeleteBrowserSettingsRequest.Builder> deleteBrowserSettingsRequest) Deletes browser settings.deleteBrowserSettings
(DeleteBrowserSettingsRequest deleteBrowserSettingsRequest) Deletes browser settings.deleteIdentityProvider
(Consumer<DeleteIdentityProviderRequest.Builder> deleteIdentityProviderRequest) Deletes the identity provider.deleteIdentityProvider
(DeleteIdentityProviderRequest deleteIdentityProviderRequest) Deletes the identity provider.deleteIpAccessSettings
(Consumer<DeleteIpAccessSettingsRequest.Builder> deleteIpAccessSettingsRequest) Deletes IP access settings.deleteIpAccessSettings
(DeleteIpAccessSettingsRequest deleteIpAccessSettingsRequest) Deletes IP access settings.deleteNetworkSettings
(Consumer<DeleteNetworkSettingsRequest.Builder> deleteNetworkSettingsRequest) Deletes network settings.deleteNetworkSettings
(DeleteNetworkSettingsRequest deleteNetworkSettingsRequest) Deletes network settings.default CompletableFuture
<DeletePortalResponse> deletePortal
(Consumer<DeletePortalRequest.Builder> deletePortalRequest) Deletes a web portal.default CompletableFuture
<DeletePortalResponse> deletePortal
(DeletePortalRequest deletePortalRequest) Deletes a web portal.deleteTrustStore
(Consumer<DeleteTrustStoreRequest.Builder> deleteTrustStoreRequest) Deletes the trust store.deleteTrustStore
(DeleteTrustStoreRequest deleteTrustStoreRequest) Deletes the trust store.deleteUserAccessLoggingSettings
(Consumer<DeleteUserAccessLoggingSettingsRequest.Builder> deleteUserAccessLoggingSettingsRequest) Deletes user access logging settings.deleteUserAccessLoggingSettings
(DeleteUserAccessLoggingSettingsRequest deleteUserAccessLoggingSettingsRequest) Deletes user access logging settings.deleteUserSettings
(Consumer<DeleteUserSettingsRequest.Builder> deleteUserSettingsRequest) Deletes user settings.deleteUserSettings
(DeleteUserSettingsRequest deleteUserSettingsRequest) Deletes user settings.disassociateBrowserSettings
(Consumer<DisassociateBrowserSettingsRequest.Builder> disassociateBrowserSettingsRequest) Disassociates browser settings from a web portal.disassociateBrowserSettings
(DisassociateBrowserSettingsRequest disassociateBrowserSettingsRequest) Disassociates browser settings from a web portal.disassociateIpAccessSettings
(Consumer<DisassociateIpAccessSettingsRequest.Builder> disassociateIpAccessSettingsRequest) Disassociates IP access settings from a web portal.disassociateIpAccessSettings
(DisassociateIpAccessSettingsRequest disassociateIpAccessSettingsRequest) Disassociates IP access settings from a web portal.disassociateNetworkSettings
(Consumer<DisassociateNetworkSettingsRequest.Builder> disassociateNetworkSettingsRequest) Disassociates network settings from a web portal.disassociateNetworkSettings
(DisassociateNetworkSettingsRequest disassociateNetworkSettingsRequest) Disassociates network settings from a web portal.disassociateTrustStore
(Consumer<DisassociateTrustStoreRequest.Builder> disassociateTrustStoreRequest) Disassociates a trust store from a web portal.disassociateTrustStore
(DisassociateTrustStoreRequest disassociateTrustStoreRequest) Disassociates a trust store from a web portal.disassociateUserAccessLoggingSettings
(Consumer<DisassociateUserAccessLoggingSettingsRequest.Builder> disassociateUserAccessLoggingSettingsRequest) Disassociates user access logging settings from a web portal.disassociateUserAccessLoggingSettings
(DisassociateUserAccessLoggingSettingsRequest disassociateUserAccessLoggingSettingsRequest) Disassociates user access logging settings from a web portal.disassociateUserSettings
(Consumer<DisassociateUserSettingsRequest.Builder> disassociateUserSettingsRequest) Disassociates user settings from a web portal.disassociateUserSettings
(DisassociateUserSettingsRequest disassociateUserSettingsRequest) Disassociates user settings from a web portal.getBrowserSettings
(Consumer<GetBrowserSettingsRequest.Builder> getBrowserSettingsRequest) Gets browser settings.getBrowserSettings
(GetBrowserSettingsRequest getBrowserSettingsRequest) Gets browser settings.getIdentityProvider
(Consumer<GetIdentityProviderRequest.Builder> getIdentityProviderRequest) Gets the identity provider.getIdentityProvider
(GetIdentityProviderRequest getIdentityProviderRequest) Gets the identity provider.getIpAccessSettings
(Consumer<GetIpAccessSettingsRequest.Builder> getIpAccessSettingsRequest) Gets the IP access settings.getIpAccessSettings
(GetIpAccessSettingsRequest getIpAccessSettingsRequest) Gets the IP access settings.getNetworkSettings
(Consumer<GetNetworkSettingsRequest.Builder> getNetworkSettingsRequest) Gets the network settings.getNetworkSettings
(GetNetworkSettingsRequest getNetworkSettingsRequest) Gets the network settings.default CompletableFuture
<GetPortalResponse> getPortal
(Consumer<GetPortalRequest.Builder> getPortalRequest) Gets the web portal.default CompletableFuture
<GetPortalResponse> getPortal
(GetPortalRequest getPortalRequest) Gets the web portal.getPortalServiceProviderMetadata
(Consumer<GetPortalServiceProviderMetadataRequest.Builder> getPortalServiceProviderMetadataRequest) Gets the service provider metadata.getPortalServiceProviderMetadata
(GetPortalServiceProviderMetadataRequest getPortalServiceProviderMetadataRequest) Gets the service provider metadata.default CompletableFuture
<GetTrustStoreResponse> getTrustStore
(Consumer<GetTrustStoreRequest.Builder> getTrustStoreRequest) Gets the trust store.default CompletableFuture
<GetTrustStoreResponse> getTrustStore
(GetTrustStoreRequest getTrustStoreRequest) Gets the trust store.getTrustStoreCertificate
(Consumer<GetTrustStoreCertificateRequest.Builder> getTrustStoreCertificateRequest) Gets the trust store certificate.getTrustStoreCertificate
(GetTrustStoreCertificateRequest getTrustStoreCertificateRequest) Gets the trust store certificate.getUserAccessLoggingSettings
(Consumer<GetUserAccessLoggingSettingsRequest.Builder> getUserAccessLoggingSettingsRequest) Gets user access logging settings.getUserAccessLoggingSettings
(GetUserAccessLoggingSettingsRequest getUserAccessLoggingSettingsRequest) Gets user access logging settings.default CompletableFuture
<GetUserSettingsResponse> getUserSettings
(Consumer<GetUserSettingsRequest.Builder> getUserSettingsRequest) Gets user settings.default CompletableFuture
<GetUserSettingsResponse> getUserSettings
(GetUserSettingsRequest getUserSettingsRequest) Gets user settings.listBrowserSettings
(Consumer<ListBrowserSettingsRequest.Builder> listBrowserSettingsRequest) Retrieves a list of browser settings.listBrowserSettings
(ListBrowserSettingsRequest listBrowserSettingsRequest) Retrieves a list of browser settings.default ListBrowserSettingsPublisher
listBrowserSettingsPaginator
(Consumer<ListBrowserSettingsRequest.Builder> listBrowserSettingsRequest) This is a variant oflistBrowserSettings(software.amazon.awssdk.services.workspacesweb.model.ListBrowserSettingsRequest)
operation.default ListBrowserSettingsPublisher
listBrowserSettingsPaginator
(ListBrowserSettingsRequest listBrowserSettingsRequest) This is a variant oflistBrowserSettings(software.amazon.awssdk.services.workspacesweb.model.ListBrowserSettingsRequest)
operation.listIdentityProviders
(Consumer<ListIdentityProvidersRequest.Builder> listIdentityProvidersRequest) Retrieves a list of identity providers for a specific web portal.listIdentityProviders
(ListIdentityProvidersRequest listIdentityProvidersRequest) Retrieves a list of identity providers for a specific web portal.default ListIdentityProvidersPublisher
listIdentityProvidersPaginator
(Consumer<ListIdentityProvidersRequest.Builder> listIdentityProvidersRequest) This is a variant oflistIdentityProviders(software.amazon.awssdk.services.workspacesweb.model.ListIdentityProvidersRequest)
operation.default ListIdentityProvidersPublisher
listIdentityProvidersPaginator
(ListIdentityProvidersRequest listIdentityProvidersRequest) This is a variant oflistIdentityProviders(software.amazon.awssdk.services.workspacesweb.model.ListIdentityProvidersRequest)
operation.listIpAccessSettings
(Consumer<ListIpAccessSettingsRequest.Builder> listIpAccessSettingsRequest) Retrieves a list of IP access settings.listIpAccessSettings
(ListIpAccessSettingsRequest listIpAccessSettingsRequest) Retrieves a list of IP access settings.default ListIpAccessSettingsPublisher
listIpAccessSettingsPaginator
(Consumer<ListIpAccessSettingsRequest.Builder> listIpAccessSettingsRequest) This is a variant oflistIpAccessSettings(software.amazon.awssdk.services.workspacesweb.model.ListIpAccessSettingsRequest)
operation.default ListIpAccessSettingsPublisher
listIpAccessSettingsPaginator
(ListIpAccessSettingsRequest listIpAccessSettingsRequest) This is a variant oflistIpAccessSettings(software.amazon.awssdk.services.workspacesweb.model.ListIpAccessSettingsRequest)
operation.listNetworkSettings
(Consumer<ListNetworkSettingsRequest.Builder> listNetworkSettingsRequest) Retrieves a list of network settings.listNetworkSettings
(ListNetworkSettingsRequest listNetworkSettingsRequest) Retrieves a list of network settings.default ListNetworkSettingsPublisher
listNetworkSettingsPaginator
(Consumer<ListNetworkSettingsRequest.Builder> listNetworkSettingsRequest) This is a variant oflistNetworkSettings(software.amazon.awssdk.services.workspacesweb.model.ListNetworkSettingsRequest)
operation.default ListNetworkSettingsPublisher
listNetworkSettingsPaginator
(ListNetworkSettingsRequest listNetworkSettingsRequest) This is a variant oflistNetworkSettings(software.amazon.awssdk.services.workspacesweb.model.ListNetworkSettingsRequest)
operation.default CompletableFuture
<ListPortalsResponse> listPortals
(Consumer<ListPortalsRequest.Builder> listPortalsRequest) Retrieves a list or web portals.default CompletableFuture
<ListPortalsResponse> listPortals
(ListPortalsRequest listPortalsRequest) Retrieves a list or web portals.default ListPortalsPublisher
listPortalsPaginator
(Consumer<ListPortalsRequest.Builder> listPortalsRequest) This is a variant oflistPortals(software.amazon.awssdk.services.workspacesweb.model.ListPortalsRequest)
operation.default ListPortalsPublisher
listPortalsPaginator
(ListPortalsRequest listPortalsRequest) This is a variant oflistPortals(software.amazon.awssdk.services.workspacesweb.model.ListPortalsRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Retrieves a list of tags for a resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Retrieves a list of tags for a resource.listTrustStoreCertificates
(Consumer<ListTrustStoreCertificatesRequest.Builder> listTrustStoreCertificatesRequest) Retrieves a list of trust store certificates.listTrustStoreCertificates
(ListTrustStoreCertificatesRequest listTrustStoreCertificatesRequest) Retrieves a list of trust store certificates.listTrustStoreCertificatesPaginator
(Consumer<ListTrustStoreCertificatesRequest.Builder> listTrustStoreCertificatesRequest) This is a variant oflistTrustStoreCertificates(software.amazon.awssdk.services.workspacesweb.model.ListTrustStoreCertificatesRequest)
operation.listTrustStoreCertificatesPaginator
(ListTrustStoreCertificatesRequest listTrustStoreCertificatesRequest) This is a variant oflistTrustStoreCertificates(software.amazon.awssdk.services.workspacesweb.model.ListTrustStoreCertificatesRequest)
operation.default CompletableFuture
<ListTrustStoresResponse> listTrustStores
(Consumer<ListTrustStoresRequest.Builder> listTrustStoresRequest) Retrieves a list of trust stores.default CompletableFuture
<ListTrustStoresResponse> listTrustStores
(ListTrustStoresRequest listTrustStoresRequest) Retrieves a list of trust stores.default ListTrustStoresPublisher
listTrustStoresPaginator
(Consumer<ListTrustStoresRequest.Builder> listTrustStoresRequest) This is a variant oflistTrustStores(software.amazon.awssdk.services.workspacesweb.model.ListTrustStoresRequest)
operation.default ListTrustStoresPublisher
listTrustStoresPaginator
(ListTrustStoresRequest listTrustStoresRequest) This is a variant oflistTrustStores(software.amazon.awssdk.services.workspacesweb.model.ListTrustStoresRequest)
operation.listUserAccessLoggingSettings
(Consumer<ListUserAccessLoggingSettingsRequest.Builder> listUserAccessLoggingSettingsRequest) Retrieves a list of user access logging settings.listUserAccessLoggingSettings
(ListUserAccessLoggingSettingsRequest listUserAccessLoggingSettingsRequest) Retrieves a list of user access logging settings.listUserAccessLoggingSettingsPaginator
(Consumer<ListUserAccessLoggingSettingsRequest.Builder> listUserAccessLoggingSettingsRequest) This is a variant oflistUserAccessLoggingSettings(software.amazon.awssdk.services.workspacesweb.model.ListUserAccessLoggingSettingsRequest)
operation.listUserAccessLoggingSettingsPaginator
(ListUserAccessLoggingSettingsRequest listUserAccessLoggingSettingsRequest) This is a variant oflistUserAccessLoggingSettings(software.amazon.awssdk.services.workspacesweb.model.ListUserAccessLoggingSettingsRequest)
operation.listUserSettings
(Consumer<ListUserSettingsRequest.Builder> listUserSettingsRequest) Retrieves a list of user settings.listUserSettings
(ListUserSettingsRequest listUserSettingsRequest) Retrieves a list of user settings.default ListUserSettingsPublisher
listUserSettingsPaginator
(Consumer<ListUserSettingsRequest.Builder> listUserSettingsRequest) This is a variant oflistUserSettings(software.amazon.awssdk.services.workspacesweb.model.ListUserSettingsRequest)
operation.default ListUserSettingsPublisher
listUserSettingsPaginator
(ListUserSettingsRequest listUserSettingsRequest) This is a variant oflistUserSettings(software.amazon.awssdk.services.workspacesweb.model.ListUserSettingsRequest)
operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds or overwrites one or more tags for the specified resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Adds or overwrites one or more tags for the specified resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags from the specified resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes one or more tags from the specified resource.updateBrowserSettings
(Consumer<UpdateBrowserSettingsRequest.Builder> updateBrowserSettingsRequest) Updates browser settings.updateBrowserSettings
(UpdateBrowserSettingsRequest updateBrowserSettingsRequest) Updates browser settings.updateIdentityProvider
(Consumer<UpdateIdentityProviderRequest.Builder> updateIdentityProviderRequest) Updates the identity provider.updateIdentityProvider
(UpdateIdentityProviderRequest updateIdentityProviderRequest) Updates the identity provider.updateIpAccessSettings
(Consumer<UpdateIpAccessSettingsRequest.Builder> updateIpAccessSettingsRequest) Updates IP access settings.updateIpAccessSettings
(UpdateIpAccessSettingsRequest updateIpAccessSettingsRequest) Updates IP access settings.updateNetworkSettings
(Consumer<UpdateNetworkSettingsRequest.Builder> updateNetworkSettingsRequest) Updates network settings.updateNetworkSettings
(UpdateNetworkSettingsRequest updateNetworkSettingsRequest) Updates network settings.default CompletableFuture
<UpdatePortalResponse> updatePortal
(Consumer<UpdatePortalRequest.Builder> updatePortalRequest) Updates a web portal.default CompletableFuture
<UpdatePortalResponse> updatePortal
(UpdatePortalRequest updatePortalRequest) Updates a web portal.updateTrustStore
(Consumer<UpdateTrustStoreRequest.Builder> updateTrustStoreRequest) Updates the trust store.updateTrustStore
(UpdateTrustStoreRequest updateTrustStoreRequest) Updates the trust store.updateUserAccessLoggingSettings
(Consumer<UpdateUserAccessLoggingSettingsRequest.Builder> updateUserAccessLoggingSettingsRequest) Updates the user access logging settings.updateUserAccessLoggingSettings
(UpdateUserAccessLoggingSettingsRequest updateUserAccessLoggingSettingsRequest) Updates the user access logging settings.updateUserSettings
(Consumer<UpdateUserSettingsRequest.Builder> updateUserSettingsRequest) Updates the user settings.updateUserSettings
(UpdateUserSettingsRequest updateUserSettingsRequest) Updates the user settings.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
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 invokeThrowable.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 viaAssociateBrowserSettingsRequest.builder()
- Parameters:
associateBrowserSettingsRequest
- AConsumer
that will call methods onAssociateBrowserSettingsRequest.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 invokeThrowable.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 invokeThrowable.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 viaAssociateIpAccessSettingsRequest.builder()
- Parameters:
associateIpAccessSettingsRequest
- AConsumer
that will call methods onAssociateIpAccessSettingsRequest.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 invokeThrowable.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 invokeThrowable.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 viaAssociateNetworkSettingsRequest.builder()
- Parameters:
associateNetworkSettingsRequest
- AConsumer
that will call methods onAssociateNetworkSettingsRequest.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 invokeThrowable.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 invokeThrowable.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 viaAssociateTrustStoreRequest.builder()
- Parameters:
associateTrustStoreRequest
- AConsumer
that will call methods onAssociateTrustStoreRequest.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 invokeThrowable.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 invokeThrowable.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 viaAssociateUserAccessLoggingSettingsRequest.builder()
- Parameters:
associateUserAccessLoggingSettingsRequest
- AConsumer
that will call methods onAssociateUserAccessLoggingSettingsRequest.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 invokeThrowable.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 invokeThrowable.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 viaAssociateUserSettingsRequest.builder()
- Parameters:
associateUserSettingsRequest
- AConsumer
that will call methods onAssociateUserSettingsRequest.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 invokeThrowable.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 invokeThrowable.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 viaCreateBrowserSettingsRequest.builder()
- Parameters:
createBrowserSettingsRequest
- AConsumer
that will call methods onCreateBrowserSettingsRequest.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 invokeThrowable.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 invokeThrowable.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 viaCreateIdentityProviderRequest.builder()
- Parameters:
createIdentityProviderRequest
- AConsumer
that will call methods onCreateIdentityProviderRequest.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 invokeThrowable.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 invokeThrowable.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 viaCreateIpAccessSettingsRequest.builder()
- Parameters:
createIpAccessSettingsRequest
- AConsumer
that will call methods onCreateIpAccessSettingsRequest.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 invokeThrowable.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 invokeThrowable.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 viaCreateNetworkSettingsRequest.builder()
- Parameters:
createNetworkSettingsRequest
- AConsumer
that will call methods onCreateNetworkSettingsRequest.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 invokeThrowable.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 invokeThrowable.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 viaCreatePortalRequest.builder()
- Parameters:
createPortalRequest
- AConsumer
that will call methods onCreatePortalRequest.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 invokeThrowable.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 invokeThrowable.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 viaCreateTrustStoreRequest.builder()
- Parameters:
createTrustStoreRequest
- AConsumer
that will call methods onCreateTrustStoreRequest.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 invokeThrowable.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 invokeThrowable.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 viaCreateUserAccessLoggingSettingsRequest.builder()
- Parameters:
createUserAccessLoggingSettingsRequest
- AConsumer
that will call methods onCreateUserAccessLoggingSettingsRequest.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 invokeThrowable.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 invokeThrowable.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 viaCreateUserSettingsRequest.builder()
- Parameters:
createUserSettingsRequest
- AConsumer
that will call methods onCreateUserSettingsRequest.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 invokeThrowable.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 invokeThrowable.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 viaDeleteBrowserSettingsRequest.builder()
- Parameters:
deleteBrowserSettingsRequest
- AConsumer
that will call methods onDeleteBrowserSettingsRequest.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 invokeThrowable.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 invokeThrowable.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 viaDeleteIdentityProviderRequest.builder()
- Parameters:
deleteIdentityProviderRequest
- AConsumer
that will call methods onDeleteIdentityProviderRequest.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 invokeThrowable.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 invokeThrowable.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 viaDeleteIpAccessSettingsRequest.builder()
- Parameters:
deleteIpAccessSettingsRequest
- AConsumer
that will call methods onDeleteIpAccessSettingsRequest.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 invokeThrowable.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 invokeThrowable.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 viaDeleteNetworkSettingsRequest.builder()
- Parameters:
deleteNetworkSettingsRequest
- AConsumer
that will call methods onDeleteNetworkSettingsRequest.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 invokeThrowable.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 invokeThrowable.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 viaDeletePortalRequest.builder()
- Parameters:
deletePortalRequest
- AConsumer
that will call methods onDeletePortalRequest.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 invokeThrowable.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 invokeThrowable.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 viaDeleteTrustStoreRequest.builder()
- Parameters:
deleteTrustStoreRequest
- AConsumer
that will call methods onDeleteTrustStoreRequest.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 invokeThrowable.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 invokeThrowable.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 viaDeleteUserAccessLoggingSettingsRequest.builder()
- Parameters:
deleteUserAccessLoggingSettingsRequest
- AConsumer
that will call methods onDeleteUserAccessLoggingSettingsRequest.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 invokeThrowable.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 invokeThrowable.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 viaDeleteUserSettingsRequest.builder()
- Parameters:
deleteUserSettingsRequest
- AConsumer
that will call methods onDeleteUserSettingsRequest.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 invokeThrowable.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 invokeThrowable.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 viaDisassociateBrowserSettingsRequest.builder()
- Parameters:
disassociateBrowserSettingsRequest
- AConsumer
that will call methods onDisassociateBrowserSettingsRequest.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 invokeThrowable.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 invokeThrowable.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 viaDisassociateIpAccessSettingsRequest.builder()
- Parameters:
disassociateIpAccessSettingsRequest
- AConsumer
that will call methods onDisassociateIpAccessSettingsRequest.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 invokeThrowable.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 invokeThrowable.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 viaDisassociateNetworkSettingsRequest.builder()
- Parameters:
disassociateNetworkSettingsRequest
- AConsumer
that will call methods onDisassociateNetworkSettingsRequest.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 invokeThrowable.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 invokeThrowable.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 viaDisassociateTrustStoreRequest.builder()
- Parameters:
disassociateTrustStoreRequest
- AConsumer
that will call methods onDisassociateTrustStoreRequest.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 invokeThrowable.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 invokeThrowable.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 viaDisassociateUserAccessLoggingSettingsRequest.builder()
- Parameters:
disassociateUserAccessLoggingSettingsRequest
- AConsumer
that will call methods onDisassociateUserAccessLoggingSettingsRequest.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 invokeThrowable.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 invokeThrowable.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 viaDisassociateUserSettingsRequest.builder()
- Parameters:
disassociateUserSettingsRequest
- AConsumer
that will call methods onDisassociateUserSettingsRequest.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 invokeThrowable.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 invokeThrowable.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 viaGetBrowserSettingsRequest.builder()
- Parameters:
getBrowserSettingsRequest
- AConsumer
that will call methods onGetBrowserSettingsRequest.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 invokeThrowable.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 invokeThrowable.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 viaGetIdentityProviderRequest.builder()
- Parameters:
getIdentityProviderRequest
- AConsumer
that will call methods onGetIdentityProviderRequest.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 invokeThrowable.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 invokeThrowable.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 viaGetIpAccessSettingsRequest.builder()
- Parameters:
getIpAccessSettingsRequest
- AConsumer
that will call methods onGetIpAccessSettingsRequest.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 invokeThrowable.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 invokeThrowable.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 viaGetNetworkSettingsRequest.builder()
- Parameters:
getNetworkSettingsRequest
- AConsumer
that will call methods onGetNetworkSettingsRequest.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 invokeThrowable.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
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 invokeThrowable.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 viaGetPortalRequest.builder()
- Parameters:
getPortalRequest
- AConsumer
that will call methods onGetPortalRequest.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 invokeThrowable.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 invokeThrowable.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 viaGetPortalServiceProviderMetadataRequest.builder()
- Parameters:
getPortalServiceProviderMetadataRequest
- AConsumer
that will call methods onGetPortalServiceProviderMetadataRequest.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 invokeThrowable.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 invokeThrowable.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 viaGetTrustStoreRequest.builder()
- Parameters:
getTrustStoreRequest
- AConsumer
that will call methods onGetTrustStoreRequest.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 invokeThrowable.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 invokeThrowable.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 viaGetTrustStoreCertificateRequest.builder()
- Parameters:
getTrustStoreCertificateRequest
- AConsumer
that will call methods onGetTrustStoreCertificateRequest.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 invokeThrowable.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 invokeThrowable.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 viaGetUserAccessLoggingSettingsRequest.builder()
- Parameters:
getUserAccessLoggingSettingsRequest
- AConsumer
that will call methods onGetUserAccessLoggingSettingsRequest.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 invokeThrowable.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 invokeThrowable.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 viaGetUserSettingsRequest.builder()
- Parameters:
getUserSettingsRequest
- AConsumer
that will call methods onGetUserSettingsRequest.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 invokeThrowable.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 invokeThrowable.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 viaListBrowserSettingsRequest.builder()
- Parameters:
listBrowserSettingsRequest
- AConsumer
that will call methods onListBrowserSettingsRequest.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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.workspacesweb.paginators.ListBrowserSettingsPublisher publisher = client.listBrowserSettingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.workspacesweb.paginators.ListBrowserSettingsPublisher publisher = client.listBrowserSettingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListBrowserSettingsRequest.builder()
- Parameters:
listBrowserSettingsRequest
- AConsumer
that will call methods onListBrowserSettingsRequest.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 invokeThrowable.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 invokeThrowable.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 viaListIdentityProvidersRequest.builder()
- Parameters:
listIdentityProvidersRequest
- AConsumer
that will call methods onListIdentityProvidersRequest.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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.workspacesweb.paginators.ListIdentityProvidersPublisher publisher = client.listIdentityProvidersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.workspacesweb.paginators.ListIdentityProvidersPublisher publisher = client.listIdentityProvidersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListIdentityProvidersRequest.builder()
- Parameters:
listIdentityProvidersRequest
- AConsumer
that will call methods onListIdentityProvidersRequest.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 invokeThrowable.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 invokeThrowable.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 viaListIpAccessSettingsRequest.builder()
- Parameters:
listIpAccessSettingsRequest
- AConsumer
that will call methods onListIpAccessSettingsRequest.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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.workspacesweb.paginators.ListIpAccessSettingsPublisher publisher = client.listIpAccessSettingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.workspacesweb.paginators.ListIpAccessSettingsPublisher publisher = client.listIpAccessSettingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListIpAccessSettingsRequest.builder()
- Parameters:
listIpAccessSettingsRequest
- AConsumer
that will call methods onListIpAccessSettingsRequest.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 invokeThrowable.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 invokeThrowable.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 viaListNetworkSettingsRequest.builder()
- Parameters:
listNetworkSettingsRequest
- AConsumer
that will call methods onListNetworkSettingsRequest.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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.workspacesweb.paginators.ListNetworkSettingsPublisher publisher = client.listNetworkSettingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.workspacesweb.paginators.ListNetworkSettingsPublisher publisher = client.listNetworkSettingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListNetworkSettingsRequest.builder()
- Parameters:
listNetworkSettingsRequest
- AConsumer
that will call methods onListNetworkSettingsRequest.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 invokeThrowable.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
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 invokeThrowable.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 viaListPortalsRequest.builder()
- Parameters:
listPortalsRequest
- AConsumer
that will call methods onListPortalsRequest.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 invokeThrowable.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
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 newSubscription
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 methodsoftware.amazon.awssdk.services.workspacesweb.paginators.ListPortalsPublisher publisher = client.listPortalsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.workspacesweb.paginators.ListPortalsPublisher publisher = client.listPortalsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListPortalsRequest.builder()
- Parameters:
listPortalsRequest
- AConsumer
that will call methods onListPortalsRequest.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 invokeThrowable.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 invokeThrowable.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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.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 invokeThrowable.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 invokeThrowable.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 viaListTrustStoreCertificatesRequest.builder()
- Parameters:
listTrustStoreCertificatesRequest
- AConsumer
that will call methods onListTrustStoreCertificatesRequest.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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.workspacesweb.paginators.ListTrustStoreCertificatesPublisher publisher = client.listTrustStoreCertificatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.workspacesweb.paginators.ListTrustStoreCertificatesPublisher publisher = client.listTrustStoreCertificatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListTrustStoreCertificatesRequest.builder()
- Parameters:
listTrustStoreCertificatesRequest
- AConsumer
that will call methods onListTrustStoreCertificatesRequest.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 invokeThrowable.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 invokeThrowable.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 viaListTrustStoresRequest.builder()
- Parameters:
listTrustStoresRequest
- AConsumer
that will call methods onListTrustStoresRequest.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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.workspacesweb.paginators.ListTrustStoresPublisher publisher = client.listTrustStoresPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.workspacesweb.paginators.ListTrustStoresPublisher publisher = client.listTrustStoresPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListTrustStoresRequest.builder()
- Parameters:
listTrustStoresRequest
- AConsumer
that will call methods onListTrustStoresRequest.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 invokeThrowable.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 invokeThrowable.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 viaListUserAccessLoggingSettingsRequest.builder()
- Parameters:
listUserAccessLoggingSettingsRequest
- AConsumer
that will call methods onListUserAccessLoggingSettingsRequest.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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.workspacesweb.paginators.ListUserAccessLoggingSettingsPublisher publisher = client.listUserAccessLoggingSettingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.workspacesweb.paginators.ListUserAccessLoggingSettingsPublisher publisher = client.listUserAccessLoggingSettingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListUserAccessLoggingSettingsRequest.builder()
- Parameters:
listUserAccessLoggingSettingsRequest
- AConsumer
that will call methods onListUserAccessLoggingSettingsRequest.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 invokeThrowable.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 invokeThrowable.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 viaListUserSettingsRequest.builder()
- Parameters:
listUserSettingsRequest
- AConsumer
that will call methods onListUserSettingsRequest.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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.workspacesweb.paginators.ListUserSettingsPublisher publisher = client.listUserSettingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.workspacesweb.paginators.ListUserSettingsPublisher publisher = client.listUserSettingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListUserSettingsRequest.builder()
- Parameters:
listUserSettingsRequest
- AConsumer
that will call methods onListUserSettingsRequest.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 invokeThrowable.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
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 invokeThrowable.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 viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.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 invokeThrowable.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 invokeThrowable.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 viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.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 invokeThrowable.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 invokeThrowable.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 viaUpdateBrowserSettingsRequest.builder()
- Parameters:
updateBrowserSettingsRequest
- AConsumer
that will call methods onUpdateBrowserSettingsRequest.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 invokeThrowable.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 invokeThrowable.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 viaUpdateIdentityProviderRequest.builder()
- Parameters:
updateIdentityProviderRequest
- AConsumer
that will call methods onUpdateIdentityProviderRequest.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 invokeThrowable.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 invokeThrowable.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 viaUpdateIpAccessSettingsRequest.builder()
- Parameters:
updateIpAccessSettingsRequest
- AConsumer
that will call methods onUpdateIpAccessSettingsRequest.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 invokeThrowable.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 invokeThrowable.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 viaUpdateNetworkSettingsRequest.builder()
- Parameters:
updateNetworkSettingsRequest
- AConsumer
that will call methods onUpdateNetworkSettingsRequest.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 invokeThrowable.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 invokeThrowable.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 viaUpdatePortalRequest.builder()
- Parameters:
updatePortalRequest
- AConsumer
that will call methods onUpdatePortalRequest.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 invokeThrowable.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 invokeThrowable.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 viaUpdateTrustStoreRequest.builder()
- Parameters:
updateTrustStoreRequest
- AConsumer
that will call methods onUpdateTrustStoreRequest.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 invokeThrowable.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 invokeThrowable.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 viaUpdateUserAccessLoggingSettingsRequest.builder()
- Parameters:
updateUserAccessLoggingSettingsRequest
- AConsumer
that will call methods onUpdateUserAccessLoggingSettingsRequest.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 invokeThrowable.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 invokeThrowable.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 viaUpdateUserSettingsRequest.builder()
- Parameters:
updateUserSettingsRequest
- AConsumer
that will call methods onUpdateUserSettingsRequest.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 invokeThrowable.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
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aWorkSpacesWebAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aWorkSpacesWebAsyncClient
.
-