workspaces/aws.sdk.kotlin.services.workspaces

Package-level declarations

Types

Link copied to clipboard
interface WorkSpacesClient : SdkClient

Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows or Amazon Linux desktops for your users, known as WorkSpaces. WorkSpaces eliminates the need to procure and deploy hardware or install complex software. You can quickly add or remove users as your needs change. Users can access their virtual desktops from multiple devices or web browsers.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard
inline suspend fun WorkSpacesClient.associateConnectionAlias(crossinline block: AssociateConnectionAliasRequest.Builder.() -> Unit): AssociateConnectionAliasResponse

Associates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Link copied to clipboard
inline suspend fun WorkSpacesClient.associateIpGroups(crossinline block: AssociateIpGroupsRequest.Builder.() -> Unit): AssociateIpGroupsResponse

Associates the specified IP access control group with the specified directory.

Link copied to clipboard
inline suspend fun WorkSpacesClient.associateWorkspaceApplication(crossinline block: AssociateWorkspaceApplicationRequest.Builder.() -> Unit): AssociateWorkspaceApplicationResponse

Associates the specified application to the specified WorkSpace.

Link copied to clipboard
inline suspend fun WorkSpacesClient.authorizeIpRules(crossinline block: AuthorizeIpRulesRequest.Builder.() -> Unit): AuthorizeIpRulesResponse

Adds one or more rules to the specified IP access control group.

Link copied to clipboard
inline suspend fun WorkSpacesClient.copyWorkspaceImage(crossinline block: CopyWorkspaceImageRequest.Builder.() -> Unit): CopyWorkspaceImageResponse

Copies the specified image from the specified Region to the current Region. For more information about copying images, see Copy a Custom WorkSpaces Image.

Link copied to clipboard
inline suspend fun WorkSpacesClient.createConnectClientAddIn(crossinline block: CreateConnectClientAddInRequest.Builder.() -> Unit): CreateConnectClientAddInResponse

Creates a client-add-in for Amazon Connect within a directory. You can create only one Amazon Connect client add-in within a directory.

Link copied to clipboard
inline suspend fun WorkSpacesClient.createConnectionAlias(crossinline block: CreateConnectionAliasRequest.Builder.() -> Unit): CreateConnectionAliasResponse

Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Link copied to clipboard
inline suspend fun WorkSpacesClient.createIpGroup(crossinline block: CreateIpGroupRequest.Builder.() -> Unit): CreateIpGroupResponse

Creates an IP access control group.

Link copied to clipboard
inline suspend fun WorkSpacesClient.createStandbyWorkspaces(crossinline block: CreateStandbyWorkspacesRequest.Builder.() -> Unit): CreateStandbyWorkspacesResponse

Creates a standby WorkSpace in a secondary Region.

Link copied to clipboard
inline suspend fun WorkSpacesClient.createTags(crossinline block: CreateTagsRequest.Builder.() -> Unit): CreateTagsResponse

Creates the specified tags for the specified WorkSpaces resource.

Link copied to clipboard
inline suspend fun WorkSpacesClient.createUpdatedWorkspaceImage(crossinline block: CreateUpdatedWorkspaceImageRequest.Builder.() -> Unit): CreateUpdatedWorkspaceImageResponse

Creates a new updated WorkSpace image based on the specified source image. The new updated WorkSpace image has the latest drivers and other updates required by the Amazon WorkSpaces components.

Link copied to clipboard
inline suspend fun WorkSpacesClient.createWorkspaceBundle(crossinline block: CreateWorkspaceBundleRequest.Builder.() -> Unit): CreateWorkspaceBundleResponse

Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle.

Link copied to clipboard
inline suspend fun WorkSpacesClient.createWorkspaceImage(crossinline block: CreateWorkspaceImageRequest.Builder.() -> Unit): CreateWorkspaceImageResponse

Creates a new WorkSpace image from an existing WorkSpace.

Link copied to clipboard
inline suspend fun WorkSpacesClient.createWorkspaces(crossinline block: CreateWorkspacesRequest.Builder.() -> Unit): CreateWorkspacesResponse

