@aws-sdk/client-appstream 3.379.1 → 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.
- package/dist-types/models/models_0.d.ts +594 -0
- package/package.json +5 -5
|
@@ -17,10 +17,12 @@ export type AccessEndpointType = (typeof AccessEndpointType)[keyof typeof Access
|
|
|
17
17
|
*/
|
|
18
18
|
export interface AccessEndpoint {
|
|
19
19
|
/**
|
|
20
|
+
* @public
|
|
20
21
|
* <p>The type of interface endpoint.</p>
|
|
21
22
|
*/
|
|
22
23
|
EndpointType: AccessEndpointType | string | undefined;
|
|
23
24
|
/**
|
|
25
|
+
* @public
|
|
24
26
|
* <p>The identifier (ID) of the VPC in which the interface endpoint is used.</p>
|
|
25
27
|
*/
|
|
26
28
|
VpceId?: string;
|
|
@@ -48,10 +50,12 @@ export type Action = (typeof Action)[keyof typeof Action];
|
|
|
48
50
|
*/
|
|
49
51
|
export interface ErrorDetails {
|
|
50
52
|
/**
|
|
53
|
+
* @public
|
|
51
54
|
* <p>The error code.</p>
|
|
52
55
|
*/
|
|
53
56
|
ErrorCode?: string;
|
|
54
57
|
/**
|
|
58
|
+
* @public
|
|
55
59
|
* <p>The error message.</p>
|
|
56
60
|
*/
|
|
57
61
|
ErrorMessage?: string;
|
|
@@ -74,10 +78,12 @@ export type PackagingType = (typeof PackagingType)[keyof typeof PackagingType];
|
|
|
74
78
|
*/
|
|
75
79
|
export interface S3Location {
|
|
76
80
|
/**
|
|
81
|
+
* @public
|
|
77
82
|
* <p>The S3 bucket of the S3 object.</p>
|
|
78
83
|
*/
|
|
79
84
|
S3Bucket: string | undefined;
|
|
80
85
|
/**
|
|
86
|
+
* @public
|
|
81
87
|
* <p>The S3 key of the S3 object.</p>
|
|
82
88
|
* <p>This is required when used for the following:</p>
|
|
83
89
|
* <ul>
|
|
@@ -111,18 +117,22 @@ export interface S3Location {
|
|
|
111
117
|
*/
|
|
112
118
|
export interface ScriptDetails {
|
|
113
119
|
/**
|
|
120
|
+
* @public
|
|
114
121
|
* <p>The S3 object location for the script.</p>
|
|
115
122
|
*/
|
|
116
123
|
ScriptS3Location: S3Location | undefined;
|
|
117
124
|
/**
|
|
125
|
+
* @public
|
|
118
126
|
* <p>The run path for the script.</p>
|
|
119
127
|
*/
|
|
120
128
|
ExecutablePath: string | undefined;
|
|
121
129
|
/**
|
|
130
|
+
* @public
|
|
122
131
|
* <p>The runtime parameters passed to the run path for the script.</p>
|
|
123
132
|
*/
|
|
124
133
|
ExecutableParameters?: string;
|
|
125
134
|
/**
|
|
135
|
+
* @public
|
|
126
136
|
* <p>The run timeout, in seconds, for the script.</p>
|
|
127
137
|
*/
|
|
128
138
|
TimeoutInSeconds: number | undefined;
|
|
@@ -151,44 +161,54 @@ export type AppBlockState = (typeof AppBlockState)[keyof typeof AppBlockState];
|
|
|
151
161
|
*/
|
|
152
162
|
export interface AppBlock {
|
|
153
163
|
/**
|
|
164
|
+
* @public
|
|
154
165
|
* <p>The name of the app block.</p>
|
|
155
166
|
*/
|
|
156
167
|
Name: string | undefined;
|
|
157
168
|
/**
|
|
169
|
+
* @public
|
|
158
170
|
* <p>The ARN of the app block.</p>
|
|
159
171
|
*/
|
|
160
172
|
Arn: string | undefined;
|
|
161
173
|
/**
|
|
174
|
+
* @public
|
|
162
175
|
* <p>The description of the app block.</p>
|
|
163
176
|
*/
|
|
164
177
|
Description?: string;
|
|
165
178
|
/**
|
|
179
|
+
* @public
|
|
166
180
|
* <p>The display name of the app block.</p>
|
|
167
181
|
*/
|
|
168
182
|
DisplayName?: string;
|
|
169
183
|
/**
|
|
184
|
+
* @public
|
|
170
185
|
* <p>The source S3 location of the app block.</p>
|
|
171
186
|
*/
|
|
172
187
|
SourceS3Location?: S3Location;
|
|
173
188
|
/**
|
|
189
|
+
* @public
|
|
174
190
|
* <p>The setup script details of the app block.</p>
|
|
175
191
|
* <p>This only applies to app blocks with PackagingType <code>CUSTOM</code>.</p>
|
|
176
192
|
*/
|
|
177
193
|
SetupScriptDetails?: ScriptDetails;
|
|
178
194
|
/**
|
|
195
|
+
* @public
|
|
179
196
|
* <p>The created time of the app block.</p>
|
|
180
197
|
*/
|
|
181
198
|
CreatedTime?: Date;
|
|
182
199
|
/**
|
|
200
|
+
* @public
|
|
183
201
|
* <p>The post setup script details of the app block.</p>
|
|
184
202
|
* <p>This only applies to app blocks with PackagingType <code>APPSTREAM2</code>.</p>
|
|
185
203
|
*/
|
|
186
204
|
PostSetupScriptDetails?: ScriptDetails;
|
|
187
205
|
/**
|
|
206
|
+
* @public
|
|
188
207
|
* <p>The packaging type of the app block.</p>
|
|
189
208
|
*/
|
|
190
209
|
PackagingType?: PackagingType | string;
|
|
191
210
|
/**
|
|
211
|
+
* @public
|
|
192
212
|
* <p>The state of the app block.</p>
|
|
193
213
|
* <p>An app block with AppStream 2.0 packaging will be in the <code>INACTIVE</code> state
|
|
194
214
|
* if no application package (VHD) is assigned to it. After an application package (VHD) is
|
|
@@ -197,6 +217,7 @@ export interface AppBlock {
|
|
|
197
217
|
*/
|
|
198
218
|
State?: AppBlockState | string;
|
|
199
219
|
/**
|
|
220
|
+
* @public
|
|
200
221
|
* <p>The errors of the app block.</p>
|
|
201
222
|
*/
|
|
202
223
|
AppBlockErrors?: ErrorDetails[];
|
|
@@ -247,14 +268,17 @@ export type FleetErrorCode = (typeof FleetErrorCode)[keyof typeof FleetErrorCode
|
|
|
247
268
|
*/
|
|
248
269
|
export interface ResourceError {
|
|
249
270
|
/**
|
|
271
|
+
* @public
|
|
250
272
|
* <p>The error code.</p>
|
|
251
273
|
*/
|
|
252
274
|
ErrorCode?: FleetErrorCode | string;
|
|
253
275
|
/**
|
|
276
|
+
* @public
|
|
254
277
|
* <p>The error message.</p>
|
|
255
278
|
*/
|
|
256
279
|
ErrorMessage?: string;
|
|
257
280
|
/**
|
|
281
|
+
* @public
|
|
258
282
|
* <p>The time the error occurred.</p>
|
|
259
283
|
*/
|
|
260
284
|
ErrorTimestamp?: Date;
|
|
@@ -301,10 +325,12 @@ export type AppBlockBuilderStateChangeReasonCode = (typeof AppBlockBuilderStateC
|
|
|
301
325
|
*/
|
|
302
326
|
export interface AppBlockBuilderStateChangeReason {
|
|
303
327
|
/**
|
|
328
|
+
* @public
|
|
304
329
|
* <p>The state change reason code.</p>
|
|
305
330
|
*/
|
|
306
331
|
Code?: AppBlockBuilderStateChangeReasonCode | string;
|
|
307
332
|
/**
|
|
333
|
+
* @public
|
|
308
334
|
* <p>The state change reason message.</p>
|
|
309
335
|
*/
|
|
310
336
|
Message?: string;
|
|
@@ -315,10 +341,12 @@ export interface AppBlockBuilderStateChangeReason {
|
|
|
315
341
|
*/
|
|
316
342
|
export interface VpcConfig {
|
|
317
343
|
/**
|
|
344
|
+
* @public
|
|
318
345
|
* <p>The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or more subnets. Image builder instances use one subnet.</p>
|
|
319
346
|
*/
|
|
320
347
|
SubnetIds?: string[];
|
|
321
348
|
/**
|
|
349
|
+
* @public
|
|
322
350
|
* <p>The identifiers of the security groups for the fleet or image builder.</p>
|
|
323
351
|
*/
|
|
324
352
|
SecurityGroupIds?: string[];
|
|
@@ -329,60 +357,74 @@ export interface VpcConfig {
|
|
|
329
357
|
*/
|
|
330
358
|
export interface AppBlockBuilder {
|
|
331
359
|
/**
|
|
360
|
+
* @public
|
|
332
361
|
* <p>The ARN of the app block builder.</p>
|
|
333
362
|
*/
|
|
334
363
|
Arn: string | undefined;
|
|
335
364
|
/**
|
|
365
|
+
* @public
|
|
336
366
|
* <p>The name of the app block builder.</p>
|
|
337
367
|
*/
|
|
338
368
|
Name: string | undefined;
|
|
339
369
|
/**
|
|
370
|
+
* @public
|
|
340
371
|
* <p>The display name of the app block builder.</p>
|
|
341
372
|
*/
|
|
342
373
|
DisplayName?: string;
|
|
343
374
|
/**
|
|
375
|
+
* @public
|
|
344
376
|
* <p>The description of the app block builder.</p>
|
|
345
377
|
*/
|
|
346
378
|
Description?: string;
|
|
347
379
|
/**
|
|
380
|
+
* @public
|
|
348
381
|
* <p>The platform of the app block builder.</p>
|
|
349
382
|
* <p>
|
|
350
383
|
* <code>WINDOWS_SERVER_2019</code> is the only valid value.</p>
|
|
351
384
|
*/
|
|
352
385
|
Platform: AppBlockBuilderPlatformType | string | undefined;
|
|
353
386
|
/**
|
|
387
|
+
* @public
|
|
354
388
|
* <p>The instance type of the app block builder.</p>
|
|
355
389
|
*/
|
|
356
390
|
InstanceType: string | undefined;
|
|
357
391
|
/**
|
|
392
|
+
* @public
|
|
358
393
|
* <p>Indicates whether default internet access is enabled for the app block builder.</p>
|
|
359
394
|
*/
|
|
360
395
|
EnableDefaultInternetAccess?: boolean;
|
|
361
396
|
/**
|
|
397
|
+
* @public
|
|
362
398
|
* <p>The ARN of the IAM role that is applied to the app block builder.</p>
|
|
363
399
|
*/
|
|
364
400
|
IamRoleArn?: string;
|
|
365
401
|
/**
|
|
402
|
+
* @public
|
|
366
403
|
* <p>The VPC configuration for the app block builder.</p>
|
|
367
404
|
*/
|
|
368
405
|
VpcConfig: VpcConfig | undefined;
|
|
369
406
|
/**
|
|
407
|
+
* @public
|
|
370
408
|
* <p>The state of the app block builder.</p>
|
|
371
409
|
*/
|
|
372
410
|
State: AppBlockBuilderState | string | undefined;
|
|
373
411
|
/**
|
|
412
|
+
* @public
|
|
374
413
|
* <p>The creation time of the app block builder.</p>
|
|
375
414
|
*/
|
|
376
415
|
CreatedTime?: Date;
|
|
377
416
|
/**
|
|
417
|
+
* @public
|
|
378
418
|
* <p>The app block builder errors.</p>
|
|
379
419
|
*/
|
|
380
420
|
AppBlockBuilderErrors?: ResourceError[];
|
|
381
421
|
/**
|
|
422
|
+
* @public
|
|
382
423
|
* <p>The state change reason.</p>
|
|
383
424
|
*/
|
|
384
425
|
StateChangeReason?: AppBlockBuilderStateChangeReason;
|
|
385
426
|
/**
|
|
427
|
+
* @public
|
|
386
428
|
* <p>The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block builder only through the specified endpoints.</p>
|
|
387
429
|
*/
|
|
388
430
|
AccessEndpoints?: AccessEndpoint[];
|
|
@@ -393,10 +435,12 @@ export interface AppBlockBuilder {
|
|
|
393
435
|
*/
|
|
394
436
|
export interface AppBlockBuilderAppBlockAssociation {
|
|
395
437
|
/**
|
|
438
|
+
* @public
|
|
396
439
|
* <p>The ARN of the app block.</p>
|
|
397
440
|
*/
|
|
398
441
|
AppBlockArn: string | undefined;
|
|
399
442
|
/**
|
|
443
|
+
* @public
|
|
400
444
|
* <p>The name of the app block builder.</p>
|
|
401
445
|
*/
|
|
402
446
|
AppBlockBuilderName: string | undefined;
|
|
@@ -434,62 +478,77 @@ export type PlatformType = (typeof PlatformType)[keyof typeof PlatformType];
|
|
|
434
478
|
*/
|
|
435
479
|
export interface Application {
|
|
436
480
|
/**
|
|
481
|
+
* @public
|
|
437
482
|
* <p>The name of the application.</p>
|
|
438
483
|
*/
|
|
439
484
|
Name?: string;
|
|
440
485
|
/**
|
|
486
|
+
* @public
|
|
441
487
|
* <p>The application name to display.</p>
|
|
442
488
|
*/
|
|
443
489
|
DisplayName?: string;
|
|
444
490
|
/**
|
|
491
|
+
* @public
|
|
445
492
|
* <p>The URL for the application icon. This URL might be time-limited.</p>
|
|
446
493
|
*/
|
|
447
494
|
IconURL?: string;
|
|
448
495
|
/**
|
|
496
|
+
* @public
|
|
449
497
|
* <p>The path to the application executable in the instance.</p>
|
|
450
498
|
*/
|
|
451
499
|
LaunchPath?: string;
|
|
452
500
|
/**
|
|
501
|
+
* @public
|
|
453
502
|
* <p>The arguments that are passed to the application at launch.</p>
|
|
454
503
|
*/
|
|
455
504
|
LaunchParameters?: string;
|
|
456
505
|
/**
|
|
506
|
+
* @public
|
|
457
507
|
* <p>If there is a problem, the application can be disabled after image creation.</p>
|
|
458
508
|
*/
|
|
459
509
|
Enabled?: boolean;
|
|
460
510
|
/**
|
|
511
|
+
* @public
|
|
461
512
|
* <p>Additional attributes that describe the application.</p>
|
|
462
513
|
*/
|
|
463
514
|
Metadata?: Record<string, string>;
|
|
464
515
|
/**
|
|
516
|
+
* @public
|
|
465
517
|
* <p>The working directory for the application.</p>
|
|
466
518
|
*/
|
|
467
519
|
WorkingDirectory?: string;
|
|
468
520
|
/**
|
|
521
|
+
* @public
|
|
469
522
|
* <p>The description of the application.</p>
|
|
470
523
|
*/
|
|
471
524
|
Description?: string;
|
|
472
525
|
/**
|
|
526
|
+
* @public
|
|
473
527
|
* <p>The ARN of the application.</p>
|
|
474
528
|
*/
|
|
475
529
|
Arn?: string;
|
|
476
530
|
/**
|
|
531
|
+
* @public
|
|
477
532
|
* <p>The app block ARN of the application.</p>
|
|
478
533
|
*/
|
|
479
534
|
AppBlockArn?: string;
|
|
480
535
|
/**
|
|
536
|
+
* @public
|
|
481
537
|
* <p>The S3 location of the application icon.</p>
|
|
482
538
|
*/
|
|
483
539
|
IconS3Location?: S3Location;
|
|
484
540
|
/**
|
|
541
|
+
* @public
|
|
485
542
|
* <p>The platforms on which the application can run.</p>
|
|
486
543
|
*/
|
|
487
544
|
Platforms?: (PlatformType | string)[];
|
|
488
545
|
/**
|
|
546
|
+
* @public
|
|
489
547
|
* <p>The instance families for the application.</p>
|
|
490
548
|
*/
|
|
491
549
|
InstanceFamilies?: string[];
|
|
492
550
|
/**
|
|
551
|
+
* @public
|
|
493
552
|
* <p>The time at which the application was created within the app block.</p>
|
|
494
553
|
*/
|
|
495
554
|
CreatedTime?: Date;
|
|
@@ -512,10 +571,12 @@ export type ApplicationAttribute = (typeof ApplicationAttribute)[keyof typeof Ap
|
|
|
512
571
|
*/
|
|
513
572
|
export interface ApplicationFleetAssociation {
|
|
514
573
|
/**
|
|
574
|
+
* @public
|
|
515
575
|
* <p>The name of the fleet associated with the application.</p>
|
|
516
576
|
*/
|
|
517
577
|
FleetName: string | undefined;
|
|
518
578
|
/**
|
|
579
|
+
* @public
|
|
519
580
|
* <p>The ARN of the application associated with the fleet.</p>
|
|
520
581
|
*/
|
|
521
582
|
ApplicationArn: string | undefined;
|
|
@@ -526,10 +587,12 @@ export interface ApplicationFleetAssociation {
|
|
|
526
587
|
*/
|
|
527
588
|
export interface ApplicationSettings {
|
|
528
589
|
/**
|
|
590
|
+
* @public
|
|
529
591
|
* <p>Enables or disables persistent application settings for users during their streaming sessions. </p>
|
|
530
592
|
*/
|
|
531
593
|
Enabled: boolean | undefined;
|
|
532
594
|
/**
|
|
595
|
+
* @public
|
|
533
596
|
* <p>The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple stacks by specifying the same settings group for each stack. </p>
|
|
534
597
|
*/
|
|
535
598
|
SettingsGroup?: string;
|
|
@@ -540,14 +603,17 @@ export interface ApplicationSettings {
|
|
|
540
603
|
*/
|
|
541
604
|
export interface ApplicationSettingsResponse {
|
|
542
605
|
/**
|
|
606
|
+
* @public
|
|
543
607
|
* <p>Specifies whether persistent application settings are enabled for users during their streaming sessions.</p>
|
|
544
608
|
*/
|
|
545
609
|
Enabled?: boolean;
|
|
546
610
|
/**
|
|
611
|
+
* @public
|
|
547
612
|
* <p>The path prefix for the S3 bucket where users’ persistent application settings are stored.</p>
|
|
548
613
|
*/
|
|
549
614
|
SettingsGroup?: string;
|
|
550
615
|
/**
|
|
616
|
+
* @public
|
|
551
617
|
* <p>The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an AWS Region, an S3 bucket is created. The bucket is unique to the AWS account and the Region.
|
|
552
618
|
* </p>
|
|
553
619
|
*/
|
|
@@ -570,10 +636,12 @@ export type AppVisibility = (typeof AppVisibility)[keyof typeof AppVisibility];
|
|
|
570
636
|
*/
|
|
571
637
|
export interface AssociateAppBlockBuilderAppBlockRequest {
|
|
572
638
|
/**
|
|
639
|
+
* @public
|
|
573
640
|
* <p>The ARN of the app block.</p>
|
|
574
641
|
*/
|
|
575
642
|
AppBlockArn: string | undefined;
|
|
576
643
|
/**
|
|
644
|
+
* @public
|
|
577
645
|
* <p>The name of the app block builder.</p>
|
|
578
646
|
*/
|
|
579
647
|
AppBlockBuilderName: string | undefined;
|
|
@@ -583,6 +651,7 @@ export interface AssociateAppBlockBuilderAppBlockRequest {
|
|
|
583
651
|
*/
|
|
584
652
|
export interface AssociateAppBlockBuilderAppBlockResult {
|
|
585
653
|
/**
|
|
654
|
+
* @public
|
|
586
655
|
* <p>The list of app block builders associated with app blocks.</p>
|
|
587
656
|
*/
|
|
588
657
|
AppBlockBuilderAppBlockAssociation?: AppBlockBuilderAppBlockAssociation;
|
|
@@ -595,6 +664,7 @@ export declare class ConcurrentModificationException extends __BaseException {
|
|
|
595
664
|
readonly name: "ConcurrentModificationException";
|
|
596
665
|
readonly $fault: "client";
|
|
597
666
|
/**
|
|
667
|
+
* @public
|
|
598
668
|
* <p>The error message in the exception.</p>
|
|
599
669
|
*/
|
|
600
670
|
Message?: string;
|
|
@@ -611,6 +681,7 @@ export declare class InvalidParameterCombinationException extends __BaseExceptio
|
|
|
611
681
|
readonly name: "InvalidParameterCombinationException";
|
|
612
682
|
readonly $fault: "client";
|
|
613
683
|
/**
|
|
684
|
+
* @public
|
|
614
685
|
* <p>The error message in the exception.</p>
|
|
615
686
|
*/
|
|
616
687
|
Message?: string;
|
|
@@ -627,6 +698,7 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
627
698
|
readonly name: "LimitExceededException";
|
|
628
699
|
readonly $fault: "client";
|
|
629
700
|
/**
|
|
701
|
+
* @public
|
|
630
702
|
* <p>The error message in the exception.</p>
|
|
631
703
|
*/
|
|
632
704
|
Message?: string;
|
|
@@ -643,6 +715,7 @@ export declare class OperationNotPermittedException extends __BaseException {
|
|
|
643
715
|
readonly name: "OperationNotPermittedException";
|
|
644
716
|
readonly $fault: "client";
|
|
645
717
|
/**
|
|
718
|
+
* @public
|
|
646
719
|
* <p>The error message in the exception.</p>
|
|
647
720
|
*/
|
|
648
721
|
Message?: string;
|
|
@@ -659,6 +732,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
659
732
|
readonly name: "ResourceNotFoundException";
|
|
660
733
|
readonly $fault: "client";
|
|
661
734
|
/**
|
|
735
|
+
* @public
|
|
662
736
|
* <p>The error message in the exception.</p>
|
|
663
737
|
*/
|
|
664
738
|
Message?: string;
|
|
@@ -672,10 +746,12 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
672
746
|
*/
|
|
673
747
|
export interface AssociateApplicationFleetRequest {
|
|
674
748
|
/**
|
|
749
|
+
* @public
|
|
675
750
|
* <p>The name of the fleet.</p>
|
|
676
751
|
*/
|
|
677
752
|
FleetName: string | undefined;
|
|
678
753
|
/**
|
|
754
|
+
* @public
|
|
679
755
|
* <p>The ARN of the application.</p>
|
|
680
756
|
*/
|
|
681
757
|
ApplicationArn: string | undefined;
|
|
@@ -685,6 +761,7 @@ export interface AssociateApplicationFleetRequest {
|
|
|
685
761
|
*/
|
|
686
762
|
export interface AssociateApplicationFleetResult {
|
|
687
763
|
/**
|
|
764
|
+
* @public
|
|
688
765
|
* <p>If fleet name is specified, this returns the list of applications that are associated
|
|
689
766
|
* to it. If application ARN is specified, this returns the list of fleets to which it is
|
|
690
767
|
* associated.</p>
|
|
@@ -696,14 +773,17 @@ export interface AssociateApplicationFleetResult {
|
|
|
696
773
|
*/
|
|
697
774
|
export interface AssociateApplicationToEntitlementRequest {
|
|
698
775
|
/**
|
|
776
|
+
* @public
|
|
699
777
|
* <p>The name of the stack.</p>
|
|
700
778
|
*/
|
|
701
779
|
StackName: string | undefined;
|
|
702
780
|
/**
|
|
781
|
+
* @public
|
|
703
782
|
* <p>The name of the entitlement.</p>
|
|
704
783
|
*/
|
|
705
784
|
EntitlementName: string | undefined;
|
|
706
785
|
/**
|
|
786
|
+
* @public
|
|
707
787
|
* <p>The identifier of the application.</p>
|
|
708
788
|
*/
|
|
709
789
|
ApplicationIdentifier: string | undefined;
|
|
@@ -721,6 +801,7 @@ export declare class EntitlementNotFoundException extends __BaseException {
|
|
|
721
801
|
readonly name: "EntitlementNotFoundException";
|
|
722
802
|
readonly $fault: "client";
|
|
723
803
|
/**
|
|
804
|
+
* @public
|
|
724
805
|
* <p>The error message in the exception.</p>
|
|
725
806
|
*/
|
|
726
807
|
Message?: string;
|
|
@@ -734,10 +815,12 @@ export declare class EntitlementNotFoundException extends __BaseException {
|
|
|
734
815
|
*/
|
|
735
816
|
export interface AssociateFleetRequest {
|
|
736
817
|
/**
|
|
818
|
+
* @public
|
|
737
819
|
* <p>The name of the fleet. </p>
|
|
738
820
|
*/
|
|
739
821
|
FleetName: string | undefined;
|
|
740
822
|
/**
|
|
823
|
+
* @public
|
|
741
824
|
* <p>The name of the stack.</p>
|
|
742
825
|
*/
|
|
743
826
|
StackName: string | undefined;
|
|
@@ -755,6 +838,7 @@ export declare class IncompatibleImageException extends __BaseException {
|
|
|
755
838
|
readonly name: "IncompatibleImageException";
|
|
756
839
|
readonly $fault: "client";
|
|
757
840
|
/**
|
|
841
|
+
* @public
|
|
758
842
|
* <p>The error message in the exception.</p>
|
|
759
843
|
*/
|
|
760
844
|
Message?: string;
|
|
@@ -771,6 +855,7 @@ export declare class InvalidAccountStatusException extends __BaseException {
|
|
|
771
855
|
readonly name: "InvalidAccountStatusException";
|
|
772
856
|
readonly $fault: "client";
|
|
773
857
|
/**
|
|
858
|
+
* @public
|
|
774
859
|
* <p>The error message in the exception.</p>
|
|
775
860
|
*/
|
|
776
861
|
Message?: string;
|
|
@@ -799,10 +884,12 @@ export type AuthenticationType = (typeof AuthenticationType)[keyof typeof Authen
|
|
|
799
884
|
*/
|
|
800
885
|
export interface UserStackAssociation {
|
|
801
886
|
/**
|
|
887
|
+
* @public
|
|
802
888
|
* <p>The name of the stack that is associated with the user.</p>
|
|
803
889
|
*/
|
|
804
890
|
StackName: string | undefined;
|
|
805
891
|
/**
|
|
892
|
+
* @public
|
|
806
893
|
* <p>The email address of the user who is associated with the stack.</p>
|
|
807
894
|
* <note>
|
|
808
895
|
* <p>Users' email addresses are case-sensitive.</p>
|
|
@@ -810,10 +897,12 @@ export interface UserStackAssociation {
|
|
|
810
897
|
*/
|
|
811
898
|
UserName: string | undefined;
|
|
812
899
|
/**
|
|
900
|
+
* @public
|
|
813
901
|
* <p>The authentication type for the user.</p>
|
|
814
902
|
*/
|
|
815
903
|
AuthenticationType: AuthenticationType | string | undefined;
|
|
816
904
|
/**
|
|
905
|
+
* @public
|
|
817
906
|
* <p>Specifies whether a welcome email is sent to a user after the user is created in the user pool.</p>
|
|
818
907
|
*/
|
|
819
908
|
SendEmailNotification?: boolean;
|
|
@@ -823,6 +912,7 @@ export interface UserStackAssociation {
|
|
|
823
912
|
*/
|
|
824
913
|
export interface BatchAssociateUserStackRequest {
|
|
825
914
|
/**
|
|
915
|
+
* @public
|
|
826
916
|
* <p>The list of UserStackAssociation objects.</p>
|
|
827
917
|
*/
|
|
828
918
|
UserStackAssociations: UserStackAssociation[] | undefined;
|
|
@@ -847,14 +937,17 @@ export type UserStackAssociationErrorCode = (typeof UserStackAssociationErrorCod
|
|
|
847
937
|
*/
|
|
848
938
|
export interface UserStackAssociationError {
|
|
849
939
|
/**
|
|
940
|
+
* @public
|
|
850
941
|
* <p>Information about the user and associated stack.</p>
|
|
851
942
|
*/
|
|
852
943
|
UserStackAssociation?: UserStackAssociation;
|
|
853
944
|
/**
|
|
945
|
+
* @public
|
|
854
946
|
* <p>The error code for the error that is returned when a user can’t be associated with or disassociated from a stack.</p>
|
|
855
947
|
*/
|
|
856
948
|
ErrorCode?: UserStackAssociationErrorCode | string;
|
|
857
949
|
/**
|
|
950
|
+
* @public
|
|
858
951
|
* <p>The error message for the error that is returned when a user can’t be associated with or disassociated from a stack.</p>
|
|
859
952
|
*/
|
|
860
953
|
ErrorMessage?: string;
|
|
@@ -864,6 +957,7 @@ export interface UserStackAssociationError {
|
|
|
864
957
|
*/
|
|
865
958
|
export interface BatchAssociateUserStackResult {
|
|
866
959
|
/**
|
|
960
|
+
* @public
|
|
867
961
|
* <p>The list of UserStackAssociationError objects.</p>
|
|
868
962
|
*/
|
|
869
963
|
errors?: UserStackAssociationError[];
|
|
@@ -873,6 +967,7 @@ export interface BatchAssociateUserStackResult {
|
|
|
873
967
|
*/
|
|
874
968
|
export interface BatchDisassociateUserStackRequest {
|
|
875
969
|
/**
|
|
970
|
+
* @public
|
|
876
971
|
* <p>The list of UserStackAssociation objects.</p>
|
|
877
972
|
*/
|
|
878
973
|
UserStackAssociations: UserStackAssociation[] | undefined;
|
|
@@ -882,6 +977,7 @@ export interface BatchDisassociateUserStackRequest {
|
|
|
882
977
|
*/
|
|
883
978
|
export interface BatchDisassociateUserStackResult {
|
|
884
979
|
/**
|
|
980
|
+
* @public
|
|
885
981
|
* <p>The list of UserStackAssociationError objects.</p>
|
|
886
982
|
*/
|
|
887
983
|
errors?: UserStackAssociationError[];
|
|
@@ -911,10 +1007,12 @@ export type CertificateBasedAuthStatus = (typeof CertificateBasedAuthStatus)[key
|
|
|
911
1007
|
*/
|
|
912
1008
|
export interface CertificateBasedAuthProperties {
|
|
913
1009
|
/**
|
|
1010
|
+
* @public
|
|
914
1011
|
* <p>The status of the certificate-based authentication properties.</p>
|
|
915
1012
|
*/
|
|
916
1013
|
Status?: CertificateBasedAuthStatus | string;
|
|
917
1014
|
/**
|
|
1015
|
+
* @public
|
|
918
1016
|
* <p>The ARN of the AWS Certificate Manager Private CA resource.</p>
|
|
919
1017
|
*/
|
|
920
1018
|
CertificateAuthorityArn?: string;
|
|
@@ -925,6 +1023,7 @@ export interface CertificateBasedAuthProperties {
|
|
|
925
1023
|
*/
|
|
926
1024
|
export interface ComputeCapacity {
|
|
927
1025
|
/**
|
|
1026
|
+
* @public
|
|
928
1027
|
* <p>The desired number of streaming instances.</p>
|
|
929
1028
|
*/
|
|
930
1029
|
DesiredInstances: number | undefined;
|
|
@@ -935,18 +1034,22 @@ export interface ComputeCapacity {
|
|
|
935
1034
|
*/
|
|
936
1035
|
export interface ComputeCapacityStatus {
|
|
937
1036
|
/**
|
|
1037
|
+
* @public
|
|
938
1038
|
* <p>The desired number of streaming instances.</p>
|
|
939
1039
|
*/
|
|
940
1040
|
Desired: number | undefined;
|
|
941
1041
|
/**
|
|
1042
|
+
* @public
|
|
942
1043
|
* <p>The total number of simultaneous streaming instances that are running.</p>
|
|
943
1044
|
*/
|
|
944
1045
|
Running?: number;
|
|
945
1046
|
/**
|
|
1047
|
+
* @public
|
|
946
1048
|
* <p>The number of instances in use for streaming.</p>
|
|
947
1049
|
*/
|
|
948
1050
|
InUse?: number;
|
|
949
1051
|
/**
|
|
1052
|
+
* @public
|
|
950
1053
|
* <p>The number of currently available instances that can be used to stream
|
|
951
1054
|
* sessions.</p>
|
|
952
1055
|
*/
|
|
@@ -957,18 +1060,22 @@ export interface ComputeCapacityStatus {
|
|
|
957
1060
|
*/
|
|
958
1061
|
export interface CopyImageRequest {
|
|
959
1062
|
/**
|
|
1063
|
+
* @public
|
|
960
1064
|
* <p>The name of the image to copy.</p>
|
|
961
1065
|
*/
|
|
962
1066
|
SourceImageName: string | undefined;
|
|
963
1067
|
/**
|
|
1068
|
+
* @public
|
|
964
1069
|
* <p>The name that the image will have when it is copied to the destination.</p>
|
|
965
1070
|
*/
|
|
966
1071
|
DestinationImageName: string | undefined;
|
|
967
1072
|
/**
|
|
1073
|
+
* @public
|
|
968
1074
|
* <p>The destination region to which the image will be copied. This parameter is required, even if you are copying an image within the same region.</p>
|
|
969
1075
|
*/
|
|
970
1076
|
DestinationRegion: string | undefined;
|
|
971
1077
|
/**
|
|
1078
|
+
* @public
|
|
972
1079
|
* <p>The description that the image will have when it is copied to the destination.</p>
|
|
973
1080
|
*/
|
|
974
1081
|
DestinationImageDescription?: string;
|
|
@@ -978,6 +1085,7 @@ export interface CopyImageRequest {
|
|
|
978
1085
|
*/
|
|
979
1086
|
export interface CopyImageResponse {
|
|
980
1087
|
/**
|
|
1088
|
+
* @public
|
|
981
1089
|
* <p>The name of the destination image.</p>
|
|
982
1090
|
*/
|
|
983
1091
|
DestinationImageName?: string;
|
|
@@ -990,6 +1098,7 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
|
|
|
990
1098
|
readonly name: "ResourceAlreadyExistsException";
|
|
991
1099
|
readonly $fault: "client";
|
|
992
1100
|
/**
|
|
1101
|
+
* @public
|
|
993
1102
|
* <p>The error message in the exception.</p>
|
|
994
1103
|
*/
|
|
995
1104
|
Message?: string;
|
|
@@ -1006,6 +1115,7 @@ export declare class ResourceNotAvailableException extends __BaseException {
|
|
|
1006
1115
|
readonly name: "ResourceNotAvailableException";
|
|
1007
1116
|
readonly $fault: "client";
|
|
1008
1117
|
/**
|
|
1118
|
+
* @public
|
|
1009
1119
|
* <p>The error message in the exception.</p>
|
|
1010
1120
|
*/
|
|
1011
1121
|
Message?: string;
|
|
@@ -1019,36 +1129,44 @@ export declare class ResourceNotAvailableException extends __BaseException {
|
|
|
1019
1129
|
*/
|
|
1020
1130
|
export interface CreateAppBlockRequest {
|
|
1021
1131
|
/**
|
|
1132
|
+
* @public
|
|
1022
1133
|
* <p>The name of the app block.</p>
|
|
1023
1134
|
*/
|
|
1024
1135
|
Name: string | undefined;
|
|
1025
1136
|
/**
|
|
1137
|
+
* @public
|
|
1026
1138
|
* <p>The description of the app block.</p>
|
|
1027
1139
|
*/
|
|
1028
1140
|
Description?: string;
|
|
1029
1141
|
/**
|
|
1142
|
+
* @public
|
|
1030
1143
|
* <p>The display name of the app block. This is not displayed to the user.</p>
|
|
1031
1144
|
*/
|
|
1032
1145
|
DisplayName?: string;
|
|
1033
1146
|
/**
|
|
1147
|
+
* @public
|
|
1034
1148
|
* <p>The source S3 location of the app block.</p>
|
|
1035
1149
|
*/
|
|
1036
1150
|
SourceS3Location: S3Location | undefined;
|
|
1037
1151
|
/**
|
|
1152
|
+
* @public
|
|
1038
1153
|
* <p>The setup script details of the app block. This must be provided for the
|
|
1039
1154
|
* <code>CUSTOM</code> PackagingType.</p>
|
|
1040
1155
|
*/
|
|
1041
1156
|
SetupScriptDetails?: ScriptDetails;
|
|
1042
1157
|
/**
|
|
1158
|
+
* @public
|
|
1043
1159
|
* <p>The tags assigned to the app block.</p>
|
|
1044
1160
|
*/
|
|
1045
1161
|
Tags?: Record<string, string>;
|
|
1046
1162
|
/**
|
|
1163
|
+
* @public
|
|
1047
1164
|
* <p>The post setup script details of the app block. This can only be provided for the
|
|
1048
1165
|
* <code>APPSTREAM2</code> PackagingType.</p>
|
|
1049
1166
|
*/
|
|
1050
1167
|
PostSetupScriptDetails?: ScriptDetails;
|
|
1051
1168
|
/**
|
|
1169
|
+
* @public
|
|
1052
1170
|
* <p>The packaging type of the app block.</p>
|
|
1053
1171
|
*/
|
|
1054
1172
|
PackagingType?: PackagingType | string;
|
|
@@ -1058,6 +1176,7 @@ export interface CreateAppBlockRequest {
|
|
|
1058
1176
|
*/
|
|
1059
1177
|
export interface CreateAppBlockResult {
|
|
1060
1178
|
/**
|
|
1179
|
+
* @public
|
|
1061
1180
|
* <p>The app block.</p>
|
|
1062
1181
|
*/
|
|
1063
1182
|
AppBlock?: AppBlock;
|
|
@@ -1067,18 +1186,22 @@ export interface CreateAppBlockResult {
|
|
|
1067
1186
|
*/
|
|
1068
1187
|
export interface CreateAppBlockBuilderRequest {
|
|
1069
1188
|
/**
|
|
1189
|
+
* @public
|
|
1070
1190
|
* <p>The unique name for the app block builder.</p>
|
|
1071
1191
|
*/
|
|
1072
1192
|
Name: string | undefined;
|
|
1073
1193
|
/**
|
|
1194
|
+
* @public
|
|
1074
1195
|
* <p>The description of the app block builder.</p>
|
|
1075
1196
|
*/
|
|
1076
1197
|
Description?: string;
|
|
1077
1198
|
/**
|
|
1199
|
+
* @public
|
|
1078
1200
|
* <p>The display name of the app block builder.</p>
|
|
1079
1201
|
*/
|
|
1080
1202
|
DisplayName?: string;
|
|
1081
1203
|
/**
|
|
1204
|
+
* @public
|
|
1082
1205
|
* <p>The tags to associate with the app block builder. A tag is a key-value pair, and the
|
|
1083
1206
|
* value is optional. For example, Environment=Test. If you do not specify a value,
|
|
1084
1207
|
* Environment=. </p>
|
|
@@ -1089,12 +1212,14 @@ export interface CreateAppBlockBuilderRequest {
|
|
|
1089
1212
|
*/
|
|
1090
1213
|
Tags?: Record<string, string>;
|
|
1091
1214
|
/**
|
|
1215
|
+
* @public
|
|
1092
1216
|
* <p>The platform of the app block builder.</p>
|
|
1093
1217
|
* <p>
|
|
1094
1218
|
* <code>WINDOWS_SERVER_2019</code> is the only valid value.</p>
|
|
1095
1219
|
*/
|
|
1096
1220
|
Platform: AppBlockBuilderPlatformType | string | undefined;
|
|
1097
1221
|
/**
|
|
1222
|
+
* @public
|
|
1098
1223
|
* <p>The instance type to use when launching the app block builder. The following instance
|
|
1099
1224
|
* types are available:</p>
|
|
1100
1225
|
* <ul>
|
|
@@ -1117,16 +1242,19 @@ export interface CreateAppBlockBuilderRequest {
|
|
|
1117
1242
|
*/
|
|
1118
1243
|
InstanceType: string | undefined;
|
|
1119
1244
|
/**
|
|
1245
|
+
* @public
|
|
1120
1246
|
* <p>The VPC configuration for the app block builder.</p>
|
|
1121
1247
|
* <p>App block builders require that you specify at least two subnets in different availability
|
|
1122
1248
|
* zones.</p>
|
|
1123
1249
|
*/
|
|
1124
1250
|
VpcConfig: VpcConfig | undefined;
|
|
1125
1251
|
/**
|
|
1252
|
+
* @public
|
|
1126
1253
|
* <p>Enables or disables default internet access for the app block builder.</p>
|
|
1127
1254
|
*/
|
|
1128
1255
|
EnableDefaultInternetAccess?: boolean;
|
|
1129
1256
|
/**
|
|
1257
|
+
* @public
|
|
1130
1258
|
* <p>The Amazon Resource Name (ARN) of the IAM role to apply to the app block builder. To
|
|
1131
1259
|
* assume a role, the app block builder calls the AWS Security Token Service (STS)
|
|
1132
1260
|
* <code>AssumeRole</code> API operation and passes the ARN of the role to use. The
|
|
@@ -1136,6 +1264,7 @@ export interface CreateAppBlockBuilderRequest {
|
|
|
1136
1264
|
*/
|
|
1137
1265
|
IamRoleArn?: string;
|
|
1138
1266
|
/**
|
|
1267
|
+
* @public
|
|
1139
1268
|
* <p>The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block builder only through the specified endpoints.</p>
|
|
1140
1269
|
*/
|
|
1141
1270
|
AccessEndpoints?: AccessEndpoint[];
|
|
@@ -1145,6 +1274,7 @@ export interface CreateAppBlockBuilderRequest {
|
|
|
1145
1274
|
*/
|
|
1146
1275
|
export interface CreateAppBlockBuilderResult {
|
|
1147
1276
|
/**
|
|
1277
|
+
* @public
|
|
1148
1278
|
* <p>Describes an app block builder.</p>
|
|
1149
1279
|
*/
|
|
1150
1280
|
AppBlockBuilder?: AppBlockBuilder;
|
|
@@ -1157,6 +1287,7 @@ export declare class InvalidRoleException extends __BaseException {
|
|
|
1157
1287
|
readonly name: "InvalidRoleException";
|
|
1158
1288
|
readonly $fault: "client";
|
|
1159
1289
|
/**
|
|
1290
|
+
* @public
|
|
1160
1291
|
* <p>The error message in the exception.</p>
|
|
1161
1292
|
*/
|
|
1162
1293
|
Message?: string;
|
|
@@ -1173,6 +1304,7 @@ export declare class RequestLimitExceededException extends __BaseException {
|
|
|
1173
1304
|
readonly name: "RequestLimitExceededException";
|
|
1174
1305
|
readonly $fault: "client";
|
|
1175
1306
|
/**
|
|
1307
|
+
* @public
|
|
1176
1308
|
* <p>The error message in the exception.</p>
|
|
1177
1309
|
*/
|
|
1178
1310
|
Message?: string;
|
|
@@ -1186,10 +1318,12 @@ export declare class RequestLimitExceededException extends __BaseException {
|
|
|
1186
1318
|
*/
|
|
1187
1319
|
export interface CreateAppBlockBuilderStreamingURLRequest {
|
|
1188
1320
|
/**
|
|
1321
|
+
* @public
|
|
1189
1322
|
* <p>The name of the app block builder.</p>
|
|
1190
1323
|
*/
|
|
1191
1324
|
AppBlockBuilderName: string | undefined;
|
|
1192
1325
|
/**
|
|
1326
|
+
* @public
|
|
1193
1327
|
* <p>The time that the streaming URL will be valid, in seconds.
|
|
1194
1328
|
* Specify a value between 1 and 604800 seconds. The default is 3600 seconds.</p>
|
|
1195
1329
|
*/
|
|
@@ -1200,10 +1334,12 @@ export interface CreateAppBlockBuilderStreamingURLRequest {
|
|
|
1200
1334
|
*/
|
|
1201
1335
|
export interface CreateAppBlockBuilderStreamingURLResult {
|
|
1202
1336
|
/**
|
|
1337
|
+
* @public
|
|
1203
1338
|
* <p>The URL to start the streaming session.</p>
|
|
1204
1339
|
*/
|
|
1205
1340
|
StreamingURL?: string;
|
|
1206
1341
|
/**
|
|
1342
|
+
* @public
|
|
1207
1343
|
* <p>The elapsed time, in seconds after the Unix epoch, when this URL expires.</p>
|
|
1208
1344
|
*/
|
|
1209
1345
|
Expires?: Date;
|
|
@@ -1213,46 +1349,57 @@ export interface CreateAppBlockBuilderStreamingURLResult {
|
|
|
1213
1349
|
*/
|
|
1214
1350
|
export interface CreateApplicationRequest {
|
|
1215
1351
|
/**
|
|
1352
|
+
* @public
|
|
1216
1353
|
* <p>The name of the application. This name is visible to users when display name is not specified.</p>
|
|
1217
1354
|
*/
|
|
1218
1355
|
Name: string | undefined;
|
|
1219
1356
|
/**
|
|
1357
|
+
* @public
|
|
1220
1358
|
* <p>The display name of the application. This name is visible to users in the application catalog.</p>
|
|
1221
1359
|
*/
|
|
1222
1360
|
DisplayName?: string;
|
|
1223
1361
|
/**
|
|
1362
|
+
* @public
|
|
1224
1363
|
* <p>The description of the application.</p>
|
|
1225
1364
|
*/
|
|
1226
1365
|
Description?: string;
|
|
1227
1366
|
/**
|
|
1367
|
+
* @public
|
|
1228
1368
|
* <p>The location in S3 of the application icon.</p>
|
|
1229
1369
|
*/
|
|
1230
1370
|
IconS3Location: S3Location | undefined;
|
|
1231
1371
|
/**
|
|
1372
|
+
* @public
|
|
1232
1373
|
* <p>The launch path of the application.</p>
|
|
1233
1374
|
*/
|
|
1234
1375
|
LaunchPath: string | undefined;
|
|
1235
1376
|
/**
|
|
1377
|
+
* @public
|
|
1236
1378
|
* <p>The working directory of the application.</p>
|
|
1237
1379
|
*/
|
|
1238
1380
|
WorkingDirectory?: string;
|
|
1239
1381
|
/**
|
|
1382
|
+
* @public
|
|
1240
1383
|
* <p>The launch parameters of the application.</p>
|
|
1241
1384
|
*/
|
|
1242
1385
|
LaunchParameters?: string;
|
|
1243
1386
|
/**
|
|
1387
|
+
* @public
|
|
1244
1388
|
* <p>The platforms the application supports. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.</p>
|
|
1245
1389
|
*/
|
|
1246
1390
|
Platforms: (PlatformType | string)[] | undefined;
|
|
1247
1391
|
/**
|
|
1392
|
+
* @public
|
|
1248
1393
|
* <p>The instance families the application supports. Valid values are GENERAL_PURPOSE and GRAPHICS_G4.</p>
|
|
1249
1394
|
*/
|
|
1250
1395
|
InstanceFamilies: string[] | undefined;
|
|
1251
1396
|
/**
|
|
1397
|
+
* @public
|
|
1252
1398
|
* <p>The app block ARN to which the application should be associated</p>
|
|
1253
1399
|
*/
|
|
1254
1400
|
AppBlockArn: string | undefined;
|
|
1255
1401
|
/**
|
|
1402
|
+
* @public
|
|
1256
1403
|
* <p>The tags assigned to the application.</p>
|
|
1257
1404
|
*/
|
|
1258
1405
|
Tags?: Record<string, string>;
|
|
@@ -1262,6 +1409,7 @@ export interface CreateApplicationRequest {
|
|
|
1262
1409
|
*/
|
|
1263
1410
|
export interface CreateApplicationResult {
|
|
1264
1411
|
/**
|
|
1412
|
+
* @public
|
|
1265
1413
|
* <p>Describes an application in the application catalog.</p>
|
|
1266
1414
|
*/
|
|
1267
1415
|
Application?: Application;
|
|
@@ -1272,12 +1420,14 @@ export interface CreateApplicationResult {
|
|
|
1272
1420
|
*/
|
|
1273
1421
|
export interface ServiceAccountCredentials {
|
|
1274
1422
|
/**
|
|
1423
|
+
* @public
|
|
1275
1424
|
* <p>The user name of the account. This account must have the following privileges: create computer objects,
|
|
1276
1425
|
* join computers to the domain, and change/reset the password on descendant computer objects for the
|
|
1277
1426
|
* organizational units specified.</p>
|
|
1278
1427
|
*/
|
|
1279
1428
|
AccountName: string | undefined;
|
|
1280
1429
|
/**
|
|
1430
|
+
* @public
|
|
1281
1431
|
* <p>The password for the account.</p>
|
|
1282
1432
|
*/
|
|
1283
1433
|
AccountPassword: string | undefined;
|
|
@@ -1287,18 +1437,22 @@ export interface ServiceAccountCredentials {
|
|
|
1287
1437
|
*/
|
|
1288
1438
|
export interface CreateDirectoryConfigRequest {
|
|
1289
1439
|
/**
|
|
1440
|
+
* @public
|
|
1290
1441
|
* <p>The fully qualified name of the directory (for example, corp.example.com).</p>
|
|
1291
1442
|
*/
|
|
1292
1443
|
DirectoryName: string | undefined;
|
|
1293
1444
|
/**
|
|
1445
|
+
* @public
|
|
1294
1446
|
* <p>The distinguished names of the organizational units for computer accounts.</p>
|
|
1295
1447
|
*/
|
|
1296
1448
|
OrganizationalUnitDistinguishedNames: string[] | undefined;
|
|
1297
1449
|
/**
|
|
1450
|
+
* @public
|
|
1298
1451
|
* <p>The credentials for the service account used by the fleet or image builder to connect to the directory.</p>
|
|
1299
1452
|
*/
|
|
1300
1453
|
ServiceAccountCredentials?: ServiceAccountCredentials;
|
|
1301
1454
|
/**
|
|
1455
|
+
* @public
|
|
1302
1456
|
* <p>The certificate-based authentication properties used to authenticate SAML 2.0 Identity
|
|
1303
1457
|
* Provider (IdP) user identities to Active Directory domain-joined streaming instances.
|
|
1304
1458
|
* Fallback is turned on by default when certificate-based authentication is <b>Enabled</b> . Fallback allows users to log in using their AD
|
|
@@ -1315,22 +1469,27 @@ export interface CreateDirectoryConfigRequest {
|
|
|
1315
1469
|
*/
|
|
1316
1470
|
export interface DirectoryConfig {
|
|
1317
1471
|
/**
|
|
1472
|
+
* @public
|
|
1318
1473
|
* <p>The fully qualified name of the directory (for example, corp.example.com).</p>
|
|
1319
1474
|
*/
|
|
1320
1475
|
DirectoryName: string | undefined;
|
|
1321
1476
|
/**
|
|
1477
|
+
* @public
|
|
1322
1478
|
* <p>The distinguished names of the organizational units for computer accounts.</p>
|
|
1323
1479
|
*/
|
|
1324
1480
|
OrganizationalUnitDistinguishedNames?: string[];
|
|
1325
1481
|
/**
|
|
1482
|
+
* @public
|
|
1326
1483
|
* <p>The credentials for the service account used by the fleet or image builder to connect to the directory.</p>
|
|
1327
1484
|
*/
|
|
1328
1485
|
ServiceAccountCredentials?: ServiceAccountCredentials;
|
|
1329
1486
|
/**
|
|
1487
|
+
* @public
|
|
1330
1488
|
* <p>The time the directory configuration was created.</p>
|
|
1331
1489
|
*/
|
|
1332
1490
|
CreatedTime?: Date;
|
|
1333
1491
|
/**
|
|
1492
|
+
* @public
|
|
1334
1493
|
* <p>The certificate-based authentication properties used to authenticate SAML 2.0 Identity
|
|
1335
1494
|
* Provider (IdP) user identities to Active Directory domain-joined streaming instances.
|
|
1336
1495
|
* Fallback is turned on by default when certificate-based authentication is <b>Enabled</b> . Fallback allows users to log in using their AD
|
|
@@ -1346,6 +1505,7 @@ export interface DirectoryConfig {
|
|
|
1346
1505
|
*/
|
|
1347
1506
|
export interface CreateDirectoryConfigResult {
|
|
1348
1507
|
/**
|
|
1508
|
+
* @public
|
|
1349
1509
|
* <p>Information about the directory configuration.</p>
|
|
1350
1510
|
*/
|
|
1351
1511
|
DirectoryConfig?: DirectoryConfig;
|
|
@@ -1358,6 +1518,7 @@ export interface CreateDirectoryConfigResult {
|
|
|
1358
1518
|
*/
|
|
1359
1519
|
export interface EntitlementAttribute {
|
|
1360
1520
|
/**
|
|
1521
|
+
* @public
|
|
1361
1522
|
* <p>A supported AWS IAM SAML <code>PrincipalTag</code> attribute that is matched to the
|
|
1362
1523
|
* associated value when a user identity federates into an Amazon AppStream 2.0 SAML
|
|
1363
1524
|
* application.</p>
|
|
@@ -1389,6 +1550,7 @@ export interface EntitlementAttribute {
|
|
|
1389
1550
|
*/
|
|
1390
1551
|
Name: string | undefined;
|
|
1391
1552
|
/**
|
|
1553
|
+
* @public
|
|
1392
1554
|
* <p>A value that is matched to a supported SAML attribute name when a user identity
|
|
1393
1555
|
* federates into an Amazon AppStream 2.0 SAML application. </p>
|
|
1394
1556
|
*/
|
|
@@ -1399,22 +1561,27 @@ export interface EntitlementAttribute {
|
|
|
1399
1561
|
*/
|
|
1400
1562
|
export interface CreateEntitlementRequest {
|
|
1401
1563
|
/**
|
|
1564
|
+
* @public
|
|
1402
1565
|
* <p>The name of the entitlement.</p>
|
|
1403
1566
|
*/
|
|
1404
1567
|
Name: string | undefined;
|
|
1405
1568
|
/**
|
|
1569
|
+
* @public
|
|
1406
1570
|
* <p>The name of the stack with which the entitlement is associated.</p>
|
|
1407
1571
|
*/
|
|
1408
1572
|
StackName: string | undefined;
|
|
1409
1573
|
/**
|
|
1574
|
+
* @public
|
|
1410
1575
|
* <p>The description of the entitlement.</p>
|
|
1411
1576
|
*/
|
|
1412
1577
|
Description?: string;
|
|
1413
1578
|
/**
|
|
1579
|
+
* @public
|
|
1414
1580
|
* <p>Specifies whether all or selected apps are entitled.</p>
|
|
1415
1581
|
*/
|
|
1416
1582
|
AppVisibility: AppVisibility | string | undefined;
|
|
1417
1583
|
/**
|
|
1584
|
+
* @public
|
|
1418
1585
|
* <p>The attributes of the entitlement.</p>
|
|
1419
1586
|
*/
|
|
1420
1587
|
Attributes: EntitlementAttribute[] | undefined;
|
|
@@ -1430,30 +1597,37 @@ export interface CreateEntitlementRequest {
|
|
|
1430
1597
|
*/
|
|
1431
1598
|
export interface Entitlement {
|
|
1432
1599
|
/**
|
|
1600
|
+
* @public
|
|
1433
1601
|
* <p>The name of the entitlement.</p>
|
|
1434
1602
|
*/
|
|
1435
1603
|
Name: string | undefined;
|
|
1436
1604
|
/**
|
|
1605
|
+
* @public
|
|
1437
1606
|
* <p>The name of the stack with which the entitlement is associated.</p>
|
|
1438
1607
|
*/
|
|
1439
1608
|
StackName: string | undefined;
|
|
1440
1609
|
/**
|
|
1610
|
+
* @public
|
|
1441
1611
|
* <p>The description of the entitlement.</p>
|
|
1442
1612
|
*/
|
|
1443
1613
|
Description?: string;
|
|
1444
1614
|
/**
|
|
1615
|
+
* @public
|
|
1445
1616
|
* <p>Specifies whether all or selected apps are entitled.</p>
|
|
1446
1617
|
*/
|
|
1447
1618
|
AppVisibility: AppVisibility | string | undefined;
|
|
1448
1619
|
/**
|
|
1620
|
+
* @public
|
|
1449
1621
|
* <p>The attributes of the entitlement.</p>
|
|
1450
1622
|
*/
|
|
1451
1623
|
Attributes: EntitlementAttribute[] | undefined;
|
|
1452
1624
|
/**
|
|
1625
|
+
* @public
|
|
1453
1626
|
* <p>The time when the entitlement was created.</p>
|
|
1454
1627
|
*/
|
|
1455
1628
|
CreatedTime?: Date;
|
|
1456
1629
|
/**
|
|
1630
|
+
* @public
|
|
1457
1631
|
* <p>The time when the entitlement was last modified.</p>
|
|
1458
1632
|
*/
|
|
1459
1633
|
LastModifiedTime?: Date;
|
|
@@ -1463,6 +1637,7 @@ export interface Entitlement {
|
|
|
1463
1637
|
*/
|
|
1464
1638
|
export interface CreateEntitlementResult {
|
|
1465
1639
|
/**
|
|
1640
|
+
* @public
|
|
1466
1641
|
* <p>The entitlement.</p>
|
|
1467
1642
|
*/
|
|
1468
1643
|
Entitlement?: Entitlement;
|
|
@@ -1475,6 +1650,7 @@ export declare class EntitlementAlreadyExistsException extends __BaseException {
|
|
|
1475
1650
|
readonly name: "EntitlementAlreadyExistsException";
|
|
1476
1651
|
readonly $fault: "client";
|
|
1477
1652
|
/**
|
|
1653
|
+
* @public
|
|
1478
1654
|
* <p>The error message in the exception.</p>
|
|
1479
1655
|
*/
|
|
1480
1656
|
Message?: string;
|
|
@@ -1489,10 +1665,12 @@ export declare class EntitlementAlreadyExistsException extends __BaseException {
|
|
|
1489
1665
|
*/
|
|
1490
1666
|
export interface DomainJoinInfo {
|
|
1491
1667
|
/**
|
|
1668
|
+
* @public
|
|
1492
1669
|
* <p>The fully qualified name of the directory (for example, corp.example.com).</p>
|
|
1493
1670
|
*/
|
|
1494
1671
|
DirectoryName?: string;
|
|
1495
1672
|
/**
|
|
1673
|
+
* @public
|
|
1496
1674
|
* <p>The distinguished name of the organizational unit for computer accounts.</p>
|
|
1497
1675
|
*/
|
|
1498
1676
|
OrganizationalUnitDistinguishedName?: string;
|
|
@@ -1527,18 +1705,22 @@ export type StreamView = (typeof StreamView)[keyof typeof StreamView];
|
|
|
1527
1705
|
*/
|
|
1528
1706
|
export interface CreateFleetRequest {
|
|
1529
1707
|
/**
|
|
1708
|
+
* @public
|
|
1530
1709
|
* <p>A unique name for the fleet.</p>
|
|
1531
1710
|
*/
|
|
1532
1711
|
Name: string | undefined;
|
|
1533
1712
|
/**
|
|
1713
|
+
* @public
|
|
1534
1714
|
* <p>The name of the image used to create the fleet.</p>
|
|
1535
1715
|
*/
|
|
1536
1716
|
ImageName?: string;
|
|
1537
1717
|
/**
|
|
1718
|
+
* @public
|
|
1538
1719
|
* <p>The ARN of the public, private, or shared image to use.</p>
|
|
1539
1720
|
*/
|
|
1540
1721
|
ImageArn?: string;
|
|
1541
1722
|
/**
|
|
1723
|
+
* @public
|
|
1542
1724
|
* <p>The instance type to use when launching fleet instances. The following instance types are available:</p>
|
|
1543
1725
|
* <ul>
|
|
1544
1726
|
* <li>
|
|
@@ -1668,6 +1850,7 @@ export interface CreateFleetRequest {
|
|
|
1668
1850
|
*/
|
|
1669
1851
|
InstanceType: string | undefined;
|
|
1670
1852
|
/**
|
|
1853
|
+
* @public
|
|
1671
1854
|
* <p>The fleet type.</p>
|
|
1672
1855
|
* <dl>
|
|
1673
1856
|
* <dt>ALWAYS_ON</dt>
|
|
@@ -1685,40 +1868,49 @@ export interface CreateFleetRequest {
|
|
|
1685
1868
|
*/
|
|
1686
1869
|
FleetType?: FleetType | string;
|
|
1687
1870
|
/**
|
|
1871
|
+
* @public
|
|
1688
1872
|
* <p>The desired capacity for the fleet. This is not allowed for Elastic fleets. For Elastic fleets, specify MaxConcurrentSessions instead.</p>
|
|
1689
1873
|
*/
|
|
1690
1874
|
ComputeCapacity?: ComputeCapacity;
|
|
1691
1875
|
/**
|
|
1876
|
+
* @public
|
|
1692
1877
|
* <p>The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.</p>
|
|
1693
1878
|
*/
|
|
1694
1879
|
VpcConfig?: VpcConfig;
|
|
1695
1880
|
/**
|
|
1881
|
+
* @public
|
|
1696
1882
|
* <p>The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.</p>
|
|
1697
1883
|
* <p>Specify a value between 600 and 360000.</p>
|
|
1698
1884
|
*/
|
|
1699
1885
|
MaxUserDurationInSeconds?: number;
|
|
1700
1886
|
/**
|
|
1887
|
+
* @public
|
|
1701
1888
|
* <p>The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance. </p>
|
|
1702
1889
|
* <p>Specify a value between 60 and 360000.</p>
|
|
1703
1890
|
*/
|
|
1704
1891
|
DisconnectTimeoutInSeconds?: number;
|
|
1705
1892
|
/**
|
|
1893
|
+
* @public
|
|
1706
1894
|
* <p>The description to display.</p>
|
|
1707
1895
|
*/
|
|
1708
1896
|
Description?: string;
|
|
1709
1897
|
/**
|
|
1898
|
+
* @public
|
|
1710
1899
|
* <p>The fleet name to display.</p>
|
|
1711
1900
|
*/
|
|
1712
1901
|
DisplayName?: string;
|
|
1713
1902
|
/**
|
|
1903
|
+
* @public
|
|
1714
1904
|
* <p>Enables or disables default internet access for the fleet.</p>
|
|
1715
1905
|
*/
|
|
1716
1906
|
EnableDefaultInternetAccess?: boolean;
|
|
1717
1907
|
/**
|
|
1908
|
+
* @public
|
|
1718
1909
|
* <p>The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. This is not allowed for Elastic fleets. </p>
|
|
1719
1910
|
*/
|
|
1720
1911
|
DomainJoinInfo?: DomainJoinInfo;
|
|
1721
1912
|
/**
|
|
1913
|
+
* @public
|
|
1722
1914
|
* <p>The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. </p>
|
|
1723
1915
|
* <p>If you do not specify a value, the value is set to an empty string.</p>
|
|
1724
1916
|
* <p>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: </p>
|
|
@@ -1727,6 +1919,7 @@ export interface CreateFleetRequest {
|
|
|
1727
1919
|
*/
|
|
1728
1920
|
Tags?: Record<string, string>;
|
|
1729
1921
|
/**
|
|
1922
|
+
* @public
|
|
1730
1923
|
* <p>The amount of time that users can be idle (inactive) before they are disconnected
|
|
1731
1924
|
* from their streaming session and the <code>DisconnectTimeoutInSeconds</code> time
|
|
1732
1925
|
* interval begins. Users are notified before they are disconnected due to inactivity. If
|
|
@@ -1744,30 +1937,36 @@ export interface CreateFleetRequest {
|
|
|
1744
1937
|
*/
|
|
1745
1938
|
IdleDisconnectTimeoutInSeconds?: number;
|
|
1746
1939
|
/**
|
|
1940
|
+
* @public
|
|
1747
1941
|
* <p>The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) <code>AssumeRole</code> API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the <b>appstream_machine_role</b> credential profile on the instance.</p>
|
|
1748
1942
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html">Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>
|
|
1749
1943
|
*/
|
|
1750
1944
|
IamRoleArn?: string;
|
|
1751
1945
|
/**
|
|
1946
|
+
* @public
|
|
1752
1947
|
* <p>The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When <code>APP</code> is specified, only the windows of applications opened by users display. When <code>DESKTOP</code> is specified, the standard desktop that is provided by the operating system displays.</p>
|
|
1753
1948
|
* <p>The default value is <code>APP</code>.</p>
|
|
1754
1949
|
*/
|
|
1755
1950
|
StreamView?: StreamView | string;
|
|
1756
1951
|
/**
|
|
1952
|
+
* @public
|
|
1757
1953
|
* <p>The fleet platform. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic
|
|
1758
1954
|
* fleets. </p>
|
|
1759
1955
|
*/
|
|
1760
1956
|
Platform?: PlatformType | string;
|
|
1761
1957
|
/**
|
|
1958
|
+
* @public
|
|
1762
1959
|
* <p>The maximum concurrent sessions of the Elastic fleet. This is required for Elastic
|
|
1763
1960
|
* fleets, and not allowed for other fleet types.</p>
|
|
1764
1961
|
*/
|
|
1765
1962
|
MaxConcurrentSessions?: number;
|
|
1766
1963
|
/**
|
|
1964
|
+
* @public
|
|
1767
1965
|
* <p>The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.</p>
|
|
1768
1966
|
*/
|
|
1769
1967
|
UsbDeviceFilterStrings?: string[];
|
|
1770
1968
|
/**
|
|
1969
|
+
* @public
|
|
1771
1970
|
* <p>The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.</p>
|
|
1772
1971
|
*/
|
|
1773
1972
|
SessionScriptS3Location?: S3Location;
|
|
@@ -1778,10 +1977,12 @@ export interface CreateFleetRequest {
|
|
|
1778
1977
|
*/
|
|
1779
1978
|
export interface FleetError {
|
|
1780
1979
|
/**
|
|
1980
|
+
* @public
|
|
1781
1981
|
* <p>The error code.</p>
|
|
1782
1982
|
*/
|
|
1783
1983
|
ErrorCode?: FleetErrorCode | string;
|
|
1784
1984
|
/**
|
|
1985
|
+
* @public
|
|
1785
1986
|
* <p>The error message.</p>
|
|
1786
1987
|
*/
|
|
1787
1988
|
ErrorMessage?: string;
|
|
@@ -1806,30 +2007,37 @@ export type FleetState = (typeof FleetState)[keyof typeof FleetState];
|
|
|
1806
2007
|
*/
|
|
1807
2008
|
export interface Fleet {
|
|
1808
2009
|
/**
|
|
2010
|
+
* @public
|
|
1809
2011
|
* <p>The Amazon Resource Name (ARN) for the fleet.</p>
|
|
1810
2012
|
*/
|
|
1811
2013
|
Arn: string | undefined;
|
|
1812
2014
|
/**
|
|
2015
|
+
* @public
|
|
1813
2016
|
* <p>The name of the fleet.</p>
|
|
1814
2017
|
*/
|
|
1815
2018
|
Name: string | undefined;
|
|
1816
2019
|
/**
|
|
2020
|
+
* @public
|
|
1817
2021
|
* <p>The fleet name to display.</p>
|
|
1818
2022
|
*/
|
|
1819
2023
|
DisplayName?: string;
|
|
1820
2024
|
/**
|
|
2025
|
+
* @public
|
|
1821
2026
|
* <p>The description to display.</p>
|
|
1822
2027
|
*/
|
|
1823
2028
|
Description?: string;
|
|
1824
2029
|
/**
|
|
2030
|
+
* @public
|
|
1825
2031
|
* <p>The name of the image used to create the fleet.</p>
|
|
1826
2032
|
*/
|
|
1827
2033
|
ImageName?: string;
|
|
1828
2034
|
/**
|
|
2035
|
+
* @public
|
|
1829
2036
|
* <p>The ARN for the public, private, or shared image.</p>
|
|
1830
2037
|
*/
|
|
1831
2038
|
ImageArn?: string;
|
|
1832
2039
|
/**
|
|
2040
|
+
* @public
|
|
1833
2041
|
* <p>The instance type to use when launching fleet instances. The following instance types are available:</p>
|
|
1834
2042
|
* <ul>
|
|
1835
2043
|
* <li>
|
|
@@ -1935,6 +2143,7 @@ export interface Fleet {
|
|
|
1935
2143
|
*/
|
|
1936
2144
|
InstanceType: string | undefined;
|
|
1937
2145
|
/**
|
|
2146
|
+
* @public
|
|
1938
2147
|
* <p>The fleet type.</p>
|
|
1939
2148
|
* <dl>
|
|
1940
2149
|
* <dt>ALWAYS_ON</dt>
|
|
@@ -1952,44 +2161,54 @@ export interface Fleet {
|
|
|
1952
2161
|
*/
|
|
1953
2162
|
FleetType?: FleetType | string;
|
|
1954
2163
|
/**
|
|
2164
|
+
* @public
|
|
1955
2165
|
* <p>The capacity status for the fleet.</p>
|
|
1956
2166
|
*/
|
|
1957
2167
|
ComputeCapacityStatus: ComputeCapacityStatus | undefined;
|
|
1958
2168
|
/**
|
|
2169
|
+
* @public
|
|
1959
2170
|
* <p>The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance. </p>
|
|
1960
2171
|
* <p>Specify a value between 600 and 360000.</p>
|
|
1961
2172
|
*/
|
|
1962
2173
|
MaxUserDurationInSeconds?: number;
|
|
1963
2174
|
/**
|
|
2175
|
+
* @public
|
|
1964
2176
|
* <p>The amount of time that a streaming session remains active after users disconnect. If they try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.</p>
|
|
1965
2177
|
* <p>Specify a value between 60 and 360000.</p>
|
|
1966
2178
|
*/
|
|
1967
2179
|
DisconnectTimeoutInSeconds?: number;
|
|
1968
2180
|
/**
|
|
2181
|
+
* @public
|
|
1969
2182
|
* <p>The current state for the fleet.</p>
|
|
1970
2183
|
*/
|
|
1971
2184
|
State: FleetState | string | undefined;
|
|
1972
2185
|
/**
|
|
2186
|
+
* @public
|
|
1973
2187
|
* <p>The VPC configuration for the fleet.</p>
|
|
1974
2188
|
*/
|
|
1975
2189
|
VpcConfig?: VpcConfig;
|
|
1976
2190
|
/**
|
|
2191
|
+
* @public
|
|
1977
2192
|
* <p>The time the fleet was created.</p>
|
|
1978
2193
|
*/
|
|
1979
2194
|
CreatedTime?: Date;
|
|
1980
2195
|
/**
|
|
2196
|
+
* @public
|
|
1981
2197
|
* <p>The fleet errors.</p>
|
|
1982
2198
|
*/
|
|
1983
2199
|
FleetErrors?: FleetError[];
|
|
1984
2200
|
/**
|
|
2201
|
+
* @public
|
|
1985
2202
|
* <p>Indicates whether default internet access is enabled for the fleet.</p>
|
|
1986
2203
|
*/
|
|
1987
2204
|
EnableDefaultInternetAccess?: boolean;
|
|
1988
2205
|
/**
|
|
2206
|
+
* @public
|
|
1989
2207
|
* <p>The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. </p>
|
|
1990
2208
|
*/
|
|
1991
2209
|
DomainJoinInfo?: DomainJoinInfo;
|
|
1992
2210
|
/**
|
|
2211
|
+
* @public
|
|
1993
2212
|
* <p>The amount of time that users can be idle (inactive) before they are disconnected
|
|
1994
2213
|
* from their streaming session and the <code>DisconnectTimeoutInSeconds</code> time
|
|
1995
2214
|
* interval begins. Users are notified before they are disconnected due to inactivity. If
|
|
@@ -2007,28 +2226,34 @@ export interface Fleet {
|
|
|
2007
2226
|
*/
|
|
2008
2227
|
IdleDisconnectTimeoutInSeconds?: number;
|
|
2009
2228
|
/**
|
|
2229
|
+
* @public
|
|
2010
2230
|
* <p>The ARN of the IAM role that is applied to the fleet. To assume a role, the fleet instance calls the AWS Security Token Service (STS) <code>AssumeRole</code> API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the <b>appstream_machine_role</b> credential profile on the instance.</p>
|
|
2011
2231
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html">Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>
|
|
2012
2232
|
*/
|
|
2013
2233
|
IamRoleArn?: string;
|
|
2014
2234
|
/**
|
|
2235
|
+
* @public
|
|
2015
2236
|
* <p>The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When <code>APP</code> is specified, only the windows of applications opened by users display. When <code>DESKTOP</code> is specified, the standard desktop that is provided by the operating system displays.</p>
|
|
2016
2237
|
* <p>The default value is <code>APP</code>.</p>
|
|
2017
2238
|
*/
|
|
2018
2239
|
StreamView?: StreamView | string;
|
|
2019
2240
|
/**
|
|
2241
|
+
* @public
|
|
2020
2242
|
* <p>The platform of the fleet.</p>
|
|
2021
2243
|
*/
|
|
2022
2244
|
Platform?: PlatformType | string;
|
|
2023
2245
|
/**
|
|
2246
|
+
* @public
|
|
2024
2247
|
* <p>The maximum number of concurrent sessions for the fleet.</p>
|
|
2025
2248
|
*/
|
|
2026
2249
|
MaxConcurrentSessions?: number;
|
|
2027
2250
|
/**
|
|
2251
|
+
* @public
|
|
2028
2252
|
* <p>The USB device filter strings associated with the fleet.</p>
|
|
2029
2253
|
*/
|
|
2030
2254
|
UsbDeviceFilterStrings?: string[];
|
|
2031
2255
|
/**
|
|
2256
|
+
* @public
|
|
2032
2257
|
* <p>The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.</p>
|
|
2033
2258
|
*/
|
|
2034
2259
|
SessionScriptS3Location?: S3Location;
|
|
@@ -2038,6 +2263,7 @@ export interface Fleet {
|
|
|
2038
2263
|
*/
|
|
2039
2264
|
export interface CreateFleetResult {
|
|
2040
2265
|
/**
|
|
2266
|
+
* @public
|
|
2041
2267
|
* <p>Information about the fleet.</p>
|
|
2042
2268
|
*/
|
|
2043
2269
|
Fleet?: Fleet;
|
|
@@ -2047,18 +2273,22 @@ export interface CreateFleetResult {
|
|
|
2047
2273
|
*/
|
|
2048
2274
|
export interface CreateImageBuilderRequest {
|
|
2049
2275
|
/**
|
|
2276
|
+
* @public
|
|
2050
2277
|
* <p>A unique name for the image builder.</p>
|
|
2051
2278
|
*/
|
|
2052
2279
|
Name: string | undefined;
|
|
2053
2280
|
/**
|
|
2281
|
+
* @public
|
|
2054
2282
|
* <p>The name of the image used to create the image builder.</p>
|
|
2055
2283
|
*/
|
|
2056
2284
|
ImageName?: string;
|
|
2057
2285
|
/**
|
|
2286
|
+
* @public
|
|
2058
2287
|
* <p>The ARN of the public, private, or shared image to use.</p>
|
|
2059
2288
|
*/
|
|
2060
2289
|
ImageArn?: string;
|
|
2061
2290
|
/**
|
|
2291
|
+
* @public
|
|
2062
2292
|
* <p>The instance type to use when launching the image builder. The following instance types are available:</p>
|
|
2063
2293
|
* <ul>
|
|
2064
2294
|
* <li>
|
|
@@ -2164,35 +2394,43 @@ export interface CreateImageBuilderRequest {
|
|
|
2164
2394
|
*/
|
|
2165
2395
|
InstanceType: string | undefined;
|
|
2166
2396
|
/**
|
|
2397
|
+
* @public
|
|
2167
2398
|
* <p>The description to display.</p>
|
|
2168
2399
|
*/
|
|
2169
2400
|
Description?: string;
|
|
2170
2401
|
/**
|
|
2402
|
+
* @public
|
|
2171
2403
|
* <p>The image builder name to display.</p>
|
|
2172
2404
|
*/
|
|
2173
2405
|
DisplayName?: string;
|
|
2174
2406
|
/**
|
|
2407
|
+
* @public
|
|
2175
2408
|
* <p>The VPC configuration for the image builder. You can specify only one subnet.</p>
|
|
2176
2409
|
*/
|
|
2177
2410
|
VpcConfig?: VpcConfig;
|
|
2178
2411
|
/**
|
|
2412
|
+
* @public
|
|
2179
2413
|
* <p>The Amazon Resource Name (ARN) of the IAM role to apply to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) <code>AssumeRole</code> API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the <b>appstream_machine_role</b> credential profile on the instance.</p>
|
|
2180
2414
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html">Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>
|
|
2181
2415
|
*/
|
|
2182
2416
|
IamRoleArn?: string;
|
|
2183
2417
|
/**
|
|
2418
|
+
* @public
|
|
2184
2419
|
* <p>Enables or disables default internet access for the image builder.</p>
|
|
2185
2420
|
*/
|
|
2186
2421
|
EnableDefaultInternetAccess?: boolean;
|
|
2187
2422
|
/**
|
|
2423
|
+
* @public
|
|
2188
2424
|
* <p>The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain. </p>
|
|
2189
2425
|
*/
|
|
2190
2426
|
DomainJoinInfo?: DomainJoinInfo;
|
|
2191
2427
|
/**
|
|
2428
|
+
* @public
|
|
2192
2429
|
* <p>The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST]. </p>
|
|
2193
2430
|
*/
|
|
2194
2431
|
AppstreamAgentVersion?: string;
|
|
2195
2432
|
/**
|
|
2433
|
+
* @public
|
|
2196
2434
|
* <p>The tags to associate with the image builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. </p>
|
|
2197
2435
|
* <p>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: </p>
|
|
2198
2436
|
* <p>_ . : / = + \ - @</p>
|
|
@@ -2201,6 +2439,7 @@ export interface CreateImageBuilderRequest {
|
|
|
2201
2439
|
*/
|
|
2202
2440
|
Tags?: Record<string, string>;
|
|
2203
2441
|
/**
|
|
2442
|
+
* @public
|
|
2204
2443
|
* <p>The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image builder only through the specified endpoints.</p>
|
|
2205
2444
|
*/
|
|
2206
2445
|
AccessEndpoints?: AccessEndpoint[];
|
|
@@ -2211,10 +2450,12 @@ export interface CreateImageBuilderRequest {
|
|
|
2211
2450
|
*/
|
|
2212
2451
|
export interface NetworkAccessConfiguration {
|
|
2213
2452
|
/**
|
|
2453
|
+
* @public
|
|
2214
2454
|
* <p>The private IP address of the elastic network interface that is attached to instances in your VPC.</p>
|
|
2215
2455
|
*/
|
|
2216
2456
|
EniPrivateIpAddress?: string;
|
|
2217
2457
|
/**
|
|
2458
|
+
* @public
|
|
2218
2459
|
* <p>The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.</p>
|
|
2219
2460
|
*/
|
|
2220
2461
|
EniId?: string;
|
|
@@ -2258,10 +2499,12 @@ export type ImageBuilderStateChangeReasonCode = (typeof ImageBuilderStateChangeR
|
|
|
2258
2499
|
*/
|
|
2259
2500
|
export interface ImageBuilderStateChangeReason {
|
|
2260
2501
|
/**
|
|
2502
|
+
* @public
|
|
2261
2503
|
* <p>The state change reason code.</p>
|
|
2262
2504
|
*/
|
|
2263
2505
|
Code?: ImageBuilderStateChangeReasonCode | string;
|
|
2264
2506
|
/**
|
|
2507
|
+
* @public
|
|
2265
2508
|
* <p>The state change reason message.</p>
|
|
2266
2509
|
*/
|
|
2267
2510
|
Message?: string;
|
|
@@ -2272,30 +2515,37 @@ export interface ImageBuilderStateChangeReason {
|
|
|
2272
2515
|
*/
|
|
2273
2516
|
export interface ImageBuilder {
|
|
2274
2517
|
/**
|
|
2518
|
+
* @public
|
|
2275
2519
|
* <p>The name of the image builder.</p>
|
|
2276
2520
|
*/
|
|
2277
2521
|
Name: string | undefined;
|
|
2278
2522
|
/**
|
|
2523
|
+
* @public
|
|
2279
2524
|
* <p>The ARN for the image builder.</p>
|
|
2280
2525
|
*/
|
|
2281
2526
|
Arn?: string;
|
|
2282
2527
|
/**
|
|
2528
|
+
* @public
|
|
2283
2529
|
* <p>The ARN of the image from which this builder was created.</p>
|
|
2284
2530
|
*/
|
|
2285
2531
|
ImageArn?: string;
|
|
2286
2532
|
/**
|
|
2533
|
+
* @public
|
|
2287
2534
|
* <p>The description to display.</p>
|
|
2288
2535
|
*/
|
|
2289
2536
|
Description?: string;
|
|
2290
2537
|
/**
|
|
2538
|
+
* @public
|
|
2291
2539
|
* <p>The image builder name to display.</p>
|
|
2292
2540
|
*/
|
|
2293
2541
|
DisplayName?: string;
|
|
2294
2542
|
/**
|
|
2543
|
+
* @public
|
|
2295
2544
|
* <p>The VPC configuration of the image builder.</p>
|
|
2296
2545
|
*/
|
|
2297
2546
|
VpcConfig?: VpcConfig;
|
|
2298
2547
|
/**
|
|
2548
|
+
* @public
|
|
2299
2549
|
* <p>The instance type for the image builder. The following instance types are available:</p>
|
|
2300
2550
|
* <ul>
|
|
2301
2551
|
* <li>
|
|
@@ -2401,47 +2651,58 @@ export interface ImageBuilder {
|
|
|
2401
2651
|
*/
|
|
2402
2652
|
InstanceType?: string;
|
|
2403
2653
|
/**
|
|
2654
|
+
* @public
|
|
2404
2655
|
* <p>The operating system platform of the image builder.</p>
|
|
2405
2656
|
*/
|
|
2406
2657
|
Platform?: PlatformType | string;
|
|
2407
2658
|
/**
|
|
2659
|
+
* @public
|
|
2408
2660
|
* <p>The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) <code>AssumeRole</code> API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the <b>appstream_machine_role</b> credential profile on the instance.</p>
|
|
2409
2661
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html">Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>
|
|
2410
2662
|
*/
|
|
2411
2663
|
IamRoleArn?: string;
|
|
2412
2664
|
/**
|
|
2665
|
+
* @public
|
|
2413
2666
|
* <p>The state of the image builder.</p>
|
|
2414
2667
|
*/
|
|
2415
2668
|
State?: ImageBuilderState | string;
|
|
2416
2669
|
/**
|
|
2670
|
+
* @public
|
|
2417
2671
|
* <p>The reason why the last state change occurred.</p>
|
|
2418
2672
|
*/
|
|
2419
2673
|
StateChangeReason?: ImageBuilderStateChangeReason;
|
|
2420
2674
|
/**
|
|
2675
|
+
* @public
|
|
2421
2676
|
* <p>The time stamp when the image builder was created.</p>
|
|
2422
2677
|
*/
|
|
2423
2678
|
CreatedTime?: Date;
|
|
2424
2679
|
/**
|
|
2680
|
+
* @public
|
|
2425
2681
|
* <p>Enables or disables default internet access for the image builder.</p>
|
|
2426
2682
|
*/
|
|
2427
2683
|
EnableDefaultInternetAccess?: boolean;
|
|
2428
2684
|
/**
|
|
2685
|
+
* @public
|
|
2429
2686
|
* <p>The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain. </p>
|
|
2430
2687
|
*/
|
|
2431
2688
|
DomainJoinInfo?: DomainJoinInfo;
|
|
2432
2689
|
/**
|
|
2690
|
+
* @public
|
|
2433
2691
|
* <p>Describes the network details of the fleet or image builder instance.</p>
|
|
2434
2692
|
*/
|
|
2435
2693
|
NetworkAccessConfiguration?: NetworkAccessConfiguration;
|
|
2436
2694
|
/**
|
|
2695
|
+
* @public
|
|
2437
2696
|
* <p>The image builder errors.</p>
|
|
2438
2697
|
*/
|
|
2439
2698
|
ImageBuilderErrors?: ResourceError[];
|
|
2440
2699
|
/**
|
|
2700
|
+
* @public
|
|
2441
2701
|
* <p>The version of the AppStream 2.0 agent that is currently being used by the image builder. </p>
|
|
2442
2702
|
*/
|
|
2443
2703
|
AppstreamAgentVersion?: string;
|
|
2444
2704
|
/**
|
|
2705
|
+
* @public
|
|
2445
2706
|
* <p>The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.</p>
|
|
2446
2707
|
*/
|
|
2447
2708
|
AccessEndpoints?: AccessEndpoint[];
|
|
@@ -2451,6 +2712,7 @@ export interface ImageBuilder {
|
|
|
2451
2712
|
*/
|
|
2452
2713
|
export interface CreateImageBuilderResult {
|
|
2453
2714
|
/**
|
|
2715
|
+
* @public
|
|
2454
2716
|
* <p>Information about the image builder.</p>
|
|
2455
2717
|
*/
|
|
2456
2718
|
ImageBuilder?: ImageBuilder;
|
|
@@ -2460,10 +2722,12 @@ export interface CreateImageBuilderResult {
|
|
|
2460
2722
|
*/
|
|
2461
2723
|
export interface CreateImageBuilderStreamingURLRequest {
|
|
2462
2724
|
/**
|
|
2725
|
+
* @public
|
|
2463
2726
|
* <p>The name of the image builder.</p>
|
|
2464
2727
|
*/
|
|
2465
2728
|
Name: string | undefined;
|
|
2466
2729
|
/**
|
|
2730
|
+
* @public
|
|
2467
2731
|
* <p>The time that the streaming URL will be valid, in seconds.
|
|
2468
2732
|
* Specify a value between 1 and 604800 seconds. The default is 3600 seconds.</p>
|
|
2469
2733
|
*/
|
|
@@ -2474,10 +2738,12 @@ export interface CreateImageBuilderStreamingURLRequest {
|
|
|
2474
2738
|
*/
|
|
2475
2739
|
export interface CreateImageBuilderStreamingURLResult {
|
|
2476
2740
|
/**
|
|
2741
|
+
* @public
|
|
2477
2742
|
* <p>The URL to start the AppStream 2.0 streaming session.</p>
|
|
2478
2743
|
*/
|
|
2479
2744
|
StreamingURL?: string;
|
|
2480
2745
|
/**
|
|
2746
|
+
* @public
|
|
2481
2747
|
* <p>The elapsed time, in seconds after the Unix epoch, when this URL expires.</p>
|
|
2482
2748
|
*/
|
|
2483
2749
|
Expires?: Date;
|
|
@@ -2501,14 +2767,17 @@ export type StorageConnectorType = (typeof StorageConnectorType)[keyof typeof St
|
|
|
2501
2767
|
*/
|
|
2502
2768
|
export interface StorageConnector {
|
|
2503
2769
|
/**
|
|
2770
|
+
* @public
|
|
2504
2771
|
* <p>The type of storage connector.</p>
|
|
2505
2772
|
*/
|
|
2506
2773
|
ConnectorType: StorageConnectorType | string | undefined;
|
|
2507
2774
|
/**
|
|
2775
|
+
* @public
|
|
2508
2776
|
* <p>The ARN of the storage connector.</p>
|
|
2509
2777
|
*/
|
|
2510
2778
|
ResourceIdentifier?: string;
|
|
2511
2779
|
/**
|
|
2780
|
+
* @public
|
|
2512
2781
|
* <p>The names of the domains for the account.</p>
|
|
2513
2782
|
*/
|
|
2514
2783
|
Domains?: string[];
|
|
@@ -2531,6 +2800,7 @@ export type PreferredProtocol = (typeof PreferredProtocol)[keyof typeof Preferre
|
|
|
2531
2800
|
*/
|
|
2532
2801
|
export interface StreamingExperienceSettings {
|
|
2533
2802
|
/**
|
|
2803
|
+
* @public
|
|
2534
2804
|
* <p>The preferred protocol that you want to use while streaming your application.</p>
|
|
2535
2805
|
*/
|
|
2536
2806
|
PreferredProtocol?: PreferredProtocol | string;
|
|
@@ -2553,10 +2823,12 @@ export type Permission = (typeof Permission)[keyof typeof Permission];
|
|
|
2553
2823
|
*/
|
|
2554
2824
|
export interface UserSetting {
|
|
2555
2825
|
/**
|
|
2826
|
+
* @public
|
|
2556
2827
|
* <p>The action that is enabled or disabled.</p>
|
|
2557
2828
|
*/
|
|
2558
2829
|
Action: Action | string | undefined;
|
|
2559
2830
|
/**
|
|
2831
|
+
* @public
|
|
2560
2832
|
* <p>Indicates whether the action is enabled or disabled.</p>
|
|
2561
2833
|
*/
|
|
2562
2834
|
Permission: Permission | string | undefined;
|
|
@@ -2566,38 +2838,47 @@ export interface UserSetting {
|
|
|
2566
2838
|
*/
|
|
2567
2839
|
export interface CreateStackRequest {
|
|
2568
2840
|
/**
|
|
2841
|
+
* @public
|
|
2569
2842
|
* <p>The name of the stack.</p>
|
|
2570
2843
|
*/
|
|
2571
2844
|
Name: string | undefined;
|
|
2572
2845
|
/**
|
|
2846
|
+
* @public
|
|
2573
2847
|
* <p>The description to display.</p>
|
|
2574
2848
|
*/
|
|
2575
2849
|
Description?: string;
|
|
2576
2850
|
/**
|
|
2851
|
+
* @public
|
|
2577
2852
|
* <p>The stack name to display.</p>
|
|
2578
2853
|
*/
|
|
2579
2854
|
DisplayName?: string;
|
|
2580
2855
|
/**
|
|
2856
|
+
* @public
|
|
2581
2857
|
* <p>The storage connectors to enable.</p>
|
|
2582
2858
|
*/
|
|
2583
2859
|
StorageConnectors?: StorageConnector[];
|
|
2584
2860
|
/**
|
|
2861
|
+
* @public
|
|
2585
2862
|
* <p>The URL that users are redirected to after their streaming session ends.</p>
|
|
2586
2863
|
*/
|
|
2587
2864
|
RedirectURL?: string;
|
|
2588
2865
|
/**
|
|
2866
|
+
* @public
|
|
2589
2867
|
* <p>The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.</p>
|
|
2590
2868
|
*/
|
|
2591
2869
|
FeedbackURL?: string;
|
|
2592
2870
|
/**
|
|
2871
|
+
* @public
|
|
2593
2872
|
* <p>The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled. </p>
|
|
2594
2873
|
*/
|
|
2595
2874
|
UserSettings?: UserSetting[];
|
|
2596
2875
|
/**
|
|
2876
|
+
* @public
|
|
2597
2877
|
* <p>The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.</p>
|
|
2598
2878
|
*/
|
|
2599
2879
|
ApplicationSettings?: ApplicationSettings;
|
|
2600
2880
|
/**
|
|
2881
|
+
* @public
|
|
2601
2882
|
* <p>The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. </p>
|
|
2602
2883
|
* <p>If you do not specify a value, the value is set to an empty string.</p>
|
|
2603
2884
|
* <p>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: </p>
|
|
@@ -2606,14 +2887,17 @@ export interface CreateStackRequest {
|
|
|
2606
2887
|
*/
|
|
2607
2888
|
Tags?: Record<string, string>;
|
|
2608
2889
|
/**
|
|
2890
|
+
* @public
|
|
2609
2891
|
* <p>The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.</p>
|
|
2610
2892
|
*/
|
|
2611
2893
|
AccessEndpoints?: AccessEndpoint[];
|
|
2612
2894
|
/**
|
|
2895
|
+
* @public
|
|
2613
2896
|
* <p>The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions. </p>
|
|
2614
2897
|
*/
|
|
2615
2898
|
EmbedHostDomains?: string[];
|
|
2616
2899
|
/**
|
|
2900
|
+
* @public
|
|
2617
2901
|
* <p>The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.</p>
|
|
2618
2902
|
*/
|
|
2619
2903
|
StreamingExperienceSettings?: StreamingExperienceSettings;
|
|
@@ -2636,10 +2920,12 @@ export type StackErrorCode = (typeof StackErrorCode)[keyof typeof StackErrorCode
|
|
|
2636
2920
|
*/
|
|
2637
2921
|
export interface StackError {
|
|
2638
2922
|
/**
|
|
2923
|
+
* @public
|
|
2639
2924
|
* <p>The error code.</p>
|
|
2640
2925
|
*/
|
|
2641
2926
|
ErrorCode?: StackErrorCode | string;
|
|
2642
2927
|
/**
|
|
2928
|
+
* @public
|
|
2643
2929
|
* <p>The error message.</p>
|
|
2644
2930
|
*/
|
|
2645
2931
|
ErrorMessage?: string;
|
|
@@ -2650,58 +2936,72 @@ export interface StackError {
|
|
|
2650
2936
|
*/
|
|
2651
2937
|
export interface Stack {
|
|
2652
2938
|
/**
|
|
2939
|
+
* @public
|
|
2653
2940
|
* <p>The ARN of the stack.</p>
|
|
2654
2941
|
*/
|
|
2655
2942
|
Arn?: string;
|
|
2656
2943
|
/**
|
|
2944
|
+
* @public
|
|
2657
2945
|
* <p>The name of the stack.</p>
|
|
2658
2946
|
*/
|
|
2659
2947
|
Name: string | undefined;
|
|
2660
2948
|
/**
|
|
2949
|
+
* @public
|
|
2661
2950
|
* <p>The description to display.</p>
|
|
2662
2951
|
*/
|
|
2663
2952
|
Description?: string;
|
|
2664
2953
|
/**
|
|
2954
|
+
* @public
|
|
2665
2955
|
* <p>The stack name to display.</p>
|
|
2666
2956
|
*/
|
|
2667
2957
|
DisplayName?: string;
|
|
2668
2958
|
/**
|
|
2959
|
+
* @public
|
|
2669
2960
|
* <p>The time the stack was created.</p>
|
|
2670
2961
|
*/
|
|
2671
2962
|
CreatedTime?: Date;
|
|
2672
2963
|
/**
|
|
2964
|
+
* @public
|
|
2673
2965
|
* <p>The storage connectors to enable.</p>
|
|
2674
2966
|
*/
|
|
2675
2967
|
StorageConnectors?: StorageConnector[];
|
|
2676
2968
|
/**
|
|
2969
|
+
* @public
|
|
2677
2970
|
* <p>The URL that users are redirected to after their streaming session ends.</p>
|
|
2678
2971
|
*/
|
|
2679
2972
|
RedirectURL?: string;
|
|
2680
2973
|
/**
|
|
2974
|
+
* @public
|
|
2681
2975
|
* <p>The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.</p>
|
|
2682
2976
|
*/
|
|
2683
2977
|
FeedbackURL?: string;
|
|
2684
2978
|
/**
|
|
2979
|
+
* @public
|
|
2685
2980
|
* <p>The errors for the stack.</p>
|
|
2686
2981
|
*/
|
|
2687
2982
|
StackErrors?: StackError[];
|
|
2688
2983
|
/**
|
|
2984
|
+
* @public
|
|
2689
2985
|
* <p>The actions that are enabled or disabled for users during their streaming sessions. By default these actions are enabled.</p>
|
|
2690
2986
|
*/
|
|
2691
2987
|
UserSettings?: UserSetting[];
|
|
2692
2988
|
/**
|
|
2989
|
+
* @public
|
|
2693
2990
|
* <p>The persistent application settings for users of the stack.</p>
|
|
2694
2991
|
*/
|
|
2695
2992
|
ApplicationSettings?: ApplicationSettingsResponse;
|
|
2696
2993
|
/**
|
|
2994
|
+
* @public
|
|
2697
2995
|
* <p>The list of virtual private cloud (VPC) interface endpoint objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints. </p>
|
|
2698
2996
|
*/
|
|
2699
2997
|
AccessEndpoints?: AccessEndpoint[];
|
|
2700
2998
|
/**
|
|
2999
|
+
* @public
|
|
2701
3000
|
* <p>The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.</p>
|
|
2702
3001
|
*/
|
|
2703
3002
|
EmbedHostDomains?: string[];
|
|
2704
3003
|
/**
|
|
3004
|
+
* @public
|
|
2705
3005
|
* <p>The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.</p>
|
|
2706
3006
|
*/
|
|
2707
3007
|
StreamingExperienceSettings?: StreamingExperienceSettings;
|
|
@@ -2711,6 +3011,7 @@ export interface Stack {
|
|
|
2711
3011
|
*/
|
|
2712
3012
|
export interface CreateStackResult {
|
|
2713
3013
|
/**
|
|
3014
|
+
* @public
|
|
2714
3015
|
* <p>Information about the stack.</p>
|
|
2715
3016
|
*/
|
|
2716
3017
|
Stack?: Stack;
|
|
@@ -2720,28 +3021,34 @@ export interface CreateStackResult {
|
|
|
2720
3021
|
*/
|
|
2721
3022
|
export interface CreateStreamingURLRequest {
|
|
2722
3023
|
/**
|
|
3024
|
+
* @public
|
|
2723
3025
|
* <p>The name of the stack.</p>
|
|
2724
3026
|
*/
|
|
2725
3027
|
StackName: string | undefined;
|
|
2726
3028
|
/**
|
|
3029
|
+
* @public
|
|
2727
3030
|
* <p>The name of the fleet.</p>
|
|
2728
3031
|
*/
|
|
2729
3032
|
FleetName: string | undefined;
|
|
2730
3033
|
/**
|
|
3034
|
+
* @public
|
|
2731
3035
|
* <p>The identifier of the user.</p>
|
|
2732
3036
|
*/
|
|
2733
3037
|
UserId: string | undefined;
|
|
2734
3038
|
/**
|
|
3039
|
+
* @public
|
|
2735
3040
|
* <p>The name of the application to launch after the session starts. This is the name that you specified
|
|
2736
3041
|
* as <b>Name</b> in the Image Assistant. If your fleet is enabled for the <b>Desktop</b> stream view, you can also choose to launch directly to the operating system desktop. To do so, specify <b>Desktop</b>.</p>
|
|
2737
3042
|
*/
|
|
2738
3043
|
ApplicationId?: string;
|
|
2739
3044
|
/**
|
|
3045
|
+
* @public
|
|
2740
3046
|
* <p>The time that the streaming URL will be valid, in seconds.
|
|
2741
3047
|
* Specify a value between 1 and 604800 seconds. The default is 60 seconds.</p>
|
|
2742
3048
|
*/
|
|
2743
3049
|
Validity?: number;
|
|
2744
3050
|
/**
|
|
3051
|
+
* @public
|
|
2745
3052
|
* <p>The session context. For more information, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/managing-stacks-fleets.html#managing-stacks-fleets-parameters">Session Context</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>
|
|
2746
3053
|
*/
|
|
2747
3054
|
SessionContext?: string;
|
|
@@ -2751,10 +3058,12 @@ export interface CreateStreamingURLRequest {
|
|
|
2751
3058
|
*/
|
|
2752
3059
|
export interface CreateStreamingURLResult {
|
|
2753
3060
|
/**
|
|
3061
|
+
* @public
|
|
2754
3062
|
* <p>The URL to start the AppStream 2.0 streaming session.</p>
|
|
2755
3063
|
*/
|
|
2756
3064
|
StreamingURL?: string;
|
|
2757
3065
|
/**
|
|
3066
|
+
* @public
|
|
2758
3067
|
* <p>The elapsed time, in seconds after the Unix epoch, when this URL expires.</p>
|
|
2759
3068
|
*/
|
|
2760
3069
|
Expires?: Date;
|
|
@@ -2764,22 +3073,27 @@ export interface CreateStreamingURLResult {
|
|
|
2764
3073
|
*/
|
|
2765
3074
|
export interface CreateUpdatedImageRequest {
|
|
2766
3075
|
/**
|
|
3076
|
+
* @public
|
|
2767
3077
|
* <p>The name of the image to update.</p>
|
|
2768
3078
|
*/
|
|
2769
3079
|
existingImageName: string | undefined;
|
|
2770
3080
|
/**
|
|
3081
|
+
* @public
|
|
2771
3082
|
* <p>The name of the new image. The name must be unique within the AWS account and Region.</p>
|
|
2772
3083
|
*/
|
|
2773
3084
|
newImageName: string | undefined;
|
|
2774
3085
|
/**
|
|
3086
|
+
* @public
|
|
2775
3087
|
* <p>The description to display for the new image.</p>
|
|
2776
3088
|
*/
|
|
2777
3089
|
newImageDescription?: string;
|
|
2778
3090
|
/**
|
|
3091
|
+
* @public
|
|
2779
3092
|
* <p>The name to display for the new image.</p>
|
|
2780
3093
|
*/
|
|
2781
3094
|
newImageDisplayName?: string;
|
|
2782
3095
|
/**
|
|
3096
|
+
* @public
|
|
2783
3097
|
* <p>The tags to associate with the new image. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. </p>
|
|
2784
3098
|
* <p>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: </p>
|
|
2785
3099
|
* <p>_ . : / = + \ - @</p>
|
|
@@ -2788,6 +3102,7 @@ export interface CreateUpdatedImageRequest {
|
|
|
2788
3102
|
*/
|
|
2789
3103
|
newImageTags?: Record<string, string>;
|
|
2790
3104
|
/**
|
|
3105
|
+
* @public
|
|
2791
3106
|
* <p>Indicates whether to display the status of image update availability before AppStream 2.0 initiates the process of creating a new updated image. If this value is set to <code>true</code>, AppStream 2.0 displays whether image updates are available. If this value is set to <code>false</code>, AppStream 2.0 initiates the process of creating a new updated image without displaying whether image updates are available.</p>
|
|
2792
3107
|
*/
|
|
2793
3108
|
dryRun?: boolean;
|
|
@@ -2798,10 +3113,12 @@ export interface CreateUpdatedImageRequest {
|
|
|
2798
3113
|
*/
|
|
2799
3114
|
export interface ImagePermissions {
|
|
2800
3115
|
/**
|
|
3116
|
+
* @public
|
|
2801
3117
|
* <p>Indicates whether the image can be used for a fleet.</p>
|
|
2802
3118
|
*/
|
|
2803
3119
|
allowFleet?: boolean;
|
|
2804
3120
|
/**
|
|
3121
|
+
* @public
|
|
2805
3122
|
* <p>Indicates whether the image can be used for an image builder.</p>
|
|
2806
3123
|
*/
|
|
2807
3124
|
allowImageBuilder?: boolean;
|
|
@@ -2842,10 +3159,12 @@ export type ImageStateChangeReasonCode = (typeof ImageStateChangeReasonCode)[key
|
|
|
2842
3159
|
*/
|
|
2843
3160
|
export interface ImageStateChangeReason {
|
|
2844
3161
|
/**
|
|
3162
|
+
* @public
|
|
2845
3163
|
* <p>The state change reason code.</p>
|
|
2846
3164
|
*/
|
|
2847
3165
|
Code?: ImageStateChangeReasonCode | string;
|
|
2848
3166
|
/**
|
|
3167
|
+
* @public
|
|
2849
3168
|
* <p>The state change reason message.</p>
|
|
2850
3169
|
*/
|
|
2851
3170
|
Message?: string;
|
|
@@ -2869,72 +3188,89 @@ export type VisibilityType = (typeof VisibilityType)[keyof typeof VisibilityType
|
|
|
2869
3188
|
*/
|
|
2870
3189
|
export interface Image {
|
|
2871
3190
|
/**
|
|
3191
|
+
* @public
|
|
2872
3192
|
* <p>The name of the image.</p>
|
|
2873
3193
|
*/
|
|
2874
3194
|
Name: string | undefined;
|
|
2875
3195
|
/**
|
|
3196
|
+
* @public
|
|
2876
3197
|
* <p>The ARN of the image.</p>
|
|
2877
3198
|
*/
|
|
2878
3199
|
Arn?: string;
|
|
2879
3200
|
/**
|
|
3201
|
+
* @public
|
|
2880
3202
|
* <p>The ARN of the image from which this image was created.</p>
|
|
2881
3203
|
*/
|
|
2882
3204
|
BaseImageArn?: string;
|
|
2883
3205
|
/**
|
|
3206
|
+
* @public
|
|
2884
3207
|
* <p>The image name to display.</p>
|
|
2885
3208
|
*/
|
|
2886
3209
|
DisplayName?: string;
|
|
2887
3210
|
/**
|
|
3211
|
+
* @public
|
|
2888
3212
|
* <p>The image starts in the <code>PENDING</code> state. If image creation succeeds, the
|
|
2889
3213
|
* state is <code>AVAILABLE</code>. If image creation fails, the state is <code>FAILED</code>.</p>
|
|
2890
3214
|
*/
|
|
2891
3215
|
State?: ImageState | string;
|
|
2892
3216
|
/**
|
|
3217
|
+
* @public
|
|
2893
3218
|
* <p>Indicates whether the image is public or private.</p>
|
|
2894
3219
|
*/
|
|
2895
3220
|
Visibility?: VisibilityType | string;
|
|
2896
3221
|
/**
|
|
3222
|
+
* @public
|
|
2897
3223
|
* <p>Indicates whether an image builder can be launched from this image.</p>
|
|
2898
3224
|
*/
|
|
2899
3225
|
ImageBuilderSupported?: boolean;
|
|
2900
3226
|
/**
|
|
3227
|
+
* @public
|
|
2901
3228
|
* <p>The name of the image builder that was used to create the private image. If the image is shared, this value is null.</p>
|
|
2902
3229
|
*/
|
|
2903
3230
|
ImageBuilderName?: string;
|
|
2904
3231
|
/**
|
|
3232
|
+
* @public
|
|
2905
3233
|
* <p>The operating system platform of the image.</p>
|
|
2906
3234
|
*/
|
|
2907
3235
|
Platform?: PlatformType | string;
|
|
2908
3236
|
/**
|
|
3237
|
+
* @public
|
|
2909
3238
|
* <p>The description to display.</p>
|
|
2910
3239
|
*/
|
|
2911
3240
|
Description?: string;
|
|
2912
3241
|
/**
|
|
3242
|
+
* @public
|
|
2913
3243
|
* <p>The reason why the last state change occurred.</p>
|
|
2914
3244
|
*/
|
|
2915
3245
|
StateChangeReason?: ImageStateChangeReason;
|
|
2916
3246
|
/**
|
|
3247
|
+
* @public
|
|
2917
3248
|
* <p>The applications associated with the image.</p>
|
|
2918
3249
|
*/
|
|
2919
3250
|
Applications?: Application[];
|
|
2920
3251
|
/**
|
|
3252
|
+
* @public
|
|
2921
3253
|
* <p>The time the image was created.</p>
|
|
2922
3254
|
*/
|
|
2923
3255
|
CreatedTime?: Date;
|
|
2924
3256
|
/**
|
|
3257
|
+
* @public
|
|
2925
3258
|
* <p>The release date of the public base image.
|
|
2926
3259
|
* For private images, this date is the release date of the base image from which the image was created.</p>
|
|
2927
3260
|
*/
|
|
2928
3261
|
PublicBaseImageReleasedDate?: Date;
|
|
2929
3262
|
/**
|
|
3263
|
+
* @public
|
|
2930
3264
|
* <p>The version of the AppStream 2.0 agent to use for instances that are launched from this image. </p>
|
|
2931
3265
|
*/
|
|
2932
3266
|
AppstreamAgentVersion?: string;
|
|
2933
3267
|
/**
|
|
3268
|
+
* @public
|
|
2934
3269
|
* <p>The permissions to provide to the destination AWS account for the specified image.</p>
|
|
2935
3270
|
*/
|
|
2936
3271
|
ImagePermissions?: ImagePermissions;
|
|
2937
3272
|
/**
|
|
3273
|
+
* @public
|
|
2938
3274
|
* <p>Describes the errors that are returned when a new image can't be created.</p>
|
|
2939
3275
|
*/
|
|
2940
3276
|
ImageErrors?: ResourceError[];
|
|
@@ -2944,10 +3280,12 @@ export interface Image {
|
|
|
2944
3280
|
*/
|
|
2945
3281
|
export interface CreateUpdatedImageResult {
|
|
2946
3282
|
/**
|
|
3283
|
+
* @public
|
|
2947
3284
|
* <p>Describes an image.</p>
|
|
2948
3285
|
*/
|
|
2949
3286
|
image?: Image;
|
|
2950
3287
|
/**
|
|
3288
|
+
* @public
|
|
2951
3289
|
* <p>Indicates whether a new image can be created.</p>
|
|
2952
3290
|
*/
|
|
2953
3291
|
canUpdateImage?: boolean;
|
|
@@ -2973,6 +3311,7 @@ export type UsageReportSchedule = (typeof UsageReportSchedule)[keyof typeof Usag
|
|
|
2973
3311
|
*/
|
|
2974
3312
|
export interface CreateUsageReportSubscriptionResult {
|
|
2975
3313
|
/**
|
|
3314
|
+
* @public
|
|
2976
3315
|
* <p>The Amazon S3 bucket where generated reports are stored.</p>
|
|
2977
3316
|
* <p>If you enabled on-instance session scripts and Amazon S3 logging for your session script
|
|
2978
3317
|
* configuration, AppStream 2.0 created an S3 bucket to store the script output. The bucket is
|
|
@@ -2982,6 +3321,7 @@ export interface CreateUsageReportSubscriptionResult {
|
|
|
2982
3321
|
*/
|
|
2983
3322
|
S3BucketName?: string;
|
|
2984
3323
|
/**
|
|
3324
|
+
* @public
|
|
2985
3325
|
* <p>The schedule for generating usage reports.</p>
|
|
2986
3326
|
*/
|
|
2987
3327
|
Schedule?: UsageReportSchedule | string;
|
|
@@ -3003,6 +3343,7 @@ export type MessageAction = (typeof MessageAction)[keyof typeof MessageAction];
|
|
|
3003
3343
|
*/
|
|
3004
3344
|
export interface CreateUserRequest {
|
|
3005
3345
|
/**
|
|
3346
|
+
* @public
|
|
3006
3347
|
* <p>The email address of the user.</p>
|
|
3007
3348
|
* <note>
|
|
3008
3349
|
* <p>Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.</p>
|
|
@@ -3010,6 +3351,7 @@ export interface CreateUserRequest {
|
|
|
3010
3351
|
*/
|
|
3011
3352
|
UserName: string | undefined;
|
|
3012
3353
|
/**
|
|
3354
|
+
* @public
|
|
3013
3355
|
* <p>The action to take for the welcome email that is sent to a user after the user is created in the user pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent. </p>
|
|
3014
3356
|
* <note>
|
|
3015
3357
|
* <p>The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.</p>
|
|
@@ -3017,14 +3359,17 @@ export interface CreateUserRequest {
|
|
|
3017
3359
|
*/
|
|
3018
3360
|
MessageAction?: MessageAction | string;
|
|
3019
3361
|
/**
|
|
3362
|
+
* @public
|
|
3020
3363
|
* <p>The first name, or given name, of the user.</p>
|
|
3021
3364
|
*/
|
|
3022
3365
|
FirstName?: string;
|
|
3023
3366
|
/**
|
|
3367
|
+
* @public
|
|
3024
3368
|
* <p>The last name, or surname, of the user.</p>
|
|
3025
3369
|
*/
|
|
3026
3370
|
LastName?: string;
|
|
3027
3371
|
/**
|
|
3372
|
+
* @public
|
|
3028
3373
|
* <p>The authentication type for the user. You must specify USERPOOL. </p>
|
|
3029
3374
|
*/
|
|
3030
3375
|
AuthenticationType: AuthenticationType | string | undefined;
|
|
@@ -3039,6 +3384,7 @@ export interface CreateUserResult {
|
|
|
3039
3384
|
*/
|
|
3040
3385
|
export interface DeleteAppBlockRequest {
|
|
3041
3386
|
/**
|
|
3387
|
+
* @public
|
|
3042
3388
|
* <p>The name of the app block.</p>
|
|
3043
3389
|
*/
|
|
3044
3390
|
Name: string | undefined;
|
|
@@ -3056,6 +3402,7 @@ export declare class ResourceInUseException extends __BaseException {
|
|
|
3056
3402
|
readonly name: "ResourceInUseException";
|
|
3057
3403
|
readonly $fault: "client";
|
|
3058
3404
|
/**
|
|
3405
|
+
* @public
|
|
3059
3406
|
* <p>The error message in the exception.</p>
|
|
3060
3407
|
*/
|
|
3061
3408
|
Message?: string;
|
|
@@ -3069,6 +3416,7 @@ export declare class ResourceInUseException extends __BaseException {
|
|
|
3069
3416
|
*/
|
|
3070
3417
|
export interface DeleteAppBlockBuilderRequest {
|
|
3071
3418
|
/**
|
|
3419
|
+
* @public
|
|
3072
3420
|
* <p>The name of the app block builder.</p>
|
|
3073
3421
|
*/
|
|
3074
3422
|
Name: string | undefined;
|
|
@@ -3083,6 +3431,7 @@ export interface DeleteAppBlockBuilderResult {
|
|
|
3083
3431
|
*/
|
|
3084
3432
|
export interface DeleteApplicationRequest {
|
|
3085
3433
|
/**
|
|
3434
|
+
* @public
|
|
3086
3435
|
* <p>The name of the application.</p>
|
|
3087
3436
|
*/
|
|
3088
3437
|
Name: string | undefined;
|
|
@@ -3097,6 +3446,7 @@ export interface DeleteApplicationResult {
|
|
|
3097
3446
|
*/
|
|
3098
3447
|
export interface DeleteDirectoryConfigRequest {
|
|
3099
3448
|
/**
|
|
3449
|
+
* @public
|
|
3100
3450
|
* <p>The name of the directory configuration.</p>
|
|
3101
3451
|
*/
|
|
3102
3452
|
DirectoryName: string | undefined;
|
|
@@ -3111,10 +3461,12 @@ export interface DeleteDirectoryConfigResult {
|
|
|
3111
3461
|
*/
|
|
3112
3462
|
export interface DeleteEntitlementRequest {
|
|
3113
3463
|
/**
|
|
3464
|
+
* @public
|
|
3114
3465
|
* <p>The name of the entitlement.</p>
|
|
3115
3466
|
*/
|
|
3116
3467
|
Name: string | undefined;
|
|
3117
3468
|
/**
|
|
3469
|
+
* @public
|
|
3118
3470
|
* <p>The name of the stack with which the entitlement is associated.</p>
|
|
3119
3471
|
*/
|
|
3120
3472
|
StackName: string | undefined;
|
|
@@ -3129,6 +3481,7 @@ export interface DeleteEntitlementResult {
|
|
|
3129
3481
|
*/
|
|
3130
3482
|
export interface DeleteFleetRequest {
|
|
3131
3483
|
/**
|
|
3484
|
+
* @public
|
|
3132
3485
|
* <p>The name of the fleet.</p>
|
|
3133
3486
|
*/
|
|
3134
3487
|
Name: string | undefined;
|
|
@@ -3143,6 +3496,7 @@ export interface DeleteFleetResult {
|
|
|
3143
3496
|
*/
|
|
3144
3497
|
export interface DeleteImageRequest {
|
|
3145
3498
|
/**
|
|
3499
|
+
* @public
|
|
3146
3500
|
* <p>The name of the image.</p>
|
|
3147
3501
|
*/
|
|
3148
3502
|
Name: string | undefined;
|
|
@@ -3152,6 +3506,7 @@ export interface DeleteImageRequest {
|
|
|
3152
3506
|
*/
|
|
3153
3507
|
export interface DeleteImageResult {
|
|
3154
3508
|
/**
|
|
3509
|
+
* @public
|
|
3155
3510
|
* <p>Information about the image.</p>
|
|
3156
3511
|
*/
|
|
3157
3512
|
Image?: Image;
|
|
@@ -3161,6 +3516,7 @@ export interface DeleteImageResult {
|
|
|
3161
3516
|
*/
|
|
3162
3517
|
export interface DeleteImageBuilderRequest {
|
|
3163
3518
|
/**
|
|
3519
|
+
* @public
|
|
3164
3520
|
* <p>The name of the image builder.</p>
|
|
3165
3521
|
*/
|
|
3166
3522
|
Name: string | undefined;
|
|
@@ -3170,6 +3526,7 @@ export interface DeleteImageBuilderRequest {
|
|
|
3170
3526
|
*/
|
|
3171
3527
|
export interface DeleteImageBuilderResult {
|
|
3172
3528
|
/**
|
|
3529
|
+
* @public
|
|
3173
3530
|
* <p>Information about the image builder.</p>
|
|
3174
3531
|
*/
|
|
3175
3532
|
ImageBuilder?: ImageBuilder;
|
|
@@ -3179,10 +3536,12 @@ export interface DeleteImageBuilderResult {
|
|
|
3179
3536
|
*/
|
|
3180
3537
|
export interface DeleteImagePermissionsRequest {
|
|
3181
3538
|
/**
|
|
3539
|
+
* @public
|
|
3182
3540
|
* <p>The name of the private image.</p>
|
|
3183
3541
|
*/
|
|
3184
3542
|
Name: string | undefined;
|
|
3185
3543
|
/**
|
|
3544
|
+
* @public
|
|
3186
3545
|
* <p>The 12-digit identifier of the AWS account for which to delete image permissions.</p>
|
|
3187
3546
|
*/
|
|
3188
3547
|
SharedAccountId: string | undefined;
|
|
@@ -3197,6 +3556,7 @@ export interface DeleteImagePermissionsResult {
|
|
|
3197
3556
|
*/
|
|
3198
3557
|
export interface DeleteStackRequest {
|
|
3199
3558
|
/**
|
|
3559
|
+
* @public
|
|
3200
3560
|
* <p>The name of the stack.</p>
|
|
3201
3561
|
*/
|
|
3202
3562
|
Name: string | undefined;
|
|
@@ -3221,6 +3581,7 @@ export interface DeleteUsageReportSubscriptionResult {
|
|
|
3221
3581
|
*/
|
|
3222
3582
|
export interface DeleteUserRequest {
|
|
3223
3583
|
/**
|
|
3584
|
+
* @public
|
|
3224
3585
|
* <p>The email address of the user.</p>
|
|
3225
3586
|
* <note>
|
|
3226
3587
|
* <p>Users' email addresses are case-sensitive.</p>
|
|
@@ -3228,6 +3589,7 @@ export interface DeleteUserRequest {
|
|
|
3228
3589
|
*/
|
|
3229
3590
|
UserName: string | undefined;
|
|
3230
3591
|
/**
|
|
3592
|
+
* @public
|
|
3231
3593
|
* <p>The authentication type for the user. You must specify USERPOOL.</p>
|
|
3232
3594
|
*/
|
|
3233
3595
|
AuthenticationType: AuthenticationType | string | undefined;
|
|
@@ -3242,18 +3604,22 @@ export interface DeleteUserResult {
|
|
|
3242
3604
|
*/
|
|
3243
3605
|
export interface DescribeAppBlockBuilderAppBlockAssociationsRequest {
|
|
3244
3606
|
/**
|
|
3607
|
+
* @public
|
|
3245
3608
|
* <p>The ARN of the app block.</p>
|
|
3246
3609
|
*/
|
|
3247
3610
|
AppBlockArn?: string;
|
|
3248
3611
|
/**
|
|
3612
|
+
* @public
|
|
3249
3613
|
* <p>The name of the app block builder.</p>
|
|
3250
3614
|
*/
|
|
3251
3615
|
AppBlockBuilderName?: string;
|
|
3252
3616
|
/**
|
|
3617
|
+
* @public
|
|
3253
3618
|
* <p>The maximum size of each page of results.</p>
|
|
3254
3619
|
*/
|
|
3255
3620
|
MaxResults?: number;
|
|
3256
3621
|
/**
|
|
3622
|
+
* @public
|
|
3257
3623
|
* <p>The pagination token used to retrieve the next page of results for this
|
|
3258
3624
|
* operation.</p>
|
|
3259
3625
|
*/
|
|
@@ -3264,10 +3630,12 @@ export interface DescribeAppBlockBuilderAppBlockAssociationsRequest {
|
|
|
3264
3630
|
*/
|
|
3265
3631
|
export interface DescribeAppBlockBuilderAppBlockAssociationsResult {
|
|
3266
3632
|
/**
|
|
3633
|
+
* @public
|
|
3267
3634
|
* <p>This list of app block builders associated with app blocks.</p>
|
|
3268
3635
|
*/
|
|
3269
3636
|
AppBlockBuilderAppBlockAssociations?: AppBlockBuilderAppBlockAssociation[];
|
|
3270
3637
|
/**
|
|
3638
|
+
* @public
|
|
3271
3639
|
* <p>The pagination token used to retrieve the next page of results for this
|
|
3272
3640
|
* operation.</p>
|
|
3273
3641
|
*/
|
|
@@ -3278,15 +3646,18 @@ export interface DescribeAppBlockBuilderAppBlockAssociationsResult {
|
|
|
3278
3646
|
*/
|
|
3279
3647
|
export interface DescribeAppBlockBuildersRequest {
|
|
3280
3648
|
/**
|
|
3649
|
+
* @public
|
|
3281
3650
|
* <p>The names of the app block builders.</p>
|
|
3282
3651
|
*/
|
|
3283
3652
|
Names?: string[];
|
|
3284
3653
|
/**
|
|
3654
|
+
* @public
|
|
3285
3655
|
* <p>The pagination token used to retrieve the next page of results for this
|
|
3286
3656
|
* operation.</p>
|
|
3287
3657
|
*/
|
|
3288
3658
|
NextToken?: string;
|
|
3289
3659
|
/**
|
|
3660
|
+
* @public
|
|
3290
3661
|
* <p>The maximum size of each page of results. The maximum value is 25.</p>
|
|
3291
3662
|
*/
|
|
3292
3663
|
MaxResults?: number;
|
|
@@ -3296,10 +3667,12 @@ export interface DescribeAppBlockBuildersRequest {
|
|
|
3296
3667
|
*/
|
|
3297
3668
|
export interface DescribeAppBlockBuildersResult {
|
|
3298
3669
|
/**
|
|
3670
|
+
* @public
|
|
3299
3671
|
* <p>The list that describes one or more app block builders.</p>
|
|
3300
3672
|
*/
|
|
3301
3673
|
AppBlockBuilders?: AppBlockBuilder[];
|
|
3302
3674
|
/**
|
|
3675
|
+
* @public
|
|
3303
3676
|
* <p>The pagination token used to retrieve the next page of results for this
|
|
3304
3677
|
* operation.</p>
|
|
3305
3678
|
*/
|
|
@@ -3310,15 +3683,18 @@ export interface DescribeAppBlockBuildersResult {
|
|
|
3310
3683
|
*/
|
|
3311
3684
|
export interface DescribeAppBlocksRequest {
|
|
3312
3685
|
/**
|
|
3686
|
+
* @public
|
|
3313
3687
|
* <p>The ARNs of the app blocks.</p>
|
|
3314
3688
|
*/
|
|
3315
3689
|
Arns?: string[];
|
|
3316
3690
|
/**
|
|
3691
|
+
* @public
|
|
3317
3692
|
* <p>The pagination token used to retrieve the next page of results for this
|
|
3318
3693
|
* operation.</p>
|
|
3319
3694
|
*/
|
|
3320
3695
|
NextToken?: string;
|
|
3321
3696
|
/**
|
|
3697
|
+
* @public
|
|
3322
3698
|
* <p>The maximum size of each page of results.</p>
|
|
3323
3699
|
*/
|
|
3324
3700
|
MaxResults?: number;
|
|
@@ -3328,10 +3704,12 @@ export interface DescribeAppBlocksRequest {
|
|
|
3328
3704
|
*/
|
|
3329
3705
|
export interface DescribeAppBlocksResult {
|
|
3330
3706
|
/**
|
|
3707
|
+
* @public
|
|
3331
3708
|
* <p>The app blocks in the list.</p>
|
|
3332
3709
|
*/
|
|
3333
3710
|
AppBlocks?: AppBlock[];
|
|
3334
3711
|
/**
|
|
3712
|
+
* @public
|
|
3335
3713
|
* <p>The pagination token used to retrieve the next page of results for this
|
|
3336
3714
|
* operation.</p>
|
|
3337
3715
|
*/
|
|
@@ -3342,18 +3720,22 @@ export interface DescribeAppBlocksResult {
|
|
|
3342
3720
|
*/
|
|
3343
3721
|
export interface DescribeApplicationFleetAssociationsRequest {
|
|
3344
3722
|
/**
|
|
3723
|
+
* @public
|
|
3345
3724
|
* <p>The name of the fleet.</p>
|
|
3346
3725
|
*/
|
|
3347
3726
|
FleetName?: string;
|
|
3348
3727
|
/**
|
|
3728
|
+
* @public
|
|
3349
3729
|
* <p>The ARN of the application.</p>
|
|
3350
3730
|
*/
|
|
3351
3731
|
ApplicationArn?: string;
|
|
3352
3732
|
/**
|
|
3733
|
+
* @public
|
|
3353
3734
|
* <p>The maximum size of each page of results.</p>
|
|
3354
3735
|
*/
|
|
3355
3736
|
MaxResults?: number;
|
|
3356
3737
|
/**
|
|
3738
|
+
* @public
|
|
3357
3739
|
* <p>The pagination token used to retrieve the next page of results for this
|
|
3358
3740
|
* operation.</p>
|
|
3359
3741
|
*/
|
|
@@ -3364,10 +3746,12 @@ export interface DescribeApplicationFleetAssociationsRequest {
|
|
|
3364
3746
|
*/
|
|
3365
3747
|
export interface DescribeApplicationFleetAssociationsResult {
|
|
3366
3748
|
/**
|
|
3749
|
+
* @public
|
|
3367
3750
|
* <p>The application fleet associations in the list.</p>
|
|
3368
3751
|
*/
|
|
3369
3752
|
ApplicationFleetAssociations?: ApplicationFleetAssociation[];
|
|
3370
3753
|
/**
|
|
3754
|
+
* @public
|
|
3371
3755
|
* <p>The pagination token used to retrieve the next page of results for this
|
|
3372
3756
|
* operation.</p>
|
|
3373
3757
|
*/
|
|
@@ -3378,15 +3762,18 @@ export interface DescribeApplicationFleetAssociationsResult {
|
|
|
3378
3762
|
*/
|
|
3379
3763
|
export interface DescribeApplicationsRequest {
|
|
3380
3764
|
/**
|
|
3765
|
+
* @public
|
|
3381
3766
|
* <p>The ARNs for the applications.</p>
|
|
3382
3767
|
*/
|
|
3383
3768
|
Arns?: string[];
|
|
3384
3769
|
/**
|
|
3770
|
+
* @public
|
|
3385
3771
|
* <p>The pagination token used to retrieve the next page of results for this
|
|
3386
3772
|
* operation.</p>
|
|
3387
3773
|
*/
|
|
3388
3774
|
NextToken?: string;
|
|
3389
3775
|
/**
|
|
3776
|
+
* @public
|
|
3390
3777
|
* <p>The maximum size of each page of results.</p>
|
|
3391
3778
|
*/
|
|
3392
3779
|
MaxResults?: number;
|
|
@@ -3396,10 +3783,12 @@ export interface DescribeApplicationsRequest {
|
|
|
3396
3783
|
*/
|
|
3397
3784
|
export interface DescribeApplicationsResult {
|
|
3398
3785
|
/**
|
|
3786
|
+
* @public
|
|
3399
3787
|
* <p>The applications in the list.</p>
|
|
3400
3788
|
*/
|
|
3401
3789
|
Applications?: Application[];
|
|
3402
3790
|
/**
|
|
3791
|
+
* @public
|
|
3403
3792
|
* <p>The pagination token used to retrieve the next page of results for this
|
|
3404
3793
|
* operation.</p>
|
|
3405
3794
|
*/
|
|
@@ -3410,14 +3799,17 @@ export interface DescribeApplicationsResult {
|
|
|
3410
3799
|
*/
|
|
3411
3800
|
export interface DescribeDirectoryConfigsRequest {
|
|
3412
3801
|
/**
|
|
3802
|
+
* @public
|
|
3413
3803
|
* <p>The directory names.</p>
|
|
3414
3804
|
*/
|
|
3415
3805
|
DirectoryNames?: string[];
|
|
3416
3806
|
/**
|
|
3807
|
+
* @public
|
|
3417
3808
|
* <p>The maximum size of each page of results.</p>
|
|
3418
3809
|
*/
|
|
3419
3810
|
MaxResults?: number;
|
|
3420
3811
|
/**
|
|
3812
|
+
* @public
|
|
3421
3813
|
* <p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>
|
|
3422
3814
|
*/
|
|
3423
3815
|
NextToken?: string;
|
|
@@ -3427,10 +3819,12 @@ export interface DescribeDirectoryConfigsRequest {
|
|
|
3427
3819
|
*/
|
|
3428
3820
|
export interface DescribeDirectoryConfigsResult {
|
|
3429
3821
|
/**
|
|
3822
|
+
* @public
|
|
3430
3823
|
* <p>Information about the directory configurations. Note that although the response syntax in this topic includes the account password, this password is not returned in the actual response. </p>
|
|
3431
3824
|
*/
|
|
3432
3825
|
DirectoryConfigs?: DirectoryConfig[];
|
|
3433
3826
|
/**
|
|
3827
|
+
* @public
|
|
3434
3828
|
* <p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>
|
|
3435
3829
|
*/
|
|
3436
3830
|
NextToken?: string;
|
|
@@ -3440,18 +3834,22 @@ export interface DescribeDirectoryConfigsResult {
|
|
|
3440
3834
|
*/
|
|
3441
3835
|
export interface DescribeEntitlementsRequest {
|
|
3442
3836
|
/**
|
|
3837
|
+
* @public
|
|
3443
3838
|
* <p>The name of the entitlement.</p>
|
|
3444
3839
|
*/
|
|
3445
3840
|
Name?: string;
|
|
3446
3841
|
/**
|
|
3842
|
+
* @public
|
|
3447
3843
|
* <p>The name of the stack with which the entitlement is associated.</p>
|
|
3448
3844
|
*/
|
|
3449
3845
|
StackName: string | undefined;
|
|
3450
3846
|
/**
|
|
3847
|
+
* @public
|
|
3451
3848
|
* <p>The pagination token used to retrieve the next page of results for this operation.</p>
|
|
3452
3849
|
*/
|
|
3453
3850
|
NextToken?: string;
|
|
3454
3851
|
/**
|
|
3852
|
+
* @public
|
|
3455
3853
|
* <p>The maximum size of each page of results.</p>
|
|
3456
3854
|
*/
|
|
3457
3855
|
MaxResults?: number;
|
|
@@ -3461,10 +3859,12 @@ export interface DescribeEntitlementsRequest {
|
|
|
3461
3859
|
*/
|
|
3462
3860
|
export interface DescribeEntitlementsResult {
|
|
3463
3861
|
/**
|
|
3862
|
+
* @public
|
|
3464
3863
|
* <p>The entitlements.</p>
|
|
3465
3864
|
*/
|
|
3466
3865
|
Entitlements?: Entitlement[];
|
|
3467
3866
|
/**
|
|
3867
|
+
* @public
|
|
3468
3868
|
* <p>The pagination token used to retrieve the next page of results for this
|
|
3469
3869
|
* operation.</p>
|
|
3470
3870
|
*/
|
|
@@ -3475,10 +3875,12 @@ export interface DescribeEntitlementsResult {
|
|
|
3475
3875
|
*/
|
|
3476
3876
|
export interface DescribeFleetsRequest {
|
|
3477
3877
|
/**
|
|
3878
|
+
* @public
|
|
3478
3879
|
* <p>The names of the fleets to describe.</p>
|
|
3479
3880
|
*/
|
|
3480
3881
|
Names?: string[];
|
|
3481
3882
|
/**
|
|
3883
|
+
* @public
|
|
3482
3884
|
* <p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>
|
|
3483
3885
|
*/
|
|
3484
3886
|
NextToken?: string;
|
|
@@ -3488,10 +3890,12 @@ export interface DescribeFleetsRequest {
|
|
|
3488
3890
|
*/
|
|
3489
3891
|
export interface DescribeFleetsResult {
|
|
3490
3892
|
/**
|
|
3893
|
+
* @public
|
|
3491
3894
|
* <p>Information about the fleets.</p>
|
|
3492
3895
|
*/
|
|
3493
3896
|
Fleets?: Fleet[];
|
|
3494
3897
|
/**
|
|
3898
|
+
* @public
|
|
3495
3899
|
* <p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>
|
|
3496
3900
|
*/
|
|
3497
3901
|
NextToken?: string;
|
|
@@ -3501,14 +3905,17 @@ export interface DescribeFleetsResult {
|
|
|
3501
3905
|
*/
|
|
3502
3906
|
export interface DescribeImageBuildersRequest {
|
|
3503
3907
|
/**
|
|
3908
|
+
* @public
|
|
3504
3909
|
* <p>The names of the image builders to describe.</p>
|
|
3505
3910
|
*/
|
|
3506
3911
|
Names?: string[];
|
|
3507
3912
|
/**
|
|
3913
|
+
* @public
|
|
3508
3914
|
* <p>The maximum size of each page of results.</p>
|
|
3509
3915
|
*/
|
|
3510
3916
|
MaxResults?: number;
|
|
3511
3917
|
/**
|
|
3918
|
+
* @public
|
|
3512
3919
|
* <p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>
|
|
3513
3920
|
*/
|
|
3514
3921
|
NextToken?: string;
|
|
@@ -3518,10 +3925,12 @@ export interface DescribeImageBuildersRequest {
|
|
|
3518
3925
|
*/
|
|
3519
3926
|
export interface DescribeImageBuildersResult {
|
|
3520
3927
|
/**
|
|
3928
|
+
* @public
|
|
3521
3929
|
* <p>Information about the image builders.</p>
|
|
3522
3930
|
*/
|
|
3523
3931
|
ImageBuilders?: ImageBuilder[];
|
|
3524
3932
|
/**
|
|
3933
|
+
* @public
|
|
3525
3934
|
* <p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>
|
|
3526
3935
|
*/
|
|
3527
3936
|
NextToken?: string;
|
|
@@ -3531,18 +3940,22 @@ export interface DescribeImageBuildersResult {
|
|
|
3531
3940
|
*/
|
|
3532
3941
|
export interface DescribeImagePermissionsRequest {
|
|
3533
3942
|
/**
|
|
3943
|
+
* @public
|
|
3534
3944
|
* <p>The name of the private image for which to describe permissions. The image must be one that you own. </p>
|
|
3535
3945
|
*/
|
|
3536
3946
|
Name: string | undefined;
|
|
3537
3947
|
/**
|
|
3948
|
+
* @public
|
|
3538
3949
|
* <p>The maximum size of each page of results.</p>
|
|
3539
3950
|
*/
|
|
3540
3951
|
MaxResults?: number;
|
|
3541
3952
|
/**
|
|
3953
|
+
* @public
|
|
3542
3954
|
* <p>The 12-digit identifier of one or more AWS accounts with which the image is shared.</p>
|
|
3543
3955
|
*/
|
|
3544
3956
|
SharedAwsAccountIds?: string[];
|
|
3545
3957
|
/**
|
|
3958
|
+
* @public
|
|
3546
3959
|
* <p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>
|
|
3547
3960
|
*/
|
|
3548
3961
|
NextToken?: string;
|
|
@@ -3553,10 +3966,12 @@ export interface DescribeImagePermissionsRequest {
|
|
|
3553
3966
|
*/
|
|
3554
3967
|
export interface SharedImagePermissions {
|
|
3555
3968
|
/**
|
|
3969
|
+
* @public
|
|
3556
3970
|
* <p>The 12-digit identifier of the AWS account with which the image is shared.</p>
|
|
3557
3971
|
*/
|
|
3558
3972
|
sharedAccountId: string | undefined;
|
|
3559
3973
|
/**
|
|
3974
|
+
* @public
|
|
3560
3975
|
* <p>Describes the permissions for a shared image.</p>
|
|
3561
3976
|
*/
|
|
3562
3977
|
imagePermissions: ImagePermissions | undefined;
|
|
@@ -3566,14 +3981,17 @@ export interface SharedImagePermissions {
|
|
|
3566
3981
|
*/
|
|
3567
3982
|
export interface DescribeImagePermissionsResult {
|
|
3568
3983
|
/**
|
|
3984
|
+
* @public
|
|
3569
3985
|
* <p>The name of the private image.</p>
|
|
3570
3986
|
*/
|
|
3571
3987
|
Name?: string;
|
|
3572
3988
|
/**
|
|
3989
|
+
* @public
|
|
3573
3990
|
* <p>The permissions for a private image that you own. </p>
|
|
3574
3991
|
*/
|
|
3575
3992
|
SharedImagePermissionsList?: SharedImagePermissions[];
|
|
3576
3993
|
/**
|
|
3994
|
+
* @public
|
|
3577
3995
|
* <p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>
|
|
3578
3996
|
*/
|
|
3579
3997
|
NextToken?: string;
|
|
@@ -3583,22 +4001,27 @@ export interface DescribeImagePermissionsResult {
|
|
|
3583
4001
|
*/
|
|
3584
4002
|
export interface DescribeImagesRequest {
|
|
3585
4003
|
/**
|
|
4004
|
+
* @public
|
|
3586
4005
|
* <p>The names of the public or private images to describe.</p>
|
|
3587
4006
|
*/
|
|
3588
4007
|
Names?: string[];
|
|
3589
4008
|
/**
|
|
4009
|
+
* @public
|
|
3590
4010
|
* <p>The ARNs of the public, private, and shared images to describe.</p>
|
|
3591
4011
|
*/
|
|
3592
4012
|
Arns?: string[];
|
|
3593
4013
|
/**
|
|
4014
|
+
* @public
|
|
3594
4015
|
* <p>The type of image (public, private, or shared) to describe. </p>
|
|
3595
4016
|
*/
|
|
3596
4017
|
Type?: VisibilityType | string;
|
|
3597
4018
|
/**
|
|
4019
|
+
* @public
|
|
3598
4020
|
* <p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>
|
|
3599
4021
|
*/
|
|
3600
4022
|
NextToken?: string;
|
|
3601
4023
|
/**
|
|
4024
|
+
* @public
|
|
3602
4025
|
* <p>The maximum size of each page of results.</p>
|
|
3603
4026
|
*/
|
|
3604
4027
|
MaxResults?: number;
|
|
@@ -3608,10 +4031,12 @@ export interface DescribeImagesRequest {
|
|
|
3608
4031
|
*/
|
|
3609
4032
|
export interface DescribeImagesResult {
|
|
3610
4033
|
/**
|
|
4034
|
+
* @public
|
|
3611
4035
|
* <p>Information about the images.</p>
|
|
3612
4036
|
*/
|
|
3613
4037
|
Images?: Image[];
|
|
3614
4038
|
/**
|
|
4039
|
+
* @public
|
|
3615
4040
|
* <p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>
|
|
3616
4041
|
*/
|
|
3617
4042
|
NextToken?: string;
|
|
@@ -3621,26 +4046,32 @@ export interface DescribeImagesResult {
|
|
|
3621
4046
|
*/
|
|
3622
4047
|
export interface DescribeSessionsRequest {
|
|
3623
4048
|
/**
|
|
4049
|
+
* @public
|
|
3624
4050
|
* <p>The name of the stack. This value is case-sensitive.</p>
|
|
3625
4051
|
*/
|
|
3626
4052
|
StackName: string | undefined;
|
|
3627
4053
|
/**
|
|
4054
|
+
* @public
|
|
3628
4055
|
* <p>The name of the fleet. This value is case-sensitive.</p>
|
|
3629
4056
|
*/
|
|
3630
4057
|
FleetName: string | undefined;
|
|
3631
4058
|
/**
|
|
4059
|
+
* @public
|
|
3632
4060
|
* <p>The user identifier (ID). If you specify a user ID, you must also specify the authentication type.</p>
|
|
3633
4061
|
*/
|
|
3634
4062
|
UserId?: string;
|
|
3635
4063
|
/**
|
|
4064
|
+
* @public
|
|
3636
4065
|
* <p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>
|
|
3637
4066
|
*/
|
|
3638
4067
|
NextToken?: string;
|
|
3639
4068
|
/**
|
|
4069
|
+
* @public
|
|
3640
4070
|
* <p>The size of each page of results. The default value is 20 and the maximum value is 50.</p>
|
|
3641
4071
|
*/
|
|
3642
4072
|
Limit?: number;
|
|
3643
4073
|
/**
|
|
4074
|
+
* @public
|
|
3644
4075
|
* <p>The authentication method. Specify <code>API</code> for a user
|
|
3645
4076
|
* authenticated using a streaming URL or <code>SAML</code> for a SAML federated user.
|
|
3646
4077
|
* The default is to authenticate users using a streaming URL.</p>
|
|
@@ -3678,43 +4109,53 @@ export type SessionState = (typeof SessionState)[keyof typeof SessionState];
|
|
|
3678
4109
|
*/
|
|
3679
4110
|
export interface Session {
|
|
3680
4111
|
/**
|
|
4112
|
+
* @public
|
|
3681
4113
|
* <p>The identifier of the streaming session.</p>
|
|
3682
4114
|
*/
|
|
3683
4115
|
Id: string | undefined;
|
|
3684
4116
|
/**
|
|
4117
|
+
* @public
|
|
3685
4118
|
* <p>The identifier of the user for whom the session was created.</p>
|
|
3686
4119
|
*/
|
|
3687
4120
|
UserId: string | undefined;
|
|
3688
4121
|
/**
|
|
4122
|
+
* @public
|
|
3689
4123
|
* <p>The name of the stack for the streaming session.</p>
|
|
3690
4124
|
*/
|
|
3691
4125
|
StackName: string | undefined;
|
|
3692
4126
|
/**
|
|
4127
|
+
* @public
|
|
3693
4128
|
* <p>The name of the fleet for the streaming session.</p>
|
|
3694
4129
|
*/
|
|
3695
4130
|
FleetName: string | undefined;
|
|
3696
4131
|
/**
|
|
4132
|
+
* @public
|
|
3697
4133
|
* <p>The current state of the streaming session.</p>
|
|
3698
4134
|
*/
|
|
3699
4135
|
State: SessionState | string | undefined;
|
|
3700
4136
|
/**
|
|
4137
|
+
* @public
|
|
3701
4138
|
* <p>Specifies whether a user is connected to the streaming session.</p>
|
|
3702
4139
|
*/
|
|
3703
4140
|
ConnectionState?: SessionConnectionState | string;
|
|
3704
4141
|
/**
|
|
4142
|
+
* @public
|
|
3705
4143
|
* <p>The time when a streaming instance is dedicated for the user.</p>
|
|
3706
4144
|
*/
|
|
3707
4145
|
StartTime?: Date;
|
|
3708
4146
|
/**
|
|
4147
|
+
* @public
|
|
3709
4148
|
* <p>The time when the streaming session is set to expire. This time is based on the <code>MaxUserDurationinSeconds</code> value, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified in <code>SessionMaxExpirationTime</code>, when the <code>DisconnectTimeOutInSeconds</code> elapses or the user chooses to end his or her session. If the <code>DisconnectTimeOutInSeconds</code> elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.</p>
|
|
3710
4149
|
*/
|
|
3711
4150
|
MaxExpirationTime?: Date;
|
|
3712
4151
|
/**
|
|
4152
|
+
* @public
|
|
3713
4153
|
* <p>The authentication method. The user is authenticated using a streaming URL
|
|
3714
4154
|
* (<code>API</code>) or SAML 2.0 federation (<code>SAML</code>).</p>
|
|
3715
4155
|
*/
|
|
3716
4156
|
AuthenticationType?: AuthenticationType | string;
|
|
3717
4157
|
/**
|
|
4158
|
+
* @public
|
|
3718
4159
|
* <p>The network details for the streaming session.</p>
|
|
3719
4160
|
*/
|
|
3720
4161
|
NetworkAccessConfiguration?: NetworkAccessConfiguration;
|
|
@@ -3724,10 +4165,12 @@ export interface Session {
|
|
|
3724
4165
|
*/
|
|
3725
4166
|
export interface DescribeSessionsResult {
|
|
3726
4167
|
/**
|
|
4168
|
+
* @public
|
|
3727
4169
|
* <p>Information about the streaming sessions.</p>
|
|
3728
4170
|
*/
|
|
3729
4171
|
Sessions?: Session[];
|
|
3730
4172
|
/**
|
|
4173
|
+
* @public
|
|
3731
4174
|
* <p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>
|
|
3732
4175
|
*/
|
|
3733
4176
|
NextToken?: string;
|
|
@@ -3737,10 +4180,12 @@ export interface DescribeSessionsResult {
|
|
|
3737
4180
|
*/
|
|
3738
4181
|
export interface DescribeStacksRequest {
|
|
3739
4182
|
/**
|
|
4183
|
+
* @public
|
|
3740
4184
|
* <p>The names of the stacks to describe.</p>
|
|
3741
4185
|
*/
|
|
3742
4186
|
Names?: string[];
|
|
3743
4187
|
/**
|
|
4188
|
+
* @public
|
|
3744
4189
|
* <p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>
|
|
3745
4190
|
*/
|
|
3746
4191
|
NextToken?: string;
|
|
@@ -3750,10 +4195,12 @@ export interface DescribeStacksRequest {
|
|
|
3750
4195
|
*/
|
|
3751
4196
|
export interface DescribeStacksResult {
|
|
3752
4197
|
/**
|
|
4198
|
+
* @public
|
|
3753
4199
|
* <p>Information about the stacks.</p>
|
|
3754
4200
|
*/
|
|
3755
4201
|
Stacks?: Stack[];
|
|
3756
4202
|
/**
|
|
4203
|
+
* @public
|
|
3757
4204
|
* <p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>
|
|
3758
4205
|
*/
|
|
3759
4206
|
NextToken?: string;
|
|
@@ -3763,10 +4210,12 @@ export interface DescribeStacksResult {
|
|
|
3763
4210
|
*/
|
|
3764
4211
|
export interface DescribeUsageReportSubscriptionsRequest {
|
|
3765
4212
|
/**
|
|
4213
|
+
* @public
|
|
3766
4214
|
* <p>The maximum size of each page of results.</p>
|
|
3767
4215
|
*/
|
|
3768
4216
|
MaxResults?: number;
|
|
3769
4217
|
/**
|
|
4218
|
+
* @public
|
|
3770
4219
|
* <p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>
|
|
3771
4220
|
*/
|
|
3772
4221
|
NextToken?: string;
|
|
@@ -3790,10 +4239,12 @@ export type UsageReportExecutionErrorCode = (typeof UsageReportExecutionErrorCod
|
|
|
3790
4239
|
*/
|
|
3791
4240
|
export interface LastReportGenerationExecutionError {
|
|
3792
4241
|
/**
|
|
4242
|
+
* @public
|
|
3793
4243
|
* <p>The error code for the error that is returned when a usage report can't be generated.</p>
|
|
3794
4244
|
*/
|
|
3795
4245
|
ErrorCode?: UsageReportExecutionErrorCode | string;
|
|
3796
4246
|
/**
|
|
4247
|
+
* @public
|
|
3797
4248
|
* <p>The error message for the error that is returned when a usage report can't be generated.</p>
|
|
3798
4249
|
*/
|
|
3799
4250
|
ErrorMessage?: string;
|
|
@@ -3804,6 +4255,7 @@ export interface LastReportGenerationExecutionError {
|
|
|
3804
4255
|
*/
|
|
3805
4256
|
export interface UsageReportSubscription {
|
|
3806
4257
|
/**
|
|
4258
|
+
* @public
|
|
3807
4259
|
* <p>The Amazon S3 bucket where generated reports are stored.</p>
|
|
3808
4260
|
* <p>If you enabled on-instance session scripts and Amazon S3 logging for your session script
|
|
3809
4261
|
* configuration, AppStream 2.0 created an S3 bucket to store the script output. The bucket is
|
|
@@ -3813,14 +4265,17 @@ export interface UsageReportSubscription {
|
|
|
3813
4265
|
*/
|
|
3814
4266
|
S3BucketName?: string;
|
|
3815
4267
|
/**
|
|
4268
|
+
* @public
|
|
3816
4269
|
* <p>The schedule for generating usage reports.</p>
|
|
3817
4270
|
*/
|
|
3818
4271
|
Schedule?: UsageReportSchedule | string;
|
|
3819
4272
|
/**
|
|
4273
|
+
* @public
|
|
3820
4274
|
* <p>The time when the last usage report was generated.</p>
|
|
3821
4275
|
*/
|
|
3822
4276
|
LastGeneratedReportDate?: Date;
|
|
3823
4277
|
/**
|
|
4278
|
+
* @public
|
|
3824
4279
|
* <p>The errors that were returned if usage reports couldn't be generated.</p>
|
|
3825
4280
|
*/
|
|
3826
4281
|
SubscriptionErrors?: LastReportGenerationExecutionError[];
|
|
@@ -3830,10 +4285,12 @@ export interface UsageReportSubscription {
|
|
|
3830
4285
|
*/
|
|
3831
4286
|
export interface DescribeUsageReportSubscriptionsResult {
|
|
3832
4287
|
/**
|
|
4288
|
+
* @public
|
|
3833
4289
|
* <p>Information about the usage report subscription.</p>
|
|
3834
4290
|
*/
|
|
3835
4291
|
UsageReportSubscriptions?: UsageReportSubscription[];
|
|
3836
4292
|
/**
|
|
4293
|
+
* @public
|
|
3837
4294
|
* <p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>
|
|
3838
4295
|
*/
|
|
3839
4296
|
NextToken?: string;
|
|
@@ -3843,14 +4300,17 @@ export interface DescribeUsageReportSubscriptionsResult {
|
|
|
3843
4300
|
*/
|
|
3844
4301
|
export interface DescribeUsersRequest {
|
|
3845
4302
|
/**
|
|
4303
|
+
* @public
|
|
3846
4304
|
* <p>The authentication type for the users in the user pool to describe. You must specify USERPOOL.</p>
|
|
3847
4305
|
*/
|
|
3848
4306
|
AuthenticationType: AuthenticationType | string | undefined;
|
|
3849
4307
|
/**
|
|
4308
|
+
* @public
|
|
3850
4309
|
* <p>The maximum size of each page of results.</p>
|
|
3851
4310
|
*/
|
|
3852
4311
|
MaxResults?: number;
|
|
3853
4312
|
/**
|
|
4313
|
+
* @public
|
|
3854
4314
|
* <p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>
|
|
3855
4315
|
*/
|
|
3856
4316
|
NextToken?: string;
|
|
@@ -3861,10 +4321,12 @@ export interface DescribeUsersRequest {
|
|
|
3861
4321
|
*/
|
|
3862
4322
|
export interface User {
|
|
3863
4323
|
/**
|
|
4324
|
+
* @public
|
|
3864
4325
|
* <p>The ARN of the user.</p>
|
|
3865
4326
|
*/
|
|
3866
4327
|
Arn?: string;
|
|
3867
4328
|
/**
|
|
4329
|
+
* @public
|
|
3868
4330
|
* <p>The email address of the user.</p>
|
|
3869
4331
|
* <note>
|
|
3870
4332
|
* <p>Users' email addresses are case-sensitive.</p>
|
|
@@ -3872,10 +4334,12 @@ export interface User {
|
|
|
3872
4334
|
*/
|
|
3873
4335
|
UserName?: string;
|
|
3874
4336
|
/**
|
|
4337
|
+
* @public
|
|
3875
4338
|
* <p>Specifies whether the user in the user pool is enabled.</p>
|
|
3876
4339
|
*/
|
|
3877
4340
|
Enabled?: boolean;
|
|
3878
4341
|
/**
|
|
4342
|
+
* @public
|
|
3879
4343
|
* <p>The status of the user in the user pool. The status can be one of the following:</p>
|
|
3880
4344
|
* <ul>
|
|
3881
4345
|
* <li>
|
|
@@ -3897,18 +4361,22 @@ export interface User {
|
|
|
3897
4361
|
*/
|
|
3898
4362
|
Status?: string;
|
|
3899
4363
|
/**
|
|
4364
|
+
* @public
|
|
3900
4365
|
* <p>The first name, or given name, of the user.</p>
|
|
3901
4366
|
*/
|
|
3902
4367
|
FirstName?: string;
|
|
3903
4368
|
/**
|
|
4369
|
+
* @public
|
|
3904
4370
|
* <p>The last name, or surname, of the user.</p>
|
|
3905
4371
|
*/
|
|
3906
4372
|
LastName?: string;
|
|
3907
4373
|
/**
|
|
4374
|
+
* @public
|
|
3908
4375
|
* <p>The date and time the user was created in the user pool.</p>
|
|
3909
4376
|
*/
|
|
3910
4377
|
CreatedTime?: Date;
|
|
3911
4378
|
/**
|
|
4379
|
+
* @public
|
|
3912
4380
|
* <p>The authentication type for the user.</p>
|
|
3913
4381
|
*/
|
|
3914
4382
|
AuthenticationType: AuthenticationType | string | undefined;
|
|
@@ -3918,10 +4386,12 @@ export interface User {
|
|
|
3918
4386
|
*/
|
|
3919
4387
|
export interface DescribeUsersResult {
|
|
3920
4388
|
/**
|
|
4389
|
+
* @public
|
|
3921
4390
|
* <p>Information about users in the user pool.</p>
|
|
3922
4391
|
*/
|
|
3923
4392
|
Users?: User[];
|
|
3924
4393
|
/**
|
|
4394
|
+
* @public
|
|
3925
4395
|
* <p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>
|
|
3926
4396
|
*/
|
|
3927
4397
|
NextToken?: string;
|
|
@@ -3931,10 +4401,12 @@ export interface DescribeUsersResult {
|
|
|
3931
4401
|
*/
|
|
3932
4402
|
export interface DescribeUserStackAssociationsRequest {
|
|
3933
4403
|
/**
|
|
4404
|
+
* @public
|
|
3934
4405
|
* <p>The name of the stack that is associated with the user.</p>
|
|
3935
4406
|
*/
|
|
3936
4407
|
StackName?: string;
|
|
3937
4408
|
/**
|
|
4409
|
+
* @public
|
|
3938
4410
|
* <p>The email address of the user who is associated with the stack.</p>
|
|
3939
4411
|
* <note>
|
|
3940
4412
|
* <p>Users' email addresses are case-sensitive.</p>
|
|
@@ -3942,14 +4414,17 @@ export interface DescribeUserStackAssociationsRequest {
|
|
|
3942
4414
|
*/
|
|
3943
4415
|
UserName?: string;
|
|
3944
4416
|
/**
|
|
4417
|
+
* @public
|
|
3945
4418
|
* <p>The authentication type for the user who is associated with the stack. You must specify USERPOOL.</p>
|
|
3946
4419
|
*/
|
|
3947
4420
|
AuthenticationType?: AuthenticationType | string;
|
|
3948
4421
|
/**
|
|
4422
|
+
* @public
|
|
3949
4423
|
* <p>The maximum size of each page of results.</p>
|
|
3950
4424
|
*/
|
|
3951
4425
|
MaxResults?: number;
|
|
3952
4426
|
/**
|
|
4427
|
+
* @public
|
|
3953
4428
|
* <p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>
|
|
3954
4429
|
*/
|
|
3955
4430
|
NextToken?: string;
|
|
@@ -3959,10 +4434,12 @@ export interface DescribeUserStackAssociationsRequest {
|
|
|
3959
4434
|
*/
|
|
3960
4435
|
export interface DescribeUserStackAssociationsResult {
|
|
3961
4436
|
/**
|
|
4437
|
+
* @public
|
|
3962
4438
|
* <p>The UserStackAssociation objects.</p>
|
|
3963
4439
|
*/
|
|
3964
4440
|
UserStackAssociations?: UserStackAssociation[];
|
|
3965
4441
|
/**
|
|
4442
|
+
* @public
|
|
3966
4443
|
* <p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>
|
|
3967
4444
|
*/
|
|
3968
4445
|
NextToken?: string;
|
|
@@ -3972,6 +4449,7 @@ export interface DescribeUserStackAssociationsResult {
|
|
|
3972
4449
|
*/
|
|
3973
4450
|
export interface DisableUserRequest {
|
|
3974
4451
|
/**
|
|
4452
|
+
* @public
|
|
3975
4453
|
* <p>The email address of the user.</p>
|
|
3976
4454
|
* <note>
|
|
3977
4455
|
* <p>Users' email addresses are case-sensitive.</p>
|
|
@@ -3979,6 +4457,7 @@ export interface DisableUserRequest {
|
|
|
3979
4457
|
*/
|
|
3980
4458
|
UserName: string | undefined;
|
|
3981
4459
|
/**
|
|
4460
|
+
* @public
|
|
3982
4461
|
* <p>The authentication type for the user. You must specify USERPOOL.</p>
|
|
3983
4462
|
*/
|
|
3984
4463
|
AuthenticationType: AuthenticationType | string | undefined;
|
|
@@ -3993,10 +4472,12 @@ export interface DisableUserResult {
|
|
|
3993
4472
|
*/
|
|
3994
4473
|
export interface DisassociateAppBlockBuilderAppBlockRequest {
|
|
3995
4474
|
/**
|
|
4475
|
+
* @public
|
|
3996
4476
|
* <p>The ARN of the app block.</p>
|
|
3997
4477
|
*/
|
|
3998
4478
|
AppBlockArn: string | undefined;
|
|
3999
4479
|
/**
|
|
4480
|
+
* @public
|
|
4000
4481
|
* <p>The name of the app block builder.</p>
|
|
4001
4482
|
*/
|
|
4002
4483
|
AppBlockBuilderName: string | undefined;
|
|
@@ -4011,10 +4492,12 @@ export interface DisassociateAppBlockBuilderAppBlockResult {
|
|
|
4011
4492
|
*/
|
|
4012
4493
|
export interface DisassociateApplicationFleetRequest {
|
|
4013
4494
|
/**
|
|
4495
|
+
* @public
|
|
4014
4496
|
* <p>The name of the fleet.</p>
|
|
4015
4497
|
*/
|
|
4016
4498
|
FleetName: string | undefined;
|
|
4017
4499
|
/**
|
|
4500
|
+
* @public
|
|
4018
4501
|
* <p>The ARN of the application.</p>
|
|
4019
4502
|
*/
|
|
4020
4503
|
ApplicationArn: string | undefined;
|
|
@@ -4029,14 +4512,17 @@ export interface DisassociateApplicationFleetResult {
|
|
|
4029
4512
|
*/
|
|
4030
4513
|
export interface DisassociateApplicationFromEntitlementRequest {
|
|
4031
4514
|
/**
|
|
4515
|
+
* @public
|
|
4032
4516
|
* <p>The name of the stack with which the entitlement is associated.</p>
|
|
4033
4517
|
*/
|
|
4034
4518
|
StackName: string | undefined;
|
|
4035
4519
|
/**
|
|
4520
|
+
* @public
|
|
4036
4521
|
* <p>The name of the entitlement.</p>
|
|
4037
4522
|
*/
|
|
4038
4523
|
EntitlementName: string | undefined;
|
|
4039
4524
|
/**
|
|
4525
|
+
* @public
|
|
4040
4526
|
* <p>The identifier of the application to remove from the entitlement.</p>
|
|
4041
4527
|
*/
|
|
4042
4528
|
ApplicationIdentifier: string | undefined;
|
|
@@ -4051,10 +4537,12 @@ export interface DisassociateApplicationFromEntitlementResult {
|
|
|
4051
4537
|
*/
|
|
4052
4538
|
export interface DisassociateFleetRequest {
|
|
4053
4539
|
/**
|
|
4540
|
+
* @public
|
|
4054
4541
|
* <p>The name of the fleet.</p>
|
|
4055
4542
|
*/
|
|
4056
4543
|
FleetName: string | undefined;
|
|
4057
4544
|
/**
|
|
4545
|
+
* @public
|
|
4058
4546
|
* <p>The name of the stack.</p>
|
|
4059
4547
|
*/
|
|
4060
4548
|
StackName: string | undefined;
|
|
@@ -4069,6 +4557,7 @@ export interface DisassociateFleetResult {
|
|
|
4069
4557
|
*/
|
|
4070
4558
|
export interface EnableUserRequest {
|
|
4071
4559
|
/**
|
|
4560
|
+
* @public
|
|
4072
4561
|
* <p>The email address of the user.</p>
|
|
4073
4562
|
* <note>
|
|
4074
4563
|
* <p>Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays. </p>
|
|
@@ -4076,6 +4565,7 @@ export interface EnableUserRequest {
|
|
|
4076
4565
|
*/
|
|
4077
4566
|
UserName: string | undefined;
|
|
4078
4567
|
/**
|
|
4568
|
+
* @public
|
|
4079
4569
|
* <p>The authentication type for the user. You must specify USERPOOL.</p>
|
|
4080
4570
|
*/
|
|
4081
4571
|
AuthenticationType: AuthenticationType | string | undefined;
|
|
@@ -4091,6 +4581,7 @@ export interface EnableUserResult {
|
|
|
4091
4581
|
*/
|
|
4092
4582
|
export interface EntitledApplication {
|
|
4093
4583
|
/**
|
|
4584
|
+
* @public
|
|
4094
4585
|
* <p>The identifier of the application.</p>
|
|
4095
4586
|
*/
|
|
4096
4587
|
ApplicationIdentifier: string | undefined;
|
|
@@ -4100,6 +4591,7 @@ export interface EntitledApplication {
|
|
|
4100
4591
|
*/
|
|
4101
4592
|
export interface ExpireSessionRequest {
|
|
4102
4593
|
/**
|
|
4594
|
+
* @public
|
|
4103
4595
|
* <p>The identifier of the streaming session.</p>
|
|
4104
4596
|
*/
|
|
4105
4597
|
SessionId: string | undefined;
|
|
@@ -4130,10 +4622,12 @@ export type FleetAttribute = (typeof FleetAttribute)[keyof typeof FleetAttribute
|
|
|
4130
4622
|
*/
|
|
4131
4623
|
export interface ListAssociatedFleetsRequest {
|
|
4132
4624
|
/**
|
|
4625
|
+
* @public
|
|
4133
4626
|
* <p>The name of the stack.</p>
|
|
4134
4627
|
*/
|
|
4135
4628
|
StackName: string | undefined;
|
|
4136
4629
|
/**
|
|
4630
|
+
* @public
|
|
4137
4631
|
* <p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>
|
|
4138
4632
|
*/
|
|
4139
4633
|
NextToken?: string;
|
|
@@ -4143,10 +4637,12 @@ export interface ListAssociatedFleetsRequest {
|
|
|
4143
4637
|
*/
|
|
4144
4638
|
export interface ListAssociatedFleetsResult {
|
|
4145
4639
|
/**
|
|
4640
|
+
* @public
|
|
4146
4641
|
* <p>The name of the fleet.</p>
|
|
4147
4642
|
*/
|
|
4148
4643
|
Names?: string[];
|
|
4149
4644
|
/**
|
|
4645
|
+
* @public
|
|
4150
4646
|
* <p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>
|
|
4151
4647
|
*/
|
|
4152
4648
|
NextToken?: string;
|
|
@@ -4156,10 +4652,12 @@ export interface ListAssociatedFleetsResult {
|
|
|
4156
4652
|
*/
|
|
4157
4653
|
export interface ListAssociatedStacksRequest {
|
|
4158
4654
|
/**
|
|
4655
|
+
* @public
|
|
4159
4656
|
* <p>The name of the fleet.</p>
|
|
4160
4657
|
*/
|
|
4161
4658
|
FleetName: string | undefined;
|
|
4162
4659
|
/**
|
|
4660
|
+
* @public
|
|
4163
4661
|
* <p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>
|
|
4164
4662
|
*/
|
|
4165
4663
|
NextToken?: string;
|
|
@@ -4169,10 +4667,12 @@ export interface ListAssociatedStacksRequest {
|
|
|
4169
4667
|
*/
|
|
4170
4668
|
export interface ListAssociatedStacksResult {
|
|
4171
4669
|
/**
|
|
4670
|
+
* @public
|
|
4172
4671
|
* <p>The name of the stack.</p>
|
|
4173
4672
|
*/
|
|
4174
4673
|
Names?: string[];
|
|
4175
4674
|
/**
|
|
4675
|
+
* @public
|
|
4176
4676
|
* <p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>
|
|
4177
4677
|
*/
|
|
4178
4678
|
NextToken?: string;
|
|
@@ -4182,18 +4682,22 @@ export interface ListAssociatedStacksResult {
|
|
|
4182
4682
|
*/
|
|
4183
4683
|
export interface ListEntitledApplicationsRequest {
|
|
4184
4684
|
/**
|
|
4685
|
+
* @public
|
|
4185
4686
|
* <p>The name of the stack with which the entitlement is associated.</p>
|
|
4186
4687
|
*/
|
|
4187
4688
|
StackName: string | undefined;
|
|
4188
4689
|
/**
|
|
4690
|
+
* @public
|
|
4189
4691
|
* <p>The name of the entitlement.</p>
|
|
4190
4692
|
*/
|
|
4191
4693
|
EntitlementName: string | undefined;
|
|
4192
4694
|
/**
|
|
4695
|
+
* @public
|
|
4193
4696
|
* <p>The pagination token used to retrieve the next page of results for this operation.</p>
|
|
4194
4697
|
*/
|
|
4195
4698
|
NextToken?: string;
|
|
4196
4699
|
/**
|
|
4700
|
+
* @public
|
|
4197
4701
|
* <p>The maximum size of each page of results.</p>
|
|
4198
4702
|
*/
|
|
4199
4703
|
MaxResults?: number;
|
|
@@ -4203,10 +4707,12 @@ export interface ListEntitledApplicationsRequest {
|
|
|
4203
4707
|
*/
|
|
4204
4708
|
export interface ListEntitledApplicationsResult {
|
|
4205
4709
|
/**
|
|
4710
|
+
* @public
|
|
4206
4711
|
* <p>The entitled applications.</p>
|
|
4207
4712
|
*/
|
|
4208
4713
|
EntitledApplications?: EntitledApplication[];
|
|
4209
4714
|
/**
|
|
4715
|
+
* @public
|
|
4210
4716
|
* <p>The pagination token used to retrieve the next page of results for this operation.</p>
|
|
4211
4717
|
*/
|
|
4212
4718
|
NextToken?: string;
|
|
@@ -4216,6 +4722,7 @@ export interface ListEntitledApplicationsResult {
|
|
|
4216
4722
|
*/
|
|
4217
4723
|
export interface ListTagsForResourceRequest {
|
|
4218
4724
|
/**
|
|
4725
|
+
* @public
|
|
4219
4726
|
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
4220
4727
|
*/
|
|
4221
4728
|
ResourceArn: string | undefined;
|
|
@@ -4225,6 +4732,7 @@ export interface ListTagsForResourceRequest {
|
|
|
4225
4732
|
*/
|
|
4226
4733
|
export interface ListTagsForResourceResponse {
|
|
4227
4734
|
/**
|
|
4735
|
+
* @public
|
|
4228
4736
|
* <p>The information about the tags.</p>
|
|
4229
4737
|
*/
|
|
4230
4738
|
Tags?: Record<string, string>;
|
|
@@ -4234,6 +4742,7 @@ export interface ListTagsForResourceResponse {
|
|
|
4234
4742
|
*/
|
|
4235
4743
|
export interface StartAppBlockBuilderRequest {
|
|
4236
4744
|
/**
|
|
4745
|
+
* @public
|
|
4237
4746
|
* <p>The name of the app block builder.</p>
|
|
4238
4747
|
*/
|
|
4239
4748
|
Name: string | undefined;
|
|
@@ -4243,6 +4752,7 @@ export interface StartAppBlockBuilderRequest {
|
|
|
4243
4752
|
*/
|
|
4244
4753
|
export interface StartAppBlockBuilderResult {
|
|
4245
4754
|
/**
|
|
4755
|
+
* @public
|
|
4246
4756
|
* <p>Describes an app block builder.</p>
|
|
4247
4757
|
*/
|
|
4248
4758
|
AppBlockBuilder?: AppBlockBuilder;
|
|
@@ -4252,6 +4762,7 @@ export interface StartAppBlockBuilderResult {
|
|
|
4252
4762
|
*/
|
|
4253
4763
|
export interface StartFleetRequest {
|
|
4254
4764
|
/**
|
|
4765
|
+
* @public
|
|
4255
4766
|
* <p>The name of the fleet.</p>
|
|
4256
4767
|
*/
|
|
4257
4768
|
Name: string | undefined;
|
|
@@ -4266,10 +4777,12 @@ export interface StartFleetResult {
|
|
|
4266
4777
|
*/
|
|
4267
4778
|
export interface StartImageBuilderRequest {
|
|
4268
4779
|
/**
|
|
4780
|
+
* @public
|
|
4269
4781
|
* <p>The name of the image builder.</p>
|
|
4270
4782
|
*/
|
|
4271
4783
|
Name: string | undefined;
|
|
4272
4784
|
/**
|
|
4785
|
+
* @public
|
|
4273
4786
|
* <p>The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST]. </p>
|
|
4274
4787
|
*/
|
|
4275
4788
|
AppstreamAgentVersion?: string;
|
|
@@ -4279,6 +4792,7 @@ export interface StartImageBuilderRequest {
|
|
|
4279
4792
|
*/
|
|
4280
4793
|
export interface StartImageBuilderResult {
|
|
4281
4794
|
/**
|
|
4795
|
+
* @public
|
|
4282
4796
|
* <p>Information about the image builder.</p>
|
|
4283
4797
|
*/
|
|
4284
4798
|
ImageBuilder?: ImageBuilder;
|
|
@@ -4288,6 +4802,7 @@ export interface StartImageBuilderResult {
|
|
|
4288
4802
|
*/
|
|
4289
4803
|
export interface StopAppBlockBuilderRequest {
|
|
4290
4804
|
/**
|
|
4805
|
+
* @public
|
|
4291
4806
|
* <p>The name of the app block builder.</p>
|
|
4292
4807
|
*/
|
|
4293
4808
|
Name: string | undefined;
|
|
@@ -4297,6 +4812,7 @@ export interface StopAppBlockBuilderRequest {
|
|
|
4297
4812
|
*/
|
|
4298
4813
|
export interface StopAppBlockBuilderResult {
|
|
4299
4814
|
/**
|
|
4815
|
+
* @public
|
|
4300
4816
|
* <p>Describes an app block builder.</p>
|
|
4301
4817
|
*/
|
|
4302
4818
|
AppBlockBuilder?: AppBlockBuilder;
|
|
@@ -4306,6 +4822,7 @@ export interface StopAppBlockBuilderResult {
|
|
|
4306
4822
|
*/
|
|
4307
4823
|
export interface StopFleetRequest {
|
|
4308
4824
|
/**
|
|
4825
|
+
* @public
|
|
4309
4826
|
* <p>The name of the fleet.</p>
|
|
4310
4827
|
*/
|
|
4311
4828
|
Name: string | undefined;
|
|
@@ -4320,6 +4837,7 @@ export interface StopFleetResult {
|
|
|
4320
4837
|
*/
|
|
4321
4838
|
export interface StopImageBuilderRequest {
|
|
4322
4839
|
/**
|
|
4840
|
+
* @public
|
|
4323
4841
|
* <p>The name of the image builder.</p>
|
|
4324
4842
|
*/
|
|
4325
4843
|
Name: string | undefined;
|
|
@@ -4329,6 +4847,7 @@ export interface StopImageBuilderRequest {
|
|
|
4329
4847
|
*/
|
|
4330
4848
|
export interface StopImageBuilderResult {
|
|
4331
4849
|
/**
|
|
4850
|
+
* @public
|
|
4332
4851
|
* <p>Information about the image builder.</p>
|
|
4333
4852
|
*/
|
|
4334
4853
|
ImageBuilder?: ImageBuilder;
|
|
@@ -4338,10 +4857,12 @@ export interface StopImageBuilderResult {
|
|
|
4338
4857
|
*/
|
|
4339
4858
|
export interface TagResourceRequest {
|
|
4340
4859
|
/**
|
|
4860
|
+
* @public
|
|
4341
4861
|
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
4342
4862
|
*/
|
|
4343
4863
|
ResourceArn: string | undefined;
|
|
4344
4864
|
/**
|
|
4865
|
+
* @public
|
|
4345
4866
|
* <p>The tags to associate. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. </p>
|
|
4346
4867
|
* <p>If you do not specify a value, the value is set to an empty string.</p>
|
|
4347
4868
|
* <p>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: </p>
|
|
@@ -4359,10 +4880,12 @@ export interface TagResourceResponse {
|
|
|
4359
4880
|
*/
|
|
4360
4881
|
export interface UntagResourceRequest {
|
|
4361
4882
|
/**
|
|
4883
|
+
* @public
|
|
4362
4884
|
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
4363
4885
|
*/
|
|
4364
4886
|
ResourceArn: string | undefined;
|
|
4365
4887
|
/**
|
|
4888
|
+
* @public
|
|
4366
4889
|
* <p>The tag keys for the tags to disassociate.</p>
|
|
4367
4890
|
*/
|
|
4368
4891
|
TagKeys: string[] | undefined;
|
|
@@ -4377,24 +4900,29 @@ export interface UntagResourceResponse {
|
|
|
4377
4900
|
*/
|
|
4378
4901
|
export interface UpdateAppBlockBuilderRequest {
|
|
4379
4902
|
/**
|
|
4903
|
+
* @public
|
|
4380
4904
|
* <p>The unique name for the app block builder.</p>
|
|
4381
4905
|
*/
|
|
4382
4906
|
Name: string | undefined;
|
|
4383
4907
|
/**
|
|
4908
|
+
* @public
|
|
4384
4909
|
* <p>The description of the app block builder.</p>
|
|
4385
4910
|
*/
|
|
4386
4911
|
Description?: string;
|
|
4387
4912
|
/**
|
|
4913
|
+
* @public
|
|
4388
4914
|
* <p>The display name of the app block builder.</p>
|
|
4389
4915
|
*/
|
|
4390
4916
|
DisplayName?: string;
|
|
4391
4917
|
/**
|
|
4918
|
+
* @public
|
|
4392
4919
|
* <p>The platform of the app block builder.</p>
|
|
4393
4920
|
* <p>
|
|
4394
4921
|
* <code>WINDOWS_SERVER_2019</code> is the only valid value.</p>
|
|
4395
4922
|
*/
|
|
4396
4923
|
Platform?: PlatformType | string;
|
|
4397
4924
|
/**
|
|
4925
|
+
* @public
|
|
4398
4926
|
* <p>The instance type to use when launching the app block builder. The following instance
|
|
4399
4927
|
* types are available:</p>
|
|
4400
4928
|
* <ul>
|
|
@@ -4417,16 +4945,19 @@ export interface UpdateAppBlockBuilderRequest {
|
|
|
4417
4945
|
*/
|
|
4418
4946
|
InstanceType?: string;
|
|
4419
4947
|
/**
|
|
4948
|
+
* @public
|
|
4420
4949
|
* <p>The VPC configuration for the app block builder.</p>
|
|
4421
4950
|
* <p>App block builders require that you specify at least two subnets in different availability
|
|
4422
4951
|
* zones.</p>
|
|
4423
4952
|
*/
|
|
4424
4953
|
VpcConfig?: VpcConfig;
|
|
4425
4954
|
/**
|
|
4955
|
+
* @public
|
|
4426
4956
|
* <p>Enables or disables default internet access for the app block builder.</p>
|
|
4427
4957
|
*/
|
|
4428
4958
|
EnableDefaultInternetAccess?: boolean;
|
|
4429
4959
|
/**
|
|
4960
|
+
* @public
|
|
4430
4961
|
* <p>The Amazon Resource Name (ARN) of the IAM role to apply to the app block builder. To
|
|
4431
4962
|
* assume a role, the app block builder calls the AWS Security Token Service (STS)
|
|
4432
4963
|
* <code>AssumeRole</code> API operation and passes the ARN of the role to use. The
|
|
@@ -4436,10 +4967,12 @@ export interface UpdateAppBlockBuilderRequest {
|
|
|
4436
4967
|
*/
|
|
4437
4968
|
IamRoleArn?: string;
|
|
4438
4969
|
/**
|
|
4970
|
+
* @public
|
|
4439
4971
|
* <p>The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block builder only through the specified endpoints.</p>
|
|
4440
4972
|
*/
|
|
4441
4973
|
AccessEndpoints?: AccessEndpoint[];
|
|
4442
4974
|
/**
|
|
4975
|
+
* @public
|
|
4443
4976
|
* <p>The attributes to delete from the app block builder.</p>
|
|
4444
4977
|
*/
|
|
4445
4978
|
AttributesToDelete?: (AppBlockBuilderAttribute | string)[];
|
|
@@ -4449,6 +4982,7 @@ export interface UpdateAppBlockBuilderRequest {
|
|
|
4449
4982
|
*/
|
|
4450
4983
|
export interface UpdateAppBlockBuilderResult {
|
|
4451
4984
|
/**
|
|
4985
|
+
* @public
|
|
4452
4986
|
* <p>Describes an app block builder.</p>
|
|
4453
4987
|
*/
|
|
4454
4988
|
AppBlockBuilder?: AppBlockBuilder;
|
|
@@ -4458,38 +4992,47 @@ export interface UpdateAppBlockBuilderResult {
|
|
|
4458
4992
|
*/
|
|
4459
4993
|
export interface UpdateApplicationRequest {
|
|
4460
4994
|
/**
|
|
4995
|
+
* @public
|
|
4461
4996
|
* <p>The name of the application. This name is visible to users when display name is not specified.</p>
|
|
4462
4997
|
*/
|
|
4463
4998
|
Name: string | undefined;
|
|
4464
4999
|
/**
|
|
5000
|
+
* @public
|
|
4465
5001
|
* <p>The display name of the application. This name is visible to users in the application catalog.</p>
|
|
4466
5002
|
*/
|
|
4467
5003
|
DisplayName?: string;
|
|
4468
5004
|
/**
|
|
5005
|
+
* @public
|
|
4469
5006
|
* <p>The description of the application.</p>
|
|
4470
5007
|
*/
|
|
4471
5008
|
Description?: string;
|
|
4472
5009
|
/**
|
|
5010
|
+
* @public
|
|
4473
5011
|
* <p>The icon S3 location of the application.</p>
|
|
4474
5012
|
*/
|
|
4475
5013
|
IconS3Location?: S3Location;
|
|
4476
5014
|
/**
|
|
5015
|
+
* @public
|
|
4477
5016
|
* <p>The launch path of the application.</p>
|
|
4478
5017
|
*/
|
|
4479
5018
|
LaunchPath?: string;
|
|
4480
5019
|
/**
|
|
5020
|
+
* @public
|
|
4481
5021
|
* <p>The working directory of the application.</p>
|
|
4482
5022
|
*/
|
|
4483
5023
|
WorkingDirectory?: string;
|
|
4484
5024
|
/**
|
|
5025
|
+
* @public
|
|
4485
5026
|
* <p>The launch parameters of the application.</p>
|
|
4486
5027
|
*/
|
|
4487
5028
|
LaunchParameters?: string;
|
|
4488
5029
|
/**
|
|
5030
|
+
* @public
|
|
4489
5031
|
* <p>The ARN of the app block.</p>
|
|
4490
5032
|
*/
|
|
4491
5033
|
AppBlockArn?: string;
|
|
4492
5034
|
/**
|
|
5035
|
+
* @public
|
|
4493
5036
|
* <p>The attributes to delete for an application.</p>
|
|
4494
5037
|
*/
|
|
4495
5038
|
AttributesToDelete?: (ApplicationAttribute | string)[];
|
|
@@ -4499,6 +5042,7 @@ export interface UpdateApplicationRequest {
|
|
|
4499
5042
|
*/
|
|
4500
5043
|
export interface UpdateApplicationResult {
|
|
4501
5044
|
/**
|
|
5045
|
+
* @public
|
|
4502
5046
|
* <p>Describes an application in the application catalog.</p>
|
|
4503
5047
|
*/
|
|
4504
5048
|
Application?: Application;
|
|
@@ -4508,18 +5052,22 @@ export interface UpdateApplicationResult {
|
|
|
4508
5052
|
*/
|
|
4509
5053
|
export interface UpdateDirectoryConfigRequest {
|
|
4510
5054
|
/**
|
|
5055
|
+
* @public
|
|
4511
5056
|
* <p>The name of the Directory Config object.</p>
|
|
4512
5057
|
*/
|
|
4513
5058
|
DirectoryName: string | undefined;
|
|
4514
5059
|
/**
|
|
5060
|
+
* @public
|
|
4515
5061
|
* <p>The distinguished names of the organizational units for computer accounts.</p>
|
|
4516
5062
|
*/
|
|
4517
5063
|
OrganizationalUnitDistinguishedNames?: string[];
|
|
4518
5064
|
/**
|
|
5065
|
+
* @public
|
|
4519
5066
|
* <p>The credentials for the service account used by the fleet or image builder to connect to the directory.</p>
|
|
4520
5067
|
*/
|
|
4521
5068
|
ServiceAccountCredentials?: ServiceAccountCredentials;
|
|
4522
5069
|
/**
|
|
5070
|
+
* @public
|
|
4523
5071
|
* <p>The certificate-based authentication properties used to authenticate SAML 2.0 Identity
|
|
4524
5072
|
* Provider (IdP) user identities to Active Directory domain-joined streaming instances.
|
|
4525
5073
|
* Fallback is turned on by default when certificate-based authentication is <b>Enabled</b> . Fallback allows users to log in using their AD
|
|
@@ -4535,6 +5083,7 @@ export interface UpdateDirectoryConfigRequest {
|
|
|
4535
5083
|
*/
|
|
4536
5084
|
export interface UpdateDirectoryConfigResult {
|
|
4537
5085
|
/**
|
|
5086
|
+
* @public
|
|
4538
5087
|
* <p>Information about the Directory Config object.</p>
|
|
4539
5088
|
*/
|
|
4540
5089
|
DirectoryConfig?: DirectoryConfig;
|
|
@@ -4544,22 +5093,27 @@ export interface UpdateDirectoryConfigResult {
|
|
|
4544
5093
|
*/
|
|
4545
5094
|
export interface UpdateEntitlementRequest {
|
|
4546
5095
|
/**
|
|
5096
|
+
* @public
|
|
4547
5097
|
* <p>The name of the entitlement.</p>
|
|
4548
5098
|
*/
|
|
4549
5099
|
Name: string | undefined;
|
|
4550
5100
|
/**
|
|
5101
|
+
* @public
|
|
4551
5102
|
* <p>The name of the stack with which the entitlement is associated.</p>
|
|
4552
5103
|
*/
|
|
4553
5104
|
StackName: string | undefined;
|
|
4554
5105
|
/**
|
|
5106
|
+
* @public
|
|
4555
5107
|
* <p>The description of the entitlement.</p>
|
|
4556
5108
|
*/
|
|
4557
5109
|
Description?: string;
|
|
4558
5110
|
/**
|
|
5111
|
+
* @public
|
|
4559
5112
|
* <p>Specifies whether all or only selected apps are entitled.</p>
|
|
4560
5113
|
*/
|
|
4561
5114
|
AppVisibility?: AppVisibility | string;
|
|
4562
5115
|
/**
|
|
5116
|
+
* @public
|
|
4563
5117
|
* <p>The attributes of the entitlement.</p>
|
|
4564
5118
|
*/
|
|
4565
5119
|
Attributes?: EntitlementAttribute[];
|
|
@@ -4569,6 +5123,7 @@ export interface UpdateEntitlementRequest {
|
|
|
4569
5123
|
*/
|
|
4570
5124
|
export interface UpdateEntitlementResult {
|
|
4571
5125
|
/**
|
|
5126
|
+
* @public
|
|
4572
5127
|
* <p>The entitlement.</p>
|
|
4573
5128
|
*/
|
|
4574
5129
|
Entitlement?: Entitlement;
|
|
@@ -4578,18 +5133,22 @@ export interface UpdateEntitlementResult {
|
|
|
4578
5133
|
*/
|
|
4579
5134
|
export interface UpdateFleetRequest {
|
|
4580
5135
|
/**
|
|
5136
|
+
* @public
|
|
4581
5137
|
* <p>The name of the image used to create the fleet.</p>
|
|
4582
5138
|
*/
|
|
4583
5139
|
ImageName?: string;
|
|
4584
5140
|
/**
|
|
5141
|
+
* @public
|
|
4585
5142
|
* <p>The ARN of the public, private, or shared image to use.</p>
|
|
4586
5143
|
*/
|
|
4587
5144
|
ImageArn?: string;
|
|
4588
5145
|
/**
|
|
5146
|
+
* @public
|
|
4589
5147
|
* <p>A unique name for the fleet.</p>
|
|
4590
5148
|
*/
|
|
4591
5149
|
Name?: string;
|
|
4592
5150
|
/**
|
|
5151
|
+
* @public
|
|
4593
5152
|
* <p>The instance type to use when launching fleet instances. The following instance types are available:</p>
|
|
4594
5153
|
* <ul>
|
|
4595
5154
|
* <li>
|
|
@@ -4719,46 +5278,56 @@ export interface UpdateFleetRequest {
|
|
|
4719
5278
|
*/
|
|
4720
5279
|
InstanceType?: string;
|
|
4721
5280
|
/**
|
|
5281
|
+
* @public
|
|
4722
5282
|
* <p>The desired capacity for the fleet. This is not allowed for Elastic fleets.</p>
|
|
4723
5283
|
*/
|
|
4724
5284
|
ComputeCapacity?: ComputeCapacity;
|
|
4725
5285
|
/**
|
|
5286
|
+
* @public
|
|
4726
5287
|
* <p>The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones. </p>
|
|
4727
5288
|
*/
|
|
4728
5289
|
VpcConfig?: VpcConfig;
|
|
4729
5290
|
/**
|
|
5291
|
+
* @public
|
|
4730
5292
|
* <p>The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.</p>
|
|
4731
5293
|
* <p>Specify a value between 600 and 432000.</p>
|
|
4732
5294
|
*/
|
|
4733
5295
|
MaxUserDurationInSeconds?: number;
|
|
4734
5296
|
/**
|
|
5297
|
+
* @public
|
|
4735
5298
|
* <p>The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance. </p>
|
|
4736
5299
|
* <p>Specify a value between 60 and 360000.</p>
|
|
4737
5300
|
*/
|
|
4738
5301
|
DisconnectTimeoutInSeconds?: number;
|
|
4739
5302
|
/**
|
|
5303
|
+
* @public
|
|
4740
5304
|
* @deprecated
|
|
4741
5305
|
*
|
|
4742
5306
|
* <p>Deletes the VPC association for the specified fleet.</p>
|
|
4743
5307
|
*/
|
|
4744
5308
|
DeleteVpcConfig?: boolean;
|
|
4745
5309
|
/**
|
|
5310
|
+
* @public
|
|
4746
5311
|
* <p>The description to display.</p>
|
|
4747
5312
|
*/
|
|
4748
5313
|
Description?: string;
|
|
4749
5314
|
/**
|
|
5315
|
+
* @public
|
|
4750
5316
|
* <p>The fleet name to display.</p>
|
|
4751
5317
|
*/
|
|
4752
5318
|
DisplayName?: string;
|
|
4753
5319
|
/**
|
|
5320
|
+
* @public
|
|
4754
5321
|
* <p>Enables or disables default internet access for the fleet.</p>
|
|
4755
5322
|
*/
|
|
4756
5323
|
EnableDefaultInternetAccess?: boolean;
|
|
4757
5324
|
/**
|
|
5325
|
+
* @public
|
|
4758
5326
|
* <p>The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. </p>
|
|
4759
5327
|
*/
|
|
4760
5328
|
DomainJoinInfo?: DomainJoinInfo;
|
|
4761
5329
|
/**
|
|
5330
|
+
* @public
|
|
4762
5331
|
* <p>The amount of time that users can be idle (inactive) before they are disconnected
|
|
4763
5332
|
* from their streaming session and the <code>DisconnectTimeoutInSeconds</code> time
|
|
4764
5333
|
* interval begins. Users are notified before they are disconnected due to inactivity. If
|
|
@@ -4776,32 +5345,39 @@ export interface UpdateFleetRequest {
|
|
|
4776
5345
|
*/
|
|
4777
5346
|
IdleDisconnectTimeoutInSeconds?: number;
|
|
4778
5347
|
/**
|
|
5348
|
+
* @public
|
|
4779
5349
|
* <p>The fleet attributes to delete.</p>
|
|
4780
5350
|
*/
|
|
4781
5351
|
AttributesToDelete?: (FleetAttribute | string)[];
|
|
4782
5352
|
/**
|
|
5353
|
+
* @public
|
|
4783
5354
|
* <p>The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) <code>AssumeRole</code> API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the <b>appstream_machine_role</b> credential profile on the instance.</p>
|
|
4784
5355
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html">Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>
|
|
4785
5356
|
*/
|
|
4786
5357
|
IamRoleArn?: string;
|
|
4787
5358
|
/**
|
|
5359
|
+
* @public
|
|
4788
5360
|
* <p>The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When <code>APP</code> is specified, only the windows of applications opened by users display. When <code>DESKTOP</code> is specified, the standard desktop that is provided by the operating system displays.</p>
|
|
4789
5361
|
* <p>The default value is <code>APP</code>.</p>
|
|
4790
5362
|
*/
|
|
4791
5363
|
StreamView?: StreamView | string;
|
|
4792
5364
|
/**
|
|
5365
|
+
* @public
|
|
4793
5366
|
* <p>The platform of the fleet. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets. </p>
|
|
4794
5367
|
*/
|
|
4795
5368
|
Platform?: PlatformType | string;
|
|
4796
5369
|
/**
|
|
5370
|
+
* @public
|
|
4797
5371
|
* <p>The maximum number of concurrent sessions for a fleet.</p>
|
|
4798
5372
|
*/
|
|
4799
5373
|
MaxConcurrentSessions?: number;
|
|
4800
5374
|
/**
|
|
5375
|
+
* @public
|
|
4801
5376
|
* <p>The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.</p>
|
|
4802
5377
|
*/
|
|
4803
5378
|
UsbDeviceFilterStrings?: string[];
|
|
4804
5379
|
/**
|
|
5380
|
+
* @public
|
|
4805
5381
|
* <p>The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets. </p>
|
|
4806
5382
|
*/
|
|
4807
5383
|
SessionScriptS3Location?: S3Location;
|
|
@@ -4811,6 +5387,7 @@ export interface UpdateFleetRequest {
|
|
|
4811
5387
|
*/
|
|
4812
5388
|
export interface UpdateFleetResult {
|
|
4813
5389
|
/**
|
|
5390
|
+
* @public
|
|
4814
5391
|
* <p>Information about the fleet.</p>
|
|
4815
5392
|
*/
|
|
4816
5393
|
Fleet?: Fleet;
|
|
@@ -4820,14 +5397,17 @@ export interface UpdateFleetResult {
|
|
|
4820
5397
|
*/
|
|
4821
5398
|
export interface UpdateImagePermissionsRequest {
|
|
4822
5399
|
/**
|
|
5400
|
+
* @public
|
|
4823
5401
|
* <p>The name of the private image.</p>
|
|
4824
5402
|
*/
|
|
4825
5403
|
Name: string | undefined;
|
|
4826
5404
|
/**
|
|
5405
|
+
* @public
|
|
4827
5406
|
* <p>The 12-digit identifier of the AWS account for which you want add or update image permissions.</p>
|
|
4828
5407
|
*/
|
|
4829
5408
|
SharedAccountId: string | undefined;
|
|
4830
5409
|
/**
|
|
5410
|
+
* @public
|
|
4831
5411
|
* <p>The permissions for the image.</p>
|
|
4832
5412
|
*/
|
|
4833
5413
|
ImagePermissions: ImagePermissions | undefined;
|
|
@@ -4864,56 +5444,69 @@ export type StackAttribute = (typeof StackAttribute)[keyof typeof StackAttribute
|
|
|
4864
5444
|
*/
|
|
4865
5445
|
export interface UpdateStackRequest {
|
|
4866
5446
|
/**
|
|
5447
|
+
* @public
|
|
4867
5448
|
* <p>The stack name to display.</p>
|
|
4868
5449
|
*/
|
|
4869
5450
|
DisplayName?: string;
|
|
4870
5451
|
/**
|
|
5452
|
+
* @public
|
|
4871
5453
|
* <p>The description to display.</p>
|
|
4872
5454
|
*/
|
|
4873
5455
|
Description?: string;
|
|
4874
5456
|
/**
|
|
5457
|
+
* @public
|
|
4875
5458
|
* <p>The name of the stack.</p>
|
|
4876
5459
|
*/
|
|
4877
5460
|
Name: string | undefined;
|
|
4878
5461
|
/**
|
|
5462
|
+
* @public
|
|
4879
5463
|
* <p>The storage connectors to enable.</p>
|
|
4880
5464
|
*/
|
|
4881
5465
|
StorageConnectors?: StorageConnector[];
|
|
4882
5466
|
/**
|
|
5467
|
+
* @public
|
|
4883
5468
|
* @deprecated
|
|
4884
5469
|
*
|
|
4885
5470
|
* <p>Deletes the storage connectors currently enabled for the stack.</p>
|
|
4886
5471
|
*/
|
|
4887
5472
|
DeleteStorageConnectors?: boolean;
|
|
4888
5473
|
/**
|
|
5474
|
+
* @public
|
|
4889
5475
|
* <p>The URL that users are redirected to after their streaming session ends.</p>
|
|
4890
5476
|
*/
|
|
4891
5477
|
RedirectURL?: string;
|
|
4892
5478
|
/**
|
|
5479
|
+
* @public
|
|
4893
5480
|
* <p>The URL that users are redirected to after they choose the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.</p>
|
|
4894
5481
|
*/
|
|
4895
5482
|
FeedbackURL?: string;
|
|
4896
5483
|
/**
|
|
5484
|
+
* @public
|
|
4897
5485
|
* <p>The stack attributes to delete.</p>
|
|
4898
5486
|
*/
|
|
4899
5487
|
AttributesToDelete?: (StackAttribute | string)[];
|
|
4900
5488
|
/**
|
|
5489
|
+
* @public
|
|
4901
5490
|
* <p>The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.</p>
|
|
4902
5491
|
*/
|
|
4903
5492
|
UserSettings?: UserSetting[];
|
|
4904
5493
|
/**
|
|
5494
|
+
* @public
|
|
4905
5495
|
* <p>The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.</p>
|
|
4906
5496
|
*/
|
|
4907
5497
|
ApplicationSettings?: ApplicationSettings;
|
|
4908
5498
|
/**
|
|
5499
|
+
* @public
|
|
4909
5500
|
* <p>The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.</p>
|
|
4910
5501
|
*/
|
|
4911
5502
|
AccessEndpoints?: AccessEndpoint[];
|
|
4912
5503
|
/**
|
|
5504
|
+
* @public
|
|
4913
5505
|
* <p>The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions. </p>
|
|
4914
5506
|
*/
|
|
4915
5507
|
EmbedHostDomains?: string[];
|
|
4916
5508
|
/**
|
|
5509
|
+
* @public
|
|
4917
5510
|
* <p>The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.</p>
|
|
4918
5511
|
*/
|
|
4919
5512
|
StreamingExperienceSettings?: StreamingExperienceSettings;
|
|
@@ -4923,6 +5516,7 @@ export interface UpdateStackRequest {
|
|
|
4923
5516
|
*/
|
|
4924
5517
|
export interface UpdateStackResult {
|
|
4925
5518
|
/**
|
|
5519
|
+
* @public
|
|
4926
5520
|
* <p>Information about the stack.</p>
|
|
4927
5521
|
*/
|
|
4928
5522
|
Stack?: Stack;
|