WorkSpaces class

Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows and Amazon Linux desktops for your users.

Constructors

WorkSpaces({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

associateConnectionAlias({required String aliasId, required String resourceId}) → Future<AssociateConnectionAliasResult>

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

associateIpGroups({required String directoryId, required List<String> groupIds}) → Future<void>

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

authorizeIpRules({required String groupId, required List<IpRuleItem> userRules}) → Future<void>

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

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

copyWorkspaceImage({required String name, required String sourceImageId, required String sourceRegion, String? description, List<Tag>? tags}) → Future<CopyWorkspaceImageResult>

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

createConnectionAlias({required String connectionString, List<Tag>? tags}) → Future<CreateConnectionAliasResult>

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

createIpGroup({required String groupName, String? groupDesc, List<Tag>? tags, List<IpRuleItem>? userRules}) → Future<CreateIpGroupResult>

Creates an IP access control group.

createTags({required String resourceId, required List<Tag> tags}) → Future<void>

Creates the specified tags for the specified WorkSpaces resource.

createWorkspaces({required List<WorkspaceRequest> workspaces}) → Future<CreateWorkspacesResult>

Creates one or more WorkSpaces.

deleteConnectionAlias({required String aliasId}) → Future<void>

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

deleteIpGroup({required String groupId}) → Future<void>

Deletes the specified IP access control group.

deleteTags({required String resourceId, required List<String> tagKeys}) → Future<void>

Deletes the specified tags from the specified WorkSpaces resource.

deleteWorkspaceImage({required String imageId}) → Future<void>

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.

deregisterWorkspaceDirectory({required String directoryId}) → Future<void>

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.

describeAccount() → Future<DescribeAccountResult>

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

describeAccountModifications({String? nextToken}) → Future<DescribeAccountModificationsResult>

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

describeClientProperties({required List<String> resourceIds}) → Future<DescribeClientPropertiesResult>

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

describeConnectionAliases({List<String>? aliasIds, int? limit, String? nextToken, String? resourceId}) → Future<DescribeConnectionAliasesResult>

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

describeConnectionAliasPermissions({required String aliasId, int? maxResults, String? nextToken}) → Future<DescribeConnectionAliasPermissionsResult>

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.

describeIpGroups({List<String>? groupIds, int? maxResults, String? nextToken}) → Future<DescribeIpGroupsResult>

Describes one or more of your IP access control groups.

describeTags({required String resourceId}) → Future<DescribeTagsResult>

Describes the specified tags for the specified WorkSpaces resource.

describeWorkspaceBundles({List<String>? bundleIds, String? nextToken, String? owner}) → Future<DescribeWorkspaceBundlesResult>

Retrieves a list that describes the available WorkSpace bundles.

describeWorkspaceDirectories({List<String>? directoryIds, int? limit, String? nextToken}) → Future<DescribeWorkspaceDirectoriesResult>

Describes the available directories that are registered with Amazon WorkSpaces.

describeWorkspaceImagePermissions({required String imageId, int? maxResults, String? nextToken}) → Future<DescribeWorkspaceImagePermissionsResult>

Describes the permissions that the owner of an image has granted to other AWS accounts for an image.

describeWorkspaceImages({List<String>? imageIds, ImageType? imageType, int? maxResults, String? nextToken}) → Future<DescribeWorkspaceImagesResult>

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

describeWorkspaces({String? bundleId, String? directoryId, int? limit, String? nextToken, String? userName, List<String>? workspaceIds}) → Future<DescribeWorkspacesResult>

Describes the specified WorkSpaces.

describeWorkspacesConnectionStatus({String? nextToken, List<String>? workspaceIds}) → Future<DescribeWorkspacesConnectionStatusResult>

Describes the connection status of the specified WorkSpaces.

describeWorkspaceSnapshots({required String workspaceId}) → Future<DescribeWorkspaceSnapshotsResult>

Describes the snapshots for the specified WorkSpace.

disassociateConnectionAlias({required String aliasId}) → Future<void>

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.

disassociateIpGroups({required String directoryId, required List<String> groupIds}) → Future<void>

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

importWorkspaceImage({required String ec2ImageId, required String imageDescription, required String imageName, required WorkspaceImageIngestionProcess ingestionProcess, List<Application>? applications, List<Tag>? tags}) → Future<ImportWorkspaceImageResult>

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.

listAvailableManagementCidrRanges({required String managementCidrRangeConstraint, int? maxResults, String? nextToken}) → Future<ListAvailableManagementCidrRangesResult>

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).

migrateWorkspace({required String bundleId, required String sourceWorkspaceId}) → Future<MigrateWorkspaceResult>

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

modifyAccount({String? dedicatedTenancyManagementCidrRange, DedicatedTenancySupportEnum? dedicatedTenancySupport}) → Future<void>

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

modifyClientProperties({required ClientProperties clientProperties, required String resourceId}) → Future<void>

Modifies the properties of the specified Amazon WorkSpaces clients.

modifySelfservicePermissions({required String resourceId, required SelfservicePermissions selfservicePermissions}) → Future<void>

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

modifyWorkspaceAccessProperties({required String resourceId, required WorkspaceAccessProperties workspaceAccessProperties}) → Future<void>

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

modifyWorkspaceCreationProperties({required String resourceId, required WorkspaceCreationProperties workspaceCreationProperties}) → Future<void>

Modify the default properties used to create WorkSpaces.

modifyWorkspaceProperties({required String workspaceId, required WorkspaceProperties workspaceProperties}) → Future<void>

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

modifyWorkspaceState({required String workspaceId, required TargetWorkspaceState workspaceState}) → Future<void>

Sets the state of the specified WorkSpace.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

rebootWorkspaces({required List<RebootRequest> rebootWorkspaceRequests}) → Future<RebootWorkspacesResult>

Reboots the specified WorkSpaces.

rebuildWorkspaces({required List<RebuildRequest> rebuildWorkspaceRequests}) → Future<RebuildWorkspacesResult>

Rebuilds the specified WorkSpace.

registerWorkspaceDirectory({required String directoryId, required bool enableWorkDocs, bool? enableSelfService, List<String>? subnetIds, List<Tag>? tags, Tenancy? tenancy}) → Future<void>

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.

restoreWorkspace({required String workspaceId}) → Future<void>

Restores the specified WorkSpace to its last known healthy state.

revokeIpRules({required String groupId, required List<String> userRules}) → Future<void>

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

startWorkspaces({required List<StartRequest> startWorkspaceRequests}) → Future<StartWorkspacesResult>

Starts the specified WorkSpaces.

stopWorkspaces({required List<StopRequest> stopWorkspaceRequests}) → Future<StopWorkspacesResult>

Stops the specified WorkSpaces.

terminateWorkspaces({required List<TerminateRequest> terminateWorkspaceRequests}) → Future<TerminateWorkspacesResult>

Terminates the specified WorkSpaces. You can terminate a WorkSpace that is in any state except SUSPENDED.

toString() → String

A string representation of this object.

inherited

updateConnectionAliasPermission({required String aliasId, required ConnectionAliasPermission connectionAliasPermission}) → Future<void>

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.

updateRulesOfIpGroup({required String groupId, required List<IpRuleItem> userRules}) → Future<void>

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

updateWorkspaceImagePermission({required bool allowCopyImage, required String imageId, required String sharedAccountId}) → Future<void>

Shares or unshares an image with one account in the same AWS 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.

Operators

operator ==(Object other) → bool

The equality operator.

inherited