Creates one or more WorkSpaces.

Link copied to clipboard
inline suspend fun WorkSpacesClient.deleteClientBranding(crossinline block: DeleteClientBrandingRequest.Builder.() -> Unit): DeleteClientBrandingResponse

Deletes customized client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.

Link copied to clipboard
inline suspend fun WorkSpacesClient.deleteConnectClientAddIn(crossinline block: DeleteConnectClientAddInRequest.Builder.() -> Unit): DeleteConnectClientAddInResponse

Deletes a client-add-in for Amazon Connect that is configured within a directory.

Link copied to clipboard
inline suspend fun WorkSpacesClient.deleteConnectionAlias(crossinline block: DeleteConnectionAliasRequest.Builder.() -> Unit): DeleteConnectionAliasResponse

Deletes the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Link copied to clipboard
inline suspend fun WorkSpacesClient.deleteIpGroup(crossinline block: DeleteIpGroupRequest.Builder.() -> Unit): DeleteIpGroupResponse

Deletes the specified IP access control group.

Link copied to clipboard
inline suspend fun WorkSpacesClient.deleteTags(crossinline block: DeleteTagsRequest.Builder.() -> Unit): DeleteTagsResponse

Deletes the specified tags from the specified WorkSpaces resource.

Link copied to clipboard
inline suspend fun WorkSpacesClient.deleteWorkspaceBundle(crossinline block: DeleteWorkspaceBundleRequest.Builder.() -> Unit): DeleteWorkspaceBundleResponse

Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image.

Link copied to clipboard
inline suspend fun WorkSpacesClient.deleteWorkspaceImage(crossinline block: DeleteWorkspaceImageRequest.Builder.() -> Unit): DeleteWorkspaceImageResponse

Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and unshare the image if it is shared with other accounts.

Link copied to clipboard
inline suspend fun WorkSpacesClient.deployWorkspaceApplications(crossinline block: DeployWorkspaceApplicationsRequest.Builder.() -> Unit): DeployWorkspaceApplicationsResponse

Deploys associated applications to the specified WorkSpace

Link copied to clipboard
inline suspend fun WorkSpacesClient.deregisterWorkspaceDirectory(crossinline block: DeregisterWorkspaceDirectoryRequest.Builder.() -> Unit): DeregisterWorkspaceDirectoryResponse

Deregisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is deregistered. If any WorkSpaces are registered to this directory, you must remove them before you can deregister the directory.

Link copied to clipboard
inline suspend fun WorkSpacesClient.describeAccount(crossinline block: DescribeAccountRequest.Builder.() -> Unit): DescribeAccountResponse

Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.

Link copied to clipboard
inline suspend fun WorkSpacesClient.describeAccountModifications(crossinline block: DescribeAccountModificationsRequest.Builder.() -> Unit): DescribeAccountModificationsResponse

Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.

Link copied to clipboard
inline suspend fun WorkSpacesClient.describeApplicationAssociations(crossinline block: DescribeApplicationAssociationsRequest.Builder.() -> Unit): DescribeApplicationAssociationsResponse

Describes the associations between the application and the specified associated resources.

Link copied to clipboard
inline suspend fun WorkSpacesClient.describeApplications(crossinline block: DescribeApplicationsRequest.Builder.() -> Unit): DescribeApplicationsResponse

Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.

Link copied to clipboard
inline suspend fun WorkSpacesClient.describeBundleAssociations(crossinline block: DescribeBundleAssociationsRequest.Builder.() -> Unit): DescribeBundleAssociationsResponse

Describes the associations between the applications and the specified bundle.

Link copied to clipboard
inline suspend fun WorkSpacesClient.describeClientBranding(crossinline block: DescribeClientBrandingRequest.Builder.() -> Unit): DescribeClientBrandingResponse

Describes the specified client branding. Client branding allows you to customize the log in page of various device types for your users. You can add your company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.

