File: types.go

package info (click to toggle)
golang-github-aws-aws-sdk-go-v2 1.24.1-2~bpo12%2B1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-backports
  • size: 554,032 kB
  • sloc: java: 15,941; makefile: 419; sh: 175
file content (1116 lines) | stat: -rw-r--r-- 35,932 bytes parent folder | download
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
// Code generated by smithy-go-codegen DO NOT EDIT.

package types

import (
	smithydocument "github.com/aws/smithy-go/document"
	"time"
)

// An LDAP attribute of an Active Directory computer account, in the form of a
// name:value pair.
type ActiveDirectoryComputerAttribute struct {

	// The name for the LDAP attribute.
	Name *string

	// The value for the LDAP attribute.
	Value *string

	noSmithyDocumentSerde
}

// The configuration for a Directory Service for Microsoft Active Directory studio
// resource.
type ActiveDirectoryConfiguration struct {

	// A collection of custom attributes for an Active Directory computer.
	ComputerAttributes []ActiveDirectoryComputerAttribute

	// The directory ID of the Directory Service for Microsoft Active Directory to
	// access using this studio component.
	DirectoryId *string

	// The distinguished name (DN) and organizational unit (OU) of an Active Directory
	// computer.
	OrganizationalUnitDistinguishedName *string

	noSmithyDocumentSerde
}

// The configuration for a render farm that is associated with a studio resource.
type ComputeFarmConfiguration struct {

	// The name of an Active Directory user that is used on ComputeFarm worker
	// instances.
	ActiveDirectoryUser *string

	// The endpoint of the ComputeFarm that is accessed by the studio component
	// resource.
	Endpoint *string

	noSmithyDocumentSerde
}

// Represents a EULA resource.
type Eula struct {

	// The EULA content.
	Content *string

	// The ISO timestamp in seconds for when the resource was created.
	CreatedAt *time.Time

	// The EULA ID.
	EulaId *string

	// The name for the EULA.
	Name *string

	// The ISO timestamp in seconds for when the resource was updated.
	UpdatedAt *time.Time

	noSmithyDocumentSerde
}

// The acceptance of a EULA, required to use Amazon-provided streaming images.
type EulaAcceptance struct {

	// The ISO timestamp in seconds for when the EULA was accepted.
	AcceptedAt *time.Time

	// The ID of the person who accepted the EULA.
	AcceptedBy *string

	// The ID of the acceptee.
	AccepteeId *string

	// The EULA acceptance ID.
	EulaAcceptanceId *string

	// The EULA ID.
	EulaId *string

	noSmithyDocumentSerde
}

// 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). 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.
type LaunchProfile struct {

	// The Amazon Resource Name (ARN) that is assigned to a studio resource and
	// uniquely identifies it. ARNs are unique across all Regions.
	Arn *string

	// The ISO timestamp in seconds for when the resource was created.
	CreatedAt *time.Time

	// The user ID of the user that created the launch profile.
	CreatedBy *string

	// A human-readable description of the launch profile.
	Description *string

	// Unique identifiers for a collection of EC2 subnets.
	Ec2SubnetIds []string

	// The ID of the launch profile used to control access from the streaming session.
	LaunchProfileId *string

	// The version number of the protocol that is used by the launch profile. The only
	// valid version is "2021-03-31".
	LaunchProfileProtocolVersions []string

	// A friendly name for the launch profile.
	Name *string

	// The current state.
	State LaunchProfileState

	// The status code.
	StatusCode LaunchProfileStatusCode

	// The status message for the launch profile.
	StatusMessage *string

	// A configuration for a streaming session.
	StreamConfiguration *StreamConfiguration

	// Unique identifiers for a collection of studio components that can be used with
	// this launch profile.
	StudioComponentIds []string

	// A collection of labels, in the form of key-value pairs, that apply to this
	// resource.
	Tags map[string]string

	// The ISO timestamp in seconds for when the resource was updated.
	UpdatedAt *time.Time

	// The user ID of the user that most recently updated the resource.
	UpdatedBy *string

	// The list of the latest validation results.
	ValidationResults []ValidationResult

	noSmithyDocumentSerde
}

