@aws-sdk/client-workspaces 3.315.0 → 3.316.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -65,776 +65,417 @@ import { UpdateRulesOfIpGroupCommandInput, UpdateRulesOfIpGroupCommandOutput } f
65
65
  import { UpdateWorkspaceBundleCommandInput, UpdateWorkspaceBundleCommandOutput } from "./commands/UpdateWorkspaceBundleCommand";
66
66
  import { UpdateWorkspaceImagePermissionCommandInput, UpdateWorkspaceImagePermissionCommandOutput } from "./commands/UpdateWorkspaceImagePermissionCommand";
67
67
  import { WorkSpacesClient } from "./WorkSpacesClient";
68
- /**
69
- * @public
70
- * <fullname>Amazon WorkSpaces Service</fullname>
71
- * <p>Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows
72
- * or Amazon Linux desktops for your users, known as <i>WorkSpaces</i>.
73
- * WorkSpaces eliminates the need to procure and deploy hardware or install complex
74
- * software. You can quickly add or remove users as your needs change. Users can access their
75
- * virtual desktops from multiple devices or web browsers.</p>
76
- * <p>This API Reference provides detailed information about the actions, data types,
77
- * parameters, and errors of the WorkSpaces service. For more information about the
78
- * supported Amazon Web Services Regions, endpoints, and service quotas of the Amazon WorkSpaces service, see <a href="https://docs.aws.amazon.com/general/latest/gr/wsp.html">WorkSpaces endpoints and quotas</a> in the <i>Amazon Web Services
79
- * General Reference</i>.</p>
80
- * <p>You can also manage your WorkSpaces resources using the WorkSpaces
81
- * console, Command Line Interface (CLI), and SDKs. For more information about
82
- * administering WorkSpaces, see the <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/">Amazon WorkSpaces Administration Guide</a>.
83
- * For more information about using the Amazon WorkSpaces client application or web
84
- * browser to access provisioned WorkSpaces, see the <a href="https://docs.aws.amazon.com/workspaces/latest/userguide/">Amazon WorkSpaces User Guide</a>. For more
85
- * information about using the CLI to manage your WorkSpaces resources,
86
- * see the <a href="https://docs.aws.amazon.com/cli/latest/reference/workspaces/index.html">WorkSpaces section of the CLI Reference</a>.</p>
87
- */
88
- export declare class WorkSpaces extends WorkSpacesClient {
89
- /**
90
- * @public
91
- * <p>Associates the specified connection alias with the specified directory to enable
92
- * cross-Region redirection. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html"> Cross-Region
93
- * Redirection for Amazon WorkSpaces</a>.</p>
94
- * <note>
95
- * <p>Before performing this operation, call <a href="https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html">
96
- * DescribeConnectionAliases</a> to make sure that the current state of the
97
- * connection alias is <code>CREATED</code>.</p>
98
- * </note>
68
+ export interface WorkSpaces {
69
+ /**
70
+ * @see {@link AssociateConnectionAliasCommand}
99
71
  */
100
72
  associateConnectionAlias(args: AssociateConnectionAliasCommandInput, options?: __HttpHandlerOptions): Promise<AssociateConnectionAliasCommandOutput>;
101
73
  associateConnectionAlias(args: AssociateConnectionAliasCommandInput, cb: (err: any, data?: AssociateConnectionAliasCommandOutput) => void): void;
102
74
  associateConnectionAlias(args: AssociateConnectionAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateConnectionAliasCommandOutput) => void): void;
103
75
  /**
104
- * @public
105
- * <p>Associates the specified IP access control group with the specified directory.</p>
76
+ * @see {@link AssociateIpGroupsCommand}
106
77
  */
107
78
  associateIpGroups(args: AssociateIpGroupsCommandInput, options?: __HttpHandlerOptions): Promise<AssociateIpGroupsCommandOutput>;
108
79
  associateIpGroups(args: AssociateIpGroupsCommandInput, cb: (err: any, data?: AssociateIpGroupsCommandOutput) => void): void;
109
80
  associateIpGroups(args: AssociateIpGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateIpGroupsCommandOutput) => void): void;
110
81
  /**
111
- * @public
112
- * <p>Adds one or more rules to the specified IP access control group.</p>
113
- * <p>This action gives users permission to access their WorkSpaces from the CIDR address
114
- * ranges specified in the rules.</p>
82
+ * @see {@link AuthorizeIpRulesCommand}
115
83
  */
116
84
  authorizeIpRules(args: AuthorizeIpRulesCommandInput, options?: __HttpHandlerOptions): Promise<AuthorizeIpRulesCommandOutput>;
117
85
  authorizeIpRules(args: AuthorizeIpRulesCommandInput, cb: (err: any, data?: AuthorizeIpRulesCommandOutput) => void): void;
118
86
  authorizeIpRules(args: AuthorizeIpRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AuthorizeIpRulesCommandOutput) => void): void;
119
87
  /**
120
- * @public
121
- * <p>Copies the specified image from the specified Region to the current Region. For more
122
- * information about copying images, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/copy-custom-image.html"> Copy a Custom WorkSpaces
123
- * Image</a>.</p>
124
- * <p>In the China (Ningxia) Region, you can copy images only within the same Region.</p>
125
- * <p>In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.</p>
126
- * <important>
127
- * <p>Before copying a shared image, be sure to verify that it has been shared from the
128
- * correct Amazon Web Services account. To determine if an image has been shared and to see
129
- * the ID of the Amazon Web Services account that owns an image, use the <a href="https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImages.html">DescribeWorkSpaceImages</a> and <a href="https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImagePermissions.html">DescribeWorkspaceImagePermissions</a> API operations. </p>
130
- * </important>
88
+ * @see {@link CopyWorkspaceImageCommand}
131
89
  */
132
90
  copyWorkspaceImage(args: CopyWorkspaceImageCommandInput, options?: __HttpHandlerOptions): Promise<CopyWorkspaceImageCommandOutput>;
133
91
  copyWorkspaceImage(args: CopyWorkspaceImageCommandInput, cb: (err: any, data?: CopyWorkspaceImageCommandOutput) => void): void;
134
92
  copyWorkspaceImage(args: CopyWorkspaceImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyWorkspaceImageCommandOutput) => void): void;
135
93
  /**
136
- * @public
137
- * <p>Creates a client-add-in for Amazon Connect within a directory. You can create only
138
- * one Amazon Connect client add-in within a directory.</p>
139
- * <p>This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect.</p>
94
+ * @see {@link CreateConnectClientAddInCommand}
140
95
  */
141
96
  createConnectClientAddIn(args: CreateConnectClientAddInCommandInput, options?: __HttpHandlerOptions): Promise<CreateConnectClientAddInCommandOutput>;
142
97
  createConnectClientAddIn(args: CreateConnectClientAddInCommandInput, cb: (err: any, data?: CreateConnectClientAddInCommandOutput) => void): void;
143
98
  createConnectClientAddIn(args: CreateConnectClientAddInCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConnectClientAddInCommandOutput) => void): void;
144
99
  /**
145
- * @public
146
- * <p>Creates the specified connection alias for use with cross-Region redirection. For more
147
- * information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html"> Cross-Region
148
- * Redirection for Amazon WorkSpaces</a>.</p>
100
+ * @see {@link CreateConnectionAliasCommand}
149
101
  */
150
102
  createConnectionAlias(args: CreateConnectionAliasCommandInput, options?: __HttpHandlerOptions): Promise<CreateConnectionAliasCommandOutput>;
151
103
  createConnectionAlias(args: CreateConnectionAliasCommandInput, cb: (err: any, data?: CreateConnectionAliasCommandOutput) => void): void;
152
104
  createConnectionAlias(args: CreateConnectionAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConnectionAliasCommandOutput) => void): void;
