Interface WorkSpacesThinClientAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
Amazon WorkSpaces Thin Client is an affordable device built to work with Amazon Web Services End User Computing (EUC) virtual desktops to provide users with a complete cloud desktop solution. WorkSpaces Thin Client is a compact device designed to connect up to two monitors and USB devices like a keyboard, mouse, headset, and webcam. To maximize endpoint security, WorkSpaces Thin Client devices do not allow local data storage or installation of unapproved applications. The WorkSpaces Thin Client device ships preloaded with device management software.
You can use these APIs to complete WorkSpaces Thin Client tasks, such as creating environments or viewing devices. For more information about WorkSpaces Thin Client, including the required permissions to use the service, see the Amazon WorkSpaces Thin Client Administrator Guide. For more information about using the Command Line Interface (CLI) to manage your WorkSpaces Thin Client resources, see the WorkSpaces Thin Client section of the CLI Reference.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionbuilder()Create a builder that can be used to configure and create aWorkSpacesThinClientAsyncClient.create()Create aWorkSpacesThinClientAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.createEnvironment(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest) Creates an environment for your thin client devices.createEnvironment(CreateEnvironmentRequest createEnvironmentRequest) Creates an environment for your thin client devices.default CompletableFuture<DeleteDeviceResponse> deleteDevice(Consumer<DeleteDeviceRequest.Builder> deleteDeviceRequest) Deletes a thin client device.default CompletableFuture<DeleteDeviceResponse> deleteDevice(DeleteDeviceRequest deleteDeviceRequest) Deletes a thin client device.deleteEnvironment(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest) Deletes an environment.deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest) Deletes an environment.deregisterDevice(Consumer<DeregisterDeviceRequest.Builder> deregisterDeviceRequest) Deregisters a thin client device.deregisterDevice(DeregisterDeviceRequest deregisterDeviceRequest) Deregisters a thin client device.default CompletableFuture<GetDeviceResponse> getDevice(Consumer<GetDeviceRequest.Builder> getDeviceRequest) Returns information for a thin client device.default CompletableFuture<GetDeviceResponse> getDevice(GetDeviceRequest getDeviceRequest) Returns information for a thin client device.default CompletableFuture<GetEnvironmentResponse> getEnvironment(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest) Returns information for an environment.default CompletableFuture<GetEnvironmentResponse> getEnvironment(GetEnvironmentRequest getEnvironmentRequest) Returns information for an environment.default CompletableFuture<GetSoftwareSetResponse> getSoftwareSet(Consumer<GetSoftwareSetRequest.Builder> getSoftwareSetRequest) Returns information for a software set.default CompletableFuture<GetSoftwareSetResponse> getSoftwareSet(GetSoftwareSetRequest getSoftwareSetRequest) Returns information for a software set.default CompletableFuture<ListDevicesResponse> listDevices(Consumer<ListDevicesRequest.Builder> listDevicesRequest) Returns a list of thin client devices.default CompletableFuture<ListDevicesResponse> listDevices(ListDevicesRequest listDevicesRequest) Returns a list of thin client devices.default ListDevicesPublisherlistDevicesPaginator(Consumer<ListDevicesRequest.Builder> listDevicesRequest) This is a variant oflistDevices(software.amazon.awssdk.services.workspacesthinclient.model.ListDevicesRequest)operation.default ListDevicesPublisherlistDevicesPaginator(ListDevicesRequest listDevicesRequest) This is a variant oflistDevices(software.amazon.awssdk.services.workspacesthinclient.model.ListDevicesRequest)operation.listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) Returns a list of environments.listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest) Returns a list of environments.default ListEnvironmentsPublisherlistEnvironmentsPaginator(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) This is a variant oflistEnvironments(software.amazon.awssdk.services.workspacesthinclient.model.ListEnvironmentsRequest)operation.default ListEnvironmentsPublisherlistEnvironmentsPaginator(ListEnvironmentsRequest listEnvironmentsRequest) This is a variant oflistEnvironments(software.amazon.awssdk.services.workspacesthinclient.model.ListEnvironmentsRequest)operation.listSoftwareSets(Consumer<ListSoftwareSetsRequest.Builder> listSoftwareSetsRequest) Returns a list of software sets.listSoftwareSets(ListSoftwareSetsRequest listSoftwareSetsRequest) Returns a list of software sets.default ListSoftwareSetsPublisherlistSoftwareSetsPaginator(Consumer<ListSoftwareSetsRequest.Builder> listSoftwareSetsRequest) This is a variant oflistSoftwareSets(software.amazon.awssdk.services.workspacesthinclient.model.ListSoftwareSetsRequest)operation.default ListSoftwareSetsPublisherlistSoftwareSetsPaginator(ListSoftwareSetsRequest listSoftwareSetsRequest) This is a variant oflistSoftwareSets(software.amazon.awssdk.services.workspacesthinclient.model.ListSoftwareSetsRequest)operation.listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns a list of tags for a resource.listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of tags for a resource.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Assigns one or more tags (key-value pairs) to the specified resource.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest) Assigns one or more tags (key-value pairs) to the specified resource.default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes a tag or tags from a resource.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes a tag or tags from a resource.default CompletableFuture<UpdateDeviceResponse> updateDevice(Consumer<UpdateDeviceRequest.Builder> updateDeviceRequest) Updates a thin client device.default CompletableFuture<UpdateDeviceResponse> updateDevice(UpdateDeviceRequest updateDeviceRequest) Updates a thin client device.updateEnvironment(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest) Updates an environment.updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest) Updates an environment.updateSoftwareSet(Consumer<UpdateSoftwareSetRequest.Builder> updateSoftwareSetRequest) Updates a software set.updateSoftwareSet(UpdateSoftwareSetRequest updateSoftwareSetRequest) Updates a software set.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods 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
-
createEnvironment
default CompletableFuture<CreateEnvironmentResponse> createEnvironment(CreateEnvironmentRequest createEnvironmentRequest) Creates an environment for your thin client devices.
- Parameters:
createEnvironmentRequest-- Returns:
- A Java Future containing the result of the CreateEnvironment 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.- ServiceQuotaExceededException Your request exceeds a service quota.
- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The resource specified in the request was not found.
- ThrottlingException The request was denied due to request throttling.
- ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createEnvironment
default CompletableFuture<CreateEnvironmentResponse> createEnvironment(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest) Creates an environment for your thin client devices.
This is a convenience which creates an instance of the
CreateEnvironmentRequest.Builderavoiding the need to create one manually viaCreateEnvironmentRequest.builder()- Parameters:
createEnvironmentRequest- AConsumerthat will call methods onCreateEnvironmentRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateEnvironment 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.- ServiceQuotaExceededException Your request exceeds a service quota.
- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The resource specified in the request was not found.
- ThrottlingException The request was denied due to request throttling.
- ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDevice
default CompletableFuture<DeleteDeviceResponse> deleteDevice(DeleteDeviceRequest deleteDeviceRequest) Deletes a thin client device.
- Parameters:
deleteDeviceRequest-- Returns:
- A Java Future containing the result of the DeleteDevice 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The resource specified in the request was not found.
- ThrottlingException The request was denied due to request throttling.
- ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDevice
default CompletableFuture<DeleteDeviceResponse> deleteDevice(Consumer<DeleteDeviceRequest.Builder> deleteDeviceRequest) Deletes a thin client device.
This is a convenience which creates an instance of the
DeleteDeviceRequest.Builderavoiding the need to create one manually viaDeleteDeviceRequest.builder()- Parameters:
deleteDeviceRequest- AConsumerthat will call methods onDeleteDeviceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteDevice 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The resource specified in the request was not found.
- ThrottlingException The request was denied due to request throttling.
- ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEnvironment
default CompletableFuture<DeleteEnvironmentResponse> deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest) Deletes an environment.
- Parameters:
deleteEnvironmentRequest-- Returns:
- A Java Future containing the result of the DeleteEnvironment 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The resource specified in the request was not found.
- ThrottlingException The request was denied due to request throttling.
- ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEnvironment
default CompletableFuture<DeleteEnvironmentResponse> deleteEnvironment(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest) Deletes an environment.
This is a convenience which creates an instance of the
DeleteEnvironmentRequest.Builderavoiding the need to create one manually viaDeleteEnvironmentRequest.builder()- Parameters:
deleteEnvironmentRequest- AConsumerthat will call methods onDeleteEnvironmentRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteEnvironment 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The resource specified in the request was not found.
- ThrottlingException The request was denied due to request throttling.
- ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deregisterDevice
default CompletableFuture<DeregisterDeviceResponse> deregisterDevice(DeregisterDeviceRequest deregisterDeviceRequest) Deregisters a thin client device.
- Parameters:
deregisterDeviceRequest-- Returns:
- A Java Future containing the result of the DeregisterDevice 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The resource specified in the request was not found.
- ThrottlingException The request was denied due to request throttling.
- ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deregisterDevice
default CompletableFuture<DeregisterDeviceResponse> deregisterDevice(Consumer<DeregisterDeviceRequest.Builder> deregisterDeviceRequest) Deregisters a thin client device.
This is a convenience which creates an instance of the
DeregisterDeviceRequest.Builderavoiding the need to create one manually viaDeregisterDeviceRequest.builder()- Parameters:
deregisterDeviceRequest- AConsumerthat will call methods onDeregisterDeviceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeregisterDevice 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The resource specified in the request was not found.
- ThrottlingException The request was denied due to request throttling.
- ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDevice
Returns information for a thin client device.
- Parameters:
getDeviceRequest-- Returns:
- A Java Future containing the result of the GetDevice 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The resource specified in the request was not found.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDevice
default CompletableFuture<GetDeviceResponse> getDevice(Consumer<GetDeviceRequest.Builder> getDeviceRequest) Returns information for a thin client device.
This is a convenience which creates an instance of the
GetDeviceRequest.Builderavoiding the need to create one manually viaGetDeviceRequest.builder()- Parameters:
getDeviceRequest- AConsumerthat will call methods onGetDeviceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetDevice 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The resource specified in the request was not found.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEnvironment
default CompletableFuture<GetEnvironmentResponse> getEnvironment(GetEnvironmentRequest getEnvironmentRequest) Returns information for an environment.
- Parameters:
getEnvironmentRequest-- Returns:
- A Java Future containing the result of the GetEnvironment 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The resource specified in the request was not found.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEnvironment
default CompletableFuture<GetEnvironmentResponse> getEnvironment(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest) Returns information for an environment.
This is a convenience which creates an instance of the
GetEnvironmentRequest.Builderavoiding the need to create one manually viaGetEnvironmentRequest.builder()- Parameters:
getEnvironmentRequest- AConsumerthat will call methods onGetEnvironmentRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetEnvironment 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The resource specified in the request was not found.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSoftwareSet
default CompletableFuture<GetSoftwareSetResponse> getSoftwareSet(GetSoftwareSetRequest getSoftwareSetRequest) Returns information for a software set.
- Parameters:
getSoftwareSetRequest-- Returns:
- A Java Future containing the result of the GetSoftwareSet 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The resource specified in the request was not found.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSoftwareSet
default CompletableFuture<GetSoftwareSetResponse> getSoftwareSet(Consumer<GetSoftwareSetRequest.Builder> getSoftwareSetRequest) Returns information for a software set.
This is a convenience which creates an instance of the
GetSoftwareSetRequest.Builderavoiding the need to create one manually viaGetSoftwareSetRequest.builder()- Parameters:
getSoftwareSetRequest- AConsumerthat will call methods onGetSoftwareSetRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetSoftwareSet 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The resource specified in the request was not found.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDevices
Returns a list of thin client devices.
- Parameters:
listDevicesRequest-- Returns:
- A Java Future containing the result of the ListDevices 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDevices
default CompletableFuture<ListDevicesResponse> listDevices(Consumer<ListDevicesRequest.Builder> listDevicesRequest) Returns a list of thin client devices.
This is a convenience which creates an instance of the
ListDevicesRequest.Builderavoiding the need to create one manually viaListDevicesRequest.builder()- Parameters:
listDevicesRequest- AConsumerthat will call methods onListDevicesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListDevices 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDevicesPaginator
This is a variant of
listDevices(software.amazon.awssdk.services.workspacesthinclient.model.ListDevicesRequest)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 newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.workspacesthinclient.paginators.ListDevicesPublisher publisher = client.listDevicesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.workspacesthinclient.paginators.ListDevicesPublisher publisher = client.listDevicesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspacesthinclient.model.ListDevicesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workspacesthinclient.model.ListDevicesResponse 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
listDevices(software.amazon.awssdk.services.workspacesthinclient.model.ListDevicesRequest)operation.- Parameters:
listDevicesRequest-- 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDevicesPaginator
default ListDevicesPublisher listDevicesPaginator(Consumer<ListDevicesRequest.Builder> listDevicesRequest) This is a variant of
listDevices(software.amazon.awssdk.services.workspacesthinclient.model.ListDevicesRequest)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 newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.workspacesthinclient.paginators.ListDevicesPublisher publisher = client.listDevicesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.workspacesthinclient.paginators.ListDevicesPublisher publisher = client.listDevicesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspacesthinclient.model.ListDevicesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workspacesthinclient.model.ListDevicesResponse 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
listDevices(software.amazon.awssdk.services.workspacesthinclient.model.ListDevicesRequest)operation.
This is a convenience which creates an instance of the
ListDevicesRequest.Builderavoiding the need to create one manually viaListDevicesRequest.builder()- Parameters:
listDevicesRequest- AConsumerthat will call methods onListDevicesRequest.Builderto 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEnvironments
default CompletableFuture<ListEnvironmentsResponse> listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest) Returns a list of environments.
- Parameters:
listEnvironmentsRequest-- Returns:
- A Java Future containing the result of the ListEnvironments 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEnvironments
default CompletableFuture<ListEnvironmentsResponse> listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) Returns a list of environments.
This is a convenience which creates an instance of the
ListEnvironmentsRequest.Builderavoiding the need to create one manually viaListEnvironmentsRequest.builder()- Parameters:
listEnvironmentsRequest- AConsumerthat will call methods onListEnvironmentsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListEnvironments 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEnvironmentsPaginator
default ListEnvironmentsPublisher listEnvironmentsPaginator(ListEnvironmentsRequest listEnvironmentsRequest) This is a variant of
listEnvironments(software.amazon.awssdk.services.workspacesthinclient.model.ListEnvironmentsRequest)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 newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.workspacesthinclient.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.workspacesthinclient.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspacesthinclient.model.ListEnvironmentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workspacesthinclient.model.ListEnvironmentsResponse 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
listEnvironments(software.amazon.awssdk.services.workspacesthinclient.model.ListEnvironmentsRequest)operation.- Parameters:
listEnvironmentsRequest-- 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEnvironmentsPaginator
default ListEnvironmentsPublisher listEnvironmentsPaginator(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) This is a variant of
listEnvironments(software.amazon.awssdk.services.workspacesthinclient.model.ListEnvironmentsRequest)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 newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.workspacesthinclient.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.workspacesthinclient.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspacesthinclient.model.ListEnvironmentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workspacesthinclient.model.ListEnvironmentsResponse 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
listEnvironments(software.amazon.awssdk.services.workspacesthinclient.model.ListEnvironmentsRequest)operation.
This is a convenience which creates an instance of the
ListEnvironmentsRequest.Builderavoiding the need to create one manually viaListEnvironmentsRequest.builder()- Parameters:
listEnvironmentsRequest- AConsumerthat will call methods onListEnvironmentsRequest.Builderto 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSoftwareSets
default CompletableFuture<ListSoftwareSetsResponse> listSoftwareSets(ListSoftwareSetsRequest listSoftwareSetsRequest) Returns a list of software sets.
- Parameters:
listSoftwareSetsRequest-- Returns:
- A Java Future containing the result of the ListSoftwareSets 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSoftwareSets
default CompletableFuture<ListSoftwareSetsResponse> listSoftwareSets(Consumer<ListSoftwareSetsRequest.Builder> listSoftwareSetsRequest) Returns a list of software sets.
This is a convenience which creates an instance of the
ListSoftwareSetsRequest.Builderavoiding the need to create one manually viaListSoftwareSetsRequest.builder()- Parameters:
listSoftwareSetsRequest- AConsumerthat will call methods onListSoftwareSetsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListSoftwareSets 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSoftwareSetsPaginator
default ListSoftwareSetsPublisher listSoftwareSetsPaginator(ListSoftwareSetsRequest listSoftwareSetsRequest) This is a variant of
listSoftwareSets(software.amazon.awssdk.services.workspacesthinclient.model.ListSoftwareSetsRequest)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 newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.workspacesthinclient.paginators.ListSoftwareSetsPublisher publisher = client.listSoftwareSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.workspacesthinclient.paginators.ListSoftwareSetsPublisher publisher = client.listSoftwareSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspacesthinclient.model.ListSoftwareSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workspacesthinclient.model.ListSoftwareSetsResponse 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
listSoftwareSets(software.amazon.awssdk.services.workspacesthinclient.model.ListSoftwareSetsRequest)operation.- Parameters:
listSoftwareSetsRequest-- 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSoftwareSetsPaginator
default ListSoftwareSetsPublisher listSoftwareSetsPaginator(Consumer<ListSoftwareSetsRequest.Builder> listSoftwareSetsRequest) This is a variant of
listSoftwareSets(software.amazon.awssdk.services.workspacesthinclient.model.ListSoftwareSetsRequest)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 newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.workspacesthinclient.paginators.ListSoftwareSetsPublisher publisher = client.listSoftwareSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.workspacesthinclient.paginators.ListSoftwareSetsPublisher publisher = client.listSoftwareSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspacesthinclient.model.ListSoftwareSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.workspacesthinclient.model.ListSoftwareSetsResponse 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
listSoftwareSets(software.amazon.awssdk.services.workspacesthinclient.model.ListSoftwareSetsRequest)operation.
This is a convenience which creates an instance of the
ListSoftwareSetsRequest.Builderavoiding the need to create one manually viaListSoftwareSetsRequest.builder()- Parameters:
listSoftwareSetsRequest- AConsumerthat will call methods onListSoftwareSetsRequest.Builderto 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException 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) Returns 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The resource specified in the request was not found.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException 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) Returns a list of tags for a resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The resource specified in the request was not found.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Assigns one or more tags (key-value pairs) to 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The resource specified in the request was not found.
- ThrottlingException The request was denied due to request throttling.
- ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException 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) Assigns one or more tags (key-value pairs) to the specified resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The resource specified in the request was not found.
- ThrottlingException The request was denied due to request throttling.
- ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException 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 a tag or tags from a 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The resource specified in the request was not found.
- ThrottlingException The request was denied due to request throttling.
- ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException 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 a tag or tags from a resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The resource specified in the request was not found.
- ThrottlingException The request was denied due to request throttling.
- ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDevice
default CompletableFuture<UpdateDeviceResponse> updateDevice(UpdateDeviceRequest updateDeviceRequest) Updates a thin client device.
- Parameters:
updateDeviceRequest-- Returns:
- A Java Future containing the result of the UpdateDevice 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The resource specified in the request was not found.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDevice
default CompletableFuture<UpdateDeviceResponse> updateDevice(Consumer<UpdateDeviceRequest.Builder> updateDeviceRequest) Updates a thin client device.
This is a convenience which creates an instance of the
UpdateDeviceRequest.Builderavoiding the need to create one manually viaUpdateDeviceRequest.builder()- Parameters:
updateDeviceRequest- AConsumerthat will call methods onUpdateDeviceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateDevice 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The resource specified in the request was not found.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateEnvironment
default CompletableFuture<UpdateEnvironmentResponse> updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest) Updates an environment.
- Parameters:
updateEnvironmentRequest-- Returns:
- A Java Future containing the result of the UpdateEnvironment 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The resource specified in the request was not found.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateEnvironment
default CompletableFuture<UpdateEnvironmentResponse> updateEnvironment(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest) Updates an environment.
This is a convenience which creates an instance of the
UpdateEnvironmentRequest.Builderavoiding the need to create one manually viaUpdateEnvironmentRequest.builder()- Parameters:
updateEnvironmentRequest- AConsumerthat will call methods onUpdateEnvironmentRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateEnvironment 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The resource specified in the request was not found.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateSoftwareSet
default CompletableFuture<UpdateSoftwareSetResponse> updateSoftwareSet(UpdateSoftwareSetRequest updateSoftwareSetRequest) Updates a software set.
- Parameters:
updateSoftwareSetRequest-- Returns:
- A Java Future containing the result of the UpdateSoftwareSet 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The resource specified in the request was not found.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateSoftwareSet
default CompletableFuture<UpdateSoftwareSetResponse> updateSoftwareSet(Consumer<UpdateSoftwareSetRequest.Builder> updateSoftwareSetRequest) Updates a software set.
This is a convenience which creates an instance of the
UpdateSoftwareSetRequest.Builderavoiding the need to create one manually viaUpdateSoftwareSetRequest.builder()- Parameters:
updateSoftwareSetRequest- AConsumerthat will call methods onUpdateSoftwareSetRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateSoftwareSet 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.- ValidationException The input fails to satisfy the specified constraints.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The resource specified in the request was not found.
- ThrottlingException The request was denied due to request throttling.
- InternalServerException The server encountered an internal error and is unable to complete the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WorkSpacesThinClientException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aWorkSpacesThinClientAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aWorkSpacesThinClientAsyncClient.
-