// A launch profile initialization contains information required for a workstation
// or server to connect to a launch profile. This includes scripts, endpoints,
// security groups, subnets, and other configuration.
type LaunchProfileInitialization struct {

	// A LaunchProfileInitializationActiveDirectory resource.
	ActiveDirectory *LaunchProfileInitializationActiveDirectory

	// The EC2 security groups that control access to the studio component.
	Ec2SecurityGroupIds []string

	// The ID of the launch profile used to control access from the streaming session.
	LaunchProfileId *string

	// The version number of the protocol that is used by the launch profile. The only
	// valid version is "2021-03-31".
	LaunchProfileProtocolVersion *string

	// The launch purpose.
	LaunchPurpose *string

	// The name for the launch profile.
	Name *string

	// The platform of the launch platform, either Windows or Linux.
	Platform LaunchProfilePlatform

	// The system initializtion scripts.
	SystemInitializationScripts []LaunchProfileInitializationScript

	// The user initializtion scripts.
	UserInitializationScripts []LaunchProfileInitializationScript

	noSmithyDocumentSerde
}

// The launch profile initialization Active Directory contains information
// required for the launch profile to connect to the Active Directory.
type LaunchProfileInitializationActiveDirectory struct {

	// A collection of custom attributes for an Active Directory computer.
	ComputerAttributes []ActiveDirectoryComputerAttribute

	// The directory ID of the Directory Service for Microsoft Active Directory to
	// access using this launch profile.
	DirectoryId *string

	// The directory name.
	DirectoryName *string

	// The DNS IP address.
	DnsIpAddresses []string

	// The name for the organizational unit distinguished name.
	OrganizationalUnitDistinguishedName *string

	// The unique identifier for a studio component resource.
	StudioComponentId *string

	// The name for the studio component.
	StudioComponentName *string

	noSmithyDocumentSerde
}

// The launch profile initialization script is used when start streaming session
// runs.
type LaunchProfileInitializationScript struct {

	// An IAM role attached to a Studio Component that gives the studio component
	// access to Amazon Web Services resources at anytime while the instance is
	// running.
	RuntimeRoleArn *string

	// The initialization script.
	Script *string

	// An IAM role attached to Studio Component when the system initialization script
	// runs which give the studio component access to Amazon Web Services resources
	// when the system initialization script runs.
	SecureInitializationRoleArn *string

	// The unique identifier for a studio component resource.
	StudioComponentId *string

	// The name for the studio component.
	StudioComponentName *string

	noSmithyDocumentSerde
}

// Studio admins can use launch profile membership to delegate launch profile
// access to studio users in the Nimble Studio portal without writing or
// maintaining complex IAM policies. A launch profile member is a user association
// from your studio identity source who is granted permissions to a launch profile.
// A launch profile member (type USER) provides the following permissions to that
// launch profile:
//   - GetLaunchProfile
//   - GetLaunchProfileInitialization
//   - GetLaunchProfileMembers
//   - GetLaunchProfileMember
//   - CreateStreamingSession
//   - GetLaunchProfileDetails
type LaunchProfileMembership struct {

	// The ID of the identity store.
	IdentityStoreId *string

	// The persona.
	Persona LaunchProfilePersona

	// The principal ID.
	PrincipalId *string

	// The Active Directory Security Identifier for this user, if available.
	Sid *string

	noSmithyDocumentSerde
}

// The configuration for a license service that is associated with a studio
// resource.
type LicenseServiceConfiguration struct {

	// The endpoint of the license service that is accessed by the studio component
	// resource.
	Endpoint *string

	noSmithyDocumentSerde
}

// A new member that is added to a launch profile.
type NewLaunchProfileMember struct {

	// The persona.
	//
	// This member is required.
	Persona LaunchProfilePersona

	// The principal ID.
	//
	// This member is required.
	PrincipalId *string

	noSmithyDocumentSerde
}

