@aws-sdk/client-workspaces 3.56.0 → 3.67.0

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