@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonWorkSpacesThinClient
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonWorkSpacesThinClient
instead.
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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
CreateEnvironmentResult |
createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)
Creates an environment for your thin client devices.
|
DeleteDeviceResult |
deleteDevice(DeleteDeviceRequest deleteDeviceRequest)
Deletes a thin client device.
|
DeleteEnvironmentResult |
deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)
Deletes an environment.
|
DeregisterDeviceResult |
deregisterDevice(DeregisterDeviceRequest deregisterDeviceRequest)
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 getDeviceRequest)
Returns information for a thin client device.
|
GetEnvironmentResult |
getEnvironment(GetEnvironmentRequest getEnvironmentRequest)
Returns information for an environment.
|
GetSoftwareSetResult |
getSoftwareSet(GetSoftwareSetRequest getSoftwareSetRequest)
Returns information for a software set.
|
ListDevicesResult |
listDevices(ListDevicesRequest listDevicesRequest)
Returns a list of thin client devices.
|
ListEnvironmentsResult |
listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)
Returns a list of environments.
|
ListSoftwareSetsResult |
listSoftwareSets(ListSoftwareSetsRequest listSoftwareSetsRequest)
Returns a list of software sets.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
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 tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag or tags from a resource.
|
UpdateDeviceResult |
updateDevice(UpdateDeviceRequest updateDeviceRequest)
Updates a thin client device.
|
UpdateEnvironmentResult |
updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest)
Updates an environment.
|
UpdateSoftwareSetResult |
updateSoftwareSet(UpdateSoftwareSetRequest updateSoftwareSetRequest)
Updates a software set.
|
static final String ENDPOINT_PREFIX
CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)
Creates an environment for your thin client devices.
createEnvironmentRequest
- 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.DeleteDeviceResult deleteDevice(DeleteDeviceRequest deleteDeviceRequest)
Deletes a thin client device.
deleteDeviceRequest
- 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.DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)
Deletes an environment.
deleteEnvironmentRequest
- 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.DeregisterDeviceResult deregisterDevice(DeregisterDeviceRequest deregisterDeviceRequest)
Deregisters a thin client device.
deregisterDeviceRequest
- 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.GetDeviceResult getDevice(GetDeviceRequest getDeviceRequest)
Returns information for a thin client device.
getDeviceRequest
- 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.GetEnvironmentResult getEnvironment(GetEnvironmentRequest getEnvironmentRequest)
Returns information for an environment.
getEnvironmentRequest
- 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.GetSoftwareSetResult getSoftwareSet(GetSoftwareSetRequest getSoftwareSetRequest)
Returns information for a software set.
getSoftwareSetRequest
- 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.ListDevicesResult listDevices(ListDevicesRequest listDevicesRequest)
Returns a list of thin client devices.
listDevicesRequest
- 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.ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)
Returns a list of environments.
listEnvironmentsRequest
- 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.ListSoftwareSetsResult listSoftwareSets(ListSoftwareSetsRequest listSoftwareSetsRequest)
Returns a list of software sets.
listSoftwareSetsRequest
- 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.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of tags for a resource.
listTagsForResourceRequest
- 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.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified resource.
tagResourceRequest
- 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.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag or tags from a resource.
untagResourceRequest
- 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.UpdateDeviceResult updateDevice(UpdateDeviceRequest updateDeviceRequest)
Updates a thin client device.
updateDeviceRequest
- 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.UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest)
Updates an environment.
updateEnvironmentRequest
- 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.UpdateSoftwareSetResult updateSoftwareSet(UpdateSoftwareSetRequest updateSoftwareSetRequest)
Updates a software set.
updateSoftwareSetRequest
- 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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 a request.
request
- The originally executed request.