// A new studio user's membership.
type NewStudioMember struct {

	// The persona.
	//
	// This member is required.
	Persona StudioPersona

	// The principal ID.
	//
	// This member is required.
	PrincipalId *string

	noSmithyDocumentSerde
}

// A parameter for a studio component script, in the form of a key-value pair.
type ScriptParameterKeyValue struct {

	// A script parameter key.
	Key *string

	// A script parameter value.
	Value *string

	noSmithyDocumentSerde
}

// The configuration for a shared file storage system that is associated with a
// studio resource.
type SharedFileSystemConfiguration struct {

	// The endpoint of the shared file system that is accessed by the studio component
	// resource.
	Endpoint *string

	// The unique identifier for a file system.
	FileSystemId *string

	// The mount location for a shared file system on a Linux virtual workstation.
	LinuxMountPoint *string

	// The name of the file share.
	ShareName *string

	// The mount location for a shared file system on a Windows virtual workstation.
	WindowsMountDrive *string

	noSmithyDocumentSerde
}

// A configuration for a streaming session.
type StreamConfiguration struct {

	// Allows or deactivates the use of the system clipboard to copy and paste between
	// the streaming session and streaming client.
	//
	// This member is required.
	ClipboardMode StreamingClipboardMode

	// The EC2 instance types that users can select from when launching a streaming
	// session with this launch profile.
	//
	// This member is required.
	Ec2InstanceTypes []StreamingInstanceType

	// The streaming images that users can select from when launching a streaming
	// session with this launch profile.
	//
	// This member is required.
	StreamingImageIds []string

	// Indicates if a streaming session created from this launch profile should be
	// terminated automatically or retained without termination after being in a
	// STOPPED state.
	//   - When ACTIVATED , the streaming session is scheduled for termination after
	//   being in the STOPPED state for the time specified in
	//   maxStoppedSessionLengthInMinutes .
	//   - When DEACTIVATED , the streaming session can remain in the STOPPED state
	//   indefinitely.
	// This parameter is only allowed when sessionPersistenceMode is ACTIVATED . When
	// allowed, the default value for this parameter is DEACTIVATED .
	AutomaticTerminationMode AutomaticTerminationMode

	// 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.
	MaxSessionLengthInMinutes *int32

	// Integer that determines if you can start and stop your sessions and how long a
	// session can stay in the STOPPED state. The default value is 0. The maximum
	// value is 5760. This field is allowed only when sessionPersistenceMode is
	// ACTIVATED and automaticTerminationMode is ACTIVATED . If the value is set to 0,
	// your sessions can’t be STOPPED . If you then call StopStreamingSession , the
	// session fails. If the time that a session stays in the READY state exceeds the
	// maxSessionLengthInMinutes value, the session will automatically be terminated
	// (instead of STOPPED ). If the value is set to a positive number, the session can
	// be stopped. You can call StopStreamingSession to stop sessions in the READY
	// state. If the time that a session stays in the READY state exceeds the
	// maxSessionLengthInMinutes value, the session will automatically be stopped
	// (instead of terminated).
	MaxStoppedSessionLengthInMinutes int32

	// Information about the streaming session backup.
	SessionBackup *StreamConfigurationSessionBackup

	// Determine if a streaming session created from this launch profile can configure
	// persistent storage. This means that volumeConfiguration and
	// automaticTerminationMode are configured.
	SessionPersistenceMode SessionPersistenceMode

	// The upload storage for a streaming session.
	SessionStorage *StreamConfigurationSessionStorage

	// Custom volume configuration for the root volumes that are attached to streaming
	// sessions. This parameter is only allowed when sessionPersistenceMode is
	// ACTIVATED .
	VolumeConfiguration *VolumeConfiguration

	noSmithyDocumentSerde
}