153
105
  /**
154
- * @public
155
- * <p>Creates an IP access control group.</p>
156
- * <p>An IP access control group provides you with the ability to control the IP addresses
157
- * from which users are allowed to access their WorkSpaces. To specify the CIDR address
158
- * ranges, add rules to your IP access control group and then associate the group with your
159
- * directory. You can add rules when you create the group or at any time using <a>AuthorizeIpRules</a>.</p>
160
- * <p>There is a default IP access control group associated with your directory. If you don't
161
- * associate an IP access control group with your directory, the default group is used. The
162
- * default group includes a default rule that allows users to access their WorkSpaces from
163
- * anywhere. You cannot modify the default IP access control group for your directory.</p>
106
+ * @see {@link CreateIpGroupCommand}
164
107
  */
165
108
  createIpGroup(args: CreateIpGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateIpGroupCommandOutput>;
166
109
  createIpGroup(args: CreateIpGroupCommandInput, cb: (err: any, data?: CreateIpGroupCommandOutput) => void): void;
167
110
  createIpGroup(args: CreateIpGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIpGroupCommandOutput) => void): void;
168
111
  /**
169
- * @public
170
- * <p>Creates a standby WorkSpace in a secondary Region.</p>
112
+ * @see {@link CreateStandbyWorkspacesCommand}
171
113
  */
172
114
  createStandbyWorkspaces(args: CreateStandbyWorkspacesCommandInput, options?: __HttpHandlerOptions): Promise<CreateStandbyWorkspacesCommandOutput>;
173
115
  createStandbyWorkspaces(args: CreateStandbyWorkspacesCommandInput, cb: (err: any, data?: CreateStandbyWorkspacesCommandOutput) => void): void;
174
116
  createStandbyWorkspaces(args: CreateStandbyWorkspacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStandbyWorkspacesCommandOutput) => void): void;
175
117
  /**
176
- * @public
177
- * <p>Creates the specified tags for the specified WorkSpaces resource.</p>
118
+ * @see {@link CreateTagsCommand}
178
119
  */
179
120
  createTags(args: CreateTagsCommandInput, options?: __HttpHandlerOptions): Promise<CreateTagsCommandOutput>;
180
121
  createTags(args: CreateTagsCommandInput, cb: (err: any, data?: CreateTagsCommandOutput) => void): void;
181
122
  createTags(args: CreateTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTagsCommandOutput) => void): void;
182
123
  /**
183
- * @public
184
- * <p>Creates a new updated WorkSpace image based on the specified source image. The new
185
- * updated WorkSpace image has the latest drivers and other updates required by the
186
- * Amazon WorkSpaces components.</p>
187
- * <p>To determine which WorkSpace images need to be updated with the latest Amazon WorkSpaces
188
- * requirements, use <a href="https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImages.html">
189
- * DescribeWorkspaceImages</a>.</p>
190
- * <note>
191
- * <ul>
192
- * <li>
193
- * <p>Only Windows 10, Windows Server 2016, and Windows Server 2019 WorkSpace images
194
- * can be programmatically updated at this time.</p>
195
- * </li>
196
- * <li>
197
- * <p>Microsoft Windows updates and other application updates are not included in the
198
- * update process.</p>
199
- * </li>
200
- * <li>
201
- * <p>The source WorkSpace image is not deleted. You can delete the source image
202
- * after you've verified your new updated image and created a new bundle. </p>
203
- * </li>
204
- * </ul>
205
- * </note>
124
+ * @see {@link CreateUpdatedWorkspaceImageCommand}
206
125
  */
207
126
  createUpdatedWorkspaceImage(args: CreateUpdatedWorkspaceImageCommandInput, options?: __HttpHandlerOptions): Promise<CreateUpdatedWorkspaceImageCommandOutput>;
208
127
  createUpdatedWorkspaceImage(args: CreateUpdatedWorkspaceImageCommandInput, cb: (err: any, data?: CreateUpdatedWorkspaceImageCommandOutput) => void): void;
209
128
  createUpdatedWorkspaceImage(args: CreateUpdatedWorkspaceImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUpdatedWorkspaceImageCommandOutput) => void): void;
210
129
  /**
211
- * @public
212
- * <p>Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see
213
- * <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/create-custom-bundle.html">
214
- * Create a Custom WorkSpaces Image and Bundle</a>.</p>
130
+ * @see {@link CreateWorkspaceBundleCommand}
215
131
  */
216
132
  createWorkspaceBundle(args: CreateWorkspaceBundleCommandInput, options?: __HttpHandlerOptions): Promise<CreateWorkspaceBundleCommandOutput>;
217
133
  createWorkspaceBundle(args: CreateWorkspaceBundleCommandInput, cb: (err: any, data?: CreateWorkspaceBundleCommandOutput) => void): void;
218
134
  createWorkspaceBundle(args: CreateWorkspaceBundleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkspaceBundleCommandOutput) => void): void;
219
135
  /**
220
- * @public
221
- * <p>Creates a new WorkSpace image from an existing WorkSpace.</p>
136
+ * @see {@link CreateWorkspaceImageCommand}
222
137
  */
223
138
  createWorkspaceImage(args: CreateWorkspaceImageCommandInput, options?: __HttpHandlerOptions): Promise<CreateWorkspaceImageCommandOutput>;
224
139
  createWorkspaceImage(args: CreateWorkspaceImageCommandInput, cb: (err: any, data?: CreateWorkspaceImageCommandOutput) => void): void;
225
140
  createWorkspaceImage(args: CreateWorkspaceImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkspaceImageCommandOutput) => void): void;
226
141
  /**
227
- * @public
228
- * <p>Creates one or more WorkSpaces.</p>
229
- * <p>This operation is asynchronous and returns before the WorkSpaces are created.</p>
230
- * <note>
231
- * <p>The <code>MANUAL</code> running mode value is only supported by Amazon WorkSpaces
232
- * Core. Contact your account team to be allow-listed to use this value. For more
233
- * information, see <a href="http://aws.amazon.com/workspaces/core/">Amazon WorkSpaces
234
- * Core</a>.</p>
235
- * </note>
142
+ * @see {@link CreateWorkspacesCommand}
236
143
  */
237
144
  createWorkspaces(args: CreateWorkspacesCommandInput, options?: __HttpHandlerOptions): Promise<CreateWorkspacesCommandOutput>;
238
145
  createWorkspaces(args: CreateWorkspacesCommandInput, cb: (err: any, data?: CreateWorkspacesCommandOutput) => void): void;
239
146
  createWorkspaces(args: CreateWorkspacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkspacesCommandOutput) => void): void;
240
147
  /**
241
- * @public
242
- * <p>Deletes customized client branding. Client branding allows you to customize your
243
- * WorkSpace's client login portal. You can tailor your login portal company logo, the support
244
- * email address, support link, link to reset password, and a custom message for users trying
245
- * to sign in.</p>
246
- * <p>After you delete your customized client branding, your login portal reverts to the
247
- * default client branding.</p>
148
+ * @see {@link DeleteClientBrandingCommand}
248
149
  */
249
150
  deleteClientBranding(args: DeleteClientBrandingCommandInput, options?: __HttpHandlerOptions): Promise<DeleteClientBrandingCommandOutput>;
250
151
  deleteClientBranding(args: DeleteClientBrandingCommandInput, cb: (err: any, data?: DeleteClientBrandingCommandOutput) => void): void;
251
152
  deleteClientBranding(args: DeleteClientBrandingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteClientBrandingCommandOutput) => void): void;
252
153
  /**
253
- * @public
254
- * <p>Deletes a client-add-in for Amazon Connect that is configured within a
255
- * directory.</p>
154
+ * @see {@link DeleteConnectClientAddInCommand}
256
155
  */
257
156
  deleteConnectClientAddIn(args: DeleteConnectClientAddInCommandInput, options?: __HttpHandlerOptions): Promise<DeleteConnectClientAddInCommandOutput>;
258
157
  deleteConnectClientAddIn(args: DeleteConnectClientAddInCommandInput, cb: (err: any, data?: DeleteConnectClientAddInCommandOutput) => void): void;
259
158
  deleteConnectClientAddIn(args: DeleteConnectClientAddInCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConnectClientAddInCommandOutput) => void): void;
