@aws-sdk/client-workspaces 3.56.0 → 3.67.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 +27 -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 +73 -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 +49 -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 +625 -153
- 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 +172 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +9 -0
- package/package.json +18 -18
|
@@ -8,34 +8,29 @@ export interface TerminateWorkspacesCommandOutput extends TerminateWorkspacesRes
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Terminates the specified WorkSpaces.</p>
|
|
11
|
-
*
|
|
12
11
|
* <important>
|
|
13
|
-
* <p>Terminating a WorkSpace is a permanent action and cannot be undone. The user's data
|
|
14
|
-
* destroyed. If you need to archive any user data, contact Amazon Web Services Support before
|
|
12
|
+
* <p>Terminating a WorkSpace is a permanent action and cannot be undone. The user's data
|
|
13
|
+
* is destroyed. If you need to archive any user data, contact Amazon Web Services Support before
|
|
15
14
|
* terminating the WorkSpace.</p>
|
|
16
15
|
* </important>
|
|
17
|
-
*
|
|
18
16
|
* <p>You can terminate a WorkSpace that is in any state except <code>SUSPENDED</code>.</p>
|
|
19
17
|
* <p>This operation is asynchronous and returns before the WorkSpaces have been completely
|
|
20
18
|
* terminated. After a WorkSpace is terminated, the <code>TERMINATED</code> state is returned
|
|
21
19
|
* only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely
|
|
22
20
|
* returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using
|
|
23
|
-
*
|
|
21
|
+
* <a href="https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html">
|
|
24
22
|
* DescribeWorkSpaces</a>. If the WorkSpace ID isn't returned, then the WorkSpace has
|
|
25
23
|
* been successfully terminated.</p>
|
|
26
|
-
*
|
|
27
24
|
* <note>
|
|
28
|
-
* <p>Simple AD and AD Connector are made available to you free of charge to use with
|
|
29
|
-
* If there are no WorkSpaces being used with your Simple AD or AD Connector
|
|
30
|
-
* consecutive days, this directory will be automatically deregistered for
|
|
31
|
-
* and you will be charged for this directory as per the
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
* Simple AD or AD Connector directory, you can always create a new one when you want to start using
|
|
38
|
-
* WorkSpaces again.</p>
|
|
25
|
+
* <p>Simple AD and AD Connector are made available to you free of charge to use with
|
|
26
|
+
* WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector
|
|
27
|
+
* directory for 30 consecutive days, this directory will be automatically deregistered for
|
|
28
|
+
* 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
|
|
29
|
+
* terms</a>.</p>
|
|
30
|
+
* <p>To delete empty directories, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces-directory.html"> Delete the
|
|
31
|
+
* Directory for Your WorkSpaces</a>. If you delete your Simple AD or AD Connector
|
|
32
|
+
* directory, you can always create a new one when you want to start using WorkSpaces
|
|
33
|
+
* again.</p>
|
|
39
34
|
* </note>
|
|
40
35
|
* @example
|
|
41
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,23 +7,25 @@ export interface UpdateConnectionAliasPermissionCommandInput extends UpdateConne
|
|
|
7
7
|
export interface UpdateConnectionAliasPermissionCommandOutput extends UpdateConnectionAliasPermissionResult, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Shares or unshares a connection alias with one account by specifying whether that
|
|
11
|
-
* associate the connection alias with a directory. If the
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
10
|
+
* <p>Shares or unshares a connection alias with one account by specifying whether that
|
|
11
|
+
* account has permission to associate the connection alias with a directory. If the
|
|
12
|
+
* association permission is granted, the connection alias is shared with that account. If the
|
|
13
|
+
* association permission is revoked, the connection alias is unshared with the account. For
|
|
14
|
+
* more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html"> Cross-Region
|
|
15
|
+
* Redirection for Amazon WorkSpaces</a>.</p>
|
|
16
16
|
* <note>
|
|
17
17
|
* <ul>
|
|
18
18
|
* <li>
|
|
19
19
|
* <p>Before performing this operation, call <a href="https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html">
|
|
20
|
-
*
|
|
20
|
+
* DescribeConnectionAliases</a> to make sure that the current state of the
|
|
21
|
+
* connection alias is <code>CREATED</code>.</p>
|
|
21
22
|
* </li>
|
|
22
23
|
* <li>
|
|
23
|
-
* <p>To delete a connection alias that has been shared, the shared account must
|
|
24
|
-
* connection alias from any directories it has been
|
|
25
|
-
*
|
|
26
|
-
*
|
|
24
|
+
* <p>To delete a connection alias that has been shared, the shared account must
|
|
25
|
+
* first disassociate the connection alias from any directories it has been
|
|
26
|
+
* associated with. Then you must unshare the connection alias from the account it
|
|
27
|
+
* has been shared with. You can delete a connection alias only after it is no longer
|
|
28
|
+
* shared with any accounts or associated with any directories.</p>
|
|
27
29
|
* </li>
|
|
28
30
|
* </ul>
|
|
29
31
|
* </note>
|
|
@@ -7,29 +7,26 @@ export interface UpdateWorkspaceImagePermissionCommandInput extends UpdateWorksp
|
|
|
7
7
|
export interface UpdateWorkspaceImagePermissionCommandOutput extends UpdateWorkspaceImagePermissionResult, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Shares or unshares an image with one account in the same Amazon Web Services Region by
|
|
11
|
-
* permission to copy the image. If the copy image
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
* <p>After an image has been shared, the recipient account can copy the image to other
|
|
15
|
-
*
|
|
10
|
+
* <p>Shares or unshares an image with one account in the same Amazon Web Services Region by
|
|
11
|
+
* specifying whether that account has permission to copy the image. If the copy image
|
|
12
|
+
* permission is granted, the image is shared with that account. If the copy image permission
|
|
13
|
+
* is revoked, the image is unshared with the account.</p>
|
|
14
|
+
* <p>After an image has been shared, the recipient account can copy the image to other
|
|
15
|
+
* Regions as needed.</p>
|
|
16
16
|
* <p>In the China (Ningxia) Region, you can copy images only within the same Region.</p>
|
|
17
|
-
*
|
|
18
17
|
* <p>In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.</p>
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
* <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/share-custom-image.html">
|
|
22
|
-
* Share or Unshare a Custom WorkSpaces Image</a>.</p>
|
|
23
|
-
*
|
|
18
|
+
* <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
|
|
19
|
+
* WorkSpaces Image</a>.</p>
|
|
24
20
|
* <note>
|
|
25
21
|
* <ul>
|
|
26
22
|
* <li>
|
|
27
|
-
* <p>To delete an image that has been shared, you must unshare the image before you
|
|
23
|
+
* <p>To delete an image that has been shared, you must unshare the image before you
|
|
24
|
+
* delete it.</p>
|
|
28
25
|
* </li>
|
|
29
26
|
* <li>
|
|
30
|
-
* <p>Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts
|
|
31
|
-
* this time in Amazon Web Services GovCloud (US). To share BYOL images
|
|
32
|
-
* Amazon Web Services GovCloud (US), contact Amazon Web Services Support.</p>
|
|
27
|
+
* <p>Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts
|
|
28
|
+
* isn't supported at this time in Amazon Web Services GovCloud (US). To share BYOL images
|
|
29
|
+
* across accounts in Amazon Web Services GovCloud (US), contact Amazon Web Services Support.</p>
|
|
33
30
|
* </li>
|
|
34
31
|
* </ul>
|
|
35
32
|
* </note>
|
|
@@ -9,6 +9,7 @@ export * from "./CreateTagsCommand";
|
|
|
9
9
|
export * from "./CreateUpdatedWorkspaceImageCommand";
|
|
10
10
|
export * from "./CreateWorkspaceBundleCommand";
|
|
11
11
|
export * from "./CreateWorkspacesCommand";
|
|
12
|
+
export * from "./DeleteClientBrandingCommand";
|
|
12
13
|
export * from "./DeleteConnectClientAddInCommand";
|
|
13
14
|
export * from "./DeleteConnectionAliasCommand";
|
|
14
15
|
export * from "./DeleteIpGroupCommand";
|
|
@@ -18,6 +19,7 @@ export * from "./DeleteWorkspaceImageCommand";
|
|
|
18
19
|
export * from "./DeregisterWorkspaceDirectoryCommand";
|
|
19
20
|
export * from "./DescribeAccountCommand";
|
|
20
21
|
export * from "./DescribeAccountModificationsCommand";
|
|
22
|
+
export * from "./DescribeClientBrandingCommand";
|
|
21
23
|
export * from "./DescribeClientPropertiesCommand";
|
|
22
24
|
export * from "./DescribeConnectClientAddInsCommand";
|
|
23
25
|
export * from "./DescribeConnectionAliasPermissionsCommand";
|
|
@@ -33,6 +35,7 @@ export * from "./DescribeWorkspacesCommand";
|
|
|
33
35
|
export * from "./DescribeWorkspacesConnectionStatusCommand";
|
|
34
36
|
export * from "./DisassociateConnectionAliasCommand";
|
|
35
37
|
export * from "./DisassociateIpGroupsCommand";
|
|
38
|
+
export * from "./ImportClientBrandingCommand";
|
|
36
39
|
export * from "./ImportWorkspaceImageCommand";
|
|
37
40
|
export * from "./ListAvailableManagementCidrRangesCommand";
|
|
38
41
|
export * from "./MigrateWorkspaceCommand";
|