// Configuration for streaming workstations created using this launch profile.
type StreamConfigurationCreate struct {

	// Allows or deactivates the use of the system clipboard to copy and paste between
	// the streaming session and streaming client.
	//
	// This member is required.
	ClipboardMode StreamingClipboardMode

	// The EC2 instance types that users can select from when launching a streaming
	// session with this launch profile.
	//
	// This member is required.
	Ec2InstanceTypes []StreamingInstanceType

	// The streaming images that users can select from when launching a streaming
	// session with this launch profile.
	//
	// This member is required.
	StreamingImageIds []string

	// Indicates if a streaming session created from this launch profile should be
	// terminated automatically or retained without termination after being in a
	// STOPPED state.
	//   - When ACTIVATED , the streaming session is scheduled for termination after
	//   being in the STOPPED state for the time specified in
	//   maxStoppedSessionLengthInMinutes .
	//   - When DEACTIVATED , the streaming session can remain in the STOPPED state
	//   indefinitely.
	// This parameter is only allowed when sessionPersistenceMode is ACTIVATED . When
	// allowed, the default value for this parameter is DEACTIVATED .
	AutomaticTerminationMode AutomaticTerminationMode

	// 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.
	MaxSessionLengthInMinutes *int32

	// Integer that determines if you can start and stop your sessions and how long a
	// session can stay in the STOPPED state. The default value is 0. The maximum
	// value is 5760. This field is allowed only when sessionPersistenceMode is
	// ACTIVATED and automaticTerminationMode is ACTIVATED . If the value is set to 0,
	// your sessions can’t be STOPPED . If you then call StopStreamingSession , the
	// session fails. If the time that a session stays in the READY state exceeds the
	// maxSessionLengthInMinutes value, the session will automatically be terminated
	// (instead of STOPPED ). If the value is set to a positive number, the session can
	// be stopped. You can call StopStreamingSession to stop sessions in the READY
	// state. If the time that a session stays in the READY state exceeds the
	// maxSessionLengthInMinutes value, the session will automatically be stopped
	// (instead of terminated).
	MaxStoppedSessionLengthInMinutes int32

	// Configures how streaming sessions are backed up when launched from this launch
	// profile.
	SessionBackup *StreamConfigurationSessionBackup

	// Determine if a streaming session created from this launch profile can configure
	// persistent storage. This means that volumeConfiguration and
	// automaticTerminationMode are configured.
	SessionPersistenceMode SessionPersistenceMode

	// The upload storage for a streaming workstation that is created using this
	// launch profile.
	SessionStorage *StreamConfigurationSessionStorage

	// Custom volume configuration for the root volumes that are attached to streaming
	// sessions. This parameter is only allowed when sessionPersistenceMode is
	// ACTIVATED .
	VolumeConfiguration *VolumeConfiguration

	noSmithyDocumentSerde
}

// Configures how streaming sessions are backed up when launched from this launch
// profile.
type StreamConfigurationSessionBackup struct {

	// The maximum number of backups that each streaming session created from this
	// launch profile can have.
	MaxBackupsToRetain int32

	// Specifies how artists sessions are backed up. Configures backups for streaming
	// sessions launched with this launch profile. The default value is DEACTIVATED ,
	// which means that backups are deactivated. To allow backups, set this value to
	// AUTOMATIC .
	Mode SessionBackupMode

	noSmithyDocumentSerde
}

// The configuration for a streaming session’s upload storage.
type StreamConfigurationSessionStorage struct {

	// Allows artists to upload files to their workstations. The only valid option is
	// UPLOAD .
	//
	// This member is required.
	Mode []StreamingSessionStorageMode

	// The configuration for the upload storage root of the streaming session.
	Root *StreamingSessionStorageRoot

	noSmithyDocumentSerde
}