260
159
  /**
261
- * @public
262
- * <p>Deletes the specified connection alias. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html">
263
- * Cross-Region Redirection for Amazon WorkSpaces</a>.</p>
264
- * <important>
265
- * <p>
266
- * <b>If you will no longer be using a fully qualified domain name
267
- * (FQDN) as the registration code for your WorkSpaces users, you must take certain
268
- * precautions to prevent potential security issues.</b> For more information,
269
- * see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html#cross-region-redirection-security-considerations"> Security Considerations if You Stop Using Cross-Region Redirection</a>.</p>
270
- * </important>
271
- * <note>
272
- * <p>To delete a connection alias that has been shared, the shared account must first
273
- * disassociate the connection alias from any directories it has been associated with. Then
274
- * you must unshare the connection alias from the account it has been shared with. You can
275
- * delete a connection alias only after it is no longer shared with any accounts or
276
- * associated with any directories.</p>
277
- * </note>
160
+ * @see {@link DeleteConnectionAliasCommand}
278
161
  */
279
162
  deleteConnectionAlias(args: DeleteConnectionAliasCommandInput, options?: __HttpHandlerOptions): Promise<DeleteConnectionAliasCommandOutput>;
280
163
  deleteConnectionAlias(args: DeleteConnectionAliasCommandInput, cb: (err: any, data?: DeleteConnectionAliasCommandOutput) => void): void;
281
164
  deleteConnectionAlias(args: DeleteConnectionAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConnectionAliasCommandOutput) => void): void;
282
165
  /**
283
- * @public
284
- * <p>Deletes the specified IP access control group.</p>
285
- * <p>You cannot delete an IP access control group that is associated with a directory.</p>
166
+ * @see {@link DeleteIpGroupCommand}
286
167
  */
287
168
  deleteIpGroup(args: DeleteIpGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteIpGroupCommandOutput>;
288
169
  deleteIpGroup(args: DeleteIpGroupCommandInput, cb: (err: any, data?: DeleteIpGroupCommandOutput) => void): void;
289
170
  deleteIpGroup(args: DeleteIpGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIpGroupCommandOutput) => void): void;
290
171
  /**
291
- * @public
292
- * <p>Deletes the specified tags from the specified WorkSpaces resource.</p>
172
+ * @see {@link DeleteTagsCommand}
293
173
  */
294
174
  deleteTags(args: DeleteTagsCommandInput, options?: __HttpHandlerOptions): Promise<DeleteTagsCommandOutput>;
295
175
  deleteTags(args: DeleteTagsCommandInput, cb: (err: any, data?: DeleteTagsCommandOutput) => void): void;
296
176
  deleteTags(args: DeleteTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTagsCommandOutput) => void): void;
297
177
  /**
298
- * @public
299
- * <p>Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see
300
- * <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/delete_bundle.html">
301
- * Delete a Custom WorkSpaces Bundle or Image</a>.</p>
178
+ * @see {@link DeleteWorkspaceBundleCommand}
302
179
  */
303
180
  deleteWorkspaceBundle(args: DeleteWorkspaceBundleCommandInput, options?: __HttpHandlerOptions): Promise<DeleteWorkspaceBundleCommandOutput>;
304
181
  deleteWorkspaceBundle(args: DeleteWorkspaceBundleCommandInput, cb: (err: any, data?: DeleteWorkspaceBundleCommandOutput) => void): void;
305
182
  deleteWorkspaceBundle(args: DeleteWorkspaceBundleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkspaceBundleCommandOutput) => void): void;
306
183
  /**
307
- * @public
308
- * <p>Deletes the specified image from your account. To delete an image, you must first delete
309
- * any bundles that are associated with the image and unshare the image if it is shared with
310
- * other accounts. </p>
184
+ * @see {@link DeleteWorkspaceImageCommand}
311
185
  */
312
186
  deleteWorkspaceImage(args: DeleteWorkspaceImageCommandInput, options?: __HttpHandlerOptions): Promise<DeleteWorkspaceImageCommandOutput>;
313
187
  deleteWorkspaceImage(args: DeleteWorkspaceImageCommandInput, cb: (err: any, data?: DeleteWorkspaceImageCommandOutput) => void): void;
314
188
  deleteWorkspaceImage(args: DeleteWorkspaceImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkspaceImageCommandOutput) => void): void;
315
189
  /**
316
- * @public
317
- * <p>Deregisters the specified directory. This operation is asynchronous and returns before
318
- * the WorkSpace directory is deregistered. If any WorkSpaces are registered to this
319
- * directory, you must remove them before you can deregister the directory.</p>
320
- * <note>
321
- * <p>Simple AD and AD Connector are made available to you free of charge to use with
322
- * WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector
323
- * directory for 30 consecutive days, this directory will be automatically deregistered for
324
- * use with Amazon WorkSpaces, and you will be charged for this directory as per the <a href="http://aws.amazon.com/directoryservice/pricing/">Directory Service pricing
325
- * terms</a>.</p>
326
- * <p>To delete empty directories, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces-directory.html"> Delete the
327
- * Directory for Your WorkSpaces</a>. If you delete your Simple AD or AD Connector
328
- * directory, you can always create a new one when you want to start using WorkSpaces
329
- * again.</p>
330
- * </note>
190
+ * @see {@link DeregisterWorkspaceDirectoryCommand}
331
191
  */
332
192
  deregisterWorkspaceDirectory(args: DeregisterWorkspaceDirectoryCommandInput, options?: __HttpHandlerOptions): Promise<DeregisterWorkspaceDirectoryCommandOutput>;
333
193
  deregisterWorkspaceDirectory(args: DeregisterWorkspaceDirectoryCommandInput, cb: (err: any, data?: DeregisterWorkspaceDirectoryCommandOutput) => void): void;
334
194
  deregisterWorkspaceDirectory(args: DeregisterWorkspaceDirectoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterWorkspaceDirectoryCommandOutput) => void): void;
335
195
  /**
336
- * @public
337
- * <p>Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for
338
- * the specified account.</p>
196
+ * @see {@link DescribeAccountCommand}
339
197
  */
340
198
  describeAccount(args: DescribeAccountCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAccountCommandOutput>;
341
199
  describeAccount(args: DescribeAccountCommandInput, cb: (err: any, data?: DescribeAccountCommandOutput) => void): void;
342
200
  describeAccount(args: DescribeAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountCommandOutput) => void): void;
343
201
  /**
344
- * @public
345
- * <p>Retrieves a list that describes modifications to the configuration of Bring Your Own
346
- * License (BYOL) for the specified account.</p>
202
+ * @see {@link DescribeAccountModificationsCommand}
347
203
  */
348
204
  describeAccountModifications(args: DescribeAccountModificationsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAccountModificationsCommandOutput>;
349
205
  describeAccountModifications(args: DescribeAccountModificationsCommandInput, cb: (err: any, data?: DescribeAccountModificationsCommandOutput) => void): void;
350
206
  describeAccountModifications(args: DescribeAccountModificationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountModificationsCommandOutput) => void): void;
351
207
  /**
352
- * @public
353
- * <p>Describes the specified client branding. Client branding allows you to customize the log
354
- * in page of various device types for your users. You can add your company logo, the support
355
- * email address, support link, link to reset password, and a custom message for users trying
356
- * to sign in.</p>
357
- * <note>
358
- * <p>Only device types that have branding information configured will be shown in the
359
- * response.</p>
360
- * </note>
208
+ * @see {@link DescribeClientBrandingCommand}
361
209
  */
362
210
  describeClientBranding(args: DescribeClientBrandingCommandInput, options?: __HttpHandlerOptions): Promise<DescribeClientBrandingCommandOutput>;
363
211
  describeClientBranding(args: DescribeClientBrandingCommandInput, cb: (err: any, data?: DescribeClientBrandingCommandOutput) => void): void;
364
212
  describeClientBranding(args: DescribeClientBrandingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClientBrandingCommandOutput) => void): void;
