@aws-sdk/client-workspaces 3.58.0 → 3.68.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.
- package/CHANGELOG.md +30 -0
- package/README.md +18 -4
- package/dist-cjs/WorkSpaces.js +45 -0
- package/dist-cjs/commands/DeleteClientBrandingCommand.js +36 -0
- package/dist-cjs/commands/DescribeClientBrandingCommand.js +36 -0
- package/dist-cjs/commands/ImportClientBrandingCommand.js +36 -0
- package/dist-cjs/commands/index.js +3 -0
- package/dist-cjs/models/models_0.js +76 -4
- package/dist-cjs/protocols/Aws_json1_1.js +327 -3
- package/dist-es/WorkSpaces.js +45 -0
- package/dist-es/commands/DeleteClientBrandingCommand.js +39 -0
- package/dist-es/commands/DescribeClientBrandingCommand.js +39 -0
- package/dist-es/commands/ImportClientBrandingCommand.js +39 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/models/models_0.js +52 -0
- package/dist-es/protocols/Aws_json1_1.js +347 -1
- package/dist-types/WorkSpaces.d.ts +199 -146
- package/dist-types/WorkSpacesClient.d.ts +21 -4
- package/dist-types/commands/AssociateConnectionAliasCommand.d.ts +5 -5
- package/dist-types/commands/CopyWorkspaceImageCommand.d.ts +5 -9
- package/dist-types/commands/CreateConnectClientAddInCommand.d.ts +0 -1
- package/dist-types/commands/CreateConnectionAliasCommand.d.ts +3 -3
- package/dist-types/commands/CreateIpGroupCommand.d.ts +0 -1
- package/dist-types/commands/CreateUpdatedWorkspaceImageCommand.d.ts +11 -13
- package/dist-types/commands/DeleteClientBrandingCommand.d.ts +40 -0
- package/dist-types/commands/DeleteConnectionAliasCommand.d.ts +9 -11
- package/dist-types/commands/DeregisterWorkspaceDirectoryCommand.d.ts +12 -15
- package/dist-types/commands/DescribeClientBrandingCommand.d.ts +42 -0
- package/dist-types/commands/DescribeConnectionAliasPermissionsCommand.d.ts +4 -3
- package/dist-types/commands/DescribeConnectionAliasesCommand.d.ts +3 -3
- package/dist-types/commands/DescribeWorkspaceDirectoriesCommand.d.ts +1 -2
- package/dist-types/commands/DescribeWorkspaceImagePermissionsCommand.d.ts +1 -2
- package/dist-types/commands/DisassociateConnectionAliasCommand.d.ts +6 -6
- package/dist-types/commands/ImportClientBrandingCommand.d.ts +62 -0
- package/dist-types/commands/ImportWorkspaceImageCommand.d.ts +3 -4
- package/dist-types/commands/ListAvailableManagementCidrRangesCommand.d.ts +3 -4
- package/dist-types/commands/MigrateWorkspaceCommand.d.ts +11 -9
- package/dist-types/commands/ModifyWorkspacePropertiesCommand.d.ts +2 -4
- package/dist-types/commands/RebuildWorkspacesCommand.d.ts +2 -1
- package/dist-types/commands/RegisterWorkspaceDirectoryCommand.d.ts +4 -4
- package/dist-types/commands/TerminateWorkspacesCommand.d.ts +12 -17
- package/dist-types/commands/UpdateConnectionAliasPermissionCommand.d.ts +13 -11
- package/dist-types/commands/UpdateWorkspaceImagePermissionCommand.d.ts +13 -16
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +639 -151
- package/dist-types/protocols/Aws_json1_1.d.ts +9 -0
- package/dist-types/ts3.4/WorkSpaces.d.ts +15 -0
- package/dist-types/ts3.4/WorkSpacesClient.d.ts +5 -2
- package/dist-types/ts3.4/commands/DeleteClientBrandingCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeClientBrandingCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ImportClientBrandingCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/models_0.d.ts +175 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +9 -0
- package/package.json +3 -3
|
@@ -10,6 +10,7 @@ import { CreateTagsCommandInput, CreateTagsCommandOutput } from "./commands/Crea
|
|
|
10
10
|
import { CreateUpdatedWorkspaceImageCommandInput, CreateUpdatedWorkspaceImageCommandOutput } from "./commands/CreateUpdatedWorkspaceImageCommand";
|
|
11
11
|
import { CreateWorkspaceBundleCommandInput, CreateWorkspaceBundleCommandOutput } from "./commands/CreateWorkspaceBundleCommand";
|
|
12
12
|
import { CreateWorkspacesCommandInput, CreateWorkspacesCommandOutput } from "./commands/CreateWorkspacesCommand";
|
|
13
|
+
import { DeleteClientBrandingCommandInput, DeleteClientBrandingCommandOutput } from "./commands/DeleteClientBrandingCommand";
|
|
13
14
|
import { DeleteConnectClientAddInCommandInput, DeleteConnectClientAddInCommandOutput } from "./commands/DeleteConnectClientAddInCommand";
|
|
14
15
|
import { DeleteConnectionAliasCommandInput, DeleteConnectionAliasCommandOutput } from "./commands/DeleteConnectionAliasCommand";
|
|
15
16
|
import { DeleteIpGroupCommandInput, DeleteIpGroupCommandOutput } from "./commands/DeleteIpGroupCommand";
|
|
@@ -19,6 +20,7 @@ import { DeleteWorkspaceImageCommandInput, DeleteWorkspaceImageCommandOutput } f
|
|
|
19
20
|
import { DeregisterWorkspaceDirectoryCommandInput, DeregisterWorkspaceDirectoryCommandOutput } from "./commands/DeregisterWorkspaceDirectoryCommand";
|
|
20
21
|
import { DescribeAccountCommandInput, DescribeAccountCommandOutput } from "./commands/DescribeAccountCommand";
|
|
21
22
|
import { DescribeAccountModificationsCommandInput, DescribeAccountModificationsCommandOutput } from "./commands/DescribeAccountModificationsCommand";
|
|
23
|
+
import { DescribeClientBrandingCommandInput, DescribeClientBrandingCommandOutput } from "./commands/DescribeClientBrandingCommand";
|
|
22
24
|
import { DescribeClientPropertiesCommandInput, DescribeClientPropertiesCommandOutput } from "./commands/DescribeClientPropertiesCommand";
|
|
23
25
|
import { DescribeConnectClientAddInsCommandInput, DescribeConnectClientAddInsCommandOutput } from "./commands/DescribeConnectClientAddInsCommand";
|
|
24
26
|
import { DescribeConnectionAliasesCommandInput, DescribeConnectionAliasesCommandOutput } from "./commands/DescribeConnectionAliasesCommand";
|
|
@@ -34,6 +36,7 @@ import { DescribeWorkspacesConnectionStatusCommandInput, DescribeWorkspacesConne
|
|
|
34
36
|
import { DescribeWorkspaceSnapshotsCommandInput, DescribeWorkspaceSnapshotsCommandOutput } from "./commands/DescribeWorkspaceSnapshotsCommand";
|
|
35
37
|
import { DisassociateConnectionAliasCommandInput, DisassociateConnectionAliasCommandOutput } from "./commands/DisassociateConnectionAliasCommand";
|
|
36
38
|
import { DisassociateIpGroupsCommandInput, DisassociateIpGroupsCommandOutput } from "./commands/DisassociateIpGroupsCommand";
|
|
39
|
+
import { ImportClientBrandingCommandInput, ImportClientBrandingCommandOutput } from "./commands/ImportClientBrandingCommand";
|
|
37
40
|
import { ImportWorkspaceImageCommandInput, ImportWorkspaceImageCommandOutput } from "./commands/ImportWorkspaceImageCommand";
|
|
38
41
|
import { ListAvailableManagementCidrRangesCommandInput, ListAvailableManagementCidrRangesCommandOutput } from "./commands/ListAvailableManagementCidrRangesCommand";
|
|
39
42
|
import { MigrateWorkspaceCommandInput, MigrateWorkspaceCommandOutput } from "./commands/MigrateWorkspaceCommand";
|
|
@@ -60,18 +63,32 @@ import { UpdateWorkspaceImagePermissionCommandInput, UpdateWorkspaceImagePermiss
|
|
|
60
63
|
import { WorkSpacesClient } from "./WorkSpacesClient";
|
|
61
64
|
/**
|
|
62
65
|
* <fullname>Amazon WorkSpaces Service</fullname>
|
|
63
|
-
* <p>Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows
|
|
64
|
-
* Amazon Linux desktops for your users
|
|
66
|
+
* <p>Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows
|
|
67
|
+
* or Amazon Linux desktops for your users, known as <i>WorkSpaces</i>.
|
|
68
|
+
* WorkSpaces eliminates the need to procure and deploy hardware or install complex
|
|
69
|
+
* software. You can quickly add or remove users as your needs change. Users can access their
|
|
70
|
+
* virtual desktops from multiple devices or web browsers.</p>
|
|
71
|
+
* <p>This API Reference provides detailed information about the actions, data types,
|
|
72
|
+
* parameters, and errors of the WorkSpaces service. For more information about the
|
|
73
|
+
* 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
|
|
74
|
+
* General Reference</i>.</p>
|
|
75
|
+
* <p>You can also manage your WorkSpaces resources using the WorkSpaces
|
|
76
|
+
* console, Command Line Interface (CLI), and SDKs. For more information about
|
|
77
|
+
* administering WorkSpaces, see the <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/">Amazon WorkSpaces Administration Guide</a>.
|
|
78
|
+
* For more information about using the Amazon WorkSpaces client application or web
|
|
79
|
+
* browser to access provisioned WorkSpaces, see the <a href="https://docs.aws.amazon.com/workspaces/latest/userguide/">Amazon WorkSpaces User Guide</a>. For more
|
|
80
|
+
* information about using the CLI to manage your WorkSpaces resources,
|
|
81
|
+
* see the <a href="https://docs.aws.amazon.com/cli/latest/reference/workspaces/index.html">WorkSpaces section of the CLI Reference</a>.</p>
|
|
65
82
|
*/
|
|
66
83
|
export declare class WorkSpaces extends WorkSpacesClient {
|
|
67
84
|
/**
|
|
68
|
-
* <p>Associates the specified connection alias with the specified directory to enable
|
|
69
|
-
* For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html">
|
|
70
|
-
*
|
|
71
|
-
*
|
|
85
|
+
* <p>Associates the specified connection alias with the specified directory to enable
|
|
86
|
+
* cross-Region redirection. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html"> Cross-Region
|
|
87
|
+
* Redirection for Amazon WorkSpaces</a>.</p>
|
|
72
88
|
* <note>
|
|
73
89
|
* <p>Before performing this operation, call <a href="https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html">
|
|
74
|
-
*
|
|
90
|
+
* DescribeConnectionAliases</a> to make sure that the current state of the
|
|
91
|
+
* connection alias is <code>CREATED</code>.</p>
|
|
75
92
|
* </note>
|
|
76
93
|
*/
|
|
77
94
|
associateConnectionAlias(args: AssociateConnectionAliasCommandInput, options?: __HttpHandlerOptions): Promise<AssociateConnectionAliasCommandOutput>;
|
|
@@ -92,19 +109,15 @@ export declare class WorkSpaces extends WorkSpacesClient {
|
|
|
92
109
|
authorizeIpRules(args: AuthorizeIpRulesCommandInput, cb: (err: any, data?: AuthorizeIpRulesCommandOutput) => void): void;
|
|
93
110
|
authorizeIpRules(args: AuthorizeIpRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AuthorizeIpRulesCommandOutput) => void): void;
|
|
94
111
|
/**
|
|
95
|
-
* <p>Copies the specified image from the specified Region to the current Region.
|
|
96
|
-
*
|
|
97
|
-
*
|
|
98
|
-
* Copy a Custom WorkSpaces Image</a>.</p>
|
|
99
|
-
*
|
|
112
|
+
* <p>Copies the specified image from the specified Region to the current Region. For more
|
|
113
|
+
* information about copying images, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/copy-custom-image.html"> Copy a Custom WorkSpaces
|
|
114
|
+
* Image</a>.</p>
|
|
100
115
|
* <p>In the China (Ningxia) Region, you can copy images only within the same Region.</p>
|
|
101
|
-
*
|
|
102
116
|
* <p>In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.</p>
|
|
103
|
-
*
|
|
104
117
|
* <important>
|
|
105
118
|
* <p>Before copying a shared image, be sure to verify that it has been shared from the
|
|
106
|
-
* correct Amazon Web Services account. To determine if an image has been shared and to see
|
|
107
|
-
* 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>
|
|
119
|
+
* correct Amazon Web Services account. To determine if an image has been shared and to see
|
|
120
|
+
* 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>
|
|
108
121
|
* </important>
|
|
109
122
|
*/
|
|
110
123
|
copyWorkspaceImage(args: CopyWorkspaceImageCommandInput, options?: __HttpHandlerOptions): Promise<CopyWorkspaceImageCommandOutput>;
|
|
@@ -113,16 +126,15 @@ export declare class WorkSpaces extends WorkSpacesClient {
|
|
|
113
126
|
/**
|
|
114
127
|
* <p>Creates a client-add-in for Amazon Connect within a directory. You can create only
|
|
115
128
|
* one Amazon Connect client add-in within a directory.</p>
|
|
116
|
-
*
|
|
117
129
|
* <p>This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect.</p>
|
|
118
130
|
*/
|
|
119
131
|
createConnectClientAddIn(args: CreateConnectClientAddInCommandInput, options?: __HttpHandlerOptions): Promise<CreateConnectClientAddInCommandOutput>;
|
|
120
132
|
createConnectClientAddIn(args: CreateConnectClientAddInCommandInput, cb: (err: any, data?: CreateConnectClientAddInCommandOutput) => void): void;
|
|
121
133
|
createConnectClientAddIn(args: CreateConnectClientAddInCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConnectClientAddInCommandOutput) => void): void;
|
|
122
134
|
/**
|
|
123
|
-
* <p>Creates the specified connection alias for use with cross-Region redirection. For more
|
|
124
|
-
* <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html">
|
|
125
|
-
*
|
|
135
|
+
* <p>Creates the specified connection alias for use with cross-Region redirection. For more
|
|
136
|
+
* information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html"> Cross-Region
|
|
137
|
+
* Redirection for Amazon WorkSpaces</a>.</p>
|
|
126
138
|
*/
|
|
127
139
|
createConnectionAlias(args: CreateConnectionAliasCommandInput, options?: __HttpHandlerOptions): Promise<CreateConnectionAliasCommandOutput>;
|
|
128
140
|
createConnectionAlias(args: CreateConnectionAliasCommandInput, cb: (err: any, data?: CreateConnectionAliasCommandOutput) => void): void;
|
|
@@ -133,7 +145,6 @@ export declare class WorkSpaces extends WorkSpacesClient {
|
|
|
133
145
|
* from which users are allowed to access their WorkSpaces. To specify the CIDR address
|
|
134
146
|
* ranges, add rules to your IP access control group and then associate the group with your
|
|
135
147
|
* directory. You can add rules when you create the group or at any time using <a>AuthorizeIpRules</a>.</p>
|
|
136
|
-
*
|
|
137
148
|
* <p>There is a default IP access control group associated with your directory. If you don't
|
|
138
149
|
* associate an IP access control group with your directory, the default group is used. The
|
|
139
150
|
* default group includes a default rule that allows users to access their WorkSpaces from
|
|
@@ -149,27 +160,25 @@ export declare class WorkSpaces extends WorkSpacesClient {
|
|
|
149
160
|
createTags(args: CreateTagsCommandInput, cb: (err: any, data?: CreateTagsCommandOutput) => void): void;
|
|
150
161
|
createTags(args: CreateTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTagsCommandOutput) => void): void;
|
|
151
162
|
/**
|
|
152
|
-
* <p>Creates a new updated WorkSpace image based on the specified source image. The
|
|
153
|
-
*
|
|
154
|
-
*
|
|
155
|
-
*
|
|
156
|
-
*
|
|
157
|
-
* WorkSpaces requirements, use
|
|
158
|
-
* <a href="https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImages.html">
|
|
163
|
+
* <p>Creates a new updated WorkSpace image based on the specified source image. The new
|
|
164
|
+
* updated WorkSpace image has the latest drivers and other updates required by the Amazon
|
|
165
|
+
* WorkSpaces components.</p>
|
|
166
|
+
* <p>To determine which WorkSpace images need to be updated with the latest Amazon WorkSpaces
|
|
167
|
+
* requirements, use <a href="https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImages.html">
|
|
159
168
|
* DescribeWorkspaceImages</a>.</p>
|
|
160
|
-
*
|
|
161
169
|
* <note>
|
|
162
170
|
* <ul>
|
|
163
171
|
* <li>
|
|
164
|
-
* <p>Only Windows 10, Windows Sever 2016, and Windows Server 2019 WorkSpace images
|
|
172
|
+
* <p>Only Windows 10, Windows Sever 2016, and Windows Server 2019 WorkSpace images
|
|
173
|
+
* can be programmatically updated at this time.</p>
|
|
165
174
|
* </li>
|
|
166
175
|
* <li>
|
|
167
|
-
* <p>Microsoft Windows updates and other application updates are not included
|
|
168
|
-
*
|
|
176
|
+
* <p>Microsoft Windows updates and other application updates are not included in the
|
|
177
|
+
* update process.</p>
|
|
169
178
|
* </li>
|
|
170
179
|
* <li>
|
|
171
|
-
* <p>The source WorkSpace image is not deleted. You can delete the source image
|
|
172
|
-
* verified your new updated image and created a new bundle. </p>
|
|
180
|
+
* <p>The source WorkSpace image is not deleted. You can delete the source image
|
|
181
|
+
* after you've verified your new updated image and created a new bundle. </p>
|
|
173
182
|
* </li>
|
|
174
183
|
* </ul>
|
|
175
184
|
* </note>
|
|
@@ -192,6 +201,17 @@ export declare class WorkSpaces extends WorkSpacesClient {
|
|
|
192
201
|
createWorkspaces(args: CreateWorkspacesCommandInput, options?: __HttpHandlerOptions): Promise<CreateWorkspacesCommandOutput>;
|
|
193
202
|
createWorkspaces(args: CreateWorkspacesCommandInput, cb: (err: any, data?: CreateWorkspacesCommandOutput) => void): void;
|
|
194
203
|
createWorkspaces(args: CreateWorkspacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkspacesCommandOutput) => void): void;
|
|
204
|
+
/**
|
|
205
|
+
* <p>Deletes customized client branding. Client branding allows you to customize your
|
|
206
|
+
* WorkSpace's client login portal. You can tailor your login portal company logo, the support
|
|
207
|
+
* email address, support link, link to reset password, and a custom message for users trying
|
|
208
|
+
* to sign in.</p>
|
|
209
|
+
* <p>After you delete your customized client branding, your login portal reverts to the
|
|
210
|
+
* default client branding.</p>
|
|
211
|
+
*/
|
|
212
|
+
deleteClientBranding(args: DeleteClientBrandingCommandInput, options?: __HttpHandlerOptions): Promise<DeleteClientBrandingCommandOutput>;
|
|
213
|
+
deleteClientBranding(args: DeleteClientBrandingCommandInput, cb: (err: any, data?: DeleteClientBrandingCommandOutput) => void): void;
|
|
214
|
+
deleteClientBranding(args: DeleteClientBrandingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteClientBrandingCommandOutput) => void): void;
|
|
195
215
|
/**
|
|
196
216
|
* <p>Deletes a client-add-in for Amazon Connect that is configured within a
|
|
197
217
|
* directory.</p>
|
|
@@ -201,21 +221,19 @@ export declare class WorkSpaces extends WorkSpacesClient {
|
|
|
201
221
|
deleteConnectClientAddIn(args: DeleteConnectClientAddInCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConnectClientAddInCommandOutput) => void): void;
|
|
202
222
|
/**
|
|
203
223
|
* <p>Deletes the specified connection alias. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html">
|
|
204
|
-
*
|
|
205
|
-
*
|
|
224
|
+
* Cross-Region Redirection for Amazon WorkSpaces</a>.</p>
|
|
206
225
|
* <important>
|
|
207
226
|
* <p>
|
|
208
|
-
* <b>If you will no longer be using a fully qualified domain name
|
|
209
|
-
*
|
|
210
|
-
*
|
|
211
|
-
* <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html#cross-region-redirection-security-considerations">
|
|
212
|
-
* Security Considerations if You Stop Using Cross-Region Redirection</a>.</p>
|
|
227
|
+
* <b>If you will no longer be using a fully qualified domain name
|
|
228
|
+
* (FQDN) as the registration code for your WorkSpaces users, you must take certain
|
|
229
|
+
* precautions to prevent potential security issues.</b> For more information,
|
|
230
|
+
* 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>
|
|
213
231
|
* </important>
|
|
214
|
-
*
|
|
215
232
|
* <note>
|
|
216
|
-
* <p>To delete a connection alias that has been shared, the shared account must first
|
|
217
|
-
* from any directories it has been associated with. Then
|
|
218
|
-
*
|
|
233
|
+
* <p>To delete a connection alias that has been shared, the shared account must first
|
|
234
|
+
* disassociate the connection alias from any directories it has been associated with. Then
|
|
235
|
+
* you must unshare the connection alias from the account it has been shared with. You can
|
|
236
|
+
* delete a connection alias only after it is no longer shared with any accounts or
|
|
219
237
|
* associated with any directories.</p>
|
|
220
238
|
* </note>
|
|
221
239
|
*/
|
|
@@ -252,22 +270,19 @@ export declare class WorkSpaces extends WorkSpacesClient {
|
|
|
252
270
|
deleteWorkspaceImage(args: DeleteWorkspaceImageCommandInput, cb: (err: any, data?: DeleteWorkspaceImageCommandOutput) => void): void;
|
|
253
271
|
deleteWorkspaceImage(args: DeleteWorkspaceImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkspaceImageCommandOutput) => void): void;
|
|
254
272
|
/**
|
|
255
|
-
* <p>Deregisters the specified directory. This operation is asynchronous
|
|
256
|
-
*
|
|
257
|
-
*
|
|
258
|
-
*
|
|
273
|
+
* <p>Deregisters the specified directory. This operation is asynchronous and returns before
|
|
274
|
+
* the WorkSpace directory is deregistered. If any WorkSpaces are registered to this
|
|
275
|
+
* directory, you must remove them before you can deregister the directory.</p>
|
|
259
276
|
* <note>
|
|
260
|
-
* <p>Simple AD and AD Connector are made available to you free of charge to use with
|
|
261
|
-
* If there are no WorkSpaces being used with your Simple AD or AD Connector
|
|
262
|
-
* consecutive days, this directory will be automatically deregistered for
|
|
263
|
-
* and you will be charged for this directory as per the
|
|
264
|
-
*
|
|
265
|
-
*
|
|
266
|
-
*
|
|
267
|
-
*
|
|
268
|
-
*
|
|
269
|
-
* Simple AD or AD Connector directory, you can always create a new one when you want to start using
|
|
270
|
-
* WorkSpaces again.</p>
|
|
277
|
+
* <p>Simple AD and AD Connector are made available to you free of charge to use with
|
|
278
|
+
* WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector
|
|
279
|
+
* directory for 30 consecutive days, this directory will be automatically deregistered for
|
|
280
|
+
* 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
|
|
281
|
+
* terms</a>.</p>
|
|
282
|
+
* <p>To delete empty directories, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces-directory.html"> Delete the
|
|
283
|
+
* Directory for Your WorkSpaces</a>. If you delete your Simple AD or AD Connector
|
|
284
|
+
* directory, you can always create a new one when you want to start using WorkSpaces
|
|
285
|
+
* again.</p>
|
|
271
286
|
* </note>
|
|
272
287
|
*/
|
|
273
288
|
deregisterWorkspaceDirectory(args: DeregisterWorkspaceDirectoryCommandInput, options?: __HttpHandlerOptions): Promise<DeregisterWorkspaceDirectoryCommandOutput>;
|
|
@@ -287,6 +302,19 @@ export declare class WorkSpaces extends WorkSpacesClient {
|
|
|
287
302
|
describeAccountModifications(args: DescribeAccountModificationsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAccountModificationsCommandOutput>;
|
|
288
303
|
describeAccountModifications(args: DescribeAccountModificationsCommandInput, cb: (err: any, data?: DescribeAccountModificationsCommandOutput) => void): void;
|
|
289
304
|
describeAccountModifications(args: DescribeAccountModificationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountModificationsCommandOutput) => void): void;
|
|
305
|
+
/**
|
|
306
|
+
* <p>Describes the specified client branding. Client branding allows you to customize the log
|
|
307
|
+
* in page of various device types for your users. You can add your company logo, the support
|
|
308
|
+
* email address, support link, link to reset password, and a custom message for users trying
|
|
309
|
+
* to sign in.</p>
|
|
310
|
+
* <note>
|
|
311
|
+
* <p>Only device types that have branding information configured will be shown in the
|
|
312
|
+
* response.</p>
|
|
313
|
+
* </note>
|
|
314
|
+
*/
|
|
315
|
+
describeClientBranding(args: DescribeClientBrandingCommandInput, options?: __HttpHandlerOptions): Promise<DescribeClientBrandingCommandOutput>;
|
|
316
|
+
describeClientBranding(args: DescribeClientBrandingCommandInput, cb: (err: any, data?: DescribeClientBrandingCommandOutput) => void): void;
|
|
317
|
+
describeClientBranding(args: DescribeClientBrandingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClientBrandingCommandOutput) => void): void;
|
|
290
318
|
/**
|
|
291
319
|
* <p>Retrieves a list that describes one or more specified Amazon WorkSpaces clients.</p>
|
|
292
320
|
*/
|
|
@@ -300,17 +328,18 @@ export declare class WorkSpaces extends WorkSpacesClient {
|
|
|
300
328
|
describeConnectClientAddIns(args: DescribeConnectClientAddInsCommandInput, cb: (err: any, data?: DescribeConnectClientAddInsCommandOutput) => void): void;
|
|
301
329
|
describeConnectClientAddIns(args: DescribeConnectClientAddInsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConnectClientAddInsCommandOutput) => void): void;
|
|
302
330
|
/**
|
|
303
|
-
* <p>Retrieves a list that describes the connection aliases used for cross-Region
|
|
304
|
-
* <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html">
|
|
305
|
-
*
|
|
331
|
+
* <p>Retrieves a list that describes the connection aliases used for cross-Region
|
|
332
|
+
* redirection. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html"> Cross-Region
|
|
333
|
+
* Redirection for Amazon WorkSpaces</a>.</p>
|
|
306
334
|
*/
|
|
307
335
|
describeConnectionAliases(args: DescribeConnectionAliasesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeConnectionAliasesCommandOutput>;
|
|
308
336
|
describeConnectionAliases(args: DescribeConnectionAliasesCommandInput, cb: (err: any, data?: DescribeConnectionAliasesCommandOutput) => void): void;
|
|
309
337
|
describeConnectionAliases(args: DescribeConnectionAliasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConnectionAliasesCommandOutput) => void): void;
|
|
310
338
|
/**
|
|
311
|
-
* <p>Describes the permissions that the owner of a connection alias has granted to another
|
|
312
|
-
*
|
|
313
|
-
* Cross-Region
|
|
339
|
+
* <p>Describes the permissions that the owner of a connection alias has granted to another
|
|
340
|
+
* Amazon Web Services account for the specified connection alias. For more information, see
|
|
341
|
+
* <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html"> Cross-Region
|
|
342
|
+
* Redirection for Amazon WorkSpaces</a>.</p>
|
|
314
343
|
*/
|
|
315
344
|
describeConnectionAliasPermissions(args: DescribeConnectionAliasPermissionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeConnectionAliasPermissionsCommandOutput>;
|
|
316
345
|
describeConnectionAliasPermissions(args: DescribeConnectionAliasPermissionsCommandInput, cb: (err: any, data?: DescribeConnectionAliasPermissionsCommandOutput) => void): void;
|
|
@@ -335,15 +364,13 @@ export declare class WorkSpaces extends WorkSpacesClient {
|
|
|
335
364
|
describeWorkspaceBundles(args: DescribeWorkspaceBundlesCommandInput, cb: (err: any, data?: DescribeWorkspaceBundlesCommandOutput) => void): void;
|
|
336
365
|
describeWorkspaceBundles(args: DescribeWorkspaceBundlesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkspaceBundlesCommandOutput) => void): void;
|
|
337
366
|
/**
|
|
338
|
-
* <p>Describes the available directories that are registered with
|
|
339
|
-
* Amazon WorkSpaces.</p>
|
|
367
|
+
* <p>Describes the available directories that are registered with Amazon WorkSpaces.</p>
|
|
340
368
|
*/
|
|
341
369
|
describeWorkspaceDirectories(args: DescribeWorkspaceDirectoriesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeWorkspaceDirectoriesCommandOutput>;
|
|
342
370
|
describeWorkspaceDirectories(args: DescribeWorkspaceDirectoriesCommandInput, cb: (err: any, data?: DescribeWorkspaceDirectoriesCommandOutput) => void): void;
|
|
343
371
|
describeWorkspaceDirectories(args: DescribeWorkspaceDirectoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkspaceDirectoriesCommandOutput) => void): void;
|
|
344
372
|
/**
|
|
345
|
-
* <p>Describes the permissions that the owner of an image has granted to other
|
|
346
|
-
* Amazon Web Services accounts for an image.</p>
|
|
373
|
+
* <p>Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.</p>
|
|
347
374
|
*/
|
|
348
375
|
describeWorkspaceImagePermissions(args: DescribeWorkspaceImagePermissionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeWorkspaceImagePermissionsCommandOutput>;
|
|
349
376
|
describeWorkspaceImagePermissions(args: DescribeWorkspaceImagePermissionsCommandInput, cb: (err: any, data?: DescribeWorkspaceImagePermissionsCommandOutput) => void): void;
|
|
@@ -376,14 +403,14 @@ export declare class WorkSpaces extends WorkSpacesClient {
|
|
|
376
403
|
describeWorkspaceSnapshots(args: DescribeWorkspaceSnapshotsCommandInput, cb: (err: any, data?: DescribeWorkspaceSnapshotsCommandOutput) => void): void;
|
|
377
404
|
describeWorkspaceSnapshots(args: DescribeWorkspaceSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkspaceSnapshotsCommandOutput) => void): void;
|
|
378
405
|
/**
|
|
379
|
-
* <p>Disassociates a connection alias from a directory. Disassociating a connection alias
|
|
380
|
-
* redirection between two directories in different Regions. For more
|
|
381
|
-
* <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html">
|
|
382
|
-
*
|
|
383
|
-
*
|
|
406
|
+
* <p>Disassociates a connection alias from a directory. Disassociating a connection alias
|
|
407
|
+
* disables cross-Region redirection between two directories in different Regions. For more
|
|
408
|
+
* information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html"> Cross-Region
|
|
409
|
+
* Redirection for Amazon WorkSpaces</a>.</p>
|
|
384
410
|
* <note>
|
|
385
411
|
* <p>Before performing this operation, call <a href="https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html">
|
|
386
|
-
*
|
|
412
|
+
* DescribeConnectionAliases</a> to make sure that the current state of the
|
|
413
|
+
* connection alias is <code>CREATED</code>.</p>
|
|
387
414
|
* </note>
|
|
388
415
|
*/
|
|
389
416
|
disassociateConnectionAlias(args: DisassociateConnectionAliasCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateConnectionAliasCommandOutput>;
|
|
@@ -395,12 +422,44 @@ export declare class WorkSpaces extends WorkSpacesClient {
|
|
|
395
422
|
disassociateIpGroups(args: DisassociateIpGroupsCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateIpGroupsCommandOutput>;
|
|
396
423
|
disassociateIpGroups(args: DisassociateIpGroupsCommandInput, cb: (err: any, data?: DisassociateIpGroupsCommandOutput) => void): void;
|
|
397
424
|
disassociateIpGroups(args: DisassociateIpGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateIpGroupsCommandOutput) => void): void;
|
|
425
|
+
/**
|
|
426
|
+
* <p>Imports client branding. Client branding allows you to customize your WorkSpace's client
|
|
427
|
+
* login portal. You can tailor your login portal company logo, the support email address,
|
|
428
|
+
* support link, link to reset password, and a custom message for users trying to sign
|
|
429
|
+
* in.</p>
|
|
430
|
+
* <p>After you import client branding, the default branding experience for the specified
|
|
431
|
+
* platform type is replaced with the imported experience</p>
|
|
432
|
+
* <note>
|
|
433
|
+
* <ul>
|
|
434
|
+
* <li>
|
|
435
|
+
* <p>You must specify at least one platform type when importing client
|
|
436
|
+
* branding.</p>
|
|
437
|
+
* </li>
|
|
438
|
+
* <li>
|
|
439
|
+
* <p>You can import up to 6 MB of data with each request. If your request exceeds
|
|
440
|
+
* this limit, you can import client branding for different platform types using
|
|
441
|
+
* separate requests.</p>
|
|
442
|
+
* </li>
|
|
443
|
+
* <li>
|
|
444
|
+
* <p>In each platform type, the <code>SupportEmail</code> and
|
|
445
|
+
* <code>SupportLink</code> parameters are mutually exclusive. You can specify
|
|
446
|
+
* only one parameter for each platform type, but not both.</p>
|
|
447
|
+
* </li>
|
|
448
|
+
* <li>
|
|
449
|
+
* <p>Imported data can take up to a minute to appear in the WorkSpaces
|
|
450
|
+
* client.</p>
|
|
451
|
+
* </li>
|
|
452
|
+
* </ul>
|
|
453
|
+
* </note>
|
|
454
|
+
*/
|
|
455
|
+
importClientBranding(args: ImportClientBrandingCommandInput, options?: __HttpHandlerOptions): Promise<ImportClientBrandingCommandOutput>;
|
|
456
|
+
importClientBranding(args: ImportClientBrandingCommandInput, cb: (err: any, data?: ImportClientBrandingCommandOutput) => void): void;
|
|
457
|
+
importClientBranding(args: ImportClientBrandingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportClientBrandingCommandOutput) => void): void;
|
|
398
458
|
/**
|
|
399
459
|
* <p>Imports the specified Windows 10 Bring Your Own License (BYOL) image into Amazon
|
|
400
|
-
* WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your
|
|
401
|
-
*
|
|
402
|
-
*
|
|
403
|
-
* Bring Your Own Windows Desktop Licenses</a>.</p>
|
|
460
|
+
* WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your Amazon Web Services account, and you must own the image. For more information about creating BYOL
|
|
461
|
+
* images, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html"> Bring Your Own Windows
|
|
462
|
+
* Desktop Licenses</a>.</p>
|
|
404
463
|
*/
|
|
405
464
|
importWorkspaceImage(args: ImportWorkspaceImageCommandInput, options?: __HttpHandlerOptions): Promise<ImportWorkspaceImageCommandOutput>;
|
|
406
465
|
importWorkspaceImage(args: ImportWorkspaceImageCommandInput, cb: (err: any, data?: ImportWorkspaceImageCommandOutput) => void): void;
|
|
@@ -408,10 +467,9 @@ export declare class WorkSpaces extends WorkSpacesClient {
|
|
|
408
467
|
/**
|
|
409
468
|
* <p>Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use
|
|
410
469
|
* for the network management interface when you enable Bring Your Own License (BYOL). </p>
|
|
411
|
-
*
|
|
412
|
-
*
|
|
413
|
-
*
|
|
414
|
-
*
|
|
470
|
+
* <p>This operation can be run only by Amazon Web Services accounts that are enabled for BYOL.
|
|
471
|
+
* If your account isn't enabled for BYOL, you'll receive an
|
|
472
|
+
* <code>AccessDeniedException</code> error.</p>
|
|
415
473
|
* <p>The management network interface is connected to a secure Amazon WorkSpaces management
|
|
416
474
|
* network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces
|
|
417
475
|
* clients, and to allow Amazon WorkSpaces to manage the WorkSpace.</p>
|
|
@@ -420,15 +478,17 @@ export declare class WorkSpaces extends WorkSpacesClient {
|
|
|
420
478
|
listAvailableManagementCidrRanges(args: ListAvailableManagementCidrRangesCommandInput, cb: (err: any, data?: ListAvailableManagementCidrRangesCommandOutput) => void): void;
|
|
421
479
|
listAvailableManagementCidrRanges(args: ListAvailableManagementCidrRangesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAvailableManagementCidrRangesCommandOutput) => void): void;
|
|
422
480
|
/**
|
|
423
|
-
* <p>Migrates a WorkSpace from one operating system or bundle type to another, while
|
|
424
|
-
*
|
|
425
|
-
* <p>The migration process recreates the WorkSpace by using a new root volume from the target
|
|
426
|
-
* from the last available snapshot of the original
|
|
427
|
-
*
|
|
428
|
-
* folder is
|
|
429
|
-
*
|
|
430
|
-
*
|
|
431
|
-
* <
|
|
481
|
+
* <p>Migrates a WorkSpace from one operating system or bundle type to another, while
|
|
482
|
+
* retaining the data on the user volume.</p>
|
|
483
|
+
* <p>The migration process recreates the WorkSpace by using a new root volume from the target
|
|
484
|
+
* bundle image and the user volume from the last available snapshot of the original
|
|
485
|
+
* WorkSpace. During migration, the original <code>D:\Users\%USERNAME%</code> user profile
|
|
486
|
+
* folder is renamed to <code>D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated</code>. A new
|
|
487
|
+
* <code>D:\Users\%USERNAME%\</code> folder is generated by the new OS. Certain files in
|
|
488
|
+
* the old user profile are moved to the new user profile.</p>
|
|
489
|
+
* <p>For available migration scenarios, details about what happens during migration, and best
|
|
490
|
+
* practices, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/migrate-workspaces.html">Migrate a
|
|
491
|
+
* WorkSpace</a>.</p>
|
|
432
492
|
*/
|
|
433
493
|
migrateWorkspace(args: MigrateWorkspaceCommandInput, options?: __HttpHandlerOptions): Promise<MigrateWorkspaceCommandOutput>;
|
|
434
494
|
migrateWorkspace(args: MigrateWorkspaceCommandInput, cb: (err: any, data?: MigrateWorkspaceCommandOutput) => void): void;
|
|
@@ -468,10 +528,8 @@ export declare class WorkSpaces extends WorkSpacesClient {
|
|
|
468
528
|
modifyWorkspaceCreationProperties(args: ModifyWorkspaceCreationPropertiesCommandInput, cb: (err: any, data?: ModifyWorkspaceCreationPropertiesCommandOutput) => void): void;
|
|
469
529
|
modifyWorkspaceCreationProperties(args: ModifyWorkspaceCreationPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyWorkspaceCreationPropertiesCommandOutput) => void): void;
|
|
470
530
|
/**
|
|
471
|
-
* <p>Modifies the specified WorkSpace properties. For important information about how
|
|
472
|
-
*
|
|
473
|
-
* <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html">
|
|
474
|
-
* Modify a WorkSpace</a>.
|
|
531
|
+
* <p>Modifies the specified WorkSpace properties. For important information about how to
|
|
532
|
+
* 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>.
|
|
475
533
|
* </p>
|
|
476
534
|
*/
|
|
477
535
|
modifyWorkspaceProperties(args: ModifyWorkspacePropertiesCommandInput, options?: __HttpHandlerOptions): Promise<ModifyWorkspacePropertiesCommandOutput>;
|
|
@@ -500,7 +558,8 @@ export declare class WorkSpaces extends WorkSpacesClient {
|
|
|
500
558
|
/**
|
|
501
559
|
* <p>Rebuilds the specified WorkSpace.</p>
|
|
502
560
|
* <p>You cannot rebuild a WorkSpace unless its state is <code>AVAILABLE</code>,
|
|
503
|
-
* <code>ERROR</code>, <code>UNHEALTHY</code>, <code>STOPPED</code>, or
|
|
561
|
+
* <code>ERROR</code>, <code>UNHEALTHY</code>, <code>STOPPED</code>, or
|
|
562
|
+
* <code>REBOOTING</code>.</p>
|
|
504
563
|
* <p>Rebuilding a WorkSpace is a potentially destructive action that can result in the loss
|
|
505
564
|
* of data. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/reset-workspace.html">Rebuild a
|
|
506
565
|
* WorkSpace</a>.</p>
|
|
@@ -511,10 +570,10 @@ export declare class WorkSpaces extends WorkSpacesClient {
|
|
|
511
570
|
rebuildWorkspaces(args: RebuildWorkspacesCommandInput, cb: (err: any, data?: RebuildWorkspacesCommandOutput) => void): void;
|
|
512
571
|
rebuildWorkspaces(args: RebuildWorkspacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RebuildWorkspacesCommandOutput) => void): void;
|
|
513
572
|
/**
|
|
514
|
-
* <p>Registers the specified directory. This operation is asynchronous
|
|
515
|
-
*
|
|
516
|
-
*
|
|
517
|
-
*
|
|
573
|
+
* <p>Registers the specified directory. This operation is asynchronous and returns before the
|
|
574
|
+
* WorkSpace directory is registered. If this is the first time you are registering a
|
|
575
|
+
* directory, you will need to create the workspaces_DefaultRole role before you can register
|
|
576
|
+
* a directory. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-access-control.html#create-default-role">
|
|
518
577
|
* Creating the workspaces_DefaultRole Role</a>.</p>
|
|
519
578
|
*/
|
|
520
579
|
registerWorkspaceDirectory(args: RegisterWorkspaceDirectoryCommandInput, options?: __HttpHandlerOptions): Promise<RegisterWorkspaceDirectoryCommandOutput>;
|
|
@@ -558,34 +617,29 @@ export declare class WorkSpaces extends WorkSpacesClient {
|
|
|
558
617
|
stopWorkspaces(args: StopWorkspacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopWorkspacesCommandOutput) => void): void;
|
|
559
618
|
/**
|
|
560
619
|
* <p>Terminates the specified WorkSpaces.</p>
|
|
561
|
-
*
|
|
562
620
|
* <important>
|
|
563
|
-
* <p>Terminating a WorkSpace is a permanent action and cannot be undone. The user's data
|
|
564
|
-
* destroyed. If you need to archive any user data, contact Amazon Web Services Support before
|
|
621
|
+
* <p>Terminating a WorkSpace is a permanent action and cannot be undone. The user's data
|
|
622
|
+
* is destroyed. If you need to archive any user data, contact Amazon Web Services Support before
|
|
565
623
|
* terminating the WorkSpace.</p>
|
|
566
624
|
* </important>
|
|
567
|
-
*
|
|
568
625
|
* <p>You can terminate a WorkSpace that is in any state except <code>SUSPENDED</code>.</p>
|
|
569
626
|
* <p>This operation is asynchronous and returns before the WorkSpaces have been completely
|
|
570
627
|
* terminated. After a WorkSpace is terminated, the <code>TERMINATED</code> state is returned
|
|
571
628
|
* only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely
|
|
572
629
|
* returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using
|
|
573
|
-
*
|
|
630
|
+
* <a href="https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html">
|
|
574
631
|
* DescribeWorkSpaces</a>. If the WorkSpace ID isn't returned, then the WorkSpace has
|
|
575
632
|
* been successfully terminated.</p>
|
|
576
|
-
*
|
|
577
633
|
* <note>
|
|
578
|
-
* <p>Simple AD and AD Connector are made available to you free of charge to use with
|
|
579
|
-
* If there are no WorkSpaces being used with your Simple AD or AD Connector
|
|
580
|
-
* consecutive days, this directory will be automatically deregistered for
|
|
581
|
-
* and you will be charged for this directory as per the
|
|
582
|
-
*
|
|
583
|
-
*
|
|
584
|
-
*
|
|
585
|
-
*
|
|
586
|
-
*
|
|
587
|
-
* Simple AD or AD Connector directory, you can always create a new one when you want to start using
|
|
588
|
-
* WorkSpaces again.</p>
|
|
634
|
+
* <p>Simple AD and AD Connector are made available to you free of charge to use with
|
|
635
|
+
* WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector
|
|
636
|
+
* directory for 30 consecutive days, this directory will be automatically deregistered for
|
|
637
|
+
* 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
|
|
638
|
+
* terms</a>.</p>
|
|
639
|
+
* <p>To delete empty directories, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces-directory.html"> Delete the
|
|
640
|
+
* Directory for Your WorkSpaces</a>. If you delete your Simple AD or AD Connector
|
|
641
|
+
* directory, you can always create a new one when you want to start using WorkSpaces
|
|
642
|
+
* again.</p>
|
|
589
643
|
* </note>
|
|
590
644
|
*/
|
|
591
645
|
terminateWorkspaces(args: TerminateWorkspacesCommandInput, options?: __HttpHandlerOptions): Promise<TerminateWorkspacesCommandOutput>;
|
|
@@ -599,23 +653,25 @@ export declare class WorkSpaces extends WorkSpacesClient {
|
|
|
599
653
|
updateConnectClientAddIn(args: UpdateConnectClientAddInCommandInput, cb: (err: any, data?: UpdateConnectClientAddInCommandOutput) => void): void;
|
|
600
654
|
updateConnectClientAddIn(args: UpdateConnectClientAddInCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConnectClientAddInCommandOutput) => void): void;
|
|
601
655
|
/**
|
|
602
|
-
* <p>Shares or unshares a connection alias with one account by specifying whether that
|
|
603
|
-
* associate the connection alias with a directory. If the
|
|
604
|
-
*
|
|
605
|
-
*
|
|
606
|
-
*
|
|
607
|
-
*
|
|
656
|
+
* <p>Shares or unshares a connection alias with one account by specifying whether that
|
|
657
|
+
* account has permission to associate the connection alias with a directory. If the
|
|
658
|
+
* association permission is granted, the connection alias is shared with that account. If the
|
|
659
|
+
* association permission is revoked, the connection alias is unshared with the account. For
|
|
660
|
+
* more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html"> Cross-Region
|
|
661
|
+
* Redirection for Amazon WorkSpaces</a>.</p>
|
|
608
662
|
* <note>
|
|
609
663
|
* <ul>
|
|
610
664
|
* <li>
|
|
611
665
|
* <p>Before performing this operation, call <a href="https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html">
|
|
612
|
-
*
|
|
666
|
+
* DescribeConnectionAliases</a> to make sure that the current state of the
|
|
667
|
+
* connection alias is <code>CREATED</code>.</p>
|
|
613
668
|
* </li>
|
|
614
669
|
* <li>
|
|
615
|
-
* <p>To delete a connection alias that has been shared, the shared account must
|
|
616
|
-
* connection alias from any directories it has been
|
|
617
|
-
*
|
|
618
|
-
*
|
|
670
|
+
* <p>To delete a connection alias that has been shared, the shared account must
|
|
671
|
+
* first disassociate the connection alias from any directories it has been
|
|
672
|
+
* associated with. Then you must unshare the connection alias from the account it
|
|
673
|
+
* has been shared with. You can delete a connection alias only after it is no longer
|
|
674
|
+
* shared with any accounts or associated with any directories.</p>
|
|
619
675
|
* </li>
|
|
620
676
|
* </ul>
|
|
621
677
|
* </note>
|
|
@@ -645,29 +701,26 @@ export declare class WorkSpaces extends WorkSpacesClient {
|
|
|
645
701
|
updateWorkspaceBundle(args: UpdateWorkspaceBundleCommandInput, cb: (err: any, data?: UpdateWorkspaceBundleCommandOutput) => void): void;
|
|
646
702
|
updateWorkspaceBundle(args: UpdateWorkspaceBundleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWorkspaceBundleCommandOutput) => void): void;
|
|
647
703
|
/**
|
|
648
|
-
* <p>Shares or unshares an image with one account in the same Amazon Web Services Region by
|
|
649
|
-
* permission to copy the image. If the copy image
|
|
650
|
-
*
|
|
651
|
-
*
|
|
652
|
-
* <p>After an image has been shared, the recipient account can copy the image to other
|
|
653
|
-
*
|
|
704
|
+
* <p>Shares or unshares an image with one account in the same Amazon Web Services Region by
|
|
705
|
+
* specifying whether that account has permission to copy the image. If the copy image
|
|
706
|
+
* permission is granted, the image is shared with that account. If the copy image permission
|
|
707
|
+
* is revoked, the image is unshared with the account.</p>
|
|
708
|
+
* <p>After an image has been shared, the recipient account can copy the image to other
|
|
709
|
+
* Regions as needed.</p>
|
|
654
710
|
* <p>In the China (Ningxia) Region, you can copy images only within the same Region.</p>
|
|
655
|
-
*
|
|
656
711
|
* <p>In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.</p>
|
|
657
|
-
*
|
|
658
|
-
*
|
|
659
|
-
* <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/share-custom-image.html">
|
|
660
|
-
* Share or Unshare a Custom WorkSpaces Image</a>.</p>
|
|
661
|
-
*
|
|
712
|
+
* <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
|
|
713
|
+
* WorkSpaces Image</a>.</p>
|
|
662
714
|
* <note>
|
|
663
715
|
* <ul>
|
|
664
716
|
* <li>
|
|
665
|
-
* <p>To delete an image that has been shared, you must unshare the image before you
|
|
717
|
+
* <p>To delete an image that has been shared, you must unshare the image before you
|
|
718
|
+
* delete it.</p>
|
|
666
719
|
* </li>
|
|
667
720
|
* <li>
|
|
668
|
-
* <p>Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts
|
|
669
|
-
* this time in Amazon Web Services GovCloud (US). To share BYOL images
|
|
670
|
-
* Amazon Web Services GovCloud (US), contact Amazon Web Services Support.</p>
|
|
721
|
+
* <p>Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts
|
|
722
|
+
* isn't supported at this time in Amazon Web Services GovCloud (US). To share BYOL images
|
|
723
|
+
* across accounts in Amazon Web Services GovCloud (US), contact Amazon Web Services Support.</p>
|
|
671
724
|
* </li>
|
|
672
725
|
* </ul>
|
|
673
726
|
* </note>
|