Interface WorkSpacesThinClientClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface WorkSpacesThinClientClient
extends AwsClient

Service client for accessing Amazon WorkSpaces Thin Client. This can be created using the static builder() method.

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

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static WorkSpacesThinClientClientBuilder	builder()	Create a builder that can be used to configure and create a WorkSpacesThinClientClient.
static WorkSpacesThinClientClient	create()	Create a WorkSpacesThinClientClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateEnvironmentResponse	createEnvironment(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest)	Creates an environment for your thin client devices.
default CreateEnvironmentResponse	createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)	Creates an environment for your thin client devices.
default DeleteDeviceResponse	deleteDevice(Consumer<DeleteDeviceRequest.Builder> deleteDeviceRequest)	Deletes a thin client device.
default DeleteDeviceResponse	deleteDevice(DeleteDeviceRequest deleteDeviceRequest)	Deletes a thin client device.
default DeleteEnvironmentResponse	deleteEnvironment(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest)	Deletes an environment.
default DeleteEnvironmentResponse	deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)	Deletes an environment.
default DeregisterDeviceResponse	deregisterDevice(Consumer<DeregisterDeviceRequest.Builder> deregisterDeviceRequest)	Deregisters a thin client device.
default DeregisterDeviceResponse	deregisterDevice(DeregisterDeviceRequest deregisterDeviceRequest)	Deregisters a thin client device.
default GetDeviceResponse	getDevice(Consumer<GetDeviceRequest.Builder> getDeviceRequest)	Returns information for a thin client device.
default GetDeviceResponse	getDevice(GetDeviceRequest getDeviceRequest)	Returns information for a thin client device.
default GetEnvironmentResponse	getEnvironment(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest)	Returns information for an environment.
default GetEnvironmentResponse	getEnvironment(GetEnvironmentRequest getEnvironmentRequest)	Returns information for an environment.
default GetSoftwareSetResponse	getSoftwareSet(Consumer<GetSoftwareSetRequest.Builder> getSoftwareSetRequest)	Returns information for a software set.
default GetSoftwareSetResponse	getSoftwareSet(GetSoftwareSetRequest getSoftwareSetRequest)	Returns information for a software set.
default ListDevicesResponse	listDevices(Consumer<ListDevicesRequest.Builder> listDevicesRequest)	Returns a list of thin client devices.
default ListDevicesResponse	listDevices(ListDevicesRequest listDevicesRequest)	Returns a list of thin client devices.
default ListDevicesIterable	listDevicesPaginator(Consumer<ListDevicesRequest.Builder> listDevicesRequest)	This is a variant of listDevices(software.amazon.awssdk.services.workspacesthinclient.model.ListDevicesRequest) operation.
default ListDevicesIterable	listDevicesPaginator(ListDevicesRequest listDevicesRequest)	This is a variant of listDevices(software.amazon.awssdk.services.workspacesthinclient.model.ListDevicesRequest) operation.
default ListEnvironmentsResponse	listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest)	Returns a list of environments.
default ListEnvironmentsResponse	listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)	Returns a list of environments.
default ListEnvironmentsIterable	listEnvironmentsPaginator(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest)	This is a variant of listEnvironments(software.amazon.awssdk.services.workspacesthinclient.model.ListEnvironmentsRequest) operation.
default ListEnvironmentsIterable	listEnvironmentsPaginator(ListEnvironmentsRequest listEnvironmentsRequest)	This is a variant of listEnvironments(software.amazon.awssdk.services.workspacesthinclient.model.ListEnvironmentsRequest) operation.
default ListSoftwareSetsResponse	listSoftwareSets(Consumer<ListSoftwareSetsRequest.Builder> listSoftwareSetsRequest)	Returns a list of software sets.
default ListSoftwareSetsResponse	listSoftwareSets(ListSoftwareSetsRequest listSoftwareSetsRequest)	Returns a list of software sets.
default ListSoftwareSetsIterable	listSoftwareSetsPaginator(Consumer<ListSoftwareSetsRequest.Builder> listSoftwareSetsRequest)	This is a variant of listSoftwareSets(software.amazon.awssdk.services.workspacesthinclient.model.ListSoftwareSetsRequest) operation.
default ListSoftwareSetsIterable	listSoftwareSetsPaginator(ListSoftwareSetsRequest listSoftwareSetsRequest)	This is a variant of listSoftwareSets(software.amazon.awssdk.services.workspacesthinclient.model.ListSoftwareSetsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Returns a list of tags for a resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Returns a list of tags for a resource.
default WorkSpacesThinClientServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Assigns one or more tags (key-value pairs) to the specified resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Assigns one or more tags (key-value pairs) to the specified resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes a tag or tags from a resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes a tag or tags from a resource.
default UpdateDeviceResponse	updateDevice(Consumer<UpdateDeviceRequest.Builder> updateDeviceRequest)	Updates a thin client device.
default UpdateDeviceResponse	updateDevice(UpdateDeviceRequest updateDeviceRequest)	Updates a thin client device.
default UpdateEnvironmentResponse	updateEnvironment(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest)	Updates an environment.
default UpdateEnvironmentResponse	updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest)	Updates an environment.
default UpdateSoftwareSetResponse	updateSoftwareSet(Consumer<UpdateSoftwareSetRequest.Builder> updateSoftwareSetRequest)	Updates a software set.
default UpdateSoftwareSetResponse	updateSoftwareSet(UpdateSoftwareSetRequest updateSoftwareSetRequest)	Updates a software set.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createEnvironment

