workspacesinstances/aws.sdk.kotlin.services.workspacesinstances

Package-level declarations

Types

interface WorkspacesInstancesClient : SdkClient

Amazon WorkSpaces Instances provides an API framework for managing virtual workspace environments across multiple AWS regions, enabling programmatic creation and configuration of desktop infrastructure.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

associateVolume

inline suspend fun WorkspacesInstancesClient.associateVolume(crossinline block: AssociateVolumeRequest.Builder.() -> Unit): AssociateVolumeResponse

Attaches a volume to a WorkSpace Instance.

createVolume

inline suspend fun WorkspacesInstancesClient.createVolume(crossinline block: CreateVolumeRequest.Builder.() -> Unit): CreateVolumeResponse

Creates a new volume for WorkSpace Instances.

createWorkspaceInstance

inline suspend fun WorkspacesInstancesClient.createWorkspaceInstance(crossinline block: CreateWorkspaceInstanceRequest.Builder.() -> Unit): CreateWorkspaceInstanceResponse

Launches a new WorkSpace Instance with specified configuration parameters, enabling programmatic workspace deployment.

deleteVolume

inline suspend fun WorkspacesInstancesClient.deleteVolume(crossinline block: DeleteVolumeRequest.Builder.() -> Unit): DeleteVolumeResponse

Deletes a specified volume.

deleteWorkspaceInstance

inline suspend fun WorkspacesInstancesClient.deleteWorkspaceInstance(crossinline block: DeleteWorkspaceInstanceRequest.Builder.() -> Unit): DeleteWorkspaceInstanceResponse

Deletes the specified WorkSpace

disassociateVolume

inline suspend fun WorkspacesInstancesClient.disassociateVolume(crossinline block: DisassociateVolumeRequest.Builder.() -> Unit): DisassociateVolumeResponse

Detaches a volume from a WorkSpace Instance.

getWorkspaceInstance

inline suspend fun WorkspacesInstancesClient.getWorkspaceInstance(crossinline block: GetWorkspaceInstanceRequest.Builder.() -> Unit): GetWorkspaceInstanceResponse

Retrieves detailed information about a specific WorkSpace Instance.

listInstanceTypes

inline suspend fun WorkspacesInstancesClient.listInstanceTypes(crossinline block: ListInstanceTypesRequest.Builder.() -> Unit): ListInstanceTypesResponse

Retrieves a list of instance types supported by Amazon WorkSpaces Instances, enabling precise workspace infrastructure configuration.

listRegions

inline suspend fun WorkspacesInstancesClient.listRegions(crossinline block: ListRegionsRequest.Builder.() -> Unit): ListRegionsResponse

Retrieves a list of AWS regions supported by Amazon WorkSpaces Instances, enabling region discovery for workspace deployments.

listTagsForResource

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

Retrieves tags for a WorkSpace Instance.

listWorkspaceInstances

inline suspend fun WorkspacesInstancesClient.listWorkspaceInstances(crossinline block: ListWorkspaceInstancesRequest.Builder.() -> Unit): ListWorkspaceInstancesResponse

Retrieves a collection of WorkSpaces Instances based on specified filters.

tagResource

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

Adds tags to a WorkSpace Instance.

untagResource

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

Removes tags from a WorkSpace Instance.

withConfig

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

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.