Link copied to clipboard
inline suspend fun WorkSpacesClient.describeClientProperties(crossinline block: DescribeClientPropertiesRequest.Builder.() -> Unit): DescribeClientPropertiesResponse

Retrieves a list that describes one or more specified Amazon WorkSpaces clients.

Link copied to clipboard
inline suspend fun WorkSpacesClient.describeConnectClientAddIns(crossinline block: DescribeConnectClientAddInsRequest.Builder.() -> Unit): DescribeConnectClientAddInsResponse

Retrieves a list of Amazon Connect client add-ins that have been created.

Link copied to clipboard
inline suspend fun WorkSpacesClient.describeConnectionAliases(crossinline block: DescribeConnectionAliasesRequest.Builder.() -> Unit): DescribeConnectionAliasesResponse

Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Link copied to clipboard
inline suspend fun WorkSpacesClient.describeConnectionAliasPermissions(crossinline block: DescribeConnectionAliasPermissionsRequest.Builder.() -> Unit): DescribeConnectionAliasPermissionsResponse

Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Link copied to clipboard
inline suspend fun WorkSpacesClient.describeImageAssociations(crossinline block: DescribeImageAssociationsRequest.Builder.() -> Unit): DescribeImageAssociationsResponse

Describes the associations between the applications and the specified image.

Link copied to clipboard
inline suspend fun WorkSpacesClient.describeIpGroups(crossinline block: DescribeIpGroupsRequest.Builder.() -> Unit): DescribeIpGroupsResponse

Describes one or more of your IP access control groups.

Link copied to clipboard
inline suspend fun WorkSpacesClient.describeTags(crossinline block: DescribeTagsRequest.Builder.() -> Unit): DescribeTagsResponse

Describes the specified tags for the specified WorkSpaces resource.

Link copied to clipboard
inline suspend fun WorkSpacesClient.describeWorkspaceAssociations(crossinline block: DescribeWorkspaceAssociationsRequest.Builder.() -> Unit): DescribeWorkspaceAssociationsResponse

Describes the associations betweens applications and the specified WorkSpace.

Link copied to clipboard
inline suspend fun WorkSpacesClient.describeWorkspaceBundles(crossinline block: DescribeWorkspaceBundlesRequest.Builder.() -> Unit): DescribeWorkspaceBundlesResponse

Retrieves a list that describes the available WorkSpace bundles.

Link copied to clipboard
inline suspend fun WorkSpacesClient.describeWorkspaceDirectories(crossinline block: DescribeWorkspaceDirectoriesRequest.Builder.() -> Unit): DescribeWorkspaceDirectoriesResponse

Describes the available directories that are registered with Amazon WorkSpaces.

Link copied to clipboard
inline suspend fun WorkSpacesClient.describeWorkspaceImagePermissions(crossinline block: DescribeWorkspaceImagePermissionsRequest.Builder.() -> Unit): DescribeWorkspaceImagePermissionsResponse

Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.

Link copied to clipboard
inline suspend fun WorkSpacesClient.describeWorkspaceImages(crossinline block: DescribeWorkspaceImagesRequest.Builder.() -> Unit): DescribeWorkspaceImagesResponse

Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.

Link copied to clipboard
inline suspend fun WorkSpacesClient.describeWorkspaces(crossinline block: DescribeWorkspacesRequest.Builder.() -> Unit): DescribeWorkspacesResponse

Describes the specified WorkSpaces.

Link copied to clipboard
inline suspend fun WorkSpacesClient.describeWorkspacesConnectionStatus(crossinline block: DescribeWorkspacesConnectionStatusRequest.Builder.() -> Unit): DescribeWorkspacesConnectionStatusResponse

Describes the connection status of the specified WorkSpaces.

Link copied to clipboard
inline suspend fun WorkSpacesClient.describeWorkspaceSnapshots(crossinline block: DescribeWorkspaceSnapshotsRequest.Builder.() -> Unit): DescribeWorkspaceSnapshotsResponse

Describes the snapshots for the specified WorkSpace.