default CreateEnvironmentResponse createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)
                                             throws ServiceQuotaExceededException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Creates an environment for your thin client devices.

Parameters:

createEnvironmentRequest -

Returns:

Result of the CreateEnvironment operation returned by the service.

See Also:

• AWS API Documentation

createEnvironment

default CreateEnvironmentResponse createEnvironment(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest)
                                             throws ServiceQuotaExceededException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Creates an environment for your thin client devices.

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

Parameters:

createEnvironmentRequest - A Consumer that will call methods on CreateEnvironmentRequest.Builder to create a request.

Returns:

Result of the CreateEnvironment operation returned by the service.

See Also:

• AWS API Documentation

deleteDevice

default DeleteDeviceResponse deleteDevice(DeleteDeviceRequest deleteDeviceRequest)
                                   throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Deletes a thin client device.

Parameters:

deleteDeviceRequest -

Returns:

Result of the DeleteDevice operation returned by the service.

See Also:

• AWS API Documentation

deleteDevice

default DeleteDeviceResponse deleteDevice(Consumer<DeleteDeviceRequest.Builder> deleteDeviceRequest)
                                   throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Deletes a thin client device.

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

Parameters:

deleteDeviceRequest - A Consumer that will call methods on DeleteDeviceRequest.Builder to create a request.

Returns:

Result of the DeleteDevice operation returned by the service.

See Also:

• AWS API Documentation

deleteEnvironment

default DeleteEnvironmentResponse deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)
                                             throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Deletes an environment.

Parameters:

deleteEnvironmentRequest -

Returns:

Result of the DeleteEnvironment operation returned by the service.

See Also:

• AWS API Documentation

deleteEnvironment

default DeleteEnvironmentResponse deleteEnvironment(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest)
                                             throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Deletes an environment.

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

Parameters:

deleteEnvironmentRequest - A Consumer that will call methods on DeleteEnvironmentRequest.Builder to create a request.

Returns:

Result of the DeleteEnvironment operation returned by the service.

See Also:

• AWS API Documentation

deregisterDevice

default DeregisterDeviceResponse deregisterDevice(DeregisterDeviceRequest deregisterDeviceRequest)
                                           throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Deregisters a thin client device.

Parameters:

deregisterDeviceRequest -

Returns:

Result of the DeregisterDevice operation returned by the service.

See Also:

• AWS API Documentation

deregisterDevice

default DeregisterDeviceResponse deregisterDevice(Consumer<DeregisterDeviceRequest.Builder> deregisterDeviceRequest)
                                           throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Deregisters a thin client device.

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

Parameters:

deregisterDeviceRequest - A Consumer that will call methods on DeregisterDeviceRequest.Builder to create a request.

Returns:

Result of the DeregisterDevice operation returned by the service.

See Also:

• AWS API Documentation

getDevice

default GetDeviceResponse getDevice(GetDeviceRequest getDeviceRequest)
                             throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Returns information for a thin client device.

Parameters:

getDeviceRequest -

Returns:

Result of the GetDevice operation returned by the service.

See Also:

• AWS API Documentation

getDevice

default GetDeviceResponse getDevice(Consumer<GetDeviceRequest.Builder> getDeviceRequest)
                             throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Returns information for a thin client device.

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

Parameters:

getDeviceRequest - A Consumer that will call methods on GetDeviceRequest.Builder to create a request.

Returns:

Result of the GetDevice operation returned by the service.

See Also:

• AWS API Documentation

getEnvironment

default GetEnvironmentResponse getEnvironment(GetEnvironmentRequest getEnvironmentRequest)
                                       throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Returns information for an environment.

Parameters:

getEnvironmentRequest -

Returns:

Result of the GetEnvironment operation returned by the service.

See Also:

• AWS API Documentation

getEnvironment

default GetEnvironmentResponse getEnvironment(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest)
                                       throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Returns information for an environment.

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

Parameters:

getEnvironmentRequest - A Consumer that will call methods on GetEnvironmentRequest.Builder to create a request.

Returns:

Result of the GetEnvironment operation returned by the service.

See Also:

• AWS API Documentation

getSoftwareSet

