/
models_0.ts
4625 lines (3966 loc) · 123 KB
/
models_0.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// smithy-typescript generated code
import { ExceptionOptionType as __ExceptionOptionType, SENSITIVE_STRING } from "@aws-sdk/smithy-client";
import { NimbleServiceException as __BaseException } from "./NimbleServiceException";
export interface AcceptEulasRequest {
/**
* <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
* request. If you don’t specify a client token, the Amazon Web Services SDK automatically
* generates a client token and uses it for the request to ensure idempotency.</p>
*/
clientToken?: string;
/**
* <p>The EULA ID.</p>
*/
eulaIds?: string[];
/**
* <p>The studio ID.</p>
*/
studioId: string | undefined;
}
/**
* <p>The acceptance of a EULA, required to use Amazon-provided streaming images.</p>
*/
export interface EulaAcceptance {
/**
* <p>The ISO timestamp in seconds for when the EULA was accepted.</p>
*/
acceptedAt?: Date;
/**
* <p>The ID of the person who accepted the EULA.</p>
*/
acceptedBy?: string;
/**
* <p>The ID of the acceptee.</p>
*/
accepteeId?: string;
/**
* <p>The EULA acceptance ID.</p>
*/
eulaAcceptanceId?: string;
/**
* <p>The EULA ID.</p>
*/
eulaId?: string;
}
export interface AcceptEulasResponse {
/**
* <p>A collection of EULA acceptances.</p>
*/
eulaAcceptances?: EulaAcceptance[];
}
/**
* <p>You are not authorized to perform this operation. Check your IAM
* policies, and ensure that you are using the correct access keys.</p>
*/
export class AccessDeniedException extends __BaseException {
readonly name: "AccessDeniedException" = "AccessDeniedException";
readonly $fault: "client" = "client";
/**
* <p>A more specific error code.</p>
*/
code?: string;
/**
* <p>The exception context.</p>
*/
context?: Record<string, string>;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>) {
super({
name: "AccessDeniedException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, AccessDeniedException.prototype);
this.code = opts.code;
this.context = opts.context;
}
}
/**
* <p>Another operation is in progress. </p>
*/
export class ConflictException extends __BaseException {
readonly name: "ConflictException" = "ConflictException";
readonly $fault: "client" = "client";
/**
* <p>A more specific error code.</p>
*/
code?: string;
/**
* <p>The exception context.</p>
*/
context?: Record<string, string>;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>) {
super({
name: "ConflictException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ConflictException.prototype);
this.code = opts.code;
this.context = opts.context;
}
}
/**
* <p>An internal error has occurred. Please retry your request.</p>
*/
export class InternalServerErrorException extends __BaseException {
readonly name: "InternalServerErrorException" = "InternalServerErrorException";
readonly $fault: "server" = "server";
$retryable = {};
/**
* <p>A more specific error code.</p>
*/
code?: string;
/**
* <p>The exception context.</p>
*/
context?: Record<string, string>;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<InternalServerErrorException, __BaseException>) {
super({
name: "InternalServerErrorException",
$fault: "server",
...opts,
});
Object.setPrototypeOf(this, InternalServerErrorException.prototype);
this.code = opts.code;
this.context = opts.context;
}
}
/**
* <p>The specified resource could not be found.</p>
*/
export class ResourceNotFoundException extends __BaseException {
readonly name: "ResourceNotFoundException" = "ResourceNotFoundException";
readonly $fault: "client" = "client";
/**
* <p>A more specific error code.</p>
*/
code?: string;
/**
* <p>The exception context.</p>
*/
context?: Record<string, string>;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>) {
super({
name: "ResourceNotFoundException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ResourceNotFoundException.prototype);
this.code = opts.code;
this.context = opts.context;
}
}
/**
* <p>Your current quota does not allow you to perform the request action. You can request
* increases for some quotas, and other quotas cannot be increased.</p>
* <p>Please use Amazon Web Services Service Quotas to request an increase. </p>
*/
export class ServiceQuotaExceededException extends __BaseException {
readonly name: "ServiceQuotaExceededException" = "ServiceQuotaExceededException";
readonly $fault: "client" = "client";
/**
* <p>A more specific error code.</p>
*/
code?: string;
/**
* <p>The exception context.</p>
*/
context?: Record<string, string>;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>) {
super({
name: "ServiceQuotaExceededException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ServiceQuotaExceededException.prototype);
this.code = opts.code;
this.context = opts.context;
}
}
/**
* <p>The request throughput limit was exceeded.</p>
*/
export class ThrottlingException extends __BaseException {
readonly name: "ThrottlingException" = "ThrottlingException";
readonly $fault: "client" = "client";
$retryable = {};
/**
* <p>A more specific error code.</p>
*/
code?: string;
/**
* <p>The exception context.</p>
*/
context?: Record<string, string>;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>) {
super({
name: "ThrottlingException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ThrottlingException.prototype);
this.code = opts.code;
this.context = opts.context;
}
}
/**
* <p>One of the parameters in the request is invalid.</p>
*/
export class ValidationException extends __BaseException {
readonly name: "ValidationException" = "ValidationException";
readonly $fault: "client" = "client";
/**
* <p>A more specific error code.</p>
*/
code?: string;
/**
* <p>The exception context.</p>
*/
context?: Record<string, string>;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>) {
super({
name: "ValidationException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ValidationException.prototype);
this.code = opts.code;
this.context = opts.context;
}
}
/**
* <p>An LDAP attribute of an Active Directory computer account, in the form of a name:value
* pair.</p>
*/
export interface ActiveDirectoryComputerAttribute {
/**
* <p>The name for the LDAP attribute.</p>
*/
name?: string;
/**
* <p>The value for the LDAP attribute.</p>
*/
value?: string;
}
/**
* <p>The configuration for a Directory Service for Microsoft Active Directory studio resource.</p>
*/
export interface ActiveDirectoryConfiguration {
/**
* <p>A collection of custom attributes for an Active Directory computer.</p>
*/
computerAttributes?: ActiveDirectoryComputerAttribute[];
/**
* <p>The directory ID of the Directory Service for Microsoft Active Directory to access using this studio
* component.</p>
*/
directoryId?: string;
/**
* <p>The distinguished name (DN) and organizational unit (OU) of an Active Directory
* computer.</p>
*/
organizationalUnitDistinguishedName?: string;
}
export enum AutomaticTerminationMode {
ACTIVATED = "ACTIVATED",
DEACTIVATED = "DEACTIVATED",
}
/**
* <p>The configuration for a render farm that is associated with a studio resource.</p>
*/
export interface ComputeFarmConfiguration {
/**
* <p>The name of an Active Directory user that is used on ComputeFarm worker
* instances.</p>
*/
activeDirectoryUser?: string;
/**
* <p>The endpoint of the ComputeFarm that is accessed by the studio component
* resource.</p>
*/
endpoint?: string;
}
export enum StreamingClipboardMode {
DISABLED = "DISABLED",
ENABLED = "ENABLED",
}
export enum StreamingInstanceType {
g3_4xlarge = "g3.4xlarge",
g3s_xlarge = "g3s.xlarge",
g4dn_12xlarge = "g4dn.12xlarge",
g4dn_16xlarge = "g4dn.16xlarge",
g4dn_2xlarge = "g4dn.2xlarge",
g4dn_4xlarge = "g4dn.4xlarge",
g4dn_8xlarge = "g4dn.8xlarge",
g4dn_xlarge = "g4dn.xlarge",
g5_16xlarge = "g5.16xlarge",
g5_2xlarge = "g5.2xlarge",
g5_4xlarge = "g5.4xlarge",
g5_8xlarge = "g5.8xlarge",
g5_xlarge = "g5.xlarge",
}
export enum SessionBackupMode {
AUTOMATIC = "AUTOMATIC",
DEACTIVATED = "DEACTIVATED",
}
/**
* <p>Configures how streaming sessions are backed up when launched from this launch
* profile.</p>
*/
export interface StreamConfigurationSessionBackup {
/**
* <p>Specifies how artists sessions are backed up.</p>
* <p>Configures backups for streaming sessions launched with this launch profile. The
* default value is <code>DEACTIVATED</code>, which means that backups are deactivated. To
* allow backups, set this value to <code>AUTOMATIC</code>.</p>
*/
mode?: SessionBackupMode | string;
/**
* <p>The maximum number of backups that each streaming session created from this launch
* profile can have.</p>
*/
maxBackupsToRetain?: number;
}
export enum SessionPersistenceMode {
ACTIVATED = "ACTIVATED",
DEACTIVATED = "DEACTIVATED",
}
export enum StreamingSessionStorageMode {
UPLOAD = "UPLOAD",
}
/**
* <p>The upload storage root location (folder) on streaming workstations where files are
* uploaded.</p>
*/
export interface StreamingSessionStorageRoot {
/**
* <p>The folder path in Linux workstations where files are uploaded.</p>
*/
linux?: string;
/**
* <p>The folder path in Windows workstations where files are uploaded.</p>
*/
windows?: string;
}
/**
* <p>The configuration for a streaming session’s upload storage.</p>
*/
export interface StreamConfigurationSessionStorage {
/**
* <p>The configuration for the upload storage root of the streaming session.</p>
*/
root?: StreamingSessionStorageRoot;
/**
* <p>Allows artists to upload files to their workstations. The only valid option is
* <code>UPLOAD</code>.</p>
*/
mode: (StreamingSessionStorageMode | string)[] | undefined;
}
/**
* <p>Custom volume configuration for the root volumes that are attached to streaming
* sessions.</p>
* <p>This parameter is only allowed when <code>sessionPersistenceMode</code> is
* <code>ACTIVATED</code>.</p>
*/
export interface VolumeConfiguration {
/**
* <p>The size of the root volume that is attached to the streaming session. The root volume
* size is measured in GiBs.</p>
*/
size?: number;
/**
* <p>The throughput to provision for the root volume that is attached to the streaming
* session. The throughput is measured in MiB/s.</p>
*/
throughput?: number;
/**
* <p>The number of I/O operations per second for the root volume that is attached to
* streaming session.</p>
*/
iops?: number;
}
/**
* <p>Configuration for streaming workstations created using this launch profile.</p>
*/
export interface StreamConfigurationCreate {
/**
* <p>Allows or deactivates the use of the system clipboard to copy and paste between the
* streaming session and streaming client.</p>
*/
clipboardMode: StreamingClipboardMode | string | undefined;
/**
* <p>The EC2 instance types that users can select from when launching a streaming session
* with this launch profile.</p>
*/
ec2InstanceTypes: (StreamingInstanceType | string)[] | undefined;
/**
* <p>The length of time, in minutes, that a streaming session can be active before it is
* stopped or terminated. After this point, Nimble Studio automatically terminates or
* stops the session. The default length of time is 690 minutes, and the maximum length of
* time is 30 days.</p>
*/
maxSessionLengthInMinutes?: number;
/**
* <p>The streaming images that users can select from when launching a streaming session
* with this launch profile.</p>
*/
streamingImageIds: string[] | undefined;
/**
* <p>Integer that determines if you can start and stop your sessions and how long a session
* can stay in the <code>STOPPED</code> state. The default value is 0. The maximum value is
* 5760.</p>
* <p>This field is allowed only when <code>sessionPersistenceMode</code> is
* <code>ACTIVATED</code> and <code>automaticTerminationMode</code> is
* <code>ACTIVATED</code>.</p>
* <p>If the value is set to 0, your sessions can’t be <code>STOPPED</code>. If you then
* call <code>StopStreamingSession</code>, the session fails. If the time that a session
* stays in the <code>READY</code> state exceeds the <code>maxSessionLengthInMinutes</code>
* value, the session will automatically be terminated (instead of
* <code>STOPPED</code>).</p>
* <p>If the value is set to a positive number, the session can be stopped. You can call
* <code>StopStreamingSession</code> to stop sessions in the <code>READY</code> state.
* If the time that a session stays in the <code>READY</code> state exceeds the
* <code>maxSessionLengthInMinutes</code> value, the session will automatically be
* stopped (instead of terminated).</p>
*/
maxStoppedSessionLengthInMinutes?: number;
/**
* <p>The upload storage for a streaming workstation that is created using this launch
* profile.</p>
*/
sessionStorage?: StreamConfigurationSessionStorage;
/**
* <p>Configures how streaming sessions are backed up when launched from this launch
* profile.</p>
*/
sessionBackup?: StreamConfigurationSessionBackup;
/**
* <p>Determine if a streaming session created from this launch profile can configure
* persistent storage. This means that <code>volumeConfiguration</code> and
* <code>automaticTerminationMode</code> are configured.</p>
*/
sessionPersistenceMode?: SessionPersistenceMode | string;
/**
* <p>Custom volume configuration for the root volumes that are attached to streaming
* sessions.</p>
* <p>This parameter is only allowed when <code>sessionPersistenceMode</code> is
* <code>ACTIVATED</code>.</p>
*/
volumeConfiguration?: VolumeConfiguration;
/**
* <p>Indicates if a streaming session created from this launch profile should be terminated
* automatically or retained without termination after being in a <code>STOPPED</code>
* state.</p>
* <ul>
* <li>
* <p>When <code>ACTIVATED</code>, the streaming session is scheduled for
* termination after being in the <code>STOPPED</code> state for the time specified
* in <code>maxStoppedSessionLengthInMinutes</code>.</p>
* </li>
* <li>
* <p>When <code>DEACTIVATED</code>, the streaming session can remain in the
* <code>STOPPED</code> state indefinitely.</p>
* </li>
* </ul>
* <p>This parameter is only allowed when <code>sessionPersistenceMode</code> is
* <code>ACTIVATED</code>. When allowed, the default value for this parameter is
* <code>DEACTIVATED</code>.</p>
*/
automaticTerminationMode?: AutomaticTerminationMode | string;
}
export interface CreateLaunchProfileRequest {
/**
* <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
* request. If you don’t specify a client token, the Amazon Web Services SDK automatically
* generates a client token and uses it for the request to ensure idempotency.</p>
*/
clientToken?: string;
/**
* <p>The description.</p>
*/
description?: string;
/**
* <p>Specifies the IDs of the EC2 subnets where streaming sessions will be accessible from.
* These subnets must support the specified instance types. </p>
*/
ec2SubnetIds: string[] | undefined;
/**
* <p>The version number of the protocol that is used by the launch profile. The only valid
* version is "2021-03-31".</p>
*/
launchProfileProtocolVersions: string[] | undefined;
/**
* <p>The name for the launch profile.</p>
*/
name: string | undefined;
/**
* <p>A configuration for a streaming session.</p>
*/
streamConfiguration: StreamConfigurationCreate | undefined;
/**
* <p>Unique identifiers for a collection of studio components that can be used with this
* launch profile.</p>
*/
studioComponentIds: string[] | undefined;
/**
* <p>The studio ID. </p>
*/
studioId: string | undefined;
/**
* <p>A collection of labels, in the form of key-value pairs, that apply to this
* resource.</p>
*/
tags?: Record<string, string>;
}
export enum LaunchProfileState {
CREATE_FAILED = "CREATE_FAILED",
CREATE_IN_PROGRESS = "CREATE_IN_PROGRESS",
DELETED = "DELETED",
DELETE_FAILED = "DELETE_FAILED",
DELETE_IN_PROGRESS = "DELETE_IN_PROGRESS",
READY = "READY",
UPDATE_FAILED = "UPDATE_FAILED",
UPDATE_IN_PROGRESS = "UPDATE_IN_PROGRESS",
}
export enum LaunchProfileStatusCode {
ENCRYPTION_KEY_ACCESS_DENIED = "ENCRYPTION_KEY_ACCESS_DENIED",
ENCRYPTION_KEY_NOT_FOUND = "ENCRYPTION_KEY_NOT_FOUND",
INTERNAL_ERROR = "INTERNAL_ERROR",
INVALID_INSTANCE_TYPES_PROVIDED = "INVALID_INSTANCE_TYPES_PROVIDED",
INVALID_SUBNETS_COMBINATION = "INVALID_SUBNETS_COMBINATION",
INVALID_SUBNETS_PROVIDED = "INVALID_SUBNETS_PROVIDED",
LAUNCH_PROFILE_CREATED = "LAUNCH_PROFILE_CREATED",
LAUNCH_PROFILE_CREATE_IN_PROGRESS = "LAUNCH_PROFILE_CREATE_IN_PROGRESS",
LAUNCH_PROFILE_DELETED = "LAUNCH_PROFILE_DELETED",
LAUNCH_PROFILE_DELETE_IN_PROGRESS = "LAUNCH_PROFILE_DELETE_IN_PROGRESS",
LAUNCH_PROFILE_UPDATED = "LAUNCH_PROFILE_UPDATED",
LAUNCH_PROFILE_UPDATE_IN_PROGRESS = "LAUNCH_PROFILE_UPDATE_IN_PROGRESS",
LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED = "LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED",
STREAMING_IMAGE_NOT_FOUND = "STREAMING_IMAGE_NOT_FOUND",
STREAMING_IMAGE_NOT_READY = "STREAMING_IMAGE_NOT_READY",
}
/**
* <p>A configuration for a streaming session.</p>
*/
export interface StreamConfiguration {
/**
* <p>Allows or deactivates the use of the system clipboard to copy and paste between the
* streaming session and streaming client.</p>
*/
clipboardMode: StreamingClipboardMode | string | undefined;
/**
* <p>The EC2 instance types that users can select from when launching a streaming session
* with this launch profile.</p>
*/
ec2InstanceTypes: (StreamingInstanceType | string)[] | undefined;
/**
* <p>The length of time, in minutes, that a streaming session can be active before it is
* stopped or terminated. After this point, Nimble Studio automatically terminates or
* stops the session. The default length of time is 690 minutes, and the maximum length of
* time is 30 days.</p>
*/
maxSessionLengthInMinutes?: number;
/**
* <p>The streaming images that users can select from when launching a streaming session
* with this launch profile.</p>
*/
streamingImageIds: string[] | undefined;
/**
* <p>Integer that determines if you can start and stop your sessions and how long a session
* can stay in the <code>STOPPED</code> state. The default value is 0. The maximum value is
* 5760.</p>
* <p>This field is allowed only when <code>sessionPersistenceMode</code> is
* <code>ACTIVATED</code> and <code>automaticTerminationMode</code> is
* <code>ACTIVATED</code>.</p>
* <p>If the value is set to 0, your sessions can’t be <code>STOPPED</code>. If you then
* call <code>StopStreamingSession</code>, the session fails. If the time that a session
* stays in the <code>READY</code> state exceeds the <code>maxSessionLengthInMinutes</code>
* value, the session will automatically be terminated (instead of
* <code>STOPPED</code>).</p>
* <p>If the value is set to a positive number, the session can be stopped. You can call
* <code>StopStreamingSession</code> to stop sessions in the <code>READY</code> state.
* If the time that a session stays in the <code>READY</code> state exceeds the
* <code>maxSessionLengthInMinutes</code> value, the session will automatically be
* stopped (instead of terminated).</p>
*/
maxStoppedSessionLengthInMinutes?: number;
/**
* <p>The upload storage for a streaming session.</p>
*/
sessionStorage?: StreamConfigurationSessionStorage;
/**
* <p>Information about the streaming session backup.</p>
*/
sessionBackup?: StreamConfigurationSessionBackup;
/**
* <p>Determine if a streaming session created from this launch profile can configure
* persistent storage. This means that <code>volumeConfiguration</code> and
* <code>automaticTerminationMode</code> are configured.</p>
*/
sessionPersistenceMode?: SessionPersistenceMode | string;
/**
* <p>Custom volume configuration for the root volumes that are attached to streaming
* sessions.</p>
* <p>This parameter is only allowed when <code>sessionPersistenceMode</code> is
* <code>ACTIVATED</code>.</p>
*/
volumeConfiguration?: VolumeConfiguration;
/**
* <p>Indicates if a streaming session created from this launch profile should be terminated
* automatically or retained without termination after being in a <code>STOPPED</code>
* state.</p>
* <ul>
* <li>
* <p>When <code>ACTIVATED</code>, the streaming session is scheduled for
* termination after being in the <code>STOPPED</code> state for the time specified
* in <code>maxStoppedSessionLengthInMinutes</code>.</p>
* </li>
* <li>
* <p>When <code>DEACTIVATED</code>, the streaming session can remain in the
* <code>STOPPED</code> state indefinitely.</p>
* </li>
* </ul>
* <p>This parameter is only allowed when <code>sessionPersistenceMode</code> is
* <code>ACTIVATED</code>. When allowed, the default value for this parameter is
* <code>DEACTIVATED</code>.</p>
*/
automaticTerminationMode?: AutomaticTerminationMode | string;
}
export enum LaunchProfileValidationState {
VALIDATION_FAILED = "VALIDATION_FAILED",
VALIDATION_FAILED_INTERNAL_SERVER_ERROR = "VALIDATION_FAILED_INTERNAL_SERVER_ERROR",
VALIDATION_IN_PROGRESS = "VALIDATION_IN_PROGRESS",
VALIDATION_NOT_STARTED = "VALIDATION_NOT_STARTED",
VALIDATION_SUCCESS = "VALIDATION_SUCCESS",
}
export enum LaunchProfileValidationStatusCode {
VALIDATION_FAILED_INTERNAL_SERVER_ERROR = "VALIDATION_FAILED_INTERNAL_SERVER_ERROR",
VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY = "VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY",
VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION = "VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION",
VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION = "VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION",
VALIDATION_FAILED_SUBNET_NOT_FOUND = "VALIDATION_FAILED_SUBNET_NOT_FOUND",
VALIDATION_FAILED_UNAUTHORIZED = "VALIDATION_FAILED_UNAUTHORIZED",
VALIDATION_IN_PROGRESS = "VALIDATION_IN_PROGRESS",
VALIDATION_NOT_STARTED = "VALIDATION_NOT_STARTED",
VALIDATION_SUCCESS = "VALIDATION_SUCCESS",
}
export enum LaunchProfileValidationType {
VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT = "VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT",
VALIDATE_NETWORK_ACL_ASSOCIATION = "VALIDATE_NETWORK_ACL_ASSOCIATION",
VALIDATE_SECURITY_GROUP_ASSOCIATION = "VALIDATE_SECURITY_GROUP_ASSOCIATION",
VALIDATE_SUBNET_ASSOCIATION = "VALIDATE_SUBNET_ASSOCIATION",
}
/**
* <p>The launch profile validation result.</p>
*/
export interface ValidationResult {
/**
* <p>The type of the validation result.</p>
*/
type: LaunchProfileValidationType | string | undefined;
/**
* <p>The current state.</p>
*/
state: LaunchProfileValidationState | string | undefined;
/**
* <p>The status code. This will contain the failure reason if the state is
* <code>VALIDATION_FAILED</code>.</p>
*/
statusCode: LaunchProfileValidationStatusCode | string | undefined;
/**
* <p>The status message for the validation result.</p>
*/
statusMessage: string | undefined;
}
/**
* <p>A launch profile controls your artist workforce’s access to studio components, like
* compute farms, shared file systems, managed file systems, and license server
* configurations, as well as instance types and Amazon Machine Images (AMIs). </p>
* <p>Studio administrators create launch profiles in the Nimble Studio console.
* Artists can use their launch profiles to launch an instance from the Nimble Studio
* portal. Each user’s launch profile defines how they can launch a streaming session. By
* default, studio admins can use all launch profiles.</p>
*/
export interface LaunchProfile {
/**
* <p>The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely
* identifies it. ARNs are unique across all Regions.</p>
*/
arn?: string;
/**
* <p>The ISO timestamp in seconds for when the resource was created.</p>
*/
createdAt?: Date;
/**
* <p>The user ID of the user that created the launch profile.</p>
*/
createdBy?: string;
/**
* <p>A human-readable description of the launch profile.</p>
*/
description?: string;
/**
* <p>Unique identifiers for a collection of EC2 subnets.</p>
*/
ec2SubnetIds?: string[];
/**
* <p>The ID of the launch profile used to control access from the streaming session.</p>
*/
launchProfileId?: string;
/**
* <p>The version number of the protocol that is used by the launch profile. The only valid
* version is "2021-03-31".</p>
*/
launchProfileProtocolVersions?: string[];
/**
* <p>A friendly name for the launch profile.</p>
*/
name?: string;
/**
* <p>The current state.</p>
*/
state?: LaunchProfileState | string;
/**
* <p>The status code.</p>
*/
statusCode?: LaunchProfileStatusCode | string;
/**
* <p>The status message for the launch profile.</p>
*/
statusMessage?: string;
/**
* <p>A configuration for a streaming session.</p>
*/
streamConfiguration?: StreamConfiguration;
/**
* <p>Unique identifiers for a collection of studio components that can be used with this
* launch profile.</p>
*/
studioComponentIds?: string[];
/**
* <p>A collection of labels, in the form of key-value pairs, that apply to this
* resource.</p>
*/
tags?: Record<string, string>;
/**
* <p>The ISO timestamp in seconds for when the resource was updated.</p>
*/
updatedAt?: Date;
/**
* <p>The user ID of the user that most recently updated the resource.</p>
*/
updatedBy?: string;
/**
* <p>The list of the latest validation results.</p>
*/
validationResults?: ValidationResult[];
}
export interface CreateLaunchProfileResponse {
/**
* <p>The launch profile.</p>
*/
launchProfile?: LaunchProfile;
}
export interface CreateStreamingImageRequest {
/**
* <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
* request. If you don’t specify a client token, the Amazon Web Services SDK automatically
* generates a client token and uses it for the request to ensure idempotency.</p>
*/
clientToken?: string;
/**
* <p>A human-readable description of the streaming image.</p>
*/
description?: string;
/**
* <p>The ID of an EC2 machine image with which to create this streaming image.</p>
*/
ec2ImageId: string | undefined;
/**
* <p>A friendly name for a streaming image resource.</p>
*/
name: string | undefined;
/**
* <p>The studio ID. </p>
*/
studioId: string | undefined;
/**
* <p>A collection of labels, in the form of key-value pairs, that apply to this
* resource.</p>
*/
tags?: Record<string, string>;
}
export enum StreamingImageEncryptionConfigurationKeyType {
CUSTOMER_MANAGED_KEY = "CUSTOMER_MANAGED_KEY",
}
/**
* <p>Specifies how a streaming image is encrypted.</p>
*/
export interface StreamingImageEncryptionConfiguration {
/**
* <p>The ARN for a KMS key that is used to encrypt studio data.</p>
*/
keyArn?: string;
/**
* <p>The type of KMS key that is used to encrypt studio data.</p>
*/
keyType: StreamingImageEncryptionConfigurationKeyType | string | undefined;
}
export enum StreamingImageState {
CREATE_FAILED = "CREATE_FAILED",
CREATE_IN_PROGRESS = "CREATE_IN_PROGRESS",
DELETED = "DELETED",
DELETE_FAILED = "DELETE_FAILED",
DELETE_IN_PROGRESS = "DELETE_IN_PROGRESS",
READY = "READY",
UPDATE_FAILED = "UPDATE_FAILED",
UPDATE_IN_PROGRESS = "UPDATE_IN_PROGRESS",
}
export enum StreamingImageStatusCode {
ACCESS_DENIED = "ACCESS_DENIED",
INTERNAL_ERROR = "INTERNAL_ERROR",
STREAMING_IMAGE_CREATE_IN_PROGRESS = "STREAMING_IMAGE_CREATE_IN_PROGRESS",
STREAMING_IMAGE_DELETED = "STREAMING_IMAGE_DELETED",
STREAMING_IMAGE_DELETE_IN_PROGRESS = "STREAMING_IMAGE_DELETE_IN_PROGRESS",
STREAMING_IMAGE_READY = "STREAMING_IMAGE_READY",
STREAMING_IMAGE_UPDATE_IN_PROGRESS = "STREAMING_IMAGE_UPDATE_IN_PROGRESS",
}
/**
* <p>Represents a streaming image resource.</p>
* <p>Streaming images are used by studio users to select which operating system and
* software they want to use in a Nimble Studio streaming session.</p>
* <p>Amazon provides a number of streaming images that include popular 3rd-party
* software.</p>
* <p>You can create your own streaming images using an Amazon EC2 machine image
* that you create for this purpose. You can also include software that your users
* require.</p>
*/
export interface StreamingImage {
/**
* <p>The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely
* identifies it. ARNs are unique across all Regions.</p>
*/
arn?: string;
/**
* <p>A human-readable description of the streaming image.</p>
*/
description?: string;
/**
* <p>The ID of an EC2 machine image with which to create the streaming image.</p>
*/
ec2ImageId?: string;
/**
* <p>The encryption configuration.</p>
*/
encryptionConfiguration?: StreamingImageEncryptionConfiguration;