Link copied to clipboard
inline suspend fun WorkSpacesClient.disassociateConnectionAlias(crossinline block: DisassociateConnectionAliasRequest.Builder.() -> Unit): DisassociateConnectionAliasResponse

Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Link copied to clipboard
inline suspend fun WorkSpacesClient.disassociateIpGroups(crossinline block: DisassociateIpGroupsRequest.Builder.() -> Unit): DisassociateIpGroupsResponse

Disassociates the specified IP access control group from the specified directory.

Link copied to clipboard
inline suspend fun WorkSpacesClient.disassociateWorkspaceApplication(crossinline block: DisassociateWorkspaceApplicationRequest.Builder.() -> Unit): DisassociateWorkspaceApplicationResponse

Disassociates the specified application from a WorkSpace.

Link copied to clipboard
inline suspend fun WorkSpacesClient.importClientBranding(crossinline block: ImportClientBrandingRequest.Builder.() -> Unit): ImportClientBrandingResponse

Imports client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.

Link copied to clipboard
inline suspend fun WorkSpacesClient.importWorkspaceImage(crossinline block: ImportWorkspaceImageRequest.Builder.() -> Unit): ImportWorkspaceImageResponse

Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your Amazon Web Services account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.

Link copied to clipboard
inline suspend fun WorkSpacesClient.listAvailableManagementCidrRanges(crossinline block: ListAvailableManagementCidrRangesRequest.Builder.() -> Unit): ListAvailableManagementCidrRangesResponse

Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable Bring Your Own License (BYOL).

Link copied to clipboard
inline suspend fun WorkSpacesClient.migrateWorkspace(crossinline block: MigrateWorkspaceRequest.Builder.() -> Unit): MigrateWorkspaceResponse

Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume.

Link copied to clipboard
inline suspend fun WorkSpacesClient.modifyAccount(crossinline block: ModifyAccountRequest.Builder.() -> Unit): ModifyAccountResponse

Modifies the configuration of Bring Your Own License (BYOL) for the specified account.

Link copied to clipboard
inline suspend fun WorkSpacesClient.modifyCertificateBasedAuthProperties(crossinline block: ModifyCertificateBasedAuthPropertiesRequest.Builder.() -> Unit): ModifyCertificateBasedAuthPropertiesResponse

Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces.

Link copied to clipboard
inline suspend fun WorkSpacesClient.modifyClientProperties(crossinline block: ModifyClientPropertiesRequest.Builder.() -> Unit): ModifyClientPropertiesResponse

Modifies the properties of the specified Amazon WorkSpaces clients.

Link copied to clipboard
inline suspend fun WorkSpacesClient.modifySamlProperties(crossinline block: ModifySamlPropertiesRequest.Builder.() -> Unit): ModifySamlPropertiesResponse

Modifies multiple properties related to SAML 2.0 authentication, including the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.

Link copied to clipboard
inline suspend fun WorkSpacesClient.modifySelfservicePermissions(crossinline block: ModifySelfservicePermissionsRequest.Builder.() -> Unit): ModifySelfservicePermissionsResponse

Modifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.

Link copied to clipboard
inline suspend fun WorkSpacesClient.modifyWorkspaceAccessProperties(crossinline block: ModifyWorkspaceAccessPropertiesRequest.Builder.() -> Unit): ModifyWorkspaceAccessPropertiesResponse

Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access.

Link copied to clipboard
inline suspend fun WorkSpacesClient.modifyWorkspaceCreationProperties(crossinline block: ModifyWorkspaceCreationPropertiesRequest.Builder.() -> Unit): ModifyWorkspaceCreationPropertiesResponse

Modify the default properties used to create WorkSpaces.

Link copied to clipboard
inline suspend fun WorkSpacesClient.modifyWorkspaceProperties(crossinline block: ModifyWorkspacePropertiesRequest.Builder.() -> Unit): ModifyWorkspacePropertiesResponse

Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

Link copied to clipboard
inline suspend fun WorkSpacesClient.modifyWorkspaceState(crossinline block: ModifyWorkspaceStateRequest.Builder.() -> Unit): ModifyWorkspaceStateResponse