default GetSoftwareSetResponse getSoftwareSet(GetSoftwareSetRequest getSoftwareSetRequest)
                                       throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Returns information for a software set.

Parameters:

getSoftwareSetRequest -

Returns:

Result of the GetSoftwareSet operation returned by the service.

See Also:

• AWS API Documentation

getSoftwareSet

default GetSoftwareSetResponse getSoftwareSet(Consumer<GetSoftwareSetRequest.Builder> getSoftwareSetRequest)
                                       throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Returns information for a software set.

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

Parameters:

getSoftwareSetRequest - A Consumer that will call methods on GetSoftwareSetRequest.Builder to create a request.

Returns:

Result of the GetSoftwareSet operation returned by the service.

See Also:

• AWS API Documentation

listDevices

default ListDevicesResponse listDevices(ListDevicesRequest listDevicesRequest)
                                 throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Returns a list of thin client devices.

Parameters:

listDevicesRequest -

Returns:

Result of the ListDevices operation returned by the service.

See Also:

• AWS API Documentation

listDevices

default ListDevicesResponse listDevices(Consumer<ListDevicesRequest.Builder> listDevicesRequest)
                                 throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Returns a list of thin client devices.

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

Parameters:

listDevicesRequest - A Consumer that will call methods on ListDevicesRequest.Builder to create a request.

Returns:

Result of the ListDevices operation returned by the service.

See Also:

• AWS API Documentation

listDevicesPaginator

default ListDevicesIterable listDevicesPaginator(ListDevicesRequest listDevicesRequest)
                                          throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