365
213
  /**
366
- * @public
367
- * <p>Retrieves a list that describes one or more specified Amazon WorkSpaces clients.</p>
214
+ * @see {@link DescribeClientPropertiesCommand}
368
215
  */
369
216
  describeClientProperties(args: DescribeClientPropertiesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeClientPropertiesCommandOutput>;
370
217
  describeClientProperties(args: DescribeClientPropertiesCommandInput, cb: (err: any, data?: DescribeClientPropertiesCommandOutput) => void): void;
371
218
  describeClientProperties(args: DescribeClientPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClientPropertiesCommandOutput) => void): void;
372
219
  /**
373
- * @public
374
- * <p>Retrieves a list of Amazon Connect client add-ins that have been created.</p>
220
+ * @see {@link DescribeConnectClientAddInsCommand}
375
221
  */
376
222
  describeConnectClientAddIns(args: DescribeConnectClientAddInsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeConnectClientAddInsCommandOutput>;
377
223
  describeConnectClientAddIns(args: DescribeConnectClientAddInsCommandInput, cb: (err: any, data?: DescribeConnectClientAddInsCommandOutput) => void): void;
378
224
  describeConnectClientAddIns(args: DescribeConnectClientAddInsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConnectClientAddInsCommandOutput) => void): void;
379
225
  /**
380
- * @public
381
- * <p>Retrieves a list that describes the connection aliases used for cross-Region
382
- * redirection. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html"> Cross-Region
383
- * Redirection for Amazon WorkSpaces</a>.</p>
226
+ * @see {@link DescribeConnectionAliasesCommand}
384
227
  */
385
228
  describeConnectionAliases(args: DescribeConnectionAliasesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeConnectionAliasesCommandOutput>;
386
229
  describeConnectionAliases(args: DescribeConnectionAliasesCommandInput, cb: (err: any, data?: DescribeConnectionAliasesCommandOutput) => void): void;
387
230
  describeConnectionAliases(args: DescribeConnectionAliasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConnectionAliasesCommandOutput) => void): void;
388
231
  /**
389
- * @public
390
- * <p>Describes the permissions that the owner of a connection alias has granted to another
391
- * Amazon Web Services account for the specified connection alias. For more information, see
392
- * <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html"> Cross-Region
393
- * Redirection for Amazon WorkSpaces</a>.</p>
232
+ * @see {@link DescribeConnectionAliasPermissionsCommand}
394
233
  */
395
234
  describeConnectionAliasPermissions(args: DescribeConnectionAliasPermissionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeConnectionAliasPermissionsCommandOutput>;
396
235
  describeConnectionAliasPermissions(args: DescribeConnectionAliasPermissionsCommandInput, cb: (err: any, data?: DescribeConnectionAliasPermissionsCommandOutput) => void): void;
397
236
  describeConnectionAliasPermissions(args: DescribeConnectionAliasPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConnectionAliasPermissionsCommandOutput) => void): void;
398
237
  /**
399
- * @public
400
- * <p>Describes one or more of your IP access control groups.</p>
238
+ * @see {@link DescribeIpGroupsCommand}
401
239
  */
402
240
  describeIpGroups(args: DescribeIpGroupsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeIpGroupsCommandOutput>;
403
241
  describeIpGroups(args: DescribeIpGroupsCommandInput, cb: (err: any, data?: DescribeIpGroupsCommandOutput) => void): void;
404
242
  describeIpGroups(args: DescribeIpGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIpGroupsCommandOutput) => void): void;
405
243
  /**
406
- * @public
407
- * <p>Describes the specified tags for the specified WorkSpaces resource.</p>
244
+ * @see {@link DescribeTagsCommand}
408
245
  */
409
246
  describeTags(args: DescribeTagsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTagsCommandOutput>;
410
247
  describeTags(args: DescribeTagsCommandInput, cb: (err: any, data?: DescribeTagsCommandOutput) => void): void;
411
248
  describeTags(args: DescribeTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTagsCommandOutput) => void): void;
412
249
  /**
413
- * @public
414
- * <p>Retrieves a list that describes the available WorkSpace bundles.</p>
415
- * <p>You can filter the results using either bundle ID or owner, but not both.</p>
250
+ * @see {@link DescribeWorkspaceBundlesCommand}
416
251
  */
417
252
  describeWorkspaceBundles(args: DescribeWorkspaceBundlesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeWorkspaceBundlesCommandOutput>;
418
253
  describeWorkspaceBundles(args: DescribeWorkspaceBundlesCommandInput, cb: (err: any, data?: DescribeWorkspaceBundlesCommandOutput) => void): void;
419
254
  describeWorkspaceBundles(args: DescribeWorkspaceBundlesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkspaceBundlesCommandOutput) => void): void;
420
255
  /**
421
- * @public
422
- * <p>Describes the available directories that are registered with Amazon WorkSpaces.</p>
256
+ * @see {@link DescribeWorkspaceDirectoriesCommand}
423
257
  */
424
258
  describeWorkspaceDirectories(args: DescribeWorkspaceDirectoriesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeWorkspaceDirectoriesCommandOutput>;
425
259
  describeWorkspaceDirectories(args: DescribeWorkspaceDirectoriesCommandInput, cb: (err: any, data?: DescribeWorkspaceDirectoriesCommandOutput) => void): void;
426
260
  describeWorkspaceDirectories(args: DescribeWorkspaceDirectoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkspaceDirectoriesCommandOutput) => void): void;
427
261
  /**
428
- * @public
429
- * <p>Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.</p>
262
+ * @see {@link DescribeWorkspaceImagePermissionsCommand}
430
263
  */
431
264
  describeWorkspaceImagePermissions(args: DescribeWorkspaceImagePermissionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeWorkspaceImagePermissionsCommandOutput>;
432
265
  describeWorkspaceImagePermissions(args: DescribeWorkspaceImagePermissionsCommandInput, cb: (err: any, data?: DescribeWorkspaceImagePermissionsCommandOutput) => void): void;
433
266
  describeWorkspaceImagePermissions(args: DescribeWorkspaceImagePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkspaceImagePermissionsCommandOutput) => void): void;
434
267
  /**
435
- * @public
436
- * <p>Retrieves a list that describes one or more specified images, if the image identifiers
437
- * are provided. Otherwise, all images in the account are described. </p>
268
+ * @see {@link DescribeWorkspaceImagesCommand}
438
269
  */
439
270
  describeWorkspaceImages(args: DescribeWorkspaceImagesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeWorkspaceImagesCommandOutput>;
440
271
  describeWorkspaceImages(args: DescribeWorkspaceImagesCommandInput, cb: (err: any, data?: DescribeWorkspaceImagesCommandOutput) => void): void;
441
272
  describeWorkspaceImages(args: DescribeWorkspaceImagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkspaceImagesCommandOutput) => void): void;
442
273
  /**
443
- * @public
444
- * <p>Describes the specified WorkSpaces.</p>
445
- * <p>You can filter the results by using the bundle identifier, directory identifier, or
446
- * owner, but you can specify only one filter at a time.</p>
274
+ * @see {@link DescribeWorkspacesCommand}
447
275
  */
448
276
  describeWorkspaces(args: DescribeWorkspacesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeWorkspacesCommandOutput>;
449
277
  describeWorkspaces(args: DescribeWorkspacesCommandInput, cb: (err: any, data?: DescribeWorkspacesCommandOutput) => void): void;
450
278
  describeWorkspaces(args: DescribeWorkspacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkspacesCommandOutput) => void): void;
451
279
  /**
452
- * @public
453
- * <p>Describes the connection status of the specified WorkSpaces.</p>
280
+ * @see {@link DescribeWorkspacesConnectionStatusCommand}
454
281
  */
455
282
  describeWorkspacesConnectionStatus(args: DescribeWorkspacesConnectionStatusCommandInput, options?: __HttpHandlerOptions): Promise<DescribeWorkspacesConnectionStatusCommandOutput>;
456
283
  describeWorkspacesConnectionStatus(args: DescribeWorkspacesConnectionStatusCommandInput, cb: (err: any, data?: DescribeWorkspacesConnectionStatusCommandOutput) => void): void;