// Represents a streaming image resource. Streaming images are used by studio
// users to select which operating system and software they want to use in a Nimble
// Studio streaming session. Amazon provides a number of streaming images that
// include popular 3rd-party software. 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.
type StreamingImage struct {

	// The Amazon Resource Name (ARN) that is assigned to a studio resource and
	// uniquely identifies it. ARNs are unique across all Regions.
	Arn *string

	// A human-readable description of the streaming image.
	Description *string

	// The ID of an EC2 machine image with which to create the streaming image.
	Ec2ImageId *string

	// The encryption configuration.
	EncryptionConfiguration *StreamingImageEncryptionConfiguration

	// The list of EULAs that must be accepted before a Streaming Session can be
	// started using this streaming image.
	EulaIds []string

	// A friendly name for a streaming image resource.
	Name *string

	// The owner of the streaming image, either the studioId that contains the
	// streaming image, or amazon for images that are provided by Amazon Nimble Studio.
	Owner *string

	// The platform of the streaming image, either Windows or Linux.
	Platform *string

	// The current state.
	State StreamingImageState

	// The status code.
	StatusCode StreamingImageStatusCode

	// The status message for the streaming image.
	StatusMessage *string

	// The ID of the streaming image.
	StreamingImageId *string

	// A collection of labels, in the form of key-value pairs, that apply to this
	// resource.
	Tags map[string]string

	noSmithyDocumentSerde
}

// Specifies how a streaming image is encrypted.
type StreamingImageEncryptionConfiguration struct {

	// The type of KMS key that is used to encrypt studio data.
	//
	// This member is required.
	KeyType StreamingImageEncryptionConfigurationKeyType

	// The ARN for a KMS key that is used to encrypt studio data.
	KeyArn *string

	noSmithyDocumentSerde
}

// A streaming session is a virtual workstation created using a particular launch
// profile.
type StreamingSession struct {

	// The Amazon Resource Name (ARN) that is assigned to a studio resource and
	// uniquely identifies it. ARNs are unique across all Regions.
	Arn *string

	// Indicates if a streaming session created from this launch profile should be
	// terminated automatically or retained without termination after being in a
	// STOPPED state.
	//   - When ACTIVATED , the streaming session is scheduled for termination after
	//   being in the STOPPED state for the time specified in
	//   maxStoppedSessionLengthInMinutes .
	//   - When DEACTIVATED , the streaming session can remain in the STOPPED state
	//   indefinitely.
	// This parameter is only allowed when sessionPersistenceMode is ACTIVATED . When
	// allowed, the default value for this parameter is DEACTIVATED .
	AutomaticTerminationMode AutomaticTerminationMode

	// Shows the current backup setting of the session.
	BackupMode SessionBackupMode

	// The ISO timestamp in seconds for when the resource was created.
	CreatedAt *time.Time

	// The user ID of the user that created the streaming session.
	CreatedBy *string

	// The EC2 Instance type used for the streaming session.
	Ec2InstanceType *string

	// The ID of the launch profile used to control access from the streaming session.
	LaunchProfileId *string

	// The maximum number of backups of a streaming session that you can have. When
	// the maximum number of backups is reached, the oldest backup is deleted.
	MaxBackupsToRetain int32

	// The user ID of the user that owns the streaming session. The user that owns the
	// session will be logging into the session and interacting with the virtual
	// workstation.
	OwnedBy *string

	// The session ID.
	SessionId *string

	// Determine if a streaming session created from this launch profile can configure
	// persistent storage. This means that volumeConfiguration and
	// automaticTerminationMode are configured.
	SessionPersistenceMode SessionPersistenceMode

	// The time the session entered START_IN_PROGRESS state.
	StartedAt *time.Time

	// The user ID of the user that started the streaming session.
	StartedBy *string

	// The backup ID used to restore a streaming session.
	StartedFromBackupId *string

	// The current state.
	State StreamingSessionState

	// The status code.
	StatusCode StreamingSessionStatusCode

	// The status message for the streaming session.
	StatusMessage *string

	// The time the streaming session will automatically be stopped if the user
	// doesn’t stop the session themselves.
	StopAt *time.Time

	// The time the session entered STOP_IN_PROGRESS state.
	StoppedAt *time.Time

	// The user ID of the user that stopped the streaming session.
	StoppedBy *string

	// The ID of the streaming image.
	StreamingImageId *string

	// A collection of labels, in the form of key-value pairs, that apply to this
	// resource.
	Tags map[string]string

	// The time the streaming session will automatically terminate if not terminated
	// by the user.
	TerminateAt *time.Time

	// The ISO timestamp in seconds for when the resource was updated.
	UpdatedAt *time.Time

	// The user ID of the user that most recently updated the resource.
	UpdatedBy *string

	// Custom volume configuration for the root volumes that are attached to streaming
	// sessions. This parameter is only allowed when sessionPersistenceMode is
	// ACTIVATED .
	VolumeConfiguration *VolumeConfiguration

	// Determine if an EBS volume created from this streaming session will be backed
	// up.
	VolumeRetentionMode VolumeRetentionMode

	noSmithyDocumentSerde
}

