@aws-sdk/client-workspaces 3.378.0 → 3.382.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.
|
@@ -56,27 +56,33 @@ export type DedicatedTenancyModificationStateEnum = (typeof DedicatedTenancyModi
|
|
|
56
56
|
*/
|
|
57
57
|
export interface AccountModification {
|
|
58
58
|
/**
|
|
59
|
+
* @public
|
|
59
60
|
* <p>The state of the modification to the configuration of BYOL.</p>
|
|
60
61
|
*/
|
|
61
62
|
ModificationState?: DedicatedTenancyModificationStateEnum | string;
|
|
62
63
|
/**
|
|
64
|
+
* @public
|
|
63
65
|
* <p>The status of BYOL (whether BYOL is being enabled or disabled).</p>
|
|
64
66
|
*/
|
|
65
67
|
DedicatedTenancySupport?: DedicatedTenancySupportResultEnum | string;
|
|
66
68
|
/**
|
|
69
|
+
* @public
|
|
67
70
|
* <p>The IP address range, specified as an IPv4 CIDR block, for the management network
|
|
68
71
|
* interface used for the account.</p>
|
|
69
72
|
*/
|
|
70
73
|
DedicatedTenancyManagementCidrRange?: string;
|
|
71
74
|
/**
|
|
75
|
+
* @public
|
|
72
76
|
* <p>The timestamp when the modification of the BYOL configuration was started.</p>
|
|
73
77
|
*/
|
|
74
78
|
StartTime?: Date;
|
|
75
79
|
/**
|
|
80
|
+
* @public
|
|
76
81
|
* <p>The error code that is returned if the configuration of BYOL cannot be modified.</p>
|
|
77
82
|
*/
|
|
78
83
|
ErrorCode?: string;
|
|
79
84
|
/**
|
|
85
|
+
* @public
|
|
80
86
|
* <p>The text of the error message that is returned if the configuration of BYOL cannot be
|
|
81
87
|
* modified.</p>
|
|
82
88
|
*/
|
|
@@ -99,10 +105,12 @@ export type Application = (typeof Application)[keyof typeof Application];
|
|
|
99
105
|
*/
|
|
100
106
|
export interface AssociateConnectionAliasRequest {
|
|
101
107
|
/**
|
|
108
|
+
* @public
|
|
102
109
|
* <p>The identifier of the connection alias.</p>
|
|
103
110
|
*/
|
|
104
111
|
AliasId: string | undefined;
|
|
105
112
|
/**
|
|
113
|
+
* @public
|
|
106
114
|
* <p>The identifier of the directory to associate the connection alias with.</p>
|
|
107
115
|
*/
|
|
108
116
|
ResourceId: string | undefined;
|
|
@@ -112,6 +120,7 @@ export interface AssociateConnectionAliasRequest {
|
|
|
112
120
|
*/
|
|
113
121
|
export interface AssociateConnectionAliasResult {
|
|
114
122
|
/**
|
|
123
|
+
* @public
|
|
115
124
|
* <p>The identifier of the connection alias association. You use the connection identifier in
|
|
116
125
|
* the DNS TXT record when you're configuring your DNS routing policies. </p>
|
|
117
126
|
*/
|
|
@@ -149,6 +158,7 @@ export declare class OperationNotSupportedException extends __BaseException {
|
|
|
149
158
|
readonly name: "OperationNotSupportedException";
|
|
150
159
|
readonly $fault: "client";
|
|
151
160
|
/**
|
|
161
|
+
* @public
|
|
152
162
|
* <p>The exception error reason.</p>
|
|
153
163
|
*/
|
|
154
164
|
reason?: string;
|
|
@@ -177,6 +187,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
177
187
|
readonly name: "ResourceNotFoundException";
|
|
178
188
|
readonly $fault: "client";
|
|
179
189
|
/**
|
|
190
|
+
* @public
|
|
180
191
|
* <p>The ID of the resource that could not be found.</p>
|
|
181
192
|
*/
|
|
182
193
|
ResourceId?: string;
|
|
@@ -190,10 +201,12 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
190
201
|
*/
|
|
191
202
|
export interface AssociateIpGroupsRequest {
|
|
192
203
|
/**
|
|
204
|
+
* @public
|
|
193
205
|
* <p>The identifier of the directory.</p>
|
|
194
206
|
*/
|
|
195
207
|
DirectoryId: string | undefined;
|
|
196
208
|
/**
|
|
209
|
+
* @public
|
|
197
210
|
* <p>The identifiers of one or more IP access control groups.</p>
|
|
198
211
|
*/
|
|
199
212
|
GroupIds: string[] | undefined;
|
|
@@ -236,10 +249,12 @@ export type AssociationStatus = (typeof AssociationStatus)[keyof typeof Associat
|
|
|
236
249
|
*/
|
|
237
250
|
export interface IpRuleItem {
|
|
238
251
|
/**
|
|
252
|
+
* @public
|
|
239
253
|
* <p>The IP address range, in CIDR notation.</p>
|
|
240
254
|
*/
|
|
241
255
|
ipRule?: string;
|
|
242
256
|
/**
|
|
257
|
+
* @public
|
|
243
258
|
* <p>The description.</p>
|
|
244
259
|
*/
|
|
245
260
|
ruleDesc?: string;
|
|
@@ -249,10 +264,12 @@ export interface IpRuleItem {
|
|
|
249
264
|
*/
|
|
250
265
|
export interface AuthorizeIpRulesRequest {
|
|
251
266
|
/**
|
|
267
|
+
* @public
|
|
252
268
|
* <p>The identifier of the group.</p>
|
|
253
269
|
*/
|
|
254
270
|
GroupId: string | undefined;
|
|
255
271
|
/**
|
|
272
|
+
* @public
|
|
256
273
|
* <p>The rules to add to the group.</p>
|
|
257
274
|
*/
|
|
258
275
|
UserRules: IpRuleItem[] | undefined;
|
|
@@ -299,6 +316,7 @@ export type Compute = (typeof Compute)[keyof typeof Compute];
|
|
|
299
316
|
*/
|
|
300
317
|
export interface ComputeType {
|
|
301
318
|
/**
|
|
319
|
+
* @public
|
|
302
320
|
* <p>The compute type.</p>
|
|
303
321
|
*/
|
|
304
322
|
Name?: Compute | string;
|
|
@@ -309,6 +327,7 @@ export interface ComputeType {
|
|
|
309
327
|
*/
|
|
310
328
|
export interface RootStorage {
|
|
311
329
|
/**
|
|
330
|
+
* @public
|
|
312
331
|
* <p>The size of the root volume.</p>
|
|
313
332
|
*/
|
|
314
333
|
Capacity?: string;
|
|
@@ -332,6 +351,7 @@ export type WorkspaceBundleState = (typeof WorkspaceBundleState)[keyof typeof Wo
|
|
|
332
351
|
*/
|
|
333
352
|
export interface UserStorage {
|
|
334
353
|
/**
|
|
354
|
+
* @public
|
|
335
355
|
* <p>The size of the user volume.</p>
|
|
336
356
|
*/
|
|
337
357
|
Capacity?: string;
|
|
@@ -342,52 +362,64 @@ export interface UserStorage {
|
|
|
342
362
|
*/
|
|
343
363
|
export interface WorkspaceBundle {
|
|
344
364
|
/**
|
|
365
|
+
* @public
|
|
345
366
|
* <p>The identifier of the bundle.</p>
|
|
346
367
|
*/
|
|
347
368
|
BundleId?: string;
|
|
348
369
|
/**
|
|
370
|
+
* @public
|
|
349
371
|
* <p>The name of the bundle.</p>
|
|
350
372
|
*/
|
|
351
373
|
Name?: string;
|
|
352
374
|
/**
|
|
375
|
+
* @public
|
|
353
376
|
* <p>The owner of the bundle. This is the account identifier of the owner, or
|
|
354
377
|
* <code>AMAZON</code> if the bundle is provided by Amazon Web Services.</p>
|
|
355
378
|
*/
|
|
356
379
|
Owner?: string;
|
|
357
380
|
/**
|
|
381
|
+
* @public
|
|
358
382
|
* <p>The description of the bundle.</p>
|
|
359
383
|
*/
|
|
360
384
|
Description?: string;
|
|
361
385
|
/**
|
|
386
|
+
* @public
|
|
362
387
|
* <p>The identifier of the image that was used to create the bundle.</p>
|
|
363
388
|
*/
|
|
364
389
|
ImageId?: string;
|
|
365
390
|
/**
|
|
391
|
+
* @public
|
|
366
392
|
* <p>The size of the root volume.</p>
|
|
367
393
|
*/
|
|
368
394
|
RootStorage?: RootStorage;
|
|
369
395
|
/**
|
|
396
|
+
* @public
|
|
370
397
|
* <p>The size of the user volume.</p>
|
|
371
398
|
*/
|
|
372
399
|
UserStorage?: UserStorage;
|
|
373
400
|
/**
|
|
401
|
+
* @public
|
|
374
402
|
* <p>The compute type of the bundle. For more information, see
|
|
375
403
|
* <a href="http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles">Amazon WorkSpaces Bundles</a>.</p>
|
|
376
404
|
*/
|
|
377
405
|
ComputeType?: ComputeType;
|
|
378
406
|
/**
|
|
407
|
+
* @public
|
|
379
408
|
* <p>The last time that the bundle was updated.</p>
|
|
380
409
|
*/
|
|
381
410
|
LastUpdatedTime?: Date;
|
|
382
411
|
/**
|
|
412
|
+
* @public
|
|
383
413
|
* <p>The time when the bundle was created.</p>
|
|
384
414
|
*/
|
|
385
415
|
CreationTime?: Date;
|
|
386
416
|
/**
|
|
417
|
+
* @public
|
|
387
418
|
* <p>The state of the WorkSpace bundle.</p>
|
|
388
419
|
*/
|
|
389
420
|
State?: WorkspaceBundleState | string;
|
|
390
421
|
/**
|
|
422
|
+
* @public
|
|
391
423
|
* <p>The type of WorkSpace bundle.</p>
|
|
392
424
|
*/
|
|
393
425
|
BundleType?: BundleType | string;
|
|
@@ -411,10 +443,12 @@ export type CertificateBasedAuthStatusEnum = (typeof CertificateBasedAuthStatusE
|
|
|
411
443
|
*/
|
|
412
444
|
export interface CertificateBasedAuthProperties {
|
|
413
445
|
/**
|
|
446
|
+
* @public
|
|
414
447
|
* <p>The status of the certificate-based authentication properties.</p>
|
|
415
448
|
*/
|
|
416
449
|
Status?: CertificateBasedAuthStatusEnum | string;
|
|
417
450
|
/**
|
|
451
|
+
* @public
|
|
418
452
|
* <p>The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager Private CA resource.</p>
|
|
419
453
|
*/
|
|
420
454
|
CertificateAuthorityArn?: string;
|
|
@@ -465,12 +499,14 @@ export type ReconnectEnum = (typeof ReconnectEnum)[keyof typeof ReconnectEnum];
|
|
|
465
499
|
*/
|
|
466
500
|
export interface ClientProperties {
|
|
467
501
|
/**
|
|
502
|
+
* @public
|
|
468
503
|
* <p>Specifies whether users can cache their credentials on the Amazon WorkSpaces client.
|
|
469
504
|
* When enabled, users can choose to reconnect to their WorkSpaces without re-entering their
|
|
470
505
|
* credentials. </p>
|
|
471
506
|
*/
|
|
472
507
|
ReconnectEnabled?: ReconnectEnum | string;
|
|
473
508
|
/**
|
|
509
|
+
* @public
|
|
474
510
|
* <p>Specifies whether users can upload diagnostic log files of Amazon WorkSpaces client directly to
|
|
475
511
|
* WorkSpaces to troubleshoot issues when using the WorkSpaces client.
|
|
476
512
|
* When enabled, the log files will be sent to WorkSpaces automatically and will be applied to all
|
|
@@ -484,10 +520,12 @@ export interface ClientProperties {
|
|
|
484
520
|
*/
|
|
485
521
|
export interface ClientPropertiesResult {
|
|
486
522
|
/**
|
|
523
|
+
* @public
|
|
487
524
|
* <p>The resource identifier, in the form of a directory ID.</p>
|
|
488
525
|
*/
|
|
489
526
|
ResourceId?: string;
|
|
490
527
|
/**
|
|
528
|
+
* @public
|
|
491
529
|
* <p>Information about the Amazon WorkSpaces client.</p>
|
|
492
530
|
*/
|
|
493
531
|
ClientProperties?: ClientProperties;
|
|
@@ -498,18 +536,22 @@ export interface ClientPropertiesResult {
|
|
|
498
536
|
*/
|
|
499
537
|
export interface ConnectClientAddIn {
|
|
500
538
|
/**
|
|
539
|
+
* @public
|
|
501
540
|
* <p>The client add-in identifier.</p>
|
|
502
541
|
*/
|
|
503
542
|
AddInId?: string;
|
|
504
543
|
/**
|
|
544
|
+
* @public
|
|
505
545
|
* <p>The directory identifier for which the client add-in is configured.</p>
|
|
506
546
|
*/
|
|
507
547
|
ResourceId?: string;
|
|
508
548
|
/**
|
|
549
|
+
* @public
|
|
509
550
|
* <p>The name of the client add in.</p>
|
|
510
551
|
*/
|
|
511
552
|
Name?: string;
|
|
512
553
|
/**
|
|
554
|
+
* @public
|
|
513
555
|
* <p>The endpoint URL of the client add-in.</p>
|
|
514
556
|
*/
|
|
515
557
|
URL?: string;
|
|
@@ -522,19 +564,23 @@ export interface ConnectClientAddIn {
|
|
|
522
564
|
*/
|
|
523
565
|
export interface ConnectionAliasAssociation {
|
|
524
566
|
/**
|
|
567
|
+
* @public
|
|
525
568
|
* <p>The association status of the connection alias.</p>
|
|
526
569
|
*/
|
|
527
570
|
AssociationStatus?: AssociationStatus | string;
|
|
528
571
|
/**
|
|
572
|
+
* @public
|
|
529
573
|
* <p>The identifier of the Amazon Web Services account that associated the connection alias
|
|
530
574
|
* with a directory.</p>
|
|
531
575
|
*/
|
|
532
576
|
AssociatedAccountId?: string;
|
|
533
577
|
/**
|
|
578
|
+
* @public
|
|
534
579
|
* <p>The identifier of the directory associated with a connection alias.</p>
|
|
535
580
|
*/
|
|
536
581
|
ResourceId?: string;
|
|
537
582
|
/**
|
|
583
|
+
* @public
|
|
538
584
|
* <p>The identifier of the connection alias association. You use the connection identifier in
|
|
539
585
|
* the DNS TXT record when you're configuring your DNS routing policies.</p>
|
|
540
586
|
*/
|
|
@@ -561,24 +607,29 @@ export type ConnectionAliasState = (typeof ConnectionAliasState)[keyof typeof Co
|
|
|
561
607
|
*/
|
|
562
608
|
export interface ConnectionAlias {
|
|
563
609
|
/**
|
|
610
|
+
* @public
|
|
564
611
|
* <p>The connection string specified for the connection alias. The connection string must be
|
|
565
612
|
* in the form of a fully qualified domain name (FQDN), such as
|
|
566
613
|
* <code>www.example.com</code>.</p>
|
|
567
614
|
*/
|
|
568
615
|
ConnectionString?: string;
|
|
569
616
|
/**
|
|
617
|
+
* @public
|
|
570
618
|
* <p>The identifier of the connection alias.</p>
|
|
571
619
|
*/
|
|
572
620
|
AliasId?: string;
|
|
573
621
|
/**
|
|
622
|
+
* @public
|
|
574
623
|
* <p>The current state of the connection alias.</p>
|
|
575
624
|
*/
|
|
576
625
|
State?: ConnectionAliasState | string;
|
|
577
626
|
/**
|
|
627
|
+
* @public
|
|
578
628
|
* <p>The identifier of the Amazon Web Services account that owns the connection alias.</p>
|
|
579
629
|
*/
|
|
580
630
|
OwnerAccountId?: string;
|
|
581
631
|
/**
|
|
632
|
+
* @public
|
|
582
633
|
* <p>The association status of the connection alias.</p>
|
|
583
634
|
*/
|
|
584
635
|
Associations?: ConnectionAliasAssociation[];
|
|
@@ -591,11 +642,13 @@ export interface ConnectionAlias {
|
|
|
591
642
|
*/
|
|
592
643
|
export interface ConnectionAliasPermission {
|
|
593
644
|
/**
|
|
645
|
+
* @public
|
|
594
646
|
* <p>The identifier of the Amazon Web Services account that the connection alias is shared
|
|
595
647
|
* with.</p>
|
|
596
648
|
*/
|
|
597
649
|
SharedAccountId: string | undefined;
|
|
598
650
|
/**
|
|
651
|
+
* @public
|
|
599
652
|
* <p>Indicates whether the specified Amazon Web Services account is allowed to associate the
|
|
600
653
|
* connection alias with a directory.</p>
|
|
601
654
|
*/
|
|
@@ -620,10 +673,12 @@ export type ConnectionState = (typeof ConnectionState)[keyof typeof ConnectionSt
|
|
|
620
673
|
*/
|
|
621
674
|
export interface Tag {
|
|
622
675
|
/**
|
|
676
|
+
* @public
|
|
623
677
|
* <p>The key of the tag.</p>
|
|
624
678
|
*/
|
|
625
679
|
Key: string | undefined;
|
|
626
680
|
/**
|
|
681
|
+
* @public
|
|
627
682
|
* <p>The value of the tag.</p>
|
|
628
683
|
*/
|
|
629
684
|
Value?: string;
|
|
@@ -633,22 +688,27 @@ export interface Tag {
|
|
|
633
688
|
*/
|
|
634
689
|
export interface CopyWorkspaceImageRequest {
|
|
635
690
|
/**
|
|
691
|
+
* @public
|
|
636
692
|
* <p>The name of the image.</p>
|
|
637
693
|
*/
|
|
638
694
|
Name: string | undefined;
|
|
639
695
|
/**
|
|
696
|
+
* @public
|
|
640
697
|
* <p>A description of the image.</p>
|
|
641
698
|
*/
|
|
642
699
|
Description?: string;
|
|
643
700
|
/**
|
|
701
|
+
* @public
|
|
644
702
|
* <p>The identifier of the source image.</p>
|
|
645
703
|
*/
|
|
646
704
|
SourceImageId: string | undefined;
|
|
647
705
|
/**
|
|
706
|
+
* @public
|
|
648
707
|
* <p>The identifier of the source Region.</p>
|
|
649
708
|
*/
|
|
650
709
|
SourceRegion: string | undefined;
|
|
651
710
|
/**
|
|
711
|
+
* @public
|
|
652
712
|
* <p>The tags for the image.</p>
|
|
653
713
|
*/
|
|
654
714
|
Tags?: Tag[];
|
|
@@ -658,6 +718,7 @@ export interface CopyWorkspaceImageRequest {
|
|
|
658
718
|
*/
|
|
659
719
|
export interface CopyWorkspaceImageResult {
|
|
660
720
|
/**
|
|
721
|
+
* @public
|
|
661
722
|
* <p>The identifier of the image.</p>
|
|
662
723
|
*/
|
|
663
724
|
ImageId?: string;
|
|
@@ -682,6 +743,7 @@ export declare class ResourceUnavailableException extends __BaseException {
|
|
|
682
743
|
readonly name: "ResourceUnavailableException";
|
|
683
744
|
readonly $fault: "client";
|
|
684
745
|
/**
|
|
746
|
+
* @public
|
|
685
747
|
* <p>The identifier of the resource that is not available.</p>
|
|
686
748
|
*/
|
|
687
749
|
ResourceId?: string;
|
|
@@ -695,14 +757,17 @@ export declare class ResourceUnavailableException extends __BaseException {
|
|
|
695
757
|
*/
|
|
696
758
|
export interface CreateConnectClientAddInRequest {
|
|
697
759
|
/**
|
|
760
|
+
* @public
|
|
698
761
|
* <p>The directory identifier for which to configure the client add-in.</p>
|
|
699
762
|
*/
|
|
700
763
|
ResourceId: string | undefined;
|
|
701
764
|
/**
|
|
765
|
+
* @public
|
|
702
766
|
* <p>The name of the client add-in.</p>
|
|
703
767
|
*/
|
|
704
768
|
Name: string | undefined;
|
|
705
769
|
/**
|
|
770
|
+
* @public
|
|
706
771
|
* <p>The endpoint URL of the Amazon Connect client add-in.</p>
|
|
707
772
|
*/
|
|
708
773
|
URL: string | undefined;
|
|
@@ -712,6 +777,7 @@ export interface CreateConnectClientAddInRequest {
|
|
|
712
777
|
*/
|
|
713
778
|
export interface CreateConnectClientAddInResult {
|
|
714
779
|
/**
|
|
780
|
+
* @public
|
|
715
781
|
* <p>The client add-in identifier.</p>
|
|
716
782
|
*/
|
|
717
783
|
AddInId?: string;
|
|
@@ -733,6 +799,7 @@ export declare class ResourceCreationFailedException extends __BaseException {
|
|
|
733
799
|
*/
|
|
734
800
|
export interface CreateConnectionAliasRequest {
|
|
735
801
|
/**
|
|
802
|
+
* @public
|
|
736
803
|
* <p>A connection string in the form of a fully qualified domain name (FQDN), such as
|
|
737
804
|
* <code>www.example.com</code>.</p>
|
|
738
805
|
* <important>
|
|
@@ -743,6 +810,7 @@ export interface CreateConnectionAliasRequest {
|
|
|
743
810
|
*/
|
|
744
811
|
ConnectionString: string | undefined;
|
|
745
812
|
/**
|
|
813
|
+
* @public
|
|
746
814
|
* <p>The tags to associate with the connection alias.</p>
|
|
747
815
|
*/
|
|
748
816
|
Tags?: Tag[];
|
|
@@ -752,6 +820,7 @@ export interface CreateConnectionAliasRequest {
|
|
|
752
820
|
*/
|
|
753
821
|
export interface CreateConnectionAliasResult {
|
|
754
822
|
/**
|
|
823
|
+
* @public
|
|
755
824
|
* <p>The identifier of the connection alias.</p>
|
|
756
825
|
*/
|
|
757
826
|
AliasId?: string;
|
|
@@ -761,18 +830,22 @@ export interface CreateConnectionAliasResult {
|
|
|
761
830
|
*/
|
|
762
831
|
export interface CreateIpGroupRequest {
|
|
763
832
|
/**
|
|
833
|
+
* @public
|
|
764
834
|
* <p>The name of the group.</p>
|
|
765
835
|
*/
|
|
766
836
|
GroupName: string | undefined;
|
|
767
837
|
/**
|
|
838
|
+
* @public
|
|
768
839
|
* <p>The description of the group.</p>
|
|
769
840
|
*/
|
|
770
841
|
GroupDesc?: string;
|
|
771
842
|
/**
|
|
843
|
+
* @public
|
|
772
844
|
* <p>The rules to add to the group.</p>
|
|
773
845
|
*/
|
|
774
846
|
UserRules?: IpRuleItem[];
|
|
775
847
|
/**
|
|
848
|
+
* @public
|
|
776
849
|
* <p>The tags. Each WorkSpaces resource can have a maximum of 50 tags.</p>
|
|
777
850
|
*/
|
|
778
851
|
Tags?: Tag[];
|
|
@@ -782,6 +855,7 @@ export interface CreateIpGroupRequest {
|
|
|
782
855
|
*/
|
|
783
856
|
export interface CreateIpGroupResult {
|
|
784
857
|
/**
|
|
858
|
+
* @public
|
|
785
859
|
* <p>The identifier of the group.</p>
|
|
786
860
|
*/
|
|
787
861
|
GroupId?: string;
|
|
@@ -792,18 +866,22 @@ export interface CreateIpGroupResult {
|
|
|
792
866
|
*/
|
|
793
867
|
export interface StandbyWorkspace {
|
|
794
868
|
/**
|
|
869
|
+
* @public
|
|
795
870
|
* <p>The identifier of the standby WorkSpace.</p>
|
|
796
871
|
*/
|
|
797
872
|
PrimaryWorkspaceId: string | undefined;
|
|
798
873
|
/**
|
|
874
|
+
* @public
|
|
799
875
|
* <p>The volume encryption key of the standby WorkSpace.</p>
|
|
800
876
|
*/
|
|
801
877
|
VolumeEncryptionKey?: string;
|
|
802
878
|
/**
|
|
879
|
+
* @public
|
|
803
880
|
* <p>The identifier of the directory for the standby WorkSpace.</p>
|
|
804
881
|
*/
|
|
805
882
|
DirectoryId: string | undefined;
|
|
806
883
|
/**
|
|
884
|
+
* @public
|
|
807
885
|
* <p>The tags associated with the standby WorkSpace.</p>
|
|
808
886
|
*/
|
|
809
887
|
Tags?: Tag[];
|
|
@@ -813,10 +891,12 @@ export interface StandbyWorkspace {
|
|
|
813
891
|
*/
|
|
814
892
|
export interface CreateStandbyWorkspacesRequest {
|
|
815
893
|
/**
|
|
894
|
+
* @public
|
|
816
895
|
* <p>The Region of the primary WorkSpace.</p>
|
|
817
896
|
*/
|
|
818
897
|
PrimaryRegion: string | undefined;
|
|
819
898
|
/**
|
|
899
|
+
* @public
|
|
820
900
|
* <p>Information about the standby WorkSpace to be created.</p>
|
|
821
901
|
*/
|
|
822
902
|
StandbyWorkspaces: StandbyWorkspace[] | undefined;
|
|
@@ -827,14 +907,17 @@ export interface CreateStandbyWorkspacesRequest {
|
|
|
827
907
|
*/
|
|
828
908
|
export interface FailedCreateStandbyWorkspacesRequest {
|
|
829
909
|
/**
|
|
910
|
+
* @public
|
|
830
911
|
* <p>Information about the standby WorkSpace that could not be created.</p>
|
|
831
912
|
*/
|
|
832
913
|
StandbyWorkspaceRequest?: StandbyWorkspace;
|
|
833
914
|
/**
|
|
915
|
+
* @public
|
|
834
916
|
* <p>The error code that is returned if the standby WorkSpace could not be created.</p>
|
|
835
917
|
*/
|
|
836
918
|
ErrorCode?: string;
|
|
837
919
|
/**
|
|
920
|
+
* @public
|
|
838
921
|
* <p>The text of the error message that is returned if the standby WorkSpace could not be created.</p>
|
|
839
922
|
*/
|
|
840
923
|
ErrorMessage?: string;
|
|
@@ -872,6 +955,7 @@ export type WorkspaceState = (typeof WorkspaceState)[keyof typeof WorkspaceState
|
|
|
872
955
|
*/
|
|
873
956
|
export interface PendingCreateStandbyWorkspacesRequest {
|
|
874
957
|
/**
|
|
958
|
+
* @public
|
|
875
959
|
* <p>Describes the standby WorkSpace that was created.</p>
|
|
876
960
|
* <p>Because this operation is asynchronous, the identifier returned is not immediately
|
|
877
961
|
* available for use with other operations. For example, if you call
|
|
@@ -881,14 +965,17 @@ export interface PendingCreateStandbyWorkspacesRequest {
|
|
|
881
965
|
*/
|
|
882
966
|
UserName?: string;
|
|
883
967
|
/**
|
|
968
|
+
* @public
|
|
884
969
|
* <p>The identifier of the directory for the standby WorkSpace.</p>
|
|
885
970
|
*/
|
|
886
971
|
DirectoryId?: string;
|
|
887
972
|
/**
|
|
973
|
+
* @public
|
|
888
974
|
* <p>The operational state of the standby WorkSpace.</p>
|
|
889
975
|
*/
|
|
890
976
|
State?: WorkspaceState | string;
|
|
891
977
|
/**
|
|
978
|
+
* @public
|
|
892
979
|
* <p>The identifier of the standby WorkSpace.</p>
|
|
893
980
|
*/
|
|
894
981
|
WorkspaceId?: string;
|
|
@@ -898,10 +985,12 @@ export interface PendingCreateStandbyWorkspacesRequest {
|
|
|
898
985
|
*/
|
|
899
986
|
export interface CreateStandbyWorkspacesResult {
|
|
900
987
|
/**
|
|
988
|
+
* @public
|
|
901
989
|
* <p>Information about the standby WorkSpace that could not be created. </p>
|
|
902
990
|
*/
|
|
903
991
|
FailedStandbyRequests?: FailedCreateStandbyWorkspacesRequest[];
|
|
904
992
|
/**
|
|
993
|
+
* @public
|
|
905
994
|
* <p>Information about the standby WorkSpace that was created.</p>
|
|
906
995
|
*/
|
|
907
996
|
PendingStandbyRequests?: PendingCreateStandbyWorkspacesRequest[];
|
|
@@ -911,12 +1000,14 @@ export interface CreateStandbyWorkspacesResult {
|
|
|
911
1000
|
*/
|
|
912
1001
|
export interface CreateTagsRequest {
|
|
913
1002
|
/**
|
|
1003
|
+
* @public
|
|
914
1004
|
* <p>The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces,
|
|
915
1005
|
* registered directories, images, custom bundles, IP access control groups, and connection
|
|
916
1006
|
* aliases.</p>
|
|
917
1007
|
*/
|
|
918
1008
|
ResourceId: string | undefined;
|
|
919
1009
|
/**
|
|
1010
|
+
* @public
|
|
920
1011
|
* <p>The tags. Each WorkSpaces resource can have a maximum of 50 tags.</p>
|
|
921
1012
|
*/
|
|
922
1013
|
Tags: Tag[] | undefined;
|
|
@@ -931,18 +1022,22 @@ export interface CreateTagsResult {
|
|
|
931
1022
|
*/
|
|
932
1023
|
export interface CreateUpdatedWorkspaceImageRequest {
|
|
933
1024
|
/**
|
|
1025
|
+
* @public
|
|
934
1026
|
* <p>The name of the new updated WorkSpace image.</p>
|
|
935
1027
|
*/
|
|
936
1028
|
Name: string | undefined;
|
|
937
1029
|
/**
|
|
1030
|
+
* @public
|
|
938
1031
|
* <p>A description of whether updates for the WorkSpace image are available.</p>
|
|
939
1032
|
*/
|
|
940
1033
|
Description: string | undefined;
|
|
941
1034
|
/**
|
|
1035
|
+
* @public
|
|
942
1036
|
* <p>The identifier of the source WorkSpace image.</p>
|
|
943
1037
|
*/
|
|
944
1038
|
SourceImageId: string | undefined;
|
|
945
1039
|
/**
|
|
1040
|
+
* @public
|
|
946
1041
|
* <p>The tags that you want to add to the new updated WorkSpace image.</p>
|
|
947
1042
|
* <note>
|
|
948
1043
|
* <p>To add tags at the same time when you're creating the updated image, you must create
|
|
@@ -957,6 +1052,7 @@ export interface CreateUpdatedWorkspaceImageRequest {
|
|
|
957
1052
|
*/
|
|
958
1053
|
export interface CreateUpdatedWorkspaceImageResult {
|
|
959
1054
|
/**
|
|
1055
|
+
* @public
|
|
960
1056
|
* <p>The identifier of the new updated WorkSpace image.</p>
|
|
961
1057
|
*/
|
|
962
1058
|
ImageId?: string;
|
|
@@ -966,30 +1062,37 @@ export interface CreateUpdatedWorkspaceImageResult {
|
|
|
966
1062
|
*/
|
|
967
1063
|
export interface CreateWorkspaceBundleRequest {
|
|
968
1064
|
/**
|
|
1065
|
+
* @public
|
|
969
1066
|
* <p>The name of the bundle.</p>
|
|
970
1067
|
*/
|
|
971
1068
|
BundleName: string | undefined;
|
|
972
1069
|
/**
|
|
1070
|
+
* @public
|
|
973
1071
|
* <p>The description of the bundle.</p>
|
|
974
1072
|
*/
|
|
975
1073
|
BundleDescription: string | undefined;
|
|
976
1074
|
/**
|
|
1075
|
+
* @public
|
|
977
1076
|
* <p>The identifier of the image that is used to create the bundle.</p>
|
|
978
1077
|
*/
|
|
979
1078
|
ImageId: string | undefined;
|
|
980
1079
|
/**
|
|
1080
|
+
* @public
|
|
981
1081
|
* <p>Describes the compute type of the bundle.</p>
|
|
982
1082
|
*/
|
|
983
1083
|
ComputeType: ComputeType | undefined;
|
|
984
1084
|
/**
|
|
1085
|
+
* @public
|
|
985
1086
|
* <p>Describes the user volume for a WorkSpace bundle.</p>
|
|
986
1087
|
*/
|
|
987
1088
|
UserStorage: UserStorage | undefined;
|
|
988
1089
|
/**
|
|
1090
|
+
* @public
|
|
989
1091
|
* <p>Describes the root volume for a WorkSpace bundle.</p>
|
|
990
1092
|
*/
|
|
991
1093
|
RootStorage?: RootStorage;
|
|
992
1094
|
/**
|
|
1095
|
+
* @public
|
|
993
1096
|
* <p>The tags associated with the bundle.</p>
|
|
994
1097
|
* <note>
|
|
995
1098
|
* <p>To add tags at the same time when you're creating the bundle, you must create an IAM policy that
|
|
@@ -1003,6 +1106,7 @@ export interface CreateWorkspaceBundleRequest {
|
|
|
1003
1106
|
*/
|
|
1004
1107
|
export interface CreateWorkspaceBundleResult {
|
|
1005
1108
|
/**
|
|
1109
|
+
* @public
|
|
1006
1110
|
* <p>Describes a WorkSpace bundle.</p>
|
|
1007
1111
|
*/
|
|
1008
1112
|
WorkspaceBundle?: WorkspaceBundle;
|
|
@@ -1012,18 +1116,22 @@ export interface CreateWorkspaceBundleResult {
|
|
|
1012
1116
|
*/
|
|
1013
1117
|
export interface CreateWorkspaceImageRequest {
|
|
1014
1118
|
/**
|
|
1119
|
+
* @public
|
|
1015
1120
|
* <p>The name of the new WorkSpace image.</p>
|
|
1016
1121
|
*/
|
|
1017
1122
|
Name: string | undefined;
|
|
1018
1123
|
/**
|
|
1124
|
+
* @public
|
|
1019
1125
|
* <p>The description of the new WorkSpace image.</p>
|
|
1020
1126
|
*/
|
|
1021
1127
|
Description: string | undefined;
|
|
1022
1128
|
/**
|
|
1129
|
+
* @public
|
|
1023
1130
|
* <p>The identifier of the source WorkSpace</p>
|
|
1024
1131
|
*/
|
|
1025
1132
|
WorkspaceId: string | undefined;
|
|
1026
1133
|
/**
|
|
1134
|
+
* @public
|
|
1027
1135
|
* <p>The tags that you want to add to the new WorkSpace image.
|
|
1028
1136
|
* To add tags when you're creating the image, you must create an IAM policy that grants
|
|
1029
1137
|
* your IAM user permission to use <code>workspaces:CreateTags</code>.</p>
|
|
@@ -1048,6 +1156,7 @@ export type OperatingSystemType = (typeof OperatingSystemType)[keyof typeof Oper
|
|
|
1048
1156
|
*/
|
|
1049
1157
|
export interface OperatingSystem {
|
|
1050
1158
|
/**
|
|
1159
|
+
* @public
|
|
1051
1160
|
* <p>The operating system.</p>
|
|
1052
1161
|
*/
|
|
1053
1162
|
Type?: OperatingSystemType | string;
|
|
@@ -1082,26 +1191,32 @@ export type WorkspaceImageState = (typeof WorkspaceImageState)[keyof typeof Work
|
|
|
1082
1191
|
*/
|
|
1083
1192
|
export interface CreateWorkspaceImageResult {
|
|
1084
1193
|
/**
|
|
1194
|
+
* @public
|
|
1085
1195
|
* <p>The identifier of the new WorkSpace image.</p>
|
|
1086
1196
|
*/
|
|
1087
1197
|
ImageId?: string;
|
|
1088
1198
|
/**
|
|
1199
|
+
* @public
|
|
1089
1200
|
* <p>The name of the image.</p>
|
|
1090
1201
|
*/
|
|
1091
1202
|
Name?: string;
|
|
1092
1203
|
/**
|
|
1204
|
+
* @public
|
|
1093
1205
|
* <p>The description of the image.</p>
|
|
1094
1206
|
*/
|
|
1095
1207
|
Description?: string;
|
|
1096
1208
|
/**
|
|
1209
|
+
* @public
|
|
1097
1210
|
* <p>The operating system that the image is running.</p>
|
|
1098
1211
|
*/
|
|
1099
1212
|
OperatingSystem?: OperatingSystem;
|
|
1100
1213
|
/**
|
|
1214
|
+
* @public
|
|
1101
1215
|
* <p>The availability status of the image.</p>
|
|
1102
1216
|
*/
|
|
1103
1217
|
State?: WorkspaceImageState | string;
|
|
1104
1218
|
/**
|
|
1219
|
+
* @public
|
|
1105
1220
|
* <p>Specifies whether the image is running on dedicated hardware.
|
|
1106
1221
|
* When Bring Your Own License (BYOL) is enabled, this value is set
|
|
1107
1222
|
* to DEDICATED. For more information, see
|
|
@@ -1110,10 +1225,12 @@ export interface CreateWorkspaceImageResult {
|
|
|
1110
1225
|
*/
|
|
1111
1226
|
RequiredTenancy?: WorkspaceImageRequiredTenancy | string;
|
|
1112
1227
|
/**
|
|
1228
|
+
* @public
|
|
1113
1229
|
* <p>The date when the image was created.</p>
|
|
1114
1230
|
*/
|
|
1115
1231
|
Created?: Date;
|
|
1116
1232
|
/**
|
|
1233
|
+
* @public
|
|
1117
1234
|
* <p>The identifier of the Amazon Web Services account that owns the image.</p>
|
|
1118
1235
|
*/
|
|
1119
1236
|
OwnerAccountId?: string;
|
|
@@ -1149,6 +1266,7 @@ export type RunningMode = (typeof RunningMode)[keyof typeof RunningMode];
|
|
|
1149
1266
|
*/
|
|
1150
1267
|
export interface WorkspaceProperties {
|
|
1151
1268
|
/**
|
|
1269
|
+
* @public
|
|
1152
1270
|
* <p>The running mode. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html">Manage the WorkSpace Running
|
|
1153
1271
|
* Mode</a>.</p>
|
|
1154
1272
|
* <note>
|
|
@@ -1159,28 +1277,33 @@ export interface WorkspaceProperties {
|
|
|
1159
1277
|
*/
|
|
1160
1278
|
RunningMode?: RunningMode | string;
|
|
1161
1279
|
/**
|
|
1280
|
+
* @public
|
|
1162
1281
|
* <p>The time after a user logs off when WorkSpaces are automatically stopped. Configured in
|
|
1163
1282
|
* 60-minute intervals.</p>
|
|
1164
1283
|
*/
|
|
1165
1284
|
RunningModeAutoStopTimeoutInMinutes?: number;
|
|
1166
1285
|
/**
|
|
1286
|
+
* @public
|
|
1167
1287
|
* <p>The size of the root volume. For important information about how to modify the size of
|
|
1168
1288
|
* the root and user volumes, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html">Modify a
|
|
1169
1289
|
* WorkSpace</a>.</p>
|
|
1170
1290
|
*/
|
|
1171
1291
|
RootVolumeSizeGib?: number;
|
|
1172
1292
|
/**
|
|
1293
|
+
* @public
|
|
1173
1294
|
* <p>The size of the user storage. For important information about how to modify the size of
|
|
1174
1295
|
* the root and user volumes, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html">Modify a
|
|
1175
1296
|
* WorkSpace</a>.</p>
|
|
1176
1297
|
*/
|
|
1177
1298
|
UserVolumeSizeGib?: number;
|
|
1178
1299
|
/**
|
|
1300
|
+
* @public
|
|
1179
1301
|
* <p>The compute type. For more information, see <a href="http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles">Amazon WorkSpaces
|
|
1180
1302
|
* Bundles</a>.</p>
|
|
1181
1303
|
*/
|
|
1182
1304
|
ComputeTypeName?: Compute | string;
|
|
1183
1305
|
/**
|
|
1306
|
+
* @public
|
|
1184
1307
|
* <p>The protocol. For more information, see
|
|
1185
1308
|
* <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-protocols.html">
|
|
1186
1309
|
* Protocols for Amazon WorkSpaces</a>.</p>
|
|
@@ -1207,35 +1330,43 @@ export interface WorkspaceProperties {
|
|
|
1207
1330
|
*/
|
|
1208
1331
|
export interface WorkspaceRequest {
|
|
1209
1332
|
/**
|
|
1333
|
+
* @public
|
|
1210
1334
|
* <p>The identifier of the Directory Service directory for the WorkSpace. You can use <a>DescribeWorkspaceDirectories</a> to list the available directories.</p>
|
|
1211
1335
|
*/
|
|
1212
1336
|
DirectoryId: string | undefined;
|
|
1213
1337
|
/**
|
|
1338
|
+
* @public
|
|
1214
1339
|
* <p>The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.</p>
|
|
1215
1340
|
*/
|
|
1216
1341
|
UserName: string | undefined;
|
|
1217
1342
|
/**
|
|
1343
|
+
* @public
|
|
1218
1344
|
* <p>The identifier of the bundle for the WorkSpace. You can use <a>DescribeWorkspaceBundles</a> to list the available bundles.</p>
|
|
1219
1345
|
*/
|
|
1220
1346
|
BundleId: string | undefined;
|
|
1221
1347
|
/**
|
|
1348
|
+
* @public
|
|
1222
1349
|
* <p>The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace.
|
|
1223
1350
|
* Amazon WorkSpaces does not support asymmetric KMS keys.</p>
|
|
1224
1351
|
*/
|
|
1225
1352
|
VolumeEncryptionKey?: string;
|
|
1226
1353
|
/**
|
|
1354
|
+
* @public
|
|
1227
1355
|
* <p>Indicates whether the data stored on the user volume is encrypted.</p>
|
|
1228
1356
|
*/
|
|
1229
1357
|
UserVolumeEncryptionEnabled?: boolean;
|
|
1230
1358
|
/**
|
|
1359
|
+
* @public
|
|
1231
1360
|
* <p>Indicates whether the data stored on the root volume is encrypted.</p>
|
|
1232
1361
|
*/
|
|
1233
1362
|
RootVolumeEncryptionEnabled?: boolean;
|
|
1234
1363
|
/**
|
|
1364
|
+
* @public
|
|
1235
1365
|
* <p>The WorkSpace properties.</p>
|
|
1236
1366
|
*/
|
|
1237
1367
|
WorkspaceProperties?: WorkspaceProperties;
|
|
1238
1368
|
/**
|
|
1369
|
+
* @public
|
|
1239
1370
|
* <p>The tags for the WorkSpace.</p>
|
|
1240
1371
|
*/
|
|
1241
1372
|
Tags?: Tag[];
|
|
@@ -1245,6 +1376,7 @@ export interface WorkspaceRequest {
|
|
|
1245
1376
|
*/
|
|
1246
1377
|
export interface CreateWorkspacesRequest {
|
|
1247
1378
|
/**
|
|
1379
|
+
* @public
|
|
1248
1380
|
* <p>The WorkSpaces to create. You can specify up to 25 WorkSpaces.</p>
|
|
1249
1381
|
*/
|
|
1250
1382
|
Workspaces: WorkspaceRequest[] | undefined;
|
|
@@ -1255,14 +1387,17 @@ export interface CreateWorkspacesRequest {
|
|
|
1255
1387
|
*/
|
|
1256
1388
|
export interface FailedCreateWorkspaceRequest {
|
|
1257
1389
|
/**
|
|
1390
|
+
* @public
|
|
1258
1391
|
* <p>Information about the WorkSpace.</p>
|
|
1259
1392
|
*/
|
|
1260
1393
|
WorkspaceRequest?: WorkspaceRequest;
|
|
1261
1394
|
/**
|
|
1395
|
+
* @public
|
|
1262
1396
|
* <p>The error code that is returned if the WorkSpace cannot be created.</p>
|
|
1263
1397
|
*/
|
|
1264
1398
|
ErrorCode?: string;
|
|
1265
1399
|
/**
|
|
1400
|
+
* @public
|
|
1266
1401
|
* <p>The text of the error message that is returned if the WorkSpace cannot be
|
|
1267
1402
|
* created.</p>
|
|
1268
1403
|
*/
|
|
@@ -1299,10 +1434,12 @@ export type ModificationStateEnum = (typeof ModificationStateEnum)[keyof typeof
|
|
|
1299
1434
|
*/
|
|
1300
1435
|
export interface ModificationState {
|
|
1301
1436
|
/**
|
|
1437
|
+
* @public
|
|
1302
1438
|
* <p>The resource.</p>
|
|
1303
1439
|
*/
|
|
1304
1440
|
Resource?: ModificationResourceEnum | string;
|
|
1305
1441
|
/**
|
|
1442
|
+
* @public
|
|
1306
1443
|
* <p>The modification state.</p>
|
|
1307
1444
|
*/
|
|
1308
1445
|
State?: ModificationStateEnum | string;
|
|
@@ -1326,18 +1463,22 @@ export type StandbyWorkspaceRelationshipType = (typeof StandbyWorkspaceRelations
|
|
|
1326
1463
|
*/
|
|
1327
1464
|
export interface RelatedWorkspaceProperties {
|
|
1328
1465
|
/**
|
|
1466
|
+
* @public
|
|
1329
1467
|
* <p>The identifier of the related WorkSpace.</p>
|
|
1330
1468
|
*/
|
|
1331
1469
|
WorkspaceId?: string;
|
|
1332
1470
|
/**
|
|
1471
|
+
* @public
|
|
1333
1472
|
* <p>The Region of the related WorkSpace.</p>
|
|
1334
1473
|
*/
|
|
1335
1474
|
Region?: string;
|
|
1336
1475
|
/**
|
|
1476
|
+
* @public
|
|
1337
1477
|
* <p>Indicates the state of the WorkSpace.</p>
|
|
1338
1478
|
*/
|
|
1339
1479
|
State?: WorkspaceState | string;
|
|
1340
1480
|
/**
|
|
1481
|
+
* @public
|
|
1341
1482
|
* <p>Indicates the type of WorkSpace.</p>
|
|
1342
1483
|
*/
|
|
1343
1484
|
Type?: StandbyWorkspaceRelationshipType | string;
|
|
@@ -1348,22 +1489,27 @@ export interface RelatedWorkspaceProperties {
|
|
|
1348
1489
|
*/
|
|
1349
1490
|
export interface Workspace {
|
|
1350
1491
|
/**
|
|
1492
|
+
* @public
|
|
1351
1493
|
* <p>The identifier of the WorkSpace.</p>
|
|
1352
1494
|
*/
|
|
1353
1495
|
WorkspaceId?: string;
|
|
1354
1496
|
/**
|
|
1497
|
+
* @public
|
|
1355
1498
|
* <p>The identifier of the Directory Service directory for the WorkSpace.</p>
|
|
1356
1499
|
*/
|
|
1357
1500
|
DirectoryId?: string;
|
|
1358
1501
|
/**
|
|
1502
|
+
* @public
|
|
1359
1503
|
* <p>The user for the WorkSpace.</p>
|
|
1360
1504
|
*/
|
|
1361
1505
|
UserName?: string;
|
|
1362
1506
|
/**
|
|
1507
|
+
* @public
|
|
1363
1508
|
* <p>The IP address of the WorkSpace.</p>
|
|
1364
1509
|
*/
|
|
1365
1510
|
IpAddress?: string;
|
|
1366
1511
|
/**
|
|
1512
|
+
* @public
|
|
1367
1513
|
* <p>The operational state of the WorkSpace.</p>
|
|
1368
1514
|
* <note>
|
|
1369
1515
|
* <p>After a WorkSpace is terminated, the <code>TERMINATED</code> state is returned only
|
|
@@ -1376,50 +1522,61 @@ export interface Workspace {
|
|
|
1376
1522
|
*/
|
|
1377
1523
|
State?: WorkspaceState | string;
|
|
1378
1524
|
/**
|
|
1525
|
+
* @public
|
|
1379
1526
|
* <p>The identifier of the bundle used to create the WorkSpace.</p>
|
|
1380
1527
|
*/
|
|
1381
1528
|
BundleId?: string;
|
|
1382
1529
|
/**
|
|
1530
|
+
* @public
|
|
1383
1531
|
* <p>The identifier of the subnet for the WorkSpace.</p>
|
|
1384
1532
|
*/
|
|
1385
1533
|
SubnetId?: string;
|
|
1386
1534
|
/**
|
|
1535
|
+
* @public
|
|
1387
1536
|
* <p>The text of the error message that is returned if the WorkSpace cannot be
|
|
1388
1537
|
* created.</p>
|
|
1389
1538
|
*/
|
|
1390
1539
|
ErrorMessage?: string;
|
|
1391
1540
|
/**
|
|
1541
|
+
* @public
|
|
1392
1542
|
* <p>The error code that is returned if the WorkSpace cannot be created.</p>
|
|
1393
1543
|
*/
|
|
1394
1544
|
ErrorCode?: string;
|
|
1395
1545
|
/**
|
|
1546
|
+
* @public
|
|
1396
1547
|
* <p>The name of the WorkSpace, as seen by the operating system. The format of this name
|
|
1397
1548
|
* varies. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/launch-workspaces-tutorials.html"> Launch a
|
|
1398
1549
|
* WorkSpace</a>. </p>
|
|
1399
1550
|
*/
|
|
1400
1551
|
ComputerName?: string;
|
|
1401
1552
|
/**
|
|
1553
|
+
* @public
|
|
1402
1554
|
* <p>The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace.
|
|
1403
1555
|
* Amazon WorkSpaces does not support asymmetric KMS keys.</p>
|
|
1404
1556
|
*/
|
|
1405
1557
|
VolumeEncryptionKey?: string;
|
|
1406
1558
|
/**
|
|
1559
|
+
* @public
|
|
1407
1560
|
* <p>Indicates whether the data stored on the user volume is encrypted.</p>
|
|
1408
1561
|
*/
|
|
1409
1562
|
UserVolumeEncryptionEnabled?: boolean;
|
|
1410
1563
|
/**
|
|
1564
|
+
* @public
|
|
1411
1565
|
* <p>Indicates whether the data stored on the root volume is encrypted.</p>
|
|
1412
1566
|
*/
|
|
1413
1567
|
RootVolumeEncryptionEnabled?: boolean;
|
|
1414
1568
|
/**
|
|
1569
|
+
* @public
|
|
1415
1570
|
* <p>The properties of the WorkSpace.</p>
|
|
1416
1571
|
*/
|
|
1417
1572
|
WorkspaceProperties?: WorkspaceProperties;
|
|
1418
1573
|
/**
|
|
1574
|
+
* @public
|
|
1419
1575
|
* <p>The modification states of the WorkSpace.</p>
|
|
1420
1576
|
*/
|
|
1421
1577
|
ModificationStates?: ModificationState[];
|
|
1422
1578
|
/**
|
|
1579
|
+
* @public
|
|
1423
1580
|
* <p>The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.</p>
|
|
1424
1581
|
*/
|
|
1425
1582
|
RelatedWorkspaces?: RelatedWorkspaceProperties[];
|
|
@@ -1429,10 +1586,12 @@ export interface Workspace {
|
|
|
1429
1586
|
*/
|
|
1430
1587
|
export interface CreateWorkspacesResult {
|
|
1431
1588
|
/**
|
|
1589
|
+
* @public
|
|
1432
1590
|
* <p>Information about the WorkSpaces that could not be created.</p>
|
|
1433
1591
|
*/
|
|
1434
1592
|
FailedRequests?: FailedCreateWorkspaceRequest[];
|
|
1435
1593
|
/**
|
|
1594
|
+
* @public
|
|
1436
1595
|
* <p>Information about the WorkSpaces that were created.</p>
|
|
1437
1596
|
* <p>Because this operation is asynchronous, the identifier returned is not immediately
|
|
1438
1597
|
* available for use with other operations. For example, if you call <a>DescribeWorkspaces</a> before the WorkSpace is created, the information returned
|
|
@@ -1462,10 +1621,12 @@ export type DedicatedTenancySupportEnum = (typeof DedicatedTenancySupportEnum)[k
|
|
|
1462
1621
|
*/
|
|
1463
1622
|
export interface DefaultClientBrandingAttributes {
|
|
1464
1623
|
/**
|
|
1624
|
+
* @public
|
|
1465
1625
|
* <p>The logo. The only image format accepted is a binary data object that is converted from a <code>.png</code> file.</p>
|
|
1466
1626
|
*/
|
|
1467
1627
|
LogoUrl?: string;
|
|
1468
1628
|
/**
|
|
1629
|
+
* @public
|
|
1469
1630
|
* <p>The support email. The company's customer support email address.</p>
|
|
1470
1631
|
* <note>
|
|
1471
1632
|
* <ul>
|
|
@@ -1482,6 +1643,7 @@ export interface DefaultClientBrandingAttributes {
|
|
|
1482
1643
|
*/
|
|
1483
1644
|
SupportEmail?: string;
|
|
1484
1645
|
/**
|
|
1646
|
+
* @public
|
|
1485
1647
|
* <p>The support link. The link for the company's customer support page for their
|
|
1486
1648
|
* WorkSpace.</p>
|
|
1487
1649
|
* <note>
|
|
@@ -1499,11 +1661,13 @@ export interface DefaultClientBrandingAttributes {
|
|
|
1499
1661
|
*/
|
|
1500
1662
|
SupportLink?: string;
|
|
1501
1663
|
/**
|
|
1664
|
+
* @public
|
|
1502
1665
|
* <p>The forgotten password link. This is the web address that users can go to if they forget
|
|
1503
1666
|
* the password for their WorkSpace.</p>
|
|
1504
1667
|
*/
|
|
1505
1668
|
ForgotPasswordLink?: string;
|
|
1506
1669
|
/**
|
|
1670
|
+
* @public
|
|
1507
1671
|
* <p>The login message. Specified as a key value pair, in which the key is a locale and the
|
|
1508
1672
|
* value is the localized message for that locale. The only key supported is
|
|
1509
1673
|
* <code>en_US</code>. The HTML tags supported include the following: <code>a, b, blockquote, br, cite, code, dd, dl, dt, div, em,
|
|
@@ -1522,10 +1686,12 @@ export interface DefaultClientBrandingAttributes {
|
|
|
1522
1686
|
*/
|
|
1523
1687
|
export interface DefaultImportClientBrandingAttributes {
|
|
1524
1688
|
/**
|
|
1689
|
+
* @public
|
|
1525
1690
|
* <p>The logo. The only image format accepted is a binary data object that is converted from a <code>.png</code> file.</p>
|
|
1526
1691
|
*/
|
|
1527
1692
|
Logo?: Uint8Array;
|
|
1528
1693
|
/**
|
|
1694
|
+
* @public
|
|
1529
1695
|
* <p>The support email. The company's customer support email address.</p>
|
|
1530
1696
|
* <note>
|
|
1531
1697
|
* <ul>
|
|
@@ -1542,6 +1708,7 @@ export interface DefaultImportClientBrandingAttributes {
|
|
|
1542
1708
|
*/
|
|
1543
1709
|
SupportEmail?: string;
|
|
1544
1710
|
/**
|
|
1711
|
+
* @public
|
|
1545
1712
|
* <p>The support link. The link for the company's customer support page for their
|
|
1546
1713
|
* WorkSpace.</p>
|
|
1547
1714
|
* <note>
|
|
@@ -1559,11 +1726,13 @@ export interface DefaultImportClientBrandingAttributes {
|
|
|
1559
1726
|
*/
|
|
1560
1727
|
SupportLink?: string;
|
|
1561
1728
|
/**
|
|
1729
|
+
* @public
|
|
1562
1730
|
* <p>The forgotten password link. This is the web address that users can go to if they forget
|
|
1563
1731
|
* the password for their WorkSpace.</p>
|
|
1564
1732
|
*/
|
|
1565
1733
|
ForgotPasswordLink?: string;
|
|
1566
1734
|
/**
|
|
1735
|
+
* @public
|
|
1567
1736
|
* <p>The login message. Specified as a key value pair, in which the key is a locale and the
|
|
1568
1737
|
* value is the localized message for that locale. The only key supported is
|
|
1569
1738
|
* <code>en_US</code>. The HTML tags supported include the following: <code>a, b, blockquote, br, cite, code, dd, dl, dt, div, em,
|
|
@@ -1579,10 +1748,12 @@ export interface DefaultImportClientBrandingAttributes {
|
|
|
1579
1748
|
*/
|
|
1580
1749
|
export interface DefaultWorkspaceCreationProperties {
|
|
1581
1750
|
/**
|
|
1751
|
+
* @public
|
|
1582
1752
|
* <p>Specifies whether the directory is enabled for Amazon WorkDocs.</p>
|
|
1583
1753
|
*/
|
|
1584
1754
|
EnableWorkDocs?: boolean;
|
|
1585
1755
|
/**
|
|
1756
|
+
* @public
|
|
1586
1757
|
* <p>Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in
|
|
1587
1758
|
* this directory by default. If enabled, the Elastic public IP address allows outbound
|
|
1588
1759
|
* internet access from your WorkSpaces when you’re using an internet gateway in the Amazon
|
|
@@ -1595,20 +1766,24 @@ export interface DefaultWorkspaceCreationProperties {
|
|
|
1595
1766
|
*/
|
|
1596
1767
|
EnableInternetAccess?: boolean;
|
|
1597
1768
|
/**
|
|
1769
|
+
* @public
|
|
1598
1770
|
* <p>The organizational unit (OU) in the directory for the WorkSpace machine accounts.</p>
|
|
1599
1771
|
*/
|
|
1600
1772
|
DefaultOu?: string;
|
|
1601
1773
|
/**
|
|
1774
|
+
* @public
|
|
1602
1775
|
* <p>The identifier of the default security group to apply to WorkSpaces when they are
|
|
1603
1776
|
* created. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-security-groups.html"> Security
|
|
1604
1777
|
* Groups for Your WorkSpaces</a>.</p>
|
|
1605
1778
|
*/
|
|
1606
1779
|
CustomSecurityGroupId?: string;
|
|
1607
1780
|
/**
|
|
1781
|
+
* @public
|
|
1608
1782
|
* <p>Specifies whether WorkSpace users are local administrators on their WorkSpaces.</p>
|
|
1609
1783
|
*/
|
|
1610
1784
|
UserEnabledAsLocalAdministrator?: boolean;
|
|
1611
1785
|
/**
|
|
1786
|
+
* @public
|
|
1612
1787
|
* <p>Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see
|
|
1613
1788
|
* <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html">WorkSpace
|
|
1614
1789
|
* Maintenance</a>.</p>
|
|
@@ -1643,11 +1818,13 @@ export type DeletableSamlProperty = (typeof DeletableSamlProperty)[keyof typeof
|
|
|
1643
1818
|
*/
|
|
1644
1819
|
export interface DeleteClientBrandingRequest {
|
|
1645
1820
|
/**
|
|
1821
|
+
* @public
|
|
1646
1822
|
* <p>The directory identifier of the WorkSpace for which you want to delete client
|
|
1647
1823
|
* branding.</p>
|
|
1648
1824
|
*/
|
|
1649
1825
|
ResourceId: string | undefined;
|
|
1650
1826
|
/**
|
|
1827
|
+
* @public
|
|
1651
1828
|
* <p>The device type for which you want to delete client branding.</p>
|
|
1652
1829
|
*/
|
|
1653
1830
|
Platforms: (ClientDeviceType | string)[] | undefined;
|
|
@@ -1662,10 +1839,12 @@ export interface DeleteClientBrandingResult {
|
|
|
1662
1839
|
*/
|
|
1663
1840
|
export interface DeleteConnectClientAddInRequest {
|
|
1664
1841
|
/**
|
|
1842
|
+
* @public
|
|
1665
1843
|
* <p>The identifier of the client add-in to delete.</p>
|
|
1666
1844
|
*/
|
|
1667
1845
|
AddInId: string | undefined;
|
|
1668
1846
|
/**
|
|
1847
|
+
* @public
|
|
1669
1848
|
* <p>The directory identifier for which the client add-in is configured.</p>
|
|
1670
1849
|
*/
|
|
1671
1850
|
ResourceId: string | undefined;
|
|
@@ -1680,6 +1859,7 @@ export interface DeleteConnectClientAddInResult {
|
|
|
1680
1859
|
*/
|
|
1681
1860
|
export interface DeleteConnectionAliasRequest {
|
|
1682
1861
|
/**
|
|
1862
|
+
* @public
|
|
1683
1863
|
* <p>The identifier of the connection alias to delete.</p>
|
|
1684
1864
|
*/
|
|
1685
1865
|
AliasId: string | undefined;
|
|
@@ -1694,6 +1874,7 @@ export interface DeleteConnectionAliasResult {
|
|
|
1694
1874
|
*/
|
|
1695
1875
|
export interface DeleteIpGroupRequest {
|
|
1696
1876
|
/**
|
|
1877
|
+
* @public
|
|
1697
1878
|
* <p>The identifier of the IP access control group.</p>
|
|
1698
1879
|
*/
|
|
1699
1880
|
GroupId: string | undefined;
|
|
@@ -1708,12 +1889,14 @@ export interface DeleteIpGroupResult {
|
|
|
1708
1889
|
*/
|
|
1709
1890
|
export interface DeleteTagsRequest {
|
|
1710
1891
|
/**
|
|
1892
|
+
* @public
|
|
1711
1893
|
* <p>The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces,
|
|
1712
1894
|
* registered directories, images, custom bundles, IP access control groups, and connection
|
|
1713
1895
|
* aliases.</p>
|
|
1714
1896
|
*/
|
|
1715
1897
|
ResourceId: string | undefined;
|
|
1716
1898
|
/**
|
|
1899
|
+
* @public
|
|
1717
1900
|
* <p>The tag keys.</p>
|
|
1718
1901
|
*/
|
|
1719
1902
|
TagKeys: string[] | undefined;
|
|
@@ -1728,6 +1911,7 @@ export interface DeleteTagsResult {
|
|
|
1728
1911
|
*/
|
|
1729
1912
|
export interface DeleteWorkspaceBundleRequest {
|
|
1730
1913
|
/**
|
|
1914
|
+
* @public
|
|
1731
1915
|
* <p>The identifier of the bundle.</p>
|
|
1732
1916
|
*/
|
|
1733
1917
|
BundleId?: string;
|
|
@@ -1742,6 +1926,7 @@ export interface DeleteWorkspaceBundleResult {
|
|
|
1742
1926
|
*/
|
|
1743
1927
|
export interface DeleteWorkspaceImageRequest {
|
|
1744
1928
|
/**
|
|
1929
|
+
* @public
|
|
1745
1930
|
* <p>The identifier of the image.</p>
|
|
1746
1931
|
*/
|
|
1747
1932
|
ImageId: string | undefined;
|
|
@@ -1756,6 +1941,7 @@ export interface DeleteWorkspaceImageResult {
|
|
|
1756
1941
|
*/
|
|
1757
1942
|
export interface DeregisterWorkspaceDirectoryRequest {
|
|
1758
1943
|
/**
|
|
1944
|
+
* @public
|
|
1759
1945
|
* <p>The identifier of the directory. If any WorkSpaces are registered to this directory, you
|
|
1760
1946
|
* must remove them before you deregister the directory, or you will receive an
|
|
1761
1947
|
* OperationNotSupportedException error.</p>
|
|
@@ -1777,10 +1963,12 @@ export interface DescribeAccountRequest {
|
|
|
1777
1963
|
*/
|
|
1778
1964
|
export interface DescribeAccountResult {
|
|
1779
1965
|
/**
|
|
1966
|
+
* @public
|
|
1780
1967
|
* <p>The status of BYOL (whether BYOL is enabled or disabled).</p>
|
|
1781
1968
|
*/
|
|
1782
1969
|
DedicatedTenancySupport?: DedicatedTenancySupportResultEnum | string;
|
|
1783
1970
|
/**
|
|
1971
|
+
* @public
|
|
1784
1972
|
* <p>The IP address range, specified as an IPv4 CIDR block, used for the management network
|
|
1785
1973
|
* interface.</p>
|
|
1786
1974
|
* <p>The management network interface is connected to a secure Amazon WorkSpaces management
|
|
@@ -1794,6 +1982,7 @@ export interface DescribeAccountResult {
|
|
|
1794
1982
|
*/
|
|
1795
1983
|
export interface DescribeAccountModificationsRequest {
|
|
1796
1984
|
/**
|
|
1985
|
+
* @public
|
|
1797
1986
|
* <p>If you received a <code>NextToken</code> from a previous call that was paginated,
|
|
1798
1987
|
* provide this token to receive the next set of results.</p>
|
|
1799
1988
|
*/
|
|
@@ -1804,10 +1993,12 @@ export interface DescribeAccountModificationsRequest {
|
|
|
1804
1993
|
*/
|
|
1805
1994
|
export interface DescribeAccountModificationsResult {
|
|
1806
1995
|
/**
|
|
1996
|
+
* @public
|
|
1807
1997
|
* <p>The list of modifications to the configuration of BYOL.</p>
|
|
1808
1998
|
*/
|
|
1809
1999
|
AccountModifications?: AccountModification[];
|
|
1810
2000
|
/**
|
|
2001
|
+
* @public
|
|
1811
2002
|
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
1812
2003
|
* no more results to return. </p>
|
|
1813
2004
|
*/
|
|
@@ -1818,6 +2009,7 @@ export interface DescribeAccountModificationsResult {
|
|
|
1818
2009
|
*/
|
|
1819
2010
|
export interface DescribeClientBrandingRequest {
|
|
1820
2011
|
/**
|
|
2012
|
+
* @public
|
|
1821
2013
|
* <p>The directory identifier of the WorkSpace for which you want to view client branding
|
|
1822
2014
|
* information.</p>
|
|
1823
2015
|
*/
|
|
@@ -1834,6 +2026,7 @@ export interface DescribeClientBrandingRequest {
|
|
|
1834
2026
|
*/
|
|
1835
2027
|
export interface IosClientBrandingAttributes {
|
|
1836
2028
|
/**
|
|
2029
|
+
* @public
|
|
1837
2030
|
* <p>The logo. This is the standard-resolution display that has a 1:1 pixel density
|
|
1838
2031
|
* (or @1x), where one pixel is equal
|
|
1839
2032
|
* to one point. The only image format accepted is a binary data object that is converted from
|
|
@@ -1841,6 +2034,7 @@ export interface IosClientBrandingAttributes {
|
|
|
1841
2034
|
*/
|
|
1842
2035
|
LogoUrl?: string;
|
|
1843
2036
|
/**
|
|
2037
|
+
* @public
|
|
1844
2038
|
* <p>The @2x version of the logo. This is the higher resolution display that offers a scale
|
|
1845
2039
|
* factor of 2.0 (or @2x). The only image format accepted is a binary data object that is
|
|
1846
2040
|
* converted from a <code>.png</code> file.</p>
|
|
@@ -1851,6 +2045,7 @@ export interface IosClientBrandingAttributes {
|
|
|
1851
2045
|
*/
|
|
1852
2046
|
Logo2xUrl?: string;
|
|
1853
2047
|
/**
|
|
2048
|
+
* @public
|
|
1854
2049
|
* <p>The @3x version of the logo. This is the higher resolution display that offers a scale
|
|
1855
2050
|
* factor of 3.0 (or @3x).The only image format accepted is a binary data object that is
|
|
1856
2051
|
* converted from a <code>.png</code> file.</p>
|
|
@@ -1861,6 +2056,7 @@ export interface IosClientBrandingAttributes {
|
|
|
1861
2056
|
*/
|
|
1862
2057
|
Logo3xUrl?: string;
|
|
1863
2058
|
/**
|
|
2059
|
+
* @public
|
|
1864
2060
|
* <p>The support email. The company's customer support email address.</p>
|
|
1865
2061
|
* <note>
|
|
1866
2062
|
* <ul>
|
|
@@ -1877,6 +2073,7 @@ export interface IosClientBrandingAttributes {
|
|
|
1877
2073
|
*/
|
|
1878
2074
|
SupportEmail?: string;
|
|
1879
2075
|
/**
|
|
2076
|
+
* @public
|
|
1880
2077
|
* <p>The support link. The link for the company's customer support page for their
|
|
1881
2078
|
* WorkSpace.</p>
|
|
1882
2079
|
* <note>
|
|
@@ -1894,11 +2091,13 @@ export interface IosClientBrandingAttributes {
|
|
|
1894
2091
|
*/
|
|
1895
2092
|
SupportLink?: string;
|
|
1896
2093
|
/**
|
|
2094
|
+
* @public
|
|
1897
2095
|
* <p>The forgotten password link. This is the web address that users can go to if they forget
|
|
1898
2096
|
* the password for their WorkSpace.</p>
|
|
1899
2097
|
*/
|
|
1900
2098
|
ForgotPasswordLink?: string;
|
|
1901
2099
|
/**
|
|
2100
|
+
* @public
|
|
1902
2101
|
* <p>The login message. Specified as a key value pair, in which the key is a locale and the
|
|
1903
2102
|
* value is the localized message for that locale. The only key supported is
|
|
1904
2103
|
* <code>en_US</code>. The HTML tags supported include the following: <code>a, b, blockquote, br, cite, code, dd, dl, dt, div, em,
|
|
@@ -1911,26 +2110,32 @@ export interface IosClientBrandingAttributes {
|
|
|
1911
2110
|
*/
|
|
1912
2111
|
export interface DescribeClientBrandingResult {
|
|
1913
2112
|
/**
|
|
2113
|
+
* @public
|
|
1914
2114
|
* <p>The branding information for Windows devices.</p>
|
|
1915
2115
|
*/
|
|
1916
2116
|
DeviceTypeWindows?: DefaultClientBrandingAttributes;
|
|
1917
2117
|
/**
|
|
2118
|
+
* @public
|
|
1918
2119
|
* <p>The branding information for macOS devices.</p>
|
|
1919
2120
|
*/
|
|
1920
2121
|
DeviceTypeOsx?: DefaultClientBrandingAttributes;
|
|
1921
2122
|
/**
|
|
2123
|
+
* @public
|
|
1922
2124
|
* <p>The branding information for Android devices.</p>
|
|
1923
2125
|
*/
|
|
1924
2126
|
DeviceTypeAndroid?: DefaultClientBrandingAttributes;
|
|
1925
2127
|
/**
|
|
2128
|
+
* @public
|
|
1926
2129
|
* <p>The branding information for iOS devices.</p>
|
|
1927
2130
|
*/
|
|
1928
2131
|
DeviceTypeIos?: IosClientBrandingAttributes;
|
|
1929
2132
|
/**
|
|
2133
|
+
* @public
|
|
1930
2134
|
* <p>The branding information for Linux devices.</p>
|
|
1931
2135
|
*/
|
|
1932
2136
|
DeviceTypeLinux?: DefaultClientBrandingAttributes;
|
|
1933
2137
|
/**
|
|
2138
|
+
* @public
|
|
1934
2139
|
* <p>The branding information for Web access.</p>
|
|
1935
2140
|
*/
|
|
1936
2141
|
DeviceTypeWeb?: DefaultClientBrandingAttributes;
|
|
@@ -1940,6 +2145,7 @@ export interface DescribeClientBrandingResult {
|
|
|
1940
2145
|
*/
|
|
1941
2146
|
export interface DescribeClientPropertiesRequest {
|
|
1942
2147
|
/**
|
|
2148
|
+
* @public
|
|
1943
2149
|
* <p>The resource identifier, in the form of directory IDs.</p>
|
|
1944
2150
|
*/
|
|
1945
2151
|
ResourceIds: string[] | undefined;
|
|
@@ -1949,6 +2155,7 @@ export interface DescribeClientPropertiesRequest {
|
|
|
1949
2155
|
*/
|
|
1950
2156
|
export interface DescribeClientPropertiesResult {
|
|
1951
2157
|
/**
|
|
2158
|
+
* @public
|
|
1952
2159
|
* <p>Information about the specified Amazon WorkSpaces clients.</p>
|
|
1953
2160
|
*/
|
|
1954
2161
|
ClientPropertiesList?: ClientPropertiesResult[];
|
|
@@ -1958,15 +2165,18 @@ export interface DescribeClientPropertiesResult {
|
|
|
1958
2165
|
*/
|
|
1959
2166
|
export interface DescribeConnectClientAddInsRequest {
|
|
1960
2167
|
/**
|
|
2168
|
+
* @public
|
|
1961
2169
|
* <p>The directory identifier for which the client add-in is configured.</p>
|
|
1962
2170
|
*/
|
|
1963
2171
|
ResourceId: string | undefined;
|
|
1964
2172
|
/**
|
|
2173
|
+
* @public
|
|
1965
2174
|
* <p>If you received a <code>NextToken</code> from a previous call that was paginated,
|
|
1966
2175
|
* provide this token to receive the next set of results.</p>
|
|
1967
2176
|
*/
|
|
1968
2177
|
NextToken?: string;
|
|
1969
2178
|
/**
|
|
2179
|
+
* @public
|
|
1970
2180
|
* <p>The maximum number of items to return.</p>
|
|
1971
2181
|
*/
|
|
1972
2182
|
MaxResults?: number;
|
|
@@ -1976,10 +2186,12 @@ export interface DescribeConnectClientAddInsRequest {
|
|
|
1976
2186
|
*/
|
|
1977
2187
|
export interface DescribeConnectClientAddInsResult {
|
|
1978
2188
|
/**
|
|
2189
|
+
* @public
|
|
1979
2190
|
* <p>Information about client add-ins.</p>
|
|
1980
2191
|
*/
|
|
1981
2192
|
AddIns?: ConnectClientAddIn[];
|
|
1982
2193
|
/**
|
|
2194
|
+
* @public
|
|
1983
2195
|
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
1984
2196
|
* no more results to return. </p>
|
|
1985
2197
|
*/
|
|
@@ -1990,18 +2202,22 @@ export interface DescribeConnectClientAddInsResult {
|
|
|
1990
2202
|
*/
|
|
1991
2203
|
export interface DescribeConnectionAliasesRequest {
|
|
1992
2204
|
/**
|
|
2205
|
+
* @public
|
|
1993
2206
|
* <p>The identifiers of the connection aliases to describe.</p>
|
|
1994
2207
|
*/
|
|
1995
2208
|
AliasIds?: string[];
|
|
1996
2209
|
/**
|
|
2210
|
+
* @public
|
|
1997
2211
|
* <p>The identifier of the directory associated with the connection alias.</p>
|
|
1998
2212
|
*/
|
|
1999
2213
|
ResourceId?: string;
|
|
2000
2214
|
/**
|
|
2215
|
+
* @public
|
|
2001
2216
|
* <p>The maximum number of connection aliases to return.</p>
|
|
2002
2217
|
*/
|
|
2003
2218
|
Limit?: number;
|
|
2004
2219
|
/**
|
|
2220
|
+
* @public
|
|
2005
2221
|
* <p>If you received a <code>NextToken</code> from a previous call that was paginated,
|
|
2006
2222
|
* provide this token to receive the next set of results. </p>
|
|
2007
2223
|
*/
|
|
@@ -2012,10 +2228,12 @@ export interface DescribeConnectionAliasesRequest {
|
|
|
2012
2228
|
*/
|
|
2013
2229
|
export interface DescribeConnectionAliasesResult {
|
|
2014
2230
|
/**
|
|
2231
|
+
* @public
|
|
2015
2232
|
* <p>Information about the specified connection aliases.</p>
|
|
2016
2233
|
*/
|
|
2017
2234
|
ConnectionAliases?: ConnectionAlias[];
|
|
2018
2235
|
/**
|
|
2236
|
+
* @public
|
|
2019
2237
|
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
2020
2238
|
* no more results to return. </p>
|
|
2021
2239
|
*/
|
|
@@ -2026,15 +2244,18 @@ export interface DescribeConnectionAliasesResult {
|
|
|
2026
2244
|
*/
|
|
2027
2245
|
export interface DescribeConnectionAliasPermissionsRequest {
|
|
2028
2246
|
/**
|
|
2247
|
+
* @public
|
|
2029
2248
|
* <p>The identifier of the connection alias.</p>
|
|
2030
2249
|
*/
|
|
2031
2250
|
AliasId: string | undefined;
|
|
2032
2251
|
/**
|
|
2252
|
+
* @public
|
|
2033
2253
|
* <p>If you received a <code>NextToken</code> from a previous call that was paginated,
|
|
2034
2254
|
* provide this token to receive the next set of results. </p>
|
|
2035
2255
|
*/
|
|
2036
2256
|
NextToken?: string;
|
|
2037
2257
|
/**
|
|
2258
|
+
* @public
|
|
2038
2259
|
* <p>The maximum number of results to return.</p>
|
|
2039
2260
|
*/
|
|
2040
2261
|
MaxResults?: number;
|
|
@@ -2044,14 +2265,17 @@ export interface DescribeConnectionAliasPermissionsRequest {
|
|
|
2044
2265
|
*/
|
|
2045
2266
|
export interface DescribeConnectionAliasPermissionsResult {
|
|
2046
2267
|
/**
|
|
2268
|
+
* @public
|
|
2047
2269
|
* <p>The identifier of the connection alias.</p>
|
|
2048
2270
|
*/
|
|
2049
2271
|
AliasId?: string;
|
|
2050
2272
|
/**
|
|
2273
|
+
* @public
|
|
2051
2274
|
* <p>The permissions associated with a connection alias.</p>
|
|
2052
2275
|
*/
|
|
2053
2276
|
ConnectionAliasPermissions?: ConnectionAliasPermission[];
|
|
2054
2277
|
/**
|
|
2278
|
+
* @public
|
|
2055
2279
|
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
2056
2280
|
* no more results to return. </p>
|
|
2057
2281
|
*/
|
|
@@ -2062,15 +2286,18 @@ export interface DescribeConnectionAliasPermissionsResult {
|
|
|
2062
2286
|
*/
|
|
2063
2287
|
export interface DescribeIpGroupsRequest {
|
|
2064
2288
|
/**
|
|
2289
|
+
* @public
|
|
2065
2290
|
* <p>The identifiers of one or more IP access control groups.</p>
|
|
2066
2291
|
*/
|
|
2067
2292
|
GroupIds?: string[];
|
|
2068
2293
|
/**
|
|
2294
|
+
* @public
|
|
2069
2295
|
* <p>If you received a <code>NextToken</code> from a previous call that was paginated,
|
|
2070
2296
|
* provide this token to receive the next set of results.</p>
|
|
2071
2297
|
*/
|
|
2072
2298
|
NextToken?: string;
|
|
2073
2299
|
/**
|
|
2300
|
+
* @public
|
|
2074
2301
|
* <p>The maximum number of items to return.</p>
|
|
2075
2302
|
*/
|
|
2076
2303
|
MaxResults?: number;
|
|
@@ -2081,18 +2308,22 @@ export interface DescribeIpGroupsRequest {
|
|
|
2081
2308
|
*/
|
|
2082
2309
|
export interface WorkspacesIpGroup {
|
|
2083
2310
|
/**
|
|
2311
|
+
* @public
|
|
2084
2312
|
* <p>The identifier of the group.</p>
|
|
2085
2313
|
*/
|
|
2086
2314
|
groupId?: string;
|
|
2087
2315
|
/**
|
|
2316
|
+
* @public
|
|
2088
2317
|
* <p>The name of the group.</p>
|
|
2089
2318
|
*/
|
|
2090
2319
|
groupName?: string;
|
|
2091
2320
|
/**
|
|
2321
|
+
* @public
|
|
2092
2322
|
* <p>The description of the group.</p>
|
|
2093
2323
|
*/
|
|
2094
2324
|
groupDesc?: string;
|
|
2095
2325
|
/**
|
|
2326
|
+
* @public
|
|
2096
2327
|
* <p>The rules.</p>
|
|
2097
2328
|
*/
|
|
2098
2329
|
userRules?: IpRuleItem[];
|
|
@@ -2102,10 +2333,12 @@ export interface WorkspacesIpGroup {
|
|
|
2102
2333
|
*/
|
|
2103
2334
|
export interface DescribeIpGroupsResult {
|
|
2104
2335
|
/**
|
|
2336
|
+
* @public
|
|
2105
2337
|
* <p>Information about the IP access control groups.</p>
|
|
2106
2338
|
*/
|
|
2107
2339
|
Result?: WorkspacesIpGroup[];
|
|
2108
2340
|
/**
|
|
2341
|
+
* @public
|
|
2109
2342
|
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
2110
2343
|
* no more results to return. </p>
|
|
2111
2344
|
*/
|
|
@@ -2116,6 +2349,7 @@ export interface DescribeIpGroupsResult {
|
|
|
2116
2349
|
*/
|
|
2117
2350
|
export interface DescribeTagsRequest {
|
|
2118
2351
|
/**
|
|
2352
|
+
* @public
|
|
2119
2353
|
* <p>The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces,
|
|
2120
2354
|
* registered directories, images, custom bundles, IP access control groups, and connection
|
|
2121
2355
|
* aliases.</p>
|
|
@@ -2127,6 +2361,7 @@ export interface DescribeTagsRequest {
|
|
|
2127
2361
|
*/
|
|
2128
2362
|
export interface DescribeTagsResult {
|
|
2129
2363
|
/**
|
|
2364
|
+
* @public
|
|
2130
2365
|
* <p>The tags.</p>
|
|
2131
2366
|
*/
|
|
2132
2367
|
TagList?: Tag[];
|
|
@@ -2136,16 +2371,19 @@ export interface DescribeTagsResult {
|
|
|
2136
2371
|
*/
|
|
2137
2372
|
export interface DescribeWorkspaceBundlesRequest {
|
|
2138
2373
|
/**
|
|
2374
|
+
* @public
|
|
2139
2375
|
* <p>The identifiers of the bundles. You cannot combine this parameter with any other filter.</p>
|
|
2140
2376
|
*/
|
|
2141
2377
|
BundleIds?: string[];
|
|
2142
2378
|
/**
|
|
2379
|
+
* @public
|
|
2143
2380
|
* <p>The owner of the bundles. You cannot combine this parameter with any other filter.</p>
|
|
2144
2381
|
* <p>To describe the bundles provided by Amazon Web Services, specify <code>AMAZON</code>.
|
|
2145
2382
|
* To describe the bundles that belong to your account, don't specify a value.</p>
|
|
2146
2383
|
*/
|
|
2147
2384
|
Owner?: string;
|
|
2148
2385
|
/**
|
|
2386
|
+
* @public
|
|
2149
2387
|
* <p>The token for the next set of results. (You received this token from a previous call.)</p>
|
|
2150
2388
|
*/
|
|
2151
2389
|
NextToken?: string;
|
|
@@ -2155,10 +2393,12 @@ export interface DescribeWorkspaceBundlesRequest {
|
|
|
2155
2393
|
*/
|
|
2156
2394
|
export interface DescribeWorkspaceBundlesResult {
|
|
2157
2395
|
/**
|
|
2396
|
+
* @public
|
|
2158
2397
|
* <p>Information about the bundles.</p>
|
|
2159
2398
|
*/
|
|
2160
2399
|
Bundles?: WorkspaceBundle[];
|
|
2161
2400
|
/**
|
|
2401
|
+
* @public
|
|
2162
2402
|
* <p>The token to use to retrieve the next page of results. This value is null when there are no more
|
|
2163
2403
|
* results to return. This token is valid for one day and must be used within that time
|
|
2164
2404
|
* frame.</p>
|
|
@@ -2170,15 +2410,18 @@ export interface DescribeWorkspaceBundlesResult {
|
|
|
2170
2410
|
*/
|
|
2171
2411
|
export interface DescribeWorkspaceDirectoriesRequest {
|
|
2172
2412
|
/**
|
|
2413
|
+
* @public
|
|
2173
2414
|
* <p>The identifiers of the directories. If the value is null, all directories are
|
|
2174
2415
|
* retrieved.</p>
|
|
2175
2416
|
*/
|
|
2176
2417
|
DirectoryIds?: string[];
|
|
2177
2418
|
/**
|
|
2419
|
+
* @public
|
|
2178
2420
|
* <p>The maximum number of directories to return.</p>
|
|
2179
2421
|
*/
|
|
2180
2422
|
Limit?: number;
|
|
2181
2423
|
/**
|
|
2424
|
+
* @public
|
|
2182
2425
|
* <p>If you received a <code>NextToken</code> from a previous call that was paginated,
|
|
2183
2426
|
* provide this token to receive the next set of results.</p>
|
|
2184
2427
|
*/
|
|
@@ -2216,6 +2459,7 @@ export type SamlStatusEnum = (typeof SamlStatusEnum)[keyof typeof SamlStatusEnum
|
|
|
2216
2459
|
*/
|
|
2217
2460
|
export interface SamlProperties {
|
|
2218
2461
|
/**
|
|
2462
|
+
* @public
|
|
2219
2463
|
* <p>Indicates the status of SAML 2.0 authentication. These statuses include the following.</p>
|
|
2220
2464
|
* <ul>
|
|
2221
2465
|
* <li>
|
|
@@ -2235,12 +2479,14 @@ export interface SamlProperties {
|
|
|
2235
2479
|
*/
|
|
2236
2480
|
Status?: SamlStatusEnum | string;
|
|
2237
2481
|
/**
|
|
2482
|
+
* @public
|
|
2238
2483
|
* <p>The SAML 2.0 identity provider (IdP) user access URL is the URL a user would navigate to in their web browser in
|
|
2239
2484
|
* order to federate from the IdP and directly access the application, without any SAML 2.0 service provider (SP)
|
|
2240
2485
|
* bindings.</p>
|
|
2241
2486
|
*/
|
|
2242
2487
|
UserAccessUrl?: string;
|
|
2243
2488
|
/**
|
|
2489
|
+
* @public
|
|
2244
2490
|
* <p>The relay state parameter name supported by the SAML 2.0 identity provider (IdP). When the end user is redirected to
|
|
2245
2491
|
* the user access URL from the WorkSpaces client application, this relay state parameter name is appended as a query
|
|
2246
2492
|
* parameter to the URL along with the relay state endpoint to return the user to the client application session.</p>
|
|
@@ -2255,23 +2501,28 @@ export interface SamlProperties {
|
|
|
2255
2501
|
*/
|
|
2256
2502
|
export interface SelfservicePermissions {
|
|
2257
2503
|
/**
|
|
2504
|
+
* @public
|
|
2258
2505
|
* <p>Specifies whether users can restart their WorkSpace.</p>
|
|
2259
2506
|
*/
|
|
2260
2507
|
RestartWorkspace?: ReconnectEnum | string;
|
|
2261
2508
|
/**
|
|
2509
|
+
* @public
|
|
2262
2510
|
* <p>Specifies whether users can increase the volume size of the drives on their
|
|
2263
2511
|
* WorkSpace.</p>
|
|
2264
2512
|
*/
|
|
2265
2513
|
IncreaseVolumeSize?: ReconnectEnum | string;
|
|
2266
2514
|
/**
|
|
2515
|
+
* @public
|
|
2267
2516
|
* <p>Specifies whether users can change the compute type (bundle) for their WorkSpace.</p>
|
|
2268
2517
|
*/
|
|
2269
2518
|
ChangeComputeType?: ReconnectEnum | string;
|
|
2270
2519
|
/**
|
|
2520
|
+
* @public
|
|
2271
2521
|
* <p>Specifies whether users can switch the running mode of their WorkSpace.</p>
|
|
2272
2522
|
*/
|
|
2273
2523
|
SwitchRunningMode?: ReconnectEnum | string;
|
|
2274
2524
|
/**
|
|
2525
|
+
* @public
|
|
2275
2526
|
* <p>Specifies whether users can rebuild the operating system of a WorkSpace to its original
|
|
2276
2527
|
* state.</p>
|
|
2277
2528
|
*/
|
|
@@ -2312,35 +2563,43 @@ export type Tenancy = (typeof Tenancy)[keyof typeof Tenancy];
|
|
|
2312
2563
|
*/
|
|
2313
2564
|
export interface WorkspaceAccessProperties {
|
|
2314
2565
|
/**
|
|
2566
|
+
* @public
|
|
2315
2567
|
* <p>Indicates whether users can use Windows clients to access their WorkSpaces.</p>
|
|
2316
2568
|
*/
|
|
2317
2569
|
DeviceTypeWindows?: AccessPropertyValue | string;
|
|
2318
2570
|
/**
|
|
2571
|
+
* @public
|
|
2319
2572
|
* <p>Indicates whether users can use macOS clients to access their WorkSpaces.</p>
|
|
2320
2573
|
*/
|
|
2321
2574
|
DeviceTypeOsx?: AccessPropertyValue | string;
|
|
2322
2575
|
/**
|
|
2576
|
+
* @public
|
|
2323
2577
|
* <p>Indicates whether users can access their WorkSpaces through a web browser.</p>
|
|
2324
2578
|
*/
|
|
2325
2579
|
DeviceTypeWeb?: AccessPropertyValue | string;
|
|
2326
2580
|
/**
|
|
2581
|
+
* @public
|
|
2327
2582
|
* <p>Indicates whether users can use iOS devices to access their WorkSpaces.</p>
|
|
2328
2583
|
*/
|
|
2329
2584
|
DeviceTypeIos?: AccessPropertyValue | string;
|
|
2330
2585
|
/**
|
|
2586
|
+
* @public
|
|
2331
2587
|
* <p>Indicates whether users can use Android and Android-compatible Chrome OS devices to
|
|
2332
2588
|
* access their WorkSpaces.</p>
|
|
2333
2589
|
*/
|
|
2334
2590
|
DeviceTypeAndroid?: AccessPropertyValue | string;
|
|
2335
2591
|
/**
|
|
2592
|
+
* @public
|
|
2336
2593
|
* <p>Indicates whether users can use Chromebooks to access their WorkSpaces.</p>
|
|
2337
2594
|
*/
|
|
2338
2595
|
DeviceTypeChromeOs?: AccessPropertyValue | string;
|
|
2339
2596
|
/**
|
|
2597
|
+
* @public
|
|
2340
2598
|
* <p>Indicates whether users can use zero client devices to access their WorkSpaces.</p>
|
|
2341
2599
|
*/
|
|
2342
2600
|
DeviceTypeZeroClient?: AccessPropertyValue | string;
|
|
2343
2601
|
/**
|
|
2602
|
+
* @public
|
|
2344
2603
|
* <p>Indicates whether users can use Linux clients to access their WorkSpaces.</p>
|
|
2345
2604
|
*/
|
|
2346
2605
|
DeviceTypeLinux?: AccessPropertyValue | string;
|
|
@@ -2351,48 +2610,59 @@ export interface WorkspaceAccessProperties {
|
|
|
2351
2610
|
*/
|
|
2352
2611
|
export interface WorkspaceDirectory {
|
|
2353
2612
|
/**
|
|
2613
|
+
* @public
|
|
2354
2614
|
* <p>The directory identifier.</p>
|
|
2355
2615
|
*/
|
|
2356
2616
|
DirectoryId?: string;
|
|
2357
2617
|
/**
|
|
2618
|
+
* @public
|
|
2358
2619
|
* <p>The directory alias.</p>
|
|
2359
2620
|
*/
|
|
2360
2621
|
Alias?: string;
|
|
2361
2622
|
/**
|
|
2623
|
+
* @public
|
|
2362
2624
|
* <p>The name of the directory.</p>
|
|
2363
2625
|
*/
|
|
2364
2626
|
DirectoryName?: string;
|
|
2365
2627
|
/**
|
|
2628
|
+
* @public
|
|
2366
2629
|
* <p>The registration code for the directory. This is the code that users enter in their
|
|
2367
2630
|
* Amazon WorkSpaces client application to connect to the directory.</p>
|
|
2368
2631
|
*/
|
|
2369
2632
|
RegistrationCode?: string;
|
|
2370
2633
|
/**
|
|
2634
|
+
* @public
|
|
2371
2635
|
* <p>The identifiers of the subnets used with the directory.</p>
|
|
2372
2636
|
*/
|
|
2373
2637
|
SubnetIds?: string[];
|
|
2374
2638
|
/**
|
|
2639
|
+
* @public
|
|
2375
2640
|
* <p>The IP addresses of the DNS servers for the directory.</p>
|
|
2376
2641
|
*/
|
|
2377
2642
|
DnsIpAddresses?: string[];
|
|
2378
2643
|
/**
|
|
2644
|
+
* @public
|
|
2379
2645
|
* <p>The user name for the service account.</p>
|
|
2380
2646
|
*/
|
|
2381
2647
|
CustomerUserName?: string;
|
|
2382
2648
|
/**
|
|
2649
|
+
* @public
|
|
2383
2650
|
* <p>The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make
|
|
2384
2651
|
* calls to other services, such as Amazon EC2, on your behalf.</p>
|
|
2385
2652
|
*/
|
|
2386
2653
|
IamRoleId?: string;
|
|
2387
2654
|
/**
|
|
2655
|
+
* @public
|
|
2388
2656
|
* <p>The directory type.</p>
|
|
2389
2657
|
*/
|
|
2390
2658
|
DirectoryType?: WorkspaceDirectoryType | string;
|
|
2391
2659
|
/**
|
|
2660
|
+
* @public
|
|
2392
2661
|
* <p>The identifier of the security group that is assigned to new WorkSpaces.</p>
|
|
2393
2662
|
*/
|
|
2394
2663
|
WorkspaceSecurityGroupId?: string;
|
|
2395
2664
|
/**
|
|
2665
|
+
* @public
|
|
2396
2666
|
* <p>The state of the directory's registration with Amazon WorkSpaces. After a directory is
|
|
2397
2667
|
* deregistered, the <code>DEREGISTERED</code> state is returned very briefly before the
|
|
2398
2668
|
* directory metadata is cleaned up, so this state is rarely returned. To confirm that a
|
|
@@ -2402,33 +2672,40 @@ export interface WorkspaceDirectory {
|
|
|
2402
2672
|
*/
|
|
2403
2673
|
State?: WorkspaceDirectoryState | string;
|
|
2404
2674
|
/**
|
|
2675
|
+
* @public
|
|
2405
2676
|
* <p>The default creation properties for all WorkSpaces in the directory.</p>
|
|
2406
2677
|
*/
|
|
2407
2678
|
WorkspaceCreationProperties?: DefaultWorkspaceCreationProperties;
|
|
2408
2679
|
/**
|
|
2680
|
+
* @public
|
|
2409
2681
|
* <p>The identifiers of the IP access control groups associated with the directory.</p>
|
|
2410
2682
|
*/
|
|
2411
2683
|
ipGroupIds?: string[];
|
|
2412
2684
|
/**
|
|
2685
|
+
* @public
|
|
2413
2686
|
* <p>The devices and operating systems that users can use to access WorkSpaces.</p>
|
|
2414
2687
|
*/
|
|
2415
2688
|
WorkspaceAccessProperties?: WorkspaceAccessProperties;
|
|
2416
2689
|
/**
|
|
2690
|
+
* @public
|
|
2417
2691
|
* <p>Specifies whether the directory is dedicated or shared. To use Bring Your Own License
|
|
2418
2692
|
* (BYOL), this value must be set to <code>DEDICATED</code>. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html">Bring
|
|
2419
2693
|
* Your Own Windows Desktop Images</a>.</p>
|
|
2420
2694
|
*/
|
|
2421
2695
|
Tenancy?: Tenancy | string;
|
|
2422
2696
|
/**
|
|
2697
|
+
* @public
|
|
2423
2698
|
* <p>The default self-service permissions for WorkSpaces in the directory.</p>
|
|
2424
2699
|
*/
|
|
2425
2700
|
SelfservicePermissions?: SelfservicePermissions;
|
|
2426
2701
|
/**
|
|
2702
|
+
* @public
|
|
2427
2703
|
* <p>Describes the enablement status, user access URL, and relay state parameter name that are used for configuring
|
|
2428
2704
|
* federation with an SAML 2.0 identity provider.</p>
|
|
2429
2705
|
*/
|
|
2430
2706
|
SamlProperties?: SamlProperties;
|
|
2431
2707
|
/**
|
|
2708
|
+
* @public
|
|
2432
2709
|
* <p>The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP)
|
|
2433
2710
|
* user identities to Active Directory for WorkSpaces login.</p>
|
|
2434
2711
|
*/
|
|
@@ -2439,10 +2716,12 @@ export interface WorkspaceDirectory {
|
|
|
2439
2716
|
*/
|
|
2440
2717
|
export interface DescribeWorkspaceDirectoriesResult {
|
|
2441
2718
|
/**
|
|
2719
|
+
* @public
|
|
2442
2720
|
* <p>Information about the directories.</p>
|
|
2443
2721
|
*/
|
|
2444
2722
|
Directories?: WorkspaceDirectory[];
|
|
2445
2723
|
/**
|
|
2724
|
+
* @public
|
|
2446
2725
|
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
2447
2726
|
* no more results to return. </p>
|
|
2448
2727
|
*/
|
|
@@ -2453,15 +2732,18 @@ export interface DescribeWorkspaceDirectoriesResult {
|
|
|
2453
2732
|
*/
|
|
2454
2733
|
export interface DescribeWorkspaceImagePermissionsRequest {
|
|
2455
2734
|
/**
|
|
2735
|
+
* @public
|
|
2456
2736
|
* <p>The identifier of the image.</p>
|
|
2457
2737
|
*/
|
|
2458
2738
|
ImageId: string | undefined;
|
|
2459
2739
|
/**
|
|
2740
|
+
* @public
|
|
2460
2741
|
* <p>If you received a <code>NextToken</code> from a previous call that was paginated,
|
|
2461
2742
|
* provide this token to receive the next set of results.</p>
|
|
2462
2743
|
*/
|
|
2463
2744
|
NextToken?: string;
|
|
2464
2745
|
/**
|
|
2746
|
+
* @public
|
|
2465
2747
|
* <p>The maximum number of items to return.</p>
|
|
2466
2748
|
*/
|
|
2467
2749
|
MaxResults?: number;
|
|
@@ -2474,6 +2756,7 @@ export interface DescribeWorkspaceImagePermissionsRequest {
|
|
|
2474
2756
|
*/
|
|
2475
2757
|
export interface ImagePermission {
|
|
2476
2758
|
/**
|
|
2759
|
+
* @public
|
|
2477
2760
|
* <p>The identifier of the Amazon Web Services account that an image has been shared
|
|
2478
2761
|
* with.</p>
|
|
2479
2762
|
*/
|
|
@@ -2484,15 +2767,18 @@ export interface ImagePermission {
|
|
|
2484
2767
|
*/
|
|
2485
2768
|
export interface DescribeWorkspaceImagePermissionsResult {
|
|
2486
2769
|
/**
|
|
2770
|
+
* @public
|
|
2487
2771
|
* <p>The identifier of the image.</p>
|
|
2488
2772
|
*/
|
|
2489
2773
|
ImageId?: string;
|
|
2490
2774
|
/**
|
|
2775
|
+
* @public
|
|
2491
2776
|
* <p>The identifiers of the Amazon Web Services accounts that the image has been shared
|
|
2492
2777
|
* with.</p>
|
|
2493
2778
|
*/
|
|
2494
2779
|
ImagePermissions?: ImagePermission[];
|
|
2495
2780
|
/**
|
|
2781
|
+
* @public
|
|
2496
2782
|
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
2497
2783
|
* no more results to return. </p>
|
|
2498
2784
|
*/
|
|
@@ -2515,19 +2801,23 @@ export type ImageType = (typeof ImageType)[keyof typeof ImageType];
|
|
|
2515
2801
|
*/
|
|
2516
2802
|
export interface DescribeWorkspaceImagesRequest {
|
|
2517
2803
|
/**
|
|
2804
|
+
* @public
|
|
2518
2805
|
* <p>The identifier of the image.</p>
|
|
2519
2806
|
*/
|
|
2520
2807
|
ImageIds?: string[];
|
|
2521
2808
|
/**
|
|
2809
|
+
* @public
|
|
2522
2810
|
* <p>The type (owned or shared) of the image.</p>
|
|
2523
2811
|
*/
|
|
2524
2812
|
ImageType?: ImageType | string;
|
|
2525
2813
|
/**
|
|
2814
|
+
* @public
|
|
2526
2815
|
* <p>If you received a <code>NextToken</code> from a previous call that was paginated,
|
|
2527
2816
|
* provide this token to receive the next set of results.</p>
|
|
2528
2817
|
*/
|
|
2529
2818
|
NextToken?: string;
|
|
2530
2819
|
/**
|
|
2820
|
+
* @public
|
|
2531
2821
|
* <p>The maximum number of items to return.</p>
|
|
2532
2822
|
*/
|
|
2533
2823
|
MaxResults?: number;
|
|
@@ -2542,11 +2832,13 @@ export interface DescribeWorkspaceImagesRequest {
|
|
|
2542
2832
|
*/
|
|
2543
2833
|
export interface UpdateResult {
|
|
2544
2834
|
/**
|
|
2835
|
+
* @public
|
|
2545
2836
|
* <p>Indicates whether updated drivers or other components are available for the specified
|
|
2546
2837
|
* WorkSpace image.</p>
|
|
2547
2838
|
*/
|
|
2548
2839
|
UpdateAvailable?: boolean;
|
|
2549
2840
|
/**
|
|
2841
|
+
* @public
|
|
2550
2842
|
* <p>A description of whether updates for the WorkSpace image are pending or
|
|
2551
2843
|
* available.</p>
|
|
2552
2844
|
*/
|
|
@@ -2558,26 +2850,32 @@ export interface UpdateResult {
|
|
|
2558
2850
|
*/
|
|
2559
2851
|
export interface WorkspaceImage {
|
|
2560
2852
|
/**
|
|
2853
|
+
* @public
|
|
2561
2854
|
* <p>The identifier of the image.</p>
|
|
2562
2855
|
*/
|
|
2563
2856
|
ImageId?: string;
|
|
2564
2857
|
/**
|
|
2858
|
+
* @public
|
|
2565
2859
|
* <p>The name of the image.</p>
|
|
2566
2860
|
*/
|
|
2567
2861
|
Name?: string;
|
|
2568
2862
|
/**
|
|
2863
|
+
* @public
|
|
2569
2864
|
* <p>The description of the image.</p>
|
|
2570
2865
|
*/
|
|
2571
2866
|
Description?: string;
|
|
2572
2867
|
/**
|
|
2868
|
+
* @public
|
|
2573
2869
|
* <p>The operating system that the image is running. </p>
|
|
2574
2870
|
*/
|
|
2575
2871
|
OperatingSystem?: OperatingSystem;
|
|
2576
2872
|
/**
|
|
2873
|
+
* @public
|
|
2577
2874
|
* <p>The status of the image.</p>
|
|
2578
2875
|
*/
|
|
2579
2876
|
State?: WorkspaceImageState | string;
|
|
2580
2877
|
/**
|
|
2878
|
+
* @public
|
|
2581
2879
|
* <p>Specifies whether the image is running on dedicated hardware. When Bring Your Own
|
|
2582
2880
|
* License (BYOL) is enabled, this value is set to <code>DEDICATED</code>. For more
|
|
2583
2881
|
* information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html">Bring Your Own Windows
|
|
@@ -2585,23 +2883,28 @@ export interface WorkspaceImage {
|
|
|
2585
2883
|
*/
|
|
2586
2884
|
RequiredTenancy?: WorkspaceImageRequiredTenancy | string;
|
|
2587
2885
|
/**
|
|
2886
|
+
* @public
|
|
2588
2887
|
* <p>The error code that is returned for the image.</p>
|
|
2589
2888
|
*/
|
|
2590
2889
|
ErrorCode?: string;
|
|
2591
2890
|
/**
|
|
2891
|
+
* @public
|
|
2592
2892
|
* <p>The text of the error message that is returned for the image.</p>
|
|
2593
2893
|
*/
|
|
2594
2894
|
ErrorMessage?: string;
|
|
2595
2895
|
/**
|
|
2896
|
+
* @public
|
|
2596
2897
|
* <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
|
|
2597
2898
|
* of the image.</p>
|
|
2598
2899
|
*/
|
|
2599
2900
|
Created?: Date;
|
|
2600
2901
|
/**
|
|
2902
|
+
* @public
|
|
2601
2903
|
* <p>The identifier of the Amazon Web Services account that owns the image.</p>
|
|
2602
2904
|
*/
|
|
2603
2905
|
OwnerAccountId?: string;
|
|
2604
2906
|
/**
|
|
2907
|
+
* @public
|
|
2605
2908
|
* <p>The updates (if any) that are available for the specified image.</p>
|
|
2606
2909
|
*/
|
|
2607
2910
|
Updates?: UpdateResult;
|
|
@@ -2611,10 +2914,12 @@ export interface WorkspaceImage {
|
|
|
2611
2914
|
*/
|
|
2612
2915
|
export interface DescribeWorkspaceImagesResult {
|
|
2613
2916
|
/**
|
|
2917
|
+
* @public
|
|
2614
2918
|
* <p>Information about the images.</p>
|
|
2615
2919
|
*/
|
|
2616
2920
|
Images?: WorkspaceImage[];
|
|
2617
2921
|
/**
|
|
2922
|
+
* @public
|
|
2618
2923
|
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
2619
2924
|
* no more results to return. </p>
|
|
2620
2925
|
*/
|
|
@@ -2625,6 +2930,7 @@ export interface DescribeWorkspaceImagesResult {
|
|
|
2625
2930
|
*/
|
|
2626
2931
|
export interface DescribeWorkspacesRequest {
|
|
2627
2932
|
/**
|
|
2933
|
+
* @public
|
|
2628
2934
|
* <p>The identifiers of the WorkSpaces. You cannot combine this parameter with any other
|
|
2629
2935
|
* filter.</p>
|
|
2630
2936
|
* <p>Because the <a>CreateWorkspaces</a> operation is asynchronous, the identifier
|
|
@@ -2632,26 +2938,31 @@ export interface DescribeWorkspacesRequest {
|
|
|
2632
2938
|
*/
|
|
2633
2939
|
WorkspaceIds?: string[];
|
|
2634
2940
|
/**
|
|
2941
|
+
* @public
|
|
2635
2942
|
* <p>The identifier of the directory. In addition, you can optionally specify a specific
|
|
2636
2943
|
* directory user (see <code>UserName</code>). You cannot combine this parameter with any
|
|
2637
2944
|
* other filter.</p>
|
|
2638
2945
|
*/
|
|
2639
2946
|
DirectoryId?: string;
|
|
2640
2947
|
/**
|
|
2948
|
+
* @public
|
|
2641
2949
|
* <p>The name of the directory user. You must specify this parameter with
|
|
2642
2950
|
* <code>DirectoryId</code>.</p>
|
|
2643
2951
|
*/
|
|
2644
2952
|
UserName?: string;
|
|
2645
2953
|
/**
|
|
2954
|
+
* @public
|
|
2646
2955
|
* <p>The identifier of the bundle. All WorkSpaces that are created from this bundle are
|
|
2647
2956
|
* retrieved. You cannot combine this parameter with any other filter.</p>
|
|
2648
2957
|
*/
|
|
2649
2958
|
BundleId?: string;
|
|
2650
2959
|
/**
|
|
2960
|
+
* @public
|
|
2651
2961
|
* <p>The maximum number of items to return.</p>
|
|
2652
2962
|
*/
|
|
2653
2963
|
Limit?: number;
|
|
2654
2964
|
/**
|
|
2965
|
+
* @public
|
|
2655
2966
|
* <p>If you received a <code>NextToken</code> from a previous call that was paginated,
|
|
2656
2967
|
* provide this token to receive the next set of results.</p>
|
|
2657
2968
|
*/
|
|
@@ -2662,12 +2973,14 @@ export interface DescribeWorkspacesRequest {
|
|
|
2662
2973
|
*/
|
|
2663
2974
|
export interface DescribeWorkspacesResult {
|
|
2664
2975
|
/**
|
|
2976
|
+
* @public
|
|
2665
2977
|
* <p>Information about the WorkSpaces.</p>
|
|
2666
2978
|
* <p>Because <a>CreateWorkspaces</a> is an asynchronous operation, some of the
|
|
2667
2979
|
* returned information could be incomplete.</p>
|
|
2668
2980
|
*/
|
|
2669
2981
|
Workspaces?: Workspace[];
|
|
2670
2982
|
/**
|
|
2983
|
+
* @public
|
|
2671
2984
|
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
2672
2985
|
* no more results to return. </p>
|
|
2673
2986
|
*/
|
|
@@ -2678,10 +2991,12 @@ export interface DescribeWorkspacesResult {
|
|
|
2678
2991
|
*/
|
|
2679
2992
|
export interface DescribeWorkspacesConnectionStatusRequest {
|
|
2680
2993
|
/**
|
|
2994
|
+
* @public
|
|
2681
2995
|
* <p>The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.</p>
|
|
2682
2996
|
*/
|
|
2683
2997
|
WorkspaceIds?: string[];
|
|
2684
2998
|
/**
|
|
2999
|
+
* @public
|
|
2685
3000
|
* <p>If you received a <code>NextToken</code> from a previous call that was paginated,
|
|
2686
3001
|
* provide this token to receive the next set of results.</p>
|
|
2687
3002
|
*/
|
|
@@ -2693,19 +3008,23 @@ export interface DescribeWorkspacesConnectionStatusRequest {
|
|
|
2693
3008
|
*/
|
|
2694
3009
|
export interface WorkspaceConnectionStatus {
|
|
2695
3010
|
/**
|
|
3011
|
+
* @public
|
|
2696
3012
|
* <p>The identifier of the WorkSpace.</p>
|
|
2697
3013
|
*/
|
|
2698
3014
|
WorkspaceId?: string;
|
|
2699
3015
|
/**
|
|
3016
|
+
* @public
|
|
2700
3017
|
* <p>The connection state of the WorkSpace. The connection state is unknown if the WorkSpace
|
|
2701
3018
|
* is stopped.</p>
|
|
2702
3019
|
*/
|
|
2703
3020
|
ConnectionState?: ConnectionState | string;
|
|
2704
3021
|
/**
|
|
3022
|
+
* @public
|
|
2705
3023
|
* <p>The timestamp of the connection status check.</p>
|
|
2706
3024
|
*/
|
|
2707
3025
|
ConnectionStateCheckTimestamp?: Date;
|
|
2708
3026
|
/**
|
|
3027
|
+
* @public
|
|
2709
3028
|
* <p>The timestamp of the last known user connection.</p>
|
|
2710
3029
|
*/
|
|
2711
3030
|
LastKnownUserConnectionTimestamp?: Date;
|
|
@@ -2715,10 +3034,12 @@ export interface WorkspaceConnectionStatus {
|
|
|
2715
3034
|
*/
|
|
2716
3035
|
export interface DescribeWorkspacesConnectionStatusResult {
|
|
2717
3036
|
/**
|
|
3037
|
+
* @public
|
|
2718
3038
|
* <p>Information about the connection status of the WorkSpace.</p>
|
|
2719
3039
|
*/
|
|
2720
3040
|
WorkspacesConnectionStatus?: WorkspaceConnectionStatus[];
|
|
2721
3041
|
/**
|
|
3042
|
+
* @public
|
|
2722
3043
|
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
2723
3044
|
* no more results to return. </p>
|
|
2724
3045
|
*/
|
|
@@ -2729,6 +3050,7 @@ export interface DescribeWorkspacesConnectionStatusResult {
|
|
|
2729
3050
|
*/
|
|
2730
3051
|
export interface DescribeWorkspaceSnapshotsRequest {
|
|
2731
3052
|
/**
|
|
3053
|
+
* @public
|
|
2732
3054
|
* <p>The identifier of the WorkSpace.</p>
|
|
2733
3055
|
*/
|
|
2734
3056
|
WorkspaceId: string | undefined;
|
|
@@ -2739,6 +3061,7 @@ export interface DescribeWorkspaceSnapshotsRequest {
|
|
|
2739
3061
|
*/
|
|
2740
3062
|
export interface Snapshot {
|
|
2741
3063
|
/**
|
|
3064
|
+
* @public
|
|
2742
3065
|
* <p>The time when the snapshot was created.</p>
|
|
2743
3066
|
*/
|
|
2744
3067
|
SnapshotTime?: Date;
|
|
@@ -2748,11 +3071,13 @@ export interface Snapshot {
|
|
|
2748
3071
|
*/
|
|
2749
3072
|
export interface DescribeWorkspaceSnapshotsResult {
|
|
2750
3073
|
/**
|
|
3074
|
+
* @public
|
|
2751
3075
|
* <p>Information about the snapshots that can be used to rebuild a WorkSpace. These snapshots
|
|
2752
3076
|
* include the user volume.</p>
|
|
2753
3077
|
*/
|
|
2754
3078
|
RebuildSnapshots?: Snapshot[];
|
|
2755
3079
|
/**
|
|
3080
|
+
* @public
|
|
2756
3081
|
* <p>Information about the snapshots that can be used to restore a WorkSpace. These snapshots
|
|
2757
3082
|
* include both the root volume and the user volume.</p>
|
|
2758
3083
|
*/
|
|
@@ -2763,6 +3088,7 @@ export interface DescribeWorkspaceSnapshotsResult {
|
|
|
2763
3088
|
*/
|
|
2764
3089
|
export interface DisassociateConnectionAliasRequest {
|
|
2765
3090
|
/**
|
|
3091
|
+
* @public
|
|
2766
3092
|
* <p>The identifier of the connection alias to disassociate.</p>
|
|
2767
3093
|
*/
|
|
2768
3094
|
AliasId: string | undefined;
|
|
@@ -2777,10 +3103,12 @@ export interface DisassociateConnectionAliasResult {
|
|
|
2777
3103
|
*/
|
|
2778
3104
|
export interface DisassociateIpGroupsRequest {
|
|
2779
3105
|
/**
|
|
3106
|
+
* @public
|
|
2780
3107
|
* <p>The identifier of the directory.</p>
|
|
2781
3108
|
*/
|
|
2782
3109
|
DirectoryId: string | undefined;
|
|
2783
3110
|
/**
|
|
3111
|
+
* @public
|
|
2784
3112
|
* <p>The identifiers of one or more IP access control groups.</p>
|
|
2785
3113
|
*/
|
|
2786
3114
|
GroupIds: string[] | undefined;
|
|
@@ -2797,14 +3125,17 @@ export interface DisassociateIpGroupsResult {
|
|
|
2797
3125
|
*/
|
|
2798
3126
|
export interface FailedWorkspaceChangeRequest {
|
|
2799
3127
|
/**
|
|
3128
|
+
* @public
|
|
2800
3129
|
* <p>The identifier of the WorkSpace.</p>
|
|
2801
3130
|
*/
|
|
2802
3131
|
WorkspaceId?: string;
|
|
2803
3132
|
/**
|
|
3133
|
+
* @public
|
|
2804
3134
|
* <p>The error code that is returned if the WorkSpace cannot be rebooted.</p>
|
|
2805
3135
|
*/
|
|
2806
3136
|
ErrorCode?: string;
|
|
2807
3137
|
/**
|
|
3138
|
+
* @public
|
|
2808
3139
|
* <p>The text of the error message that is returned if the WorkSpace cannot be
|
|
2809
3140
|
* rebooted.</p>
|
|
2810
3141
|
*/
|
|
@@ -2821,6 +3152,7 @@ export interface FailedWorkspaceChangeRequest {
|
|
|
2821
3152
|
*/
|
|
2822
3153
|
export interface IosImportClientBrandingAttributes {
|
|
2823
3154
|
/**
|
|
3155
|
+
* @public
|
|
2824
3156
|
* <p>The logo. This is the
|
|
2825
3157
|
* standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal
|
|
2826
3158
|
* to one point. The only image format accepted is a binary data object that is converted
|
|
@@ -2828,6 +3160,7 @@ export interface IosImportClientBrandingAttributes {
|
|
|
2828
3160
|
*/
|
|
2829
3161
|
Logo?: Uint8Array;
|
|
2830
3162
|
/**
|
|
3163
|
+
* @public
|
|
2831
3164
|
* <p>The @2x version of the logo. This is the higher resolution display that offers a scale
|
|
2832
3165
|
* factor of 2.0 (or @2x). The only image format accepted is a binary data object that is
|
|
2833
3166
|
* converted from a <code>.png</code> file.</p>
|
|
@@ -2838,6 +3171,7 @@ export interface IosImportClientBrandingAttributes {
|
|
|
2838
3171
|
*/
|
|
2839
3172
|
Logo2x?: Uint8Array;
|
|
2840
3173
|
/**
|
|
3174
|
+
* @public
|
|
2841
3175
|
* <p>The @3x version of the logo. This is the higher resolution display that offers a scale
|
|
2842
3176
|
* factor of 3.0 (or @3x). The only image format accepted is a binary data object that is
|
|
2843
3177
|
* converted from a <code>.png</code> file.</p>
|
|
@@ -2848,6 +3182,7 @@ export interface IosImportClientBrandingAttributes {
|
|
|
2848
3182
|
*/
|
|
2849
3183
|
Logo3x?: Uint8Array;
|
|
2850
3184
|
/**
|
|
3185
|
+
* @public
|
|
2851
3186
|
* <p>The support email. The company's customer support email address.</p>
|
|
2852
3187
|
* <note>
|
|
2853
3188
|
* <ul>
|
|
@@ -2864,6 +3199,7 @@ export interface IosImportClientBrandingAttributes {
|
|
|
2864
3199
|
*/
|
|
2865
3200
|
SupportEmail?: string;
|
|
2866
3201
|
/**
|
|
3202
|
+
* @public
|
|
2867
3203
|
* <p>The support link. The link for the company's customer support page for their
|
|
2868
3204
|
* WorkSpace.</p>
|
|
2869
3205
|
* <note>
|
|
@@ -2881,11 +3217,13 @@ export interface IosImportClientBrandingAttributes {
|
|
|
2881
3217
|
*/
|
|
2882
3218
|
SupportLink?: string;
|
|
2883
3219
|
/**
|
|
3220
|
+
* @public
|
|
2884
3221
|
* <p>The forgotten password link. This is the web address that users can go to if they forget
|
|
2885
3222
|
* the password for their WorkSpace.</p>
|
|
2886
3223
|
*/
|
|
2887
3224
|
ForgotPasswordLink?: string;
|
|
2888
3225
|
/**
|
|
3226
|
+
* @public
|
|
2889
3227
|
* <p>The login message. Specified as a key value pair, in which the key is a locale and the
|
|
2890
3228
|
* value is the localized message for that locale. The only key supported is
|
|
2891
3229
|
* <code>en_US</code>. The HTML tags supported include the following: <code>a, b, blockquote, br, cite, code, dd, dl, dt, div, em,
|
|
@@ -2898,31 +3236,38 @@ export interface IosImportClientBrandingAttributes {
|
|
|
2898
3236
|
*/
|
|
2899
3237
|
export interface ImportClientBrandingRequest {
|
|
2900
3238
|
/**
|
|
3239
|
+
* @public
|
|
2901
3240
|
* <p>The directory identifier of the WorkSpace for which you want to import client
|
|
2902
3241
|
* branding.</p>
|
|
2903
3242
|
*/
|
|
2904
3243
|
ResourceId: string | undefined;
|
|
2905
3244
|
/**
|
|
3245
|
+
* @public
|
|
2906
3246
|
* <p>The branding information to import for Windows devices.</p>
|
|
2907
3247
|
*/
|
|
2908
3248
|
DeviceTypeWindows?: DefaultImportClientBrandingAttributes;
|
|
2909
3249
|
/**
|
|
3250
|
+
* @public
|
|
2910
3251
|
* <p>The branding information to import for macOS devices.</p>
|
|
2911
3252
|
*/
|
|
2912
3253
|
DeviceTypeOsx?: DefaultImportClientBrandingAttributes;
|
|
2913
3254
|
/**
|
|
3255
|
+
* @public
|
|
2914
3256
|
* <p>The branding information to import for Android devices.</p>
|
|
2915
3257
|
*/
|
|
2916
3258
|
DeviceTypeAndroid?: DefaultImportClientBrandingAttributes;
|
|
2917
3259
|
/**
|
|
3260
|
+
* @public
|
|
2918
3261
|
* <p>The branding information to import for iOS devices.</p>
|
|
2919
3262
|
*/
|
|
2920
3263
|
DeviceTypeIos?: IosImportClientBrandingAttributes;
|
|
2921
3264
|
/**
|
|
3265
|
+
* @public
|
|
2922
3266
|
* <p>The branding information to import for Linux devices.</p>
|
|
2923
3267
|
*/
|
|
2924
3268
|
DeviceTypeLinux?: DefaultImportClientBrandingAttributes;
|
|
2925
3269
|
/**
|
|
3270
|
+
* @public
|
|
2926
3271
|
* <p>The branding information to import for web access.</p>
|
|
2927
3272
|
*/
|
|
2928
3273
|
DeviceTypeWeb?: DefaultImportClientBrandingAttributes;
|
|
@@ -2932,26 +3277,32 @@ export interface ImportClientBrandingRequest {
|
|
|
2932
3277
|
*/
|
|
2933
3278
|
export interface ImportClientBrandingResult {
|
|
2934
3279
|
/**
|
|
3280
|
+
* @public
|
|
2935
3281
|
* <p>The branding information configured for Windows devices.</p>
|
|
2936
3282
|
*/
|
|
2937
3283
|
DeviceTypeWindows?: DefaultClientBrandingAttributes;
|
|
2938
3284
|
/**
|
|
3285
|
+
* @public
|
|
2939
3286
|
* <p>The branding information configured for macOS devices.</p>
|
|
2940
3287
|
*/
|
|
2941
3288
|
DeviceTypeOsx?: DefaultClientBrandingAttributes;
|
|
2942
3289
|
/**
|
|
3290
|
+
* @public
|
|
2943
3291
|
* <p>The branding information configured for Android devices.</p>
|
|
2944
3292
|
*/
|
|
2945
3293
|
DeviceTypeAndroid?: DefaultClientBrandingAttributes;
|
|
2946
3294
|
/**
|
|
3295
|
+
* @public
|
|
2947
3296
|
* <p>The branding information configured for iOS devices.</p>
|
|
2948
3297
|
*/
|
|
2949
3298
|
DeviceTypeIos?: IosClientBrandingAttributes;
|
|
2950
3299
|
/**
|
|
3300
|
+
* @public
|
|
2951
3301
|
* <p>The branding information configured for Linux devices.</p>
|
|
2952
3302
|
*/
|
|
2953
3303
|
DeviceTypeLinux?: DefaultClientBrandingAttributes;
|
|
2954
3304
|
/**
|
|
3305
|
+
* @public
|
|
2955
3306
|
* <p>The branding information configured for web access.</p>
|
|
2956
3307
|
*/
|
|
2957
3308
|
DeviceTypeWeb?: DefaultClientBrandingAttributes;
|
|
@@ -2978,10 +3329,12 @@ export type WorkspaceImageIngestionProcess = (typeof WorkspaceImageIngestionProc
|
|
|
2978
3329
|
*/
|
|
2979
3330
|
export interface ImportWorkspaceImageRequest {
|
|
2980
3331
|
/**
|
|
3332
|
+
* @public
|
|
2981
3333
|
* <p>The identifier of the EC2 image.</p>
|
|
2982
3334
|
*/
|
|
2983
3335
|
Ec2ImageId: string | undefined;
|
|
2984
3336
|
/**
|
|
3337
|
+
* @public
|
|
2985
3338
|
* <p>The ingestion process to be used when importing the image, depending on which protocol
|
|
2986
3339
|
* you want to use for your BYOL Workspace image, either PCoIP, WorkSpaces Streaming Protocol
|
|
2987
3340
|
* (WSP), or bring your own protocol (BYOP). To use WSP, specify a value that ends in
|
|
@@ -2998,18 +3351,22 @@ export interface ImportWorkspaceImageRequest {
|
|
|
2998
3351
|
*/
|
|
2999
3352
|
IngestionProcess: WorkspaceImageIngestionProcess | string | undefined;
|
|
3000
3353
|
/**
|
|
3354
|
+
* @public
|
|
3001
3355
|
* <p>The name of the WorkSpace image.</p>
|
|
3002
3356
|
*/
|
|
3003
3357
|
ImageName: string | undefined;
|
|
3004
3358
|
/**
|
|
3359
|
+
* @public
|
|
3005
3360
|
* <p>The description of the WorkSpace image.</p>
|
|
3006
3361
|
*/
|
|
3007
3362
|
ImageDescription: string | undefined;
|
|
3008
3363
|
/**
|
|
3364
|
+
* @public
|
|
3009
3365
|
* <p>The tags. Each WorkSpaces resource can have a maximum of 50 tags.</p>
|
|
3010
3366
|
*/
|
|
3011
3367
|
Tags?: Tag[];
|
|
3012
3368
|
/**
|
|
3369
|
+
* @public
|
|
3013
3370
|
* <p>If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11
|
|
3014
3371
|
* 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
|
|
3015
3372
|
* Your Own Windows Desktop Licenses</a>.</p>
|
|
@@ -3031,6 +3388,7 @@ export interface ImportWorkspaceImageRequest {
|
|
|
3031
3388
|
*/
|
|
3032
3389
|
export interface ImportWorkspaceImageResult {
|
|
3033
3390
|
/**
|
|
3391
|
+
* @public
|
|
3034
3392
|
* <p>The identifier of the WorkSpace image.</p>
|
|
3035
3393
|
*/
|
|
3036
3394
|
ImageId?: string;
|
|
@@ -3040,15 +3398,18 @@ export interface ImportWorkspaceImageResult {
|
|
|
3040
3398
|
*/
|
|
3041
3399
|
export interface ListAvailableManagementCidrRangesRequest {
|
|
3042
3400
|
/**
|
|
3401
|
+
* @public
|
|
3043
3402
|
* <p>The IP address range to search. Specify an IP address range that is compatible with your
|
|
3044
3403
|
* network and in CIDR notation (that is, specify the range as an IPv4 CIDR block).</p>
|
|
3045
3404
|
*/
|
|
3046
3405
|
ManagementCidrRangeConstraint: string | undefined;
|
|
3047
3406
|
/**
|
|
3407
|
+
* @public
|
|
3048
3408
|
* <p>The maximum number of items to return.</p>
|
|
3049
3409
|
*/
|
|
3050
3410
|
MaxResults?: number;
|
|
3051
3411
|
/**
|
|
3412
|
+
* @public
|
|
3052
3413
|
* <p>If you received a <code>NextToken</code> from a previous call that was paginated,
|
|
3053
3414
|
* provide this token to receive the next set of results.</p>
|
|
3054
3415
|
*/
|
|
@@ -3059,10 +3420,12 @@ export interface ListAvailableManagementCidrRangesRequest {
|
|
|
3059
3420
|
*/
|
|
3060
3421
|
export interface ListAvailableManagementCidrRangesResult {
|
|
3061
3422
|
/**
|
|
3423
|
+
* @public
|
|
3062
3424
|
* <p>The list of available IP address ranges, specified as IPv4 CIDR blocks.</p>
|
|
3063
3425
|
*/
|
|
3064
3426
|
ManagementCidrRanges?: string[];
|
|
3065
3427
|
/**
|
|
3428
|
+
* @public
|
|
3066
3429
|
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
3067
3430
|
* no more results to return. </p>
|
|
3068
3431
|
*/
|
|
@@ -3073,10 +3436,12 @@ export interface ListAvailableManagementCidrRangesResult {
|
|
|
3073
3436
|
*/
|
|
3074
3437
|
export interface MigrateWorkspaceRequest {
|
|
3075
3438
|
/**
|
|
3439
|
+
* @public
|
|
3076
3440
|
* <p>The identifier of the WorkSpace to migrate from.</p>
|
|
3077
3441
|
*/
|
|
3078
3442
|
SourceWorkspaceId: string | undefined;
|
|
3079
3443
|
/**
|
|
3444
|
+
* @public
|
|
3080
3445
|
* <p>The identifier of the target bundle type to migrate the WorkSpace to.</p>
|
|
3081
3446
|
*/
|
|
3082
3447
|
BundleId: string | undefined;
|
|
@@ -3086,10 +3451,12 @@ export interface MigrateWorkspaceRequest {
|
|
|
3086
3451
|
*/
|
|
3087
3452
|
export interface MigrateWorkspaceResult {
|
|
3088
3453
|
/**
|
|
3454
|
+
* @public
|
|
3089
3455
|
* <p>The original identifier of the WorkSpace that is being migrated.</p>
|
|
3090
3456
|
*/
|
|
3091
3457
|
SourceWorkspaceId?: string;
|
|
3092
3458
|
/**
|
|
3459
|
+
* @public
|
|
3093
3460
|
* <p>The new identifier of the WorkSpace that is being migrated. If the migration does not
|
|
3094
3461
|
* succeed, the target WorkSpace ID will not be used, and the WorkSpace will still have the
|
|
3095
3462
|
* original WorkSpace ID.</p>
|
|
@@ -3113,10 +3480,12 @@ export declare class OperationInProgressException extends __BaseException {
|
|
|
3113
3480
|
*/
|
|
3114
3481
|
export interface ModifyAccountRequest {
|
|
3115
3482
|
/**
|
|
3483
|
+
* @public
|
|
3116
3484
|
* <p>The status of BYOL.</p>
|
|
3117
3485
|
*/
|
|
3118
3486
|
DedicatedTenancySupport?: DedicatedTenancySupportEnum | string;
|
|
3119
3487
|
/**
|
|
3488
|
+
* @public
|
|
3120
3489
|
* <p>The IP address range, specified as an IPv4 CIDR block, for the management network
|
|
3121
3490
|
* interface. Specify an IP address range that is compatible with your network and in CIDR
|
|
3122
3491
|
* notation (that is, specify the range as an IPv4 CIDR block). The CIDR block size must be
|
|
@@ -3135,14 +3504,17 @@ export interface ModifyAccountResult {
|
|
|
3135
3504
|
*/
|
|
3136
3505
|
export interface ModifyCertificateBasedAuthPropertiesRequest {
|
|
3137
3506
|
/**
|
|
3507
|
+
* @public
|
|
3138
3508
|
* <p>The resource identifiers, in the form of directory IDs.</p>
|
|
3139
3509
|
*/
|
|
3140
3510
|
ResourceId: string | undefined;
|
|
3141
3511
|
/**
|
|
3512
|
+
* @public
|
|
3142
3513
|
* <p>The properties of the certificate-based authentication.</p>
|
|
3143
3514
|
*/
|
|
3144
3515
|
CertificateBasedAuthProperties?: CertificateBasedAuthProperties;
|
|
3145
3516
|
/**
|
|
3517
|
+
* @public
|
|
3146
3518
|
* <p>The properties of the certificate-based authentication you want to delete.</p>
|
|
3147
3519
|
*/
|
|
3148
3520
|
PropertiesToDelete?: (DeletableCertificateBasedAuthProperty | string)[];
|
|
@@ -3157,10 +3529,12 @@ export interface ModifyCertificateBasedAuthPropertiesResult {
|
|
|
3157
3529
|
*/
|
|
3158
3530
|
export interface ModifyClientPropertiesRequest {
|
|
3159
3531
|
/**
|
|
3532
|
+
* @public
|
|
3160
3533
|
* <p>The resource identifiers, in the form of directory IDs.</p>
|
|
3161
3534
|
*/
|
|
3162
3535
|
ResourceId: string | undefined;
|
|
3163
3536
|
/**
|
|
3537
|
+
* @public
|
|
3164
3538
|
* <p>Information about the Amazon WorkSpaces client.</p>
|
|
3165
3539
|
*/
|
|
3166
3540
|
ClientProperties: ClientProperties | undefined;
|
|
@@ -3175,14 +3549,17 @@ export interface ModifyClientPropertiesResult {
|
|
|
3175
3549
|
*/
|
|
3176
3550
|
export interface ModifySamlPropertiesRequest {
|
|
3177
3551
|
/**
|
|
3552
|
+
* @public
|
|
3178
3553
|
* <p>The directory identifier for which you want to configure SAML properties.</p>
|
|
3179
3554
|
*/
|
|
3180
3555
|
ResourceId: string | undefined;
|
|
3181
3556
|
/**
|
|
3557
|
+
* @public
|
|
3182
3558
|
* <p>The properties for configuring SAML 2.0 authentication.</p>
|
|
3183
3559
|
*/
|
|
3184
3560
|
SamlProperties?: SamlProperties;
|
|
3185
3561
|
/**
|
|
3562
|
+
* @public
|
|
3186
3563
|
* <p>The SAML properties to delete as part of your request.</p>
|
|
3187
3564
|
* <p>Specify one of the following options:</p>
|
|
3188
3565
|
* <ul>
|
|
@@ -3209,10 +3586,12 @@ export interface ModifySamlPropertiesResult {
|
|
|
3209
3586
|
*/
|
|
3210
3587
|
export interface ModifySelfservicePermissionsRequest {
|
|
3211
3588
|
/**
|
|
3589
|
+
* @public
|
|
3212
3590
|
* <p>The identifier of the directory.</p>
|
|
3213
3591
|
*/
|
|
3214
3592
|
ResourceId: string | undefined;
|
|
3215
3593
|
/**
|
|
3594
|
+
* @public
|
|
3216
3595
|
* <p>The permissions to enable or disable self-service capabilities.</p>
|
|
3217
3596
|
*/
|
|
3218
3597
|
SelfservicePermissions: SelfservicePermissions | undefined;
|
|
@@ -3227,10 +3606,12 @@ export interface ModifySelfservicePermissionsResult {
|
|
|
3227
3606
|
*/
|
|
3228
3607
|
export interface ModifyWorkspaceAccessPropertiesRequest {
|
|
3229
3608
|
/**
|
|
3609
|
+
* @public
|
|
3230
3610
|
* <p>The identifier of the directory.</p>
|
|
3231
3611
|
*/
|
|
3232
3612
|
ResourceId: string | undefined;
|
|
3233
3613
|
/**
|
|
3614
|
+
* @public
|
|
3234
3615
|
* <p>The device types and operating systems to enable or disable for access.</p>
|
|
3235
3616
|
*/
|
|
3236
3617
|
WorkspaceAccessProperties: WorkspaceAccessProperties | undefined;
|
|
@@ -3248,6 +3629,7 @@ export interface ModifyWorkspaceAccessPropertiesResult {
|
|
|
3248
3629
|
*/
|
|
3249
3630
|
export interface WorkspaceCreationProperties {
|
|
3250
3631
|
/**
|
|
3632
|
+
* @public
|
|
3251
3633
|
* <p>Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.</p>
|
|
3252
3634
|
* <note>
|
|
3253
3635
|
* <p>If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new
|
|
@@ -3264,10 +3646,12 @@ export interface WorkspaceCreationProperties {
|
|
|
3264
3646
|
*/
|
|
3265
3647
|
EnableWorkDocs?: boolean;
|
|
3266
3648
|
/**
|
|
3649
|
+
* @public
|
|
3267
3650
|
* <p>Indicates whether internet access is enabled for your WorkSpaces.</p>
|
|
3268
3651
|
*/
|
|
3269
3652
|
EnableInternetAccess?: boolean;
|
|
3270
3653
|
/**
|
|
3654
|
+
* @public
|
|
3271
3655
|
* <p>The default organizational unit (OU) for your WorkSpaces directories. This string must
|
|
3272
3656
|
* be the full Lightweight Directory Access Protocol (LDAP) distinguished name for the target
|
|
3273
3657
|
* domain and OU. It must be in the form
|
|
@@ -3289,14 +3673,17 @@ export interface WorkspaceCreationProperties {
|
|
|
3289
3673
|
*/
|
|
3290
3674
|
DefaultOu?: string;
|
|
3291
3675
|
/**
|
|
3676
|
+
* @public
|
|
3292
3677
|
* <p>The identifier of your custom security group.</p>
|
|
3293
3678
|
*/
|
|
3294
3679
|
CustomSecurityGroupId?: string;
|
|
3295
3680
|
/**
|
|
3681
|
+
* @public
|
|
3296
3682
|
* <p>Indicates whether users are local administrators of their WorkSpaces.</p>
|
|
3297
3683
|
*/
|
|
3298
3684
|
UserEnabledAsLocalAdministrator?: boolean;
|
|
3299
3685
|
/**
|
|
3686
|
+
* @public
|
|
3300
3687
|
* <p>Indicates whether maintenance mode is enabled for your WorkSpaces. For more information,
|
|
3301
3688
|
* see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html">WorkSpace
|
|
3302
3689
|
* Maintenance</a>. </p>
|
|
@@ -3308,10 +3695,12 @@ export interface WorkspaceCreationProperties {
|
|
|
3308
3695
|
*/
|
|
3309
3696
|
export interface ModifyWorkspaceCreationPropertiesRequest {
|
|
3310
3697
|
/**
|
|
3698
|
+
* @public
|
|
3311
3699
|
* <p>The identifier of the directory.</p>
|
|
3312
3700
|
*/
|
|
3313
3701
|
ResourceId: string | undefined;
|
|
3314
3702
|
/**
|
|
3703
|
+
* @public
|
|
3315
3704
|
* <p>The default properties for creating WorkSpaces.</p>
|
|
3316
3705
|
*/
|
|
3317
3706
|
WorkspaceCreationProperties: WorkspaceCreationProperties | undefined;
|
|
@@ -3326,10 +3715,12 @@ export interface ModifyWorkspaceCreationPropertiesResult {
|
|
|
3326
3715
|
*/
|
|
3327
3716
|
export interface ModifyWorkspacePropertiesRequest {
|
|
3328
3717
|
/**
|
|
3718
|
+
* @public
|
|
3329
3719
|
* <p>The identifier of the WorkSpace.</p>
|
|
3330
3720
|
*/
|
|
3331
3721
|
WorkspaceId: string | undefined;
|
|
3332
3722
|
/**
|
|
3723
|
+
* @public
|
|
3333
3724
|
* <p>The properties of the WorkSpace.</p>
|
|
3334
3725
|
*/
|
|
3335
3726
|
WorkspaceProperties: WorkspaceProperties | undefined;
|
|
@@ -3370,10 +3761,12 @@ export type TargetWorkspaceState = (typeof TargetWorkspaceState)[keyof typeof Ta
|
|
|
3370
3761
|
*/
|
|
3371
3762
|
export interface ModifyWorkspaceStateRequest {
|
|
3372
3763
|
/**
|
|
3764
|
+
* @public
|
|
3373
3765
|
* <p>The identifier of the WorkSpace.</p>
|
|
3374
3766
|
*/
|
|
3375
3767
|
WorkspaceId: string | undefined;
|
|
3376
3768
|
/**
|
|
3769
|
+
* @public
|
|
3377
3770
|
* <p>The WorkSpace state.</p>
|
|
3378
3771
|
*/
|
|
3379
3772
|
WorkspaceState: TargetWorkspaceState | string | undefined;
|
|
@@ -3389,6 +3782,7 @@ export interface ModifyWorkspaceStateResult {
|
|
|
3389
3782
|
*/
|
|
3390
3783
|
export interface RebootRequest {
|
|
3391
3784
|
/**
|
|
3785
|
+
* @public
|
|
3392
3786
|
* <p>The identifier of the WorkSpace.</p>
|
|
3393
3787
|
*/
|
|
3394
3788
|
WorkspaceId: string | undefined;
|
|
@@ -3398,6 +3792,7 @@ export interface RebootRequest {
|
|
|
3398
3792
|
*/
|
|
3399
3793
|
export interface RebootWorkspacesRequest {
|
|
3400
3794
|
/**
|
|
3795
|
+
* @public
|
|
3401
3796
|
* <p>The WorkSpaces to reboot. You can specify up to 25 WorkSpaces.</p>
|
|
3402
3797
|
*/
|
|
3403
3798
|
RebootWorkspaceRequests: RebootRequest[] | undefined;
|
|
@@ -3407,6 +3802,7 @@ export interface RebootWorkspacesRequest {
|
|
|
3407
3802
|
*/
|
|
3408
3803
|
export interface RebootWorkspacesResult {
|
|
3409
3804
|
/**
|
|
3805
|
+
* @public
|
|
3410
3806
|
* <p>Information about the WorkSpaces that could not be rebooted.</p>
|
|
3411
3807
|
*/
|
|
3412
3808
|
FailedRequests?: FailedWorkspaceChangeRequest[];
|
|
@@ -3417,6 +3813,7 @@ export interface RebootWorkspacesResult {
|
|
|
3417
3813
|
*/
|
|
3418
3814
|
export interface RebuildRequest {
|
|
3419
3815
|
/**
|
|
3816
|
+
* @public
|
|
3420
3817
|
* <p>The identifier of the WorkSpace.</p>
|
|
3421
3818
|
*/
|
|
3422
3819
|
WorkspaceId: string | undefined;
|
|
@@ -3426,6 +3823,7 @@ export interface RebuildRequest {
|
|
|
3426
3823
|
*/
|
|
3427
3824
|
export interface RebuildWorkspacesRequest {
|
|
3428
3825
|
/**
|
|
3826
|
+
* @public
|
|
3429
3827
|
* <p>The WorkSpace to rebuild. You can specify a single WorkSpace.</p>
|
|
3430
3828
|
*/
|
|
3431
3829
|
RebuildWorkspaceRequests: RebuildRequest[] | undefined;
|
|
@@ -3435,6 +3833,7 @@ export interface RebuildWorkspacesRequest {
|
|
|
3435
3833
|
*/
|
|
3436
3834
|
export interface RebuildWorkspacesResult {
|
|
3437
3835
|
/**
|
|
3836
|
+
* @public
|
|
3438
3837
|
* <p>Information about the WorkSpace that could not be rebuilt.</p>
|
|
3439
3838
|
*/
|
|
3440
3839
|
FailedRequests?: FailedWorkspaceChangeRequest[];
|
|
@@ -3444,6 +3843,7 @@ export interface RebuildWorkspacesResult {
|
|
|
3444
3843
|
*/
|
|
3445
3844
|
export interface RegisterWorkspaceDirectoryRequest {
|
|
3446
3845
|
/**
|
|
3846
|
+
* @public
|
|
3447
3847
|
* <p>The identifier of the directory. You cannot register a directory if it does not have a
|
|
3448
3848
|
* status of Active. If the directory does not have a status of Active, you will receive an
|
|
3449
3849
|
* InvalidResourceStateException error. If you have already registered the maximum number of
|
|
@@ -3453,6 +3853,7 @@ export interface RegisterWorkspaceDirectoryRequest {
|
|
|
3453
3853
|
*/
|
|
3454
3854
|
DirectoryId: string | undefined;
|
|
3455
3855
|
/**
|
|
3856
|
+
* @public
|
|
3456
3857
|
* <p>The identifiers of the subnets for your virtual private cloud (VPC). Make sure that the
|
|
3457
3858
|
* subnets are in supported Availability Zones. The subnets must also be in separate
|
|
3458
3859
|
* Availability Zones. If these conditions are not met, you will receive an
|
|
@@ -3460,6 +3861,7 @@ export interface RegisterWorkspaceDirectoryRequest {
|
|
|
3460
3861
|
*/
|
|
3461
3862
|
SubnetIds?: string[];
|
|
3462
3863
|
/**
|
|
3864
|
+
* @public
|
|
3463
3865
|
* <p>Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this
|
|
3464
3866
|
* parameter and WorkDocs is not available in the Region, you will receive an
|
|
3465
3867
|
* OperationNotSupportedException error. Set <code>EnableWorkDocs</code> to disabled, and try
|
|
@@ -3467,10 +3869,12 @@ export interface RegisterWorkspaceDirectoryRequest {
|
|
|
3467
3869
|
*/
|
|
3468
3870
|
EnableWorkDocs: boolean | undefined;
|
|
3469
3871
|
/**
|
|
3872
|
+
* @public
|
|
3470
3873
|
* <p>Indicates whether self-service capabilities are enabled or disabled.</p>
|
|
3471
3874
|
*/
|
|
3472
3875
|
EnableSelfService?: boolean;
|
|
3473
3876
|
/**
|
|
3877
|
+
* @public
|
|
3474
3878
|
* <p>Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own
|
|
3475
3879
|
* 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
|
|
3476
3880
|
* BYOL, you will receive an InvalidParameterValuesException error. For more information about
|
|
@@ -3479,6 +3883,7 @@ export interface RegisterWorkspaceDirectoryRequest {
|
|
|
3479
3883
|
*/
|
|
3480
3884
|
Tenancy?: Tenancy | string;
|
|
3481
3885
|
/**
|
|
3886
|
+
* @public
|
|
3482
3887
|
* <p>The tags associated with the directory.</p>
|
|
3483
3888
|
*/
|
|
3484
3889
|
Tags?: Tag[];
|
|
@@ -3521,6 +3926,7 @@ export declare class WorkspacesDefaultRoleNotFoundException extends __BaseExcept
|
|
|
3521
3926
|
*/
|
|
3522
3927
|
export interface RestoreWorkspaceRequest {
|
|
3523
3928
|
/**
|
|
3929
|
+
* @public
|
|
3524
3930
|
* <p>The identifier of the WorkSpace.</p>
|
|
3525
3931
|
*/
|
|
3526
3932
|
WorkspaceId: string | undefined;
|
|
@@ -3535,10 +3941,12 @@ export interface RestoreWorkspaceResult {
|
|
|
3535
3941
|
*/
|
|
3536
3942
|
export interface RevokeIpRulesRequest {
|
|
3537
3943
|
/**
|
|
3944
|
+
* @public
|
|
3538
3945
|
* <p>The identifier of the group.</p>
|
|
3539
3946
|
*/
|
|
3540
3947
|
GroupId: string | undefined;
|
|
3541
3948
|
/**
|
|
3949
|
+
* @public
|
|
3542
3950
|
* <p>The rules to remove from the group.</p>
|
|
3543
3951
|
*/
|
|
3544
3952
|
UserRules: string[] | undefined;
|
|
@@ -3554,6 +3962,7 @@ export interface RevokeIpRulesResult {
|
|
|
3554
3962
|
*/
|
|
3555
3963
|
export interface StartRequest {
|
|
3556
3964
|
/**
|
|
3965
|
+
* @public
|
|
3557
3966
|
* <p>The identifier of the WorkSpace.</p>
|
|
3558
3967
|
*/
|
|
3559
3968
|
WorkspaceId?: string;
|
|
@@ -3563,6 +3972,7 @@ export interface StartRequest {
|
|
|
3563
3972
|
*/
|
|
3564
3973
|
export interface StartWorkspacesRequest {
|
|
3565
3974
|
/**
|
|
3975
|
+
* @public
|
|
3566
3976
|
* <p>The WorkSpaces to start. You can specify up to 25 WorkSpaces.</p>
|
|
3567
3977
|
*/
|
|
3568
3978
|
StartWorkspaceRequests: StartRequest[] | undefined;
|
|
@@ -3572,6 +3982,7 @@ export interface StartWorkspacesRequest {
|
|
|
3572
3982
|
*/
|
|
3573
3983
|
export interface StartWorkspacesResult {
|
|
3574
3984
|
/**
|
|
3985
|
+
* @public
|
|
3575
3986
|
* <p>Information about the WorkSpaces that could not be started.</p>
|
|
3576
3987
|
*/
|
|
3577
3988
|
FailedRequests?: FailedWorkspaceChangeRequest[];
|
|
@@ -3582,6 +3993,7 @@ export interface StartWorkspacesResult {
|
|
|
3582
3993
|
*/
|
|
3583
3994
|
export interface StopRequest {
|
|
3584
3995
|
/**
|
|
3996
|
+
* @public
|
|
3585
3997
|
* <p>The identifier of the WorkSpace.</p>
|
|
3586
3998
|
*/
|
|
3587
3999
|
WorkspaceId?: string;
|
|
@@ -3591,6 +4003,7 @@ export interface StopRequest {
|
|
|
3591
4003
|
*/
|
|
3592
4004
|
export interface StopWorkspacesRequest {
|
|
3593
4005
|
/**
|
|
4006
|
+
* @public
|
|
3594
4007
|
* <p>The WorkSpaces to stop. You can specify up to 25 WorkSpaces.</p>
|
|
3595
4008
|
*/
|
|
3596
4009
|
StopWorkspaceRequests: StopRequest[] | undefined;
|
|
@@ -3600,6 +4013,7 @@ export interface StopWorkspacesRequest {
|
|
|
3600
4013
|
*/
|
|
3601
4014
|
export interface StopWorkspacesResult {
|
|
3602
4015
|
/**
|
|
4016
|
+
* @public
|
|
3603
4017
|
* <p>Information about the WorkSpaces that could not be stopped.</p>
|
|
3604
4018
|
*/
|
|
3605
4019
|
FailedRequests?: FailedWorkspaceChangeRequest[];
|
|
@@ -3610,6 +4024,7 @@ export interface StopWorkspacesResult {
|
|
|
3610
4024
|
*/
|
|
3611
4025
|
export interface TerminateRequest {
|
|
3612
4026
|
/**
|
|
4027
|
+
* @public
|
|
3613
4028
|
* <p>The identifier of the WorkSpace.</p>
|
|
3614
4029
|
*/
|
|
3615
4030
|
WorkspaceId: string | undefined;
|
|
@@ -3619,6 +4034,7 @@ export interface TerminateRequest {
|
|
|
3619
4034
|
*/
|
|
3620
4035
|
export interface TerminateWorkspacesRequest {
|
|
3621
4036
|
/**
|
|
4037
|
+
* @public
|
|
3622
4038
|
* <p>The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.</p>
|
|
3623
4039
|
*/
|
|
3624
4040
|
TerminateWorkspaceRequests: TerminateRequest[] | undefined;
|
|
@@ -3628,6 +4044,7 @@ export interface TerminateWorkspacesRequest {
|
|
|
3628
4044
|
*/
|
|
3629
4045
|
export interface TerminateWorkspacesResult {
|
|
3630
4046
|
/**
|
|
4047
|
+
* @public
|
|
3631
4048
|
* <p>Information about the WorkSpaces that could not be terminated.</p>
|
|
3632
4049
|
*/
|
|
3633
4050
|
FailedRequests?: FailedWorkspaceChangeRequest[];
|
|
@@ -3637,18 +4054,22 @@ export interface TerminateWorkspacesResult {
|
|
|
3637
4054
|
*/
|
|
3638
4055
|
export interface UpdateConnectClientAddInRequest {
|
|
3639
4056
|
/**
|
|
4057
|
+
* @public
|
|
3640
4058
|
* <p>The identifier of the client add-in to update.</p>
|
|
3641
4059
|
*/
|
|
3642
4060
|
AddInId: string | undefined;
|
|
3643
4061
|
/**
|
|
4062
|
+
* @public
|
|
3644
4063
|
* <p>The directory identifier for which the client add-in is configured.</p>
|
|
3645
4064
|
*/
|
|
3646
4065
|
ResourceId: string | undefined;
|
|
3647
4066
|
/**
|
|
4067
|
+
* @public
|
|
3648
4068
|
* <p>The name of the client add-in.</p>
|
|
3649
4069
|
*/
|
|
3650
4070
|
Name?: string;
|
|
3651
4071
|
/**
|
|
4072
|
+
* @public
|
|
3652
4073
|
* <p>The endpoint URL of the Amazon Connect client add-in.</p>
|
|
3653
4074
|
*/
|
|
3654
4075
|
URL?: string;
|
|
@@ -3663,10 +4084,12 @@ export interface UpdateConnectClientAddInResult {
|
|
|
3663
4084
|
*/
|
|
3664
4085
|
export interface UpdateConnectionAliasPermissionRequest {
|
|
3665
4086
|
/**
|
|
4087
|
+
* @public
|
|
3666
4088
|
* <p>The identifier of the connection alias that you want to update permissions for.</p>
|
|
3667
4089
|
*/
|
|
3668
4090
|
AliasId: string | undefined;
|
|
3669
4091
|
/**
|
|
4092
|
+
* @public
|
|
3670
4093
|
* <p>Indicates whether to share or unshare the connection alias with the specified Amazon Web Services account.</p>
|
|
3671
4094
|
*/
|
|
3672
4095
|
ConnectionAliasPermission: ConnectionAliasPermission | undefined;
|
|
@@ -3681,10 +4104,12 @@ export interface UpdateConnectionAliasPermissionResult {
|
|
|
3681
4104
|
*/
|
|
3682
4105
|
export interface UpdateRulesOfIpGroupRequest {
|
|
3683
4106
|
/**
|
|
4107
|
+
* @public
|
|
3684
4108
|
* <p>The identifier of the group.</p>
|
|
3685
4109
|
*/
|
|
3686
4110
|
GroupId: string | undefined;
|
|
3687
4111
|
/**
|
|
4112
|
+
* @public
|
|
3688
4113
|
* <p>One or more rules.</p>
|
|
3689
4114
|
*/
|
|
3690
4115
|
UserRules: IpRuleItem[] | undefined;
|
|
@@ -3699,10 +4124,12 @@ export interface UpdateRulesOfIpGroupResult {
|
|
|
3699
4124
|
*/
|
|
3700
4125
|
export interface UpdateWorkspaceBundleRequest {
|
|
3701
4126
|
/**
|
|
4127
|
+
* @public
|
|
3702
4128
|
* <p>The identifier of the bundle.</p>
|
|
3703
4129
|
*/
|
|
3704
4130
|
BundleId?: string;
|
|
3705
4131
|
/**
|
|
4132
|
+
* @public
|
|
3706
4133
|
* <p>The identifier of the image.</p>
|
|
3707
4134
|
*/
|
|
3708
4135
|
ImageId?: string;
|
|
@@ -3717,15 +4144,18 @@ export interface UpdateWorkspaceBundleResult {
|
|
|
3717
4144
|
*/
|
|
3718
4145
|
export interface UpdateWorkspaceImagePermissionRequest {
|
|
3719
4146
|
/**
|
|
4147
|
+
* @public
|
|
3720
4148
|
* <p>The identifier of the image.</p>
|
|
3721
4149
|
*/
|
|
3722
4150
|
ImageId: string | undefined;
|
|
3723
4151
|
/**
|
|
4152
|
+
* @public
|
|
3724
4153
|
* <p>The permission to copy the image. This permission can be revoked only after an image has
|
|
3725
4154
|
* been shared.</p>
|
|
3726
4155
|
*/
|
|
3727
4156
|
AllowCopyImage: boolean | undefined;
|
|
3728
4157
|
/**
|
|
4158
|
+
* @public
|
|
3729
4159
|
* <p>The identifier of the Amazon Web Services account to share or unshare the image
|
|
3730
4160
|
* with.</p>
|
|
3731
4161
|
* <important>
|