UNPKG

64.1 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 * Retrieves a list that describes the configuration of bring your own license (BYOL) for the specified account.
88 */
89 describeAccount(params: WorkSpaces.Types.DescribeAccountRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeAccountResult) => void): Request<WorkSpaces.Types.DescribeAccountResult, AWSError>;
90 /**
91 * Retrieves a list that describes the configuration of bring your own license (BYOL) for the specified account.
92 */
93 describeAccount(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeAccountResult) => void): Request<WorkSpaces.Types.DescribeAccountResult, AWSError>;
94 /**
95 * Retrieves a list that describes modifications to the configuration of bring your own license (BYOL) for the specified account.
96 */
97 describeAccountModifications(params: WorkSpaces.Types.DescribeAccountModificationsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeAccountModificationsResult) => void): Request<WorkSpaces.Types.DescribeAccountModificationsResult, AWSError>;
98 /**
99 * Retrieves a list that describes modifications to the configuration of bring your own license (BYOL) for the specified account.
100 */
101 describeAccountModifications(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeAccountModificationsResult) => void): Request<WorkSpaces.Types.DescribeAccountModificationsResult, AWSError>;
102 /**
103 * Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
104 */
105 describeClientProperties(params: WorkSpaces.Types.DescribeClientPropertiesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeClientPropertiesResult) => void): Request<WorkSpaces.Types.DescribeClientPropertiesResult, AWSError>;
106 /**
107 * Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
108 */
109 describeClientProperties(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeClientPropertiesResult) => void): Request<WorkSpaces.Types.DescribeClientPropertiesResult, AWSError>;
110 /**
111 * Describes one or more of your IP access control groups.
112 */
113 describeIpGroups(params: WorkSpaces.Types.DescribeIpGroupsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeIpGroupsResult) => void): Request<WorkSpaces.Types.DescribeIpGroupsResult, AWSError>;
114 /**
115 * Describes one or more of your IP access control groups.
116 */
117 describeIpGroups(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeIpGroupsResult) => void): Request<WorkSpaces.Types.DescribeIpGroupsResult, AWSError>;
118 /**
119 * Describes the specified tags for the specified WorkSpaces resource.
120 */
121 describeTags(params: WorkSpaces.Types.DescribeTagsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeTagsResult) => void): Request<WorkSpaces.Types.DescribeTagsResult, AWSError>;
122 /**
123 * Describes the specified tags for the specified WorkSpaces resource.
124 */
125 describeTags(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeTagsResult) => void): Request<WorkSpaces.Types.DescribeTagsResult, AWSError>;
126 /**
127 * Retrieves a list that describes the available WorkSpace bundles. You can filter the results using either bundle ID or owner, but not both.
128 */
129 describeWorkspaceBundles(params: WorkSpaces.Types.DescribeWorkspaceBundlesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceBundlesResult) => void): Request<WorkSpaces.Types.DescribeWorkspaceBundlesResult, AWSError>;
130 /**
131 * Retrieves a list that describes the available WorkSpace bundles. You can filter the results using either bundle ID or owner, but not both.
132 */
133 describeWorkspaceBundles(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceBundlesResult) => void): Request<WorkSpaces.Types.DescribeWorkspaceBundlesResult, AWSError>;
134 /**
135 * Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
136 */
137 describeWorkspaceDirectories(params: WorkSpaces.Types.DescribeWorkspaceDirectoriesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceDirectoriesResult) => void): Request<WorkSpaces.Types.DescribeWorkspaceDirectoriesResult, AWSError>;
138 /**
139 * Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
140 */
141 describeWorkspaceDirectories(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceDirectoriesResult) => void): Request<WorkSpaces.Types.DescribeWorkspaceDirectoriesResult, AWSError>;
142 /**
143 * Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.
144 */
145 describeWorkspaceImages(params: WorkSpaces.Types.DescribeWorkspaceImagesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceImagesResult) => void): Request<WorkSpaces.Types.DescribeWorkspaceImagesResult, AWSError>;
146 /**
147 * Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.
148 */
149 describeWorkspaceImages(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceImagesResult) => void): Request<WorkSpaces.Types.DescribeWorkspaceImagesResult, AWSError>;
150 /**
151 * Describes the snapshots for the specified WorkSpace.
152 */
153 describeWorkspaceSnapshots(params: WorkSpaces.Types.DescribeWorkspaceSnapshotsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceSnapshotsResult) => void): Request<WorkSpaces.Types.DescribeWorkspaceSnapshotsResult, AWSError>;
154 /**
155 * Describes the snapshots for the specified WorkSpace.
156 */
157 describeWorkspaceSnapshots(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceSnapshotsResult) => void): Request<WorkSpaces.Types.DescribeWorkspaceSnapshotsResult, AWSError>;
158 /**
159 * 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.
160 */
161 describeWorkspaces(params: WorkSpaces.Types.DescribeWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspacesResult) => void): Request<WorkSpaces.Types.DescribeWorkspacesResult, AWSError>;
162 /**
163 * 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.
164 */
165 describeWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspacesResult) => void): Request<WorkSpaces.Types.DescribeWorkspacesResult, AWSError>;
166 /**
167 * Describes the connection status of the specified WorkSpaces.
168 */
169 describeWorkspacesConnectionStatus(params: WorkSpaces.Types.DescribeWorkspacesConnectionStatusRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspacesConnectionStatusResult) => void): Request<WorkSpaces.Types.DescribeWorkspacesConnectionStatusResult, AWSError>;
170 /**
171 * Describes the connection status of the specified WorkSpaces.
172 */
173 describeWorkspacesConnectionStatus(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspacesConnectionStatusResult) => void): Request<WorkSpaces.Types.DescribeWorkspacesConnectionStatusResult, AWSError>;
174 /**
175 * Disassociates the specified IP access control group from the specified directory.
176 */
177 disassociateIpGroups(params: WorkSpaces.Types.DisassociateIpGroupsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DisassociateIpGroupsResult) => void): Request<WorkSpaces.Types.DisassociateIpGroupsResult, AWSError>;
178 /**
179 * Disassociates the specified IP access control group from the specified directory.
180 */
181 disassociateIpGroups(callback?: (err: AWSError, data: WorkSpaces.Types.DisassociateIpGroupsResult) => void): Request<WorkSpaces.Types.DisassociateIpGroupsResult, AWSError>;
182 /**
183 * 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.
184 */
185 importWorkspaceImage(params: WorkSpaces.Types.ImportWorkspaceImageRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ImportWorkspaceImageResult) => void): Request<WorkSpaces.Types.ImportWorkspaceImageResult, AWSError>;
186 /**
187 * 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.
188 */
189 importWorkspaceImage(callback?: (err: AWSError, data: WorkSpaces.Types.ImportWorkspaceImageResult) => void): Request<WorkSpaces.Types.ImportWorkspaceImageResult, AWSError>;
190 /**
191 * 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.
192 */
193 listAvailableManagementCidrRanges(params: WorkSpaces.Types.ListAvailableManagementCidrRangesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ListAvailableManagementCidrRangesResult) => void): Request<WorkSpaces.Types.ListAvailableManagementCidrRangesResult, AWSError>;
194 /**
195 * 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.
196 */
197 listAvailableManagementCidrRanges(callback?: (err: AWSError, data: WorkSpaces.Types.ListAvailableManagementCidrRangesResult) => void): Request<WorkSpaces.Types.ListAvailableManagementCidrRangesResult, AWSError>;
198 /**
199 * Modifies the configuration of bring your own license (BYOL) for the specified account.
200 */
201 modifyAccount(params: WorkSpaces.Types.ModifyAccountRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ModifyAccountResult) => void): Request<WorkSpaces.Types.ModifyAccountResult, AWSError>;
202 /**
203 * Modifies the configuration of bring your own license (BYOL) for the specified account.
204 */
205 modifyAccount(callback?: (err: AWSError, data: WorkSpaces.Types.ModifyAccountResult) => void): Request<WorkSpaces.Types.ModifyAccountResult, AWSError>;
206 /**
207 * Modifies the properties of the specified Amazon WorkSpaces clients.
208 */
209 modifyClientProperties(params: WorkSpaces.Types.ModifyClientPropertiesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ModifyClientPropertiesResult) => void): Request<WorkSpaces.Types.ModifyClientPropertiesResult, AWSError>;
210 /**
211 * Modifies the properties of the specified Amazon WorkSpaces clients.
212 */
213 modifyClientProperties(callback?: (err: AWSError, data: WorkSpaces.Types.ModifyClientPropertiesResult) => void): Request<WorkSpaces.Types.ModifyClientPropertiesResult, AWSError>;
214 /**
215 * Modifies the specified WorkSpace properties.
216 */
217 modifyWorkspaceProperties(params: WorkSpaces.Types.ModifyWorkspacePropertiesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ModifyWorkspacePropertiesResult) => void): Request<WorkSpaces.Types.ModifyWorkspacePropertiesResult, AWSError>;
218 /**
219 * Modifies the specified WorkSpace properties.
220 */
221 modifyWorkspaceProperties(callback?: (err: AWSError, data: WorkSpaces.Types.ModifyWorkspacePropertiesResult) => void): Request<WorkSpaces.Types.ModifyWorkspacePropertiesResult, AWSError>;
222 /**
223 * 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.
224 */
225 modifyWorkspaceState(params: WorkSpaces.Types.ModifyWorkspaceStateRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ModifyWorkspaceStateResult) => void): Request<WorkSpaces.Types.ModifyWorkspaceStateResult, AWSError>;
226 /**
227 * 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.
228 */
229 modifyWorkspaceState(callback?: (err: AWSError, data: WorkSpaces.Types.ModifyWorkspaceStateResult) => void): Request<WorkSpaces.Types.ModifyWorkspaceStateResult, AWSError>;
230 /**
231 * 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.
232 */
233 rebootWorkspaces(params: WorkSpaces.Types.RebootWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.RebootWorkspacesResult) => void): Request<WorkSpaces.Types.RebootWorkspacesResult, AWSError>;
234 /**
235 * 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.
236 */
237 rebootWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.RebootWorkspacesResult) => void): Request<WorkSpaces.Types.RebootWorkspacesResult, AWSError>;
238 /**
239 * Rebuilds the specified WorkSpace. You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR, or UNHEALTHY. 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.
240 */
241 rebuildWorkspaces(params: WorkSpaces.Types.RebuildWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.RebuildWorkspacesResult) => void): Request<WorkSpaces.Types.RebuildWorkspacesResult, AWSError>;
242 /**
243 * Rebuilds the specified WorkSpace. You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR, or UNHEALTHY. 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.
244 */
245 rebuildWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.RebuildWorkspacesResult) => void): Request<WorkSpaces.Types.RebuildWorkspacesResult, AWSError>;
246 /**
247 * Restores the specified WorkSpace to its last known healthy state. You cannot restore a WorkSpace unless its state is AVAILABLE, ERROR, or UNHEALTHY. 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.
248 */
249 restoreWorkspace(params: WorkSpaces.Types.RestoreWorkspaceRequest, callback?: (err: AWSError, data: WorkSpaces.Types.RestoreWorkspaceResult) => void): Request<WorkSpaces.Types.RestoreWorkspaceResult, AWSError>;
250 /**
251 * Restores the specified WorkSpace to its last known healthy state. You cannot restore a WorkSpace unless its state is AVAILABLE, ERROR, or UNHEALTHY. 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.
252 */
253 restoreWorkspace(callback?: (err: AWSError, data: WorkSpaces.Types.RestoreWorkspaceResult) => void): Request<WorkSpaces.Types.RestoreWorkspaceResult, AWSError>;
254 /**
255 * Removes one or more rules from the specified IP access control group.
256 */
257 revokeIpRules(params: WorkSpaces.Types.RevokeIpRulesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.RevokeIpRulesResult) => void): Request<WorkSpaces.Types.RevokeIpRulesResult, AWSError>;
258 /**
259 * Removes one or more rules from the specified IP access control group.
260 */
261 revokeIpRules(callback?: (err: AWSError, data: WorkSpaces.Types.RevokeIpRulesResult) => void): Request<WorkSpaces.Types.RevokeIpRulesResult, AWSError>;
262 /**
263 * Starts the specified WorkSpaces. You cannot start a WorkSpace unless it has a running mode of AutoStop and a state of STOPPED.
264 */
265 startWorkspaces(params: WorkSpaces.Types.StartWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.StartWorkspacesResult) => void): Request<WorkSpaces.Types.StartWorkspacesResult, AWSError>;
266 /**
267 * Starts the specified WorkSpaces. You cannot start a WorkSpace unless it has a running mode of AutoStop and a state of STOPPED.
268 */
269 startWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.StartWorkspacesResult) => void): Request<WorkSpaces.Types.StartWorkspacesResult, AWSError>;
270 /**
271 * 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.
272 */
273 stopWorkspaces(params: WorkSpaces.Types.StopWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.StopWorkspacesResult) => void): Request<WorkSpaces.Types.StopWorkspacesResult, AWSError>;
274 /**
275 * 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.
276 */
277 stopWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.StopWorkspacesResult) => void): Request<WorkSpaces.Types.StopWorkspacesResult, AWSError>;
278 /**
279 * 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.
280 */
281 terminateWorkspaces(params: WorkSpaces.Types.TerminateWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.TerminateWorkspacesResult) => void): Request<WorkSpaces.Types.TerminateWorkspacesResult, AWSError>;
282 /**
283 * 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.
284 */
285 terminateWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.TerminateWorkspacesResult) => void): Request<WorkSpaces.Types.TerminateWorkspacesResult, AWSError>;
286 /**
287 * Replaces the current rules of the specified IP access control group with the specified rules.
288 */
289 updateRulesOfIpGroup(params: WorkSpaces.Types.UpdateRulesOfIpGroupRequest, callback?: (err: AWSError, data: WorkSpaces.Types.UpdateRulesOfIpGroupResult) => void): Request<WorkSpaces.Types.UpdateRulesOfIpGroupResult, AWSError>;
290 /**
291 * Replaces the current rules of the specified IP access control group with the specified rules.
292 */
293 updateRulesOfIpGroup(callback?: (err: AWSError, data: WorkSpaces.Types.UpdateRulesOfIpGroupResult) => void): Request<WorkSpaces.Types.UpdateRulesOfIpGroupResult, AWSError>;
294}
295declare namespace WorkSpaces {
296 export type ARN = string;
297 export interface AccountModification {
298 /**
299 * The state of the modification to the configuration of BYOL.
300 */
301 ModificationState?: DedicatedTenancyModificationStateEnum;
302 /**
303 * The status of BYOL (whether BYOL is being enabled or disabled).
304 */
305 DedicatedTenancySupport?: DedicatedTenancySupportResultEnum;
306 /**
307 * The IP address range, specified as an IPv4 CIDR block, for the management network interface used for the account.
308 */
309 DedicatedTenancyManagementCidrRange?: DedicatedTenancyManagementCidrRange;
310 /**
311 * The timestamp when the modification of the BYOL configuration was started.
312 */
313 StartTime?: Timestamp;
314 /**
315 * The error code that is returned if the configuration of BYOL cannot be modified.
316 */
317 ErrorCode?: WorkspaceErrorCode;
318 /**
319 * The text of the error message that is returned if the configuration of BYOL cannot be modified.
320 */
321 ErrorMessage?: Description;
322 }
323 export type AccountModificationList = AccountModification[];
324 export type Alias = string;
325 export interface AssociateIpGroupsRequest {
326 /**
327 * The identifier of the directory.
328 */
329 DirectoryId: DirectoryId;
330 /**
331 * The identifiers of one or more IP access control groups.
332 */
333 GroupIds: IpGroupIdList;
334 }
335 export interface AssociateIpGroupsResult {
336 }
337 export interface AuthorizeIpRulesRequest {
338 /**
339 * The identifier of the group.
340 */
341 GroupId: IpGroupId;
342 /**
343 * The rules to add to the group.
344 */
345 UserRules: IpRuleList;
346 }
347 export interface AuthorizeIpRulesResult {
348 }
349 export type BooleanObject = boolean;
350 export type BundleId = string;
351 export type BundleIdList = BundleId[];
352 export type BundleList = WorkspaceBundle[];
353 export type BundleOwner = string;
354 export interface ClientProperties {
355 /**
356 * 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.
357 */
358 ReconnectEnabled?: ReconnectEnum;
359 }
360 export type ClientPropertiesList = ClientPropertiesResult[];
361 export interface ClientPropertiesResult {
362 /**
363 * The resource identifier, in the form of a directory ID.
364 */
365 ResourceId?: NonEmptyString;
366 /**
367 * Information about the Amazon WorkSpaces client.
368 */
369 ClientProperties?: ClientProperties;
370 }
371 export type Compute = "VALUE"|"STANDARD"|"PERFORMANCE"|"POWER"|"GRAPHICS"|"POWERPRO"|"GRAPHICSPRO"|string;
372 export interface ComputeType {
373 /**
374 * The compute type.
375 */
376 Name?: Compute;
377 }
378 export type ComputerName = string;
379 export type ConnectionState = "CONNECTED"|"DISCONNECTED"|"UNKNOWN"|string;
380 export interface CopyWorkspaceImageRequest {
381 /**
382 * The name of the image.
383 */
384 Name: WorkspaceImageName;
385 /**
386 * A description of the image.
387 */
388 Description?: WorkspaceImageDescription;
389 /**
390 * The identifier of the source image.
391 */
392 SourceImageId: WorkspaceImageId;
393 /**
394 * The identifier of the source Region.
395 */
396 SourceRegion: Region;
397 /**
398 * The tags for the image.
399 */
400 Tags?: TagList;
401 }
402 export interface CopyWorkspaceImageResult {
403 /**
404 * The identifier of the image.
405 */
406 ImageId?: WorkspaceImageId;
407 }
408 export interface CreateIpGroupRequest {
409 /**
410 * The name of the group.
411 */
412 GroupName: IpGroupName;
413 /**
414 * The description of the group.
415 */
416 GroupDesc?: IpGroupDesc;
417 /**
418 * The rules to add to the group.
419 */
420 UserRules?: IpRuleList;
421 /**
422 * The tags. Each WorkSpaces resource can have a maximum of 50 tags.
423 */
424 Tags?: TagList;
425 }
426 export interface CreateIpGroupResult {
427 /**
428 * The identifier of the group.
429 */
430 GroupId?: IpGroupId;
431 }
432 export interface CreateTagsRequest {
433 /**
434 * The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, and IP access control groups.
435 */
436 ResourceId: NonEmptyString;
437 /**
438 * The tags. Each WorkSpaces resource can have a maximum of 50 tags.
439 */
440 Tags: TagList;
441 }
442 export interface CreateTagsResult {
443 }
444 export interface CreateWorkspacesRequest {
445 /**
446 * The WorkSpaces to create. You can specify up to 25 WorkSpaces.
447 */
448 Workspaces: WorkspaceRequestList;
449 }
450 export interface CreateWorkspacesResult {
451 /**
452 * Information about the WorkSpaces that could not be created.
453 */
454 FailedRequests?: FailedCreateWorkspaceRequests;
455 /**
456 * 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.
457 */
458 PendingRequests?: WorkspaceList;
459 }
460 export type DedicatedTenancyCidrRangeList = DedicatedTenancyManagementCidrRange[];
461 export type DedicatedTenancyManagementCidrRange = string;
462 export type DedicatedTenancyModificationStateEnum = "PENDING"|"COMPLETED"|"FAILED"|string;
463 export type DedicatedTenancySupportEnum = "ENABLED"|string;
464 export type DedicatedTenancySupportResultEnum = "ENABLED"|"DISABLED"|string;
465 export type DefaultOu = string;
466 export interface DefaultWorkspaceCreationProperties {
467 /**
468 * Specifies whether the directory is enabled for Amazon WorkDocs.
469 */
470 EnableWorkDocs?: BooleanObject;
471 /**
472 * Specifies whether to automatically assign a public IP address to WorkSpaces in this directory by default. If enabled, the 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.
473 */
474 EnableInternetAccess?: BooleanObject;
475 /**
476 * The organizational unit (OU) in the directory for the WorkSpace machine accounts.
477 */
478 DefaultOu?: DefaultOu;
479 /**
480 * The identifier of any security groups to apply to WorkSpaces when they are created.
481 */
482 CustomSecurityGroupId?: SecurityGroupId;
483 /**
484 * Specifies whether the WorkSpace user is an administrator on the WorkSpace.
485 */
486 UserEnabledAsLocalAdministrator?: BooleanObject;
487 }
488 export interface DeleteIpGroupRequest {
489 /**
490 * The identifier of the IP access control group.
491 */
492 GroupId: IpGroupId;
493 }
494 export interface DeleteIpGroupResult {
495 }
496 export interface DeleteTagsRequest {
497 /**
498 * The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, and IP access control groups.
499 */
500 ResourceId: NonEmptyString;
501 /**
502 * The tag keys.
503 */
504 TagKeys: TagKeyList;
505 }
506 export interface DeleteTagsResult {
507 }
508 export interface DeleteWorkspaceImageRequest {
509 /**
510 * The identifier of the image.
511 */
512 ImageId: WorkspaceImageId;
513 }
514 export interface DeleteWorkspaceImageResult {
515 }
516 export interface DescribeAccountModificationsRequest {
517 /**
518 * If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
519 */
520 NextToken?: PaginationToken;
521 }
522 export interface DescribeAccountModificationsResult {
523 /**
524 * The list of modifications to the configuration of BYOL.
525 */
526 AccountModifications?: AccountModificationList;
527 /**
528 * The token to use to retrieve the next set of results, or null if no more results are available.
529 */
530 NextToken?: PaginationToken;
531 }
532 export interface DescribeAccountRequest {
533 }
534 export interface DescribeAccountResult {
535 /**
536 * The status of BYOL (whether BYOL is enabled or disabled).
537 */
538 DedicatedTenancySupport?: DedicatedTenancySupportResultEnum;
539 /**
540 * 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.
541 */
542 DedicatedTenancyManagementCidrRange?: DedicatedTenancyManagementCidrRange;
543 }
544 export interface DescribeClientPropertiesRequest {
545 /**
546 * The resource identifier, in the form of directory IDs.
547 */
548 ResourceIds: ResourceIdList;
549 }
550 export interface DescribeClientPropertiesResult {
551 /**
552 * Information about the specified Amazon WorkSpaces clients.
553 */
554 ClientPropertiesList?: ClientPropertiesList;
555 }
556 export interface DescribeIpGroupsRequest {
557 /**
558 * The identifiers of one or more IP access control groups.
559 */
560 GroupIds?: IpGroupIdList;
561 /**
562 * If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
563 */
564 NextToken?: PaginationToken;
565 /**
566 * The maximum number of items to return.
567 */
568 MaxResults?: Limit;
569 }
570 export interface DescribeIpGroupsResult {
571 /**
572 * Information about the IP access control groups.
573 */
574 Result?: WorkspacesIpGroupsList;
575 /**
576 * The token to use to retrieve the next set of results, or null if no more results are available.
577 */
578 NextToken?: PaginationToken;
579 }
580 export interface DescribeTagsRequest {
581 /**
582 * The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, and IP access control groups.
583 */
584 ResourceId: NonEmptyString;
585 }
586 export interface DescribeTagsResult {
587 /**
588 * The tags.
589 */
590 TagList?: TagList;
591 }
592 export interface DescribeWorkspaceBundlesRequest {
593 /**
594 * The identifiers of the bundles. You cannot combine this parameter with any other filter.
595 */
596 BundleIds?: BundleIdList;
597 /**
598 * 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.
599 */
600 Owner?: BundleOwner;
601 /**
602 * The token for the next set of results. (You received this token from a previous call.)
603 */
604 NextToken?: PaginationToken;
605 }
606 export interface DescribeWorkspaceBundlesResult {
607 /**
608 * Information about the bundles.
609 */
610 Bundles?: BundleList;
611 /**
612 * 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.
613 */
614 NextToken?: PaginationToken;
615 }
616 export interface DescribeWorkspaceDirectoriesRequest {
617 /**
618 * The identifiers of the directories. If the value is null, all directories are retrieved.
619 */
620 DirectoryIds?: DirectoryIdList;
621 /**
622 * If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
623 */
624 NextToken?: PaginationToken;
625 }
626 export interface DescribeWorkspaceDirectoriesResult {
627 /**
628 * Information about the directories.
629 */
630 Directories?: DirectoryList;
631 /**
632 * The token to use to retrieve the next set of results, or null if no more results are available.
633 */
634 NextToken?: PaginationToken;
635 }
636 export interface DescribeWorkspaceImagesRequest {
637 /**
638 * The identifier of the image.
639 */
640 ImageIds?: WorkspaceImageIdList;
641 /**
642 * If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
643 */
644 NextToken?: PaginationToken;
645 /**
646 * The maximum number of items to return.
647 */
648 MaxResults?: Limit;
649 }
650 export interface DescribeWorkspaceImagesResult {
651 /**
652 * Information about the images.
653 */
654 Images?: WorkspaceImageList;
655 /**
656 * The token to use to retrieve the next set of results, or null if no more results are available.
657 */
658 NextToken?: PaginationToken;
659 }
660 export interface DescribeWorkspaceSnapshotsRequest {
661 /**
662 * The identifier of the WorkSpace.
663 */
664 WorkspaceId: WorkspaceId;
665 }
666 export interface DescribeWorkspaceSnapshotsResult {
667 /**
668 * Information about the snapshots that can be used to rebuild a WorkSpace. These snapshots include the user volume.
669 */
670 RebuildSnapshots?: SnapshotList;
671 /**
672 * Information about the snapshots that can be used to restore a WorkSpace. These snapshots include both the root volume and the user volume.
673 */
674 RestoreSnapshots?: SnapshotList;
675 }
676 export interface DescribeWorkspacesConnectionStatusRequest {
677 /**
678 * The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.
679 */
680 WorkspaceIds?: WorkspaceIdList;
681 /**
682 * If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
683 */
684 NextToken?: PaginationToken;
685 }
686 export interface DescribeWorkspacesConnectionStatusResult {
687 /**
688 * Information about the connection status of the WorkSpace.
689 */
690 WorkspacesConnectionStatus?: WorkspaceConnectionStatusList;
691 /**
692 * The token to use to retrieve the next set of results, or null if no more results are available.
693 */
694 NextToken?: PaginationToken;
695 }
696 export interface DescribeWorkspacesRequest {
697 /**
698 * 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.
699 */
700 WorkspaceIds?: WorkspaceIdList;
701 /**
702 * 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.
703 */
704 DirectoryId?: DirectoryId;
705 /**
706 * The name of the directory user. You must specify this parameter with DirectoryId.
707 */
708 UserName?: UserName;
709 /**
710 * The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.
711 */
712 BundleId?: BundleId;
713 /**
714 * The maximum number of items to return.
715 */
716 Limit?: Limit;
717 /**
718 * If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
719 */
720 NextToken?: PaginationToken;
721 }
722 export interface DescribeWorkspacesResult {
723 /**
724 * Information about the WorkSpaces. Because CreateWorkspaces is an asynchronous operation, some of the returned information could be incomplete.
725 */
726 Workspaces?: WorkspaceList;
727 /**
728 * The token to use to retrieve the next set of results, or null if no more results are available.
729 */
730 NextToken?: PaginationToken;
731 }
732 export type Description = string;
733 export type DirectoryId = string;
734 export type DirectoryIdList = DirectoryId[];
735 export type DirectoryList = WorkspaceDirectory[];
736 export type DirectoryName = string;
737 export interface DisassociateIpGroupsRequest {
738 /**
739 * The identifier of the directory.
740 */
741 DirectoryId: DirectoryId;
742 /**
743 * The identifiers of one or more IP access control groups.
744 */
745 GroupIds: IpGroupIdList;
746 }
747 export interface DisassociateIpGroupsResult {
748 }
749 export type DnsIpAddresses = IpAddress[];
750 export type Ec2ImageId = string;
751 export type ErrorType = string;
752 export interface FailedCreateWorkspaceRequest {
753 /**
754 * Information about the WorkSpace.
755 */
756 WorkspaceRequest?: WorkspaceRequest;
757 /**
758 * The error code that is returned if the WorkSpace cannot be created.
759 */
760 ErrorCode?: ErrorType;
761 /**
762 * The text of the error message that is returned if the WorkSpace cannot be created.
763 */
764 ErrorMessage?: Description;
765 }
766 export type FailedCreateWorkspaceRequests = FailedCreateWorkspaceRequest[];
767 export type FailedRebootWorkspaceRequests = FailedWorkspaceChangeRequest[];
768 export type FailedRebuildWorkspaceRequests = FailedWorkspaceChangeRequest[];
769 export type FailedStartWorkspaceRequests = FailedWorkspaceChangeRequest[];
770 export type FailedStopWorkspaceRequests = FailedWorkspaceChangeRequest[];
771 export type FailedTerminateWorkspaceRequests = FailedWorkspaceChangeRequest[];
772 export interface FailedWorkspaceChangeRequest {
773 /**
774 * The identifier of the WorkSpace.
775 */
776 WorkspaceId?: WorkspaceId;
777 /**
778 * The error code that is returned if the WorkSpace cannot be rebooted.
779 */
780 ErrorCode?: ErrorType;
781 /**
782 * The text of the error message that is returned if the WorkSpace cannot be rebooted.
783 */
784 ErrorMessage?: Description;
785 }
786 export interface ImportWorkspaceImageRequest {
787 /**
788 * The identifier of the EC2 image.
789 */
790 Ec2ImageId: Ec2ImageId;
791 /**
792 * The ingestion process to be used when importing the image.
793 */
794 IngestionProcess: WorkspaceImageIngestionProcess;
795 /**
796 * The name of the WorkSpace image.
797 */
798 ImageName: WorkspaceImageName;
799 /**
800 * The description of the WorkSpace image.
801 */
802 ImageDescription: WorkspaceImageDescription;
803 /**
804 * The tags. Each WorkSpaces resource can have a maximum of 50 tags.
805 */
806 Tags?: TagList;
807 }
808 export interface ImportWorkspaceImageResult {
809 /**
810 * The identifier of the WorkSpace image.
811 */
812 ImageId?: WorkspaceImageId;
813 }
814 export type IpAddress = string;
815 export type IpGroupDesc = string;
816 export type IpGroupId = string;
817 export type IpGroupIdList = IpGroupId[];
818 export type IpGroupName = string;
819 export type IpRevokedRuleList = IpRule[];
820 export type IpRule = string;
821 export type IpRuleDesc = string;
822 export interface IpRuleItem {
823 /**
824 * The IP address range, in CIDR notation.
825 */
826 ipRule?: IpRule;
827 /**
828 * The description.
829 */
830 ruleDesc?: IpRuleDesc;
831 }
832 export type IpRuleList = IpRuleItem[];
833 export type Limit = number;
834 export interface ListAvailableManagementCidrRangesRequest {
835 /**
836 * 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).
837 */
838 ManagementCidrRangeConstraint: ManagementCidrRangeConstraint;
839 /**
840 * The maximum number of items to return.
841 */
842 MaxResults?: ManagementCidrRangeMaxResults;
843 /**
844 * If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
845 */
846 NextToken?: PaginationToken;
847 }
848 export interface ListAvailableManagementCidrRangesResult {
849 /**
850 * The list of available IP address ranges, specified as IPv4 CIDR blocks.
851 */
852 ManagementCidrRanges?: DedicatedTenancyCidrRangeList;
853 /**
854 * The token to use to retrieve the next set of results, or null if no more results are available.
855 */
856 NextToken?: PaginationToken;
857 }
858 export type ManagementCidrRangeConstraint = string;
859 export type ManagementCidrRangeMaxResults = number;
860 export type ModificationResourceEnum = "ROOT_VOLUME"|"USER_VOLUME"|"COMPUTE_TYPE"|string;
861 export interface ModificationState {
862 /**
863 * The resource.
864 */
865 Resource?: ModificationResourceEnum;
866 /**
867 * The modification state.
868 */
869 State?: ModificationStateEnum;
870 }
871 export type ModificationStateEnum = "UPDATE_INITIATED"|"UPDATE_IN_PROGRESS"|string;
872 export type ModificationStateList = ModificationState[];
873 export interface ModifyAccountRequest {
874 /**
875 * The status of BYOL.
876 */
877 DedicatedTenancySupport?: DedicatedTenancySupportEnum;
878 /**
879 * 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.
880 */
881 DedicatedTenancyManagementCidrRange?: DedicatedTenancyManagementCidrRange;
882 }
883 export interface ModifyAccountResult {
884 }
885 export interface ModifyClientPropertiesRequest {
886 /**
887 * The resource identifiers, in the form of directory IDs.
888 */
889 ResourceId: NonEmptyString;
890 /**
891 * Information about the Amazon WorkSpaces client.
892 */
893 ClientProperties: ClientProperties;
894 }
895 export interface ModifyClientPropertiesResult {
896 }
897 export interface ModifyWorkspacePropertiesRequest {
898 /**
899 * The identifier of the WorkSpace.
900 */
901 WorkspaceId: WorkspaceId;
902 /**
903 * The properties of the WorkSpace.
904 */
905 WorkspaceProperties: WorkspaceProperties;
906 }
907 export interface ModifyWorkspacePropertiesResult {
908 }
909 export interface ModifyWorkspaceStateRequest {
910 /**
911 * The identifier of the WorkSpace.
912 */
913 WorkspaceId: WorkspaceId;
914 /**
915 * The WorkSpace state.
916 */
917 WorkspaceState: TargetWorkspaceState;
918 }
919 export interface ModifyWorkspaceStateResult {
920 }
921 export type NonEmptyString = string;
922 export interface OperatingSystem {
923 /**
924 * The operating system.
925 */
926 Type?: OperatingSystemType;
927 }
928 export type OperatingSystemType = "WINDOWS"|"LINUX"|string;
929 export type PaginationToken = string;
930 export interface RebootRequest {
931 /**
932 * The identifier of the WorkSpace.
933 */
934 WorkspaceId: WorkspaceId;
935 }
936 export type RebootWorkspaceRequests = RebootRequest[];
937 export interface RebootWorkspacesRequest {
938 /**
939 * The WorkSpaces to reboot. You can specify up to 25 WorkSpaces.
940 */
941 RebootWorkspaceRequests: RebootWorkspaceRequests;
942 }
943 export interface RebootWorkspacesResult {
944 /**
945 * Information about the WorkSpaces that could not be rebooted.
946 */
947 FailedRequests?: FailedRebootWorkspaceRequests;
948 }
949 export interface RebuildRequest {
950 /**
951 * The identifier of the WorkSpace.
952 */
953 WorkspaceId: WorkspaceId;
954 }
955 export type RebuildWorkspaceRequests = RebuildRequest[];
956 export interface RebuildWorkspacesRequest {
957 /**
958 * The WorkSpace to rebuild. You can specify a single WorkSpace.
959 */
960 RebuildWorkspaceRequests: RebuildWorkspaceRequests;
961 }
962 export interface RebuildWorkspacesResult {
963 /**
964 * Information about the WorkSpace that could not be rebuilt.
965 */
966 FailedRequests?: FailedRebuildWorkspaceRequests;
967 }
968 export type ReconnectEnum = "ENABLED"|"DISABLED"|string;
969 export type Region = string;
970 export type RegistrationCode = string;
971 export type ResourceIdList = NonEmptyString[];
972 export interface RestoreWorkspaceRequest {
973 /**
974 * The identifier of the WorkSpace.
975 */
976 WorkspaceId: WorkspaceId;
977 }
978 export interface RestoreWorkspaceResult {
979 }
980 export interface RevokeIpRulesRequest {
981 /**
982 * The identifier of the group.
983 */
984 GroupId: IpGroupId;
985 /**
986 * The rules to remove from the group.
987 */
988 UserRules: IpRevokedRuleList;
989 }
990 export interface RevokeIpRulesResult {
991 }
992 export interface RootStorage {
993 /**
994 * The size of the root volume.
995 */
996 Capacity?: NonEmptyString;
997 }
998 export type RootVolumeSizeGib = number;
999 export type RunningMode = "AUTO_STOP"|"ALWAYS_ON"|string;
1000 export type RunningModeAutoStopTimeoutInMinutes = number;
1001 export type SecurityGroupId = string;
1002 export interface Snapshot {
1003 /**
1004 * The time when the snapshot was created.
1005 */
1006 SnapshotTime?: Timestamp;
1007 }
1008 export type SnapshotList = Snapshot[];
1009 export interface StartRequest {
1010 /**
1011 * The identifier of the WorkSpace.
1012 */
1013 WorkspaceId?: WorkspaceId;
1014 }
1015 export type StartWorkspaceRequests = StartRequest[];
1016 export interface StartWorkspacesRequest {
1017 /**
1018 * The WorkSpaces to start. You can specify up to 25 WorkSpaces.
1019 */
1020 StartWorkspaceRequests: StartWorkspaceRequests;
1021 }
1022 export interface StartWorkspacesResult {
1023 /**
1024 * Information about the WorkSpaces that could not be started.
1025 */
1026 FailedRequests?: FailedStartWorkspaceRequests;
1027 }
1028 export interface StopRequest {
1029 /**
1030 * The identifier of the WorkSpace.
1031 */
1032 WorkspaceId?: WorkspaceId;
1033 }
1034 export type StopWorkspaceRequests = StopRequest[];
1035 export interface StopWorkspacesRequest {
1036 /**
1037 * The WorkSpaces to stop. You can specify up to 25 WorkSpaces.
1038 */
1039 StopWorkspaceRequests: StopWorkspaceRequests;
1040 }
1041 export interface StopWorkspacesResult {
1042 /**
1043 * Information about the WorkSpaces that could not be stopped.
1044 */
1045 FailedRequests?: FailedStopWorkspaceRequests;
1046 }
1047 export type SubnetId = string;
1048 export type SubnetIds = SubnetId[];
1049 export interface Tag {
1050 /**
1051 * The key of the tag.
1052 */
1053 Key: TagKey;
1054 /**
1055 * The value of the tag.
1056 */
1057 Value?: TagValue;
1058 }
1059 export type TagKey = string;
1060 export type TagKeyList = NonEmptyString[];
1061 export type TagList = Tag[];
1062 export type TagValue = string;
1063 export type TargetWorkspaceState = "AVAILABLE"|"ADMIN_MAINTENANCE"|string;
1064 export interface TerminateRequest {
1065 /**
1066 * The identifier of the WorkSpace.
1067 */
1068 WorkspaceId: WorkspaceId;
1069 }
1070 export type TerminateWorkspaceRequests = TerminateRequest[];
1071 export interface TerminateWorkspacesRequest {
1072 /**
1073 * The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.
1074 */
1075 TerminateWorkspaceRequests: TerminateWorkspaceRequests;
1076 }
1077 export interface TerminateWorkspacesResult {
1078 /**
1079 * Information about the WorkSpaces that could not be terminated.
1080 */
1081 FailedRequests?: FailedTerminateWorkspaceRequests;
1082 }
1083 export type Timestamp = Date;
1084 export interface UpdateRulesOfIpGroupRequest {
1085 /**
1086 * The identifier of the group.
1087 */
1088 GroupId: IpGroupId;
1089 /**
1090 * One or more rules.
1091 */
1092 UserRules: IpRuleList;
1093 }
1094 export interface UpdateRulesOfIpGroupResult {
1095 }
1096 export type UserName = string;
1097 export interface UserStorage {
1098 /**
1099 * The size of the user storage.
1100 */
1101 Capacity?: NonEmptyString;
1102 }
1103 export type UserVolumeSizeGib = number;
1104 export type VolumeEncryptionKey = string;
1105 export interface Workspace {
1106 /**
1107 * The identifier of the WorkSpace.
1108 */
1109 WorkspaceId?: WorkspaceId;
1110 /**
1111 * The identifier of the AWS Directory Service directory for the WorkSpace.
1112 */
1113 DirectoryId?: DirectoryId;
1114 /**
1115 * The user for the WorkSpace.
1116 */
1117 UserName?: UserName;
1118 /**
1119 * The IP address of the WorkSpace.
1120 */
1121 IpAddress?: IpAddress;
1122 /**
1123 * The operational state of the WorkSpace.
1124 */
1125 State?: WorkspaceState;
1126 /**
1127 * The identifier of the bundle used to create the WorkSpace.
1128 */
1129 BundleId?: BundleId;
1130 /**
1131 * The identifier of the subnet for the WorkSpace.
1132 */
1133 SubnetId?: SubnetId;
1134 /**
1135 * The text of the error message that is returned if the WorkSpace cannot be created.
1136 */
1137 ErrorMessage?: Description;
1138 /**
1139 * The error code that is returned if the WorkSpace cannot be created.
1140 */
1141 ErrorCode?: WorkspaceErrorCode;
1142 /**
1143 * The name of the WorkSpace, as seen by the operating system.
1144 */
1145 ComputerName?: ComputerName;
1146 /**
1147 * The KMS key used to encrypt data stored on your WorkSpace.
1148 */
1149 VolumeEncryptionKey?: VolumeEncryptionKey;
1150 /**
1151 * Indicates whether the data stored on the user volume is encrypted.
1152 */
1153 UserVolumeEncryptionEnabled?: BooleanObject;
1154 /**
1155 * Indicates whether the data stored on the root volume is encrypted.
1156 */
1157 RootVolumeEncryptionEnabled?: BooleanObject;
1158 /**
1159 * The properties of the WorkSpace.
1160 */
1161 WorkspaceProperties?: WorkspaceProperties;
1162 /**
1163 * The modification states of the WorkSpace.
1164 */
1165 ModificationStates?: ModificationStateList;
1166 }
1167 export interface WorkspaceBundle {
1168 /**
1169 * The bundle identifier.
1170 */
1171 BundleId?: BundleId;
1172 /**
1173 * The name of the bundle.
1174 */
1175 Name?: NonEmptyString;
1176 /**
1177 * The owner of the bundle. This is the account identifier of the owner, or AMAZON if the bundle is provided by AWS.
1178 */
1179 Owner?: BundleOwner;
1180 /**
1181 * A description.
1182 */
1183 Description?: Description;
1184 /**
1185 * The size of the root volume.
1186 */
1187 RootStorage?: RootStorage;
1188 /**
1189 * The size of the user storage.
1190 */
1191 UserStorage?: UserStorage;
1192 /**
1193 * The compute type. For more information, see Amazon WorkSpaces Bundles.
1194 */
1195 ComputeType?: ComputeType;
1196 }
1197 export interface WorkspaceConnectionStatus {
1198 /**
1199 * The identifier of the WorkSpace.
1200 */
1201 WorkspaceId?: WorkspaceId;
1202 /**
1203 * The connection state of the WorkSpace. The connection state is unknown if the WorkSpace is stopped.
1204 */
1205 ConnectionState?: ConnectionState;
1206 /**
1207 * The timestamp of the connection status check.
1208 */
1209 ConnectionStateCheckTimestamp?: Timestamp;
1210 /**
1211 * The timestamp of the last known user connection.
1212 */
1213 LastKnownUserConnectionTimestamp?: Timestamp;
1214 }
1215 export type WorkspaceConnectionStatusList = WorkspaceConnectionStatus[];
1216 export interface WorkspaceDirectory {
1217 /**
1218 * The directory identifier.
1219 */
1220 DirectoryId?: DirectoryId;
1221 /**
1222 * The directory alias.
1223 */
1224 Alias?: Alias;
1225 /**
1226 * The name of the directory.
1227 */
1228 DirectoryName?: DirectoryName;
1229 /**
1230 * The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.
1231 */
1232 RegistrationCode?: RegistrationCode;
1233 /**
1234 * The identifiers of the subnets used with the directory.
1235 */
1236 SubnetIds?: SubnetIds;
1237 /**
1238 * The IP addresses of the DNS servers for the directory.
1239 */
1240 DnsIpAddresses?: DnsIpAddresses;
1241 /**
1242 * The user name for the service account.
1243 */
1244 CustomerUserName?: UserName;
1245 /**
1246 * 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.
1247 */
1248 IamRoleId?: ARN;
1249 /**
1250 * The directory type.
1251 */
1252 DirectoryType?: WorkspaceDirectoryType;
1253 /**
1254 * The identifier of the security group that is assigned to new WorkSpaces.
1255 */
1256 WorkspaceSecurityGroupId?: SecurityGroupId;
1257 /**
1258 * The state of the directory's registration with Amazon WorkSpaces
1259 */
1260 State?: WorkspaceDirectoryState;
1261 /**
1262 * The default creation properties for all WorkSpaces in the directory.
1263 */
1264 WorkspaceCreationProperties?: DefaultWorkspaceCreationProperties;
1265 /**
1266 * The identifiers of the IP access control groups associated with the directory.
1267 */
1268 ipGroupIds?: IpGroupIdList;
1269 }
1270 export type WorkspaceDirectoryState = "REGISTERING"|"REGISTERED"|"DEREGISTERING"|"DEREGISTERED"|"ERROR"|string;
1271 export type WorkspaceDirectoryType = "SIMPLE_AD"|"AD_CONNECTOR"|string;
1272 export type WorkspaceErrorCode = string;
1273 export type WorkspaceId = string;
1274 export type WorkspaceIdList = WorkspaceId[];
1275 export interface WorkspaceImage {
1276 /**
1277 * The identifier of the image.
1278 */
1279 ImageId?: WorkspaceImageId;
1280 /**
1281 * The name of the image.
1282 */
1283 Name?: WorkspaceImageName;
1284 /**
1285 * The description of the image.
1286 */
1287 Description?: WorkspaceImageDescription;
1288 /**
1289 * The operating system that the image is running.
1290 */
1291 OperatingSystem?: OperatingSystem;
1292 /**
1293 * The status of the image.
1294 */
1295 State?: WorkspaceImageState;
1296 /**
1297 * Specifies whether the image is running on dedicated hardware. When bring your own license (BYOL) is enabled, this value is set to DEDICATED.
1298 */
1299 RequiredTenancy?: WorkspaceImageRequiredTenancy;
1300 /**
1301 * The error code that is returned for the image.
1302 */
1303 ErrorCode?: WorkspaceImageErrorCode;
1304 /**
1305 * The text of the error message that is returned for the image.
1306 */
1307 ErrorMessage?: Description;
1308 }
1309 export type WorkspaceImageDescription = string;
1310 export type WorkspaceImageErrorCode = string;
1311 export type WorkspaceImageId = string;
1312 export type WorkspaceImageIdList = WorkspaceImageId[];
1313 export type WorkspaceImageIngestionProcess = "BYOL_REGULAR"|"BYOL_GRAPHICS"|"BYOL_GRAPHICSPRO"|string;
1314 export type WorkspaceImageList = WorkspaceImage[];
1315 export type WorkspaceImageName = string;
1316 export type WorkspaceImageRequiredTenancy = "DEFAULT"|"DEDICATED"|string;
1317 export type WorkspaceImageState = "AVAILABLE"|"PENDING"|"ERROR"|string;
1318 export type WorkspaceList = Workspace[];
1319 export interface WorkspaceProperties {
1320 /**
1321 * The running mode. For more information, see Manage the WorkSpace Running Mode.
1322 */
1323 RunningMode?: RunningMode;
1324 /**
1325 * The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
1326 */
1327 RunningModeAutoStopTimeoutInMinutes?: RunningModeAutoStopTimeoutInMinutes;
1328 /**
1329 * The size of the root volume.
1330 */
1331 RootVolumeSizeGib?: RootVolumeSizeGib;
1332 /**
1333 * The size of the user storage.
1334 */
1335 UserVolumeSizeGib?: UserVolumeSizeGib;
1336 /**
1337 * The compute type. For more information, see Amazon WorkSpaces Bundles.
1338 */
1339 ComputeTypeName?: Compute;
1340 }
1341 export interface WorkspaceRequest {
1342 /**
1343 * The identifier of the AWS Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.
1344 */
1345 DirectoryId: DirectoryId;
1346 /**
1347 * The username of the user for the WorkSpace. This username must exist in the AWS Directory Service directory for the WorkSpace.
1348 */
1349 UserName: UserName;
1350 /**
1351 * The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.
1352 */
1353 BundleId: BundleId;
1354 /**
1355 * The KMS key used to encrypt data stored on your WorkSpace.
1356 */
1357 VolumeEncryptionKey?: VolumeEncryptionKey;
1358 /**
1359 * Indicates whether the data stored on the user volume is encrypted.
1360 */
1361 UserVolumeEncryptionEnabled?: BooleanObject;
1362 /**
1363 * Indicates whether the data stored on the root volume is encrypted.
1364 */
1365 RootVolumeEncryptionEnabled?: BooleanObject;
1366 /**
1367 * The WorkSpace properties.
1368 */
1369 WorkspaceProperties?: WorkspaceProperties;
1370 /**
1371 * The tags for the WorkSpace.
1372 */
1373 Tags?: TagList;
1374 }
1375 export type WorkspaceRequestList = WorkspaceRequest[];
1376 export type WorkspaceState = "PENDING"|"AVAILABLE"|"IMPAIRED"|"UNHEALTHY"|"REBOOTING"|"STARTING"|"REBUILDING"|"RESTORING"|"MAINTENANCE"|"ADMIN_MAINTENANCE"|"TERMINATING"|"TERMINATED"|"SUSPENDED"|"UPDATING"|"STOPPING"|"STOPPED"|"ERROR"|string;
1377 export interface WorkspacesIpGroup {
1378 /**
1379 * The identifier of the group.
1380 */
1381 groupId?: IpGroupId;
1382 /**
1383 * The name of the group.
1384 */
1385 groupName?: IpGroupName;
1386 /**
1387 * The description of the group.
1388 */
1389 groupDesc?: IpGroupDesc;
1390 /**
1391 * The rules.
1392 */
1393 userRules?: IpRuleList;
1394 }
1395 export type WorkspacesIpGroupsList = WorkspacesIpGroup[];
1396 /**
1397 * 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.
1398 */
1399 export type apiVersion = "2015-04-08"|"latest"|string;
1400 export interface ClientApiVersions {
1401 /**
1402 * 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.
1403 */
1404 apiVersion?: apiVersion;
1405 }
1406 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
1407 /**
1408 * Contains interfaces for use with the WorkSpaces client.
1409 */
1410 export import Types = WorkSpaces;
1411}
1412export = WorkSpaces;