// Information about the streaming session backup.
type StreamingSessionBackup struct {

	// The Amazon Resource Name (ARN) that is assigned to a studio resource and
	// uniquely identifies it. ARNs are unique across all Regions.
	Arn *string

	// The ID of the backup.
	BackupId *string

	// The ISO timestamp in for when the resource was created.
	CreatedAt *time.Time

	// The ID of the launch profile which allowed the backups for the streaming
	// session.
	LaunchProfileId *string

	// The user ID of the user that owns the streaming session.
	OwnedBy *string

	// The streaming session ID for the StreamingSessionBackup .
	SessionId *string

	// The streaming session state.
	State StreamingSessionState

	// The status code.
	StatusCode StreamingSessionStatusCode

	// The status message for the streaming session backup.
	StatusMessage *string

	// A collection of labels, in the form of key-value pairs, that apply to this
	// resource.
	Tags map[string]string

	noSmithyDocumentSerde
}

// The upload storage root location (folder) on streaming workstations where files
// are uploaded.
type StreamingSessionStorageRoot struct {

	// The folder path in Linux workstations where files are uploaded.
	Linux *string

	// The folder path in Windows workstations where files are uploaded.
	Windows *string

	noSmithyDocumentSerde
}

// A stream is an active connection to a streaming session, enabling a studio user
// to control the streaming session using a compatible client. Streaming session
// streams are compatible with the NICE DCV web client, included in the Nimble
// Studio portal, or the NICE DCV desktop client.
type StreamingSessionStream struct {

	// The ISO timestamp in seconds for when the resource was created.
	CreatedAt *time.Time

	// The user ID of the user that created the streaming session stream.
	CreatedBy *string

	// The ISO timestamp in seconds for when the resource expires.
	ExpiresAt *time.Time

	// The user ID of the user that owns the streaming session. The user that owns the
	// session will be logging into the session and interacting with the virtual
	// workstation.
	OwnedBy *string

	// The current state.
	State StreamingSessionStreamState

	// The streaming session stream status code.
	StatusCode StreamingSessionStreamStatusCode

	// The stream ID.
	StreamId *string

	// The URL to connect to this stream using the DCV client.
	Url *string

	noSmithyDocumentSerde
}