This is a variant of listDevices(software.amazon.awssdk.services.workspacesthinclient.model.ListDevicesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.workspacesthinclient.paginators.ListDevicesIterable responses = client.listDevicesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.workspacesthinclient.paginators.ListDevicesIterable responses = client
             .listDevicesPaginator(request);
     for (software.amazon.awssdk.services.workspacesthinclient.model.ListDevicesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.workspacesthinclient.paginators.ListDevicesIterable responses = client.listDevicesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDevicesPaginator

default ListDevicesIterable listDevicesPaginator(Consumer<ListDevicesRequest.Builder> listDevicesRequest)
                                          throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

This is a variant of listDevices(software.amazon.awssdk.services.workspacesthinclient.model.ListDevicesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.workspacesthinclient.paginators.ListDevicesIterable responses = client.listDevicesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.workspacesthinclient.paginators.ListDevicesIterable responses = client
             .listDevicesPaginator(request);
     for (software.amazon.awssdk.services.workspacesthinclient.model.ListDevicesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.workspacesthinclient.paginators.ListDevicesIterable responses = client.listDevicesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via ListDevicesRequest.builder()

Parameters:

listDevicesRequest - A Consumer that will call methods on ListDevicesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listEnvironments

default ListEnvironmentsResponse listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)
                                           throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Returns a list of environments.

Parameters:

listEnvironmentsRequest -

Returns:

Result of the ListEnvironments operation returned by the service.

See Also:

• AWS API Documentation

listEnvironments

default ListEnvironmentsResponse listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest)
                                           throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Returns a list of environments.

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

Parameters:

listEnvironmentsRequest - A Consumer that will call methods on ListEnvironmentsRequest.Builder to create a request.

Returns:

Result of the ListEnvironments operation returned by the service.

See Also:

• AWS API Documentation

listEnvironmentsPaginator

default ListEnvironmentsIterable listEnvironmentsPaginator(ListEnvironmentsRequest listEnvironmentsRequest)
                                                    throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

This is a variant of listEnvironments(software.amazon.awssdk.services.workspacesthinclient.model.ListEnvironmentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.workspacesthinclient.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.workspacesthinclient.paginators.ListEnvironmentsIterable responses = client
             .listEnvironmentsPaginator(request);
     for (software.amazon.awssdk.services.workspacesthinclient.model.ListEnvironmentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.workspacesthinclient.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listEnvironmentsPaginator

default ListEnvironmentsIterable listEnvironmentsPaginator(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest)
                                                    throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

This is a variant of listEnvironments(software.amazon.awssdk.services.workspacesthinclient.model.ListEnvironmentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.workspacesthinclient.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.workspacesthinclient.paginators.ListEnvironmentsIterable responses = client
             .listEnvironmentsPaginator(request);
     for (software.amazon.awssdk.services.workspacesthinclient.model.ListEnvironmentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.workspacesthinclient.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via ListEnvironmentsRequest.builder()

Parameters:

listEnvironmentsRequest - A Consumer that will call methods on ListEnvironmentsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSoftwareSets

default ListSoftwareSetsResponse listSoftwareSets(ListSoftwareSetsRequest listSoftwareSetsRequest)
                                           throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Returns a list of software sets.

Parameters:

listSoftwareSetsRequest -

Returns:

Result of the ListSoftwareSets operation returned by the service.

See Also:

• AWS API Documentation

listSoftwareSets

default ListSoftwareSetsResponse listSoftwareSets(Consumer<ListSoftwareSetsRequest.Builder> listSoftwareSetsRequest)
                                           throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Returns a list of software sets.

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

Parameters:

listSoftwareSetsRequest - A Consumer that will call methods on ListSoftwareSetsRequest.Builder to create a request.

Returns:

Result of the ListSoftwareSets operation returned by the service.

See Also:

• AWS API Documentation

listSoftwareSetsPaginator

default ListSoftwareSetsIterable listSoftwareSetsPaginator(ListSoftwareSetsRequest listSoftwareSetsRequest)
                                                    throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

This is a variant of listSoftwareSets(software.amazon.awssdk.services.workspacesthinclient.model.ListSoftwareSetsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.workspacesthinclient.paginators.ListSoftwareSetsIterable responses = client.listSoftwareSetsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.workspacesthinclient.paginators.ListSoftwareSetsIterable responses = client
             .listSoftwareSetsPaginator(request);
     for (software.amazon.awssdk.services.workspacesthinclient.model.ListSoftwareSetsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.workspacesthinclient.paginators.ListSoftwareSetsIterable responses = client.listSoftwareSetsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSoftwareSetsPaginator

default ListSoftwareSetsIterable listSoftwareSetsPaginator(Consumer<ListSoftwareSetsRequest.Builder> listSoftwareSetsRequest)
                                                    throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

This is a variant of listSoftwareSets(software.amazon.awssdk.services.workspacesthinclient.model.ListSoftwareSetsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.workspacesthinclient.paginators.ListSoftwareSetsIterable responses = client.listSoftwareSetsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.workspacesthinclient.paginators.ListSoftwareSetsIterable responses = client
             .listSoftwareSetsPaginator(request);
     for (software.amazon.awssdk.services.workspacesthinclient.model.ListSoftwareSetsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.workspacesthinclient.paginators.ListSoftwareSetsIterable responses = client.listSoftwareSetsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via ListSoftwareSetsRequest.builder()

Parameters:

listSoftwareSetsRequest - A Consumer that will call methods on ListSoftwareSetsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Returns a list of tags for a resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Returns a list of tags for a resource.

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

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Assigns one or more tags (key-value pairs) to the specified resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Assigns one or more tags (key-value pairs) to the specified resource.

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

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Removes a tag or tags from a resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Removes a tag or tags from a resource.

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

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateDevice

default UpdateDeviceResponse updateDevice(UpdateDeviceRequest updateDeviceRequest)
                                   throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Updates a thin client device.

Parameters:

updateDeviceRequest -

Returns:

Result of the UpdateDevice operation returned by the service.

See Also:

• AWS API Documentation

updateDevice

default UpdateDeviceResponse updateDevice(Consumer<UpdateDeviceRequest.Builder> updateDeviceRequest)
                                   throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Updates a thin client device.

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

Parameters:

updateDeviceRequest - A Consumer that will call methods on UpdateDeviceRequest.Builder to create a request.

Returns:

Result of the UpdateDevice operation returned by the service.

See Also:

• AWS API Documentation

updateEnvironment

default UpdateEnvironmentResponse updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest)
                                             throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Updates an environment.

Parameters:

updateEnvironmentRequest -

Returns:

Result of the UpdateEnvironment operation returned by the service.

See Also:

• AWS API Documentation

updateEnvironment

default UpdateEnvironmentResponse updateEnvironment(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest)
                                             throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Updates an environment.

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

Parameters:

updateEnvironmentRequest - A Consumer that will call methods on UpdateEnvironmentRequest.Builder to create a request.

Returns:

Result of the UpdateEnvironment operation returned by the service.

See Also:

• AWS API Documentation

updateSoftwareSet

default UpdateSoftwareSetResponse updateSoftwareSet(UpdateSoftwareSetRequest updateSoftwareSetRequest)
                                             throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Updates a software set.

Parameters:

updateSoftwareSetRequest -

Returns:

Result of the UpdateSoftwareSet operation returned by the service.

See Also:

• AWS API Documentation

updateSoftwareSet

default UpdateSoftwareSetResponse updateSoftwareSet(Consumer<UpdateSoftwareSetRequest.Builder> updateSoftwareSetRequest)
                                             throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkSpacesThinClientException

Updates a software set.

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

Parameters:

updateSoftwareSetRequest - A Consumer that will call methods on UpdateSoftwareSetRequest.Builder to create a request.

Returns:

Result of the UpdateSoftwareSet operation returned by the service.

See Also:

• AWS API Documentation

create

static WorkSpacesThinClientClient create()

Create a WorkSpacesThinClientClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static WorkSpacesThinClientClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default WorkSpacesThinClientServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration