aws-sdk-nimblestudio 1.16.0 → 1.17.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-nimblestudio/client.rb +369 -122
- data/lib/aws-sdk-nimblestudio/client_api.rb +106 -1
- data/lib/aws-sdk-nimblestudio/endpoint_parameters.rb +3 -0
- data/lib/aws-sdk-nimblestudio/endpoint_provider.rb +72 -73
- data/lib/aws-sdk-nimblestudio/endpoints.rb +28 -0
- data/lib/aws-sdk-nimblestudio/plugins/endpoints.rb +4 -0
- data/lib/aws-sdk-nimblestudio/types.rb +550 -905
- data/lib/aws-sdk-nimblestudio.rb +1 -1
- metadata +2 -2
@@ -10,20 +10,11 @@
|
|
10
10
|
module Aws::NimbleStudio
|
11
11
|
module Types
|
12
12
|
|
13
|
-
# @note When making an API call, you may pass AcceptEulasRequest
|
14
|
-
# data as a hash:
|
15
|
-
#
|
16
|
-
# {
|
17
|
-
# client_token: "ClientToken",
|
18
|
-
# eula_ids: ["String"],
|
19
|
-
# studio_id: "String", # required
|
20
|
-
# }
|
21
|
-
#
|
22
13
|
# @!attribute [rw] client_token
|
23
14
|
# Unique, case-sensitive identifier that you provide to ensure the
|
24
15
|
# idempotency of the request. If you don’t specify a client token, the
|
25
|
-
#
|
26
|
-
# request to ensure idempotency.
|
16
|
+
# Amazon Web Services SDK automatically generates a client token and
|
17
|
+
# uses it for the request to ensure idempotency.
|
27
18
|
#
|
28
19
|
# **A suitable default value is auto-generated.** You should normally
|
29
20
|
# not need to pass this option.
|
@@ -87,14 +78,6 @@ module Aws::NimbleStudio
|
|
87
78
|
# An LDAP attribute of an Active Directory computer account, in the form
|
88
79
|
# of a name:value pair.
|
89
80
|
#
|
90
|
-
# @note When making an API call, you may pass ActiveDirectoryComputerAttribute
|
91
|
-
# data as a hash:
|
92
|
-
#
|
93
|
-
# {
|
94
|
-
# name: "ActiveDirectoryComputerAttributeName",
|
95
|
-
# value: "ActiveDirectoryComputerAttributeValue",
|
96
|
-
# }
|
97
|
-
#
|
98
81
|
# @!attribute [rw] name
|
99
82
|
# The name for the LDAP attribute.
|
100
83
|
# @return [String]
|
@@ -112,22 +95,8 @@ module Aws::NimbleStudio
|
|
112
95
|
include Aws::Structure
|
113
96
|
end
|
114
97
|
|
115
|
-
# The configuration for a
|
116
|
-
# studio resource.
|
117
|
-
#
|
118
|
-
# @note When making an API call, you may pass ActiveDirectoryConfiguration
|
119
|
-
# data as a hash:
|
120
|
-
#
|
121
|
-
# {
|
122
|
-
# computer_attributes: [
|
123
|
-
# {
|
124
|
-
# name: "ActiveDirectoryComputerAttributeName",
|
125
|
-
# value: "ActiveDirectoryComputerAttributeValue",
|
126
|
-
# },
|
127
|
-
# ],
|
128
|
-
# directory_id: "DirectoryId",
|
129
|
-
# organizational_unit_distinguished_name: "ActiveDirectoryOrganizationalUnitDistinguishedName",
|
130
|
-
# }
|
98
|
+
# The configuration for a Directory Service for Microsoft Active
|
99
|
+
# Directory studio resource.
|
131
100
|
#
|
132
101
|
# @!attribute [rw] computer_attributes
|
133
102
|
# A collection of custom attributes for an Active Directory computer.
|
@@ -156,14 +125,6 @@ module Aws::NimbleStudio
|
|
156
125
|
# The configuration for a render farm that is associated with a studio
|
157
126
|
# resource.
|
158
127
|
#
|
159
|
-
# @note When making an API call, you may pass ComputeFarmConfiguration
|
160
|
-
# data as a hash:
|
161
|
-
#
|
162
|
-
# {
|
163
|
-
# active_directory_user: "String",
|
164
|
-
# endpoint: "SensitiveString",
|
165
|
-
# }
|
166
|
-
#
|
167
128
|
# @!attribute [rw] active_directory_user
|
168
129
|
# The name of an Active Directory user that is used on ComputeFarm
|
169
130
|
# worker instances.
|
@@ -207,41 +168,11 @@ module Aws::NimbleStudio
|
|
207
168
|
include Aws::Structure
|
208
169
|
end
|
209
170
|
|
210
|
-
# @note When making an API call, you may pass CreateLaunchProfileRequest
|
211
|
-
# data as a hash:
|
212
|
-
#
|
213
|
-
# {
|
214
|
-
# client_token: "ClientToken",
|
215
|
-
# description: "LaunchProfileDescription",
|
216
|
-
# ec2_subnet_ids: ["EC2SubnetId"], # required
|
217
|
-
# launch_profile_protocol_versions: ["LaunchProfileProtocolVersion"], # required
|
218
|
-
# name: "LaunchProfileName", # required
|
219
|
-
# stream_configuration: { # required
|
220
|
-
# clipboard_mode: "ENABLED", # required, accepts ENABLED, DISABLED
|
221
|
-
# ec2_instance_types: ["g4dn.xlarge"], # required, accepts g4dn.xlarge, g4dn.2xlarge, g4dn.4xlarge, g4dn.8xlarge, g4dn.12xlarge, g4dn.16xlarge, g3.4xlarge, g3s.xlarge, g5.xlarge, g5.2xlarge, g5.4xlarge, g5.8xlarge, g5.16xlarge
|
222
|
-
# max_session_length_in_minutes: 1,
|
223
|
-
# max_stopped_session_length_in_minutes: 1,
|
224
|
-
# session_storage: {
|
225
|
-
# mode: ["UPLOAD"], # required, accepts UPLOAD
|
226
|
-
# root: {
|
227
|
-
# linux: "StreamingSessionStorageRootPathLinux",
|
228
|
-
# windows: "StreamingSessionStorageRootPathWindows",
|
229
|
-
# },
|
230
|
-
# },
|
231
|
-
# streaming_image_ids: ["StreamingImageId"], # required
|
232
|
-
# },
|
233
|
-
# studio_component_ids: ["String"], # required
|
234
|
-
# studio_id: "String", # required
|
235
|
-
# tags: {
|
236
|
-
# "String" => "String",
|
237
|
-
# },
|
238
|
-
# }
|
239
|
-
#
|
240
171
|
# @!attribute [rw] client_token
|
241
172
|
# Unique, case-sensitive identifier that you provide to ensure the
|
242
173
|
# idempotency of the request. If you don’t specify a client token, the
|
243
|
-
#
|
244
|
-
# request to ensure idempotency.
|
174
|
+
# Amazon Web Services SDK automatically generates a client token and
|
175
|
+
# uses it for the request to ensure idempotency.
|
245
176
|
#
|
246
177
|
# **A suitable default value is auto-generated.** You should normally
|
247
178
|
# not need to pass this option.
|
@@ -280,7 +211,7 @@ module Aws::NimbleStudio
|
|
280
211
|
# @return [String]
|
281
212
|
#
|
282
213
|
# @!attribute [rw] tags
|
283
|
-
# A collection of labels, in the form of key
|
214
|
+
# A collection of labels, in the form of key-value pairs, that apply
|
284
215
|
# to this resource.
|
285
216
|
# @return [Hash<String,String>]
|
286
217
|
#
|
@@ -312,25 +243,11 @@ module Aws::NimbleStudio
|
|
312
243
|
include Aws::Structure
|
313
244
|
end
|
314
245
|
|
315
|
-
# @note When making an API call, you may pass CreateStreamingImageRequest
|
316
|
-
# data as a hash:
|
317
|
-
#
|
318
|
-
# {
|
319
|
-
# client_token: "ClientToken",
|
320
|
-
# description: "StreamingImageDescription",
|
321
|
-
# ec2_image_id: "EC2ImageId", # required
|
322
|
-
# name: "StreamingImageName", # required
|
323
|
-
# studio_id: "String", # required
|
324
|
-
# tags: {
|
325
|
-
# "String" => "String",
|
326
|
-
# },
|
327
|
-
# }
|
328
|
-
#
|
329
246
|
# @!attribute [rw] client_token
|
330
247
|
# Unique, case-sensitive identifier that you provide to ensure the
|
331
248
|
# idempotency of the request. If you don’t specify a client token, the
|
332
|
-
#
|
333
|
-
# request to ensure idempotency.
|
249
|
+
# Amazon Web Services SDK automatically generates a client token and
|
250
|
+
# uses it for the request to ensure idempotency.
|
334
251
|
#
|
335
252
|
# **A suitable default value is auto-generated.** You should normally
|
336
253
|
# not need to pass this option.
|
@@ -354,7 +271,7 @@ module Aws::NimbleStudio
|
|
354
271
|
# @return [String]
|
355
272
|
#
|
356
273
|
# @!attribute [rw] tags
|
357
|
-
# A collection of labels, in the form of key
|
274
|
+
# A collection of labels, in the form of key-value pairs, that apply
|
358
275
|
# to this resource.
|
359
276
|
# @return [Hash<String,String>]
|
360
277
|
#
|
@@ -383,26 +300,11 @@ module Aws::NimbleStudio
|
|
383
300
|
include Aws::Structure
|
384
301
|
end
|
385
302
|
|
386
|
-
# @note When making an API call, you may pass CreateStreamingSessionRequest
|
387
|
-
# data as a hash:
|
388
|
-
#
|
389
|
-
# {
|
390
|
-
# client_token: "ClientToken",
|
391
|
-
# ec2_instance_type: "g4dn.xlarge", # accepts g4dn.xlarge, g4dn.2xlarge, g4dn.4xlarge, g4dn.8xlarge, g4dn.12xlarge, g4dn.16xlarge, g3.4xlarge, g3s.xlarge, g5.xlarge, g5.2xlarge, g5.4xlarge, g5.8xlarge, g5.16xlarge
|
392
|
-
# launch_profile_id: "String",
|
393
|
-
# owned_by: "String",
|
394
|
-
# streaming_image_id: "StreamingImageId",
|
395
|
-
# studio_id: "String", # required
|
396
|
-
# tags: {
|
397
|
-
# "String" => "String",
|
398
|
-
# },
|
399
|
-
# }
|
400
|
-
#
|
401
303
|
# @!attribute [rw] client_token
|
402
304
|
# Unique, case-sensitive identifier that you provide to ensure the
|
403
305
|
# idempotency of the request. If you don’t specify a client token, the
|
404
|
-
#
|
405
|
-
# request to ensure idempotency.
|
306
|
+
# Amazon Web Services SDK automatically generates a client token and
|
307
|
+
# uses it for the request to ensure idempotency.
|
406
308
|
#
|
407
309
|
# **A suitable default value is auto-generated.** You should normally
|
408
310
|
# not need to pass this option.
|
@@ -413,7 +315,8 @@ module Aws::NimbleStudio
|
|
413
315
|
# @return [String]
|
414
316
|
#
|
415
317
|
# @!attribute [rw] launch_profile_id
|
416
|
-
# The launch profile
|
318
|
+
# The ID of the launch profile used to control access from the
|
319
|
+
# streaming session.
|
417
320
|
# @return [String]
|
418
321
|
#
|
419
322
|
# @!attribute [rw] owned_by
|
@@ -431,7 +334,7 @@ module Aws::NimbleStudio
|
|
431
334
|
# @return [String]
|
432
335
|
#
|
433
336
|
# @!attribute [rw] tags
|
434
|
-
# A collection of labels, in the form of key
|
337
|
+
# A collection of labels, in the form of key-value pairs, that apply
|
435
338
|
# to this resource.
|
436
339
|
# @return [Hash<String,String>]
|
437
340
|
#
|
@@ -461,21 +364,11 @@ module Aws::NimbleStudio
|
|
461
364
|
include Aws::Structure
|
462
365
|
end
|
463
366
|
|
464
|
-
# @note When making an API call, you may pass CreateStreamingSessionStreamRequest
|
465
|
-
# data as a hash:
|
466
|
-
#
|
467
|
-
# {
|
468
|
-
# client_token: "ClientToken",
|
469
|
-
# expiration_in_seconds: 1,
|
470
|
-
# session_id: "String", # required
|
471
|
-
# studio_id: "String", # required
|
472
|
-
# }
|
473
|
-
#
|
474
367
|
# @!attribute [rw] client_token
|
475
368
|
# Unique, case-sensitive identifier that you provide to ensure the
|
476
369
|
# idempotency of the request. If you don’t specify a client token, the
|
477
|
-
#
|
478
|
-
# request to ensure idempotency.
|
370
|
+
# Amazon Web Services SDK automatically generates a client token and
|
371
|
+
# uses it for the request to ensure idempotency.
|
479
372
|
#
|
480
373
|
# **A suitable default value is auto-generated.** You should normally
|
481
374
|
# not need to pass this option.
|
@@ -516,69 +409,11 @@ module Aws::NimbleStudio
|
|
516
409
|
include Aws::Structure
|
517
410
|
end
|
518
411
|
|
519
|
-
# @note When making an API call, you may pass CreateStudioComponentRequest
|
520
|
-
# data as a hash:
|
521
|
-
#
|
522
|
-
# {
|
523
|
-
# client_token: "ClientToken",
|
524
|
-
# configuration: {
|
525
|
-
# active_directory_configuration: {
|
526
|
-
# computer_attributes: [
|
527
|
-
# {
|
528
|
-
# name: "ActiveDirectoryComputerAttributeName",
|
529
|
-
# value: "ActiveDirectoryComputerAttributeValue",
|
530
|
-
# },
|
531
|
-
# ],
|
532
|
-
# directory_id: "DirectoryId",
|
533
|
-
# organizational_unit_distinguished_name: "ActiveDirectoryOrganizationalUnitDistinguishedName",
|
534
|
-
# },
|
535
|
-
# compute_farm_configuration: {
|
536
|
-
# active_directory_user: "String",
|
537
|
-
# endpoint: "SensitiveString",
|
538
|
-
# },
|
539
|
-
# license_service_configuration: {
|
540
|
-
# endpoint: "SensitiveString",
|
541
|
-
# },
|
542
|
-
# shared_file_system_configuration: {
|
543
|
-
# endpoint: "SensitiveString",
|
544
|
-
# file_system_id: "String",
|
545
|
-
# linux_mount_point: "LinuxMountPoint",
|
546
|
-
# share_name: "SensitiveString",
|
547
|
-
# windows_mount_drive: "WindowsMountDrive",
|
548
|
-
# },
|
549
|
-
# },
|
550
|
-
# description: "StudioComponentDescription",
|
551
|
-
# ec2_security_group_ids: ["SecurityGroupId"],
|
552
|
-
# initialization_scripts: [
|
553
|
-
# {
|
554
|
-
# launch_profile_protocol_version: "LaunchProfileProtocolVersion",
|
555
|
-
# platform: "LINUX", # accepts LINUX, WINDOWS
|
556
|
-
# run_context: "SYSTEM_INITIALIZATION", # accepts SYSTEM_INITIALIZATION, USER_INITIALIZATION
|
557
|
-
# script: "StudioComponentInitializationScriptContent",
|
558
|
-
# },
|
559
|
-
# ],
|
560
|
-
# name: "StudioComponentName", # required
|
561
|
-
# runtime_role_arn: "RoleArn",
|
562
|
-
# script_parameters: [
|
563
|
-
# {
|
564
|
-
# key: "ScriptParameterKey",
|
565
|
-
# value: "ScriptParameterValue",
|
566
|
-
# },
|
567
|
-
# ],
|
568
|
-
# secure_initialization_role_arn: "RoleArn",
|
569
|
-
# studio_id: "String", # required
|
570
|
-
# subtype: "AWS_MANAGED_MICROSOFT_AD", # accepts AWS_MANAGED_MICROSOFT_AD, AMAZON_FSX_FOR_WINDOWS, AMAZON_FSX_FOR_LUSTRE, CUSTOM
|
571
|
-
# tags: {
|
572
|
-
# "String" => "String",
|
573
|
-
# },
|
574
|
-
# type: "ACTIVE_DIRECTORY", # required, accepts ACTIVE_DIRECTORY, SHARED_FILE_SYSTEM, COMPUTE_FARM, LICENSE_SERVICE, CUSTOM
|
575
|
-
# }
|
576
|
-
#
|
577
412
|
# @!attribute [rw] client_token
|
578
413
|
# Unique, case-sensitive identifier that you provide to ensure the
|
579
414
|
# idempotency of the request. If you don’t specify a client token, the
|
580
|
-
#
|
581
|
-
# request to ensure idempotency.
|
415
|
+
# Amazon Web Services SDK automatically generates a client token and
|
416
|
+
# uses it for the request to ensure idempotency.
|
582
417
|
#
|
583
418
|
# **A suitable default value is auto-generated.** You should normally
|
584
419
|
# not need to pass this option.
|
@@ -606,8 +441,8 @@ module Aws::NimbleStudio
|
|
606
441
|
#
|
607
442
|
# @!attribute [rw] runtime_role_arn
|
608
443
|
# An IAM role attached to a Studio Component that gives the studio
|
609
|
-
# component access to
|
610
|
-
# running.
|
444
|
+
# component access to Amazon Web Services resources at anytime while
|
445
|
+
# the instance is running.
|
611
446
|
# @return [String]
|
612
447
|
#
|
613
448
|
# @!attribute [rw] script_parameters
|
@@ -617,7 +452,8 @@ module Aws::NimbleStudio
|
|
617
452
|
# @!attribute [rw] secure_initialization_role_arn
|
618
453
|
# An IAM role attached to Studio Component when the system
|
619
454
|
# initialization script runs which give the studio component access to
|
620
|
-
#
|
455
|
+
# Amazon Web Services resources when the system initialization script
|
456
|
+
# runs.
|
621
457
|
# @return [String]
|
622
458
|
#
|
623
459
|
# @!attribute [rw] studio_id
|
@@ -629,7 +465,7 @@ module Aws::NimbleStudio
|
|
629
465
|
# @return [String]
|
630
466
|
#
|
631
467
|
# @!attribute [rw] tags
|
632
|
-
# A collection of labels, in the form of key
|
468
|
+
# A collection of labels, in the form of key-value pairs, that apply
|
633
469
|
# to this resource.
|
634
470
|
# @return [Hash<String,String>]
|
635
471
|
#
|
@@ -669,34 +505,16 @@ module Aws::NimbleStudio
|
|
669
505
|
include Aws::Structure
|
670
506
|
end
|
671
507
|
|
672
|
-
# @note When making an API call, you may pass CreateStudioRequest
|
673
|
-
# data as a hash:
|
674
|
-
#
|
675
|
-
# {
|
676
|
-
# admin_role_arn: "RoleArn", # required
|
677
|
-
# client_token: "ClientToken",
|
678
|
-
# display_name: "StudioDisplayName", # required
|
679
|
-
# studio_encryption_configuration: {
|
680
|
-
# key_arn: "StudioEncryptionConfigurationKeyArn",
|
681
|
-
# key_type: "AWS_OWNED_KEY", # required, accepts AWS_OWNED_KEY, CUSTOMER_MANAGED_KEY
|
682
|
-
# },
|
683
|
-
# studio_name: "StudioName", # required
|
684
|
-
# tags: {
|
685
|
-
# "String" => "String",
|
686
|
-
# },
|
687
|
-
# user_role_arn: "RoleArn", # required
|
688
|
-
# }
|
689
|
-
#
|
690
508
|
# @!attribute [rw] admin_role_arn
|
691
|
-
# The IAM role that
|
509
|
+
# The IAM role that studio admins will assume when logging in to the
|
692
510
|
# Nimble Studio portal.
|
693
511
|
# @return [String]
|
694
512
|
#
|
695
513
|
# @!attribute [rw] client_token
|
696
514
|
# Unique, case-sensitive identifier that you provide to ensure the
|
697
515
|
# idempotency of the request. If you don’t specify a client token, the
|
698
|
-
#
|
699
|
-
# request to ensure idempotency.
|
516
|
+
# Amazon Web Services SDK automatically generates a client token and
|
517
|
+
# uses it for the request to ensure idempotency.
|
700
518
|
#
|
701
519
|
# **A suitable default value is auto-generated.** You should normally
|
702
520
|
# not need to pass this option.
|
@@ -716,12 +534,12 @@ module Aws::NimbleStudio
|
|
716
534
|
# @return [String]
|
717
535
|
#
|
718
536
|
# @!attribute [rw] tags
|
719
|
-
# A collection of labels, in the form of key
|
537
|
+
# A collection of labels, in the form of key-value pairs, that apply
|
720
538
|
# to this resource.
|
721
539
|
# @return [Hash<String,String>]
|
722
540
|
#
|
723
541
|
# @!attribute [rw] user_role_arn
|
724
|
-
# The IAM role that
|
542
|
+
# The IAM role that studio users will assume when logging in to the
|
725
543
|
# Nimble Studio portal.
|
726
544
|
# @return [String]
|
727
545
|
#
|
@@ -751,28 +569,19 @@ module Aws::NimbleStudio
|
|
751
569
|
include Aws::Structure
|
752
570
|
end
|
753
571
|
|
754
|
-
# @note When making an API call, you may pass DeleteLaunchProfileMemberRequest
|
755
|
-
# data as a hash:
|
756
|
-
#
|
757
|
-
# {
|
758
|
-
# client_token: "ClientToken",
|
759
|
-
# launch_profile_id: "String", # required
|
760
|
-
# principal_id: "String", # required
|
761
|
-
# studio_id: "String", # required
|
762
|
-
# }
|
763
|
-
#
|
764
572
|
# @!attribute [rw] client_token
|
765
573
|
# Unique, case-sensitive identifier that you provide to ensure the
|
766
574
|
# idempotency of the request. If you don’t specify a client token, the
|
767
|
-
#
|
768
|
-
# request to ensure idempotency.
|
575
|
+
# Amazon Web Services SDK automatically generates a client token and
|
576
|
+
# uses it for the request to ensure idempotency.
|
769
577
|
#
|
770
578
|
# **A suitable default value is auto-generated.** You should normally
|
771
579
|
# not need to pass this option.
|
772
580
|
# @return [String]
|
773
581
|
#
|
774
582
|
# @!attribute [rw] launch_profile_id
|
775
|
-
# The
|
583
|
+
# The ID of the launch profile used to control access from the
|
584
|
+
# streaming session.
|
776
585
|
# @return [String]
|
777
586
|
#
|
778
587
|
# @!attribute [rw] principal_id
|
@@ -799,27 +608,19 @@ module Aws::NimbleStudio
|
|
799
608
|
#
|
800
609
|
class DeleteLaunchProfileMemberResponse < Aws::EmptyStructure; end
|
801
610
|
|
802
|
-
# @note When making an API call, you may pass DeleteLaunchProfileRequest
|
803
|
-
# data as a hash:
|
804
|
-
#
|
805
|
-
# {
|
806
|
-
# client_token: "ClientToken",
|
807
|
-
# launch_profile_id: "String", # required
|
808
|
-
# studio_id: "String", # required
|
809
|
-
# }
|
810
|
-
#
|
811
611
|
# @!attribute [rw] client_token
|
812
612
|
# Unique, case-sensitive identifier that you provide to ensure the
|
813
613
|
# idempotency of the request. If you don’t specify a client token, the
|
814
|
-
#
|
815
|
-
# request to ensure idempotency.
|
614
|
+
# Amazon Web Services SDK automatically generates a client token and
|
615
|
+
# uses it for the request to ensure idempotency.
|
816
616
|
#
|
817
617
|
# **A suitable default value is auto-generated.** You should normally
|
818
618
|
# not need to pass this option.
|
819
619
|
# @return [String]
|
820
620
|
#
|
821
621
|
# @!attribute [rw] launch_profile_id
|
822
|
-
# The
|
622
|
+
# The ID of the launch profile used to control access from the
|
623
|
+
# streaming session.
|
823
624
|
# @return [String]
|
824
625
|
#
|
825
626
|
# @!attribute [rw] studio_id
|
@@ -848,20 +649,11 @@ module Aws::NimbleStudio
|
|
848
649
|
include Aws::Structure
|
849
650
|
end
|
850
651
|
|
851
|
-
# @note When making an API call, you may pass DeleteStreamingImageRequest
|
852
|
-
# data as a hash:
|
853
|
-
#
|
854
|
-
# {
|
855
|
-
# client_token: "ClientToken",
|
856
|
-
# streaming_image_id: "String", # required
|
857
|
-
# studio_id: "String", # required
|
858
|
-
# }
|
859
|
-
#
|
860
652
|
# @!attribute [rw] client_token
|
861
653
|
# Unique, case-sensitive identifier that you provide to ensure the
|
862
654
|
# idempotency of the request. If you don’t specify a client token, the
|
863
|
-
#
|
864
|
-
# request to ensure idempotency.
|
655
|
+
# Amazon Web Services SDK automatically generates a client token and
|
656
|
+
# uses it for the request to ensure idempotency.
|
865
657
|
#
|
866
658
|
# **A suitable default value is auto-generated.** You should normally
|
867
659
|
# not need to pass this option.
|
@@ -897,20 +689,11 @@ module Aws::NimbleStudio
|
|
897
689
|
include Aws::Structure
|
898
690
|
end
|
899
691
|
|
900
|
-
# @note When making an API call, you may pass DeleteStreamingSessionRequest
|
901
|
-
# data as a hash:
|
902
|
-
#
|
903
|
-
# {
|
904
|
-
# client_token: "ClientToken",
|
905
|
-
# session_id: "String", # required
|
906
|
-
# studio_id: "String", # required
|
907
|
-
# }
|
908
|
-
#
|
909
692
|
# @!attribute [rw] client_token
|
910
693
|
# Unique, case-sensitive identifier that you provide to ensure the
|
911
694
|
# idempotency of the request. If you don’t specify a client token, the
|
912
|
-
#
|
913
|
-
# request to ensure idempotency.
|
695
|
+
# Amazon Web Services SDK automatically generates a client token and
|
696
|
+
# uses it for the request to ensure idempotency.
|
914
697
|
#
|
915
698
|
# **A suitable default value is auto-generated.** You should normally
|
916
699
|
# not need to pass this option.
|
@@ -946,20 +729,11 @@ module Aws::NimbleStudio
|
|
946
729
|
include Aws::Structure
|
947
730
|
end
|
948
731
|
|
949
|
-
# @note When making an API call, you may pass DeleteStudioComponentRequest
|
950
|
-
# data as a hash:
|
951
|
-
#
|
952
|
-
# {
|
953
|
-
# client_token: "ClientToken",
|
954
|
-
# studio_component_id: "String", # required
|
955
|
-
# studio_id: "String", # required
|
956
|
-
# }
|
957
|
-
#
|
958
732
|
# @!attribute [rw] client_token
|
959
733
|
# Unique, case-sensitive identifier that you provide to ensure the
|
960
734
|
# idempotency of the request. If you don’t specify a client token, the
|
961
|
-
#
|
962
|
-
# request to ensure idempotency.
|
735
|
+
# Amazon Web Services SDK automatically generates a client token and
|
736
|
+
# uses it for the request to ensure idempotency.
|
963
737
|
#
|
964
738
|
# **A suitable default value is auto-generated.** You should normally
|
965
739
|
# not need to pass this option.
|
@@ -995,20 +769,11 @@ module Aws::NimbleStudio
|
|
995
769
|
include Aws::Structure
|
996
770
|
end
|
997
771
|
|
998
|
-
# @note When making an API call, you may pass DeleteStudioMemberRequest
|
999
|
-
# data as a hash:
|
1000
|
-
#
|
1001
|
-
# {
|
1002
|
-
# client_token: "ClientToken",
|
1003
|
-
# principal_id: "String", # required
|
1004
|
-
# studio_id: "String", # required
|
1005
|
-
# }
|
1006
|
-
#
|
1007
772
|
# @!attribute [rw] client_token
|
1008
773
|
# Unique, case-sensitive identifier that you provide to ensure the
|
1009
774
|
# idempotency of the request. If you don’t specify a client token, the
|
1010
|
-
#
|
1011
|
-
# request to ensure idempotency.
|
775
|
+
# Amazon Web Services SDK automatically generates a client token and
|
776
|
+
# uses it for the request to ensure idempotency.
|
1012
777
|
#
|
1013
778
|
# **A suitable default value is auto-generated.** You should normally
|
1014
779
|
# not need to pass this option.
|
@@ -1037,19 +802,11 @@ module Aws::NimbleStudio
|
|
1037
802
|
#
|
1038
803
|
class DeleteStudioMemberResponse < Aws::EmptyStructure; end
|
1039
804
|
|
1040
|
-
# @note When making an API call, you may pass DeleteStudioRequest
|
1041
|
-
# data as a hash:
|
1042
|
-
#
|
1043
|
-
# {
|
1044
|
-
# client_token: "ClientToken",
|
1045
|
-
# studio_id: "String", # required
|
1046
|
-
# }
|
1047
|
-
#
|
1048
805
|
# @!attribute [rw] client_token
|
1049
806
|
# Unique, case-sensitive identifier that you provide to ensure the
|
1050
807
|
# idempotency of the request. If you don’t specify a client token, the
|
1051
|
-
#
|
1052
|
-
# request to ensure idempotency.
|
808
|
+
# Amazon Web Services SDK automatically generates a client token and
|
809
|
+
# uses it for the request to ensure idempotency.
|
1053
810
|
#
|
1054
811
|
# **A suitable default value is auto-generated.** You should normally
|
1055
812
|
# not need to pass this option.
|
@@ -1087,8 +844,7 @@ module Aws::NimbleStudio
|
|
1087
844
|
# @return [String]
|
1088
845
|
#
|
1089
846
|
# @!attribute [rw] created_at
|
1090
|
-
# The
|
1091
|
-
# created.
|
847
|
+
# The ISO timestamp in seconds for when the resource was created.
|
1092
848
|
# @return [Time]
|
1093
849
|
#
|
1094
850
|
# @!attribute [rw] eula_id
|
@@ -1100,8 +856,7 @@ module Aws::NimbleStudio
|
|
1100
856
|
# @return [String]
|
1101
857
|
#
|
1102
858
|
# @!attribute [rw] updated_at
|
1103
|
-
# The
|
1104
|
-
# updated.
|
859
|
+
# The ISO timestamp in seconds for when the resource was updated.
|
1105
860
|
# @return [Time]
|
1106
861
|
#
|
1107
862
|
# @see http://docs.aws.amazon.com/goto/WebAPI/nimble-2020-08-01/Eula AWS API Documentation
|
@@ -1120,7 +875,7 @@ module Aws::NimbleStudio
|
|
1120
875
|
# images.
|
1121
876
|
#
|
1122
877
|
# @!attribute [rw] accepted_at
|
1123
|
-
# The
|
878
|
+
# The ISO timestamp in seconds for when the EULA was accepted.
|
1124
879
|
# @return [Time]
|
1125
880
|
#
|
1126
881
|
# @!attribute [rw] accepted_by
|
@@ -1151,13 +906,6 @@ module Aws::NimbleStudio
|
|
1151
906
|
include Aws::Structure
|
1152
907
|
end
|
1153
908
|
|
1154
|
-
# @note When making an API call, you may pass GetEulaRequest
|
1155
|
-
# data as a hash:
|
1156
|
-
#
|
1157
|
-
# {
|
1158
|
-
# eula_id: "String", # required
|
1159
|
-
# }
|
1160
|
-
#
|
1161
909
|
# @!attribute [rw] eula_id
|
1162
910
|
# The EULA ID.
|
1163
911
|
# @return [String]
|
@@ -1182,16 +930,9 @@ module Aws::NimbleStudio
|
|
1182
930
|
include Aws::Structure
|
1183
931
|
end
|
1184
932
|
|
1185
|
-
# @note When making an API call, you may pass GetLaunchProfileDetailsRequest
|
1186
|
-
# data as a hash:
|
1187
|
-
#
|
1188
|
-
# {
|
1189
|
-
# launch_profile_id: "String", # required
|
1190
|
-
# studio_id: "String", # required
|
1191
|
-
# }
|
1192
|
-
#
|
1193
933
|
# @!attribute [rw] launch_profile_id
|
1194
|
-
# The
|
934
|
+
# The ID of the launch profile used to control access from the
|
935
|
+
# streaming session.
|
1195
936
|
# @return [String]
|
1196
937
|
#
|
1197
938
|
# @!attribute [rw] studio_id
|
@@ -1229,19 +970,9 @@ module Aws::NimbleStudio
|
|
1229
970
|
include Aws::Structure
|
1230
971
|
end
|
1231
972
|
|
1232
|
-
# @note When making an API call, you may pass GetLaunchProfileInitializationRequest
|
1233
|
-
# data as a hash:
|
1234
|
-
#
|
1235
|
-
# {
|
1236
|
-
# launch_profile_id: "String", # required
|
1237
|
-
# launch_profile_protocol_versions: ["String"], # required
|
1238
|
-
# launch_purpose: "String", # required
|
1239
|
-
# platform: "String", # required
|
1240
|
-
# studio_id: "String", # required
|
1241
|
-
# }
|
1242
|
-
#
|
1243
973
|
# @!attribute [rw] launch_profile_id
|
1244
|
-
# The
|
974
|
+
# The ID of the launch profile used to control access from the
|
975
|
+
# streaming session.
|
1245
976
|
# @return [String]
|
1246
977
|
#
|
1247
978
|
# @!attribute [rw] launch_profile_protocol_versions
|
@@ -1253,8 +984,8 @@ module Aws::NimbleStudio
|
|
1253
984
|
# @return [String]
|
1254
985
|
#
|
1255
986
|
# @!attribute [rw] platform
|
1256
|
-
# The platform where this Launch Profile will be used, either
|
1257
|
-
# or
|
987
|
+
# The platform where this Launch Profile will be used, either Windows
|
988
|
+
# or Linux.
|
1258
989
|
# @return [String]
|
1259
990
|
#
|
1260
991
|
# @!attribute [rw] studio_id
|
@@ -1285,17 +1016,9 @@ module Aws::NimbleStudio
|
|
1285
1016
|
include Aws::Structure
|
1286
1017
|
end
|
1287
1018
|
|
1288
|
-
# @note When making an API call, you may pass GetLaunchProfileMemberRequest
|
1289
|
-
# data as a hash:
|
1290
|
-
#
|
1291
|
-
# {
|
1292
|
-
# launch_profile_id: "String", # required
|
1293
|
-
# principal_id: "String", # required
|
1294
|
-
# studio_id: "String", # required
|
1295
|
-
# }
|
1296
|
-
#
|
1297
1019
|
# @!attribute [rw] launch_profile_id
|
1298
|
-
# The
|
1020
|
+
# The ID of the launch profile used to control access from the
|
1021
|
+
# streaming session.
|
1299
1022
|
# @return [String]
|
1300
1023
|
#
|
1301
1024
|
# @!attribute [rw] principal_id
|
@@ -1329,16 +1052,9 @@ module Aws::NimbleStudio
|
|
1329
1052
|
include Aws::Structure
|
1330
1053
|
end
|
1331
1054
|
|
1332
|
-
# @note When making an API call, you may pass GetLaunchProfileRequest
|
1333
|
-
# data as a hash:
|
1334
|
-
#
|
1335
|
-
# {
|
1336
|
-
# launch_profile_id: "String", # required
|
1337
|
-
# studio_id: "String", # required
|
1338
|
-
# }
|
1339
|
-
#
|
1340
1055
|
# @!attribute [rw] launch_profile_id
|
1341
|
-
# The
|
1056
|
+
# The ID of the launch profile used to control access from the
|
1057
|
+
# streaming session.
|
1342
1058
|
# @return [String]
|
1343
1059
|
#
|
1344
1060
|
# @!attribute [rw] studio_id
|
@@ -1366,14 +1082,6 @@ module Aws::NimbleStudio
|
|
1366
1082
|
include Aws::Structure
|
1367
1083
|
end
|
1368
1084
|
|
1369
|
-
# @note When making an API call, you may pass GetStreamingImageRequest
|
1370
|
-
# data as a hash:
|
1371
|
-
#
|
1372
|
-
# {
|
1373
|
-
# streaming_image_id: "String", # required
|
1374
|
-
# studio_id: "String", # required
|
1375
|
-
# }
|
1376
|
-
#
|
1377
1085
|
# @!attribute [rw] streaming_image_id
|
1378
1086
|
# The streaming image ID.
|
1379
1087
|
# @return [String]
|
@@ -1403,14 +1111,35 @@ module Aws::NimbleStudio
|
|
1403
1111
|
include Aws::Structure
|
1404
1112
|
end
|
1405
1113
|
|
1406
|
-
#
|
1407
|
-
#
|
1114
|
+
# @!attribute [rw] backup_id
|
1115
|
+
# The ID of the backup.
|
1116
|
+
# @return [String]
|
1408
1117
|
#
|
1409
|
-
#
|
1410
|
-
#
|
1411
|
-
#
|
1412
|
-
#
|
1118
|
+
# @!attribute [rw] studio_id
|
1119
|
+
# The studio ID.
|
1120
|
+
# @return [String]
|
1121
|
+
#
|
1122
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/nimble-2020-08-01/GetStreamingSessionBackupRequest AWS API Documentation
|
1123
|
+
#
|
1124
|
+
class GetStreamingSessionBackupRequest < Struct.new(
|
1125
|
+
:backup_id,
|
1126
|
+
:studio_id)
|
1127
|
+
SENSITIVE = []
|
1128
|
+
include Aws::Structure
|
1129
|
+
end
|
1130
|
+
|
1131
|
+
# @!attribute [rw] streaming_session_backup
|
1132
|
+
# Information about the streaming session backup.
|
1133
|
+
# @return [Types::StreamingSessionBackup]
|
1413
1134
|
#
|
1135
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/nimble-2020-08-01/GetStreamingSessionBackupResponse AWS API Documentation
|
1136
|
+
#
|
1137
|
+
class GetStreamingSessionBackupResponse < Struct.new(
|
1138
|
+
:streaming_session_backup)
|
1139
|
+
SENSITIVE = []
|
1140
|
+
include Aws::Structure
|
1141
|
+
end
|
1142
|
+
|
1414
1143
|
# @!attribute [rw] session_id
|
1415
1144
|
# The streaming session ID.
|
1416
1145
|
# @return [String]
|
@@ -1440,15 +1169,6 @@ module Aws::NimbleStudio
|
|
1440
1169
|
include Aws::Structure
|
1441
1170
|
end
|
1442
1171
|
|
1443
|
-
# @note When making an API call, you may pass GetStreamingSessionStreamRequest
|
1444
|
-
# data as a hash:
|
1445
|
-
#
|
1446
|
-
# {
|
1447
|
-
# session_id: "String", # required
|
1448
|
-
# stream_id: "String", # required
|
1449
|
-
# studio_id: "String", # required
|
1450
|
-
# }
|
1451
|
-
#
|
1452
1172
|
# @!attribute [rw] session_id
|
1453
1173
|
# The streaming session ID.
|
1454
1174
|
# @return [String]
|
@@ -1483,14 +1203,6 @@ module Aws::NimbleStudio
|
|
1483
1203
|
include Aws::Structure
|
1484
1204
|
end
|
1485
1205
|
|
1486
|
-
# @note When making an API call, you may pass GetStudioComponentRequest
|
1487
|
-
# data as a hash:
|
1488
|
-
#
|
1489
|
-
# {
|
1490
|
-
# studio_component_id: "String", # required
|
1491
|
-
# studio_id: "String", # required
|
1492
|
-
# }
|
1493
|
-
#
|
1494
1206
|
# @!attribute [rw] studio_component_id
|
1495
1207
|
# The studio component ID.
|
1496
1208
|
# @return [String]
|
@@ -1520,14 +1232,6 @@ module Aws::NimbleStudio
|
|
1520
1232
|
include Aws::Structure
|
1521
1233
|
end
|
1522
1234
|
|
1523
|
-
# @note When making an API call, you may pass GetStudioMemberRequest
|
1524
|
-
# data as a hash:
|
1525
|
-
#
|
1526
|
-
# {
|
1527
|
-
# principal_id: "String", # required
|
1528
|
-
# studio_id: "String", # required
|
1529
|
-
# }
|
1530
|
-
#
|
1531
1235
|
# @!attribute [rw] principal_id
|
1532
1236
|
# The principal ID. This currently supports a IAM Identity Center
|
1533
1237
|
# UserId.
|
@@ -1558,13 +1262,6 @@ module Aws::NimbleStudio
|
|
1558
1262
|
include Aws::Structure
|
1559
1263
|
end
|
1560
1264
|
|
1561
|
-
# @note When making an API call, you may pass GetStudioRequest
|
1562
|
-
# data as a hash:
|
1563
|
-
#
|
1564
|
-
# {
|
1565
|
-
# studio_id: "String", # required
|
1566
|
-
# }
|
1567
|
-
#
|
1568
1265
|
# @!attribute [rw] studio_id
|
1569
1266
|
# The studio ID.
|
1570
1267
|
# @return [String]
|
@@ -1618,15 +1315,19 @@ module Aws::NimbleStudio
|
|
1618
1315
|
# systems, and license server configurations, as well as instance types
|
1619
1316
|
# and Amazon Machine Images (AMIs).
|
1620
1317
|
#
|
1621
|
-
#
|
1318
|
+
# Studio administrators create launch profiles in the Nimble Studio
|
1319
|
+
# console. Artists can use their launch profiles to launch an instance
|
1320
|
+
# from the Nimble Studio portal. Each user’s launch profile defines how
|
1321
|
+
# they can launch a streaming session. By default, studio admins can use
|
1322
|
+
# all launch profiles.
|
1622
1323
|
#
|
1623
1324
|
# @!attribute [rw] arn
|
1624
|
-
# The ARN
|
1325
|
+
# The Amazon Resource Name (ARN) that is assigned to a studio resource
|
1326
|
+
# and uniquely identifies it. ARNs are unique across all Regions.
|
1625
1327
|
# @return [String]
|
1626
1328
|
#
|
1627
1329
|
# @!attribute [rw] created_at
|
1628
|
-
# The
|
1629
|
-
# created.
|
1330
|
+
# The ISO timestamp in seconds for when the resource was created.
|
1630
1331
|
# @return [Time]
|
1631
1332
|
#
|
1632
1333
|
# @!attribute [rw] created_by
|
@@ -1642,7 +1343,8 @@ module Aws::NimbleStudio
|
|
1642
1343
|
# @return [Array<String>]
|
1643
1344
|
#
|
1644
1345
|
# @!attribute [rw] launch_profile_id
|
1645
|
-
# The launch profile
|
1346
|
+
# The ID of the launch profile used to control access from the
|
1347
|
+
# streaming session.
|
1646
1348
|
# @return [String]
|
1647
1349
|
#
|
1648
1350
|
# @!attribute [rw] launch_profile_protocol_versions
|
@@ -1676,13 +1378,12 @@ module Aws::NimbleStudio
|
|
1676
1378
|
# @return [Array<String>]
|
1677
1379
|
#
|
1678
1380
|
# @!attribute [rw] tags
|
1679
|
-
# A collection of labels, in the form of key
|
1381
|
+
# A collection of labels, in the form of key-value pairs, that apply
|
1680
1382
|
# to this resource.
|
1681
1383
|
# @return [Hash<String,String>]
|
1682
1384
|
#
|
1683
1385
|
# @!attribute [rw] updated_at
|
1684
|
-
# The
|
1685
|
-
# updated.
|
1386
|
+
# The ISO timestamp in seconds for when the resource was updated.
|
1686
1387
|
# @return [Time]
|
1687
1388
|
#
|
1688
1389
|
# @!attribute [rw] updated_by
|
@@ -1717,14 +1418,14 @@ module Aws::NimbleStudio
|
|
1717
1418
|
include Aws::Structure
|
1718
1419
|
end
|
1719
1420
|
|
1720
|
-
# A
|
1421
|
+
# A launch profile initialization contains information required for a
|
1721
1422
|
# workstation or server to connect to a launch profile.
|
1722
1423
|
#
|
1723
1424
|
# This includes scripts, endpoints, security groups, subnets, and other
|
1724
1425
|
# configuration.
|
1725
1426
|
#
|
1726
1427
|
# @!attribute [rw] active_directory
|
1727
|
-
# A LaunchProfileInitializationActiveDirectory resource.
|
1428
|
+
# A `LaunchProfileInitializationActiveDirectory` resource.
|
1728
1429
|
# @return [Types::LaunchProfileInitializationActiveDirectory]
|
1729
1430
|
#
|
1730
1431
|
# @!attribute [rw] ec2_security_group_ids
|
@@ -1732,7 +1433,8 @@ module Aws::NimbleStudio
|
|
1732
1433
|
# @return [Array<String>]
|
1733
1434
|
#
|
1734
1435
|
# @!attribute [rw] launch_profile_id
|
1735
|
-
# The launch profile
|
1436
|
+
# The ID of the launch profile used to control access from the
|
1437
|
+
# streaming session.
|
1736
1438
|
# @return [String]
|
1737
1439
|
#
|
1738
1440
|
# @!attribute [rw] launch_profile_protocol_version
|
@@ -1749,7 +1451,7 @@ module Aws::NimbleStudio
|
|
1749
1451
|
# @return [String]
|
1750
1452
|
#
|
1751
1453
|
# @!attribute [rw] platform
|
1752
|
-
# The platform of the launch platform, either
|
1454
|
+
# The platform of the launch platform, either Windows or Linux.
|
1753
1455
|
# @return [String]
|
1754
1456
|
#
|
1755
1457
|
# @!attribute [rw] system_initialization_scripts
|
@@ -1776,7 +1478,7 @@ module Aws::NimbleStudio
|
|
1776
1478
|
include Aws::Structure
|
1777
1479
|
end
|
1778
1480
|
|
1779
|
-
# The
|
1481
|
+
# The launch profile initialization Active Directory contains
|
1780
1482
|
# information required for the launch profile to connect to the Active
|
1781
1483
|
# Directory.
|
1782
1484
|
#
|
@@ -1823,13 +1525,13 @@ module Aws::NimbleStudio
|
|
1823
1525
|
include Aws::Structure
|
1824
1526
|
end
|
1825
1527
|
|
1826
|
-
# The
|
1528
|
+
# The launch profile initialization script is used when start streaming
|
1827
1529
|
# session runs.
|
1828
1530
|
#
|
1829
1531
|
# @!attribute [rw] runtime_role_arn
|
1830
1532
|
# An IAM role attached to a Studio Component that gives the studio
|
1831
|
-
# component access to
|
1832
|
-
# running.
|
1533
|
+
# component access to Amazon Web Services resources at anytime while
|
1534
|
+
# the instance is running.
|
1833
1535
|
# @return [String]
|
1834
1536
|
#
|
1835
1537
|
# @!attribute [rw] script
|
@@ -1839,7 +1541,8 @@ module Aws::NimbleStudio
|
|
1839
1541
|
# @!attribute [rw] secure_initialization_role_arn
|
1840
1542
|
# An IAM role attached to Studio Component when the system
|
1841
1543
|
# initialization script runs which give the studio component access to
|
1842
|
-
#
|
1544
|
+
# Amazon Web Services resources when the system initialization script
|
1545
|
+
# runs.
|
1843
1546
|
# @return [String]
|
1844
1547
|
#
|
1845
1548
|
# @!attribute [rw] studio_component_id
|
@@ -1862,11 +1565,11 @@ module Aws::NimbleStudio
|
|
1862
1565
|
include Aws::Structure
|
1863
1566
|
end
|
1864
1567
|
|
1865
|
-
#
|
1866
|
-
#
|
1867
|
-
#
|
1868
|
-
#
|
1869
|
-
#
|
1568
|
+
# Studio admins can use launch profile membership to delegate launch
|
1569
|
+
# profile access to studio users in the Nimble Studio portal without
|
1570
|
+
# writing or maintaining complex IAM policies. A launch profile member
|
1571
|
+
# is a user association from your studio identity source who is granted
|
1572
|
+
# permissions to a launch profile.
|
1870
1573
|
#
|
1871
1574
|
# A launch profile member (type USER) provides the following permissions
|
1872
1575
|
# to that launch profile:
|
@@ -1914,13 +1617,6 @@ module Aws::NimbleStudio
|
|
1914
1617
|
# The configuration for a license service that is associated with a
|
1915
1618
|
# studio resource.
|
1916
1619
|
#
|
1917
|
-
# @note When making an API call, you may pass LicenseServiceConfiguration
|
1918
|
-
# data as a hash:
|
1919
|
-
#
|
1920
|
-
# {
|
1921
|
-
# endpoint: "SensitiveString",
|
1922
|
-
# }
|
1923
|
-
#
|
1924
1620
|
# @!attribute [rw] endpoint
|
1925
1621
|
# The endpoint of the license service that is accessed by the studio
|
1926
1622
|
# component resource.
|
@@ -1934,21 +1630,13 @@ module Aws::NimbleStudio
|
|
1934
1630
|
include Aws::Structure
|
1935
1631
|
end
|
1936
1632
|
|
1937
|
-
# @note When making an API call, you may pass ListEulaAcceptancesRequest
|
1938
|
-
# data as a hash:
|
1939
|
-
#
|
1940
|
-
# {
|
1941
|
-
# eula_ids: ["String"],
|
1942
|
-
# next_token: "String",
|
1943
|
-
# studio_id: "String", # required
|
1944
|
-
# }
|
1945
|
-
#
|
1946
1633
|
# @!attribute [rw] eula_ids
|
1947
1634
|
# The list of EULA IDs that have been previously accepted.
|
1948
1635
|
# @return [Array<String>]
|
1949
1636
|
#
|
1950
1637
|
# @!attribute [rw] next_token
|
1951
|
-
# The token
|
1638
|
+
# The token for the next set of results, or null if there are no more
|
1639
|
+
# results.
|
1952
1640
|
# @return [String]
|
1953
1641
|
#
|
1954
1642
|
# @!attribute [rw] studio_id
|
@@ -1983,20 +1671,13 @@ module Aws::NimbleStudio
|
|
1983
1671
|
include Aws::Structure
|
1984
1672
|
end
|
1985
1673
|
|
1986
|
-
# @note When making an API call, you may pass ListEulasRequest
|
1987
|
-
# data as a hash:
|
1988
|
-
#
|
1989
|
-
# {
|
1990
|
-
# eula_ids: ["String"],
|
1991
|
-
# next_token: "String",
|
1992
|
-
# }
|
1993
|
-
#
|
1994
1674
|
# @!attribute [rw] eula_ids
|
1995
1675
|
# The list of EULA IDs that should be returned
|
1996
1676
|
# @return [Array<String>]
|
1997
1677
|
#
|
1998
1678
|
# @!attribute [rw] next_token
|
1999
|
-
# The token
|
1679
|
+
# The token for the next set of results, or null if there are no more
|
1680
|
+
# results.
|
2000
1681
|
# @return [String]
|
2001
1682
|
#
|
2002
1683
|
# @see http://docs.aws.amazon.com/goto/WebAPI/nimble-2020-08-01/ListEulasRequest AWS API Documentation
|
@@ -2026,18 +1707,9 @@ module Aws::NimbleStudio
|
|
2026
1707
|
include Aws::Structure
|
2027
1708
|
end
|
2028
1709
|
|
2029
|
-
# @note When making an API call, you may pass ListLaunchProfileMembersRequest
|
2030
|
-
# data as a hash:
|
2031
|
-
#
|
2032
|
-
# {
|
2033
|
-
# launch_profile_id: "String", # required
|
2034
|
-
# max_results: 1,
|
2035
|
-
# next_token: "String",
|
2036
|
-
# studio_id: "String", # required
|
2037
|
-
# }
|
2038
|
-
#
|
2039
1710
|
# @!attribute [rw] launch_profile_id
|
2040
|
-
# The
|
1711
|
+
# The ID of the launch profile used to control access from the
|
1712
|
+
# streaming session.
|
2041
1713
|
# @return [String]
|
2042
1714
|
#
|
2043
1715
|
# @!attribute [rw] max_results
|
@@ -2045,7 +1717,8 @@ module Aws::NimbleStudio
|
|
2045
1717
|
# @return [Integer]
|
2046
1718
|
#
|
2047
1719
|
# @!attribute [rw] next_token
|
2048
|
-
# The token
|
1720
|
+
# The token for the next set of results, or null if there are no more
|
1721
|
+
# results.
|
2049
1722
|
# @return [String]
|
2050
1723
|
#
|
2051
1724
|
# @!attribute [rw] studio_id
|
@@ -2081,23 +1754,13 @@ module Aws::NimbleStudio
|
|
2081
1754
|
include Aws::Structure
|
2082
1755
|
end
|
2083
1756
|
|
2084
|
-
# @note When making an API call, you may pass ListLaunchProfilesRequest
|
2085
|
-
# data as a hash:
|
2086
|
-
#
|
2087
|
-
# {
|
2088
|
-
# max_results: 1,
|
2089
|
-
# next_token: "String",
|
2090
|
-
# principal_id: "String",
|
2091
|
-
# states: ["CREATE_IN_PROGRESS"], # accepts CREATE_IN_PROGRESS, READY, UPDATE_IN_PROGRESS, DELETE_IN_PROGRESS, DELETED, DELETE_FAILED, CREATE_FAILED, UPDATE_FAILED
|
2092
|
-
# studio_id: "String", # required
|
2093
|
-
# }
|
2094
|
-
#
|
2095
1757
|
# @!attribute [rw] max_results
|
2096
1758
|
# The max number of results to return in the response.
|
2097
1759
|
# @return [Integer]
|
2098
1760
|
#
|
2099
1761
|
# @!attribute [rw] next_token
|
2100
|
-
# The token
|
1762
|
+
# The token for the next set of results, or null if there are no more
|
1763
|
+
# results.
|
2101
1764
|
# @return [String]
|
2102
1765
|
#
|
2103
1766
|
# @!attribute [rw] principal_id
|
@@ -2143,17 +1806,9 @@ module Aws::NimbleStudio
|
|
2143
1806
|
include Aws::Structure
|
2144
1807
|
end
|
2145
1808
|
|
2146
|
-
# @note When making an API call, you may pass ListStreamingImagesRequest
|
2147
|
-
# data as a hash:
|
2148
|
-
#
|
2149
|
-
# {
|
2150
|
-
# next_token: "String",
|
2151
|
-
# owner: "String",
|
2152
|
-
# studio_id: "String", # required
|
2153
|
-
# }
|
2154
|
-
#
|
2155
1809
|
# @!attribute [rw] next_token
|
2156
|
-
# The token
|
1810
|
+
# The token for the next set of results, or null if there are no more
|
1811
|
+
# results.
|
2157
1812
|
# @return [String]
|
2158
1813
|
#
|
2159
1814
|
# @!attribute [rw] owner
|
@@ -2192,23 +1847,54 @@ module Aws::NimbleStudio
|
|
2192
1847
|
include Aws::Structure
|
2193
1848
|
end
|
2194
1849
|
|
2195
|
-
#
|
2196
|
-
#
|
1850
|
+
# @!attribute [rw] next_token
|
1851
|
+
# The token for the next set of results, or null if there are no more
|
1852
|
+
# results.
|
1853
|
+
# @return [String]
|
1854
|
+
#
|
1855
|
+
# @!attribute [rw] owned_by
|
1856
|
+
# The user ID of the user that owns the streaming session.
|
1857
|
+
# @return [String]
|
1858
|
+
#
|
1859
|
+
# @!attribute [rw] studio_id
|
1860
|
+
# The studio ID.
|
1861
|
+
# @return [String]
|
1862
|
+
#
|
1863
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/nimble-2020-08-01/ListStreamingSessionBackupsRequest AWS API Documentation
|
1864
|
+
#
|
1865
|
+
class ListStreamingSessionBackupsRequest < Struct.new(
|
1866
|
+
:next_token,
|
1867
|
+
:owned_by,
|
1868
|
+
:studio_id)
|
1869
|
+
SENSITIVE = []
|
1870
|
+
include Aws::Structure
|
1871
|
+
end
|
1872
|
+
|
1873
|
+
# @!attribute [rw] next_token
|
1874
|
+
# The token for the next set of results, or null if there are no more
|
1875
|
+
# results.
|
1876
|
+
# @return [String]
|
2197
1877
|
#
|
2198
|
-
#
|
2199
|
-
#
|
2200
|
-
#
|
2201
|
-
# owned_by: "String",
|
2202
|
-
# session_ids: "String",
|
2203
|
-
# studio_id: "String", # required
|
2204
|
-
# }
|
1878
|
+
# @!attribute [rw] streaming_session_backups
|
1879
|
+
# Information about the streaming session backups.
|
1880
|
+
# @return [Array<Types::StreamingSessionBackup>]
|
2205
1881
|
#
|
1882
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/nimble-2020-08-01/ListStreamingSessionBackupsResponse AWS API Documentation
|
1883
|
+
#
|
1884
|
+
class ListStreamingSessionBackupsResponse < Struct.new(
|
1885
|
+
:next_token,
|
1886
|
+
:streaming_session_backups)
|
1887
|
+
SENSITIVE = []
|
1888
|
+
include Aws::Structure
|
1889
|
+
end
|
1890
|
+
|
2206
1891
|
# @!attribute [rw] created_by
|
2207
1892
|
# Filters the request to streaming sessions created by the given user.
|
2208
1893
|
# @return [String]
|
2209
1894
|
#
|
2210
1895
|
# @!attribute [rw] next_token
|
2211
|
-
# The token
|
1896
|
+
# The token for the next set of results, or null if there are no more
|
1897
|
+
# results.
|
2212
1898
|
# @return [String]
|
2213
1899
|
#
|
2214
1900
|
# @!attribute [rw] owned_by
|
@@ -2253,23 +1939,13 @@ module Aws::NimbleStudio
|
|
2253
1939
|
include Aws::Structure
|
2254
1940
|
end
|
2255
1941
|
|
2256
|
-
# @note When making an API call, you may pass ListStudioComponentsRequest
|
2257
|
-
# data as a hash:
|
2258
|
-
#
|
2259
|
-
# {
|
2260
|
-
# max_results: 1,
|
2261
|
-
# next_token: "String",
|
2262
|
-
# states: ["CREATE_IN_PROGRESS"], # accepts CREATE_IN_PROGRESS, READY, UPDATE_IN_PROGRESS, DELETE_IN_PROGRESS, DELETED, DELETE_FAILED, CREATE_FAILED, UPDATE_FAILED
|
2263
|
-
# studio_id: "String", # required
|
2264
|
-
# types: ["ACTIVE_DIRECTORY"], # accepts ACTIVE_DIRECTORY, SHARED_FILE_SYSTEM, COMPUTE_FARM, LICENSE_SERVICE, CUSTOM
|
2265
|
-
# }
|
2266
|
-
#
|
2267
1942
|
# @!attribute [rw] max_results
|
2268
1943
|
# The max number of results to return in the response.
|
2269
1944
|
# @return [Integer]
|
2270
1945
|
#
|
2271
1946
|
# @!attribute [rw] next_token
|
2272
|
-
# The token
|
1947
|
+
# The token for the next set of results, or null if there are no more
|
1948
|
+
# results.
|
2273
1949
|
# @return [String]
|
2274
1950
|
#
|
2275
1951
|
# @!attribute [rw] states
|
@@ -2316,21 +1992,13 @@ module Aws::NimbleStudio
|
|
2316
1992
|
include Aws::Structure
|
2317
1993
|
end
|
2318
1994
|
|
2319
|
-
# @note When making an API call, you may pass ListStudioMembersRequest
|
2320
|
-
# data as a hash:
|
2321
|
-
#
|
2322
|
-
# {
|
2323
|
-
# max_results: 1,
|
2324
|
-
# next_token: "String",
|
2325
|
-
# studio_id: "String", # required
|
2326
|
-
# }
|
2327
|
-
#
|
2328
1995
|
# @!attribute [rw] max_results
|
2329
1996
|
# The max number of results to return in the response.
|
2330
1997
|
# @return [Integer]
|
2331
1998
|
#
|
2332
1999
|
# @!attribute [rw] next_token
|
2333
|
-
# The token
|
2000
|
+
# The token for the next set of results, or null if there are no more
|
2001
|
+
# results.
|
2334
2002
|
# @return [String]
|
2335
2003
|
#
|
2336
2004
|
# @!attribute [rw] studio_id
|
@@ -2365,15 +2033,9 @@ module Aws::NimbleStudio
|
|
2365
2033
|
include Aws::Structure
|
2366
2034
|
end
|
2367
2035
|
|
2368
|
-
# @note When making an API call, you may pass ListStudiosRequest
|
2369
|
-
# data as a hash:
|
2370
|
-
#
|
2371
|
-
# {
|
2372
|
-
# next_token: "String",
|
2373
|
-
# }
|
2374
|
-
#
|
2375
2036
|
# @!attribute [rw] next_token
|
2376
|
-
# The token
|
2037
|
+
# The token for the next set of results, or null if there are no more
|
2038
|
+
# results.
|
2377
2039
|
# @return [String]
|
2378
2040
|
#
|
2379
2041
|
# @see http://docs.aws.amazon.com/goto/WebAPI/nimble-2020-08-01/ListStudiosRequest AWS API Documentation
|
@@ -2402,13 +2064,6 @@ module Aws::NimbleStudio
|
|
2402
2064
|
include Aws::Structure
|
2403
2065
|
end
|
2404
2066
|
|
2405
|
-
# @note When making an API call, you may pass ListTagsForResourceRequest
|
2406
|
-
# data as a hash:
|
2407
|
-
#
|
2408
|
-
# {
|
2409
|
-
# resource_arn: "String", # required
|
2410
|
-
# }
|
2411
|
-
#
|
2412
2067
|
# @!attribute [rw] resource_arn
|
2413
2068
|
# The Amazon Resource Name (ARN) of the resource for which you want to
|
2414
2069
|
# list tags.
|
@@ -2423,7 +2078,7 @@ module Aws::NimbleStudio
|
|
2423
2078
|
end
|
2424
2079
|
|
2425
2080
|
# @!attribute [rw] tags
|
2426
|
-
# A collection of labels, in the form of key
|
2081
|
+
# A collection of labels, in the form of key-value pairs, that apply
|
2427
2082
|
# to this resource.
|
2428
2083
|
# @return [Hash<String,String>]
|
2429
2084
|
#
|
@@ -2437,14 +2092,6 @@ module Aws::NimbleStudio
|
|
2437
2092
|
|
2438
2093
|
# A new member that is added to a launch profile.
|
2439
2094
|
#
|
2440
|
-
# @note When making an API call, you may pass NewLaunchProfileMember
|
2441
|
-
# data as a hash:
|
2442
|
-
#
|
2443
|
-
# {
|
2444
|
-
# persona: "USER", # required, accepts USER
|
2445
|
-
# principal_id: "String", # required
|
2446
|
-
# }
|
2447
|
-
#
|
2448
2095
|
# @!attribute [rw] persona
|
2449
2096
|
# The persona.
|
2450
2097
|
# @return [String]
|
@@ -2464,14 +2111,6 @@ module Aws::NimbleStudio
|
|
2464
2111
|
|
2465
2112
|
# A new studio user's membership.
|
2466
2113
|
#
|
2467
|
-
# @note When making an API call, you may pass NewStudioMember
|
2468
|
-
# data as a hash:
|
2469
|
-
#
|
2470
|
-
# {
|
2471
|
-
# persona: "ADMINISTRATOR", # required, accepts ADMINISTRATOR
|
2472
|
-
# principal_id: "String", # required
|
2473
|
-
# }
|
2474
|
-
#
|
2475
2114
|
# @!attribute [rw] persona
|
2476
2115
|
# The persona.
|
2477
2116
|
# @return [String]
|
@@ -2489,27 +2128,11 @@ module Aws::NimbleStudio
|
|
2489
2128
|
include Aws::Structure
|
2490
2129
|
end
|
2491
2130
|
|
2492
|
-
# @note When making an API call, you may pass PutLaunchProfileMembersRequest
|
2493
|
-
# data as a hash:
|
2494
|
-
#
|
2495
|
-
# {
|
2496
|
-
# client_token: "ClientToken",
|
2497
|
-
# identity_store_id: "String", # required
|
2498
|
-
# launch_profile_id: "String", # required
|
2499
|
-
# members: [ # required
|
2500
|
-
# {
|
2501
|
-
# persona: "USER", # required, accepts USER
|
2502
|
-
# principal_id: "String", # required
|
2503
|
-
# },
|
2504
|
-
# ],
|
2505
|
-
# studio_id: "String", # required
|
2506
|
-
# }
|
2507
|
-
#
|
2508
2131
|
# @!attribute [rw] client_token
|
2509
2132
|
# Unique, case-sensitive identifier that you provide to ensure the
|
2510
2133
|
# idempotency of the request. If you don’t specify a client token, the
|
2511
|
-
#
|
2512
|
-
# request to ensure idempotency.
|
2134
|
+
# Amazon Web Services SDK automatically generates a client token and
|
2135
|
+
# uses it for the request to ensure idempotency.
|
2513
2136
|
#
|
2514
2137
|
# **A suitable default value is auto-generated.** You should normally
|
2515
2138
|
# not need to pass this option.
|
@@ -2520,7 +2143,8 @@ module Aws::NimbleStudio
|
|
2520
2143
|
# @return [String]
|
2521
2144
|
#
|
2522
2145
|
# @!attribute [rw] launch_profile_id
|
2523
|
-
# The
|
2146
|
+
# The ID of the launch profile used to control access from the
|
2147
|
+
# streaming session.
|
2524
2148
|
# @return [String]
|
2525
2149
|
#
|
2526
2150
|
# @!attribute [rw] members
|
@@ -2547,26 +2171,11 @@ module Aws::NimbleStudio
|
|
2547
2171
|
#
|
2548
2172
|
class PutLaunchProfileMembersResponse < Aws::EmptyStructure; end
|
2549
2173
|
|
2550
|
-
# @note When making an API call, you may pass PutStudioMembersRequest
|
2551
|
-
# data as a hash:
|
2552
|
-
#
|
2553
|
-
# {
|
2554
|
-
# client_token: "ClientToken",
|
2555
|
-
# identity_store_id: "String", # required
|
2556
|
-
# members: [ # required
|
2557
|
-
# {
|
2558
|
-
# persona: "ADMINISTRATOR", # required, accepts ADMINISTRATOR
|
2559
|
-
# principal_id: "String", # required
|
2560
|
-
# },
|
2561
|
-
# ],
|
2562
|
-
# studio_id: "String", # required
|
2563
|
-
# }
|
2564
|
-
#
|
2565
2174
|
# @!attribute [rw] client_token
|
2566
2175
|
# Unique, case-sensitive identifier that you provide to ensure the
|
2567
2176
|
# idempotency of the request. If you don’t specify a client token, the
|
2568
|
-
#
|
2569
|
-
# request to ensure idempotency.
|
2177
|
+
# Amazon Web Services SDK automatically generates a client token and
|
2178
|
+
# uses it for the request to ensure idempotency.
|
2570
2179
|
#
|
2571
2180
|
# **A suitable default value is auto-generated.** You should normally
|
2572
2181
|
# not need to pass this option.
|
@@ -2623,17 +2232,9 @@ module Aws::NimbleStudio
|
|
2623
2232
|
include Aws::Structure
|
2624
2233
|
end
|
2625
2234
|
|
2626
|
-
# A parameter for a studio component script, in the form of a key
|
2235
|
+
# A parameter for a studio component script, in the form of a key-value
|
2627
2236
|
# pair.
|
2628
2237
|
#
|
2629
|
-
# @note When making an API call, you may pass ScriptParameterKeyValue
|
2630
|
-
# data as a hash:
|
2631
|
-
#
|
2632
|
-
# {
|
2633
|
-
# key: "ScriptParameterKey",
|
2634
|
-
# value: "ScriptParameterValue",
|
2635
|
-
# }
|
2636
|
-
#
|
2637
2238
|
# @!attribute [rw] key
|
2638
2239
|
# A script parameter key.
|
2639
2240
|
# @return [String]
|
@@ -2655,7 +2256,7 @@ module Aws::NimbleStudio
|
|
2655
2256
|
# You can request increases for some quotas, and other quotas cannot be
|
2656
2257
|
# increased.
|
2657
2258
|
#
|
2658
|
-
# Please use
|
2259
|
+
# Please use Amazon Web Services Service Quotas to request an increase.
|
2659
2260
|
#
|
2660
2261
|
# @!attribute [rw] code
|
2661
2262
|
# A more specific error code.
|
@@ -2682,17 +2283,6 @@ module Aws::NimbleStudio
|
|
2682
2283
|
# The configuration for a shared file storage system that is associated
|
2683
2284
|
# with a studio resource.
|
2684
2285
|
#
|
2685
|
-
# @note When making an API call, you may pass SharedFileSystemConfiguration
|
2686
|
-
# data as a hash:
|
2687
|
-
#
|
2688
|
-
# {
|
2689
|
-
# endpoint: "SensitiveString",
|
2690
|
-
# file_system_id: "String",
|
2691
|
-
# linux_mount_point: "LinuxMountPoint",
|
2692
|
-
# share_name: "SensitiveString",
|
2693
|
-
# windows_mount_drive: "WindowsMountDrive",
|
2694
|
-
# }
|
2695
|
-
#
|
2696
2286
|
# @!attribute [rw] endpoint
|
2697
2287
|
# The endpoint of the shared file system that is accessed by the
|
2698
2288
|
# studio component resource.
|
@@ -2728,27 +2318,22 @@ module Aws::NimbleStudio
|
|
2728
2318
|
include Aws::Structure
|
2729
2319
|
end
|
2730
2320
|
|
2731
|
-
#
|
2732
|
-
#
|
2733
|
-
#
|
2734
|
-
# {
|
2735
|
-
# client_token: "ClientToken",
|
2736
|
-
# session_id: "String", # required
|
2737
|
-
# studio_id: "String", # required
|
2738
|
-
# }
|
2321
|
+
# @!attribute [rw] backup_id
|
2322
|
+
# The ID of the backup.
|
2323
|
+
# @return [String]
|
2739
2324
|
#
|
2740
2325
|
# @!attribute [rw] client_token
|
2741
2326
|
# Unique, case-sensitive identifier that you provide to ensure the
|
2742
2327
|
# idempotency of the request. If you don’t specify a client token, the
|
2743
|
-
#
|
2744
|
-
# request to ensure idempotency.
|
2328
|
+
# Amazon Web Services SDK automatically generates a client token and
|
2329
|
+
# uses it for the request to ensure idempotency.
|
2745
2330
|
#
|
2746
2331
|
# **A suitable default value is auto-generated.** You should normally
|
2747
2332
|
# not need to pass this option.
|
2748
2333
|
# @return [String]
|
2749
2334
|
#
|
2750
2335
|
# @!attribute [rw] session_id
|
2751
|
-
# The streaming session ID for the StartStreamingSessionRequest
|
2336
|
+
# The streaming session ID for the `StartStreamingSessionRequest`.
|
2752
2337
|
# @return [String]
|
2753
2338
|
#
|
2754
2339
|
# @!attribute [rw] studio_id
|
@@ -2758,6 +2343,7 @@ module Aws::NimbleStudio
|
|
2758
2343
|
# @see http://docs.aws.amazon.com/goto/WebAPI/nimble-2020-08-01/StartStreamingSessionRequest AWS API Documentation
|
2759
2344
|
#
|
2760
2345
|
class StartStreamingSessionRequest < Struct.new(
|
2346
|
+
:backup_id,
|
2761
2347
|
:client_token,
|
2762
2348
|
:session_id,
|
2763
2349
|
:studio_id)
|
@@ -2778,19 +2364,11 @@ module Aws::NimbleStudio
|
|
2778
2364
|
include Aws::Structure
|
2779
2365
|
end
|
2780
2366
|
|
2781
|
-
# @note When making an API call, you may pass StartStudioSSOConfigurationRepairRequest
|
2782
|
-
# data as a hash:
|
2783
|
-
#
|
2784
|
-
# {
|
2785
|
-
# client_token: "ClientToken",
|
2786
|
-
# studio_id: "String", # required
|
2787
|
-
# }
|
2788
|
-
#
|
2789
2367
|
# @!attribute [rw] client_token
|
2790
2368
|
# Unique, case-sensitive identifier that you provide to ensure the
|
2791
2369
|
# idempotency of the request. If you don’t specify a client token, the
|
2792
|
-
#
|
2793
|
-
# request to ensure idempotency.
|
2370
|
+
# Amazon Web Services SDK automatically generates a client token and
|
2371
|
+
# uses it for the request to ensure idempotency.
|
2794
2372
|
#
|
2795
2373
|
# **A suitable default value is auto-generated.** You should normally
|
2796
2374
|
# not need to pass this option.
|
@@ -2821,39 +2399,36 @@ module Aws::NimbleStudio
|
|
2821
2399
|
include Aws::Structure
|
2822
2400
|
end
|
2823
2401
|
|
2824
|
-
# @note When making an API call, you may pass StopStreamingSessionRequest
|
2825
|
-
# data as a hash:
|
2826
|
-
#
|
2827
|
-
# {
|
2828
|
-
# client_token: "ClientToken",
|
2829
|
-
# session_id: "String", # required
|
2830
|
-
# studio_id: "String", # required
|
2831
|
-
# }
|
2832
|
-
#
|
2833
2402
|
# @!attribute [rw] client_token
|
2834
2403
|
# Unique, case-sensitive identifier that you provide to ensure the
|
2835
2404
|
# idempotency of the request. If you don’t specify a client token, the
|
2836
|
-
#
|
2837
|
-
# request to ensure idempotency.
|
2405
|
+
# Amazon Web Services SDK automatically generates a client token and
|
2406
|
+
# uses it for the request to ensure idempotency.
|
2838
2407
|
#
|
2839
2408
|
# **A suitable default value is auto-generated.** You should normally
|
2840
2409
|
# not need to pass this option.
|
2841
2410
|
# @return [String]
|
2842
2411
|
#
|
2843
2412
|
# @!attribute [rw] session_id
|
2844
|
-
# The streaming session ID for the StopStreamingSessionRequest
|
2413
|
+
# The streaming session ID for the `StopStreamingSessionRequest`.
|
2845
2414
|
# @return [String]
|
2846
2415
|
#
|
2847
2416
|
# @!attribute [rw] studio_id
|
2848
2417
|
# The studioId for the StopStreamingSessionRequest.
|
2849
2418
|
# @return [String]
|
2850
2419
|
#
|
2420
|
+
# @!attribute [rw] volume_retention_mode
|
2421
|
+
# Adds additional instructions to a streaming session stop action to
|
2422
|
+
# either retain the EBS volumes or delete the EBS volumes.
|
2423
|
+
# @return [String]
|
2424
|
+
#
|
2851
2425
|
# @see http://docs.aws.amazon.com/goto/WebAPI/nimble-2020-08-01/StopStreamingSessionRequest AWS API Documentation
|
2852
2426
|
#
|
2853
2427
|
class StopStreamingSessionRequest < Struct.new(
|
2854
2428
|
:client_token,
|
2855
2429
|
:session_id,
|
2856
|
-
:studio_id
|
2430
|
+
:studio_id,
|
2431
|
+
:volume_retention_mode)
|
2857
2432
|
SENSITIVE = []
|
2858
2433
|
include Aws::Structure
|
2859
2434
|
end
|
@@ -2873,9 +2448,26 @@ module Aws::NimbleStudio
|
|
2873
2448
|
|
2874
2449
|
# A configuration for a streaming session.
|
2875
2450
|
#
|
2451
|
+
# @!attribute [rw] automatic_termination_mode
|
2452
|
+
# Indicates if a streaming session created from this launch profile
|
2453
|
+
# should be terminated automatically or retained without termination
|
2454
|
+
# after being in a `STOPPED` state.
|
2455
|
+
#
|
2456
|
+
# * When `ACTIVATED`, the streaming session is scheduled for
|
2457
|
+
# termination after being in the `STOPPED` state for the time
|
2458
|
+
# specified in `maxStoppedSessionLengthInMinutes`.
|
2459
|
+
#
|
2460
|
+
# * When `DEACTIVATED`, the streaming session can remain in the
|
2461
|
+
# `STOPPED` state indefinitely.
|
2462
|
+
#
|
2463
|
+
# This parameter is only allowed when `sessionPersistenceMode` is
|
2464
|
+
# `ACTIVATED`. When allowed, the default value for this parameter is
|
2465
|
+
# `DEACTIVATED`.
|
2466
|
+
# @return [String]
|
2467
|
+
#
|
2876
2468
|
# @!attribute [rw] clipboard_mode
|
2877
|
-
#
|
2878
|
-
# between the streaming session and streaming client.
|
2469
|
+
# Allows or deactivates the use of the system clipboard to copy and
|
2470
|
+
# paste between the streaming session and streaming client.
|
2879
2471
|
# @return [String]
|
2880
2472
|
#
|
2881
2473
|
# @!attribute [rw] ec2_instance_types
|
@@ -2893,24 +2485,37 @@ module Aws::NimbleStudio
|
|
2893
2485
|
#
|
2894
2486
|
# @!attribute [rw] max_stopped_session_length_in_minutes
|
2895
2487
|
# Integer that determines if you can start and stop your sessions and
|
2896
|
-
# how long a session can stay in the STOPPED state. The default
|
2897
|
-
# is 0. The maximum value is 5760.
|
2488
|
+
# how long a session can stay in the `STOPPED` state. The default
|
2489
|
+
# value is 0. The maximum value is 5760.
|
2490
|
+
#
|
2491
|
+
# This field is allowed only when `sessionPersistenceMode` is
|
2492
|
+
# `ACTIVATED` and `automaticTerminationMode` is `ACTIVATED`.
|
2898
2493
|
#
|
2899
|
-
# If the value is
|
2900
|
-
#
|
2901
|
-
#
|
2494
|
+
# If the value is set to 0, your sessions can’t be `STOPPED`. If you
|
2495
|
+
# then call `StopStreamingSession`, the session fails. If the time
|
2496
|
+
# that a session stays in the `READY` state exceeds the
|
2902
2497
|
# `maxSessionLengthInMinutes` value, the session will automatically be
|
2903
|
-
# terminated (instead of
|
2498
|
+
# terminated (instead of `STOPPED`).
|
2904
2499
|
#
|
2905
2500
|
# If the value is set to a positive number, the session can be
|
2906
2501
|
# stopped. You can call `StopStreamingSession` to stop sessions in the
|
2907
|
-
# READY state. If the time that a session stays in the READY state
|
2502
|
+
# `READY` state. If the time that a session stays in the `READY` state
|
2908
2503
|
# exceeds the `maxSessionLengthInMinutes` value, the session will
|
2909
2504
|
# automatically be stopped (instead of terminated).
|
2910
2505
|
# @return [Integer]
|
2911
2506
|
#
|
2507
|
+
# @!attribute [rw] session_backup
|
2508
|
+
# Information about the streaming session backup.
|
2509
|
+
# @return [Types::StreamConfigurationSessionBackup]
|
2510
|
+
#
|
2511
|
+
# @!attribute [rw] session_persistence_mode
|
2512
|
+
# Determine if a streaming session created from this launch profile
|
2513
|
+
# can configure persistent storage. This means that
|
2514
|
+
# `volumeConfiguration` and `automaticTerminationMode` are configured.
|
2515
|
+
# @return [String]
|
2516
|
+
#
|
2912
2517
|
# @!attribute [rw] session_storage
|
2913
|
-
#
|
2518
|
+
# The upload storage for a streaming session.
|
2914
2519
|
# @return [Types::StreamConfigurationSessionStorage]
|
2915
2520
|
#
|
2916
2521
|
# @!attribute [rw] streaming_image_ids
|
@@ -2918,15 +2523,27 @@ module Aws::NimbleStudio
|
|
2918
2523
|
# streaming session with this launch profile.
|
2919
2524
|
# @return [Array<String>]
|
2920
2525
|
#
|
2526
|
+
# @!attribute [rw] volume_configuration
|
2527
|
+
# Custom volume configuration for the root volumes that are attached
|
2528
|
+
# to streaming sessions.
|
2529
|
+
#
|
2530
|
+
# This parameter is only allowed when `sessionPersistenceMode` is
|
2531
|
+
# `ACTIVATED`.
|
2532
|
+
# @return [Types::VolumeConfiguration]
|
2533
|
+
#
|
2921
2534
|
# @see http://docs.aws.amazon.com/goto/WebAPI/nimble-2020-08-01/StreamConfiguration AWS API Documentation
|
2922
2535
|
#
|
2923
2536
|
class StreamConfiguration < Struct.new(
|
2537
|
+
:automatic_termination_mode,
|
2924
2538
|
:clipboard_mode,
|
2925
2539
|
:ec2_instance_types,
|
2926
2540
|
:max_session_length_in_minutes,
|
2927
2541
|
:max_stopped_session_length_in_minutes,
|
2542
|
+
:session_backup,
|
2543
|
+
:session_persistence_mode,
|
2928
2544
|
:session_storage,
|
2929
|
-
:streaming_image_ids
|
2545
|
+
:streaming_image_ids,
|
2546
|
+
:volume_configuration)
|
2930
2547
|
SENSITIVE = []
|
2931
2548
|
include Aws::Structure
|
2932
2549
|
end
|
@@ -2934,27 +2551,26 @@ module Aws::NimbleStudio
|
|
2934
2551
|
# Configuration for streaming workstations created using this launch
|
2935
2552
|
# profile.
|
2936
2553
|
#
|
2937
|
-
#
|
2938
|
-
#
|
2939
|
-
#
|
2940
|
-
#
|
2941
|
-
#
|
2942
|
-
#
|
2943
|
-
#
|
2944
|
-
#
|
2945
|
-
#
|
2946
|
-
#
|
2947
|
-
#
|
2948
|
-
#
|
2949
|
-
#
|
2950
|
-
#
|
2951
|
-
#
|
2952
|
-
#
|
2953
|
-
# }
|
2554
|
+
# @!attribute [rw] automatic_termination_mode
|
2555
|
+
# Indicates if a streaming session created from this launch profile
|
2556
|
+
# should be terminated automatically or retained without termination
|
2557
|
+
# after being in a `STOPPED` state.
|
2558
|
+
#
|
2559
|
+
# * When `ACTIVATED`, the streaming session is scheduled for
|
2560
|
+
# termination after being in the `STOPPED` state for the time
|
2561
|
+
# specified in `maxStoppedSessionLengthInMinutes`.
|
2562
|
+
#
|
2563
|
+
# * When `DEACTIVATED`, the streaming session can remain in the
|
2564
|
+
# `STOPPED` state indefinitely.
|
2565
|
+
#
|
2566
|
+
# This parameter is only allowed when `sessionPersistenceMode` is
|
2567
|
+
# `ACTIVATED`. When allowed, the default value for this parameter is
|
2568
|
+
# `DEACTIVATED`.
|
2569
|
+
# @return [String]
|
2954
2570
|
#
|
2955
2571
|
# @!attribute [rw] clipboard_mode
|
2956
|
-
#
|
2957
|
-
# between the streaming session and streaming client.
|
2572
|
+
# Allows or deactivates the use of the system clipboard to copy and
|
2573
|
+
# paste between the streaming session and streaming client.
|
2958
2574
|
# @return [String]
|
2959
2575
|
#
|
2960
2576
|
# @!attribute [rw] ec2_instance_types
|
@@ -2972,25 +2588,39 @@ module Aws::NimbleStudio
|
|
2972
2588
|
#
|
2973
2589
|
# @!attribute [rw] max_stopped_session_length_in_minutes
|
2974
2590
|
# Integer that determines if you can start and stop your sessions and
|
2975
|
-
# how long a session can stay in the STOPPED state. The default
|
2976
|
-
# is 0. The maximum value is 5760.
|
2591
|
+
# how long a session can stay in the `STOPPED` state. The default
|
2592
|
+
# value is 0. The maximum value is 5760.
|
2593
|
+
#
|
2594
|
+
# This field is allowed only when `sessionPersistenceMode` is
|
2595
|
+
# `ACTIVATED` and `automaticTerminationMode` is `ACTIVATED`.
|
2977
2596
|
#
|
2978
|
-
# If the value is
|
2979
|
-
#
|
2980
|
-
#
|
2597
|
+
# If the value is set to 0, your sessions can’t be `STOPPED`. If you
|
2598
|
+
# then call `StopStreamingSession`, the session fails. If the time
|
2599
|
+
# that a session stays in the `READY` state exceeds the
|
2981
2600
|
# `maxSessionLengthInMinutes` value, the session will automatically be
|
2982
|
-
# terminated (instead of
|
2601
|
+
# terminated (instead of `STOPPED`).
|
2983
2602
|
#
|
2984
2603
|
# If the value is set to a positive number, the session can be
|
2985
2604
|
# stopped. You can call `StopStreamingSession` to stop sessions in the
|
2986
|
-
# READY state. If the time that a session stays in the READY state
|
2605
|
+
# `READY` state. If the time that a session stays in the `READY` state
|
2987
2606
|
# exceeds the `maxSessionLengthInMinutes` value, the session will
|
2988
2607
|
# automatically be stopped (instead of terminated).
|
2989
2608
|
# @return [Integer]
|
2990
2609
|
#
|
2610
|
+
# @!attribute [rw] session_backup
|
2611
|
+
# Configures how streaming sessions are backed up when launched from
|
2612
|
+
# this launch profile.
|
2613
|
+
# @return [Types::StreamConfigurationSessionBackup]
|
2614
|
+
#
|
2615
|
+
# @!attribute [rw] session_persistence_mode
|
2616
|
+
# Determine if a streaming session created from this launch profile
|
2617
|
+
# can configure persistent storage. This means that
|
2618
|
+
# `volumeConfiguration` and `automaticTerminationMode` are configured.
|
2619
|
+
# @return [String]
|
2620
|
+
#
|
2991
2621
|
# @!attribute [rw] session_storage
|
2992
|
-
#
|
2993
|
-
#
|
2622
|
+
# The upload storage for a streaming workstation that is created using
|
2623
|
+
# this launch profile.
|
2994
2624
|
# @return [Types::StreamConfigurationSessionStorage]
|
2995
2625
|
#
|
2996
2626
|
# @!attribute [rw] streaming_image_ids
|
@@ -2998,31 +2628,58 @@ module Aws::NimbleStudio
|
|
2998
2628
|
# streaming session with this launch profile.
|
2999
2629
|
# @return [Array<String>]
|
3000
2630
|
#
|
2631
|
+
# @!attribute [rw] volume_configuration
|
2632
|
+
# Custom volume configuration for the root volumes that are attached
|
2633
|
+
# to streaming sessions.
|
2634
|
+
#
|
2635
|
+
# This parameter is only allowed when `sessionPersistenceMode` is
|
2636
|
+
# `ACTIVATED`.
|
2637
|
+
# @return [Types::VolumeConfiguration]
|
2638
|
+
#
|
3001
2639
|
# @see http://docs.aws.amazon.com/goto/WebAPI/nimble-2020-08-01/StreamConfigurationCreate AWS API Documentation
|
3002
2640
|
#
|
3003
2641
|
class StreamConfigurationCreate < Struct.new(
|
2642
|
+
:automatic_termination_mode,
|
3004
2643
|
:clipboard_mode,
|
3005
2644
|
:ec2_instance_types,
|
3006
2645
|
:max_session_length_in_minutes,
|
3007
2646
|
:max_stopped_session_length_in_minutes,
|
2647
|
+
:session_backup,
|
2648
|
+
:session_persistence_mode,
|
3008
2649
|
:session_storage,
|
3009
|
-
:streaming_image_ids
|
2650
|
+
:streaming_image_ids,
|
2651
|
+
:volume_configuration)
|
3010
2652
|
SENSITIVE = []
|
3011
2653
|
include Aws::Structure
|
3012
2654
|
end
|
3013
2655
|
|
3014
|
-
#
|
2656
|
+
# Configures how streaming sessions are backed up when launched from
|
2657
|
+
# this launch profile.
|
2658
|
+
#
|
2659
|
+
# @!attribute [rw] max_backups_to_retain
|
2660
|
+
# The maximum number of backups that each streaming session created
|
2661
|
+
# from this launch profile can have.
|
2662
|
+
# @return [Integer]
|
3015
2663
|
#
|
3016
|
-
#
|
3017
|
-
#
|
2664
|
+
# @!attribute [rw] mode
|
2665
|
+
# Specifies how artists sessions are backed up.
|
2666
|
+
#
|
2667
|
+
# Configures backups for streaming sessions launched with this launch
|
2668
|
+
# profile. The default value is `DEACTIVATED`, which means that
|
2669
|
+
# backups are deactivated. To allow backups, set this value to
|
2670
|
+
# `AUTOMATIC`.
|
2671
|
+
# @return [String]
|
3018
2672
|
#
|
3019
|
-
#
|
3020
|
-
#
|
3021
|
-
|
3022
|
-
|
3023
|
-
|
3024
|
-
|
3025
|
-
|
2673
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/nimble-2020-08-01/StreamConfigurationSessionBackup AWS API Documentation
|
2674
|
+
#
|
2675
|
+
class StreamConfigurationSessionBackup < Struct.new(
|
2676
|
+
:max_backups_to_retain,
|
2677
|
+
:mode)
|
2678
|
+
SENSITIVE = []
|
2679
|
+
include Aws::Structure
|
2680
|
+
end
|
2681
|
+
|
2682
|
+
# The configuration for a streaming session’s upload storage.
|
3026
2683
|
#
|
3027
2684
|
# @!attribute [rw] mode
|
3028
2685
|
# Allows artists to upload files to their workstations. The only valid
|
@@ -3052,12 +2709,13 @@ module Aws::NimbleStudio
|
|
3052
2709
|
# Amazon provides a number of streaming images that include popular
|
3053
2710
|
# 3rd-party software.
|
3054
2711
|
#
|
3055
|
-
# You can create your own streaming images using an Amazon
|
3056
|
-
#
|
3057
|
-
#
|
2712
|
+
# You can create your own streaming images using an Amazon EC2 machine
|
2713
|
+
# image that you create for this purpose. You can also include software
|
2714
|
+
# that your users require.
|
3058
2715
|
#
|
3059
2716
|
# @!attribute [rw] arn
|
3060
|
-
# The ARN
|
2717
|
+
# The Amazon Resource Name (ARN) that is assigned to a studio resource
|
2718
|
+
# and uniquely identifies it. ARNs are unique across all Regions.
|
3061
2719
|
# @return [String]
|
3062
2720
|
#
|
3063
2721
|
# @!attribute [rw] description
|
@@ -3083,13 +2741,13 @@ module Aws::NimbleStudio
|
|
3083
2741
|
# @return [String]
|
3084
2742
|
#
|
3085
2743
|
# @!attribute [rw] owner
|
3086
|
-
# The owner of the streaming image, either the studioId that
|
3087
|
-
# the streaming image, or
|
3088
|
-
# Amazon Nimble Studio.
|
2744
|
+
# The owner of the streaming image, either the `studioId` that
|
2745
|
+
# contains the streaming image, or `amazon` for images that are
|
2746
|
+
# provided by Amazon Nimble Studio.
|
3089
2747
|
# @return [String]
|
3090
2748
|
#
|
3091
2749
|
# @!attribute [rw] platform
|
3092
|
-
# The platform of the streaming image, either
|
2750
|
+
# The platform of the streaming image, either Windows or Linux.
|
3093
2751
|
# @return [String]
|
3094
2752
|
#
|
3095
2753
|
# @!attribute [rw] state
|
@@ -3109,7 +2767,7 @@ module Aws::NimbleStudio
|
|
3109
2767
|
# @return [String]
|
3110
2768
|
#
|
3111
2769
|
# @!attribute [rw] tags
|
3112
|
-
# A collection of labels, in the form of key
|
2770
|
+
# A collection of labels, in the form of key-value pairs, that apply
|
3113
2771
|
# to this resource.
|
3114
2772
|
# @return [Hash<String,String>]
|
3115
2773
|
#
|
@@ -3156,12 +2814,33 @@ module Aws::NimbleStudio
|
|
3156
2814
|
# particular launch profile.
|
3157
2815
|
#
|
3158
2816
|
# @!attribute [rw] arn
|
3159
|
-
# The ARN
|
2817
|
+
# The Amazon Resource Name (ARN) that is assigned to a studio resource
|
2818
|
+
# and uniquely identifies it. ARNs are unique across all Regions.
|
2819
|
+
# @return [String]
|
2820
|
+
#
|
2821
|
+
# @!attribute [rw] automatic_termination_mode
|
2822
|
+
# Indicates if a streaming session created from this launch profile
|
2823
|
+
# should be terminated automatically or retained without termination
|
2824
|
+
# after being in a `STOPPED` state.
|
2825
|
+
#
|
2826
|
+
# * When `ACTIVATED`, the streaming session is scheduled for
|
2827
|
+
# termination after being in the `STOPPED` state for the time
|
2828
|
+
# specified in `maxStoppedSessionLengthInMinutes`.
|
2829
|
+
#
|
2830
|
+
# * When `DEACTIVATED`, the streaming session can remain in the
|
2831
|
+
# `STOPPED` state indefinitely.
|
2832
|
+
#
|
2833
|
+
# This parameter is only allowed when `sessionPersistenceMode` is
|
2834
|
+
# `ACTIVATED`. When allowed, the default value for this parameter is
|
2835
|
+
# `DEACTIVATED`.
|
2836
|
+
# @return [String]
|
2837
|
+
#
|
2838
|
+
# @!attribute [rw] backup_mode
|
2839
|
+
# Shows the current backup setting of the session.
|
3160
2840
|
# @return [String]
|
3161
2841
|
#
|
3162
2842
|
# @!attribute [rw] created_at
|
3163
|
-
# The
|
3164
|
-
# created.
|
2843
|
+
# The ISO timestamp in seconds for when the resource was created.
|
3165
2844
|
# @return [Time]
|
3166
2845
|
#
|
3167
2846
|
# @!attribute [rw] created_by
|
@@ -3177,6 +2856,12 @@ module Aws::NimbleStudio
|
|
3177
2856
|
# streaming session.
|
3178
2857
|
# @return [String]
|
3179
2858
|
#
|
2859
|
+
# @!attribute [rw] max_backups_to_retain
|
2860
|
+
# The maximum number of backups of a streaming session that you can
|
2861
|
+
# have. When the maximum number of backups is reached, the oldest
|
2862
|
+
# backup is deleted.
|
2863
|
+
# @return [Integer]
|
2864
|
+
#
|
3180
2865
|
# @!attribute [rw] owned_by
|
3181
2866
|
# The user ID of the user that owns the streaming session. The user
|
3182
2867
|
# that owns the session will be logging into the session and
|
@@ -3187,14 +2872,24 @@ module Aws::NimbleStudio
|
|
3187
2872
|
# The session ID.
|
3188
2873
|
# @return [String]
|
3189
2874
|
#
|
2875
|
+
# @!attribute [rw] session_persistence_mode
|
2876
|
+
# Determine if a streaming session created from this launch profile
|
2877
|
+
# can configure persistent storage. This means that
|
2878
|
+
# `volumeConfiguration` and `automaticTerminationMode` are configured.
|
2879
|
+
# @return [String]
|
2880
|
+
#
|
3190
2881
|
# @!attribute [rw] started_at
|
3191
|
-
# The time the session entered
|
2882
|
+
# The time the session entered `START_IN_PROGRESS` state.
|
3192
2883
|
# @return [Time]
|
3193
2884
|
#
|
3194
2885
|
# @!attribute [rw] started_by
|
3195
2886
|
# The user ID of the user that started the streaming session.
|
3196
2887
|
# @return [String]
|
3197
2888
|
#
|
2889
|
+
# @!attribute [rw] started_from_backup_id
|
2890
|
+
# The backup ID used to restore a streaming session.
|
2891
|
+
# @return [String]
|
2892
|
+
#
|
3198
2893
|
# @!attribute [rw] state
|
3199
2894
|
# The current state.
|
3200
2895
|
# @return [String]
|
@@ -3213,7 +2908,7 @@ module Aws::NimbleStudio
|
|
3213
2908
|
# @return [Time]
|
3214
2909
|
#
|
3215
2910
|
# @!attribute [rw] stopped_at
|
3216
|
-
# The time the session entered
|
2911
|
+
# The time the session entered `STOP_IN_PROGRESS` state.
|
3217
2912
|
# @return [Time]
|
3218
2913
|
#
|
3219
2914
|
# @!attribute [rw] stopped_by
|
@@ -3225,7 +2920,7 @@ module Aws::NimbleStudio
|
|
3225
2920
|
# @return [String]
|
3226
2921
|
#
|
3227
2922
|
# @!attribute [rw] tags
|
3228
|
-
# A collection of labels, in the form of key
|
2923
|
+
# A collection of labels, in the form of key-value pairs, that apply
|
3229
2924
|
# to this resource.
|
3230
2925
|
# @return [Hash<String,String>]
|
3231
2926
|
#
|
@@ -3235,26 +2930,43 @@ module Aws::NimbleStudio
|
|
3235
2930
|
# @return [Time]
|
3236
2931
|
#
|
3237
2932
|
# @!attribute [rw] updated_at
|
3238
|
-
# The
|
3239
|
-
# updated.
|
2933
|
+
# The ISO timestamp in seconds for when the resource was updated.
|
3240
2934
|
# @return [Time]
|
3241
2935
|
#
|
3242
2936
|
# @!attribute [rw] updated_by
|
3243
2937
|
# The user ID of the user that most recently updated the resource.
|
3244
2938
|
# @return [String]
|
3245
2939
|
#
|
2940
|
+
# @!attribute [rw] volume_configuration
|
2941
|
+
# Custom volume configuration for the root volumes that are attached
|
2942
|
+
# to streaming sessions.
|
2943
|
+
#
|
2944
|
+
# This parameter is only allowed when `sessionPersistenceMode` is
|
2945
|
+
# `ACTIVATED`.
|
2946
|
+
# @return [Types::VolumeConfiguration]
|
2947
|
+
#
|
2948
|
+
# @!attribute [rw] volume_retention_mode
|
2949
|
+
# Determine if an EBS volume created from this streaming session will
|
2950
|
+
# be backed up.
|
2951
|
+
# @return [String]
|
2952
|
+
#
|
3246
2953
|
# @see http://docs.aws.amazon.com/goto/WebAPI/nimble-2020-08-01/StreamingSession AWS API Documentation
|
3247
2954
|
#
|
3248
2955
|
class StreamingSession < Struct.new(
|
3249
2956
|
:arn,
|
2957
|
+
:automatic_termination_mode,
|
2958
|
+
:backup_mode,
|
3250
2959
|
:created_at,
|
3251
2960
|
:created_by,
|
3252
2961
|
:ec2_instance_type,
|
3253
2962
|
:launch_profile_id,
|
2963
|
+
:max_backups_to_retain,
|
3254
2964
|
:owned_by,
|
3255
2965
|
:session_id,
|
2966
|
+
:session_persistence_mode,
|
3256
2967
|
:started_at,
|
3257
2968
|
:started_by,
|
2969
|
+
:started_from_backup_id,
|
3258
2970
|
:state,
|
3259
2971
|
:status_code,
|
3260
2972
|
:status_message,
|
@@ -3265,21 +2977,77 @@ module Aws::NimbleStudio
|
|
3265
2977
|
:tags,
|
3266
2978
|
:terminate_at,
|
3267
2979
|
:updated_at,
|
3268
|
-
:updated_by
|
2980
|
+
:updated_by,
|
2981
|
+
:volume_configuration,
|
2982
|
+
:volume_retention_mode)
|
3269
2983
|
SENSITIVE = []
|
3270
2984
|
include Aws::Structure
|
3271
2985
|
end
|
3272
2986
|
|
3273
|
-
#
|
3274
|
-
#
|
2987
|
+
# Information about the streaming session backup.
|
2988
|
+
#
|
2989
|
+
# @!attribute [rw] arn
|
2990
|
+
# The Amazon Resource Name (ARN) that is assigned to a studio resource
|
2991
|
+
# and uniquely identifies it. ARNs are unique across all Regions.
|
2992
|
+
# @return [String]
|
2993
|
+
#
|
2994
|
+
# @!attribute [rw] backup_id
|
2995
|
+
# The ID of the backup.
|
2996
|
+
# @return [String]
|
3275
2997
|
#
|
3276
|
-
#
|
3277
|
-
#
|
2998
|
+
# @!attribute [rw] created_at
|
2999
|
+
# The ISO timestamp in for when the resource was created.
|
3000
|
+
# @return [Time]
|
3278
3001
|
#
|
3279
|
-
#
|
3280
|
-
#
|
3281
|
-
#
|
3282
|
-
#
|
3002
|
+
# @!attribute [rw] launch_profile_id
|
3003
|
+
# The ID of the launch profile which allowed the backups for the
|
3004
|
+
# streaming session.
|
3005
|
+
# @return [String]
|
3006
|
+
#
|
3007
|
+
# @!attribute [rw] owned_by
|
3008
|
+
# The user ID of the user that owns the streaming session.
|
3009
|
+
# @return [String]
|
3010
|
+
#
|
3011
|
+
# @!attribute [rw] session_id
|
3012
|
+
# The streaming session ID for the `StreamingSessionBackup`.
|
3013
|
+
# @return [String]
|
3014
|
+
#
|
3015
|
+
# @!attribute [rw] state
|
3016
|
+
# The streaming session state.
|
3017
|
+
# @return [String]
|
3018
|
+
#
|
3019
|
+
# @!attribute [rw] status_code
|
3020
|
+
# The status code.
|
3021
|
+
# @return [String]
|
3022
|
+
#
|
3023
|
+
# @!attribute [rw] status_message
|
3024
|
+
# The status message for the streaming session backup.
|
3025
|
+
# @return [String]
|
3026
|
+
#
|
3027
|
+
# @!attribute [rw] tags
|
3028
|
+
# A collection of labels, in the form of key-value pairs, that apply
|
3029
|
+
# to this resource.
|
3030
|
+
# @return [Hash<String,String>]
|
3031
|
+
#
|
3032
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/nimble-2020-08-01/StreamingSessionBackup AWS API Documentation
|
3033
|
+
#
|
3034
|
+
class StreamingSessionBackup < Struct.new(
|
3035
|
+
:arn,
|
3036
|
+
:backup_id,
|
3037
|
+
:created_at,
|
3038
|
+
:launch_profile_id,
|
3039
|
+
:owned_by,
|
3040
|
+
:session_id,
|
3041
|
+
:state,
|
3042
|
+
:status_code,
|
3043
|
+
:status_message,
|
3044
|
+
:tags)
|
3045
|
+
SENSITIVE = []
|
3046
|
+
include Aws::Structure
|
3047
|
+
end
|
3048
|
+
|
3049
|
+
# The upload storage root location (folder) on streaming workstations
|
3050
|
+
# where files are uploaded.
|
3283
3051
|
#
|
3284
3052
|
# @!attribute [rw] linux
|
3285
3053
|
# The folder path in Linux workstations where files are uploaded.
|
@@ -3305,8 +3073,7 @@ module Aws::NimbleStudio
|
|
3305
3073
|
# client.
|
3306
3074
|
#
|
3307
3075
|
# @!attribute [rw] created_at
|
3308
|
-
# The
|
3309
|
-
# created.
|
3076
|
+
# The ISO timestamp in seconds for when the resource was created.
|
3310
3077
|
# @return [Time]
|
3311
3078
|
#
|
3312
3079
|
# @!attribute [rw] created_by
|
@@ -3314,7 +3081,7 @@ module Aws::NimbleStudio
|
|
3314
3081
|
# @return [String]
|
3315
3082
|
#
|
3316
3083
|
# @!attribute [rw] expires_at
|
3317
|
-
# The
|
3084
|
+
# The ISO timestamp in seconds for when the resource expires.
|
3318
3085
|
# @return [Time]
|
3319
3086
|
#
|
3320
3087
|
# @!attribute [rw] owned_by
|
@@ -3366,14 +3133,14 @@ module Aws::NimbleStudio
|
|
3366
3133
|
# they log in to the Nimble Studio portal via IAM Identity Center and
|
3367
3134
|
# your identity source.
|
3368
3135
|
#
|
3369
|
-
# The user role must have the AmazonNimbleStudio-StudioUser managed
|
3136
|
+
# The user role must have the `AmazonNimbleStudio-StudioUser` managed
|
3370
3137
|
# policy attached for the portal to function properly.
|
3371
3138
|
#
|
3372
|
-
# The admin role must have the AmazonNimbleStudio-StudioAdmin managed
|
3139
|
+
# The admin role must have the `AmazonNimbleStudio-StudioAdmin` managed
|
3373
3140
|
# policy attached for the portal to function properly.
|
3374
3141
|
#
|
3375
|
-
# Your studio roles must trust the identity.nimble.amazonaws.com
|
3376
|
-
# principal to function properly.
|
3142
|
+
# Your studio roles must trust the `identity.nimble.amazonaws.com`
|
3143
|
+
# service principal to function properly.
|
3377
3144
|
#
|
3378
3145
|
# @!attribute [rw] admin_role_arn
|
3379
3146
|
# The IAM role that studio admins assume when logging in to the Nimble
|
@@ -3386,8 +3153,7 @@ module Aws::NimbleStudio
|
|
3386
3153
|
# @return [String]
|
3387
3154
|
#
|
3388
3155
|
# @!attribute [rw] created_at
|
3389
|
-
# The
|
3390
|
-
# created.
|
3156
|
+
# The ISO timestamp in seconds for when the resource was created.
|
3391
3157
|
# @return [Time]
|
3392
3158
|
#
|
3393
3159
|
# @!attribute [rw] display_name
|
@@ -3400,8 +3166,8 @@ module Aws::NimbleStudio
|
|
3400
3166
|
#
|
3401
3167
|
# @!attribute [rw] sso_client_id
|
3402
3168
|
# The IAM Identity Center application client ID used to integrate with
|
3403
|
-
# IAM Identity Center
|
3404
|
-
# Nimble Studio portal.
|
3169
|
+
# IAM Identity Center. This ID allows IAM Identity Center users to log
|
3170
|
+
# in to Nimble Studio portal.
|
3405
3171
|
# @return [String]
|
3406
3172
|
#
|
3407
3173
|
# @!attribute [rw] state
|
@@ -3435,13 +3201,12 @@ module Aws::NimbleStudio
|
|
3435
3201
|
# @return [String]
|
3436
3202
|
#
|
3437
3203
|
# @!attribute [rw] tags
|
3438
|
-
# A collection of labels, in the form of key
|
3204
|
+
# A collection of labels, in the form of key-value pairs, that apply
|
3439
3205
|
# to this resource.
|
3440
3206
|
# @return [Hash<String,String>]
|
3441
3207
|
#
|
3442
3208
|
# @!attribute [rw] updated_at
|
3443
|
-
# The
|
3444
|
-
# updated.
|
3209
|
+
# The ISO timestamp in seconds for when the resource was updated.
|
3445
3210
|
# @return [Time]
|
3446
3211
|
#
|
3447
3212
|
# @!attribute [rw] user_role_arn
|
@@ -3487,7 +3252,8 @@ module Aws::NimbleStudio
|
|
3487
3252
|
# configured on a streaming session.
|
3488
3253
|
#
|
3489
3254
|
# @!attribute [rw] arn
|
3490
|
-
# The ARN
|
3255
|
+
# The Amazon Resource Name (ARN) that is assigned to a studio resource
|
3256
|
+
# and uniquely identifies it. ARNs are unique across all Regions.
|
3491
3257
|
# @return [String]
|
3492
3258
|
#
|
3493
3259
|
# @!attribute [rw] configuration
|
@@ -3495,8 +3261,7 @@ module Aws::NimbleStudio
|
|
3495
3261
|
# @return [Types::StudioComponentConfiguration]
|
3496
3262
|
#
|
3497
3263
|
# @!attribute [rw] created_at
|
3498
|
-
# The
|
3499
|
-
# created.
|
3264
|
+
# The ISO timestamp in seconds for when the resource was created.
|
3500
3265
|
# @return [Time]
|
3501
3266
|
#
|
3502
3267
|
# @!attribute [rw] created_by
|
@@ -3521,8 +3286,8 @@ module Aws::NimbleStudio
|
|
3521
3286
|
#
|
3522
3287
|
# @!attribute [rw] runtime_role_arn
|
3523
3288
|
# An IAM role attached to a Studio Component that gives the studio
|
3524
|
-
# component access to
|
3525
|
-
# running.
|
3289
|
+
# component access to Amazon Web Services resources at anytime while
|
3290
|
+
# the instance is running.
|
3526
3291
|
# @return [String]
|
3527
3292
|
#
|
3528
3293
|
# @!attribute [rw] script_parameters
|
@@ -3532,7 +3297,8 @@ module Aws::NimbleStudio
|
|
3532
3297
|
# @!attribute [rw] secure_initialization_role_arn
|
3533
3298
|
# An IAM role attached to Studio Component when the system
|
3534
3299
|
# initialization script runs which give the studio component access to
|
3535
|
-
#
|
3300
|
+
# Amazon Web Services resources when the system initialization script
|
3301
|
+
# runs.
|
3536
3302
|
# @return [String]
|
3537
3303
|
#
|
3538
3304
|
# @!attribute [rw] state
|
@@ -3556,7 +3322,7 @@ module Aws::NimbleStudio
|
|
3556
3322
|
# @return [String]
|
3557
3323
|
#
|
3558
3324
|
# @!attribute [rw] tags
|
3559
|
-
# A collection of labels, in the form of key
|
3325
|
+
# A collection of labels, in the form of key-value pairs, that apply
|
3560
3326
|
# to this resource.
|
3561
3327
|
# @return [Hash<String,String>]
|
3562
3328
|
#
|
@@ -3565,8 +3331,7 @@ module Aws::NimbleStudio
|
|
3565
3331
|
# @return [String]
|
3566
3332
|
#
|
3567
3333
|
# @!attribute [rw] updated_at
|
3568
|
-
# The
|
3569
|
-
# updated.
|
3334
|
+
# The ISO timestamp in seconds for when the resource was updated.
|
3570
3335
|
# @return [Time]
|
3571
3336
|
#
|
3572
3337
|
# @!attribute [rw] updated_by
|
@@ -3607,8 +3372,8 @@ module Aws::NimbleStudio
|
|
3607
3372
|
# @note StudioComponentConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of StudioComponentConfiguration corresponding to the set member.
|
3608
3373
|
#
|
3609
3374
|
# @!attribute [rw] active_directory_configuration
|
3610
|
-
# The configuration for a
|
3611
|
-
# studio resource.
|
3375
|
+
# The configuration for a Directory Service for Microsoft Active
|
3376
|
+
# Directory studio resource.
|
3612
3377
|
# @return [Types::ActiveDirectoryConfiguration]
|
3613
3378
|
#
|
3614
3379
|
# @!attribute [rw] compute_farm_configuration
|
@@ -3647,23 +3412,13 @@ module Aws::NimbleStudio
|
|
3647
3412
|
|
3648
3413
|
# Initialization scripts for studio components.
|
3649
3414
|
#
|
3650
|
-
# @note When making an API call, you may pass StudioComponentInitializationScript
|
3651
|
-
# data as a hash:
|
3652
|
-
#
|
3653
|
-
# {
|
3654
|
-
# launch_profile_protocol_version: "LaunchProfileProtocolVersion",
|
3655
|
-
# platform: "LINUX", # accepts LINUX, WINDOWS
|
3656
|
-
# run_context: "SYSTEM_INITIALIZATION", # accepts SYSTEM_INITIALIZATION, USER_INITIALIZATION
|
3657
|
-
# script: "StudioComponentInitializationScriptContent",
|
3658
|
-
# }
|
3659
|
-
#
|
3660
3415
|
# @!attribute [rw] launch_profile_protocol_version
|
3661
3416
|
# The version number of the protocol that is used by the launch
|
3662
3417
|
# profile. The only valid version is "2021-03-31".
|
3663
3418
|
# @return [String]
|
3664
3419
|
#
|
3665
3420
|
# @!attribute [rw] platform
|
3666
|
-
# The platform of the initialization script, either
|
3421
|
+
# The platform of the initialization script, either Windows or Linux.
|
3667
3422
|
# @return [String]
|
3668
3423
|
#
|
3669
3424
|
# @!attribute [rw] run_context
|
@@ -3688,8 +3443,7 @@ module Aws::NimbleStudio
|
|
3688
3443
|
# The studio component's summary.
|
3689
3444
|
#
|
3690
3445
|
# @!attribute [rw] created_at
|
3691
|
-
# The
|
3692
|
-
# created.
|
3446
|
+
# The ISO timestamp in seconds for when the resource was created.
|
3693
3447
|
# @return [Time]
|
3694
3448
|
#
|
3695
3449
|
# @!attribute [rw] created_by
|
@@ -3717,8 +3471,7 @@ module Aws::NimbleStudio
|
|
3717
3471
|
# @return [String]
|
3718
3472
|
#
|
3719
3473
|
# @!attribute [rw] updated_at
|
3720
|
-
# The
|
3721
|
-
# updated.
|
3474
|
+
# The ISO timestamp in seconds for when the resource was updated.
|
3722
3475
|
# @return [Time]
|
3723
3476
|
#
|
3724
3477
|
# @!attribute [rw] updated_by
|
@@ -3743,14 +3496,6 @@ module Aws::NimbleStudio
|
|
3743
3496
|
|
3744
3497
|
# Configuration of the encryption method that is used for the studio.
|
3745
3498
|
#
|
3746
|
-
# @note When making an API call, you may pass StudioEncryptionConfiguration
|
3747
|
-
# data as a hash:
|
3748
|
-
#
|
3749
|
-
# {
|
3750
|
-
# key_arn: "StudioEncryptionConfigurationKeyArn",
|
3751
|
-
# key_type: "AWS_OWNED_KEY", # required, accepts AWS_OWNED_KEY, CUSTOMER_MANAGED_KEY
|
3752
|
-
# }
|
3753
|
-
#
|
3754
3499
|
# @!attribute [rw] key_arn
|
3755
3500
|
# The ARN for a KMS key that is used to encrypt studio data.
|
3756
3501
|
# @return [String]
|
@@ -3778,7 +3523,7 @@ module Aws::NimbleStudio
|
|
3778
3523
|
# do not appear in the studio membership collection. Only studio admins
|
3779
3524
|
# appear in studio membership.
|
3780
3525
|
#
|
3781
|
-
# When you add a user to studio membership with the persona
|
3526
|
+
# When you add a user to studio membership with the ADMIN persona, upon
|
3782
3527
|
# logging in to the Nimble Studio portal, they are granted permissions
|
3783
3528
|
# specified by the Studio's Admin IAM role.
|
3784
3529
|
#
|
@@ -3810,23 +3555,13 @@ module Aws::NimbleStudio
|
|
3810
3555
|
include Aws::Structure
|
3811
3556
|
end
|
3812
3557
|
|
3813
|
-
# @note When making an API call, you may pass TagResourceRequest
|
3814
|
-
# data as a hash:
|
3815
|
-
#
|
3816
|
-
# {
|
3817
|
-
# resource_arn: "String", # required
|
3818
|
-
# tags: {
|
3819
|
-
# "String" => "String",
|
3820
|
-
# },
|
3821
|
-
# }
|
3822
|
-
#
|
3823
3558
|
# @!attribute [rw] resource_arn
|
3824
3559
|
# The Amazon Resource Name (ARN) of the resource you want to add tags
|
3825
3560
|
# to.
|
3826
3561
|
# @return [String]
|
3827
3562
|
#
|
3828
3563
|
# @!attribute [rw] tags
|
3829
|
-
# A collection of labels, in the form of key
|
3564
|
+
# A collection of labels, in the form of key-value pairs, that apply
|
3830
3565
|
# to this resource.
|
3831
3566
|
# @return [Hash<String,String>]
|
3832
3567
|
#
|
@@ -3867,14 +3602,6 @@ module Aws::NimbleStudio
|
|
3867
3602
|
include Aws::Structure
|
3868
3603
|
end
|
3869
3604
|
|
3870
|
-
# @note When making an API call, you may pass UntagResourceRequest
|
3871
|
-
# data as a hash:
|
3872
|
-
#
|
3873
|
-
# {
|
3874
|
-
# resource_arn: "String", # required
|
3875
|
-
# tag_keys: ["String"], # required
|
3876
|
-
# }
|
3877
|
-
#
|
3878
3605
|
# @!attribute [rw] resource_arn
|
3879
3606
|
# Identifies the Amazon Resource Name(ARN) key from which you are
|
3880
3607
|
# removing tags.
|
@@ -3897,29 +3624,19 @@ module Aws::NimbleStudio
|
|
3897
3624
|
#
|
3898
3625
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
3899
3626
|
|
3900
|
-
# @note When making an API call, you may pass UpdateLaunchProfileMemberRequest
|
3901
|
-
# data as a hash:
|
3902
|
-
#
|
3903
|
-
# {
|
3904
|
-
# client_token: "ClientToken",
|
3905
|
-
# launch_profile_id: "String", # required
|
3906
|
-
# persona: "USER", # required, accepts USER
|
3907
|
-
# principal_id: "String", # required
|
3908
|
-
# studio_id: "String", # required
|
3909
|
-
# }
|
3910
|
-
#
|
3911
3627
|
# @!attribute [rw] client_token
|
3912
3628
|
# Unique, case-sensitive identifier that you provide to ensure the
|
3913
3629
|
# idempotency of the request. If you don’t specify a client token, the
|
3914
|
-
#
|
3915
|
-
# request to ensure idempotency.
|
3630
|
+
# Amazon Web Services SDK automatically generates a client token and
|
3631
|
+
# uses it for the request to ensure idempotency.
|
3916
3632
|
#
|
3917
3633
|
# **A suitable default value is auto-generated.** You should normally
|
3918
3634
|
# not need to pass this option.
|
3919
3635
|
# @return [String]
|
3920
3636
|
#
|
3921
3637
|
# @!attribute [rw] launch_profile_id
|
3922
|
-
# The
|
3638
|
+
# The ID of the launch profile used to control access from the
|
3639
|
+
# streaming session.
|
3923
3640
|
# @return [String]
|
3924
3641
|
#
|
3925
3642
|
# @!attribute [rw] persona
|
@@ -3959,38 +3676,11 @@ module Aws::NimbleStudio
|
|
3959
3676
|
include Aws::Structure
|
3960
3677
|
end
|
3961
3678
|
|
3962
|
-
# @note When making an API call, you may pass UpdateLaunchProfileRequest
|
3963
|
-
# data as a hash:
|
3964
|
-
#
|
3965
|
-
# {
|
3966
|
-
# client_token: "ClientToken",
|
3967
|
-
# description: "LaunchProfileDescription",
|
3968
|
-
# launch_profile_id: "String", # required
|
3969
|
-
# launch_profile_protocol_versions: ["LaunchProfileProtocolVersion"],
|
3970
|
-
# name: "LaunchProfileName",
|
3971
|
-
# stream_configuration: {
|
3972
|
-
# clipboard_mode: "ENABLED", # required, accepts ENABLED, DISABLED
|
3973
|
-
# ec2_instance_types: ["g4dn.xlarge"], # required, accepts g4dn.xlarge, g4dn.2xlarge, g4dn.4xlarge, g4dn.8xlarge, g4dn.12xlarge, g4dn.16xlarge, g3.4xlarge, g3s.xlarge, g5.xlarge, g5.2xlarge, g5.4xlarge, g5.8xlarge, g5.16xlarge
|
3974
|
-
# max_session_length_in_minutes: 1,
|
3975
|
-
# max_stopped_session_length_in_minutes: 1,
|
3976
|
-
# session_storage: {
|
3977
|
-
# mode: ["UPLOAD"], # required, accepts UPLOAD
|
3978
|
-
# root: {
|
3979
|
-
# linux: "StreamingSessionStorageRootPathLinux",
|
3980
|
-
# windows: "StreamingSessionStorageRootPathWindows",
|
3981
|
-
# },
|
3982
|
-
# },
|
3983
|
-
# streaming_image_ids: ["StreamingImageId"], # required
|
3984
|
-
# },
|
3985
|
-
# studio_component_ids: ["String"],
|
3986
|
-
# studio_id: "String", # required
|
3987
|
-
# }
|
3988
|
-
#
|
3989
3679
|
# @!attribute [rw] client_token
|
3990
3680
|
# Unique, case-sensitive identifier that you provide to ensure the
|
3991
3681
|
# idempotency of the request. If you don’t specify a client token, the
|
3992
|
-
#
|
3993
|
-
# request to ensure idempotency.
|
3682
|
+
# Amazon Web Services SDK automatically generates a client token and
|
3683
|
+
# uses it for the request to ensure idempotency.
|
3994
3684
|
#
|
3995
3685
|
# **A suitable default value is auto-generated.** You should normally
|
3996
3686
|
# not need to pass this option.
|
@@ -4001,7 +3691,8 @@ module Aws::NimbleStudio
|
|
4001
3691
|
# @return [String]
|
4002
3692
|
#
|
4003
3693
|
# @!attribute [rw] launch_profile_id
|
4004
|
-
# The
|
3694
|
+
# The ID of the launch profile used to control access from the
|
3695
|
+
# streaming session.
|
4005
3696
|
# @return [String]
|
4006
3697
|
#
|
4007
3698
|
# @!attribute [rw] launch_profile_protocol_versions
|
@@ -4053,22 +3744,11 @@ module Aws::NimbleStudio
|
|
4053
3744
|
include Aws::Structure
|
4054
3745
|
end
|
4055
3746
|
|
4056
|
-
# @note When making an API call, you may pass UpdateStreamingImageRequest
|
4057
|
-
# data as a hash:
|
4058
|
-
#
|
4059
|
-
# {
|
4060
|
-
# client_token: "ClientToken",
|
4061
|
-
# description: "StreamingImageDescription",
|
4062
|
-
# name: "StreamingImageName",
|
4063
|
-
# streaming_image_id: "String", # required
|
4064
|
-
# studio_id: "String", # required
|
4065
|
-
# }
|
4066
|
-
#
|
4067
3747
|
# @!attribute [rw] client_token
|
4068
3748
|
# Unique, case-sensitive identifier that you provide to ensure the
|
4069
3749
|
# idempotency of the request. If you don’t specify a client token, the
|
4070
|
-
#
|
4071
|
-
# request to ensure idempotency.
|
3750
|
+
# Amazon Web Services SDK automatically generates a client token and
|
3751
|
+
# uses it for the request to ensure idempotency.
|
4072
3752
|
#
|
4073
3753
|
# **A suitable default value is auto-generated.** You should normally
|
4074
3754
|
# not need to pass this option.
|
@@ -4112,9 +3792,9 @@ module Aws::NimbleStudio
|
|
4112
3792
|
# Amazon provides a number of streaming images that include popular
|
4113
3793
|
# 3rd-party software.
|
4114
3794
|
#
|
4115
|
-
# You can create your own streaming images using an Amazon
|
4116
|
-
#
|
4117
|
-
#
|
3795
|
+
# You can create your own streaming images using an Amazon EC2 machine
|
3796
|
+
# image that you create for this purpose. You can also include
|
3797
|
+
# software that your users require.
|
4118
3798
|
# @return [Types::StreamingImage]
|
4119
3799
|
#
|
4120
3800
|
# @see http://docs.aws.amazon.com/goto/WebAPI/nimble-2020-08-01/UpdateStreamingImageResponse AWS API Documentation
|
@@ -4125,67 +3805,11 @@ module Aws::NimbleStudio
|
|
4125
3805
|
include Aws::Structure
|
4126
3806
|
end
|
4127
3807
|
|
4128
|
-
# @note When making an API call, you may pass UpdateStudioComponentRequest
|
4129
|
-
# data as a hash:
|
4130
|
-
#
|
4131
|
-
# {
|
4132
|
-
# client_token: "ClientToken",
|
4133
|
-
# configuration: {
|
4134
|
-
# active_directory_configuration: {
|
4135
|
-
# computer_attributes: [
|
4136
|
-
# {
|
4137
|
-
# name: "ActiveDirectoryComputerAttributeName",
|
4138
|
-
# value: "ActiveDirectoryComputerAttributeValue",
|
4139
|
-
# },
|
4140
|
-
# ],
|
4141
|
-
# directory_id: "DirectoryId",
|
4142
|
-
# organizational_unit_distinguished_name: "ActiveDirectoryOrganizationalUnitDistinguishedName",
|
4143
|
-
# },
|
4144
|
-
# compute_farm_configuration: {
|
4145
|
-
# active_directory_user: "String",
|
4146
|
-
# endpoint: "SensitiveString",
|
4147
|
-
# },
|
4148
|
-
# license_service_configuration: {
|
4149
|
-
# endpoint: "SensitiveString",
|
4150
|
-
# },
|
4151
|
-
# shared_file_system_configuration: {
|
4152
|
-
# endpoint: "SensitiveString",
|
4153
|
-
# file_system_id: "String",
|
4154
|
-
# linux_mount_point: "LinuxMountPoint",
|
4155
|
-
# share_name: "SensitiveString",
|
4156
|
-
# windows_mount_drive: "WindowsMountDrive",
|
4157
|
-
# },
|
4158
|
-
# },
|
4159
|
-
# description: "StudioComponentDescription",
|
4160
|
-
# ec2_security_group_ids: ["SecurityGroupId"],
|
4161
|
-
# initialization_scripts: [
|
4162
|
-
# {
|
4163
|
-
# launch_profile_protocol_version: "LaunchProfileProtocolVersion",
|
4164
|
-
# platform: "LINUX", # accepts LINUX, WINDOWS
|
4165
|
-
# run_context: "SYSTEM_INITIALIZATION", # accepts SYSTEM_INITIALIZATION, USER_INITIALIZATION
|
4166
|
-
# script: "StudioComponentInitializationScriptContent",
|
4167
|
-
# },
|
4168
|
-
# ],
|
4169
|
-
# name: "StudioComponentName",
|
4170
|
-
# runtime_role_arn: "RoleArn",
|
4171
|
-
# script_parameters: [
|
4172
|
-
# {
|
4173
|
-
# key: "ScriptParameterKey",
|
4174
|
-
# value: "ScriptParameterValue",
|
4175
|
-
# },
|
4176
|
-
# ],
|
4177
|
-
# secure_initialization_role_arn: "RoleArn",
|
4178
|
-
# studio_component_id: "String", # required
|
4179
|
-
# studio_id: "String", # required
|
4180
|
-
# subtype: "AWS_MANAGED_MICROSOFT_AD", # accepts AWS_MANAGED_MICROSOFT_AD, AMAZON_FSX_FOR_WINDOWS, AMAZON_FSX_FOR_LUSTRE, CUSTOM
|
4181
|
-
# type: "ACTIVE_DIRECTORY", # accepts ACTIVE_DIRECTORY, SHARED_FILE_SYSTEM, COMPUTE_FARM, LICENSE_SERVICE, CUSTOM
|
4182
|
-
# }
|
4183
|
-
#
|
4184
3808
|
# @!attribute [rw] client_token
|
4185
3809
|
# Unique, case-sensitive identifier that you provide to ensure the
|
4186
3810
|
# idempotency of the request. If you don’t specify a client token, the
|
4187
|
-
#
|
4188
|
-
# request to ensure idempotency.
|
3811
|
+
# Amazon Web Services SDK automatically generates a client token and
|
3812
|
+
# uses it for the request to ensure idempotency.
|
4189
3813
|
#
|
4190
3814
|
# **A suitable default value is auto-generated.** You should normally
|
4191
3815
|
# not need to pass this option.
|
@@ -4213,8 +3837,8 @@ module Aws::NimbleStudio
|
|
4213
3837
|
#
|
4214
3838
|
# @!attribute [rw] runtime_role_arn
|
4215
3839
|
# An IAM role attached to a Studio Component that gives the studio
|
4216
|
-
# component access to
|
4217
|
-
# running.
|
3840
|
+
# component access to Amazon Web Services resources at anytime while
|
3841
|
+
# the instance is running.
|
4218
3842
|
# @return [String]
|
4219
3843
|
#
|
4220
3844
|
# @!attribute [rw] script_parameters
|
@@ -4224,7 +3848,8 @@ module Aws::NimbleStudio
|
|
4224
3848
|
# @!attribute [rw] secure_initialization_role_arn
|
4225
3849
|
# An IAM role attached to Studio Component when the system
|
4226
3850
|
# initialization script runs which give the studio component access to
|
4227
|
-
#
|
3851
|
+
# Amazon Web Services resources when the system initialization script
|
3852
|
+
# runs.
|
4228
3853
|
# @return [String]
|
4229
3854
|
#
|
4230
3855
|
# @!attribute [rw] studio_component_id
|
@@ -4275,17 +3900,6 @@ module Aws::NimbleStudio
|
|
4275
3900
|
include Aws::Structure
|
4276
3901
|
end
|
4277
3902
|
|
4278
|
-
# @note When making an API call, you may pass UpdateStudioRequest
|
4279
|
-
# data as a hash:
|
4280
|
-
#
|
4281
|
-
# {
|
4282
|
-
# admin_role_arn: "RoleArn",
|
4283
|
-
# client_token: "ClientToken",
|
4284
|
-
# display_name: "StudioDisplayName",
|
4285
|
-
# studio_id: "String", # required
|
4286
|
-
# user_role_arn: "RoleArn",
|
4287
|
-
# }
|
4288
|
-
#
|
4289
3903
|
# @!attribute [rw] admin_role_arn
|
4290
3904
|
# The IAM role that Studio Admins will assume when logging in to the
|
4291
3905
|
# Nimble Studio portal.
|
@@ -4294,8 +3908,8 @@ module Aws::NimbleStudio
|
|
4294
3908
|
# @!attribute [rw] client_token
|
4295
3909
|
# Unique, case-sensitive identifier that you provide to ensure the
|
4296
3910
|
# idempotency of the request. If you don’t specify a client token, the
|
4297
|
-
#
|
4298
|
-
# request to ensure idempotency.
|
3911
|
+
# Amazon Web Services SDK automatically generates a client token and
|
3912
|
+
# uses it for the request to ensure idempotency.
|
4299
3913
|
#
|
4300
3914
|
# **A suitable default value is auto-generated.** You should normally
|
4301
3915
|
# not need to pass this option.
|
@@ -4392,5 +4006,36 @@ module Aws::NimbleStudio
|
|
4392
4006
|
include Aws::Structure
|
4393
4007
|
end
|
4394
4008
|
|
4009
|
+
# Custom volume configuration for the root volumes that are attached to
|
4010
|
+
# streaming sessions.
|
4011
|
+
#
|
4012
|
+
# This parameter is only allowed when `sessionPersistenceMode` is
|
4013
|
+
# `ACTIVATED`.
|
4014
|
+
#
|
4015
|
+
# @!attribute [rw] iops
|
4016
|
+
# The number of I/O operations per second for the root volume that is
|
4017
|
+
# attached to streaming session.
|
4018
|
+
# @return [Integer]
|
4019
|
+
#
|
4020
|
+
# @!attribute [rw] size
|
4021
|
+
# The size of the root volume that is attached to the streaming
|
4022
|
+
# session. The root volume size is measured in GiBs.
|
4023
|
+
# @return [Integer]
|
4024
|
+
#
|
4025
|
+
# @!attribute [rw] throughput
|
4026
|
+
# The throughput to provision for the root volume that is attached to
|
4027
|
+
# the streaming session. The throughput is measured in MiB/s.
|
4028
|
+
# @return [Integer]
|
4029
|
+
#
|
4030
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/nimble-2020-08-01/VolumeConfiguration AWS API Documentation
|
4031
|
+
#
|
4032
|
+
class VolumeConfiguration < Struct.new(
|
4033
|
+
:iops,
|
4034
|
+
:size,
|
4035
|
+
:throughput)
|
4036
|
+
SENSITIVE = []
|
4037
|
+
include Aws::Structure
|
4038
|
+
end
|
4039
|
+
|
4395
4040
|
end
|
4396
4041
|
end
|