@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
|
@@ -17,6 +17,7 @@ import { CreateTagsCommandInput, CreateTagsCommandOutput } from "./commands/Crea
|
|
|
17
17
|
import { CreateUpdatedWorkspaceImageCommandInput, CreateUpdatedWorkspaceImageCommandOutput } from "./commands/CreateUpdatedWorkspaceImageCommand";
|
|
18
18
|
import { CreateWorkspaceBundleCommandInput, CreateWorkspaceBundleCommandOutput } from "./commands/CreateWorkspaceBundleCommand";
|
|
19
19
|
import { CreateWorkspacesCommandInput, CreateWorkspacesCommandOutput } from "./commands/CreateWorkspacesCommand";
|
|
20
|
+
import { DeleteClientBrandingCommandInput, DeleteClientBrandingCommandOutput } from "./commands/DeleteClientBrandingCommand";
|
|
20
21
|
import { DeleteConnectClientAddInCommandInput, DeleteConnectClientAddInCommandOutput } from "./commands/DeleteConnectClientAddInCommand";
|
|
21
22
|
import { DeleteConnectionAliasCommandInput, DeleteConnectionAliasCommandOutput } from "./commands/DeleteConnectionAliasCommand";
|
|
22
23
|
import { DeleteIpGroupCommandInput, DeleteIpGroupCommandOutput } from "./commands/DeleteIpGroupCommand";
|
|
@@ -26,6 +27,7 @@ import { DeleteWorkspaceImageCommandInput, DeleteWorkspaceImageCommandOutput } f
|
|
|
26
27
|
import { DeregisterWorkspaceDirectoryCommandInput, DeregisterWorkspaceDirectoryCommandOutput } from "./commands/DeregisterWorkspaceDirectoryCommand";
|
|
27
28
|
import { DescribeAccountCommandInput, DescribeAccountCommandOutput } from "./commands/DescribeAccountCommand";
|
|
28
29
|
import { DescribeAccountModificationsCommandInput, DescribeAccountModificationsCommandOutput } from "./commands/DescribeAccountModificationsCommand";
|
|
30
|
+
import { DescribeClientBrandingCommandInput, DescribeClientBrandingCommandOutput } from "./commands/DescribeClientBrandingCommand";
|
|
29
31
|
import { DescribeClientPropertiesCommandInput, DescribeClientPropertiesCommandOutput } from "./commands/DescribeClientPropertiesCommand";
|
|
30
32
|
import { DescribeConnectClientAddInsCommandInput, DescribeConnectClientAddInsCommandOutput } from "./commands/DescribeConnectClientAddInsCommand";
|
|
31
33
|
import { DescribeConnectionAliasesCommandInput, DescribeConnectionAliasesCommandOutput } from "./commands/DescribeConnectionAliasesCommand";
|
|
@@ -41,6 +43,7 @@ import { DescribeWorkspacesConnectionStatusCommandInput, DescribeWorkspacesConne
|
|
|
41
43
|
import { DescribeWorkspaceSnapshotsCommandInput, DescribeWorkspaceSnapshotsCommandOutput } from "./commands/DescribeWorkspaceSnapshotsCommand";
|
|
42
44
|
import { DisassociateConnectionAliasCommandInput, DisassociateConnectionAliasCommandOutput } from "./commands/DisassociateConnectionAliasCommand";
|
|
43
45
|
import { DisassociateIpGroupsCommandInput, DisassociateIpGroupsCommandOutput } from "./commands/DisassociateIpGroupsCommand";
|
|
46
|
+
import { ImportClientBrandingCommandInput, ImportClientBrandingCommandOutput } from "./commands/ImportClientBrandingCommand";
|
|
44
47
|
import { ImportWorkspaceImageCommandInput, ImportWorkspaceImageCommandOutput } from "./commands/ImportWorkspaceImageCommand";
|
|
45
48
|
import { ListAvailableManagementCidrRangesCommandInput, ListAvailableManagementCidrRangesCommandOutput } from "./commands/ListAvailableManagementCidrRangesCommand";
|
|
46
49
|
import { MigrateWorkspaceCommandInput, MigrateWorkspaceCommandOutput } from "./commands/MigrateWorkspaceCommand";
|
|
@@ -64,8 +67,8 @@ import { UpdateConnectionAliasPermissionCommandInput, UpdateConnectionAliasPermi
|
|
|
64
67
|
import { UpdateRulesOfIpGroupCommandInput, UpdateRulesOfIpGroupCommandOutput } from "./commands/UpdateRulesOfIpGroupCommand";
|
|
65
68
|
import { UpdateWorkspaceBundleCommandInput, UpdateWorkspaceBundleCommandOutput } from "./commands/UpdateWorkspaceBundleCommand";
|
|
66
69
|
import { UpdateWorkspaceImagePermissionCommandInput, UpdateWorkspaceImagePermissionCommandOutput } from "./commands/UpdateWorkspaceImagePermissionCommand";
|
|
67
|
-
export declare type ServiceInputTypes = AssociateConnectionAliasCommandInput | AssociateIpGroupsCommandInput | AuthorizeIpRulesCommandInput | CopyWorkspaceImageCommandInput | CreateConnectClientAddInCommandInput | CreateConnectionAliasCommandInput | CreateIpGroupCommandInput | CreateTagsCommandInput | CreateUpdatedWorkspaceImageCommandInput | CreateWorkspaceBundleCommandInput | CreateWorkspacesCommandInput | DeleteConnectClientAddInCommandInput | DeleteConnectionAliasCommandInput | DeleteIpGroupCommandInput | DeleteTagsCommandInput | DeleteWorkspaceBundleCommandInput | DeleteWorkspaceImageCommandInput | DeregisterWorkspaceDirectoryCommandInput | DescribeAccountCommandInput | DescribeAccountModificationsCommandInput | DescribeClientPropertiesCommandInput | DescribeConnectClientAddInsCommandInput | DescribeConnectionAliasPermissionsCommandInput | DescribeConnectionAliasesCommandInput | DescribeIpGroupsCommandInput | DescribeTagsCommandInput | DescribeWorkspaceBundlesCommandInput | DescribeWorkspaceDirectoriesCommandInput | DescribeWorkspaceImagePermissionsCommandInput | DescribeWorkspaceImagesCommandInput | DescribeWorkspaceSnapshotsCommandInput | DescribeWorkspacesCommandInput | DescribeWorkspacesConnectionStatusCommandInput | DisassociateConnectionAliasCommandInput | DisassociateIpGroupsCommandInput | ImportWorkspaceImageCommandInput | ListAvailableManagementCidrRangesCommandInput | MigrateWorkspaceCommandInput | ModifyAccountCommandInput | ModifyClientPropertiesCommandInput | ModifySelfservicePermissionsCommandInput | ModifyWorkspaceAccessPropertiesCommandInput | ModifyWorkspaceCreationPropertiesCommandInput | ModifyWorkspacePropertiesCommandInput | ModifyWorkspaceStateCommandInput | RebootWorkspacesCommandInput | RebuildWorkspacesCommandInput | RegisterWorkspaceDirectoryCommandInput | RestoreWorkspaceCommandInput | RevokeIpRulesCommandInput | StartWorkspacesCommandInput | StopWorkspacesCommandInput | TerminateWorkspacesCommandInput | UpdateConnectClientAddInCommandInput | UpdateConnectionAliasPermissionCommandInput | UpdateRulesOfIpGroupCommandInput | UpdateWorkspaceBundleCommandInput | UpdateWorkspaceImagePermissionCommandInput;
|
|
68
|
-
export declare type ServiceOutputTypes = AssociateConnectionAliasCommandOutput | AssociateIpGroupsCommandOutput | AuthorizeIpRulesCommandOutput | CopyWorkspaceImageCommandOutput | CreateConnectClientAddInCommandOutput | CreateConnectionAliasCommandOutput | CreateIpGroupCommandOutput | CreateTagsCommandOutput | CreateUpdatedWorkspaceImageCommandOutput | CreateWorkspaceBundleCommandOutput | CreateWorkspacesCommandOutput | DeleteConnectClientAddInCommandOutput | DeleteConnectionAliasCommandOutput | DeleteIpGroupCommandOutput | DeleteTagsCommandOutput | DeleteWorkspaceBundleCommandOutput | DeleteWorkspaceImageCommandOutput | DeregisterWorkspaceDirectoryCommandOutput | DescribeAccountCommandOutput | DescribeAccountModificationsCommandOutput | DescribeClientPropertiesCommandOutput | DescribeConnectClientAddInsCommandOutput | DescribeConnectionAliasPermissionsCommandOutput | DescribeConnectionAliasesCommandOutput | DescribeIpGroupsCommandOutput | DescribeTagsCommandOutput | DescribeWorkspaceBundlesCommandOutput | DescribeWorkspaceDirectoriesCommandOutput | DescribeWorkspaceImagePermissionsCommandOutput | DescribeWorkspaceImagesCommandOutput | DescribeWorkspaceSnapshotsCommandOutput | DescribeWorkspacesCommandOutput | DescribeWorkspacesConnectionStatusCommandOutput | DisassociateConnectionAliasCommandOutput | DisassociateIpGroupsCommandOutput | ImportWorkspaceImageCommandOutput | ListAvailableManagementCidrRangesCommandOutput | MigrateWorkspaceCommandOutput | ModifyAccountCommandOutput | ModifyClientPropertiesCommandOutput | ModifySelfservicePermissionsCommandOutput | ModifyWorkspaceAccessPropertiesCommandOutput | ModifyWorkspaceCreationPropertiesCommandOutput | ModifyWorkspacePropertiesCommandOutput | ModifyWorkspaceStateCommandOutput | RebootWorkspacesCommandOutput | RebuildWorkspacesCommandOutput | RegisterWorkspaceDirectoryCommandOutput | RestoreWorkspaceCommandOutput | RevokeIpRulesCommandOutput | StartWorkspacesCommandOutput | StopWorkspacesCommandOutput | TerminateWorkspacesCommandOutput | UpdateConnectClientAddInCommandOutput | UpdateConnectionAliasPermissionCommandOutput | UpdateRulesOfIpGroupCommandOutput | UpdateWorkspaceBundleCommandOutput | UpdateWorkspaceImagePermissionCommandOutput;
|
|
70
|
+
export declare type ServiceInputTypes = AssociateConnectionAliasCommandInput | AssociateIpGroupsCommandInput | AuthorizeIpRulesCommandInput | CopyWorkspaceImageCommandInput | CreateConnectClientAddInCommandInput | CreateConnectionAliasCommandInput | CreateIpGroupCommandInput | CreateTagsCommandInput | CreateUpdatedWorkspaceImageCommandInput | CreateWorkspaceBundleCommandInput | CreateWorkspacesCommandInput | DeleteClientBrandingCommandInput | DeleteConnectClientAddInCommandInput | DeleteConnectionAliasCommandInput | DeleteIpGroupCommandInput | DeleteTagsCommandInput | DeleteWorkspaceBundleCommandInput | DeleteWorkspaceImageCommandInput | DeregisterWorkspaceDirectoryCommandInput | DescribeAccountCommandInput | DescribeAccountModificationsCommandInput | DescribeClientBrandingCommandInput | DescribeClientPropertiesCommandInput | DescribeConnectClientAddInsCommandInput | DescribeConnectionAliasPermissionsCommandInput | DescribeConnectionAliasesCommandInput | DescribeIpGroupsCommandInput | DescribeTagsCommandInput | DescribeWorkspaceBundlesCommandInput | DescribeWorkspaceDirectoriesCommandInput | DescribeWorkspaceImagePermissionsCommandInput | DescribeWorkspaceImagesCommandInput | DescribeWorkspaceSnapshotsCommandInput | DescribeWorkspacesCommandInput | DescribeWorkspacesConnectionStatusCommandInput | DisassociateConnectionAliasCommandInput | DisassociateIpGroupsCommandInput | ImportClientBrandingCommandInput | ImportWorkspaceImageCommandInput | ListAvailableManagementCidrRangesCommandInput | MigrateWorkspaceCommandInput | ModifyAccountCommandInput | ModifyClientPropertiesCommandInput | ModifySelfservicePermissionsCommandInput | ModifyWorkspaceAccessPropertiesCommandInput | ModifyWorkspaceCreationPropertiesCommandInput | ModifyWorkspacePropertiesCommandInput | ModifyWorkspaceStateCommandInput | RebootWorkspacesCommandInput | RebuildWorkspacesCommandInput | RegisterWorkspaceDirectoryCommandInput | RestoreWorkspaceCommandInput | RevokeIpRulesCommandInput | StartWorkspacesCommandInput | StopWorkspacesCommandInput | TerminateWorkspacesCommandInput | UpdateConnectClientAddInCommandInput | UpdateConnectionAliasPermissionCommandInput | UpdateRulesOfIpGroupCommandInput | UpdateWorkspaceBundleCommandInput | UpdateWorkspaceImagePermissionCommandInput;
|
|
71
|
+
export declare type ServiceOutputTypes = AssociateConnectionAliasCommandOutput | AssociateIpGroupsCommandOutput | AuthorizeIpRulesCommandOutput | CopyWorkspaceImageCommandOutput | CreateConnectClientAddInCommandOutput | CreateConnectionAliasCommandOutput | CreateIpGroupCommandOutput | CreateTagsCommandOutput | CreateUpdatedWorkspaceImageCommandOutput | CreateWorkspaceBundleCommandOutput | CreateWorkspacesCommandOutput | DeleteClientBrandingCommandOutput | DeleteConnectClientAddInCommandOutput | DeleteConnectionAliasCommandOutput | DeleteIpGroupCommandOutput | DeleteTagsCommandOutput | DeleteWorkspaceBundleCommandOutput | DeleteWorkspaceImageCommandOutput | DeregisterWorkspaceDirectoryCommandOutput | DescribeAccountCommandOutput | DescribeAccountModificationsCommandOutput | DescribeClientBrandingCommandOutput | DescribeClientPropertiesCommandOutput | DescribeConnectClientAddInsCommandOutput | DescribeConnectionAliasPermissionsCommandOutput | DescribeConnectionAliasesCommandOutput | DescribeIpGroupsCommandOutput | DescribeTagsCommandOutput | DescribeWorkspaceBundlesCommandOutput | DescribeWorkspaceDirectoriesCommandOutput | DescribeWorkspaceImagePermissionsCommandOutput | DescribeWorkspaceImagesCommandOutput | DescribeWorkspaceSnapshotsCommandOutput | DescribeWorkspacesCommandOutput | DescribeWorkspacesConnectionStatusCommandOutput | DisassociateConnectionAliasCommandOutput | DisassociateIpGroupsCommandOutput | ImportClientBrandingCommandOutput | ImportWorkspaceImageCommandOutput | ListAvailableManagementCidrRangesCommandOutput | MigrateWorkspaceCommandOutput | ModifyAccountCommandOutput | ModifyClientPropertiesCommandOutput | ModifySelfservicePermissionsCommandOutput | ModifyWorkspaceAccessPropertiesCommandOutput | ModifyWorkspaceCreationPropertiesCommandOutput | ModifyWorkspacePropertiesCommandOutput | ModifyWorkspaceStateCommandOutput | RebootWorkspacesCommandOutput | RebuildWorkspacesCommandOutput | RegisterWorkspaceDirectoryCommandOutput | RestoreWorkspaceCommandOutput | RevokeIpRulesCommandOutput | StartWorkspacesCommandOutput | StopWorkspacesCommandOutput | TerminateWorkspacesCommandOutput | UpdateConnectClientAddInCommandOutput | UpdateConnectionAliasPermissionCommandOutput | UpdateRulesOfIpGroupCommandOutput | UpdateWorkspaceBundleCommandOutput | UpdateWorkspaceImagePermissionCommandOutput;
|
|
69
72
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
70
73
|
/**
|
|
71
74
|
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
@@ -185,8 +188,22 @@ export interface WorkSpacesClientResolvedConfig extends WorkSpacesClientResolved
|
|
|
185
188
|
}
|
|
186
189
|
/**
|
|
187
190
|
* <fullname>Amazon WorkSpaces Service</fullname>
|
|
188
|
-
* <p>Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows
|
|
189
|
-
* Amazon Linux desktops for your users
|
|
191
|
+
* <p>Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows
|
|
192
|
+
* or Amazon Linux desktops for your users, known as <i>WorkSpaces</i>.
|
|
193
|
+
* WorkSpaces eliminates the need to procure and deploy hardware or install complex
|
|
194
|
+
* software. You can quickly add or remove users as your needs change. Users can access their
|
|
195
|
+
* virtual desktops from multiple devices or web browsers.</p>
|
|
196
|
+
* <p>This API Reference provides detailed information about the actions, data types,
|
|
197
|
+
* parameters, and errors of the WorkSpaces service. For more information about the
|
|
198
|
+
* 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
|
|
199
|
+
* General Reference</i>.</p>
|
|
200
|
+
* <p>You can also manage your WorkSpaces resources using the WorkSpaces
|
|
201
|
+
* console, Command Line Interface (CLI), and SDKs. For more information about
|
|
202
|
+
* administering WorkSpaces, see the <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/">Amazon WorkSpaces Administration Guide</a>.
|
|
203
|
+
* For more information about using the Amazon WorkSpaces client application or web
|
|
204
|
+
* browser to access provisioned WorkSpaces, see the <a href="https://docs.aws.amazon.com/workspaces/latest/userguide/">Amazon WorkSpaces User Guide</a>. For more
|
|
205
|
+
* information about using the CLI to manage your WorkSpaces resources,
|
|
206
|
+
* see the <a href="https://docs.aws.amazon.com/cli/latest/reference/workspaces/index.html">WorkSpaces section of the CLI Reference</a>.</p>
|
|
190
207
|
*/
|
|
191
208
|
export declare class WorkSpacesClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, WorkSpacesClientResolvedConfig> {
|
|
192
209
|
/**
|
|
@@ -7,13 +7,13 @@ export interface AssociateConnectionAliasCommandInput extends AssociateConnectio
|
|
|
7
7
|
export interface AssociateConnectionAliasCommandOutput extends AssociateConnectionAliasResult, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Associates the specified connection alias with the specified directory to enable
|
|
11
|
-
* For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html">
|
|
12
|
-
*
|
|
13
|
-
*
|
|
10
|
+
* <p>Associates the specified connection alias with the specified directory to enable
|
|
11
|
+
* cross-Region redirection. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html"> Cross-Region
|
|
12
|
+
* Redirection for Amazon WorkSpaces</a>.</p>
|
|
14
13
|
* <note>
|
|
15
14
|
* <p>Before performing this operation, call <a href="https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html">
|
|
16
|
-
*
|
|
15
|
+
* DescribeConnectionAliases</a> to make sure that the current state of the
|
|
16
|
+
* connection alias is <code>CREATED</code>.</p>
|
|
17
17
|
* </note>
|
|
18
18
|
* @example
|
|
19
19
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,19 +7,15 @@ export interface CopyWorkspaceImageCommandInput extends CopyWorkspaceImageReques
|
|
|
7
7
|
export interface CopyWorkspaceImageCommandOutput extends CopyWorkspaceImageResult, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Copies the specified image from the specified Region to the current Region.
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
* Copy a Custom WorkSpaces Image</a>.</p>
|
|
14
|
-
*
|
|
10
|
+
* <p>Copies the specified image from the specified Region to the current Region. For more
|
|
11
|
+
* information about copying images, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/copy-custom-image.html"> Copy a Custom WorkSpaces
|
|
12
|
+
* Image</a>.</p>
|
|
15
13
|
* <p>In the China (Ningxia) Region, you can copy images only within the same Region.</p>
|
|
16
|
-
*
|
|
17
14
|
* <p>In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.</p>
|
|
18
|
-
*
|
|
19
15
|
* <important>
|
|
20
16
|
* <p>Before copying a shared image, be sure to verify that it has been shared from the
|
|
21
|
-
* correct Amazon Web Services account. To determine if an image has been shared and to see
|
|
22
|
-
* 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>
|
|
17
|
+
* correct Amazon Web Services account. To determine if an image has been shared and to see
|
|
18
|
+
* 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>
|
|
23
19
|
* </important>
|
|
24
20
|
* @example
|
|
25
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,7 +9,6 @@ export interface CreateConnectClientAddInCommandOutput extends CreateConnectClie
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Creates a client-add-in for Amazon Connect within a directory. You can create only
|
|
11
11
|
* one Amazon Connect client add-in within a directory.</p>
|
|
12
|
-
*
|
|
13
12
|
* <p>This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect.</p>
|
|
14
13
|
* @example
|
|
15
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,9 +7,9 @@ export interface CreateConnectionAliasCommandInput extends CreateConnectionAlias
|
|
|
7
7
|
export interface CreateConnectionAliasCommandOutput extends CreateConnectionAliasResult, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates the specified connection alias for use with cross-Region redirection. For more
|
|
11
|
-
* <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html">
|
|
12
|
-
*
|
|
10
|
+
* <p>Creates the specified connection alias for use with cross-Region redirection. For more
|
|
11
|
+
* information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html"> Cross-Region
|
|
12
|
+
* Redirection for Amazon WorkSpaces</a>.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -12,7 +12,6 @@ export interface CreateIpGroupCommandOutput extends CreateIpGroupResult, __Metad
|
|
|
12
12
|
* from which users are allowed to access their WorkSpaces. To specify the CIDR address
|
|
13
13
|
* ranges, add rules to your IP access control group and then associate the group with your
|
|
14
14
|
* directory. You can add rules when you create the group or at any time using <a>AuthorizeIpRules</a>.</p>
|
|
15
|
-
*
|
|
16
15
|
* <p>There is a default IP access control group associated with your directory. If you don't
|
|
17
16
|
* associate an IP access control group with your directory, the default group is used. The
|
|
18
17
|
* default group includes a default rule that allows users to access their WorkSpaces from
|
|
@@ -7,27 +7,25 @@ export interface CreateUpdatedWorkspaceImageCommandInput extends CreateUpdatedWo
|
|
|
7
7
|
export interface CreateUpdatedWorkspaceImageCommandOutput extends CreateUpdatedWorkspaceImageResult, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates a new updated WorkSpace image based on the specified source image. The
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
* WorkSpaces requirements, use
|
|
16
|
-
* <a href="https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImages.html">
|
|
10
|
+
* <p>Creates a new updated WorkSpace image based on the specified source image. The new
|
|
11
|
+
* updated WorkSpace image has the latest drivers and other updates required by the Amazon
|
|
12
|
+
* WorkSpaces components.</p>
|
|
13
|
+
* <p>To determine which WorkSpace images need to be updated with the latest Amazon WorkSpaces
|
|
14
|
+
* requirements, use <a href="https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImages.html">
|
|
17
15
|
* DescribeWorkspaceImages</a>.</p>
|
|
18
|
-
*
|
|
19
16
|
* <note>
|
|
20
17
|
* <ul>
|
|
21
18
|
* <li>
|
|
22
|
-
* <p>Only Windows 10, Windows Sever 2016, and Windows Server 2019 WorkSpace images
|
|
19
|
+
* <p>Only Windows 10, Windows Sever 2016, and Windows Server 2019 WorkSpace images
|
|
20
|
+
* can be programmatically updated at this time.</p>
|
|
23
21
|
* </li>
|
|
24
22
|
* <li>
|
|
25
|
-
* <p>Microsoft Windows updates and other application updates are not included
|
|
26
|
-
*
|
|
23
|
+
* <p>Microsoft Windows updates and other application updates are not included in the
|
|
24
|
+
* update process.</p>
|
|
27
25
|
* </li>
|
|
28
26
|
* <li>
|
|
29
|
-
* <p>The source WorkSpace image is not deleted. You can delete the source image
|
|
30
|
-
* verified your new updated image and created a new bundle. </p>
|
|
27
|
+
* <p>The source WorkSpace image is not deleted. You can delete the source image
|
|
28
|
+
* after you've verified your new updated image and created a new bundle. </p>
|
|
31
29
|
* </li>
|
|
32
30
|
* </ul>
|
|
33
31
|
* </note>
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { DeleteClientBrandingRequest, DeleteClientBrandingResult } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, WorkSpacesClientResolvedConfig } from "../WorkSpacesClient";
|
|
5
|
+
export interface DeleteClientBrandingCommandInput extends DeleteClientBrandingRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface DeleteClientBrandingCommandOutput extends DeleteClientBrandingResult, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Deletes customized client branding. Client branding allows you to customize your
|
|
11
|
+
* WorkSpace's client login portal. You can tailor your login portal company logo, the support
|
|
12
|
+
* email address, support link, link to reset password, and a custom message for users trying
|
|
13
|
+
* to sign in.</p>
|
|
14
|
+
* <p>After you delete your customized client branding, your login portal reverts to the
|
|
15
|
+
* default client branding.</p>
|
|
16
|
+
* @example
|
|
17
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
18
|
+
* ```javascript
|
|
19
|
+
* import { WorkSpacesClient, DeleteClientBrandingCommand } from "@aws-sdk/client-workspaces"; // ES Modules import
|
|
20
|
+
* // const { WorkSpacesClient, DeleteClientBrandingCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import
|
|
21
|
+
* const client = new WorkSpacesClient(config);
|
|
22
|
+
* const command = new DeleteClientBrandingCommand(input);
|
|
23
|
+
* const response = await client.send(command);
|
|
24
|
+
* ```
|
|
25
|
+
*
|
|
26
|
+
* @see {@link DeleteClientBrandingCommandInput} for command's `input` shape.
|
|
27
|
+
* @see {@link DeleteClientBrandingCommandOutput} for command's `response` shape.
|
|
28
|
+
* @see {@link WorkSpacesClientResolvedConfig | config} for WorkSpacesClient's `config` shape.
|
|
29
|
+
*
|
|
30
|
+
*/
|
|
31
|
+
export declare class DeleteClientBrandingCommand extends $Command<DeleteClientBrandingCommandInput, DeleteClientBrandingCommandOutput, WorkSpacesClientResolvedConfig> {
|
|
32
|
+
readonly input: DeleteClientBrandingCommandInput;
|
|
33
|
+
constructor(input: DeleteClientBrandingCommandInput);
|
|
34
|
+
/**
|
|
35
|
+
* @internal
|
|
36
|
+
*/
|
|
37
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkSpacesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteClientBrandingCommandInput, DeleteClientBrandingCommandOutput>;
|
|
38
|
+
private serialize;
|
|
39
|
+
private deserialize;
|
|
40
|
+
}
|
|
@@ -8,21 +8,19 @@ export interface DeleteConnectionAliasCommandOutput extends DeleteConnectionAlia
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Deletes the specified connection alias. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html">
|
|
11
|
-
*
|
|
12
|
-
*
|
|
11
|
+
* Cross-Region Redirection for Amazon WorkSpaces</a>.</p>
|
|
13
12
|
* <important>
|
|
14
13
|
* <p>
|
|
15
|
-
* <b>If you will no longer be using a fully qualified domain name
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
* <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html#cross-region-redirection-security-considerations">
|
|
19
|
-
* Security Considerations if You Stop Using Cross-Region Redirection</a>.</p>
|
|
14
|
+
* <b>If you will no longer be using a fully qualified domain name
|
|
15
|
+
* (FQDN) as the registration code for your WorkSpaces users, you must take certain
|
|
16
|
+
* precautions to prevent potential security issues.</b> For more information,
|
|
17
|
+
* 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>
|
|
20
18
|
* </important>
|
|
21
|
-
*
|
|
22
19
|
* <note>
|
|
23
|
-
* <p>To delete a connection alias that has been shared, the shared account must first
|
|
24
|
-
* from any directories it has been associated with. Then
|
|
25
|
-
*
|
|
20
|
+
* <p>To delete a connection alias that has been shared, the shared account must first
|
|
21
|
+
* disassociate the connection alias from any directories it has been associated with. Then
|
|
22
|
+
* you must unshare the connection alias from the account it has been shared with. You can
|
|
23
|
+
* delete a connection alias only after it is no longer shared with any accounts or
|
|
26
24
|
* associated with any directories.</p>
|
|
27
25
|
* </note>
|
|
28
26
|
* @example
|
|
@@ -7,22 +7,19 @@ export interface DeregisterWorkspaceDirectoryCommandInput extends DeregisterWork
|
|
|
7
7
|
export interface DeregisterWorkspaceDirectoryCommandOutput extends DeregisterWorkspaceDirectoryResult, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deregisters the specified directory. This operation is asynchronous
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
10
|
+
* <p>Deregisters the specified directory. This operation is asynchronous and returns before
|
|
11
|
+
* the WorkSpace directory is deregistered. If any WorkSpaces are registered to this
|
|
12
|
+
* directory, you must remove them before you can deregister the directory.</p>
|
|
14
13
|
* <note>
|
|
15
|
-
* <p>Simple AD and AD Connector are made available to you free of charge to use with
|
|
16
|
-
* If there are no WorkSpaces being used with your Simple AD or AD Connector
|
|
17
|
-
* consecutive days, this directory will be automatically deregistered for
|
|
18
|
-
* and you will be charged for this directory as per the
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
* Simple AD or AD Connector directory, you can always create a new one when you want to start using
|
|
25
|
-
* WorkSpaces again.</p>
|
|
14
|
+
* <p>Simple AD and AD Connector are made available to you free of charge to use with
|
|
15
|
+
* WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector
|
|
16
|
+
* directory for 30 consecutive days, this directory will be automatically deregistered for
|
|
17
|
+
* 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
|
|
18
|
+
* terms</a>.</p>
|
|
19
|
+
* <p>To delete empty directories, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces-directory.html"> Delete the
|
|
20
|
+
* Directory for Your WorkSpaces</a>. If you delete your Simple AD or AD Connector
|
|
21
|
+
* directory, you can always create a new one when you want to start using WorkSpaces
|
|
22
|
+
* again.</p>
|
|
26
23
|
* </note>
|
|
27
24
|
* @example
|
|
28
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { DescribeClientBrandingRequest, DescribeClientBrandingResult } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, WorkSpacesClientResolvedConfig } from "../WorkSpacesClient";
|
|
5
|
+
export interface DescribeClientBrandingCommandInput extends DescribeClientBrandingRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface DescribeClientBrandingCommandOutput extends DescribeClientBrandingResult, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Describes the specified client branding. Client branding allows you to customize the log
|
|
11
|
+
* in page of various device types for your users. You can add your company logo, the support
|
|
12
|
+
* email address, support link, link to reset password, and a custom message for users trying
|
|
13
|
+
* to sign in.</p>
|
|
14
|
+
* <note>
|
|
15
|
+
* <p>Only device types that have branding information configured will be shown in the
|
|
16
|
+
* response.</p>
|
|
17
|
+
* </note>
|
|
18
|
+
* @example
|
|
19
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
20
|
+
* ```javascript
|
|
21
|
+
* import { WorkSpacesClient, DescribeClientBrandingCommand } from "@aws-sdk/client-workspaces"; // ES Modules import
|
|
22
|
+
* // const { WorkSpacesClient, DescribeClientBrandingCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import
|
|
23
|
+
* const client = new WorkSpacesClient(config);
|
|
24
|
+
* const command = new DescribeClientBrandingCommand(input);
|
|
25
|
+
* const response = await client.send(command);
|
|
26
|
+
* ```
|
|
27
|
+
*
|
|
28
|
+
* @see {@link DescribeClientBrandingCommandInput} for command's `input` shape.
|
|
29
|
+
* @see {@link DescribeClientBrandingCommandOutput} for command's `response` shape.
|
|
30
|
+
* @see {@link WorkSpacesClientResolvedConfig | config} for WorkSpacesClient's `config` shape.
|
|
31
|
+
*
|
|
32
|
+
*/
|
|
33
|
+
export declare class DescribeClientBrandingCommand extends $Command<DescribeClientBrandingCommandInput, DescribeClientBrandingCommandOutput, WorkSpacesClientResolvedConfig> {
|
|
34
|
+
readonly input: DescribeClientBrandingCommandInput;
|
|
35
|
+
constructor(input: DescribeClientBrandingCommandInput);
|
|
36
|
+
/**
|
|
37
|
+
* @internal
|
|
38
|
+
*/
|
|
39
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkSpacesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeClientBrandingCommandInput, DescribeClientBrandingCommandOutput>;
|
|
40
|
+
private serialize;
|
|
41
|
+
private deserialize;
|
|
42
|
+
}
|
|
@@ -7,9 +7,10 @@ export interface DescribeConnectionAliasPermissionsCommandInput extends Describe
|
|
|
7
7
|
export interface DescribeConnectionAliasPermissionsCommandOutput extends DescribeConnectionAliasPermissionsResult, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Describes the permissions that the owner of a connection alias has granted to another
|
|
11
|
-
*
|
|
12
|
-
* Cross-Region
|
|
10
|
+
* <p>Describes the permissions that the owner of a connection alias has granted to another
|
|
11
|
+
* Amazon Web Services account for the specified connection alias. For more information, see
|
|
12
|
+
* <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html"> Cross-Region
|
|
13
|
+
* Redirection for Amazon WorkSpaces</a>.</p>
|
|
13
14
|
* @example
|
|
14
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
16
|
* ```javascript
|
|
@@ -7,9 +7,9 @@ export interface DescribeConnectionAliasesCommandInput extends DescribeConnectio
|
|
|
7
7
|
export interface DescribeConnectionAliasesCommandOutput extends DescribeConnectionAliasesResult, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Retrieves a list that describes the connection aliases used for cross-Region
|
|
11
|
-
* <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html">
|
|
12
|
-
*
|
|
10
|
+
* <p>Retrieves a list that describes the connection aliases used for cross-Region
|
|
11
|
+
* redirection. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html"> Cross-Region
|
|
12
|
+
* Redirection for Amazon WorkSpaces</a>.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -7,8 +7,7 @@ export interface DescribeWorkspaceDirectoriesCommandInput extends DescribeWorksp
|
|
|
7
7
|
export interface DescribeWorkspaceDirectoriesCommandOutput extends DescribeWorkspaceDirectoriesResult, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Describes the available directories that are registered with
|
|
11
|
-
* Amazon WorkSpaces.</p>
|
|
10
|
+
* <p>Describes the available directories that are registered with Amazon WorkSpaces.</p>
|
|
12
11
|
* @example
|
|
13
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
13
|
* ```javascript
|
|
@@ -7,8 +7,7 @@ export interface DescribeWorkspaceImagePermissionsCommandInput extends DescribeW
|
|
|
7
7
|
export interface DescribeWorkspaceImagePermissionsCommandOutput extends DescribeWorkspaceImagePermissionsResult, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Describes the permissions that the owner of an image has granted to other
|
|
11
|
-
* Amazon Web Services accounts for an image.</p>
|
|
10
|
+
* <p>Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.</p>
|
|
12
11
|
* @example
|
|
13
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
13
|
* ```javascript
|
|
@@ -7,14 +7,14 @@ export interface DisassociateConnectionAliasCommandInput extends DisassociateCon
|
|
|
7
7
|
export interface DisassociateConnectionAliasCommandOutput extends DisassociateConnectionAliasResult, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Disassociates a connection alias from a directory. Disassociating a connection alias
|
|
11
|
-
* redirection between two directories in different Regions. For more
|
|
12
|
-
* <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html">
|
|
13
|
-
*
|
|
14
|
-
*
|
|
10
|
+
* <p>Disassociates a connection alias from a directory. Disassociating a connection alias
|
|
11
|
+
* disables cross-Region redirection between two directories in different Regions. For more
|
|
12
|
+
* information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html"> Cross-Region
|
|
13
|
+
* Redirection for Amazon WorkSpaces</a>.</p>
|
|
15
14
|
* <note>
|
|
16
15
|
* <p>Before performing this operation, call <a href="https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html">
|
|
17
|
-
*
|
|
16
|
+
* DescribeConnectionAliases</a> to make sure that the current state of the
|
|
17
|
+
* connection alias is <code>CREATED</code>.</p>
|
|
18
18
|
* </note>
|
|
19
19
|
* @example
|
|
20
20
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { ImportClientBrandingRequest, ImportClientBrandingResult } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, WorkSpacesClientResolvedConfig } from "../WorkSpacesClient";
|
|
5
|
+
export interface ImportClientBrandingCommandInput extends ImportClientBrandingRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface ImportClientBrandingCommandOutput extends ImportClientBrandingResult, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Imports client branding. Client branding allows you to customize your WorkSpace's client
|
|
11
|
+
* login portal. You can tailor your login portal company logo, the support email address,
|
|
12
|
+
* support link, link to reset password, and a custom message for users trying to sign
|
|
13
|
+
* in.</p>
|
|
14
|
+
* <p>After you import client branding, the default branding experience for the specified
|
|
15
|
+
* platform type is replaced with the imported experience</p>
|
|
16
|
+
* <note>
|
|
17
|
+
* <ul>
|
|
18
|
+
* <li>
|
|
19
|
+
* <p>You must specify at least one platform type when importing client
|
|
20
|
+
* branding.</p>
|
|
21
|
+
* </li>
|
|
22
|
+
* <li>
|
|
23
|
+
* <p>You can import up to 6 MB of data with each request. If your request exceeds
|
|
24
|
+
* this limit, you can import client branding for different platform types using
|
|
25
|
+
* separate requests.</p>
|
|
26
|
+
* </li>
|
|
27
|
+
* <li>
|
|
28
|
+
* <p>In each platform type, the <code>SupportEmail</code> and
|
|
29
|
+
* <code>SupportLink</code> parameters are mutually exclusive. You can specify
|
|
30
|
+
* only one parameter for each platform type, but not both.</p>
|
|
31
|
+
* </li>
|
|
32
|
+
* <li>
|
|
33
|
+
* <p>Imported data can take up to a minute to appear in the WorkSpaces
|
|
34
|
+
* client.</p>
|
|
35
|
+
* </li>
|
|
36
|
+
* </ul>
|
|
37
|
+
* </note>
|
|
38
|
+
* @example
|
|
39
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
40
|
+
* ```javascript
|
|
41
|
+
* import { WorkSpacesClient, ImportClientBrandingCommand } from "@aws-sdk/client-workspaces"; // ES Modules import
|
|
42
|
+
* // const { WorkSpacesClient, ImportClientBrandingCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import
|
|
43
|
+
* const client = new WorkSpacesClient(config);
|
|
44
|
+
* const command = new ImportClientBrandingCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* ```
|
|
47
|
+
*
|
|
48
|
+
* @see {@link ImportClientBrandingCommandInput} for command's `input` shape.
|
|
49
|
+
* @see {@link ImportClientBrandingCommandOutput} for command's `response` shape.
|
|
50
|
+
* @see {@link WorkSpacesClientResolvedConfig | config} for WorkSpacesClient's `config` shape.
|
|
51
|
+
*
|
|
52
|
+
*/
|
|
53
|
+
export declare class ImportClientBrandingCommand extends $Command<ImportClientBrandingCommandInput, ImportClientBrandingCommandOutput, WorkSpacesClientResolvedConfig> {
|
|
54
|
+
readonly input: ImportClientBrandingCommandInput;
|
|
55
|
+
constructor(input: ImportClientBrandingCommandInput);
|
|
56
|
+
/**
|
|
57
|
+
* @internal
|
|
58
|
+
*/
|
|
59
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkSpacesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ImportClientBrandingCommandInput, ImportClientBrandingCommandOutput>;
|
|
60
|
+
private serialize;
|
|
61
|
+
private deserialize;
|
|
62
|
+
}
|
|
@@ -8,10 +8,9 @@ export interface ImportWorkspaceImageCommandOutput extends ImportWorkspaceImageR
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Imports the specified Windows 10 Bring Your Own License (BYOL) image into Amazon
|
|
11
|
-
* WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
* Bring Your Own Windows Desktop Licenses</a>.</p>
|
|
11
|
+
* 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
|
|
12
|
+
* images, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html"> Bring Your Own Windows
|
|
13
|
+
* Desktop Licenses</a>.</p>
|
|
15
14
|
* @example
|
|
16
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
16
|
* ```javascript
|
|
@@ -9,10 +9,9 @@ export interface ListAvailableManagementCidrRangesCommandOutput extends ListAvai
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use
|
|
11
11
|
* for the network management interface when you enable Bring Your Own License (BYOL). </p>
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
12
|
+
* <p>This operation can be run only by Amazon Web Services accounts that are enabled for BYOL.
|
|
13
|
+
* If your account isn't enabled for BYOL, you'll receive an
|
|
14
|
+
* <code>AccessDeniedException</code> error.</p>
|
|
16
15
|
* <p>The management network interface is connected to a secure Amazon WorkSpaces management
|
|
17
16
|
* network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces
|
|
18
17
|
* clients, and to allow Amazon WorkSpaces to manage the WorkSpace.</p>
|
|
@@ -7,15 +7,17 @@ export interface MigrateWorkspaceCommandInput extends MigrateWorkspaceRequest {
|
|
|
7
7
|
export interface MigrateWorkspaceCommandOutput extends MigrateWorkspaceResult, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Migrates a WorkSpace from one operating system or bundle type to another, while
|
|
11
|
-
*
|
|
12
|
-
* <p>The migration process recreates the WorkSpace by using a new root volume from the target
|
|
13
|
-
* from the last available snapshot of the original
|
|
14
|
-
*
|
|
15
|
-
* folder is
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
* <
|
|
10
|
+
* <p>Migrates a WorkSpace from one operating system or bundle type to another, while
|
|
11
|
+
* retaining the data on the user volume.</p>
|
|
12
|
+
* <p>The migration process recreates the WorkSpace by using a new root volume from the target
|
|
13
|
+
* bundle image and the user volume from the last available snapshot of the original
|
|
14
|
+
* WorkSpace. During migration, the original <code>D:\Users\%USERNAME%</code> user profile
|
|
15
|
+
* folder is renamed to <code>D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated</code>. A new
|
|
16
|
+
* <code>D:\Users\%USERNAME%\</code> folder is generated by the new OS. Certain files in
|
|
17
|
+
* the old user profile are moved to the new user profile.</p>
|
|
18
|
+
* <p>For available migration scenarios, details about what happens during migration, and best
|
|
19
|
+
* practices, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/migrate-workspaces.html">Migrate a
|
|
20
|
+
* WorkSpace</a>.</p>
|
|
19
21
|
* @example
|
|
20
22
|
* Use a bare-bones client and the command you need to make an API call.
|
|
21
23
|
* ```javascript
|
|
@@ -7,10 +7,8 @@ export interface ModifyWorkspacePropertiesCommandInput extends ModifyWorkspacePr
|
|
|
7
7
|
export interface ModifyWorkspacePropertiesCommandOutput extends ModifyWorkspacePropertiesResult, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Modifies the specified WorkSpace properties. For important information about how
|
|
11
|
-
*
|
|
12
|
-
* <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html">
|
|
13
|
-
* Modify a WorkSpace</a>.
|
|
10
|
+
* <p>Modifies the specified WorkSpace properties. For important information about how to
|
|
11
|
+
* 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>.
|
|
14
12
|
* </p>
|
|
15
13
|
* @example
|
|
16
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,7 +9,8 @@ export interface RebuildWorkspacesCommandOutput extends RebuildWorkspacesResult,
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Rebuilds the specified WorkSpace.</p>
|
|
11
11
|
* <p>You cannot rebuild a WorkSpace unless its state is <code>AVAILABLE</code>,
|
|
12
|
-
* <code>ERROR</code>, <code>UNHEALTHY</code>, <code>STOPPED</code>, or
|
|
12
|
+
* <code>ERROR</code>, <code>UNHEALTHY</code>, <code>STOPPED</code>, or
|
|
13
|
+
* <code>REBOOTING</code>.</p>
|
|
13
14
|
* <p>Rebuilding a WorkSpace is a potentially destructive action that can result in the loss
|
|
14
15
|
* of data. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/reset-workspace.html">Rebuild a
|
|
15
16
|
* WorkSpace</a>.</p>
|
|
@@ -7,10 +7,10 @@ export interface RegisterWorkspaceDirectoryCommandInput extends RegisterWorkspac
|
|
|
7
7
|
export interface RegisterWorkspaceDirectoryCommandOutput extends RegisterWorkspaceDirectoryResult, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Registers the specified directory. This operation is asynchronous
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
10
|
+
* <p>Registers the specified directory. This operation is asynchronous and returns before the
|
|
11
|
+
* WorkSpace directory is registered. If this is the first time you are registering a
|
|
12
|
+
* directory, you will need to create the workspaces_DefaultRole role before you can register
|
|
13
|
+
* a directory. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-access-control.html#create-default-role">
|
|
14
14
|
* Creating the workspaces_DefaultRole Role</a>.</p>
|
|
15
15
|
* @example
|
|
16
16
|
* Use a bare-bones client and the command you need to make an API call.
|