View on GitHub
WorkSpaces Structure Reference
WorkSpaces
public struct WorkSpacesClient object for interacting with AWS WorkSpaces service.
Amazon WorkSpaces Service Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows and Amazon Linux desktops for your users.
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the WorkSpaces client
Declaration
Swift
public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)Parameters
accessKeyIdPublic access key provided by AWS
secretAccessKeyPrivate access key provided by AWS
sessionTokenToken provided by STS.AssumeRole() which allows access to another AWS account
regionRegion of server you want to communicate with
endpointCustom endpoint URL to use instead of standard AWS servers
middlewaresArray of middlewares to apply to requests and responses
eventLoopGroupProviderEventLoopGroup to use. Use
useAWSClientSharedif the client shall manage its own EventLoopGroup.
-
Associates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces. Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.
Declaration
Swift
public func associateConnectionAlias(_ input: AssociateConnectionAliasRequest) -> EventLoopFuture<AssociateConnectionAliasResult> -
Associates the specified IP access control group with the specified directory.
Declaration
Swift
public func associateIpGroups(_ input: AssociateIpGroupsRequest) -> EventLoopFuture<AssociateIpGroupsResult> -
Adds one or more rules to the specified IP access control group. This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules.
Declaration
Swift
public func authorizeIpRules(_ input: AuthorizeIpRulesRequest) -> EventLoopFuture<AuthorizeIpRulesResult> -
Copies the specified image from the specified Region to the current Region.
Declaration
Swift
public func copyWorkspaceImage(_ input: CopyWorkspaceImageRequest) -> EventLoopFuture<CopyWorkspaceImageResult> -
Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Declaration
Swift
public func createConnectionAlias(_ input: CreateConnectionAliasRequest) -> EventLoopFuture<CreateConnectionAliasResult> -
Creates an IP access control group. An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using AuthorizeIpRules. There is a default IP access control group associated with your directory. If you don’t associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory.
Declaration
Swift
public func createIpGroup(_ input: CreateIpGroupRequest) -> EventLoopFuture<CreateIpGroupResult> -
Creates the specified tags for the specified WorkSpaces resource.
Declaration
Swift
public func createTags(_ input: CreateTagsRequest) -> EventLoopFuture<CreateTagsResult> -
Creates one or more WorkSpaces. This operation is asynchronous and returns before the WorkSpaces are created.
Declaration
Swift
public func createWorkspaces(_ input: CreateWorkspacesRequest) -> EventLoopFuture<CreateWorkspacesResult> -
Deletes the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces. If you will no longer be using a fully qualified domain name (FQDN) as the registration code for your WorkSpaces users, you must take certain precautions to prevent potential security issues. For more information, see Security Considerations if You Stop Using Cross-Region Redirection. To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.
Declaration
Swift
public func deleteConnectionAlias(_ input: DeleteConnectionAliasRequest) -> EventLoopFuture<DeleteConnectionAliasResult> -
Deletes the specified IP access control group. You cannot delete an IP access control group that is associated with a directory.
Declaration
Swift
public func deleteIpGroup(_ input: DeleteIpGroupRequest) -> EventLoopFuture<DeleteIpGroupResult> -
Deletes the specified tags from the specified WorkSpaces resource.
Declaration
Swift
public func deleteTags(_ input: DeleteTagsRequest) -> EventLoopFuture<DeleteTagsResult> -
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.
Declaration
Swift
public func deleteWorkspaceImage(_ input: DeleteWorkspaceImageRequest) -> EventLoopFuture<DeleteWorkspaceImageResult> -
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.
Declaration
Swift
public func deregisterWorkspaceDirectory(_ input: DeregisterWorkspaceDirectoryRequest) -> EventLoopFuture<DeregisterWorkspaceDirectoryResult> -
Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
Declaration
Swift
public func describeAccount(_ input: DescribeAccountRequest) -> EventLoopFuture<DescribeAccountResult> -
Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.
Declaration
Swift
public func describeAccountModifications(_ input: DescribeAccountModificationsRequest) -> EventLoopFuture<DescribeAccountModificationsResult> -
Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
Declaration
Swift
public func describeClientProperties(_ input: DescribeClientPropertiesRequest) -> EventLoopFuture<DescribeClientPropertiesResult> -
Describes the permissions that the owner of a connection alias has granted to another AWS account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Declaration
Swift
public func describeConnectionAliasPermissions(_ input: DescribeConnectionAliasPermissionsRequest) -> EventLoopFuture<DescribeConnectionAliasPermissionsResult> -
Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Declaration
Swift
public func describeConnectionAliases(_ input: DescribeConnectionAliasesRequest) -> EventLoopFuture<DescribeConnectionAliasesResult> -
Describes one or more of your IP access control groups.
Declaration
Swift
public func describeIpGroups(_ input: DescribeIpGroupsRequest) -> EventLoopFuture<DescribeIpGroupsResult> -
Describes the specified tags for the specified WorkSpaces resource.
Declaration
Swift
public func describeTags(_ input: DescribeTagsRequest) -> EventLoopFuture<DescribeTagsResult> -
Retrieves a list that describes the available WorkSpace bundles. You can filter the results using either bundle ID or owner, but not both.
Declaration
Swift
public func describeWorkspaceBundles(_ input: DescribeWorkspaceBundlesRequest) -> EventLoopFuture<DescribeWorkspaceBundlesResult> -
Describes the available directories that are registered with Amazon WorkSpaces.
Declaration
Swift
public func describeWorkspaceDirectories(_ input: DescribeWorkspaceDirectoriesRequest) -> EventLoopFuture<DescribeWorkspaceDirectoriesResult> -
Describes the permissions that the owner of an image has granted to other AWS accounts for an image.
Declaration
Swift
public func describeWorkspaceImagePermissions(_ input: DescribeWorkspaceImagePermissionsRequest) -> EventLoopFuture<DescribeWorkspaceImagePermissionsResult> -
Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.
Declaration
Swift
public func describeWorkspaceImages(_ input: DescribeWorkspaceImagesRequest) -> EventLoopFuture<DescribeWorkspaceImagesResult> -
Describes the snapshots for the specified WorkSpace.
Declaration
Swift
public func describeWorkspaceSnapshots(_ input: DescribeWorkspaceSnapshotsRequest) -> EventLoopFuture<DescribeWorkspaceSnapshotsResult> -
Describes the specified WorkSpaces. You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.
Declaration
Swift
public func describeWorkspaces(_ input: DescribeWorkspacesRequest) -> EventLoopFuture<DescribeWorkspacesResult> -
Describes the connection status of the specified WorkSpaces.
Declaration
Swift
public func describeWorkspacesConnectionStatus(_ input: DescribeWorkspacesConnectionStatusRequest) -> EventLoopFuture<DescribeWorkspacesConnectionStatusResult> -
Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different AWS Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces. Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.
Declaration
Swift
public func disassociateConnectionAlias(_ input: DisassociateConnectionAliasRequest) -> EventLoopFuture<DisassociateConnectionAliasResult> -
Disassociates the specified IP access control group from the specified directory.
Declaration
Swift
public func disassociateIpGroups(_ input: DisassociateIpGroupsRequest) -> EventLoopFuture<DisassociateIpGroupsResult> -
Imports the specified Windows 10 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your AWS account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.
Declaration
Swift
public func importWorkspaceImage(_ input: ImportWorkspaceImageRequest) -> EventLoopFuture<ImportWorkspaceImageResult> -
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). The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.
Declaration
Swift
public func listAvailableManagementCidrRanges(_ input: ListAvailableManagementCidrRangesRequest) -> EventLoopFuture<ListAvailableManagementCidrRangesResult> -
Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume. The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the user volume from the last available snapshot of the original WorkSpace. During migration, the original D:\Users\%USERNAME% user profile folder is renamed to D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new D:\Users\%USERNAME%\ folder is generated by the new OS. Certain files in the old user profile are moved to the new user profile. For available migration scenarios, details about what happens during migration, and best practices, see Migrate a WorkSpace.
Declaration
Swift
public func migrateWorkspace(_ input: MigrateWorkspaceRequest) -> EventLoopFuture<MigrateWorkspaceResult> -
Modifies the configuration of Bring Your Own License (BYOL) for the specified account.
Declaration
Swift
public func modifyAccount(_ input: ModifyAccountRequest) -> EventLoopFuture<ModifyAccountResult> -
Modifies the properties of the specified Amazon WorkSpaces clients.
Declaration
Swift
public func modifyClientProperties(_ input: ModifyClientPropertiesRequest) -> EventLoopFuture<ModifyClientPropertiesResult> -
Modifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.
Declaration
Swift
public func modifySelfservicePermissions(_ input: ModifySelfservicePermissionsRequest) -> EventLoopFuture<ModifySelfservicePermissionsResult> -
Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access.
Declaration
Swift
public func modifyWorkspaceAccessProperties(_ input: ModifyWorkspaceAccessPropertiesRequest) -> EventLoopFuture<ModifyWorkspaceAccessPropertiesResult> -
Modify the default properties used to create WorkSpaces.
Declaration
Swift
public func modifyWorkspaceCreationProperties(_ input: ModifyWorkspaceCreationPropertiesRequest) -> EventLoopFuture<ModifyWorkspaceCreationPropertiesResult> -
Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
Declaration
Swift
public func modifyWorkspaceProperties(_ input: ModifyWorkspacePropertiesRequest) -> EventLoopFuture<ModifyWorkspacePropertiesResult> -
Sets the state of the specified WorkSpace. To maintain a WorkSpace without being interrupted, set the WorkSpace state to ADMIN_MAINTENANCE. WorkSpaces in this state do not respond to requests to reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE state.
Declaration
Swift
public func modifyWorkspaceState(_ input: ModifyWorkspaceStateRequest) -> EventLoopFuture<ModifyWorkspaceStateResult> -
Reboots the specified WorkSpaces. You cannot reboot a WorkSpace unless its state is AVAILABLE or UNHEALTHY. This operation is asynchronous and returns before the WorkSpaces have rebooted.
Declaration
Swift
public func rebootWorkspaces(_ input: RebootWorkspacesRequest) -> EventLoopFuture<RebootWorkspacesResult> -
Rebuilds the specified WorkSpace. You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, STOPPED, or REBOOTING. Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace. This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.
Declaration
Swift
public func rebuildWorkspaces(_ input: RebuildWorkspacesRequest) -> EventLoopFuture<RebuildWorkspacesResult> -
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.
Declaration
Swift
public func registerWorkspaceDirectory(_ input: RegisterWorkspaceDirectoryRequest) -> EventLoopFuture<RegisterWorkspaceDirectoryResult> -
Restores the specified WorkSpace to its last known healthy state. You cannot restore a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, or STOPPED. Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Restore a WorkSpace. This operation is asynchronous and returns before the WorkSpace is completely restored.
Declaration
Swift
public func restoreWorkspace(_ input: RestoreWorkspaceRequest) -> EventLoopFuture<RestoreWorkspaceResult> -
Removes one or more rules from the specified IP access control group.
Declaration
Swift
public func revokeIpRules(_ input: RevokeIpRulesRequest) -> EventLoopFuture<RevokeIpRulesResult> -
Starts the specified WorkSpaces. You cannot start a WorkSpace unless it has a running mode of AutoStop and a state of STOPPED.
Declaration
Swift
public func startWorkspaces(_ input: StartWorkspacesRequest) -> EventLoopFuture<StartWorkspacesResult> -
Stops the specified WorkSpaces. You cannot stop a WorkSpace unless it has a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.
Declaration
Swift
public func stopWorkspaces(_ input: StopWorkspacesRequest) -> EventLoopFuture<StopWorkspacesResult> -
Terminates the specified WorkSpaces. Terminating a WorkSpace is a permanent action and cannot be undone. The user’s data is destroyed. If you need to archive any user data, contact Amazon Web Services before terminating the WorkSpace. You can terminate a WorkSpace that is in any state except SUSPENDED. This operation is asynchronous and returns before the WorkSpaces have been completely terminated.
Declaration
Swift
public func terminateWorkspaces(_ input: TerminateWorkspacesRequest) -> EventLoopFuture<TerminateWorkspacesResult> -
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. Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED. To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.
Declaration
Swift
public func updateConnectionAliasPermission(_ input: UpdateConnectionAliasPermissionRequest) -> EventLoopFuture<UpdateConnectionAliasPermissionResult> -
Replaces the current rules of the specified IP access control group with the specified rules.
Declaration
Swift
public func updateRulesOfIpGroup(_ input: UpdateRulesOfIpGroupRequest) -> EventLoopFuture<UpdateRulesOfIpGroupResult> -
Shares or unshares an image with one account 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. To delete an image that has been shared, you must unshare the image before you delete it. Sharing Bring Your Own License (BYOL) images across AWS accounts isn’t supported at this time in the AWS GovCloud (US-West) Region. To share BYOL images across accounts in the AWS GovCloud (US-West) Region, contact AWS Support.
Declaration
Swift
public func updateWorkspaceImagePermission(_ input: UpdateWorkspaceImagePermissionRequest) -> EventLoopFuture<UpdateWorkspaceImagePermissionResult>
-
Retrieves a list that describes the available WorkSpace bundles. You can filter the results using either bundle ID or owner, but not both.
Declaration
Swift
public func describeWorkspaceBundlesPaginator(_ input: DescribeWorkspaceBundlesRequest, onPage: @escaping (DescribeWorkspaceBundlesResult, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Describes the available directories that are registered with Amazon WorkSpaces.
Declaration
Swift
public func describeWorkspaceDirectoriesPaginator(_ input: DescribeWorkspaceDirectoriesRequest, onPage: @escaping (DescribeWorkspaceDirectoriesResult, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Describes the specified WorkSpaces. You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.
Declaration
Swift
public func describeWorkspacesPaginator(_ input: DescribeWorkspacesRequest, onPage: @escaping (DescribeWorkspacesResult, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Undocumented
See moreDeclaration
Swift
public struct DescribeWorkspaceBundlesRequest : AWSShapeextension WorkSpaces.DescribeWorkspaceBundlesRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct DescribeWorkspaceDirectoriesRequest : AWSShapeextension WorkSpaces.DescribeWorkspaceDirectoriesRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct DescribeWorkspacesRequest : AWSShapeextension WorkSpaces.DescribeWorkspacesRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public enum AccessPropertyValue : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum Application : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum AssociationStatus : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum Compute : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ConnectionAliasState : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ConnectionState : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum DedicatedTenancyModificationStateEnum : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum DedicatedTenancySupportEnum : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum DedicatedTenancySupportResultEnum : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ImageType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ModificationResourceEnum : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ModificationStateEnum : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum OperatingSystemType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ReconnectEnum : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum RunningMode : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum TargetWorkspaceState : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum Tenancy : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum WorkspaceDirectoryState : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum WorkspaceDirectoryType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum WorkspaceImageIngestionProcess : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum WorkspaceImageRequiredTenancy : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum WorkspaceImageState : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum WorkspaceState : String, CustomStringConvertible, Codable