// Represents a studio resource. A studio is the core resource used with Nimble
// Studio. You must create a studio first, before any other resource type can be
// created. All other resources you create and manage in Nimble Studio are
// contained within a studio. When creating a studio, you must provides two IAM
// roles for use with the Nimble Studio portal. These roles are assumed by your
// users when they log in to the Nimble Studio portal via IAM Identity Center and
// your identity source. The user role must have the AmazonNimbleStudio-StudioUser
// managed policy attached for the portal to function properly. The admin role must
// have the AmazonNimbleStudio-StudioAdmin managed policy attached for the portal
// to function properly. Your studio roles must trust the
// identity.nimble.amazonaws.com service principal to function properly.
type Studio struct {

	// The IAM role that studio admins assume when logging in to the Nimble Studio
	// portal.
	AdminRoleArn *string

	// The Amazon Resource Name (ARN) that is assigned to a studio resource and
	// uniquely identifies it. ARNs are unique across all Regions.
	Arn *string

	// The ISO timestamp in seconds for when the resource was created.
	CreatedAt *time.Time

	// A friendly name for the studio.
	DisplayName *string

	// The Amazon Web Services Region where the studio resource is located.
	HomeRegion *string

	// The IAM Identity Center application client ID used to integrate with IAM
	// Identity Center. This ID allows IAM Identity Center users to log in to Nimble
	// Studio portal.
	SsoClientId *string

	// The current state of the studio resource.
	State StudioState

	// Status codes that provide additional detail on the studio state.
	StatusCode StudioStatusCode

	// Additional detail on the studio state.
	StatusMessage *string

	// Configuration of the encryption method that is used for the studio.
	StudioEncryptionConfiguration *StudioEncryptionConfiguration

	// The unique identifier for a studio resource. In Nimble Studio, all other
	// resources are contained in a studio resource.
	StudioId *string

	// The name of the studio, as included in the URL when accessing it in the Nimble
	// Studio portal.
	StudioName *string

	// The address of the web page for the studio.
	StudioUrl *string

	// A collection of labels, in the form of key-value pairs, that apply to this
	// resource.
	Tags map[string]string

	// The ISO timestamp in seconds for when the resource was updated.
	UpdatedAt *time.Time

	// The IAM role that studio users assume when logging in to the Nimble Studio
	// portal.
	UserRoleArn *string

	noSmithyDocumentSerde
}

// A studio component represents a network resource to be used by a studio's users
// and workflows. A typical studio contains studio components for each of the
// following: render farm, Active Directory, licensing, and file system. Access to
// a studio component is managed by specifying security groups for the resource, as
// well as its endpoint. A studio component also has a set of initialization
// scripts that are returned by GetLaunchProfileInitialization . These
// initialization scripts run on streaming sessions when they start. They provide
// users with flexibility in controlling how the studio resources are configured on
// a streaming session.
type StudioComponent struct {

	// The Amazon Resource Name (ARN) that is assigned to a studio resource and
	// uniquely identifies it. ARNs are unique across all Regions.
	Arn *string

	// The configuration of the studio component, based on component type.
	Configuration *StudioComponentConfiguration

	// The ISO timestamp in seconds for when the resource was created.
	CreatedAt *time.Time

	// The user ID of the user that created the studio component.
	CreatedBy *string

	// A human-readable description for the studio component resource.
	Description *string

	// The EC2 security groups that control access to the studio component.
	Ec2SecurityGroupIds []string

	// Initialization scripts for studio components.
	InitializationScripts []StudioComponentInitializationScript

	// A friendly name for the studio component resource.
	Name *string

	// An IAM role attached to a Studio Component that gives the studio component
	// access to Amazon Web Services resources at anytime while the instance is
	// running.
	RuntimeRoleArn *string

	// Parameters for the studio component scripts.
	ScriptParameters []ScriptParameterKeyValue

	// An IAM role attached to Studio Component when the system initialization script
	// runs which give the studio component access to Amazon Web Services resources
	// when the system initialization script runs.
	SecureInitializationRoleArn *string

	// The current state.
	State StudioComponentState

	// The status code.
	StatusCode StudioComponentStatusCode

	// The status message for the studio component.
	StatusMessage *string

	// The unique identifier for a studio component resource.
	StudioComponentId *string

	// The specific subtype of a studio component.
	Subtype StudioComponentSubtype

	// A collection of labels, in the form of key-value pairs, that apply to this
	// resource.
	Tags map[string]string

	// The type of the studio component.
	Type StudioComponentType

	// The ISO timestamp in seconds for when the resource was updated.
	UpdatedAt *time.Time

	// The user ID of the user that most recently updated the resource.
	UpdatedBy *string

	noSmithyDocumentSerde
}