457
284
  describeWorkspacesConnectionStatus(args: DescribeWorkspacesConnectionStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkspacesConnectionStatusCommandOutput) => void): void;
458
285
  /**
459
- * @public
460
- * <p>Describes the snapshots for the specified WorkSpace.</p>
286
+ * @see {@link DescribeWorkspaceSnapshotsCommand}
461
287
  */
462
288
  describeWorkspaceSnapshots(args: DescribeWorkspaceSnapshotsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeWorkspaceSnapshotsCommandOutput>;
463
289
  describeWorkspaceSnapshots(args: DescribeWorkspaceSnapshotsCommandInput, cb: (err: any, data?: DescribeWorkspaceSnapshotsCommandOutput) => void): void;
464
290
  describeWorkspaceSnapshots(args: DescribeWorkspaceSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkspaceSnapshotsCommandOutput) => void): void;
465
291
  /**
466
- * @public
467
- * <p>Disassociates a connection alias from a directory. Disassociating a connection alias
468
- * disables cross-Region redirection between two directories in different Regions. For more
469
- * information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html"> Cross-Region
470
- * Redirection for Amazon WorkSpaces</a>.</p>
471
- * <note>
472
- * <p>Before performing this operation, call <a href="https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html">
473
- * DescribeConnectionAliases</a> to make sure that the current state of the
474
- * connection alias is <code>CREATED</code>.</p>
475
- * </note>
292
+ * @see {@link DisassociateConnectionAliasCommand}
476
293
  */
477
294
  disassociateConnectionAlias(args: DisassociateConnectionAliasCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateConnectionAliasCommandOutput>;
478
295
  disassociateConnectionAlias(args: DisassociateConnectionAliasCommandInput, cb: (err: any, data?: DisassociateConnectionAliasCommandOutput) => void): void;
479
296
  disassociateConnectionAlias(args: DisassociateConnectionAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateConnectionAliasCommandOutput) => void): void;
480
297
  /**
481
- * @public
482
- * <p>Disassociates the specified IP access control group from the specified directory.</p>
298
+ * @see {@link DisassociateIpGroupsCommand}
483
299
  */
484
300
  disassociateIpGroups(args: DisassociateIpGroupsCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateIpGroupsCommandOutput>;
485
301
  disassociateIpGroups(args: DisassociateIpGroupsCommandInput, cb: (err: any, data?: DisassociateIpGroupsCommandOutput) => void): void;
486
302
  disassociateIpGroups(args: DisassociateIpGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateIpGroupsCommandOutput) => void): void;
487
303
  /**
488
- * @public
489
- * <p>Imports client branding. Client branding allows you to customize your WorkSpace's client
490
- * login portal. You can tailor your login portal company logo, the support email address,
491
- * support link, link to reset password, and a custom message for users trying to sign
492
- * in.</p>
493
- * <p>After you import client branding, the default branding experience for the specified
494
- * platform type is replaced with the imported experience</p>
495
- * <note>
496
- * <ul>
497
- * <li>
498
- * <p>You must specify at least one platform type when importing client
499
- * branding.</p>
500
- * </li>
501
- * <li>
502
- * <p>You can import up to 6 MB of data with each request. If your request exceeds
503
- * this limit, you can import client branding for different platform types using
504
- * separate requests.</p>
505
- * </li>
506
- * <li>
507
- * <p>In each platform type, the <code>SupportEmail</code> and
508
- * <code>SupportLink</code> parameters are mutually exclusive. You can specify
509
- * only one parameter for each platform type, but not both.</p>
510
- * </li>
511
- * <li>
512
- * <p>Imported data can take up to a minute to appear in the WorkSpaces
513
- * client.</p>
514
- * </li>
515
- * </ul>
516
- * </note>
304
+ * @see {@link ImportClientBrandingCommand}
517
305
  */
518
306
  importClientBranding(args: ImportClientBrandingCommandInput, options?: __HttpHandlerOptions): Promise<ImportClientBrandingCommandOutput>;
519
307
  importClientBranding(args: ImportClientBrandingCommandInput, cb: (err: any, data?: ImportClientBrandingCommandOutput) => void): void;
520
308
  importClientBranding(args: ImportClientBrandingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportClientBrandingCommandOutput) => void): void;
521
309
  /**
522
- * @public
523
- * <p>Imports the specified Windows 10 Bring Your Own License (BYOL)
524
- * image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is
525
- * in your Amazon Web Services account, and you must own the image. For more information about
526
- * creating BYOL images, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html"> Bring Your Own Windows
527
- * Desktop Licenses</a>.</p>
310
+ * @see {@link ImportWorkspaceImageCommand}
528
311
  */
529
312
  importWorkspaceImage(args: ImportWorkspaceImageCommandInput, options?: __HttpHandlerOptions): Promise<ImportWorkspaceImageCommandOutput>;
530
313
  importWorkspaceImage(args: ImportWorkspaceImageCommandInput, cb: (err: any, data?: ImportWorkspaceImageCommandOutput) => void): void;
531
314
  importWorkspaceImage(args: ImportWorkspaceImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportWorkspaceImageCommandOutput) => void): void;
532
315
  /**
533
- * @public
534
- * <p>Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use
535
- * for the network management interface when you enable Bring Your Own License (BYOL). </p>
536
- * <p>This operation can be run only by Amazon Web Services accounts that are enabled for BYOL.
537
- * If your account isn't enabled for BYOL, you'll receive an
538
- * <code>AccessDeniedException</code> error.</p>
539
- * <p>The management network interface is connected to a secure Amazon WorkSpaces management
540
- * network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces
541
- * clients, and to allow Amazon WorkSpaces to manage the WorkSpace.</p>
316
+ * @see {@link ListAvailableManagementCidrRangesCommand}
542
317
  */
543
318
  listAvailableManagementCidrRanges(args: ListAvailableManagementCidrRangesCommandInput, options?: __HttpHandlerOptions): Promise<ListAvailableManagementCidrRangesCommandOutput>;
544
319
  listAvailableManagementCidrRanges(args: ListAvailableManagementCidrRangesCommandInput, cb: (err: any, data?: ListAvailableManagementCidrRangesCommandOutput) => void): void;
545
320
  listAvailableManagementCidrRanges(args: ListAvailableManagementCidrRangesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAvailableManagementCidrRangesCommandOutput) => void): void;
546
321
  /**
547
- * @public
548
- * <p>Migrates a WorkSpace from one operating system or bundle type to another, while
549
- * retaining the data on the user volume.</p>
550
- * <p>The migration process recreates the WorkSpace by using a new root volume from the target
551
- * bundle image and the user volume from the last available snapshot of the original
552
- * WorkSpace. During migration, the original <code>D:\Users\%USERNAME%</code> user profile
553
- * folder is renamed to <code>D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated</code>. A new
554
- * <code>D:\Users\%USERNAME%\</code> folder is generated by the new OS. Certain files in
555
- * the old user profile are moved to the new user profile.</p>
556
- * <p>For available migration scenarios, details about what happens during migration, and best
557
- * practices, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/migrate-workspaces.html">Migrate a
558
- * WorkSpace</a>.</p>
322
+ * @see {@link MigrateWorkspaceCommand}
559
323
  */
560
324
  migrateWorkspace(args: MigrateWorkspaceCommandInput, options?: __HttpHandlerOptions): Promise<MigrateWorkspaceCommandOutput>;
561
325
  migrateWorkspace(args: MigrateWorkspaceCommandInput, cb: (err: any, data?: MigrateWorkspaceCommandOutput) => void): void;
562
326
  migrateWorkspace(args: MigrateWorkspaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MigrateWorkspaceCommandOutput) => void): void;
563
327
  /**
564
- * @public
565
- * <p>Modifies the configuration of Bring Your Own License (BYOL) for the specified
566
- * account.</p>
328
+ * @see {@link ModifyAccountCommand}
567
329
  */
568
330
  modifyAccount(args: ModifyAccountCommandInput, options?: __HttpHandlerOptions): Promise<ModifyAccountCommandOutput>;
