workspacesthinclient/aws.sdk.kotlin.services.workspacesthinclient/WorkSpacesThinClient

WorkSpacesThinClient

interface WorkSpacesThinClient : SdkClient

Amazon WorkSpaces Thin Client is a 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.

Types

Builder

class Builder : AbstractSdkClientBuilder<WorkSpacesThinClient.Config, WorkSpacesThinClient.Config.Builder, WorkSpacesThinClient>

Companion

object Companion : AbstractAwsSdkClientFactory<WorkSpacesThinClient.Config, WorkSpacesThinClient.Config.Builder, WorkSpacesThinClient, WorkSpacesThinClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, IdempotencyTokenConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: WorkSpacesThinClient.Config

WorkSpacesThinClient's configuration

Functions

createEnvironment

abstract suspend fun createEnvironment(input: CreateEnvironmentRequest): CreateEnvironmentResponse

Creates an environment for your thin client devices.

deleteDevice

abstract suspend fun deleteDevice(input: DeleteDeviceRequest): DeleteDeviceResponse

Deletes a thin client device.

deleteEnvironment

abstract suspend fun deleteEnvironment(input: DeleteEnvironmentRequest): DeleteEnvironmentResponse

Deletes an environment.

deregisterDevice

abstract suspend fun deregisterDevice(input: DeregisterDeviceRequest): DeregisterDeviceResponse

Deregisters a thin client device.

getDevice

abstract suspend fun getDevice(input: GetDeviceRequest): GetDeviceResponse

Returns information for a thin client device.

getEnvironment

abstract suspend fun getEnvironment(input: GetEnvironmentRequest): GetEnvironmentResponse

Returns information for an environment.

getSoftwareSet

abstract suspend fun getSoftwareSet(input: GetSoftwareSetRequest): GetSoftwareSetResponse

Returns information for a software set.

listDevices

abstract suspend fun listDevices(input: ListDevicesRequest = ListDevicesRequest { }): ListDevicesResponse

Returns a list of thin client devices.

listEnvironments

abstract suspend fun listEnvironments(input: ListEnvironmentsRequest = ListEnvironmentsRequest { }): ListEnvironmentsResponse

Returns a list of environments.

listSoftwareSets

abstract suspend fun listSoftwareSets(input: ListSoftwareSetsRequest = ListSoftwareSetsRequest { }): ListSoftwareSetsResponse

Returns a list of software sets.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Returns a list of tags for a resource.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

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

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes a tag or tags from a resource.

updateDevice

abstract suspend fun updateDevice(input: UpdateDeviceRequest): UpdateDeviceResponse

Updates a thin client device.

updateEnvironment

abstract suspend fun updateEnvironment(input: UpdateEnvironmentRequest): UpdateEnvironmentResponse

Updates an environment.

updateSoftwareSet

abstract suspend fun updateSoftwareSet(input: UpdateSoftwareSetRequest): UpdateSoftwareSetResponse

Updates a software set.

Inherited functions

expect abstract fun close()

createEnvironment

inline suspend fun WorkSpacesThinClient.createEnvironment(crossinline block: CreateEnvironmentRequest.Builder.() -> Unit): CreateEnvironmentResponse

Creates an environment for your thin client devices.

deleteDevice

inline suspend fun WorkSpacesThinClient.deleteDevice(crossinline block: DeleteDeviceRequest.Builder.() -> Unit): DeleteDeviceResponse

Deletes a thin client device.

deleteEnvironment

inline suspend fun WorkSpacesThinClient.deleteEnvironment(crossinline block: DeleteEnvironmentRequest.Builder.() -> Unit): DeleteEnvironmentResponse

Deletes an environment.

deregisterDevice

inline suspend fun WorkSpacesThinClient.deregisterDevice(crossinline block: DeregisterDeviceRequest.Builder.() -> Unit): DeregisterDeviceResponse

Deregisters a thin client device.

getDevice

inline suspend fun WorkSpacesThinClient.getDevice(crossinline block: GetDeviceRequest.Builder.() -> Unit): GetDeviceResponse

Returns information for a thin client device.

getEnvironment

inline suspend fun WorkSpacesThinClient.getEnvironment(crossinline block: GetEnvironmentRequest.Builder.() -> Unit): GetEnvironmentResponse

Returns information for an environment.

getSoftwareSet

inline suspend fun WorkSpacesThinClient.getSoftwareSet(crossinline block: GetSoftwareSetRequest.Builder.() -> Unit): GetSoftwareSetResponse

Returns information for a software set.

listDevices

inline suspend fun WorkSpacesThinClient.listDevices(crossinline block: ListDevicesRequest.Builder.() -> Unit): ListDevicesResponse

Returns a list of thin client devices.

listDevicesPaginated

fun WorkSpacesThinClient.listDevicesPaginated(initialRequest: ListDevicesRequest = ListDevicesRequest { }): Flow<ListDevicesResponse>

fun WorkSpacesThinClient.listDevicesPaginated(block: ListDevicesRequest.Builder.() -> Unit): Flow<ListDevicesResponse>

Paginate over ListDevicesResponse results.

listEnvironments

inline suspend fun WorkSpacesThinClient.listEnvironments(crossinline block: ListEnvironmentsRequest.Builder.() -> Unit): ListEnvironmentsResponse

Returns a list of environments.

listEnvironmentsPaginated

fun WorkSpacesThinClient.listEnvironmentsPaginated(initialRequest: ListEnvironmentsRequest = ListEnvironmentsRequest { }): Flow<ListEnvironmentsResponse>

fun WorkSpacesThinClient.listEnvironmentsPaginated(block: ListEnvironmentsRequest.Builder.() -> Unit): Flow<ListEnvironmentsResponse>

Paginate over ListEnvironmentsResponse results.

listSoftwareSets

inline suspend fun WorkSpacesThinClient.listSoftwareSets(crossinline block: ListSoftwareSetsRequest.Builder.() -> Unit): ListSoftwareSetsResponse

Returns a list of software sets.

listSoftwareSetsPaginated

fun WorkSpacesThinClient.listSoftwareSetsPaginated(initialRequest: ListSoftwareSetsRequest = ListSoftwareSetsRequest { }): Flow<ListSoftwareSetsResponse>

fun WorkSpacesThinClient.listSoftwareSetsPaginated(block: ListSoftwareSetsRequest.Builder.() -> Unit): Flow<ListSoftwareSetsResponse>

Paginate over ListSoftwareSetsResponse results.

listTagsForResource

inline suspend fun WorkSpacesThinClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Returns a list of tags for a resource.

tagResource

inline suspend fun WorkSpacesThinClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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

untagResource

inline suspend fun WorkSpacesThinClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes a tag or tags from a resource.

updateDevice

inline suspend fun WorkSpacesThinClient.updateDevice(crossinline block: UpdateDeviceRequest.Builder.() -> Unit): UpdateDeviceResponse

Updates a thin client device.

updateEnvironment

inline suspend fun WorkSpacesThinClient.updateEnvironment(crossinline block: UpdateEnvironmentRequest.Builder.() -> Unit): UpdateEnvironmentResponse

Updates an environment.

updateSoftwareSet

inline suspend fun WorkSpacesThinClient.updateSoftwareSet(crossinline block: UpdateSoftwareSetRequest.Builder.() -> Unit): UpdateSoftwareSetResponse

Updates a software set.

withConfig

fun WorkSpacesThinClient.withConfig(block: WorkSpacesThinClient.Config.Builder.() -> Unit): WorkSpacesThinClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.