com.amazonaws.services.workspacesthinclient

Class AmazonWorkSpacesThinClientClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.workspacesthinclient.AmazonWorkSpacesThinClientClient

All Implemented Interfaces:

AmazonWorkSpacesThinClient

Direct Known Subclasses:

AmazonWorkSpacesThinClientAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonWorkSpacesThinClientClient
extends AmazonWebServiceClient
implements AmazonWorkSpacesThinClient

Client for accessing Amazon WorkSpaces Thin Client. All service calls made using this client are blocking, and will not return until the service call completes.

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 inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.workspacesthinclient.AmazonWorkSpacesThinClient

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonWorkSpacesThinClientClientBuilder	builder()
CreateEnvironmentResult	createEnvironment(CreateEnvironmentRequest request) Creates an environment for your thin client devices.
DeleteDeviceResult	deleteDevice(DeleteDeviceRequest request) Deletes a thin client device.
DeleteEnvironmentResult	deleteEnvironment(DeleteEnvironmentRequest request) Deletes an environment.
DeregisterDeviceResult	deregisterDevice(DeregisterDeviceRequest request) Deregisters a thin client device.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetDeviceResult	getDevice(GetDeviceRequest request) Returns information for a thin client device.
GetEnvironmentResult	getEnvironment(GetEnvironmentRequest request) Returns information for an environment.
GetSoftwareSetResult	getSoftwareSet(GetSoftwareSetRequest request) Returns information for a software set.
ListDevicesResult	listDevices(ListDevicesRequest request) Returns a list of thin client devices.
ListEnvironmentsResult	listEnvironments(ListEnvironmentsRequest request) Returns a list of environments.
ListSoftwareSetsResult	listSoftwareSets(ListSoftwareSetsRequest request) Returns a list of software sets.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Returns a list of tags for a resource.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Assigns one or more tags (key-value pairs) to the specified resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes a tag or tags from a resource.
UpdateDeviceResult	updateDevice(UpdateDeviceRequest request) Updates a thin client device.
UpdateEnvironmentResult	updateEnvironment(UpdateEnvironmentRequest request) Updates an environment.
UpdateSoftwareSetResult	updateSoftwareSet(UpdateSoftwareSetRequest request) Updates a software set.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AmazonWorkSpacesThinClientClientBuilder builder()

createEnvironment

public CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest request)

Creates an environment for your thin client devices.

Specified by:

createEnvironment in interface AmazonWorkSpacesThinClient

Parameters:

createEnvironmentRequest -

Returns:

Result of the CreateEnvironment operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteDevice

public DeleteDeviceResult deleteDevice(DeleteDeviceRequest request)

Deletes a thin client device.

Specified by:

deleteDevice in interface AmazonWorkSpacesThinClient

Parameters:

deleteDeviceRequest -

Returns:

Result of the DeleteDevice operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteEnvironment

public DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest request)

Deletes an environment.

Specified by:

deleteEnvironment in interface AmazonWorkSpacesThinClient

Parameters:

deleteEnvironmentRequest -

Returns:

Result of the DeleteEnvironment operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deregisterDevice

public DeregisterDeviceResult deregisterDevice(DeregisterDeviceRequest request)

Deregisters a thin client device.

Specified by:

deregisterDevice in interface AmazonWorkSpacesThinClient

Parameters:

deregisterDeviceRequest -

Returns:

Result of the DeregisterDevice operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getDevice

public GetDeviceResult getDevice(GetDeviceRequest request)

Returns information for a thin client device.

Specified by:

getDevice in interface AmazonWorkSpacesThinClient

Parameters:

getDeviceRequest -

Returns:

Result of the GetDevice operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getEnvironment

public GetEnvironmentResult getEnvironment(GetEnvironmentRequest request)

Returns information for an environment.

Specified by:

getEnvironment in interface AmazonWorkSpacesThinClient

Parameters:

getEnvironmentRequest -

Returns:

Result of the GetEnvironment operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getSoftwareSet

public GetSoftwareSetResult getSoftwareSet(GetSoftwareSetRequest request)

Returns information for a software set.

Specified by:

getSoftwareSet in interface AmazonWorkSpacesThinClient

Parameters:

getSoftwareSetRequest -

Returns:

Result of the GetSoftwareSet operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listDevices

public ListDevicesResult listDevices(ListDevicesRequest request)

Returns a list of thin client devices.

Specified by:

listDevices in interface AmazonWorkSpacesThinClient

Parameters:

listDevicesRequest -

Returns:

Result of the ListDevices operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listEnvironments

public ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest request)

Returns a list of environments.

Specified by:

listEnvironments in interface AmazonWorkSpacesThinClient

Parameters:

listEnvironmentsRequest -

Returns:

Result of the ListEnvironments operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listSoftwareSets

public ListSoftwareSetsResult listSoftwareSets(ListSoftwareSetsRequest request)

Returns a list of software sets.

Specified by:

listSoftwareSets in interface AmazonWorkSpacesThinClient

Parameters:

listSoftwareSetsRequest -

Returns:

Result of the ListSoftwareSets operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Returns a list of tags for a resource.

Specified by:

listTagsForResource in interface AmazonWorkSpacesThinClient

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

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

Specified by:

tagResource in interface AmazonWorkSpacesThinClient

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes a tag or tags from a resource.

Specified by:

untagResource in interface AmazonWorkSpacesThinClient

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateDevice

public UpdateDeviceResult updateDevice(UpdateDeviceRequest request)

Updates a thin client device.

Specified by:

updateDevice in interface AmazonWorkSpacesThinClient

Parameters:

updateDeviceRequest -

Returns:

Result of the UpdateDevice operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateEnvironment

public UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest request)

Updates an environment.

Specified by:

updateEnvironment in interface AmazonWorkSpacesThinClient

Parameters:

updateEnvironmentRequest -

Returns:

Result of the UpdateEnvironment operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateSoftwareSet

public UpdateSoftwareSetResult updateSoftwareSet(UpdateSoftwareSetRequest request)

Updates a software set.

Specified by:

updateSoftwareSet in interface AmazonWorkSpacesThinClient

Parameters:

updateSoftwareSetRequest -

Returns:

Result of the UpdateSoftwareSet operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonWorkSpacesThinClient

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonWorkSpacesThinClient

Overrides:

shutdown in class AmazonWebServiceClient