// The configuration of the studio component, based on component type.
type StudioComponentConfiguration struct {

	// The configuration for a Directory Service for Microsoft Active Directory studio
	// resource.
	ActiveDirectoryConfiguration *ActiveDirectoryConfiguration

	// The configuration for a render farm that is associated with a studio resource.
	ComputeFarmConfiguration *ComputeFarmConfiguration

	// The configuration for a license service that is associated with a studio
	// resource.
	LicenseServiceConfiguration *LicenseServiceConfiguration

	// The configuration for a shared file storage system that is associated with a
	// studio resource.
	SharedFileSystemConfiguration *SharedFileSystemConfiguration

	noSmithyDocumentSerde
}

// Initialization scripts for studio components.
type StudioComponentInitializationScript struct {

	// The version number of the protocol that is used by the launch profile. The only
	// valid version is "2021-03-31".
	LaunchProfileProtocolVersion *string

	// The platform of the initialization script, either Windows or Linux.
	Platform LaunchProfilePlatform

	// The method to use when running the initialization script.
	RunContext StudioComponentInitializationScriptRunContext

	// The initialization script.
	Script *string

	noSmithyDocumentSerde
}

// The studio component's summary.
type StudioComponentSummary struct {

	// The ISO timestamp in seconds for when the resource was created.
	CreatedAt *time.Time

	// The user ID of the user that created the studio component.
	CreatedBy *string

	// The description.
	Description *string

	// The name for the studio component.
	Name *string

	// The unique identifier for a studio component resource.
	StudioComponentId *string

	// The specific subtype of a studio component.
	Subtype StudioComponentSubtype

	// The type of the studio component.
	Type StudioComponentType

	// The ISO timestamp in seconds for when the resource was updated.
	UpdatedAt *time.Time

	// The user ID of the user that most recently updated the resource.
	UpdatedBy *string

	noSmithyDocumentSerde
}

// Configuration of the encryption method that is used for the studio.
type StudioEncryptionConfiguration struct {

	// The type of KMS key that is used to encrypt studio data.
	//
	// This member is required.
	KeyType StudioEncryptionConfigurationKeyType

	// The ARN for a KMS key that is used to encrypt studio data.
	KeyArn *string

	noSmithyDocumentSerde
}

// A studio member is an association of a user from your studio identity source to
// elevated permissions that they are granted in the studio. When you add a user to
// your studio using the Nimble Studio console, they are given access to the
// studio's IAM Identity Center application and are given access to log in to the
// Nimble Studio portal. These users have the permissions provided by the studio's
// user IAM role and do not appear in the studio membership collection. Only studio
// admins appear in studio membership. When you add a user to studio membership
// with the ADMIN persona, upon logging in to the Nimble Studio portal, they are
// granted permissions specified by the Studio's Admin IAM role.
type StudioMembership struct {

	// The ID of the identity store.
	IdentityStoreId *string

	// The persona.
	Persona StudioPersona

	// The principal ID.
	PrincipalId *string

	// The Active Directory Security Identifier for this user, if available.
	Sid *string

	noSmithyDocumentSerde
}

// The launch profile validation result.
type ValidationResult struct {

	// The current state.
	//
	// This member is required.
	State LaunchProfileValidationState

	// The status code. This will contain the failure reason if the state is
	// VALIDATION_FAILED .
	//
	// This member is required.
	StatusCode LaunchProfileValidationStatusCode

	// The status message for the validation result.
	//
	// This member is required.
	StatusMessage *string

	// The type of the validation result.
	//
	// This member is required.
	Type LaunchProfileValidationType

	noSmithyDocumentSerde
}

// Custom volume configuration for the root volumes that are attached to streaming
// sessions. This parameter is only allowed when sessionPersistenceMode is
// ACTIVATED .
type VolumeConfiguration struct {

	// The number of I/O operations per second for the root volume that is attached to
	// streaming session.
	Iops *int32

	// The size of the root volume that is attached to the streaming session. The root
	// volume size is measured in GiBs.
	Size *int32

	// The throughput to provision for the root volume that is attached to the
	// streaming session. The throughput is measured in MiB/s.
	Throughput *int32

	noSmithyDocumentSerde
}

type noSmithyDocumentSerde = smithydocument.NoSerde