@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
|
@@ -84,8 +84,8 @@ export declare namespace AssociateConnectionAliasRequest {
|
|
|
84
84
|
}
|
|
85
85
|
export interface AssociateConnectionAliasResult {
|
|
86
86
|
/**
|
|
87
|
-
* <p>The identifier of the connection alias association. You use the connection identifier in
|
|
88
|
-
* you're configuring your DNS routing policies. </p>
|
|
87
|
+
* <p>The identifier of the connection alias association. You use the connection identifier in
|
|
88
|
+
* the DNS TXT record when you're configuring your DNS routing policies. </p>
|
|
89
89
|
*/
|
|
90
90
|
ConnectionIdentifier?: string;
|
|
91
91
|
}
|
|
@@ -242,6 +242,8 @@ export declare namespace AuthorizeIpRulesResult {
|
|
|
242
242
|
export declare enum Compute {
|
|
243
243
|
GRAPHICS = "GRAPHICS",
|
|
244
244
|
GRAPHICSPRO = "GRAPHICSPRO",
|
|
245
|
+
GRAPHICSPRO_G4DN = "GRAPHICSPRO_G4DN",
|
|
246
|
+
GRAPHICS_G4DN = "GRAPHICS_G4DN",
|
|
245
247
|
PERFORMANCE = "PERFORMANCE",
|
|
246
248
|
POWER = "POWER",
|
|
247
249
|
POWERPRO = "POWERPRO",
|
|
@@ -346,6 +348,14 @@ export declare namespace WorkspaceBundle {
|
|
|
346
348
|
*/
|
|
347
349
|
const filterSensitiveLog: (obj: WorkspaceBundle) => any;
|
|
348
350
|
}
|
|
351
|
+
export declare enum ClientDeviceType {
|
|
352
|
+
DEVICE_TYPE_ANDROID = "DeviceTypeAndroid",
|
|
353
|
+
DEVICE_TYPE_IOS = "DeviceTypeIos",
|
|
354
|
+
DEVICE_TYPE_LINUX = "DeviceTypeLinux",
|
|
355
|
+
DEVICE_TYPE_OSX = "DeviceTypeOsx",
|
|
356
|
+
DEVICE_TYPE_WEB = "DeviceTypeWeb",
|
|
357
|
+
DEVICE_TYPE_WINDOWS = "DeviceTypeWindows"
|
|
358
|
+
}
|
|
349
359
|
export declare enum ReconnectEnum {
|
|
350
360
|
DISABLED = "DISABLED",
|
|
351
361
|
ENABLED = "ENABLED"
|
|
@@ -414,9 +424,9 @@ export declare namespace ConnectClientAddIn {
|
|
|
414
424
|
const filterSensitiveLog: (obj: ConnectClientAddIn) => any;
|
|
415
425
|
}
|
|
416
426
|
/**
|
|
417
|
-
* <p>Describes a connection alias association that is used for cross-Region redirection. For
|
|
418
|
-
* <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html">
|
|
419
|
-
*
|
|
427
|
+
* <p>Describes a connection alias association that is used for cross-Region redirection. For
|
|
428
|
+
* more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html"> Cross-Region
|
|
429
|
+
* Redirection for Amazon WorkSpaces</a>.</p>
|
|
420
430
|
*/
|
|
421
431
|
export interface ConnectionAliasAssociation {
|
|
422
432
|
/**
|
|
@@ -424,7 +434,8 @@ export interface ConnectionAliasAssociation {
|
|
|
424
434
|
*/
|
|
425
435
|
AssociationStatus?: AssociationStatus | string;
|
|
426
436
|
/**
|
|
427
|
-
* <p>The identifier of the Amazon Web Services account that associated the connection alias
|
|
437
|
+
* <p>The identifier of the Amazon Web Services account that associated the connection alias
|
|
438
|
+
* with a directory.</p>
|
|
428
439
|
*/
|
|
429
440
|
AssociatedAccountId?: string;
|
|
430
441
|
/**
|
|
@@ -432,8 +443,8 @@ export interface ConnectionAliasAssociation {
|
|
|
432
443
|
*/
|
|
433
444
|
ResourceId?: string;
|
|
434
445
|
/**
|
|
435
|
-
* <p>The identifier of the connection alias association. You use the connection identifier in
|
|
436
|
-
* you're configuring your DNS routing policies.</p>
|
|
446
|
+
* <p>The identifier of the connection alias association. You use the connection identifier in
|
|
447
|
+
* the DNS TXT record when you're configuring your DNS routing policies.</p>
|
|
437
448
|
*/
|
|
438
449
|
ConnectionIdentifier?: string;
|
|
439
450
|
}
|
|
@@ -449,14 +460,15 @@ export declare enum ConnectionAliasState {
|
|
|
449
460
|
DELETING = "DELETING"
|
|
450
461
|
}
|
|
451
462
|
/**
|
|
452
|
-
* <p>Describes a connection alias. Connection aliases are used for cross-Region redirection.
|
|
453
|
-
* see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html">
|
|
454
|
-
*
|
|
463
|
+
* <p>Describes a connection alias. Connection aliases are used for cross-Region redirection.
|
|
464
|
+
* For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html"> Cross-Region
|
|
465
|
+
* Redirection for Amazon WorkSpaces</a>.</p>
|
|
455
466
|
*/
|
|
456
467
|
export interface ConnectionAlias {
|
|
457
468
|
/**
|
|
458
|
-
* <p>The connection string specified for the connection alias. The connection string must be
|
|
459
|
-
* a fully qualified domain name (FQDN), such as
|
|
469
|
+
* <p>The connection string specified for the connection alias. The connection string must be
|
|
470
|
+
* in the form of a fully qualified domain name (FQDN), such as
|
|
471
|
+
* <code>www.example.com</code>.</p>
|
|
460
472
|
*/
|
|
461
473
|
ConnectionString?: string;
|
|
462
474
|
/**
|
|
@@ -483,17 +495,19 @@ export declare namespace ConnectionAlias {
|
|
|
483
495
|
const filterSensitiveLog: (obj: ConnectionAlias) => any;
|
|
484
496
|
}
|
|
485
497
|
/**
|
|
486
|
-
* <p>Describes the permissions for a connection alias. Connection aliases are used for
|
|
487
|
-
* For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html">
|
|
488
|
-
*
|
|
498
|
+
* <p>Describes the permissions for a connection alias. Connection aliases are used for
|
|
499
|
+
* cross-Region redirection. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html"> Cross-Region
|
|
500
|
+
* Redirection for Amazon WorkSpaces</a>.</p>
|
|
489
501
|
*/
|
|
490
502
|
export interface ConnectionAliasPermission {
|
|
491
503
|
/**
|
|
492
|
-
* <p>The identifier of the Amazon Web Services account that the connection alias is shared
|
|
504
|
+
* <p>The identifier of the Amazon Web Services account that the connection alias is shared
|
|
505
|
+
* with.</p>
|
|
493
506
|
*/
|
|
494
507
|
SharedAccountId: string | undefined;
|
|
495
508
|
/**
|
|
496
|
-
* <p>Indicates whether the specified Amazon Web Services account is allowed to associate the
|
|
509
|
+
* <p>Indicates whether the specified Amazon Web Services account is allowed to associate the
|
|
510
|
+
* connection alias with a directory.</p>
|
|
497
511
|
*/
|
|
498
512
|
AllowAssociation: boolean | undefined;
|
|
499
513
|
}
|
|
@@ -638,12 +652,12 @@ export declare class ResourceCreationFailedException extends __BaseException {
|
|
|
638
652
|
}
|
|
639
653
|
export interface CreateConnectionAliasRequest {
|
|
640
654
|
/**
|
|
641
|
-
* <p>A connection string in the form of a fully qualified domain name (FQDN), such as
|
|
642
|
-
*
|
|
655
|
+
* <p>A connection string in the form of a fully qualified domain name (FQDN), such as
|
|
656
|
+
* <code>www.example.com</code>.</p>
|
|
643
657
|
* <important>
|
|
644
|
-
* <p>After you create a connection string, it is always associated to your Amazon Web Services account. You cannot recreate the same
|
|
645
|
-
*
|
|
646
|
-
*
|
|
658
|
+
* <p>After you create a connection string, it is always associated to your Amazon Web Services account. You cannot recreate the same connection string with a different
|
|
659
|
+
* account, even if you delete all instances of it from the original account. The
|
|
660
|
+
* connection string is globally reserved for your account.</p>
|
|
647
661
|
* </important>
|
|
648
662
|
*/
|
|
649
663
|
ConnectionString: string | undefined;
|
|
@@ -709,7 +723,8 @@ export declare namespace CreateIpGroupResult {
|
|
|
709
723
|
export interface CreateTagsRequest {
|
|
710
724
|
/**
|
|
711
725
|
* <p>The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces,
|
|
712
|
-
* registered directories, images, custom bundles, IP access control groups, and connection
|
|
726
|
+
* registered directories, images, custom bundles, IP access control groups, and connection
|
|
727
|
+
* aliases.</p>
|
|
713
728
|
*/
|
|
714
729
|
ResourceId: string | undefined;
|
|
715
730
|
/**
|
|
@@ -746,10 +761,10 @@ export interface CreateUpdatedWorkspaceImageRequest {
|
|
|
746
761
|
SourceImageId: string | undefined;
|
|
747
762
|
/**
|
|
748
763
|
* <p>The tags that you want to add to the new updated WorkSpace image.</p>
|
|
749
|
-
*
|
|
750
764
|
* <note>
|
|
751
765
|
* <p>To add tags at the same time when you're creating the updated image, you must create
|
|
752
|
-
* an IAM policy that grants your IAM user permissions to use
|
|
766
|
+
* an IAM policy that grants your IAM user permissions to use
|
|
767
|
+
* <code>workspaces:CreateTags</code>. </p>
|
|
753
768
|
* </note>
|
|
754
769
|
*/
|
|
755
770
|
Tags?: Tag[];
|
|
@@ -839,17 +854,20 @@ export interface WorkspaceProperties {
|
|
|
839
854
|
*/
|
|
840
855
|
RunningMode?: RunningMode | string;
|
|
841
856
|
/**
|
|
842
|
-
* <p>The time after a user logs off when WorkSpaces are automatically stopped. Configured in
|
|
857
|
+
* <p>The time after a user logs off when WorkSpaces are automatically stopped. Configured in
|
|
858
|
+
* 60-minute intervals.</p>
|
|
843
859
|
*/
|
|
844
860
|
RunningModeAutoStopTimeoutInMinutes?: number;
|
|
845
861
|
/**
|
|
846
|
-
* <p>The size of the root volume. For important information about how to modify the size of
|
|
847
|
-
* <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html">Modify a
|
|
862
|
+
* <p>The size of the root volume. For important information about how to modify the size of
|
|
863
|
+
* the root and user volumes, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html">Modify a
|
|
864
|
+
* WorkSpace</a>.</p>
|
|
848
865
|
*/
|
|
849
866
|
RootVolumeSizeGib?: number;
|
|
850
867
|
/**
|
|
851
|
-
* <p>The size of the user storage. For important information about how to modify the size of
|
|
852
|
-
* <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html">Modify a
|
|
868
|
+
* <p>The size of the user storage. For important information about how to modify the size of
|
|
869
|
+
* the root and user volumes, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html">Modify a
|
|
870
|
+
* WorkSpace</a>.</p>
|
|
853
871
|
*/
|
|
854
872
|
UserVolumeSizeGib?: number;
|
|
855
873
|
/**
|
|
@@ -869,13 +887,11 @@ export declare namespace WorkspaceProperties {
|
|
|
869
887
|
*/
|
|
870
888
|
export interface WorkspaceRequest {
|
|
871
889
|
/**
|
|
872
|
-
* <p>The identifier of the Directory Service directory for the WorkSpace. You can use
|
|
873
|
-
* <a>DescribeWorkspaceDirectories</a> to list the available directories.</p>
|
|
890
|
+
* <p>The identifier of the Directory Service directory for the WorkSpace. You can use <a>DescribeWorkspaceDirectories</a> to list the available directories.</p>
|
|
874
891
|
*/
|
|
875
892
|
DirectoryId: string | undefined;
|
|
876
893
|
/**
|
|
877
|
-
* <p>The user name of the user for the WorkSpace. This user name must exist in the Directory Service
|
|
878
|
-
* directory for the WorkSpace.</p>
|
|
894
|
+
* <p>The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.</p>
|
|
879
895
|
*/
|
|
880
896
|
UserName: string | undefined;
|
|
881
897
|
/**
|
|
@@ -1015,14 +1031,13 @@ export interface Workspace {
|
|
|
1015
1031
|
IpAddress?: string;
|
|
1016
1032
|
/**
|
|
1017
1033
|
* <p>The operational state of the WorkSpace.</p>
|
|
1018
|
-
*
|
|
1019
1034
|
* <note>
|
|
1020
|
-
* <p>After a WorkSpace is terminated, the <code>TERMINATED</code> state is returned
|
|
1021
|
-
*
|
|
1035
|
+
* <p>After a WorkSpace is terminated, the <code>TERMINATED</code> state is returned only
|
|
1036
|
+
* briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely
|
|
1022
1037
|
* returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using
|
|
1023
|
-
*
|
|
1024
|
-
* DescribeWorkSpaces</a>. If the WorkSpace ID isn't returned, then the WorkSpace
|
|
1025
|
-
* been successfully terminated.</p>
|
|
1038
|
+
* <a href="https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html">
|
|
1039
|
+
* DescribeWorkSpaces</a>. If the WorkSpace ID isn't returned, then the WorkSpace
|
|
1040
|
+
* has been successfully terminated.</p>
|
|
1026
1041
|
* </note>
|
|
1027
1042
|
*/
|
|
1028
1043
|
State?: WorkspaceState | string;
|
|
@@ -1044,9 +1059,9 @@ export interface Workspace {
|
|
|
1044
1059
|
*/
|
|
1045
1060
|
ErrorCode?: string;
|
|
1046
1061
|
/**
|
|
1047
|
-
* <p>The name of the WorkSpace, as seen by the operating system. The format of this name
|
|
1048
|
-
* For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/launch-workspaces-tutorials.html">
|
|
1049
|
-
*
|
|
1062
|
+
* <p>The name of the WorkSpace, as seen by the operating system. The format of this name
|
|
1063
|
+
* varies. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/launch-workspaces-tutorials.html"> Launch a
|
|
1064
|
+
* WorkSpace</a>. </p>
|
|
1050
1065
|
*/
|
|
1051
1066
|
ComputerName?: string;
|
|
1052
1067
|
/**
|
|
@@ -1100,7 +1115,143 @@ export declare enum DedicatedTenancySupportEnum {
|
|
|
1100
1115
|
ENABLED = "ENABLED"
|
|
1101
1116
|
}
|
|
1102
1117
|
/**
|
|
1103
|
-
* <p>
|
|
1118
|
+
* <p>Returns default client branding attributes that were imported. These attributes display
|
|
1119
|
+
* on the client login screen.</p>
|
|
1120
|
+
* <important>
|
|
1121
|
+
* <p>Client branding attributes are public facing. Ensure that you don't include sensitive
|
|
1122
|
+
* information.</p>
|
|
1123
|
+
* </important>
|
|
1124
|
+
*/
|
|
1125
|
+
export interface DefaultClientBrandingAttributes {
|
|
1126
|
+
/**
|
|
1127
|
+
* <p>The logo URL. This is the link where users can download the logo image. The only
|
|
1128
|
+
* supported image format is <code>.png</code>.</p>
|
|
1129
|
+
*/
|
|
1130
|
+
LogoUrl?: string;
|
|
1131
|
+
/**
|
|
1132
|
+
* <p>The support email. The company's customer support email address.</p>
|
|
1133
|
+
* <note>
|
|
1134
|
+
* <ul>
|
|
1135
|
+
* <li>
|
|
1136
|
+
* <p>In each platform type, the <code>SupportEmail</code> and
|
|
1137
|
+
* <code>SupportLink</code> parameters are mutually exclusive. You can specify one
|
|
1138
|
+
* parameter for each platform type, but not both.</p>
|
|
1139
|
+
* </li>
|
|
1140
|
+
* <li>
|
|
1141
|
+
* <p>The default email is <code>workspaces-feedback@amazon.com</code>.</p>
|
|
1142
|
+
* </li>
|
|
1143
|
+
* </ul>
|
|
1144
|
+
* </note>
|
|
1145
|
+
*/
|
|
1146
|
+
SupportEmail?: string;
|
|
1147
|
+
/**
|
|
1148
|
+
* <p>The support link. The link for the company's customer support page for their
|
|
1149
|
+
* WorkSpace.</p>
|
|
1150
|
+
* <note>
|
|
1151
|
+
* <ul>
|
|
1152
|
+
* <li>
|
|
1153
|
+
* <p>In each platform type, the <code>SupportEmail</code> and
|
|
1154
|
+
* <code>SupportLink</code> parameters are mutually exclusive.You can specify one
|
|
1155
|
+
* parameter for each platform type, but not both.</p>
|
|
1156
|
+
* </li>
|
|
1157
|
+
* <li>
|
|
1158
|
+
* <p>The default support link is <code>workspaces-feedback@amazon.com</code>.</p>
|
|
1159
|
+
* </li>
|
|
1160
|
+
* </ul>
|
|
1161
|
+
* </note>
|
|
1162
|
+
*/
|
|
1163
|
+
SupportLink?: string;
|
|
1164
|
+
/**
|
|
1165
|
+
* <p>The forgotten password link. This is the web address that users can go to if they forget
|
|
1166
|
+
* the password for their WorkSpace.</p>
|
|
1167
|
+
*/
|
|
1168
|
+
ForgotPasswordLink?: string;
|
|
1169
|
+
/**
|
|
1170
|
+
* <p>The login message. Specified as a key value pair, in which the key is a locale and the
|
|
1171
|
+
* value is the localized message for that locale. The only key supported is
|
|
1172
|
+
* <code>en_US</code>. </p>
|
|
1173
|
+
*/
|
|
1174
|
+
LoginMessage?: {
|
|
1175
|
+
[key: string]: string;
|
|
1176
|
+
};
|
|
1177
|
+
}
|
|
1178
|
+
export declare namespace DefaultClientBrandingAttributes {
|
|
1179
|
+
/**
|
|
1180
|
+
* @internal
|
|
1181
|
+
*/
|
|
1182
|
+
const filterSensitiveLog: (obj: DefaultClientBrandingAttributes) => any;
|
|
1183
|
+
}
|
|
1184
|
+
/**
|
|
1185
|
+
* <p>The default client branding attributes to be imported. These attributes display on the
|
|
1186
|
+
* client login screen.</p>
|
|
1187
|
+
* <important>
|
|
1188
|
+
* <p>Client branding attributes are public facing. Ensure that you do not include
|
|
1189
|
+
* sensitive information.</p>
|
|
1190
|
+
* </important>
|
|
1191
|
+
*/
|
|
1192
|
+
export interface DefaultImportClientBrandingAttributes {
|
|
1193
|
+
/**
|
|
1194
|
+
* <p>The logo. This is the link where users can download the logo image. The only image
|
|
1195
|
+
* format accepted is <code>.png</code>.</p>
|
|
1196
|
+
*/
|
|
1197
|
+
Logo?: Uint8Array;
|
|
1198
|
+
/**
|
|
1199
|
+
* <p>The support email. The company's customer support email address.</p>
|
|
1200
|
+
* <note>
|
|
1201
|
+
* <ul>
|
|
1202
|
+
* <li>
|
|
1203
|
+
* <p>In each platform type, the <code>SupportEmail</code> and
|
|
1204
|
+
* <code>SupportLink</code> parameters are mutually exclusive. You can specify one
|
|
1205
|
+
* parameter for each platform type, but not both.</p>
|
|
1206
|
+
* </li>
|
|
1207
|
+
* <li>
|
|
1208
|
+
* <p>The default email is <code>workspaces-feedback@amazon.com</code>.</p>
|
|
1209
|
+
* </li>
|
|
1210
|
+
* </ul>
|
|
1211
|
+
* </note>
|
|
1212
|
+
*/
|
|
1213
|
+
SupportEmail?: string;
|
|
1214
|
+
/**
|
|
1215
|
+
* <p>The support link. The link for the company's customer support page for their
|
|
1216
|
+
* WorkSpace.</p>
|
|
1217
|
+
* <note>
|
|
1218
|
+
* <ul>
|
|
1219
|
+
* <li>
|
|
1220
|
+
* <p>In each platform type, the <code>SupportEmail</code> and
|
|
1221
|
+
* <code>SupportLink</code> parameters are mutually exclusive. You can specify one
|
|
1222
|
+
* parameter for each platform type, but not both.</p>
|
|
1223
|
+
* </li>
|
|
1224
|
+
* <li>
|
|
1225
|
+
* <p>The default support link is <code>workspaces-feedback@amazon.com</code>.</p>
|
|
1226
|
+
* </li>
|
|
1227
|
+
* </ul>
|
|
1228
|
+
* </note>
|
|
1229
|
+
*/
|
|
1230
|
+
SupportLink?: string;
|
|
1231
|
+
/**
|
|
1232
|
+
* <p>The forgotten password link. This is the web address that users can go to if they forget
|
|
1233
|
+
* the password for their WorkSpace.</p>
|
|
1234
|
+
*/
|
|
1235
|
+
ForgotPasswordLink?: string;
|
|
1236
|
+
/**
|
|
1237
|
+
* <p>The login message. Specified as a key value pair, in which the key is a locale and the
|
|
1238
|
+
* value is the localized message for that locale. The only key supported is
|
|
1239
|
+
* <code>en_US</code>. </p>
|
|
1240
|
+
*/
|
|
1241
|
+
LoginMessage?: {
|
|
1242
|
+
[key: string]: string;
|
|
1243
|
+
};
|
|
1244
|
+
}
|
|
1245
|
+
export declare namespace DefaultImportClientBrandingAttributes {
|
|
1246
|
+
/**
|
|
1247
|
+
* @internal
|
|
1248
|
+
*/
|
|
1249
|
+
const filterSensitiveLog: (obj: DefaultImportClientBrandingAttributes) => any;
|
|
1250
|
+
}
|
|
1251
|
+
/**
|
|
1252
|
+
* <p>Describes the default values that are used to create WorkSpaces. For more information,
|
|
1253
|
+
* see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html">Update Directory
|
|
1254
|
+
* Details for Your WorkSpaces</a>.</p>
|
|
1104
1255
|
*/
|
|
1105
1256
|
export interface DefaultWorkspaceCreationProperties {
|
|
1106
1257
|
/**
|
|
@@ -1108,14 +1259,15 @@ export interface DefaultWorkspaceCreationProperties {
|
|
|
1108
1259
|
*/
|
|
1109
1260
|
EnableWorkDocs?: boolean;
|
|
1110
1261
|
/**
|
|
1111
|
-
* <p>Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in
|
|
1112
|
-
* If enabled, the Elastic public IP address allows outbound
|
|
1113
|
-
* internet
|
|
1114
|
-
*
|
|
1115
|
-
*
|
|
1116
|
-
*
|
|
1117
|
-
*
|
|
1118
|
-
*
|
|
1262
|
+
* <p>Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in
|
|
1263
|
+
* this directory by default. If enabled, the Elastic public IP address allows outbound
|
|
1264
|
+
* internet access from your WorkSpaces when you’re using an internet gateway in the Amazon
|
|
1265
|
+
* VPC in which your WorkSpaces are located. If you're using a Network Address Translation
|
|
1266
|
+
* (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in
|
|
1267
|
+
* public subnets and you manually assign them Elastic IP addresses, you should disable this
|
|
1268
|
+
* setting. This setting applies to new WorkSpaces that you launch or to existing WorkSpaces
|
|
1269
|
+
* that you rebuild. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-vpc.html"> Configure a VPC for
|
|
1270
|
+
* Amazon WorkSpaces</a>.</p>
|
|
1119
1271
|
*/
|
|
1120
1272
|
EnableInternetAccess?: boolean;
|
|
1121
1273
|
/**
|
|
@@ -1123,10 +1275,9 @@ export interface DefaultWorkspaceCreationProperties {
|
|
|
1123
1275
|
*/
|
|
1124
1276
|
DefaultOu?: string;
|
|
1125
1277
|
/**
|
|
1126
|
-
* <p>The identifier of the default security group to apply to WorkSpaces when they are
|
|
1127
|
-
* For more information, see
|
|
1128
|
-
*
|
|
1129
|
-
* Security Groups for Your WorkSpaces</a>.</p>
|
|
1278
|
+
* <p>The identifier of the default security group to apply to WorkSpaces when they are
|
|
1279
|
+
* created. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-security-groups.html"> Security
|
|
1280
|
+
* Groups for Your WorkSpaces</a>.</p>
|
|
1130
1281
|
*/
|
|
1131
1282
|
CustomSecurityGroupId?: string;
|
|
1132
1283
|
/**
|
|
@@ -1146,6 +1297,31 @@ export declare namespace DefaultWorkspaceCreationProperties {
|
|
|
1146
1297
|
*/
|
|
1147
1298
|
const filterSensitiveLog: (obj: DefaultWorkspaceCreationProperties) => any;
|
|
1148
1299
|
}
|
|
1300
|
+
export interface DeleteClientBrandingRequest {
|
|
1301
|
+
/**
|
|
1302
|
+
* <p>The directory identifier of the WorkSpace for which you want to delete client
|
|
1303
|
+
* branding.</p>
|
|
1304
|
+
*/
|
|
1305
|
+
ResourceId: string | undefined;
|
|
1306
|
+
/**
|
|
1307
|
+
* <p>The device type for which you want to delete client branding.</p>
|
|
1308
|
+
*/
|
|
1309
|
+
Platforms: (ClientDeviceType | string)[] | undefined;
|
|
1310
|
+
}
|
|
1311
|
+
export declare namespace DeleteClientBrandingRequest {
|
|
1312
|
+
/**
|
|
1313
|
+
* @internal
|
|
1314
|
+
*/
|
|
1315
|
+
const filterSensitiveLog: (obj: DeleteClientBrandingRequest) => any;
|
|
1316
|
+
}
|
|
1317
|
+
export interface DeleteClientBrandingResult {
|
|
1318
|
+
}
|
|
1319
|
+
export declare namespace DeleteClientBrandingResult {
|
|
1320
|
+
/**
|
|
1321
|
+
* @internal
|
|
1322
|
+
*/
|
|
1323
|
+
const filterSensitiveLog: (obj: DeleteClientBrandingResult) => any;
|
|
1324
|
+
}
|
|
1149
1325
|
export interface DeleteConnectClientAddInRequest {
|
|
1150
1326
|
/**
|
|
1151
1327
|
* <p>The identifier of the client add-in to delete.</p>
|
|
@@ -1213,7 +1389,8 @@ export declare namespace DeleteIpGroupResult {
|
|
|
1213
1389
|
export interface DeleteTagsRequest {
|
|
1214
1390
|
/**
|
|
1215
1391
|
* <p>The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces,
|
|
1216
|
-
* registered directories, images, custom bundles, IP access control groups, and connection
|
|
1392
|
+
* registered directories, images, custom bundles, IP access control groups, and connection
|
|
1393
|
+
* aliases.</p>
|
|
1217
1394
|
*/
|
|
1218
1395
|
ResourceId: string | undefined;
|
|
1219
1396
|
/**
|
|
@@ -1277,9 +1454,9 @@ export declare namespace DeleteWorkspaceImageResult {
|
|
|
1277
1454
|
}
|
|
1278
1455
|
export interface DeregisterWorkspaceDirectoryRequest {
|
|
1279
1456
|
/**
|
|
1280
|
-
* <p>The identifier of the directory. If any WorkSpaces are registered to this directory, you
|
|
1281
|
-
* remove them before you deregister the directory, or you will receive an
|
|
1282
|
-
* error.</p>
|
|
1457
|
+
* <p>The identifier of the directory. If any WorkSpaces are registered to this directory, you
|
|
1458
|
+
* must remove them before you deregister the directory, or you will receive an
|
|
1459
|
+
* OperationNotSupportedException error.</p>
|
|
1283
1460
|
*/
|
|
1284
1461
|
DirectoryId: string | undefined;
|
|
1285
1462
|
}
|
|
@@ -1344,8 +1521,8 @@ export interface DescribeAccountModificationsResult {
|
|
|
1344
1521
|
*/
|
|
1345
1522
|
AccountModifications?: AccountModification[];
|
|
1346
1523
|
/**
|
|
1347
|
-
* <p>The token to use to retrieve the next page of results. This value is null when there
|
|
1348
|
-
*
|
|
1524
|
+
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
1525
|
+
* no more results to return. </p>
|
|
1349
1526
|
*/
|
|
1350
1527
|
NextToken?: string;
|
|
1351
1528
|
}
|
|
@@ -1355,6 +1532,137 @@ export declare namespace DescribeAccountModificationsResult {
|
|
|
1355
1532
|
*/
|
|
1356
1533
|
const filterSensitiveLog: (obj: DescribeAccountModificationsResult) => any;
|
|
1357
1534
|
}
|
|
1535
|
+
export interface DescribeClientBrandingRequest {
|
|
1536
|
+
/**
|
|
1537
|
+
* <p>The directory identifier of the WorkSpace for which you want to view client branding
|
|
1538
|
+
* information.</p>
|
|
1539
|
+
*/
|
|
1540
|
+
ResourceId: string | undefined;
|
|
1541
|
+
}
|
|
1542
|
+
export declare namespace DescribeClientBrandingRequest {
|
|
1543
|
+
/**
|
|
1544
|
+
* @internal
|
|
1545
|
+
*/
|
|
1546
|
+
const filterSensitiveLog: (obj: DescribeClientBrandingRequest) => any;
|
|
1547
|
+
}
|
|
1548
|
+
/**
|
|
1549
|
+
* <p>The client branding attributes for iOS device types. These attributes are displayed on
|
|
1550
|
+
* the iOS client login screen only.</p>
|
|
1551
|
+
* <important>
|
|
1552
|
+
* <p>Client branding attributes are public facing. Ensure you do not include sensitive
|
|
1553
|
+
* information.</p>
|
|
1554
|
+
* </important>
|
|
1555
|
+
*/
|
|
1556
|
+
export interface IosClientBrandingAttributes {
|
|
1557
|
+
/**
|
|
1558
|
+
* <p>The logo. This is the link where users can download the logo image. This is the
|
|
1559
|
+
* standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal
|
|
1560
|
+
* to one point.</p>
|
|
1561
|
+
*/
|
|
1562
|
+
LogoUrl?: string;
|
|
1563
|
+
/**
|
|
1564
|
+
* <p>The @2x version of the logo. This is the higher resolution display that offers a scale
|
|
1565
|
+
* factor of 2.0 (or @2x).</p>
|
|
1566
|
+
* <note>
|
|
1567
|
+
* <p> For more information about iOS image size and resolution, see <a href="https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/image-size-and-resolution/">Image Size and Resolution </a> in the <i>Apple Human Interface
|
|
1568
|
+
* Guidelines</i>.</p>
|
|
1569
|
+
* </note>
|
|
1570
|
+
*/
|
|
1571
|
+
Logo2xUrl?: string;
|
|
1572
|
+
/**
|
|
1573
|
+
* <p>The @3x version of the logo. This is the higher resolution display that offers a scale
|
|
1574
|
+
* factor of 3.0 (or @3x).</p>
|
|
1575
|
+
* <note>
|
|
1576
|
+
* <p> For more information about iOS image size and resolution, see <a href="https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/image-size-and-resolution/">Image Size and Resolution </a> in the <i>Apple Human Interface
|
|
1577
|
+
* Guidelines</i>.</p>
|
|
1578
|
+
* </note>
|
|
1579
|
+
*/
|
|
1580
|
+
Logo3xUrl?: string;
|
|
1581
|
+
/**
|
|
1582
|
+
* <p>The support email. The company's customer support email address.</p>
|
|
1583
|
+
* <note>
|
|
1584
|
+
* <ul>
|
|
1585
|
+
* <li>
|
|
1586
|
+
* <p>In each platform type, the <code>SupportEmail</code> and
|
|
1587
|
+
* <code>SupportLink</code> parameters are mutually exclusive. You can specify one
|
|
1588
|
+
* parameter for each platform type, but not both.</p>
|
|
1589
|
+
* </li>
|
|
1590
|
+
* <li>
|
|
1591
|
+
* <p>The default email is <code>workspaces-feedback@amazon.com</code>.</p>
|
|
1592
|
+
* </li>
|
|
1593
|
+
* </ul>
|
|
1594
|
+
* </note>
|
|
1595
|
+
*/
|
|
1596
|
+
SupportEmail?: string;
|
|
1597
|
+
/**
|
|
1598
|
+
* <p>The support link. The link for the company's customer support page for their
|
|
1599
|
+
* WorkSpace.</p>
|
|
1600
|
+
* <note>
|
|
1601
|
+
* <ul>
|
|
1602
|
+
* <li>
|
|
1603
|
+
* <p>In each platform type, the <code>SupportEmail</code> and
|
|
1604
|
+
* <code>SupportLink</code> parameters are mutually exclusive. You can specify one
|
|
1605
|
+
* parameter for each platform type, but not both.</p>
|
|
1606
|
+
* </li>
|
|
1607
|
+
* <li>
|
|
1608
|
+
* <p>The default support link is <code>workspaces-feedback@amazon.com</code>.</p>
|
|
1609
|
+
* </li>
|
|
1610
|
+
* </ul>
|
|
1611
|
+
* </note>
|
|
1612
|
+
*/
|
|
1613
|
+
SupportLink?: string;
|
|
1614
|
+
/**
|
|
1615
|
+
* <p>The forgotten password link. This is the web address that users can go to if they forget
|
|
1616
|
+
* the password for their WorkSpace.</p>
|
|
1617
|
+
*/
|
|
1618
|
+
ForgotPasswordLink?: string;
|
|
1619
|
+
/**
|
|
1620
|
+
* <p>The login message. Specified as a key value pair, in which the key is a locale and the
|
|
1621
|
+
* value is the localized message for that locale. The only key supported is
|
|
1622
|
+
* <code>en_US</code>. </p>
|
|
1623
|
+
*/
|
|
1624
|
+
LoginMessage?: {
|
|
1625
|
+
[key: string]: string;
|
|
1626
|
+
};
|
|
1627
|
+
}
|
|
1628
|
+
export declare namespace IosClientBrandingAttributes {
|
|
1629
|
+
/**
|
|
1630
|
+
* @internal
|
|
1631
|
+
*/
|
|
1632
|
+
const filterSensitiveLog: (obj: IosClientBrandingAttributes) => any;
|
|
1633
|
+
}
|
|
1634
|
+
export interface DescribeClientBrandingResult {
|
|
1635
|
+
/**
|
|
1636
|
+
* <p>The branding information for Windows devices.</p>
|
|
1637
|
+
*/
|
|
1638
|
+
DeviceTypeWindows?: DefaultClientBrandingAttributes;
|
|
1639
|
+
/**
|
|
1640
|
+
* <p>The branding information for macOS devices.</p>
|
|
1641
|
+
*/
|
|
1642
|
+
DeviceTypeOsx?: DefaultClientBrandingAttributes;
|
|
1643
|
+
/**
|
|
1644
|
+
* <p>The branding information for Android devices.</p>
|
|
1645
|
+
*/
|
|
1646
|
+
DeviceTypeAndroid?: DefaultClientBrandingAttributes;
|
|
1647
|
+
/**
|
|
1648
|
+
* <p>The branding information for iOS devices.</p>
|
|
1649
|
+
*/
|
|
1650
|
+
DeviceTypeIos?: IosClientBrandingAttributes;
|
|
1651
|
+
/**
|
|
1652
|
+
* <p>The branding information for Linux devices.</p>
|
|
1653
|
+
*/
|
|
1654
|
+
DeviceTypeLinux?: DefaultClientBrandingAttributes;
|
|
1655
|
+
/**
|
|
1656
|
+
* <p>The branding information for Web access.</p>
|
|
1657
|
+
*/
|
|
1658
|
+
DeviceTypeWeb?: DefaultClientBrandingAttributes;
|
|
1659
|
+
}
|
|
1660
|
+
export declare namespace DescribeClientBrandingResult {
|
|
1661
|
+
/**
|
|
1662
|
+
* @internal
|
|
1663
|
+
*/
|
|
1664
|
+
const filterSensitiveLog: (obj: DescribeClientBrandingResult) => any;
|
|
1665
|
+
}
|
|
1358
1666
|
export interface DescribeClientPropertiesRequest {
|
|
1359
1667
|
/**
|
|
1360
1668
|
* <p>The resource identifier, in the form of directory IDs.</p>
|
|
@@ -1431,8 +1739,8 @@ export interface DescribeConnectionAliasesRequest {
|
|
|
1431
1739
|
*/
|
|
1432
1740
|
Limit?: number;
|
|
1433
1741
|
/**
|
|
1434
|
-
* <p>If you received a <code>NextToken</code> from a previous call that was paginated,
|
|
1435
|
-
* next set of results. </p>
|
|
1742
|
+
* <p>If you received a <code>NextToken</code> from a previous call that was paginated,
|
|
1743
|
+
* provide this token to receive the next set of results. </p>
|
|
1436
1744
|
*/
|
|
1437
1745
|
NextToken?: string;
|
|
1438
1746
|
}
|
|
@@ -1448,7 +1756,8 @@ export interface DescribeConnectionAliasesResult {
|
|
|
1448
1756
|
*/
|
|
1449
1757
|
ConnectionAliases?: ConnectionAlias[];
|
|
1450
1758
|
/**
|
|
1451
|
-
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
1759
|
+
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
1760
|
+
* no more results to return. </p>
|
|
1452
1761
|
*/
|
|
1453
1762
|
NextToken?: string;
|
|
1454
1763
|
}
|
|
@@ -1464,8 +1773,8 @@ export interface DescribeConnectionAliasPermissionsRequest {
|
|
|
1464
1773
|
*/
|
|
1465
1774
|
AliasId: string | undefined;
|
|
1466
1775
|
/**
|
|
1467
|
-
* <p>If you received a <code>NextToken</code> from a previous call that was paginated,
|
|
1468
|
-
* next set of results. </p>
|
|
1776
|
+
* <p>If you received a <code>NextToken</code> from a previous call that was paginated,
|
|
1777
|
+
* provide this token to receive the next set of results. </p>
|
|
1469
1778
|
*/
|
|
1470
1779
|
NextToken?: string;
|
|
1471
1780
|
/**
|
|
@@ -1489,7 +1798,8 @@ export interface DescribeConnectionAliasPermissionsResult {
|
|
|
1489
1798
|
*/
|
|
1490
1799
|
ConnectionAliasPermissions?: ConnectionAliasPermission[];
|
|
1491
1800
|
/**
|
|
1492
|
-
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
1801
|
+
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
1802
|
+
* no more results to return. </p>
|
|
1493
1803
|
*/
|
|
1494
1804
|
NextToken?: string;
|
|
1495
1805
|
}
|
|
@@ -1553,7 +1863,8 @@ export interface DescribeIpGroupsResult {
|
|
|
1553
1863
|
*/
|
|
1554
1864
|
Result?: WorkspacesIpGroup[];
|
|
1555
1865
|
/**
|
|
1556
|
-
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
1866
|
+
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
1867
|
+
* no more results to return. </p>
|
|
1557
1868
|
*/
|
|
1558
1869
|
NextToken?: string;
|
|
1559
1870
|
}
|
|
@@ -1566,7 +1877,8 @@ export declare namespace DescribeIpGroupsResult {
|
|
|
1566
1877
|
export interface DescribeTagsRequest {
|
|
1567
1878
|
/**
|
|
1568
1879
|
* <p>The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces,
|
|
1569
|
-
* registered directories, images, custom bundles, IP access control groups, and connection
|
|
1880
|
+
* registered directories, images, custom bundles, IP access control groups, and connection
|
|
1881
|
+
* aliases.</p>
|
|
1570
1882
|
*/
|
|
1571
1883
|
ResourceId: string | undefined;
|
|
1572
1884
|
}
|
|
@@ -1721,8 +2033,8 @@ export interface WorkspaceAccessProperties {
|
|
|
1721
2033
|
*/
|
|
1722
2034
|
DeviceTypeIos?: AccessPropertyValue | string;
|
|
1723
2035
|
/**
|
|
1724
|
-
* <p>Indicates whether users can use Android and Android-compatible Chrome OS devices
|
|
1725
|
-
*
|
|
2036
|
+
* <p>Indicates whether users can use Android and Android-compatible Chrome OS devices to
|
|
2037
|
+
* access their WorkSpaces.</p>
|
|
1726
2038
|
*/
|
|
1727
2039
|
DeviceTypeAndroid?: AccessPropertyValue | string;
|
|
1728
2040
|
/**
|
|
@@ -1792,12 +2104,11 @@ export interface WorkspaceDirectory {
|
|
|
1792
2104
|
WorkspaceSecurityGroupId?: string;
|
|
1793
2105
|
/**
|
|
1794
2106
|
* <p>The state of the directory's registration with Amazon WorkSpaces. After a directory is
|
|
1795
|
-
* deregistered, the <code>DEREGISTERED</code> state is returned very briefly before the
|
|
1796
|
-
* metadata is cleaned up, so this state is rarely returned. To confirm that a
|
|
1797
|
-
* check for the directory ID by using
|
|
1798
|
-
*
|
|
1799
|
-
*
|
|
1800
|
-
* successfully deregistered.</p>
|
|
2107
|
+
* deregistered, the <code>DEREGISTERED</code> state is returned very briefly before the
|
|
2108
|
+
* directory metadata is cleaned up, so this state is rarely returned. To confirm that a
|
|
2109
|
+
* directory is deregistered, check for the directory ID by using <a href="https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceDirectories.html">
|
|
2110
|
+
* DescribeWorkspaceDirectories</a>. If the directory ID isn't returned, then the
|
|
2111
|
+
* directory has been successfully deregistered.</p>
|
|
1801
2112
|
*/
|
|
1802
2113
|
State?: WorkspaceDirectoryState | string;
|
|
1803
2114
|
/**
|
|
@@ -1835,7 +2146,8 @@ export interface DescribeWorkspaceDirectoriesResult {
|
|
|
1835
2146
|
*/
|
|
1836
2147
|
Directories?: WorkspaceDirectory[];
|
|
1837
2148
|
/**
|
|
1838
|
-
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
2149
|
+
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
2150
|
+
* no more results to return. </p>
|
|
1839
2151
|
*/
|
|
1840
2152
|
NextToken?: string;
|
|
1841
2153
|
}
|
|
@@ -1867,14 +2179,14 @@ export declare namespace DescribeWorkspaceImagePermissionsRequest {
|
|
|
1867
2179
|
const filterSensitiveLog: (obj: DescribeWorkspaceImagePermissionsRequest) => any;
|
|
1868
2180
|
}
|
|
1869
2181
|
/**
|
|
1870
|
-
* <p>Describes the Amazon Web Services accounts that have been granted permission to use a
|
|
1871
|
-
* For more information about sharing images, see
|
|
1872
|
-
*
|
|
1873
|
-
* Share or Unshare a Custom WorkSpaces Image</a>.</p>
|
|
2182
|
+
* <p>Describes the Amazon Web Services accounts that have been granted permission to use a
|
|
2183
|
+
* shared image. 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
|
|
2184
|
+
* WorkSpaces Image</a>.</p>
|
|
1874
2185
|
*/
|
|
1875
2186
|
export interface ImagePermission {
|
|
1876
2187
|
/**
|
|
1877
|
-
* <p>The identifier of the Amazon Web Services account that an image has been shared
|
|
2188
|
+
* <p>The identifier of the Amazon Web Services account that an image has been shared
|
|
2189
|
+
* with.</p>
|
|
1878
2190
|
*/
|
|
1879
2191
|
SharedAccountId?: string;
|
|
1880
2192
|
}
|
|
@@ -1890,11 +2202,13 @@ export interface DescribeWorkspaceImagePermissionsResult {
|
|
|
1890
2202
|
*/
|
|
1891
2203
|
ImageId?: string;
|
|
1892
2204
|
/**
|
|
1893
|
-
* <p>The identifiers of the Amazon Web Services accounts that the image has been shared
|
|
2205
|
+
* <p>The identifiers of the Amazon Web Services accounts that the image has been shared
|
|
2206
|
+
* with.</p>
|
|
1894
2207
|
*/
|
|
1895
2208
|
ImagePermissions?: ImagePermission[];
|
|
1896
2209
|
/**
|
|
1897
|
-
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
2210
|
+
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
2211
|
+
* no more results to return. </p>
|
|
1898
2212
|
*/
|
|
1899
2213
|
NextToken?: string;
|
|
1900
2214
|
}
|
|
@@ -1962,20 +2276,21 @@ export declare enum WorkspaceImageState {
|
|
|
1962
2276
|
PENDING = "PENDING"
|
|
1963
2277
|
}
|
|
1964
2278
|
/**
|
|
1965
|
-
* <p>Describes whether a WorkSpace image needs to be updated with the latest
|
|
1966
|
-
*
|
|
1967
|
-
*
|
|
2279
|
+
* <p>Describes whether a WorkSpace image needs to be updated with the latest drivers and
|
|
2280
|
+
* other components required by Amazon WorkSpaces.</p>
|
|
1968
2281
|
* <note>
|
|
1969
2282
|
* <p>Only Windows 10 WorkSpace images can be programmatically updated at this time.</p>
|
|
1970
2283
|
* </note>
|
|
1971
2284
|
*/
|
|
1972
2285
|
export interface UpdateResult {
|
|
1973
2286
|
/**
|
|
1974
|
-
* <p>Indicates whether updated drivers or other components are available for the specified
|
|
2287
|
+
* <p>Indicates whether updated drivers or other components are available for the specified
|
|
2288
|
+
* WorkSpace image.</p>
|
|
1975
2289
|
*/
|
|
1976
2290
|
UpdateAvailable?: boolean;
|
|
1977
2291
|
/**
|
|
1978
|
-
* <p>A description of whether updates for the WorkSpace image are pending or
|
|
2292
|
+
* <p>A description of whether updates for the WorkSpace image are pending or
|
|
2293
|
+
* available.</p>
|
|
1979
2294
|
*/
|
|
1980
2295
|
Description?: string;
|
|
1981
2296
|
}
|
|
@@ -2025,8 +2340,8 @@ export interface WorkspaceImage {
|
|
|
2025
2340
|
*/
|
|
2026
2341
|
ErrorMessage?: string;
|
|
2027
2342
|
/**
|
|
2028
|
-
* <p>The date when the image was created. If the image has been shared, the Amazon Web Services account
|
|
2029
|
-
*
|
|
2343
|
+
* <p>The date when the image was created. If the image has been shared, the Amazon Web Services account that the image has been shared with sees the original creation date
|
|
2344
|
+
* of the image.</p>
|
|
2030
2345
|
*/
|
|
2031
2346
|
Created?: Date;
|
|
2032
2347
|
/**
|
|
@@ -2050,7 +2365,8 @@ export interface DescribeWorkspaceImagesResult {
|
|
|
2050
2365
|
*/
|
|
2051
2366
|
Images?: WorkspaceImage[];
|
|
2052
2367
|
/**
|
|
2053
|
-
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
2368
|
+
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
2369
|
+
* no more results to return. </p>
|
|
2054
2370
|
*/
|
|
2055
2371
|
NextToken?: string;
|
|
2056
2372
|
}
|
|
@@ -2108,7 +2424,8 @@ export interface DescribeWorkspacesResult {
|
|
|
2108
2424
|
*/
|
|
2109
2425
|
Workspaces?: Workspace[];
|
|
2110
2426
|
/**
|
|
2111
|
-
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
2427
|
+
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
2428
|
+
* no more results to return. </p>
|
|
2112
2429
|
*/
|
|
2113
2430
|
NextToken?: string;
|
|
2114
2431
|
}
|
|
@@ -2169,7 +2486,8 @@ export interface DescribeWorkspacesConnectionStatusResult {
|
|
|
2169
2486
|
*/
|
|
2170
2487
|
WorkspacesConnectionStatus?: WorkspaceConnectionStatus[];
|
|
2171
2488
|
/**
|
|
2172
|
-
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
2489
|
+
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
2490
|
+
* no more results to return. </p>
|
|
2173
2491
|
*/
|
|
2174
2492
|
NextToken?: string;
|
|
2175
2493
|
}
|
|
@@ -2208,8 +2526,8 @@ export declare namespace Snapshot {
|
|
|
2208
2526
|
}
|
|
2209
2527
|
export interface DescribeWorkspaceSnapshotsResult {
|
|
2210
2528
|
/**
|
|
2211
|
-
* <p>Information about the snapshots that can be used to rebuild a WorkSpace. These snapshots
|
|
2212
|
-
* the user volume.</p>
|
|
2529
|
+
* <p>Information about the snapshots that can be used to rebuild a WorkSpace. These snapshots
|
|
2530
|
+
* include the user volume.</p>
|
|
2213
2531
|
*/
|
|
2214
2532
|
RebuildSnapshots?: Snapshot[];
|
|
2215
2533
|
/**
|
|
@@ -2269,9 +2587,8 @@ export declare namespace DisassociateIpGroupsResult {
|
|
|
2269
2587
|
const filterSensitiveLog: (obj: DisassociateIpGroupsResult) => any;
|
|
2270
2588
|
}
|
|
2271
2589
|
/**
|
|
2272
|
-
* <p>Describes a WorkSpace that could not be rebooted.
|
|
2273
|
-
* (<a>
|
|
2274
|
-
* (<a>TerminateWorkspaces</a>), started (<a>StartWorkspaces</a>), or stopped (<a>StopWorkspaces</a>).</p>
|
|
2590
|
+
* <p>Describes a WorkSpace that could not be rebooted. (<a>RebootWorkspaces</a>),
|
|
2591
|
+
* rebuilt (<a>RebuildWorkspaces</a>), restored (<a>RestoreWorkspace</a>), terminated (<a>TerminateWorkspaces</a>), started (<a>StartWorkspaces</a>), or stopped (<a>StopWorkspaces</a>).</p>
|
|
2275
2592
|
*/
|
|
2276
2593
|
export interface FailedWorkspaceChangeRequest {
|
|
2277
2594
|
/**
|
|
@@ -2294,9 +2611,165 @@ export declare namespace FailedWorkspaceChangeRequest {
|
|
|
2294
2611
|
*/
|
|
2295
2612
|
const filterSensitiveLog: (obj: FailedWorkspaceChangeRequest) => any;
|
|
2296
2613
|
}
|
|
2614
|
+
/**
|
|
2615
|
+
* <p>The client branding attributes to import for iOS device types. These attributes are
|
|
2616
|
+
* displayed on the iOS client login screen.</p>
|
|
2617
|
+
* <important>
|
|
2618
|
+
* <p>Client branding attributes are public facing. Ensure you do not include sensitive
|
|
2619
|
+
* information.</p>
|
|
2620
|
+
* </important>
|
|
2621
|
+
*/
|
|
2622
|
+
export interface IosImportClientBrandingAttributes {
|
|
2623
|
+
/**
|
|
2624
|
+
* <p>The logo. This is the link where users can download the logo image. This is the
|
|
2625
|
+
* standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal
|
|
2626
|
+
* to one point.</p>
|
|
2627
|
+
*/
|
|
2628
|
+
Logo?: Uint8Array;
|
|
2629
|
+
/**
|
|
2630
|
+
* <p>The @2x version of the logo. This is the higher resolution display that offers a scale
|
|
2631
|
+
* factor of 2.0 (or @2x).</p>
|
|
2632
|
+
* <note>
|
|
2633
|
+
* <p> For more information about iOS image size and resolution, see <a href="https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/image-size-and-resolution/">Image Size and Resolution </a> in the <i>Apple Human Interface
|
|
2634
|
+
* Guidelines</i>.</p>
|
|
2635
|
+
* </note>
|
|
2636
|
+
*/
|
|
2637
|
+
Logo2x?: Uint8Array;
|
|
2638
|
+
/**
|
|
2639
|
+
* <p>The @3x version of the logo. This is the higher resolution display that offers a scale
|
|
2640
|
+
* factor of 3.0 (or @3x).</p>
|
|
2641
|
+
* <note>
|
|
2642
|
+
* <p> For more information about iOS image size and resolution, see <a href="https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/image-size-and-resolution/">Image Size and Resolution </a> in the <i>Apple Human Interface
|
|
2643
|
+
* Guidelines</i>.</p>
|
|
2644
|
+
* </note>
|
|
2645
|
+
*/
|
|
2646
|
+
Logo3x?: Uint8Array;
|
|
2647
|
+
/**
|
|
2648
|
+
* <p>The support email. The company's customer support email address.</p>
|
|
2649
|
+
* <note>
|
|
2650
|
+
* <ul>
|
|
2651
|
+
* <li>
|
|
2652
|
+
* <p>In each platform type, the <code>SupportEmail</code> and
|
|
2653
|
+
* <code>SupportLink</code> parameters are mutually exclusive. You can specify one
|
|
2654
|
+
* parameter for each platform type, but not both.</p>
|
|
2655
|
+
* </li>
|
|
2656
|
+
* <li>
|
|
2657
|
+
* <p>The default email is <code>workspaces-feedback@amazon.com</code>.</p>
|
|
2658
|
+
* </li>
|
|
2659
|
+
* </ul>
|
|
2660
|
+
* </note>
|
|
2661
|
+
*/
|
|
2662
|
+
SupportEmail?: string;
|
|
2663
|
+
/**
|
|
2664
|
+
* <p>The support link. The link for the company's customer support page for their
|
|
2665
|
+
* WorkSpace.</p>
|
|
2666
|
+
* <note>
|
|
2667
|
+
* <ul>
|
|
2668
|
+
* <li>
|
|
2669
|
+
* <p>In each platform type, the <code>SupportEmail</code> and
|
|
2670
|
+
* <code>SupportLink</code> parameters are mutually exclusive. You can specify one
|
|
2671
|
+
* parameter for each platform type, but not both.</p>
|
|
2672
|
+
* </li>
|
|
2673
|
+
* <li>
|
|
2674
|
+
* <p>The default support link is <code>workspaces-feedback@amazon.com</code>.</p>
|
|
2675
|
+
* </li>
|
|
2676
|
+
* </ul>
|
|
2677
|
+
* </note>
|
|
2678
|
+
*/
|
|
2679
|
+
SupportLink?: string;
|
|
2680
|
+
/**
|
|
2681
|
+
* <p>The forgotten password link. This is the web address that users can go to if they forget
|
|
2682
|
+
* the password for their WorkSpace.</p>
|
|
2683
|
+
*/
|
|
2684
|
+
ForgotPasswordLink?: string;
|
|
2685
|
+
/**
|
|
2686
|
+
* <p>The login message. Specified as a key value pair, in which the key is a locale and the
|
|
2687
|
+
* value is the localized message for that locale. The only key supported is
|
|
2688
|
+
* <code>en_US</code>. </p>
|
|
2689
|
+
*/
|
|
2690
|
+
LoginMessage?: {
|
|
2691
|
+
[key: string]: string;
|
|
2692
|
+
};
|
|
2693
|
+
}
|
|
2694
|
+
export declare namespace IosImportClientBrandingAttributes {
|
|
2695
|
+
/**
|
|
2696
|
+
* @internal
|
|
2697
|
+
*/
|
|
2698
|
+
const filterSensitiveLog: (obj: IosImportClientBrandingAttributes) => any;
|
|
2699
|
+
}
|
|
2700
|
+
export interface ImportClientBrandingRequest {
|
|
2701
|
+
/**
|
|
2702
|
+
* <p>The directory identifier of the WorkSpace for which you want to import client
|
|
2703
|
+
* branding.</p>
|
|
2704
|
+
*/
|
|
2705
|
+
ResourceId: string | undefined;
|
|
2706
|
+
/**
|
|
2707
|
+
* <p>The branding information to import for Windows devices.</p>
|
|
2708
|
+
*/
|
|
2709
|
+
DeviceTypeWindows?: DefaultImportClientBrandingAttributes;
|
|
2710
|
+
/**
|
|
2711
|
+
* <p>The branding information to import for macOS devices.</p>
|
|
2712
|
+
*/
|
|
2713
|
+
DeviceTypeOsx?: DefaultImportClientBrandingAttributes;
|
|
2714
|
+
/**
|
|
2715
|
+
* <p>The branding information to import for Android devices.</p>
|
|
2716
|
+
*/
|
|
2717
|
+
DeviceTypeAndroid?: DefaultImportClientBrandingAttributes;
|
|
2718
|
+
/**
|
|
2719
|
+
* <p>The branding information to import for iOS devices.</p>
|
|
2720
|
+
*/
|
|
2721
|
+
DeviceTypeIos?: IosImportClientBrandingAttributes;
|
|
2722
|
+
/**
|
|
2723
|
+
* <p>The branding information to import for Linux devices.</p>
|
|
2724
|
+
*/
|
|
2725
|
+
DeviceTypeLinux?: DefaultImportClientBrandingAttributes;
|
|
2726
|
+
/**
|
|
2727
|
+
* <p>The branding information to import for web access.</p>
|
|
2728
|
+
*/
|
|
2729
|
+
DeviceTypeWeb?: DefaultImportClientBrandingAttributes;
|
|
2730
|
+
}
|
|
2731
|
+
export declare namespace ImportClientBrandingRequest {
|
|
2732
|
+
/**
|
|
2733
|
+
* @internal
|
|
2734
|
+
*/
|
|
2735
|
+
const filterSensitiveLog: (obj: ImportClientBrandingRequest) => any;
|
|
2736
|
+
}
|
|
2737
|
+
export interface ImportClientBrandingResult {
|
|
2738
|
+
/**
|
|
2739
|
+
* <p>The branding information configured for Windows devices.</p>
|
|
2740
|
+
*/
|
|
2741
|
+
DeviceTypeWindows?: DefaultClientBrandingAttributes;
|
|
2742
|
+
/**
|
|
2743
|
+
* <p>The branding information configured for macOS devices.</p>
|
|
2744
|
+
*/
|
|
2745
|
+
DeviceTypeOsx?: DefaultClientBrandingAttributes;
|
|
2746
|
+
/**
|
|
2747
|
+
* <p>The branding information configured for Android devices.</p>
|
|
2748
|
+
*/
|
|
2749
|
+
DeviceTypeAndroid?: DefaultClientBrandingAttributes;
|
|
2750
|
+
/**
|
|
2751
|
+
* <p>The branding information configured for iOS devices.</p>
|
|
2752
|
+
*/
|
|
2753
|
+
DeviceTypeIos?: IosClientBrandingAttributes;
|
|
2754
|
+
/**
|
|
2755
|
+
* <p>The branding information configured for Linux devices.</p>
|
|
2756
|
+
*/
|
|
2757
|
+
DeviceTypeLinux?: DefaultClientBrandingAttributes;
|
|
2758
|
+
/**
|
|
2759
|
+
* <p>The branding information configured for web access.</p>
|
|
2760
|
+
*/
|
|
2761
|
+
DeviceTypeWeb?: DefaultClientBrandingAttributes;
|
|
2762
|
+
}
|
|
2763
|
+
export declare namespace ImportClientBrandingResult {
|
|
2764
|
+
/**
|
|
2765
|
+
* @internal
|
|
2766
|
+
*/
|
|
2767
|
+
const filterSensitiveLog: (obj: ImportClientBrandingResult) => any;
|
|
2768
|
+
}
|
|
2297
2769
|
export declare enum WorkspaceImageIngestionProcess {
|
|
2298
2770
|
BYOL_GRAPHICS = "BYOL_GRAPHICS",
|
|
2299
2771
|
BYOL_GRAPHICSPRO = "BYOL_GRAPHICSPRO",
|
|
2772
|
+
BYOL_GRAPHICS_G4DN = "BYOL_GRAPHICS_G4DN",
|
|
2300
2773
|
BYOL_REGULAR = "BYOL_REGULAR",
|
|
2301
2774
|
BYOL_REGULAR_WSP = "BYOL_REGULAR_WSP"
|
|
2302
2775
|
}
|
|
@@ -2311,8 +2784,13 @@ export interface ImportWorkspaceImageRequest {
|
|
|
2311
2784
|
* (WSP). To use WSP, specify a value that ends in <code>_WSP</code>. To use PCoIP, specify a value
|
|
2312
2785
|
* that does not end in <code>_WSP</code>. </p>
|
|
2313
2786
|
*
|
|
2314
|
-
* <p>For non-GPU-enabled
|
|
2315
|
-
* <code>BYOL_REGULAR</code> or <code>BYOL_REGULAR_WSP</code>, depending
|
|
2787
|
+
* <p>For non-GPU-enabled images (bundles other than Graphics.g4dn, GraphicsPro.g4dn, Graphics,
|
|
2788
|
+
* or GraphicsPro), specify <code>BYOL_REGULAR</code> or <code>BYOL_REGULAR_WSP</code>, depending
|
|
2789
|
+
* on the protocol.</p>
|
|
2790
|
+
* <note>
|
|
2791
|
+
* <p>Use <code>BYOL_GRAPHICS_G4DN</code> ingestion for both Graphics.g4dn and
|
|
2792
|
+
* GraphicsPro.g4dn.</p>
|
|
2793
|
+
* </note>
|
|
2316
2794
|
*/
|
|
2317
2795
|
IngestionProcess: WorkspaceImageIngestionProcess | string | undefined;
|
|
2318
2796
|
/**
|
|
@@ -2329,12 +2807,18 @@ export interface ImportWorkspaceImageRequest {
|
|
|
2329
2807
|
Tags?: Tag[];
|
|
2330
2808
|
/**
|
|
2331
2809
|
* <p>If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10
|
|
2332
|
-
* BYOL images. For more information about subscribing to Office for BYOL images, see
|
|
2333
|
-
*
|
|
2334
|
-
* Bring Your Own Windows Desktop Licenses</a>.</p>
|
|
2335
|
-
*
|
|
2810
|
+
* BYOL images. For more information about subscribing to Office for BYOL images, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html"> Bring
|
|
2811
|
+
* Your Own Windows Desktop Licenses</a>.</p>
|
|
2336
2812
|
* <note>
|
|
2337
|
-
* <
|
|
2813
|
+
* <ul>
|
|
2814
|
+
* <li>
|
|
2815
|
+
* <p>Although this parameter is an array, only one item is allowed at this time</p>
|
|
2816
|
+
* </li>
|
|
2817
|
+
* <li>
|
|
2818
|
+
* <p>Microsoft Office 2016 application subscription through AWS is currently not supported
|
|
2819
|
+
* for Graphics.g4dn Bring Your Own License (BYOL) images</p>
|
|
2820
|
+
* </li>
|
|
2821
|
+
* </ul>
|
|
2338
2822
|
* </note>
|
|
2339
2823
|
*/
|
|
2340
2824
|
Applications?: (Application | string)[];
|
|
@@ -2385,7 +2869,8 @@ export interface ListAvailableManagementCidrRangesResult {
|
|
|
2385
2869
|
*/
|
|
2386
2870
|
ManagementCidrRanges?: string[];
|
|
2387
2871
|
/**
|
|
2388
|
-
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
2872
|
+
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
2873
|
+
* no more results to return. </p>
|
|
2389
2874
|
*/
|
|
2390
2875
|
NextToken?: string;
|
|
2391
2876
|
}
|
|
@@ -2417,8 +2902,9 @@ export interface MigrateWorkspaceResult {
|
|
|
2417
2902
|
*/
|
|
2418
2903
|
SourceWorkspaceId?: string;
|
|
2419
2904
|
/**
|
|
2420
|
-
* <p>The new identifier of the WorkSpace that is being migrated. If the migration does not
|
|
2421
|
-
* the target WorkSpace ID will not be used, and the WorkSpace will still have the
|
|
2905
|
+
* <p>The new identifier of the WorkSpace that is being migrated. If the migration does not
|
|
2906
|
+
* succeed, the target WorkSpace ID will not be used, and the WorkSpace will still have the
|
|
2907
|
+
* original WorkSpace ID.</p>
|
|
2422
2908
|
*/
|
|
2423
2909
|
TargetWorkspaceId?: string;
|
|
2424
2910
|
}
|
|
@@ -2547,18 +3033,17 @@ export declare namespace ModifyWorkspaceAccessPropertiesResult {
|
|
|
2547
3033
|
export interface WorkspaceCreationProperties {
|
|
2548
3034
|
/**
|
|
2549
3035
|
* <p>Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.</p>
|
|
2550
|
-
*
|
|
2551
3036
|
* <note>
|
|
2552
|
-
* <p>If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new
|
|
2553
|
-
* directory will not have WorkDocs enabled. However, WorkDocs
|
|
2554
|
-
*
|
|
2555
|
-
*
|
|
2556
|
-
*
|
|
2557
|
-
*
|
|
2558
|
-
*
|
|
2559
|
-
*
|
|
2560
|
-
*
|
|
2561
|
-
*
|
|
3037
|
+
* <p>If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new
|
|
3038
|
+
* WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs
|
|
3039
|
+
* remains enabled for any existing WorkSpaces, unless you either disable users' access to
|
|
3040
|
+
* WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, see
|
|
3041
|
+
* <a href="https://docs.aws.amazon.com/workdocs/latest/adminguide/inactive-user.html">Disabling Users</a> in the <i>Amazon WorkDocs Administration
|
|
3042
|
+
* Guide</i>. To delete a WorkDocs site, see <a href="https://docs.aws.amazon.com/workdocs/latest/adminguide/manage-sites.html">Deleting a Site</a> in the
|
|
3043
|
+
* <i>Amazon WorkDocs Administration Guide</i>.</p>
|
|
3044
|
+
* <p>If you enable WorkDocs on a directory that already has existing WorkSpaces, the
|
|
3045
|
+
* existing WorkSpaces and any new WorkSpaces that are launched in the directory will have
|
|
3046
|
+
* WorkDocs enabled.</p>
|
|
2562
3047
|
* </note>
|
|
2563
3048
|
*/
|
|
2564
3049
|
EnableWorkDocs?: boolean;
|
|
@@ -2567,18 +3052,18 @@ export interface WorkspaceCreationProperties {
|
|
|
2567
3052
|
*/
|
|
2568
3053
|
EnableInternetAccess?: boolean;
|
|
2569
3054
|
/**
|
|
2570
|
-
* <p>The default organizational unit (OU) for your WorkSpaces directories. This string must
|
|
2571
|
-
* Directory Access Protocol (LDAP) distinguished name for the target
|
|
2572
|
-
*
|
|
2573
|
-
*
|
|
2574
|
-
*
|
|
2575
|
-
*
|
|
3055
|
+
* <p>The default organizational unit (OU) for your WorkSpaces directories. This string must
|
|
3056
|
+
* be the full Lightweight Directory Access Protocol (LDAP) distinguished name for the target
|
|
3057
|
+
* domain and OU. It must be in the form
|
|
3058
|
+
* <code>"OU=<i>value</i>,DC=<i>value</i>,DC=<i>value</i>"</code>,
|
|
3059
|
+
* where <i>value</i> is any string of characters, and the number of domain
|
|
3060
|
+
* components (DCs) is two or more. For example,
|
|
3061
|
+
* <code>OU=WorkSpaces_machines,DC=machines,DC=example,DC=com</code>. </p>
|
|
2576
3062
|
* <important>
|
|
2577
3063
|
* <ul>
|
|
2578
3064
|
* <li>
|
|
2579
|
-
* <p>To avoid errors, certain characters in the distinguished name must be escaped.
|
|
2580
|
-
* see <a href="https://docs.microsoft.com/previous-versions/windows/desktop/ldap/distinguished-names">
|
|
2581
|
-
* Distinguished Names</a> in the Microsoft documentation.</p>
|
|
3065
|
+
* <p>To avoid errors, certain characters in the distinguished name must be escaped.
|
|
3066
|
+
* For more information, see <a href="https://docs.microsoft.com/previous-versions/windows/desktop/ldap/distinguished-names"> Distinguished Names</a> in the Microsoft documentation.</p>
|
|
2582
3067
|
* </li>
|
|
2583
3068
|
* <li>
|
|
2584
3069
|
* <p>The API doesn't validate whether the OU exists.</p>
|
|
@@ -2777,23 +3262,26 @@ export declare namespace RebuildWorkspacesResult {
|
|
|
2777
3262
|
}
|
|
2778
3263
|
export interface RegisterWorkspaceDirectoryRequest {
|
|
2779
3264
|
/**
|
|
2780
|
-
* <p>The identifier of the directory. You cannot register a directory if it does not have a
|
|
2781
|
-
* of Active. If the directory does not have a status of Active, you will receive an
|
|
2782
|
-
* InvalidResourceStateException error. If you have already registered the maximum number of
|
|
2783
|
-
* that you can register with Amazon WorkSpaces, you will receive a
|
|
2784
|
-
* Deregister directories that you are not using for
|
|
3265
|
+
* <p>The identifier of the directory. You cannot register a directory if it does not have a
|
|
3266
|
+
* status of Active. If the directory does not have a status of Active, you will receive an
|
|
3267
|
+
* InvalidResourceStateException error. If you have already registered the maximum number of
|
|
3268
|
+
* directories that you can register with Amazon WorkSpaces, you will receive a
|
|
3269
|
+
* ResourceLimitExceededException error. Deregister directories that you are not using for
|
|
3270
|
+
* WorkSpaces, and try again.</p>
|
|
2785
3271
|
*/
|
|
2786
3272
|
DirectoryId: string | undefined;
|
|
2787
3273
|
/**
|
|
2788
|
-
* <p>The identifiers of the subnets for your virtual private cloud (VPC). Make sure that the
|
|
2789
|
-
* are in supported Availability Zones. The subnets must also be in separate
|
|
2790
|
-
* conditions are not met, you will receive an
|
|
3274
|
+
* <p>The identifiers of the subnets for your virtual private cloud (VPC). Make sure that the
|
|
3275
|
+
* subnets are in supported Availability Zones. The subnets must also be in separate
|
|
3276
|
+
* Availability Zones. If these conditions are not met, you will receive an
|
|
3277
|
+
* OperationNotSupportedException error.</p>
|
|
2791
3278
|
*/
|
|
2792
3279
|
SubnetIds?: string[];
|
|
2793
3280
|
/**
|
|
2794
|
-
* <p>Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this
|
|
2795
|
-
* WorkDocs is not available in the Region, you will receive an
|
|
2796
|
-
* <code>EnableWorkDocs</code> to disabled, and try
|
|
3281
|
+
* <p>Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this
|
|
3282
|
+
* parameter and WorkDocs is not available in the Region, you will receive an
|
|
3283
|
+
* OperationNotSupportedException error. Set <code>EnableWorkDocs</code> to disabled, and try
|
|
3284
|
+
* again.</p>
|
|
2797
3285
|
*/
|
|
2798
3286
|
EnableWorkDocs: boolean | undefined;
|
|
2799
3287
|
/**
|
|
@@ -2802,10 +3290,10 @@ export interface RegisterWorkspaceDirectoryRequest {
|
|
|
2802
3290
|
EnableSelfService?: boolean;
|
|
2803
3291
|
/**
|
|
2804
3292
|
* <p>Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own
|
|
2805
|
-
* License (BYOL) images, this value must be set to <code>DEDICATED</code> and your Amazon Web Services account must be
|
|
2806
|
-
*
|
|
2807
|
-
*
|
|
2808
|
-
*
|
|
3293
|
+
* License (BYOL) images, this value must be set to <code>DEDICATED</code> and your Amazon Web Services account must be enabled for BYOL. If your account has not been enabled for
|
|
3294
|
+
* BYOL, you will receive an InvalidParameterValuesException error. For more information about
|
|
3295
|
+
* BYOL images, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html">Bring Your Own Windows
|
|
3296
|
+
* Desktop Images</a>.</p>
|
|
2809
3297
|
*/
|
|
2810
3298
|
Tenancy?: Tenancy | string;
|
|
2811
3299
|
/**
|
|
@@ -3124,13 +3612,13 @@ export interface UpdateWorkspaceImagePermissionRequest {
|
|
|
3124
3612
|
*/
|
|
3125
3613
|
ImageId: string | undefined;
|
|
3126
3614
|
/**
|
|
3127
|
-
* <p>The permission to copy the image. This permission can be revoked only after an image
|
|
3128
|
-
*
|
|
3615
|
+
* <p>The permission to copy the image. This permission can be revoked only after an image has
|
|
3616
|
+
* been shared.</p>
|
|
3129
3617
|
*/
|
|
3130
3618
|
AllowCopyImage: boolean | undefined;
|
|
3131
3619
|
/**
|
|
3132
|
-
* <p>The identifier of the Amazon Web Services account to share or unshare the image
|
|
3133
|
-
*
|
|
3620
|
+
* <p>The identifier of the Amazon Web Services account to share or unshare the image
|
|
3621
|
+
* with.</p>
|
|
3134
3622
|
* <important>
|
|
3135
3623
|
* <p>Before sharing the image, confirm that you are sharing to the correct Amazon Web Services account ID.</p>
|
|
3136
3624
|
* </important>
|