UNPKG

78.8 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class WorkSpaces extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: WorkSpaces.Types.ClientConfiguration)
13 config: Config & WorkSpaces.Types.ClientConfiguration;
14 /**
15 * Associates the specified IP access control group with the specified directory.
16 */
17 associateIpGroups(params: WorkSpaces.Types.AssociateIpGroupsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.AssociateIpGroupsResult) => void): Request<WorkSpaces.Types.AssociateIpGroupsResult, AWSError>;
18 /**
19 * Associates the specified IP access control group with the specified directory.
20 */
21 associateIpGroups(callback?: (err: AWSError, data: WorkSpaces.Types.AssociateIpGroupsResult) => void): Request<WorkSpaces.Types.AssociateIpGroupsResult, AWSError>;
22 /**
23 * 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.
24 */
25 authorizeIpRules(params: WorkSpaces.Types.AuthorizeIpRulesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.AuthorizeIpRulesResult) => void): Request<WorkSpaces.Types.AuthorizeIpRulesResult, AWSError>;
26 /**
27 * 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.
28 */
29 authorizeIpRules(callback?: (err: AWSError, data: WorkSpaces.Types.AuthorizeIpRulesResult) => void): Request<WorkSpaces.Types.AuthorizeIpRulesResult, AWSError>;
30 /**
31 * Copies the specified image from the specified Region to the current Region.
32 */
33 copyWorkspaceImage(params: WorkSpaces.Types.CopyWorkspaceImageRequest, callback?: (err: AWSError, data: WorkSpaces.Types.CopyWorkspaceImageResult) => void): Request<WorkSpaces.Types.CopyWorkspaceImageResult, AWSError>;
34 /**
35 * Copies the specified image from the specified Region to the current Region.
36 */
37 copyWorkspaceImage(callback?: (err: AWSError, data: WorkSpaces.Types.CopyWorkspaceImageResult) => void): Request<WorkSpaces.Types.CopyWorkspaceImageResult, AWSError>;
38 /**
39 * 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.
40 */
41 createIpGroup(params: WorkSpaces.Types.CreateIpGroupRequest, callback?: (err: AWSError, data: WorkSpaces.Types.CreateIpGroupResult) => void): Request<WorkSpaces.Types.CreateIpGroupResult, AWSError>;
42 /**
43 * 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.
44 */
45 createIpGroup(callback?: (err: AWSError, data: WorkSpaces.Types.CreateIpGroupResult) => void): Request<WorkSpaces.Types.CreateIpGroupResult, AWSError>;
46 /**
47 * Creates the specified tags for the specified WorkSpaces resource.
48 */
49 createTags(params: WorkSpaces.Types.CreateTagsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.CreateTagsResult) => void): Request<WorkSpaces.Types.CreateTagsResult, AWSError>;
50 /**
51 * Creates the specified tags for the specified WorkSpaces resource.
52 */
53 createTags(callback?: (err: AWSError, data: WorkSpaces.Types.CreateTagsResult) => void): Request<WorkSpaces.Types.CreateTagsResult, AWSError>;
54 /**
55 * Creates one or more WorkSpaces. This operation is asynchronous and returns before the WorkSpaces are created.
56 */
57 createWorkspaces(params: WorkSpaces.Types.CreateWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.CreateWorkspacesResult) => void): Request<WorkSpaces.Types.CreateWorkspacesResult, AWSError>;
58 /**
59 * Creates one or more WorkSpaces. This operation is asynchronous and returns before the WorkSpaces are created.
60 */
61 createWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.CreateWorkspacesResult) => void): Request<WorkSpaces.Types.CreateWorkspacesResult, AWSError>;
62 /**
63 * Deletes the specified IP access control group. You cannot delete an IP access control group that is associated with a directory.
64 */
65 deleteIpGroup(params: WorkSpaces.Types.DeleteIpGroupRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DeleteIpGroupResult) => void): Request<WorkSpaces.Types.DeleteIpGroupResult, AWSError>;
66 /**
67 * Deletes the specified IP access control group. You cannot delete an IP access control group that is associated with a directory.
68 */
69 deleteIpGroup(callback?: (err: AWSError, data: WorkSpaces.Types.DeleteIpGroupResult) => void): Request<WorkSpaces.Types.DeleteIpGroupResult, AWSError>;
70 /**
71 * Deletes the specified tags from the specified WorkSpaces resource.
72 */
73 deleteTags(params: WorkSpaces.Types.DeleteTagsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DeleteTagsResult) => void): Request<WorkSpaces.Types.DeleteTagsResult, AWSError>;
74 /**
75 * Deletes the specified tags from the specified WorkSpaces resource.
76 */
77 deleteTags(callback?: (err: AWSError, data: WorkSpaces.Types.DeleteTagsResult) => void): Request<WorkSpaces.Types.DeleteTagsResult, AWSError>;
78 /**
79 * Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and un-share the image if it is shared with other accounts.
80 */
81 deleteWorkspaceImage(params: WorkSpaces.Types.DeleteWorkspaceImageRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DeleteWorkspaceImageResult) => void): Request<WorkSpaces.Types.DeleteWorkspaceImageResult, AWSError>;
82 /**
83 * Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and un-share the image if it is shared with other accounts.
84 */
85 deleteWorkspaceImage(callback?: (err: AWSError, data: WorkSpaces.Types.DeleteWorkspaceImageResult) => void): Request<WorkSpaces.Types.DeleteWorkspaceImageResult, AWSError>;
86 /**
87 * 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.
88 */
89 deregisterWorkspaceDirectory(params: WorkSpaces.Types.DeregisterWorkspaceDirectoryRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DeregisterWorkspaceDirectoryResult) => void): Request<WorkSpaces.Types.DeregisterWorkspaceDirectoryResult, AWSError>;
90 /**
91 * 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.
92 */
93 deregisterWorkspaceDirectory(callback?: (err: AWSError, data: WorkSpaces.Types.DeregisterWorkspaceDirectoryResult) => void): Request<WorkSpaces.Types.DeregisterWorkspaceDirectoryResult, AWSError>;
94 /**
95 * Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
96 */
97 describeAccount(params: WorkSpaces.Types.DescribeAccountRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeAccountResult) => void): Request<WorkSpaces.Types.DescribeAccountResult, AWSError>;
98 /**
99 * Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
100 */
101 describeAccount(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeAccountResult) => void): Request<WorkSpaces.Types.DescribeAccountResult, AWSError>;
102 /**
103 * Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.
104 */
105 describeAccountModifications(params: WorkSpaces.Types.DescribeAccountModificationsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeAccountModificationsResult) => void): Request<WorkSpaces.Types.DescribeAccountModificationsResult, AWSError>;
106 /**
107 * Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.
108 */
109 describeAccountModifications(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeAccountModificationsResult) => void): Request<WorkSpaces.Types.DescribeAccountModificationsResult, AWSError>;
110 /**
111 * Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
112 */
113 describeClientProperties(params: WorkSpaces.Types.DescribeClientPropertiesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeClientPropertiesResult) => void): Request<WorkSpaces.Types.DescribeClientPropertiesResult, AWSError>;
114 /**
115 * Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
116 */
117 describeClientProperties(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeClientPropertiesResult) => void): Request<WorkSpaces.Types.DescribeClientPropertiesResult, AWSError>;
118 /**
119 * Describes one or more of your IP access control groups.
120 */
121 describeIpGroups(params: WorkSpaces.Types.DescribeIpGroupsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeIpGroupsResult) => void): Request<WorkSpaces.Types.DescribeIpGroupsResult, AWSError>;
122 /**
123 * Describes one or more of your IP access control groups.
124 */
125 describeIpGroups(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeIpGroupsResult) => void): Request<WorkSpaces.Types.DescribeIpGroupsResult, AWSError>;
126 /**
127 * Describes the specified tags for the specified WorkSpaces resource.
128 */
129 describeTags(params: WorkSpaces.Types.DescribeTagsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeTagsResult) => void): Request<WorkSpaces.Types.DescribeTagsResult, AWSError>;
130 /**
131 * Describes the specified tags for the specified WorkSpaces resource.
132 */
133 describeTags(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeTagsResult) => void): Request<WorkSpaces.Types.DescribeTagsResult, AWSError>;
134 /**
135 * Retrieves a list that describes the available WorkSpace bundles. You can filter the results using either bundle ID or owner, but not both.
136 */
137 describeWorkspaceBundles(params: WorkSpaces.Types.DescribeWorkspaceBundlesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceBundlesResult) => void): Request<WorkSpaces.Types.DescribeWorkspaceBundlesResult, AWSError>;
138 /**
139 * Retrieves a list that describes the available WorkSpace bundles. You can filter the results using either bundle ID or owner, but not both.
140 */
141 describeWorkspaceBundles(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceBundlesResult) => void): Request<WorkSpaces.Types.DescribeWorkspaceBundlesResult, AWSError>;
142 /**
143 * Describes the available directories that are registered with Amazon WorkSpaces.
144 */
145 describeWorkspaceDirectories(params: WorkSpaces.Types.DescribeWorkspaceDirectoriesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceDirectoriesResult) => void): Request<WorkSpaces.Types.DescribeWorkspaceDirectoriesResult, AWSError>;
146 /**
147 * Describes the available directories that are registered with Amazon WorkSpaces.
148 */
149 describeWorkspaceDirectories(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceDirectoriesResult) => void): Request<WorkSpaces.Types.DescribeWorkspaceDirectoriesResult, AWSError>;
150 /**
151 * Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.
152 */
153 describeWorkspaceImages(params: WorkSpaces.Types.DescribeWorkspaceImagesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceImagesResult) => void): Request<WorkSpaces.Types.DescribeWorkspaceImagesResult, AWSError>;
154 /**
155 * Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.
156 */
157 describeWorkspaceImages(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceImagesResult) => void): Request<WorkSpaces.Types.DescribeWorkspaceImagesResult, AWSError>;
158 /**
159 * Describes the snapshots for the specified WorkSpace.
160 */
161 describeWorkspaceSnapshots(params: WorkSpaces.Types.DescribeWorkspaceSnapshotsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceSnapshotsResult) => void): Request<WorkSpaces.Types.DescribeWorkspaceSnapshotsResult, AWSError>;
162 /**
163 * Describes the snapshots for the specified WorkSpace.
164 */
165 describeWorkspaceSnapshots(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceSnapshotsResult) => void): Request<WorkSpaces.Types.DescribeWorkspaceSnapshotsResult, AWSError>;
166 /**
167 * 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.
168 */
169 describeWorkspaces(params: WorkSpaces.Types.DescribeWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspacesResult) => void): Request<WorkSpaces.Types.DescribeWorkspacesResult, AWSError>;
170 /**
171 * 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.
172 */
173 describeWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspacesResult) => void): Request<WorkSpaces.Types.DescribeWorkspacesResult, AWSError>;
174 /**
175 * Describes the connection status of the specified WorkSpaces.
176 */
177 describeWorkspacesConnectionStatus(params: WorkSpaces.Types.DescribeWorkspacesConnectionStatusRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspacesConnectionStatusResult) => void): Request<WorkSpaces.Types.DescribeWorkspacesConnectionStatusResult, AWSError>;
178 /**
179 * Describes the connection status of the specified WorkSpaces.
180 */
181 describeWorkspacesConnectionStatus(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspacesConnectionStatusResult) => void): Request<WorkSpaces.Types.DescribeWorkspacesConnectionStatusResult, AWSError>;
182 /**
183 * Disassociates the specified IP access control group from the specified directory.
184 */
185 disassociateIpGroups(params: WorkSpaces.Types.DisassociateIpGroupsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DisassociateIpGroupsResult) => void): Request<WorkSpaces.Types.DisassociateIpGroupsResult, AWSError>;
186 /**
187 * Disassociates the specified IP access control group from the specified directory.
188 */
189 disassociateIpGroups(callback?: (err: AWSError, data: WorkSpaces.Types.DisassociateIpGroupsResult) => void): Request<WorkSpaces.Types.DisassociateIpGroupsResult, AWSError>;
190 /**
191 * Imports the specified Windows 7 or Windows 10 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed EC2 image that is in your AWS account, and you must own the image.
192 */
193 importWorkspaceImage(params: WorkSpaces.Types.ImportWorkspaceImageRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ImportWorkspaceImageResult) => void): Request<WorkSpaces.Types.ImportWorkspaceImageResult, AWSError>;
194 /**
195 * Imports the specified Windows 7 or Windows 10 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed EC2 image that is in your AWS account, and you must own the image.
196 */
197 importWorkspaceImage(callback?: (err: AWSError, data: WorkSpaces.Types.ImportWorkspaceImageResult) => void): Request<WorkSpaces.Types.ImportWorkspaceImageResult, AWSError>;
198 /**
199 * 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.
200 */
201 listAvailableManagementCidrRanges(params: WorkSpaces.Types.ListAvailableManagementCidrRangesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ListAvailableManagementCidrRangesResult) => void): Request<WorkSpaces.Types.ListAvailableManagementCidrRangesResult, AWSError>;
202 /**
203 * 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.
204 */
205 listAvailableManagementCidrRanges(callback?: (err: AWSError, data: WorkSpaces.Types.ListAvailableManagementCidrRangesResult) => void): Request<WorkSpaces.Types.ListAvailableManagementCidrRangesResult, AWSError>;
206 /**
207 * 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.
208 */
209 migrateWorkspace(params: WorkSpaces.Types.MigrateWorkspaceRequest, callback?: (err: AWSError, data: WorkSpaces.Types.MigrateWorkspaceResult) => void): Request<WorkSpaces.Types.MigrateWorkspaceResult, AWSError>;
210 /**
211 * 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.
212 */
213 migrateWorkspace(callback?: (err: AWSError, data: WorkSpaces.Types.MigrateWorkspaceResult) => void): Request<WorkSpaces.Types.MigrateWorkspaceResult, AWSError>;
214 /**
215 * Modifies the configuration of Bring Your Own License (BYOL) for the specified account.
216 */
217 modifyAccount(params: WorkSpaces.Types.ModifyAccountRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ModifyAccountResult) => void): Request<WorkSpaces.Types.ModifyAccountResult, AWSError>;
218 /**
219 * Modifies the configuration of Bring Your Own License (BYOL) for the specified account.
220 */
221 modifyAccount(callback?: (err: AWSError, data: WorkSpaces.Types.ModifyAccountResult) => void): Request<WorkSpaces.Types.ModifyAccountResult, AWSError>;
222 /**
223 * Modifies the properties of the specified Amazon WorkSpaces clients.
224 */
225 modifyClientProperties(params: WorkSpaces.Types.ModifyClientPropertiesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ModifyClientPropertiesResult) => void): Request<WorkSpaces.Types.ModifyClientPropertiesResult, AWSError>;
226 /**
227 * Modifies the properties of the specified Amazon WorkSpaces clients.
228 */
229 modifyClientProperties(callback?: (err: AWSError, data: WorkSpaces.Types.ModifyClientPropertiesResult) => void): Request<WorkSpaces.Types.ModifyClientPropertiesResult, AWSError>;
230 /**
231 * Modifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.
232 */
233 modifySelfservicePermissions(params: WorkSpaces.Types.ModifySelfservicePermissionsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ModifySelfservicePermissionsResult) => void): Request<WorkSpaces.Types.ModifySelfservicePermissionsResult, AWSError>;
234 /**
235 * Modifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.
236 */
237 modifySelfservicePermissions(callback?: (err: AWSError, data: WorkSpaces.Types.ModifySelfservicePermissionsResult) => void): Request<WorkSpaces.Types.ModifySelfservicePermissionsResult, AWSError>;
238 /**
239 * Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access.
240 */
241 modifyWorkspaceAccessProperties(params: WorkSpaces.Types.ModifyWorkspaceAccessPropertiesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ModifyWorkspaceAccessPropertiesResult) => void): Request<WorkSpaces.Types.ModifyWorkspaceAccessPropertiesResult, AWSError>;
242 /**
243 * Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access.
244 */
245 modifyWorkspaceAccessProperties(callback?: (err: AWSError, data: WorkSpaces.Types.ModifyWorkspaceAccessPropertiesResult) => void): Request<WorkSpaces.Types.ModifyWorkspaceAccessPropertiesResult, AWSError>;
246 /**
247 * Modify the default properties used to create WorkSpaces.
248 */
249 modifyWorkspaceCreationProperties(params: WorkSpaces.Types.ModifyWorkspaceCreationPropertiesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ModifyWorkspaceCreationPropertiesResult) => void): Request<WorkSpaces.Types.ModifyWorkspaceCreationPropertiesResult, AWSError>;
250 /**
251 * Modify the default properties used to create WorkSpaces.
252 */
253 modifyWorkspaceCreationProperties(callback?: (err: AWSError, data: WorkSpaces.Types.ModifyWorkspaceCreationPropertiesResult) => void): Request<WorkSpaces.Types.ModifyWorkspaceCreationPropertiesResult, AWSError>;
254 /**
255 * Modifies the specified WorkSpace properties.
256 */
257 modifyWorkspaceProperties(params: WorkSpaces.Types.ModifyWorkspacePropertiesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ModifyWorkspacePropertiesResult) => void): Request<WorkSpaces.Types.ModifyWorkspacePropertiesResult, AWSError>;
258 /**
259 * Modifies the specified WorkSpace properties.
260 */
261 modifyWorkspaceProperties(callback?: (err: AWSError, data: WorkSpaces.Types.ModifyWorkspacePropertiesResult) => void): Request<WorkSpaces.Types.ModifyWorkspacePropertiesResult, AWSError>;
262 /**
263 * 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.
264 */
265 modifyWorkspaceState(params: WorkSpaces.Types.ModifyWorkspaceStateRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ModifyWorkspaceStateResult) => void): Request<WorkSpaces.Types.ModifyWorkspaceStateResult, AWSError>;
266 /**
267 * 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.
268 */
269 modifyWorkspaceState(callback?: (err: AWSError, data: WorkSpaces.Types.ModifyWorkspaceStateResult) => void): Request<WorkSpaces.Types.ModifyWorkspaceStateResult, AWSError>;
270 /**
271 * 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.
272 */
273 rebootWorkspaces(params: WorkSpaces.Types.RebootWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.RebootWorkspacesResult) => void): Request<WorkSpaces.Types.RebootWorkspacesResult, AWSError>;
274 /**
275 * 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.
276 */
277 rebootWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.RebootWorkspacesResult) => void): Request<WorkSpaces.Types.RebootWorkspacesResult, AWSError>;
278 /**
279 * Rebuilds the specified WorkSpace. You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, or STOPPED. 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.
280 */
281 rebuildWorkspaces(params: WorkSpaces.Types.RebuildWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.RebuildWorkspacesResult) => void): Request<WorkSpaces.Types.RebuildWorkspacesResult, AWSError>;
282 /**
283 * Rebuilds the specified WorkSpace. You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, or STOPPED. 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.
284 */
285 rebuildWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.RebuildWorkspacesResult) => void): Request<WorkSpaces.Types.RebuildWorkspacesResult, AWSError>;
286 /**
287 * 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.
288 */
289 registerWorkspaceDirectory(params: WorkSpaces.Types.RegisterWorkspaceDirectoryRequest, callback?: (err: AWSError, data: WorkSpaces.Types.RegisterWorkspaceDirectoryResult) => void): Request<WorkSpaces.Types.RegisterWorkspaceDirectoryResult, AWSError>;
290 /**
291 * 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.
292 */
293 registerWorkspaceDirectory(callback?: (err: AWSError, data: WorkSpaces.Types.RegisterWorkspaceDirectoryResult) => void): Request<WorkSpaces.Types.RegisterWorkspaceDirectoryResult, AWSError>;
294 /**
295 * 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.
296 */
297 restoreWorkspace(params: WorkSpaces.Types.RestoreWorkspaceRequest, callback?: (err: AWSError, data: WorkSpaces.Types.RestoreWorkspaceResult) => void): Request<WorkSpaces.Types.RestoreWorkspaceResult, AWSError>;
298 /**
299 * 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.
300 */
301 restoreWorkspace(callback?: (err: AWSError, data: WorkSpaces.Types.RestoreWorkspaceResult) => void): Request<WorkSpaces.Types.RestoreWorkspaceResult, AWSError>;
302 /**
303 * Removes one or more rules from the specified IP access control group.
304 */
305 revokeIpRules(params: WorkSpaces.Types.RevokeIpRulesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.RevokeIpRulesResult) => void): Request<WorkSpaces.Types.RevokeIpRulesResult, AWSError>;
306 /**
307 * Removes one or more rules from the specified IP access control group.
308 */
309 revokeIpRules(callback?: (err: AWSError, data: WorkSpaces.Types.RevokeIpRulesResult) => void): Request<WorkSpaces.Types.RevokeIpRulesResult, AWSError>;
310 /**
311 * Starts the specified WorkSpaces. You cannot start a WorkSpace unless it has a running mode of AutoStop and a state of STOPPED.
312 */
313 startWorkspaces(params: WorkSpaces.Types.StartWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.StartWorkspacesResult) => void): Request<WorkSpaces.Types.StartWorkspacesResult, AWSError>;
314 /**
315 * Starts the specified WorkSpaces. You cannot start a WorkSpace unless it has a running mode of AutoStop and a state of STOPPED.
316 */
317 startWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.StartWorkspacesResult) => void): Request<WorkSpaces.Types.StartWorkspacesResult, AWSError>;
318 /**
319 * 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.
320 */
321 stopWorkspaces(params: WorkSpaces.Types.StopWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.StopWorkspacesResult) => void): Request<WorkSpaces.Types.StopWorkspacesResult, AWSError>;
322 /**
323 * 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.
324 */
325 stopWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.StopWorkspacesResult) => void): Request<WorkSpaces.Types.StopWorkspacesResult, AWSError>;
326 /**
327 * 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.
328 */
329 terminateWorkspaces(params: WorkSpaces.Types.TerminateWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.TerminateWorkspacesResult) => void): Request<WorkSpaces.Types.TerminateWorkspacesResult, AWSError>;
330 /**
331 * 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.
332 */
333 terminateWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.TerminateWorkspacesResult) => void): Request<WorkSpaces.Types.TerminateWorkspacesResult, AWSError>;
334 /**
335 * Replaces the current rules of the specified IP access control group with the specified rules.
336 */
337 updateRulesOfIpGroup(params: WorkSpaces.Types.UpdateRulesOfIpGroupRequest, callback?: (err: AWSError, data: WorkSpaces.Types.UpdateRulesOfIpGroupResult) => void): Request<WorkSpaces.Types.UpdateRulesOfIpGroupResult, AWSError>;
338 /**
339 * Replaces the current rules of the specified IP access control group with the specified rules.
340 */
341 updateRulesOfIpGroup(callback?: (err: AWSError, data: WorkSpaces.Types.UpdateRulesOfIpGroupResult) => void): Request<WorkSpaces.Types.UpdateRulesOfIpGroupResult, AWSError>;
342}
343declare namespace WorkSpaces {
344 export type ARN = string;
345 export type AccessPropertyValue = "ALLOW"|"DENY"|string;
346 export interface AccountModification {
347 /**
348 * The state of the modification to the configuration of BYOL.
349 */
350 ModificationState?: DedicatedTenancyModificationStateEnum;
351 /**
352 * The status of BYOL (whether BYOL is being enabled or disabled).
353 */
354 DedicatedTenancySupport?: DedicatedTenancySupportResultEnum;
355 /**
356 * The IP address range, specified as an IPv4 CIDR block, for the management network interface used for the account.
357 */
358 DedicatedTenancyManagementCidrRange?: DedicatedTenancyManagementCidrRange;
359 /**
360 * The timestamp when the modification of the BYOL configuration was started.
361 */
362 StartTime?: Timestamp;
363 /**
364 * The error code that is returned if the configuration of BYOL cannot be modified.
365 */
366 ErrorCode?: WorkspaceErrorCode;
367 /**
368 * The text of the error message that is returned if the configuration of BYOL cannot be modified.
369 */
370 ErrorMessage?: Description;
371 }
372 export type AccountModificationList = AccountModification[];
373 export type Alias = string;
374 export interface AssociateIpGroupsRequest {
375 /**
376 * The identifier of the directory.
377 */
378 DirectoryId: DirectoryId;
379 /**
380 * The identifiers of one or more IP access control groups.
381 */
382 GroupIds: IpGroupIdList;
383 }
384 export interface AssociateIpGroupsResult {
385 }
386 export interface AuthorizeIpRulesRequest {
387 /**
388 * The identifier of the group.
389 */
390 GroupId: IpGroupId;
391 /**
392 * The rules to add to the group.
393 */
394 UserRules: IpRuleList;
395 }
396 export interface AuthorizeIpRulesResult {
397 }
398 export type BooleanObject = boolean;
399 export type BundleId = string;
400 export type BundleIdList = BundleId[];
401 export type BundleList = WorkspaceBundle[];
402 export type BundleOwner = string;
403 export interface ClientProperties {
404 /**
405 * Specifies whether users can cache their credentials on the Amazon WorkSpaces client. When enabled, users can choose to reconnect to their WorkSpaces without re-entering their credentials.
406 */
407 ReconnectEnabled?: ReconnectEnum;
408 }
409 export type ClientPropertiesList = ClientPropertiesResult[];
410 export interface ClientPropertiesResult {
411 /**
412 * The resource identifier, in the form of a directory ID.
413 */
414 ResourceId?: NonEmptyString;
415 /**
416 * Information about the Amazon WorkSpaces client.
417 */
418 ClientProperties?: ClientProperties;
419 }
420 export type Compute = "VALUE"|"STANDARD"|"PERFORMANCE"|"POWER"|"GRAPHICS"|"POWERPRO"|"GRAPHICSPRO"|string;
421 export interface ComputeType {
422 /**
423 * The compute type.
424 */
425 Name?: Compute;
426 }
427 export type ComputerName = string;
428 export type ConnectionState = "CONNECTED"|"DISCONNECTED"|"UNKNOWN"|string;
429 export interface CopyWorkspaceImageRequest {
430 /**
431 * The name of the image.
432 */
433 Name: WorkspaceImageName;
434 /**
435 * A description of the image.
436 */
437 Description?: WorkspaceImageDescription;
438 /**
439 * The identifier of the source image.
440 */
441 SourceImageId: WorkspaceImageId;
442 /**
443 * The identifier of the source Region.
444 */
445 SourceRegion: Region;
446 /**
447 * The tags for the image.
448 */
449 Tags?: TagList;
450 }
451 export interface CopyWorkspaceImageResult {
452 /**
453 * The identifier of the image.
454 */
455 ImageId?: WorkspaceImageId;
456 }
457 export interface CreateIpGroupRequest {
458 /**
459 * The name of the group.
460 */
461 GroupName: IpGroupName;
462 /**
463 * The description of the group.
464 */
465 GroupDesc?: IpGroupDesc;
466 /**
467 * The rules to add to the group.
468 */
469 UserRules?: IpRuleList;
470 /**
471 * The tags. Each WorkSpaces resource can have a maximum of 50 tags.
472 */
473 Tags?: TagList;
474 }
475 export interface CreateIpGroupResult {
476 /**
477 * The identifier of the group.
478 */
479 GroupId?: IpGroupId;
480 }
481 export interface CreateTagsRequest {
482 /**
483 * The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, and IP access control groups.
484 */
485 ResourceId: NonEmptyString;
486 /**
487 * The tags. Each WorkSpaces resource can have a maximum of 50 tags. If you want to add new tags to a set of existing tags, you must submit all of the existing tags along with the new ones.
488 */
489 Tags: TagList;
490 }
491 export interface CreateTagsResult {
492 }
493 export interface CreateWorkspacesRequest {
494 /**
495 * The WorkSpaces to create. You can specify up to 25 WorkSpaces.
496 */
497 Workspaces: WorkspaceRequestList;
498 }
499 export interface CreateWorkspacesResult {
500 /**
501 * Information about the WorkSpaces that could not be created.
502 */
503 FailedRequests?: FailedCreateWorkspaceRequests;
504 /**
505 * Information about the WorkSpaces that were created. Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned can be incomplete.
506 */
507 PendingRequests?: WorkspaceList;
508 }
509 export type DedicatedTenancyCidrRangeList = DedicatedTenancyManagementCidrRange[];
510 export type DedicatedTenancyManagementCidrRange = string;
511 export type DedicatedTenancyModificationStateEnum = "PENDING"|"COMPLETED"|"FAILED"|string;
512 export type DedicatedTenancySupportEnum = "ENABLED"|string;
513 export type DedicatedTenancySupportResultEnum = "ENABLED"|"DISABLED"|string;
514 export type DefaultOu = string;
515 export interface DefaultWorkspaceCreationProperties {
516 /**
517 * Specifies whether the directory is enabled for Amazon WorkDocs.
518 */
519 EnableWorkDocs?: BooleanObject;
520 /**
521 * Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in this directory by default. If enabled, the Elastic public IP address allows outbound internet access from your WorkSpaces when you’re using an internet gateway in the Amazon VPC in which your WorkSpaces are located. If you're using a Network Address Translation (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in public subnets and you manually assign them Elastic IP addresses, you should disable this setting. This setting applies to new WorkSpaces that you launch or to existing WorkSpaces that you rebuild. For more information, see Configure a VPC for Amazon WorkSpaces.
522 */
523 EnableInternetAccess?: BooleanObject;
524 /**
525 * The organizational unit (OU) in the directory for the WorkSpace machine accounts.
526 */
527 DefaultOu?: DefaultOu;
528 /**
529 * The identifier of any security groups to apply to WorkSpaces when they are created.
530 */
531 CustomSecurityGroupId?: SecurityGroupId;
532 /**
533 * Specifies whether WorkSpace users are local administrators on their WorkSpaces.
534 */
535 UserEnabledAsLocalAdministrator?: BooleanObject;
536 /**
537 * Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see WorkSpace Maintenance.
538 */
539 EnableMaintenanceMode?: BooleanObject;
540 }
541 export interface DeleteIpGroupRequest {
542 /**
543 * The identifier of the IP access control group.
544 */
545 GroupId: IpGroupId;
546 }
547 export interface DeleteIpGroupResult {
548 }
549 export interface DeleteTagsRequest {
550 /**
551 * The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, and IP access control groups.
552 */
553 ResourceId: NonEmptyString;
554 /**
555 * The tag keys.
556 */
557 TagKeys: TagKeyList;
558 }
559 export interface DeleteTagsResult {
560 }
561 export interface DeleteWorkspaceImageRequest {
562 /**
563 * The identifier of the image.
564 */
565 ImageId: WorkspaceImageId;
566 }
567 export interface DeleteWorkspaceImageResult {
568 }
569 export interface DeregisterWorkspaceDirectoryRequest {
570 /**
571 * The identifier of the directory. If any WorkSpaces are registered to this directory, you must remove them before you deregister the directory, or you will receive an OperationNotSupportedException error.
572 */
573 DirectoryId: DirectoryId;
574 }
575 export interface DeregisterWorkspaceDirectoryResult {
576 }
577 export interface DescribeAccountModificationsRequest {
578 /**
579 * If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
580 */
581 NextToken?: PaginationToken;
582 }
583 export interface DescribeAccountModificationsResult {
584 /**
585 * The list of modifications to the configuration of BYOL.
586 */
587 AccountModifications?: AccountModificationList;
588 /**
589 * The token to use to retrieve the next set of results, or null if no more results are available.
590 */
591 NextToken?: PaginationToken;
592 }
593 export interface DescribeAccountRequest {
594 }
595 export interface DescribeAccountResult {
596 /**
597 * The status of BYOL (whether BYOL is enabled or disabled).
598 */
599 DedicatedTenancySupport?: DedicatedTenancySupportResultEnum;
600 /**
601 * The IP address range, specified as an IPv4 CIDR block, used for the management network interface. 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.
602 */
603 DedicatedTenancyManagementCidrRange?: DedicatedTenancyManagementCidrRange;
604 }
605 export interface DescribeClientPropertiesRequest {
606 /**
607 * The resource identifier, in the form of directory IDs.
608 */
609 ResourceIds: ResourceIdList;
610 }
611 export interface DescribeClientPropertiesResult {
612 /**
613 * Information about the specified Amazon WorkSpaces clients.
614 */
615 ClientPropertiesList?: ClientPropertiesList;
616 }
617 export interface DescribeIpGroupsRequest {
618 /**
619 * The identifiers of one or more IP access control groups.
620 */
621 GroupIds?: IpGroupIdList;
622 /**
623 * If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
624 */
625 NextToken?: PaginationToken;
626 /**
627 * The maximum number of items to return.
628 */
629 MaxResults?: Limit;
630 }
631 export interface DescribeIpGroupsResult {
632 /**
633 * Information about the IP access control groups.
634 */
635 Result?: WorkspacesIpGroupsList;
636 /**
637 * The token to use to retrieve the next set of results, or null if no more results are available.
638 */
639 NextToken?: PaginationToken;
640 }
641 export interface DescribeTagsRequest {
642 /**
643 * The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, and IP access control groups.
644 */
645 ResourceId: NonEmptyString;
646 }
647 export interface DescribeTagsResult {
648 /**
649 * The tags.
650 */
651 TagList?: TagList;
652 }
653 export interface DescribeWorkspaceBundlesRequest {
654 /**
655 * The identifiers of the bundles. You cannot combine this parameter with any other filter.
656 */
657 BundleIds?: BundleIdList;
658 /**
659 * The owner of the bundles. You cannot combine this parameter with any other filter. Specify AMAZON to describe the bundles provided by AWS or null to describe the bundles that belong to your account.
660 */
661 Owner?: BundleOwner;
662 /**
663 * The token for the next set of results. (You received this token from a previous call.)
664 */
665 NextToken?: PaginationToken;
666 }
667 export interface DescribeWorkspaceBundlesResult {
668 /**
669 * Information about the bundles.
670 */
671 Bundles?: BundleList;
672 /**
673 * The token to use to retrieve the next set of results, or null if there are no more results available. This token is valid for one day and must be used within that time frame.
674 */
675 NextToken?: PaginationToken;
676 }
677 export interface DescribeWorkspaceDirectoriesRequest {
678 /**
679 * The identifiers of the directories. If the value is null, all directories are retrieved.
680 */
681 DirectoryIds?: DirectoryIdList;
682 /**
683 * The maximum number of directories to return.
684 */
685 Limit?: Limit;
686 /**
687 * If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
688 */
689 NextToken?: PaginationToken;
690 }
691 export interface DescribeWorkspaceDirectoriesResult {
692 /**
693 * Information about the directories.
694 */
695 Directories?: DirectoryList;
696 /**
697 * The token to use to retrieve the next set of results, or null if no more results are available.
698 */
699 NextToken?: PaginationToken;
700 }
701 export interface DescribeWorkspaceImagesRequest {
702 /**
703 * The identifier of the image.
704 */
705 ImageIds?: WorkspaceImageIdList;
706 /**
707 * If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
708 */
709 NextToken?: PaginationToken;
710 /**
711 * The maximum number of items to return.
712 */
713 MaxResults?: Limit;
714 }
715 export interface DescribeWorkspaceImagesResult {
716 /**
717 * Information about the images.
718 */
719 Images?: WorkspaceImageList;
720 /**
721 * The token to use to retrieve the next set of results, or null if no more results are available.
722 */
723 NextToken?: PaginationToken;
724 }
725 export interface DescribeWorkspaceSnapshotsRequest {
726 /**
727 * The identifier of the WorkSpace.
728 */
729 WorkspaceId: WorkspaceId;
730 }
731 export interface DescribeWorkspaceSnapshotsResult {
732 /**
733 * Information about the snapshots that can be used to rebuild a WorkSpace. These snapshots include the user volume.
734 */
735 RebuildSnapshots?: SnapshotList;
736 /**
737 * Information about the snapshots that can be used to restore a WorkSpace. These snapshots include both the root volume and the user volume.
738 */
739 RestoreSnapshots?: SnapshotList;
740 }
741 export interface DescribeWorkspacesConnectionStatusRequest {
742 /**
743 * The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.
744 */
745 WorkspaceIds?: WorkspaceIdList;
746 /**
747 * If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
748 */
749 NextToken?: PaginationToken;
750 }
751 export interface DescribeWorkspacesConnectionStatusResult {
752 /**
753 * Information about the connection status of the WorkSpace.
754 */
755 WorkspacesConnectionStatus?: WorkspaceConnectionStatusList;
756 /**
757 * The token to use to retrieve the next set of results, or null if no more results are available.
758 */
759 NextToken?: PaginationToken;
760 }
761 export interface DescribeWorkspacesRequest {
762 /**
763 * The identifiers of the WorkSpaces. You cannot combine this parameter with any other filter. Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.
764 */
765 WorkspaceIds?: WorkspaceIdList;
766 /**
767 * The identifier of the directory. In addition, you can optionally specify a specific directory user (see UserName). You cannot combine this parameter with any other filter.
768 */
769 DirectoryId?: DirectoryId;
770 /**
771 * The name of the directory user. You must specify this parameter with DirectoryId.
772 */
773 UserName?: UserName;
774 /**
775 * The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.
776 */
777 BundleId?: BundleId;
778 /**
779 * The maximum number of items to return.
780 */
781 Limit?: Limit;
782 /**
783 * If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
784 */
785 NextToken?: PaginationToken;
786 }
787 export interface DescribeWorkspacesResult {
788 /**
789 * Information about the WorkSpaces. Because CreateWorkspaces is an asynchronous operation, some of the returned information could be incomplete.
790 */
791 Workspaces?: WorkspaceList;
792 /**
793 * The token to use to retrieve the next set of results, or null if no more results are available.
794 */
795 NextToken?: PaginationToken;
796 }
797 export type Description = string;
798 export type DirectoryId = string;
799 export type DirectoryIdList = DirectoryId[];
800 export type DirectoryList = WorkspaceDirectory[];
801 export type DirectoryName = string;
802 export interface DisassociateIpGroupsRequest {
803 /**
804 * The identifier of the directory.
805 */
806 DirectoryId: DirectoryId;
807 /**
808 * The identifiers of one or more IP access control groups.
809 */
810 GroupIds: IpGroupIdList;
811 }
812 export interface DisassociateIpGroupsResult {
813 }
814 export type DnsIpAddresses = IpAddress[];
815 export type Ec2ImageId = string;
816 export type ErrorType = string;
817 export interface FailedCreateWorkspaceRequest {
818 /**
819 * Information about the WorkSpace.
820 */
821 WorkspaceRequest?: WorkspaceRequest;
822 /**
823 * The error code that is returned if the WorkSpace cannot be created.
824 */
825 ErrorCode?: ErrorType;
826 /**
827 * The text of the error message that is returned if the WorkSpace cannot be created.
828 */
829 ErrorMessage?: Description;
830 }
831 export type FailedCreateWorkspaceRequests = FailedCreateWorkspaceRequest[];
832 export type FailedRebootWorkspaceRequests = FailedWorkspaceChangeRequest[];
833 export type FailedRebuildWorkspaceRequests = FailedWorkspaceChangeRequest[];
834 export type FailedStartWorkspaceRequests = FailedWorkspaceChangeRequest[];
835 export type FailedStopWorkspaceRequests = FailedWorkspaceChangeRequest[];
836 export type FailedTerminateWorkspaceRequests = FailedWorkspaceChangeRequest[];
837 export interface FailedWorkspaceChangeRequest {
838 /**
839 * The identifier of the WorkSpace.
840 */
841 WorkspaceId?: WorkspaceId;
842 /**
843 * The error code that is returned if the WorkSpace cannot be rebooted.
844 */
845 ErrorCode?: ErrorType;
846 /**
847 * The text of the error message that is returned if the WorkSpace cannot be rebooted.
848 */
849 ErrorMessage?: Description;
850 }
851 export interface ImportWorkspaceImageRequest {
852 /**
853 * The identifier of the EC2 image.
854 */
855 Ec2ImageId: Ec2ImageId;
856 /**
857 * The ingestion process to be used when importing the image.
858 */
859 IngestionProcess: WorkspaceImageIngestionProcess;
860 /**
861 * The name of the WorkSpace image.
862 */
863 ImageName: WorkspaceImageName;
864 /**
865 * The description of the WorkSpace image.
866 */
867 ImageDescription: WorkspaceImageDescription;
868 /**
869 * The tags. Each WorkSpaces resource can have a maximum of 50 tags.
870 */
871 Tags?: TagList;
872 }
873 export interface ImportWorkspaceImageResult {
874 /**
875 * The identifier of the WorkSpace image.
876 */
877 ImageId?: WorkspaceImageId;
878 }
879 export type IpAddress = string;
880 export type IpGroupDesc = string;
881 export type IpGroupId = string;
882 export type IpGroupIdList = IpGroupId[];
883 export type IpGroupName = string;
884 export type IpRevokedRuleList = IpRule[];
885 export type IpRule = string;
886 export type IpRuleDesc = string;
887 export interface IpRuleItem {
888 /**
889 * The IP address range, in CIDR notation.
890 */
891 ipRule?: IpRule;
892 /**
893 * The description.
894 */
895 ruleDesc?: IpRuleDesc;
896 }
897 export type IpRuleList = IpRuleItem[];
898 export type Limit = number;
899 export interface ListAvailableManagementCidrRangesRequest {
900 /**
901 * The IP address range to search. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block).
902 */
903 ManagementCidrRangeConstraint: ManagementCidrRangeConstraint;
904 /**
905 * The maximum number of items to return.
906 */
907 MaxResults?: ManagementCidrRangeMaxResults;
908 /**
909 * If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
910 */
911 NextToken?: PaginationToken;
912 }
913 export interface ListAvailableManagementCidrRangesResult {
914 /**
915 * The list of available IP address ranges, specified as IPv4 CIDR blocks.
916 */
917 ManagementCidrRanges?: DedicatedTenancyCidrRangeList;
918 /**
919 * The token to use to retrieve the next set of results, or null if no more results are available.
920 */
921 NextToken?: PaginationToken;
922 }
923 export type ManagementCidrRangeConstraint = string;
924 export type ManagementCidrRangeMaxResults = number;
925 export interface MigrateWorkspaceRequest {
926 /**
927 * The identifier of the WorkSpace to migrate from.
928 */
929 SourceWorkspaceId: WorkspaceId;
930 /**
931 * The identifier of the target bundle type to migrate the WorkSpace to.
932 */
933 BundleId: BundleId;
934 }
935 export interface MigrateWorkspaceResult {
936 /**
937 * The original identifier of the WorkSpace that is being migrated.
938 */
939 SourceWorkspaceId?: WorkspaceId;
940 /**
941 * The new identifier of the WorkSpace that is being migrated. If the migration does not succeed, the target WorkSpace ID will not be used, and the WorkSpace will still have the original WorkSpace ID.
942 */
943 TargetWorkspaceId?: WorkspaceId;
944 }
945 export type ModificationResourceEnum = "ROOT_VOLUME"|"USER_VOLUME"|"COMPUTE_TYPE"|string;
946 export interface ModificationState {
947 /**
948 * The resource.
949 */
950 Resource?: ModificationResourceEnum;
951 /**
952 * The modification state.
953 */
954 State?: ModificationStateEnum;
955 }
956 export type ModificationStateEnum = "UPDATE_INITIATED"|"UPDATE_IN_PROGRESS"|string;
957 export type ModificationStateList = ModificationState[];
958 export interface ModifyAccountRequest {
959 /**
960 * The status of BYOL.
961 */
962 DedicatedTenancySupport?: DedicatedTenancySupportEnum;
963 /**
964 * The IP address range, specified as an IPv4 CIDR block, for the management network interface. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block). The CIDR block size must be /16 (for example, 203.0.113.25/16). It must also be specified as available by the ListAvailableManagementCidrRanges operation.
965 */
966 DedicatedTenancyManagementCidrRange?: DedicatedTenancyManagementCidrRange;
967 }
968 export interface ModifyAccountResult {
969 }
970 export interface ModifyClientPropertiesRequest {
971 /**
972 * The resource identifiers, in the form of directory IDs.
973 */
974 ResourceId: NonEmptyString;
975 /**
976 * Information about the Amazon WorkSpaces client.
977 */
978 ClientProperties: ClientProperties;
979 }
980 export interface ModifyClientPropertiesResult {
981 }
982 export interface ModifySelfservicePermissionsRequest {
983 /**
984 * The identifier of the directory.
985 */
986 ResourceId: DirectoryId;
987 /**
988 * The permissions to enable or disable self-service capabilities.
989 */
990 SelfservicePermissions: SelfservicePermissions;
991 }
992 export interface ModifySelfservicePermissionsResult {
993 }
994 export interface ModifyWorkspaceAccessPropertiesRequest {
995 /**
996 * The identifier of the directory.
997 */
998 ResourceId: DirectoryId;
999 /**
1000 * The device types and operating systems to enable or disable for access.
1001 */
1002 WorkspaceAccessProperties: WorkspaceAccessProperties;
1003 }
1004 export interface ModifyWorkspaceAccessPropertiesResult {
1005 }
1006 export interface ModifyWorkspaceCreationPropertiesRequest {
1007 /**
1008 * The identifier of the directory.
1009 */
1010 ResourceId: DirectoryId;
1011 /**
1012 * The default properties for creating WorkSpaces.
1013 */
1014 WorkspaceCreationProperties: WorkspaceCreationProperties;
1015 }
1016 export interface ModifyWorkspaceCreationPropertiesResult {
1017 }
1018 export interface ModifyWorkspacePropertiesRequest {
1019 /**
1020 * The identifier of the WorkSpace.
1021 */
1022 WorkspaceId: WorkspaceId;
1023 /**
1024 * The properties of the WorkSpace.
1025 */
1026 WorkspaceProperties: WorkspaceProperties;
1027 }
1028 export interface ModifyWorkspacePropertiesResult {
1029 }
1030 export interface ModifyWorkspaceStateRequest {
1031 /**
1032 * The identifier of the WorkSpace.
1033 */
1034 WorkspaceId: WorkspaceId;
1035 /**
1036 * The WorkSpace state.
1037 */
1038 WorkspaceState: TargetWorkspaceState;
1039 }
1040 export interface ModifyWorkspaceStateResult {
1041 }
1042 export type NonEmptyString = string;
1043 export interface OperatingSystem {
1044 /**
1045 * The operating system.
1046 */
1047 Type?: OperatingSystemType;
1048 }
1049 export type OperatingSystemType = "WINDOWS"|"LINUX"|string;
1050 export type PaginationToken = string;
1051 export interface RebootRequest {
1052 /**
1053 * The identifier of the WorkSpace.
1054 */
1055 WorkspaceId: WorkspaceId;
1056 }
1057 export type RebootWorkspaceRequests = RebootRequest[];
1058 export interface RebootWorkspacesRequest {
1059 /**
1060 * The WorkSpaces to reboot. You can specify up to 25 WorkSpaces.
1061 */
1062 RebootWorkspaceRequests: RebootWorkspaceRequests;
1063 }
1064 export interface RebootWorkspacesResult {
1065 /**
1066 * Information about the WorkSpaces that could not be rebooted.
1067 */
1068 FailedRequests?: FailedRebootWorkspaceRequests;
1069 }
1070 export interface RebuildRequest {
1071 /**
1072 * The identifier of the WorkSpace.
1073 */
1074 WorkspaceId: WorkspaceId;
1075 }
1076 export type RebuildWorkspaceRequests = RebuildRequest[];
1077 export interface RebuildWorkspacesRequest {
1078 /**
1079 * The WorkSpace to rebuild. You can specify a single WorkSpace.
1080 */
1081 RebuildWorkspaceRequests: RebuildWorkspaceRequests;
1082 }
1083 export interface RebuildWorkspacesResult {
1084 /**
1085 * Information about the WorkSpace that could not be rebuilt.
1086 */
1087 FailedRequests?: FailedRebuildWorkspaceRequests;
1088 }
1089 export type ReconnectEnum = "ENABLED"|"DISABLED"|string;
1090 export type Region = string;
1091 export interface RegisterWorkspaceDirectoryRequest {
1092 /**
1093 * The identifier of the directory. You cannot register a directory if it does not have a status of Active. If the directory does not have a status of Active, you will receive an InvalidResourceStateException error. If you have already registered the maximum number of directories that you can register with Amazon WorkSpaces, you will receive a ResourceLimitExceededException error. Deregister directories that you are not using for WorkSpaces, and try again.
1094 */
1095 DirectoryId: DirectoryId;
1096 /**
1097 * The identifiers of the subnets for your virtual private cloud (VPC). Make sure that the subnets are in supported Availability Zones. The subnets must also be in separate Availability Zones. If these conditions are not met, you will receive an OperationNotSupportedException error.
1098 */
1099 SubnetIds?: SubnetIds;
1100 /**
1101 * Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this parameter and WorkDocs is not available in the Region, you will receive an OperationNotSupportedException error. Set EnableWorkDocs to disabled, and try again.
1102 */
1103 EnableWorkDocs: BooleanObject;
1104 /**
1105 * Indicates whether self-service capabilities are enabled or disabled.
1106 */
1107 EnableSelfService?: BooleanObject;
1108 /**
1109 * Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own License (BYOL) images, this value must be set to DEDICATED and your AWS account must be enabled for BYOL. If your account has not been enabled for BYOL, you will receive an InvalidParameterValuesException error. For more information about BYOL images, see Bring Your Own Windows Desktop Images.
1110 */
1111 Tenancy?: Tenancy;
1112 /**
1113 * The tags associated with the directory.
1114 */
1115 Tags?: TagList;
1116 }
1117 export interface RegisterWorkspaceDirectoryResult {
1118 }
1119 export type RegistrationCode = string;
1120 export type ResourceIdList = NonEmptyString[];
1121 export interface RestoreWorkspaceRequest {
1122 /**
1123 * The identifier of the WorkSpace.
1124 */
1125 WorkspaceId: WorkspaceId;
1126 }
1127 export interface RestoreWorkspaceResult {
1128 }
1129 export interface RevokeIpRulesRequest {
1130 /**
1131 * The identifier of the group.
1132 */
1133 GroupId: IpGroupId;
1134 /**
1135 * The rules to remove from the group.
1136 */
1137 UserRules: IpRevokedRuleList;
1138 }
1139 export interface RevokeIpRulesResult {
1140 }
1141 export interface RootStorage {
1142 /**
1143 * The size of the root volume.
1144 */
1145 Capacity?: NonEmptyString;
1146 }
1147 export type RootVolumeSizeGib = number;
1148 export type RunningMode = "AUTO_STOP"|"ALWAYS_ON"|string;
1149 export type RunningModeAutoStopTimeoutInMinutes = number;
1150 export type SecurityGroupId = string;
1151 export interface SelfservicePermissions {
1152 /**
1153 * Specifies whether users can restart their WorkSpace.
1154 */
1155 RestartWorkspace?: ReconnectEnum;
1156 /**
1157 * Specifies whether users can increase the volume size of the drives on their WorkSpace.
1158 */
1159 IncreaseVolumeSize?: ReconnectEnum;
1160 /**
1161 * Specifies whether users can change the compute type (bundle) for their WorkSpace.
1162 */
1163 ChangeComputeType?: ReconnectEnum;
1164 /**
1165 * Specifies whether users can switch the running mode of their WorkSpace.
1166 */
1167 SwitchRunningMode?: ReconnectEnum;
1168 /**
1169 * Specifies whether users can rebuild the operating system of a WorkSpace to its original state.
1170 */
1171 RebuildWorkspace?: ReconnectEnum;
1172 }
1173 export interface Snapshot {
1174 /**
1175 * The time when the snapshot was created.
1176 */
1177 SnapshotTime?: Timestamp;
1178 }
1179 export type SnapshotList = Snapshot[];
1180 export interface StartRequest {
1181 /**
1182 * The identifier of the WorkSpace.
1183 */
1184 WorkspaceId?: WorkspaceId;
1185 }
1186 export type StartWorkspaceRequests = StartRequest[];
1187 export interface StartWorkspacesRequest {
1188 /**
1189 * The WorkSpaces to start. You can specify up to 25 WorkSpaces.
1190 */
1191 StartWorkspaceRequests: StartWorkspaceRequests;
1192 }
1193 export interface StartWorkspacesResult {
1194 /**
1195 * Information about the WorkSpaces that could not be started.
1196 */
1197 FailedRequests?: FailedStartWorkspaceRequests;
1198 }
1199 export interface StopRequest {
1200 /**
1201 * The identifier of the WorkSpace.
1202 */
1203 WorkspaceId?: WorkspaceId;
1204 }
1205 export type StopWorkspaceRequests = StopRequest[];
1206 export interface StopWorkspacesRequest {
1207 /**
1208 * The WorkSpaces to stop. You can specify up to 25 WorkSpaces.
1209 */
1210 StopWorkspaceRequests: StopWorkspaceRequests;
1211 }
1212 export interface StopWorkspacesResult {
1213 /**
1214 * Information about the WorkSpaces that could not be stopped.
1215 */
1216 FailedRequests?: FailedStopWorkspaceRequests;
1217 }
1218 export type SubnetId = string;
1219 export type SubnetIds = SubnetId[];
1220 export interface Tag {
1221 /**
1222 * The key of the tag.
1223 */
1224 Key: TagKey;
1225 /**
1226 * The value of the tag.
1227 */
1228 Value?: TagValue;
1229 }
1230 export type TagKey = string;
1231 export type TagKeyList = NonEmptyString[];
1232 export type TagList = Tag[];
1233 export type TagValue = string;
1234 export type TargetWorkspaceState = "AVAILABLE"|"ADMIN_MAINTENANCE"|string;
1235 export type Tenancy = "DEDICATED"|"SHARED"|string;
1236 export interface TerminateRequest {
1237 /**
1238 * The identifier of the WorkSpace.
1239 */
1240 WorkspaceId: WorkspaceId;
1241 }
1242 export type TerminateWorkspaceRequests = TerminateRequest[];
1243 export interface TerminateWorkspacesRequest {
1244 /**
1245 * The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.
1246 */
1247 TerminateWorkspaceRequests: TerminateWorkspaceRequests;
1248 }
1249 export interface TerminateWorkspacesResult {
1250 /**
1251 * Information about the WorkSpaces that could not be terminated.
1252 */
1253 FailedRequests?: FailedTerminateWorkspaceRequests;
1254 }
1255 export type Timestamp = Date;
1256 export interface UpdateRulesOfIpGroupRequest {
1257 /**
1258 * The identifier of the group.
1259 */
1260 GroupId: IpGroupId;
1261 /**
1262 * One or more rules.
1263 */
1264 UserRules: IpRuleList;
1265 }
1266 export interface UpdateRulesOfIpGroupResult {
1267 }
1268 export type UserName = string;
1269 export interface UserStorage {
1270 /**
1271 * The size of the user storage.
1272 */
1273 Capacity?: NonEmptyString;
1274 }
1275 export type UserVolumeSizeGib = number;
1276 export type VolumeEncryptionKey = string;
1277 export interface Workspace {
1278 /**
1279 * The identifier of the WorkSpace.
1280 */
1281 WorkspaceId?: WorkspaceId;
1282 /**
1283 * The identifier of the AWS Directory Service directory for the WorkSpace.
1284 */
1285 DirectoryId?: DirectoryId;
1286 /**
1287 * The user for the WorkSpace.
1288 */
1289 UserName?: UserName;
1290 /**
1291 * The IP address of the WorkSpace.
1292 */
1293 IpAddress?: IpAddress;
1294 /**
1295 * The operational state of the WorkSpace.
1296 */
1297 State?: WorkspaceState;
1298 /**
1299 * The identifier of the bundle used to create the WorkSpace.
1300 */
1301 BundleId?: BundleId;
1302 /**
1303 * The identifier of the subnet for the WorkSpace.
1304 */
1305 SubnetId?: SubnetId;
1306 /**
1307 * The text of the error message that is returned if the WorkSpace cannot be created.
1308 */
1309 ErrorMessage?: Description;
1310 /**
1311 * The error code that is returned if the WorkSpace cannot be created.
1312 */
1313 ErrorCode?: WorkspaceErrorCode;
1314 /**
1315 * The name of the WorkSpace, as seen by the operating system.
1316 */
1317 ComputerName?: ComputerName;
1318 /**
1319 * The symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs.
1320 */
1321 VolumeEncryptionKey?: VolumeEncryptionKey;
1322 /**
1323 * Indicates whether the data stored on the user volume is encrypted.
1324 */
1325 UserVolumeEncryptionEnabled?: BooleanObject;
1326 /**
1327 * Indicates whether the data stored on the root volume is encrypted.
1328 */
1329 RootVolumeEncryptionEnabled?: BooleanObject;
1330 /**
1331 * The properties of the WorkSpace.
1332 */
1333 WorkspaceProperties?: WorkspaceProperties;
1334 /**
1335 * The modification states of the WorkSpace.
1336 */
1337 ModificationStates?: ModificationStateList;
1338 }
1339 export interface WorkspaceAccessProperties {
1340 /**
1341 * Indicates whether users can use Windows clients to access their WorkSpaces. To restrict WorkSpaces access to trusted devices (also known as managed devices) with valid certificates, specify a value of TRUST. For more information, see Restrict WorkSpaces Access to Trusted Devices.
1342 */
1343 DeviceTypeWindows?: AccessPropertyValue;
1344 /**
1345 * Indicates whether users can use macOS clients to access their WorkSpaces. To restrict WorkSpaces access to trusted devices (also known as managed devices) with valid certificates, specify a value of TRUST. For more information, see Restrict WorkSpaces Access to Trusted Devices.
1346 */
1347 DeviceTypeOsx?: AccessPropertyValue;
1348 /**
1349 * Indicates whether users can access their WorkSpaces through a web browser.
1350 */
1351 DeviceTypeWeb?: AccessPropertyValue;
1352 /**
1353 * Indicates whether users can use iOS devices to access their WorkSpaces.
1354 */
1355 DeviceTypeIos?: AccessPropertyValue;
1356 /**
1357 * Indicates whether users can use Android devices to access their WorkSpaces.
1358 */
1359 DeviceTypeAndroid?: AccessPropertyValue;
1360 /**
1361 * Indicates whether users can use Chromebooks to access their WorkSpaces.
1362 */
1363 DeviceTypeChromeOs?: AccessPropertyValue;
1364 /**
1365 * Indicates whether users can use zero client devices to access their WorkSpaces.
1366 */
1367 DeviceTypeZeroClient?: AccessPropertyValue;
1368 }
1369 export interface WorkspaceBundle {
1370 /**
1371 * The bundle identifier.
1372 */
1373 BundleId?: BundleId;
1374 /**
1375 * The name of the bundle.
1376 */
1377 Name?: NonEmptyString;
1378 /**
1379 * The owner of the bundle. This is the account identifier of the owner, or AMAZON if the bundle is provided by AWS.
1380 */
1381 Owner?: BundleOwner;
1382 /**
1383 * A description.
1384 */
1385 Description?: Description;
1386 /**
1387 * The image identifier of the bundle.
1388 */
1389 ImageId?: WorkspaceImageId;
1390 /**
1391 * The size of the root volume.
1392 */
1393 RootStorage?: RootStorage;
1394 /**
1395 * The size of the user storage.
1396 */
1397 UserStorage?: UserStorage;
1398 /**
1399 * The compute type. For more information, see Amazon WorkSpaces Bundles.
1400 */
1401 ComputeType?: ComputeType;
1402 /**
1403 * The last time that the bundle was updated.
1404 */
1405 LastUpdatedTime?: Timestamp;
1406 }
1407 export interface WorkspaceConnectionStatus {
1408 /**
1409 * The identifier of the WorkSpace.
1410 */
1411 WorkspaceId?: WorkspaceId;
1412 /**
1413 * The connection state of the WorkSpace. The connection state is unknown if the WorkSpace is stopped.
1414 */
1415 ConnectionState?: ConnectionState;
1416 /**
1417 * The timestamp of the connection status check.
1418 */
1419 ConnectionStateCheckTimestamp?: Timestamp;
1420 /**
1421 * The timestamp of the last known user connection.
1422 */
1423 LastKnownUserConnectionTimestamp?: Timestamp;
1424 }
1425 export type WorkspaceConnectionStatusList = WorkspaceConnectionStatus[];
1426 export interface WorkspaceCreationProperties {
1427 /**
1428 * Indicates whether internet access is enabled for your WorkSpaces.
1429 */
1430 EnableInternetAccess?: BooleanObject;
1431 /**
1432 * The default organizational unit (OU) for your WorkSpace directories.
1433 */
1434 DefaultOu?: DefaultOu;
1435 /**
1436 * The identifier of your custom security group.
1437 */
1438 CustomSecurityGroupId?: SecurityGroupId;
1439 /**
1440 * Indicates whether users are local administrators of their WorkSpaces.
1441 */
1442 UserEnabledAsLocalAdministrator?: BooleanObject;
1443 /**
1444 * Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.
1445 */
1446 EnableMaintenanceMode?: BooleanObject;
1447 }
1448 export interface WorkspaceDirectory {
1449 /**
1450 * The directory identifier.
1451 */
1452 DirectoryId?: DirectoryId;
1453 /**
1454 * The directory alias.
1455 */
1456 Alias?: Alias;
1457 /**
1458 * The name of the directory.
1459 */
1460 DirectoryName?: DirectoryName;
1461 /**
1462 * The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.
1463 */
1464 RegistrationCode?: RegistrationCode;
1465 /**
1466 * The identifiers of the subnets used with the directory.
1467 */
1468 SubnetIds?: SubnetIds;
1469 /**
1470 * The IP addresses of the DNS servers for the directory.
1471 */
1472 DnsIpAddresses?: DnsIpAddresses;
1473 /**
1474 * The user name for the service account.
1475 */
1476 CustomerUserName?: UserName;
1477 /**
1478 * The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.
1479 */
1480 IamRoleId?: ARN;
1481 /**
1482 * The directory type.
1483 */
1484 DirectoryType?: WorkspaceDirectoryType;
1485 /**
1486 * The identifier of the security group that is assigned to new WorkSpaces.
1487 */
1488 WorkspaceSecurityGroupId?: SecurityGroupId;
1489 /**
1490 * The state of the directory's registration with Amazon WorkSpaces.
1491 */
1492 State?: WorkspaceDirectoryState;
1493 /**
1494 * The default creation properties for all WorkSpaces in the directory.
1495 */
1496 WorkspaceCreationProperties?: DefaultWorkspaceCreationProperties;
1497 /**
1498 * The identifiers of the IP access control groups associated with the directory.
1499 */
1500 ipGroupIds?: IpGroupIdList;
1501 /**
1502 * The devices and operating systems that users can use to access WorkSpaces.
1503 */
1504 WorkspaceAccessProperties?: WorkspaceAccessProperties;
1505 /**
1506 * Specifies whether the directory is dedicated or shared. To use Bring Your Own License (BYOL), this value must be set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.
1507 */
1508 Tenancy?: Tenancy;
1509 /**
1510 * The default self-service permissions for WorkSpaces in the directory.
1511 */
1512 SelfservicePermissions?: SelfservicePermissions;
1513 }
1514 export type WorkspaceDirectoryState = "REGISTERING"|"REGISTERED"|"DEREGISTERING"|"DEREGISTERED"|"ERROR"|string;
1515 export type WorkspaceDirectoryType = "SIMPLE_AD"|"AD_CONNECTOR"|string;
1516 export type WorkspaceErrorCode = string;
1517 export type WorkspaceId = string;
1518 export type WorkspaceIdList = WorkspaceId[];
1519 export interface WorkspaceImage {
1520 /**
1521 * The identifier of the image.
1522 */
1523 ImageId?: WorkspaceImageId;
1524 /**
1525 * The name of the image.
1526 */
1527 Name?: WorkspaceImageName;
1528 /**
1529 * The description of the image.
1530 */
1531 Description?: WorkspaceImageDescription;
1532 /**
1533 * The operating system that the image is running.
1534 */
1535 OperatingSystem?: OperatingSystem;
1536 /**
1537 * The status of the image.
1538 */
1539 State?: WorkspaceImageState;
1540 /**
1541 * Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.
1542 */
1543 RequiredTenancy?: WorkspaceImageRequiredTenancy;
1544 /**
1545 * The error code that is returned for the image.
1546 */
1547 ErrorCode?: WorkspaceImageErrorCode;
1548 /**
1549 * The text of the error message that is returned for the image.
1550 */
1551 ErrorMessage?: Description;
1552 }
1553 export type WorkspaceImageDescription = string;
1554 export type WorkspaceImageErrorCode = string;
1555 export type WorkspaceImageId = string;
1556 export type WorkspaceImageIdList = WorkspaceImageId[];
1557 export type WorkspaceImageIngestionProcess = "BYOL_REGULAR"|"BYOL_GRAPHICS"|"BYOL_GRAPHICSPRO"|string;
1558 export type WorkspaceImageList = WorkspaceImage[];
1559 export type WorkspaceImageName = string;
1560 export type WorkspaceImageRequiredTenancy = "DEFAULT"|"DEDICATED"|string;
1561 export type WorkspaceImageState = "AVAILABLE"|"PENDING"|"ERROR"|string;
1562 export type WorkspaceList = Workspace[];
1563 export interface WorkspaceProperties {
1564 /**
1565 * The running mode. For more information, see Manage the WorkSpace Running Mode.
1566 */
1567 RunningMode?: RunningMode;
1568 /**
1569 * The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
1570 */
1571 RunningModeAutoStopTimeoutInMinutes?: RunningModeAutoStopTimeoutInMinutes;
1572 /**
1573 * The size of the root volume.
1574 */
1575 RootVolumeSizeGib?: RootVolumeSizeGib;
1576 /**
1577 * The size of the user storage.
1578 */
1579 UserVolumeSizeGib?: UserVolumeSizeGib;
1580 /**
1581 * The compute type. For more information, see Amazon WorkSpaces Bundles.
1582 */
1583 ComputeTypeName?: Compute;
1584 }
1585 export interface WorkspaceRequest {
1586 /**
1587 * The identifier of the AWS Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.
1588 */
1589 DirectoryId: DirectoryId;
1590 /**
1591 * The user name of the user for the WorkSpace. This user name must exist in the AWS Directory Service directory for the WorkSpace.
1592 */
1593 UserName: UserName;
1594 /**
1595 * The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.
1596 */
1597 BundleId: BundleId;
1598 /**
1599 * The symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs.
1600 */
1601 VolumeEncryptionKey?: VolumeEncryptionKey;
1602 /**
1603 * Indicates whether the data stored on the user volume is encrypted.
1604 */
1605 UserVolumeEncryptionEnabled?: BooleanObject;
1606 /**
1607 * Indicates whether the data stored on the root volume is encrypted.
1608 */
1609 RootVolumeEncryptionEnabled?: BooleanObject;
1610 /**
1611 * The WorkSpace properties.
1612 */
1613 WorkspaceProperties?: WorkspaceProperties;
1614 /**
1615 * The tags for the WorkSpace.
1616 */
1617 Tags?: TagList;
1618 }
1619 export type WorkspaceRequestList = WorkspaceRequest[];
1620 export type WorkspaceState = "PENDING"|"AVAILABLE"|"IMPAIRED"|"UNHEALTHY"|"REBOOTING"|"STARTING"|"REBUILDING"|"RESTORING"|"MAINTENANCE"|"ADMIN_MAINTENANCE"|"TERMINATING"|"TERMINATED"|"SUSPENDED"|"UPDATING"|"STOPPING"|"STOPPED"|"ERROR"|string;
1621 export interface WorkspacesIpGroup {
1622 /**
1623 * The identifier of the group.
1624 */
1625 groupId?: IpGroupId;
1626 /**
1627 * The name of the group.
1628 */
1629 groupName?: IpGroupName;
1630 /**
1631 * The description of the group.
1632 */
1633 groupDesc?: IpGroupDesc;
1634 /**
1635 * The rules.
1636 */
1637 userRules?: IpRuleList;
1638 }
1639 export type WorkspacesIpGroupsList = WorkspacesIpGroup[];
1640 /**
1641 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1642 */
1643 export type apiVersion = "2015-04-08"|"latest"|string;
1644 export interface ClientApiVersions {
1645 /**
1646 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1647 */
1648 apiVersion?: apiVersion;
1649 }
1650 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
1651 /**
1652 * Contains interfaces for use with the WorkSpaces client.
1653 */
1654 export import Types = WorkSpaces;
1655}
1656export = WorkSpaces;