569
331
  modifyAccount(args: ModifyAccountCommandInput, cb: (err: any, data?: ModifyAccountCommandOutput) => void): void;
570
332
  modifyAccount(args: ModifyAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyAccountCommandOutput) => void): void;
571
333
  /**
572
- * @public
573
- * <p>Modifies the properties of the certificate-based authentication you want
574
- * to use with your WorkSpaces.</p>
334
+ * @see {@link ModifyCertificateBasedAuthPropertiesCommand}
575
335
  */
576
336
  modifyCertificateBasedAuthProperties(args: ModifyCertificateBasedAuthPropertiesCommandInput, options?: __HttpHandlerOptions): Promise<ModifyCertificateBasedAuthPropertiesCommandOutput>;
577
337
  modifyCertificateBasedAuthProperties(args: ModifyCertificateBasedAuthPropertiesCommandInput, cb: (err: any, data?: ModifyCertificateBasedAuthPropertiesCommandOutput) => void): void;
578
338
  modifyCertificateBasedAuthProperties(args: ModifyCertificateBasedAuthPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyCertificateBasedAuthPropertiesCommandOutput) => void): void;
579
339
  /**
580
- * @public
581
- * <p>Modifies the properties of the specified Amazon WorkSpaces clients.</p>
340
+ * @see {@link ModifyClientPropertiesCommand}
582
341
  */
583
342
  modifyClientProperties(args: ModifyClientPropertiesCommandInput, options?: __HttpHandlerOptions): Promise<ModifyClientPropertiesCommandOutput>;
584
343
  modifyClientProperties(args: ModifyClientPropertiesCommandInput, cb: (err: any, data?: ModifyClientPropertiesCommandOutput) => void): void;
585
344
  modifyClientProperties(args: ModifyClientPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyClientPropertiesCommandOutput) => void): void;
586
345
  /**
587
- * @public
588
- * <p>Modifies multiple properties related to SAML 2.0 authentication, including the enablement status,
589
- * user access URL, and relay state parameter name that are used for configuring federation with an
590
- * SAML 2.0 identity provider.</p>
346
+ * @see {@link ModifySamlPropertiesCommand}
591
347
  */
592
348
  modifySamlProperties(args: ModifySamlPropertiesCommandInput, options?: __HttpHandlerOptions): Promise<ModifySamlPropertiesCommandOutput>;
593
349
  modifySamlProperties(args: ModifySamlPropertiesCommandInput, cb: (err: any, data?: ModifySamlPropertiesCommandOutput) => void): void;
594
350
  modifySamlProperties(args: ModifySamlPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifySamlPropertiesCommandOutput) => void): void;
595
351
  /**
596
- * @public
597
- * <p>Modifies the self-service WorkSpace management capabilities for your users. For more
598
- * information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/enable-user-self-service-workspace-management.html">Enable Self-Service WorkSpace Management Capabilities for Your Users</a>.</p>
352
+ * @see {@link ModifySelfservicePermissionsCommand}
599
353
  */
600
354
  modifySelfservicePermissions(args: ModifySelfservicePermissionsCommandInput, options?: __HttpHandlerOptions): Promise<ModifySelfservicePermissionsCommandOutput>;
601
355
  modifySelfservicePermissions(args: ModifySelfservicePermissionsCommandInput, cb: (err: any, data?: ModifySelfservicePermissionsCommandOutput) => void): void;
602
356
  modifySelfservicePermissions(args: ModifySelfservicePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifySelfservicePermissionsCommandOutput) => void): void;
603
357
  /**
604
- * @public
605
- * <p>Specifies which devices and operating systems users can use to access their WorkSpaces.
606
- * For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html#control-device-access">
607
- * Control Device Access</a>.</p>
358
+ * @see {@link ModifyWorkspaceAccessPropertiesCommand}
608
359
  */
609
360
  modifyWorkspaceAccessProperties(args: ModifyWorkspaceAccessPropertiesCommandInput, options?: __HttpHandlerOptions): Promise<ModifyWorkspaceAccessPropertiesCommandOutput>;
610
361
  modifyWorkspaceAccessProperties(args: ModifyWorkspaceAccessPropertiesCommandInput, cb: (err: any, data?: ModifyWorkspaceAccessPropertiesCommandOutput) => void): void;
611
362
  modifyWorkspaceAccessProperties(args: ModifyWorkspaceAccessPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyWorkspaceAccessPropertiesCommandOutput) => void): void;
612
363
  /**
613
- * @public
614
- * <p>Modify the default properties used to create WorkSpaces.</p>
364
+ * @see {@link ModifyWorkspaceCreationPropertiesCommand}
615
365
  */
616
366
  modifyWorkspaceCreationProperties(args: ModifyWorkspaceCreationPropertiesCommandInput, options?: __HttpHandlerOptions): Promise<ModifyWorkspaceCreationPropertiesCommandOutput>;
617
367
  modifyWorkspaceCreationProperties(args: ModifyWorkspaceCreationPropertiesCommandInput, cb: (err: any, data?: ModifyWorkspaceCreationPropertiesCommandOutput) => void): void;
618
368
  modifyWorkspaceCreationProperties(args: ModifyWorkspaceCreationPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyWorkspaceCreationPropertiesCommandOutput) => void): void;
619
369
  /**
620
- * @public
621
- * <p>Modifies the specified WorkSpace properties. For important information about how to
622
- * modify the size of the root and user volumes, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html"> Modify a WorkSpace</a>.
623
- * </p>
624
- * <note>
625
- * <p>The <code>MANUAL</code> running mode value is only supported by Amazon WorkSpaces
626
- * Core. Contact your account team to be allow-listed to use this value. For more
627
- * information, see <a href="http://aws.amazon.com/workspaces/core/">Amazon WorkSpaces
628
- * Core</a>.</p>
629
- * </note>
370
+ * @see {@link ModifyWorkspacePropertiesCommand}
630
371
  */
631
372
  modifyWorkspaceProperties(args: ModifyWorkspacePropertiesCommandInput, options?: __HttpHandlerOptions): Promise<ModifyWorkspacePropertiesCommandOutput>;
632
373
  modifyWorkspaceProperties(args: ModifyWorkspacePropertiesCommandInput, cb: (err: any, data?: ModifyWorkspacePropertiesCommandOutput) => void): void;
633
374
  modifyWorkspaceProperties(args: ModifyWorkspacePropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyWorkspacePropertiesCommandOutput) => void): void;
634
375
  /**
635
- * @public
636
- * <p>Sets the state of the specified WorkSpace.</p>
637
- * <p>To maintain a WorkSpace without being interrupted, set the WorkSpace state to
638
- * <code>ADMIN_MAINTENANCE</code>. WorkSpaces in this state do not respond to requests to
639
- * reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not
640
- * stopped. Users cannot log into a WorkSpace in the <code>ADMIN_MAINTENANCE</code>
641
- * state.</p>
376
+ * @see {@link ModifyWorkspaceStateCommand}
642
377
  */
643
378
  modifyWorkspaceState(args: ModifyWorkspaceStateCommandInput, options?: __HttpHandlerOptions): Promise<ModifyWorkspaceStateCommandOutput>;
644
379
  modifyWorkspaceState(args: ModifyWorkspaceStateCommandInput, cb: (err: any, data?: ModifyWorkspaceStateCommandOutput) => void): void;
645
380
  modifyWorkspaceState(args: ModifyWorkspaceStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyWorkspaceStateCommandOutput) => void): void;
646
381
  /**
647
- * @public
648
- * <p>Reboots the specified WorkSpaces.</p>
649
- * <p>You cannot reboot a WorkSpace unless its state is <code>AVAILABLE</code> or
650
- * <code>UNHEALTHY</code>.</p>
651
- * <p>This operation is asynchronous and returns before the WorkSpaces have rebooted.</p>
382
+ * @see {@link RebootWorkspacesCommand}
652
383
  */