Sets the state of the specified WorkSpace.

Link copied to clipboard
inline suspend fun WorkSpacesClient.rebootWorkspaces(crossinline block: RebootWorkspacesRequest.Builder.() -> Unit): RebootWorkspacesResponse

Reboots the specified WorkSpaces.

Link copied to clipboard
inline suspend fun WorkSpacesClient.rebuildWorkspaces(crossinline block: RebuildWorkspacesRequest.Builder.() -> Unit): RebuildWorkspacesResponse

Rebuilds the specified WorkSpace.

Link copied to clipboard
inline suspend fun WorkSpacesClient.registerWorkspaceDirectory(crossinline block: RegisterWorkspaceDirectoryRequest.Builder.() -> Unit): RegisterWorkspaceDirectoryResponse

Registers the specified directory. This operation is asynchronous and returns before the WorkSpace directory is registered. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.

Link copied to clipboard
inline suspend fun WorkSpacesClient.restoreWorkspace(crossinline block: RestoreWorkspaceRequest.Builder.() -> Unit): RestoreWorkspaceResponse

Restores the specified WorkSpace to its last known healthy state.

Link copied to clipboard
inline suspend fun WorkSpacesClient.revokeIpRules(crossinline block: RevokeIpRulesRequest.Builder.() -> Unit): RevokeIpRulesResponse

Removes one or more rules from the specified IP access control group.

Link copied to clipboard
inline suspend fun WorkSpacesClient.startWorkspaces(crossinline block: StartWorkspacesRequest.Builder.() -> Unit): StartWorkspacesResponse

Starts the specified WorkSpaces.

Link copied to clipboard
inline suspend fun WorkSpacesClient.stopWorkspaces(crossinline block: StopWorkspacesRequest.Builder.() -> Unit): StopWorkspacesResponse

Stops the specified WorkSpaces.

Link copied to clipboard
inline suspend fun WorkSpacesClient.terminateWorkspaces(crossinline block: TerminateWorkspacesRequest.Builder.() -> Unit): TerminateWorkspacesResponse

Terminates the specified WorkSpaces.

Link copied to clipboard
inline suspend fun WorkSpacesClient.updateConnectClientAddIn(crossinline block: UpdateConnectClientAddInRequest.Builder.() -> Unit): UpdateConnectClientAddInResponse

Updates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon Connect client add-in.

Link copied to clipboard
inline suspend fun WorkSpacesClient.updateConnectionAliasPermission(crossinline block: UpdateConnectionAliasPermissionRequest.Builder.() -> Unit): UpdateConnectionAliasPermissionResponse

Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory. If the association permission is granted, the connection alias is shared with that account. If the association permission is revoked, the connection alias is unshared with the account. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Link copied to clipboard
inline suspend fun WorkSpacesClient.updateRulesOfIpGroup(crossinline block: UpdateRulesOfIpGroupRequest.Builder.() -> Unit): UpdateRulesOfIpGroupResponse

Replaces the current rules of the specified IP access control group with the specified rules.

Link copied to clipboard
inline suspend fun WorkSpacesClient.updateWorkspaceBundle(crossinline block: UpdateWorkspaceBundleRequest.Builder.() -> Unit): UpdateWorkspaceBundleResponse

Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see Update a Custom WorkSpaces Bundle.

Link copied to clipboard
inline suspend fun WorkSpacesClient.updateWorkspaceImagePermission(crossinline block: UpdateWorkspaceImagePermissionRequest.Builder.() -> Unit): UpdateWorkspaceImagePermissionResponse

Shares or unshares an image with one account in the same Amazon Web Services Region by specifying whether that account has permission to copy the image. If the copy image permission is granted, the image is shared with that account. If the copy image permission is revoked, the image is unshared with the account.

Link copied to clipboard
fun WorkSpacesClient.withConfig(block: WorkSpacesClient.Config.Builder.() -> Unit): WorkSpacesClient

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.