653
384
  rebootWorkspaces(args: RebootWorkspacesCommandInput, options?: __HttpHandlerOptions): Promise<RebootWorkspacesCommandOutput>;
654
385
  rebootWorkspaces(args: RebootWorkspacesCommandInput, cb: (err: any, data?: RebootWorkspacesCommandOutput) => void): void;
655
386
  rebootWorkspaces(args: RebootWorkspacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RebootWorkspacesCommandOutput) => void): void;
656
387
  /**
657
- * @public
658
- * <p>Rebuilds the specified WorkSpace.</p>
659
- * <p>You cannot rebuild a WorkSpace unless its state is <code>AVAILABLE</code>,
660
- * <code>ERROR</code>, <code>UNHEALTHY</code>, <code>STOPPED</code>, or
661
- * <code>REBOOTING</code>.</p>
662
- * <p>Rebuilding a WorkSpace is a potentially destructive action that can result in the loss
663
- * of data. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/reset-workspace.html">Rebuild a
664
- * WorkSpace</a>.</p>
665
- * <p>This operation is asynchronous and returns before the WorkSpaces have been completely
666
- * rebuilt.</p>
388
+ * @see {@link RebuildWorkspacesCommand}
667
389
  */
668
390
  rebuildWorkspaces(args: RebuildWorkspacesCommandInput, options?: __HttpHandlerOptions): Promise<RebuildWorkspacesCommandOutput>;
669
391
  rebuildWorkspaces(args: RebuildWorkspacesCommandInput, cb: (err: any, data?: RebuildWorkspacesCommandOutput) => void): void;
670
392
  rebuildWorkspaces(args: RebuildWorkspacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RebuildWorkspacesCommandOutput) => void): void;
671
393
  /**
672
- * @public
673
- * <p>Registers the specified directory. This operation is asynchronous and returns before the
674
- * WorkSpace directory is registered. If this is the first time you are registering a
675
- * directory, you will need to create the workspaces_DefaultRole role before you can register
676
- * a directory. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-access-control.html#create-default-role">
677
- * Creating the workspaces_DefaultRole Role</a>.</p>
394
+ * @see {@link RegisterWorkspaceDirectoryCommand}
678
395
  */
679
396
  registerWorkspaceDirectory(args: RegisterWorkspaceDirectoryCommandInput, options?: __HttpHandlerOptions): Promise<RegisterWorkspaceDirectoryCommandOutput>;
680
397
  registerWorkspaceDirectory(args: RegisterWorkspaceDirectoryCommandInput, cb: (err: any, data?: RegisterWorkspaceDirectoryCommandOutput) => void): void;
681
398
  registerWorkspaceDirectory(args: RegisterWorkspaceDirectoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterWorkspaceDirectoryCommandOutput) => void): void;
682
399
  /**
683
- * @public
684
- * <p>Restores the specified WorkSpace to its last known healthy state.</p>
685
- * <p>You cannot restore a WorkSpace unless its state is <code> AVAILABLE</code>,
686
- * <code>ERROR</code>, <code>UNHEALTHY</code>, or <code>STOPPED</code>.</p>
687
- * <p>Restoring a WorkSpace is a potentially destructive action that can result in the loss of
688
- * data. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/restore-workspace.html">Restore a
689
- * WorkSpace</a>.</p>
690
- * <p>This operation is asynchronous and returns before the WorkSpace is completely
691
- * restored.</p>
400
+ * @see {@link RestoreWorkspaceCommand}
692
401
  */
693
402
  restoreWorkspace(args: RestoreWorkspaceCommandInput, options?: __HttpHandlerOptions): Promise<RestoreWorkspaceCommandOutput>;
694
403
  restoreWorkspace(args: RestoreWorkspaceCommandInput, cb: (err: any, data?: RestoreWorkspaceCommandOutput) => void): void;
695
404
  restoreWorkspace(args: RestoreWorkspaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreWorkspaceCommandOutput) => void): void;
696
405
  /**
697
- * @public
698
- * <p>Removes one or more rules from the specified IP access control group.</p>
406
+ * @see {@link RevokeIpRulesCommand}
699
407
  */
700
408
  revokeIpRules(args: RevokeIpRulesCommandInput, options?: __HttpHandlerOptions): Promise<RevokeIpRulesCommandOutput>;
701
409
  revokeIpRules(args: RevokeIpRulesCommandInput, cb: (err: any, data?: RevokeIpRulesCommandOutput) => void): void;
702
410
  revokeIpRules(args: RevokeIpRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeIpRulesCommandOutput) => void): void;
703
411
  /**
704
- * @public
705
- * <p>Starts the specified WorkSpaces.</p>
706
- * <p>You cannot start a WorkSpace unless it has a running mode of <code>AutoStop</code> and a
707
- * state of <code>STOPPED</code>.</p>
412
+ * @see {@link StartWorkspacesCommand}
708
413
  */
709
414
  startWorkspaces(args: StartWorkspacesCommandInput, options?: __HttpHandlerOptions): Promise<StartWorkspacesCommandOutput>;
710
415
  startWorkspaces(args: StartWorkspacesCommandInput, cb: (err: any, data?: StartWorkspacesCommandOutput) => void): void;
711
416
  startWorkspaces(args: StartWorkspacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartWorkspacesCommandOutput) => void): void;
712
417
  /**
713
- * @public
714
- * <p> Stops the specified WorkSpaces.</p>
715
- * <p>You cannot stop a WorkSpace unless it has a running mode of <code>AutoStop</code> and a
716
- * state of <code>AVAILABLE</code>, <code>IMPAIRED</code>, <code>UNHEALTHY</code>, or
717
- * <code>ERROR</code>.</p>
418
+ * @see {@link StopWorkspacesCommand}
718
419
  */
719
420
  stopWorkspaces(args: StopWorkspacesCommandInput, options?: __HttpHandlerOptions): Promise<StopWorkspacesCommandOutput>;
720
421
  stopWorkspaces(args: StopWorkspacesCommandInput, cb: (err: any, data?: StopWorkspacesCommandOutput) => void): void;
721
422
  stopWorkspaces(args: StopWorkspacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopWorkspacesCommandOutput) => void): void;
722
423
  /**
723
- * @public
724
- * <p>Terminates the specified WorkSpaces.</p>
725
- * <important>
726
- * <p>Terminating a WorkSpace is a permanent action and cannot be undone. The user's data
727
- * is destroyed. If you need to archive any user data, contact Amazon Web Services Support before
728
- * terminating the WorkSpace.</p>
729
- * </important>
730
- * <p>You can terminate a WorkSpace that is in any state except <code>SUSPENDED</code>.</p>
731
- * <p>This operation is asynchronous and returns before the WorkSpaces have been completely
732
- * terminated. After a WorkSpace is terminated, the <code>TERMINATED</code> state is returned
733
- * only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely
734
- * returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using
735
- * <a href="https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html">
736
- * DescribeWorkSpaces</a>. If the WorkSpace ID isn't returned, then the WorkSpace has
737
- * been successfully terminated.</p>
738
- * <note>
739
- * <p>Simple AD and AD Connector are made available to you free of charge to use with
740
- * WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector
741
- * directory for 30 consecutive days, this directory will be automatically deregistered for
742
- * use with Amazon WorkSpaces, and you will be charged for this directory as per the <a href="http://aws.amazon.com/directoryservice/pricing/">Directory Service pricing
743
- * terms</a>.</p>
744
- * <p>To delete empty directories, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces-directory.html"> Delete the
745
- * Directory for Your WorkSpaces</a>. If you delete your Simple AD or AD Connector
746
- * directory, you can always create a new one when you want to start using WorkSpaces
747
- * again.</p>
748
- * </note>
424
+ * @see {@link TerminateWorkspacesCommand}
749
425
  */
750
426
  terminateWorkspaces(args: TerminateWorkspacesCommandInput, options?: __HttpHandlerOptions): Promise<TerminateWorkspacesCommandOutput>;
751
427
  terminateWorkspaces(args: TerminateWorkspacesCommandInput, cb: (err: any, data?: TerminateWorkspacesCommandOutput) => void): void;
752
428
  terminateWorkspaces(args: TerminateWorkspacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TerminateWorkspacesCommandOutput) => void): void;
753
429
  /**
754
- * @public
755
- * <p>Updates a Amazon Connect client add-in. Use this action to update the name and
756
- * endpoint URL of a Amazon Connect client add-in.</p>
430
+ * @see {@link UpdateConnectClientAddInCommand}
757
431
  */
758
432
  updateConnectClientAddIn(args: UpdateConnectClientAddInCommandInput, options?: __HttpHandlerOptions): Promise<UpdateConnectClientAddInCommandOutput>;
759
433
  updateConnectClientAddIn(args: UpdateConnectClientAddInCommandInput, cb: (err: any, data?: UpdateConnectClientAddInCommandOutput) => void): void;
760
434
  updateConnectClientAddIn(args: UpdateConnectClientAddInCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConnectClientAddInCommandOutput) => void): void;
761
435
  /**
762
- * @public
763
- * <p>Shares or unshares a connection alias with one account by specifying whether that
764
- * account has permission to associate the connection alias with a directory. If the
765
- * association permission is granted, the connection alias is shared with that account. If the
766
- * association permission is revoked, the connection alias is unshared with the account. For
767
- * more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html"> Cross-Region
768
- * Redirection for Amazon WorkSpaces</a>.</p>
769
- * <note>
770
- * <ul>
771
- * <li>
772
- * <p>Before performing this operation, call <a href="https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html">
773
- * DescribeConnectionAliases</a> to make sure that the current state of the
774
- * connection alias is <code>CREATED</code>.</p>
775
- * </li>
776
- * <li>
777
- * <p>To delete a connection alias that has been shared, the shared account must
778
- * first disassociate the connection alias from any directories it has been
779
- * associated with. Then you must unshare the connection alias from the account it
780
- * has been shared with. You can delete a connection alias only after it is no longer
781
- * shared with any accounts or associated with any directories.</p>
782
- * </li>
783
- * </ul>
784
- * </note>
436
+ * @see {@link UpdateConnectionAliasPermissionCommand}
785
437
  */
786
438
  updateConnectionAliasPermission(args: UpdateConnectionAliasPermissionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateConnectionAliasPermissionCommandOutput>;
787
439
  updateConnectionAliasPermission(args: UpdateConnectionAliasPermissionCommandInput, cb: (err: any, data?: UpdateConnectionAliasPermissionCommandOutput) => void): void;
788
440
  updateConnectionAliasPermission(args: UpdateConnectionAliasPermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConnectionAliasPermissionCommandOutput) => void): void;
789
441
  /**
790
- * @public
791
- * <p>Replaces the current rules of the specified IP access control group with the specified
792
- * rules.</p>
442
+ * @see {@link UpdateRulesOfIpGroupCommand}
793
443
  */
794
444
  updateRulesOfIpGroup(args: UpdateRulesOfIpGroupCommandInput, options?: __HttpHandlerOptions): Promise<UpdateRulesOfIpGroupCommandOutput>;
795
445
  updateRulesOfIpGroup(args: UpdateRulesOfIpGroupCommandInput, cb: (err: any, data?: UpdateRulesOfIpGroupCommandOutput) => void): void;
796
446
  updateRulesOfIpGroup(args: UpdateRulesOfIpGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRulesOfIpGroupCommandOutput) => void): void;
797
447
  /**
798
- * @public
799
- * <p>Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see
800
- * <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/update-custom-bundle.html">
801
- * Update a Custom WorkSpaces Bundle</a>.</p>
802
- * <important>
803
- * <p>Existing WorkSpaces aren't automatically updated when you update the bundle that they're
804
- * based on. To update existing WorkSpaces that are based on a bundle that you've updated, you
805
- * must either rebuild the WorkSpaces or delete and recreate them.</p>
806
- * </important>
448
+ * @see {@link UpdateWorkspaceBundleCommand}
807
449
  */
808
450
  updateWorkspaceBundle(args: UpdateWorkspaceBundleCommandInput, options?: __HttpHandlerOptions): Promise<UpdateWorkspaceBundleCommandOutput>;
809
451
  updateWorkspaceBundle(args: UpdateWorkspaceBundleCommandInput, cb: (err: any, data?: UpdateWorkspaceBundleCommandOutput) => void): void;
810
452
  updateWorkspaceBundle(args: UpdateWorkspaceBundleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWorkspaceBundleCommandOutput) => void): void;
811
453
  /**
812
- * @public
813
- * <p>Shares or unshares an image with one account in the same Amazon Web Services Region by
814
- * specifying whether that account has permission to copy the image. If the copy image
815
- * permission is granted, the image is shared with that account. If the copy image permission
816
- * is revoked, the image is unshared with the account.</p>
817
- * <p>After an image has been shared, the recipient account can copy the image to other
818
- * Regions as needed.</p>
819
- * <p>In the China (Ningxia) Region, you can copy images only within the same Region.</p>
820
- * <p>In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.</p>
821
- * <p>For more information about sharing images, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/share-custom-image.html"> Share or Unshare a Custom
822
- * WorkSpaces Image</a>.</p>
823
- * <note>
824
- * <ul>
825
- * <li>
826
- * <p>To delete an image that has been shared, you must unshare the image before you
827
- * delete it.</p>
828
- * </li>
829
- * <li>
830
- * <p>Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts
831
- * isn't supported at this time in Amazon Web Services GovCloud (US). To share BYOL images
832
- * across accounts in Amazon Web Services GovCloud (US), contact Amazon Web Services Support.</p>
833
- * </li>
834
- * </ul>
835
- * </note>
454
+ * @see {@link UpdateWorkspaceImagePermissionCommand}
836
455
  */
837
456
  updateWorkspaceImagePermission(args: UpdateWorkspaceImagePermissionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateWorkspaceImagePermissionCommandOutput>;
838
457
  updateWorkspaceImagePermission(args: UpdateWorkspaceImagePermissionCommandInput, cb: (err: any, data?: UpdateWorkspaceImagePermissionCommandOutput) => void): void;
839
458
  updateWorkspaceImagePermission(args: UpdateWorkspaceImagePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWorkspaceImagePermissionCommandOutput) => void): void;
840
459
  }
460
+ /**
461
+ * @public
462
+ * <fullname>Amazon WorkSpaces Service</fullname>
463
+ * <p>Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows
464
+ * or Amazon Linux desktops for your users, known as <i>WorkSpaces</i>.
465
+ * WorkSpaces eliminates the need to procure and deploy hardware or install complex
466
+ * software. You can quickly add or remove users as your needs change. Users can access their
467
+ * virtual desktops from multiple devices or web browsers.</p>
468
+ * <p>This API Reference provides detailed information about the actions, data types,
469
+ * parameters, and errors of the WorkSpaces service. For more information about the
470
+ * supported Amazon Web Services Regions, endpoints, and service quotas of the Amazon WorkSpaces service, see <a href="https://docs.aws.amazon.com/general/latest/gr/wsp.html">WorkSpaces endpoints and quotas</a> in the <i>Amazon Web Services
471
+ * General Reference</i>.</p>
472
+ * <p>You can also manage your WorkSpaces resources using the WorkSpaces
473
+ * console, Command Line Interface (CLI), and SDKs. For more information about
474
+ * administering WorkSpaces, see the <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/">Amazon WorkSpaces Administration Guide</a>.
475
+ * For more information about using the Amazon WorkSpaces client application or web
476
+ * browser to access provisioned WorkSpaces, see the <a href="https://docs.aws.amazon.com/workspaces/latest/userguide/">Amazon WorkSpaces User Guide</a>. For more
477
+ * information about using the CLI to manage your WorkSpaces resources,
478
+ * see the <a href="https://docs.aws.amazon.com/cli/latest/reference/workspaces/index.html">WorkSpaces section of the CLI Reference</a>.</p>
479
+ */
480
+ export declare class WorkSpaces extends WorkSpacesClient implements WorkSpaces {
481
+ }