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
@@ -373,8 +373,8 @@ module Aws::NimbleStudio
|
|
373
373
|
# @option params [String] :client_token
|
374
374
|
# Unique, case-sensitive identifier that you provide to ensure the
|
375
375
|
# idempotency of the request. If you don’t specify a client token, the
|
376
|
-
#
|
377
|
-
# request to ensure idempotency.
|
376
|
+
# Amazon Web Services SDK automatically generates a client token and
|
377
|
+
# uses it for the request to ensure idempotency.
|
378
378
|
#
|
379
379
|
# **A suitable default value is auto-generated.** You should normally
|
380
380
|
# not need to pass this option.**
|
@@ -420,8 +420,8 @@ module Aws::NimbleStudio
|
|
420
420
|
# @option params [String] :client_token
|
421
421
|
# Unique, case-sensitive identifier that you provide to ensure the
|
422
422
|
# idempotency of the request. If you don’t specify a client token, the
|
423
|
-
#
|
424
|
-
# request to ensure idempotency.
|
423
|
+
# Amazon Web Services SDK automatically generates a client token and
|
424
|
+
# uses it for the request to ensure idempotency.
|
425
425
|
#
|
426
426
|
# **A suitable default value is auto-generated.** You should normally
|
427
427
|
# not need to pass this option.**
|
@@ -452,7 +452,7 @@ module Aws::NimbleStudio
|
|
452
452
|
# The studio ID.
|
453
453
|
#
|
454
454
|
# @option params [Hash<String,String>] :tags
|
455
|
-
# A collection of labels, in the form of key
|
455
|
+
# A collection of labels, in the form of key-value pairs, that apply to
|
456
456
|
# this resource.
|
457
457
|
#
|
458
458
|
# @return [Types::CreateLaunchProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -468,10 +468,16 @@ module Aws::NimbleStudio
|
|
468
468
|
# launch_profile_protocol_versions: ["LaunchProfileProtocolVersion"], # required
|
469
469
|
# name: "LaunchProfileName", # required
|
470
470
|
# stream_configuration: { # required
|
471
|
+
# automatic_termination_mode: "DEACTIVATED", # accepts DEACTIVATED, ACTIVATED
|
471
472
|
# clipboard_mode: "ENABLED", # required, accepts ENABLED, DISABLED
|
472
473
|
# 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
|
473
474
|
# max_session_length_in_minutes: 1,
|
474
475
|
# max_stopped_session_length_in_minutes: 1,
|
476
|
+
# session_backup: {
|
477
|
+
# max_backups_to_retain: 1,
|
478
|
+
# mode: "AUTOMATIC", # accepts AUTOMATIC, DEACTIVATED
|
479
|
+
# },
|
480
|
+
# session_persistence_mode: "DEACTIVATED", # accepts DEACTIVATED, ACTIVATED
|
475
481
|
# session_storage: {
|
476
482
|
# mode: ["UPLOAD"], # required, accepts UPLOAD
|
477
483
|
# root: {
|
@@ -480,6 +486,11 @@ module Aws::NimbleStudio
|
|
480
486
|
# },
|
481
487
|
# },
|
482
488
|
# streaming_image_ids: ["StreamingImageId"], # required
|
489
|
+
# volume_configuration: {
|
490
|
+
# iops: 1,
|
491
|
+
# size: 1,
|
492
|
+
# throughput: 1,
|
493
|
+
# },
|
483
494
|
# },
|
484
495
|
# studio_component_ids: ["String"], # required
|
485
496
|
# studio_id: "String", # required
|
@@ -503,17 +514,24 @@ module Aws::NimbleStudio
|
|
503
514
|
# resp.launch_profile.state #=> String, one of "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED"
|
504
515
|
# resp.launch_profile.status_code #=> String, one of "LAUNCH_PROFILE_CREATED", "LAUNCH_PROFILE_UPDATED", "LAUNCH_PROFILE_DELETED", "LAUNCH_PROFILE_CREATE_IN_PROGRESS", "LAUNCH_PROFILE_UPDATE_IN_PROGRESS", "LAUNCH_PROFILE_DELETE_IN_PROGRESS", "INTERNAL_ERROR", "STREAMING_IMAGE_NOT_FOUND", "STREAMING_IMAGE_NOT_READY", "LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED", "ENCRYPTION_KEY_ACCESS_DENIED", "ENCRYPTION_KEY_NOT_FOUND", "INVALID_SUBNETS_PROVIDED", "INVALID_INSTANCE_TYPES_PROVIDED", "INVALID_SUBNETS_COMBINATION"
|
505
516
|
# resp.launch_profile.status_message #=> String
|
517
|
+
# resp.launch_profile.stream_configuration.automatic_termination_mode #=> String, one of "DEACTIVATED", "ACTIVATED"
|
506
518
|
# resp.launch_profile.stream_configuration.clipboard_mode #=> String, one of "ENABLED", "DISABLED"
|
507
519
|
# resp.launch_profile.stream_configuration.ec2_instance_types #=> Array
|
508
520
|
# resp.launch_profile.stream_configuration.ec2_instance_types[0] #=> String, one of "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"
|
509
521
|
# resp.launch_profile.stream_configuration.max_session_length_in_minutes #=> Integer
|
510
522
|
# resp.launch_profile.stream_configuration.max_stopped_session_length_in_minutes #=> Integer
|
523
|
+
# resp.launch_profile.stream_configuration.session_backup.max_backups_to_retain #=> Integer
|
524
|
+
# resp.launch_profile.stream_configuration.session_backup.mode #=> String, one of "AUTOMATIC", "DEACTIVATED"
|
525
|
+
# resp.launch_profile.stream_configuration.session_persistence_mode #=> String, one of "DEACTIVATED", "ACTIVATED"
|
511
526
|
# resp.launch_profile.stream_configuration.session_storage.mode #=> Array
|
512
527
|
# resp.launch_profile.stream_configuration.session_storage.mode[0] #=> String, one of "UPLOAD"
|
513
528
|
# resp.launch_profile.stream_configuration.session_storage.root.linux #=> String
|
514
529
|
# resp.launch_profile.stream_configuration.session_storage.root.windows #=> String
|
515
530
|
# resp.launch_profile.stream_configuration.streaming_image_ids #=> Array
|
516
531
|
# resp.launch_profile.stream_configuration.streaming_image_ids[0] #=> String
|
532
|
+
# resp.launch_profile.stream_configuration.volume_configuration.iops #=> Integer
|
533
|
+
# resp.launch_profile.stream_configuration.volume_configuration.size #=> Integer
|
534
|
+
# resp.launch_profile.stream_configuration.volume_configuration.throughput #=> Integer
|
517
535
|
# resp.launch_profile.studio_component_ids #=> Array
|
518
536
|
# resp.launch_profile.studio_component_ids[0] #=> String
|
519
537
|
# resp.launch_profile.tags #=> Hash
|
@@ -540,8 +558,8 @@ module Aws::NimbleStudio
|
|
540
558
|
# @option params [String] :client_token
|
541
559
|
# Unique, case-sensitive identifier that you provide to ensure the
|
542
560
|
# idempotency of the request. If you don’t specify a client token, the
|
543
|
-
#
|
544
|
-
# request to ensure idempotency.
|
561
|
+
# Amazon Web Services SDK automatically generates a client token and
|
562
|
+
# uses it for the request to ensure idempotency.
|
545
563
|
#
|
546
564
|
# **A suitable default value is auto-generated.** You should normally
|
547
565
|
# not need to pass this option.**
|
@@ -560,7 +578,7 @@ module Aws::NimbleStudio
|
|
560
578
|
# The studio ID.
|
561
579
|
#
|
562
580
|
# @option params [Hash<String,String>] :tags
|
563
|
-
# A collection of labels, in the form of key
|
581
|
+
# A collection of labels, in the form of key-value pairs, that apply to
|
564
582
|
# this resource.
|
565
583
|
#
|
566
584
|
# @return [Types::CreateStreamingImageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -611,13 +629,13 @@ module Aws::NimbleStudio
|
|
611
629
|
# Creates a streaming session in a studio.
|
612
630
|
#
|
613
631
|
# After invoking this operation, you must poll GetStreamingSession until
|
614
|
-
# the streaming session is in
|
632
|
+
# the streaming session is in the `READY` state.
|
615
633
|
#
|
616
634
|
# @option params [String] :client_token
|
617
635
|
# Unique, case-sensitive identifier that you provide to ensure the
|
618
636
|
# idempotency of the request. If you don’t specify a client token, the
|
619
|
-
#
|
620
|
-
# request to ensure idempotency.
|
637
|
+
# Amazon Web Services SDK automatically generates a client token and
|
638
|
+
# uses it for the request to ensure idempotency.
|
621
639
|
#
|
622
640
|
# **A suitable default value is auto-generated.** You should normally
|
623
641
|
# not need to pass this option.**
|
@@ -625,8 +643,9 @@ module Aws::NimbleStudio
|
|
625
643
|
# @option params [String] :ec2_instance_type
|
626
644
|
# The EC2 Instance type used for the streaming session.
|
627
645
|
#
|
628
|
-
# @option params [String] :launch_profile_id
|
629
|
-
# The launch profile
|
646
|
+
# @option params [required, String] :launch_profile_id
|
647
|
+
# The ID of the launch profile used to control access from the streaming
|
648
|
+
# session.
|
630
649
|
#
|
631
650
|
# @option params [String] :owned_by
|
632
651
|
# The user ID of the user that owns the streaming session. The user that
|
@@ -640,7 +659,7 @@ module Aws::NimbleStudio
|
|
640
659
|
# The studio ID.
|
641
660
|
#
|
642
661
|
# @option params [Hash<String,String>] :tags
|
643
|
-
# A collection of labels, in the form of key
|
662
|
+
# A collection of labels, in the form of key-value pairs, that apply to
|
644
663
|
# this resource.
|
645
664
|
#
|
646
665
|
# @return [Types::CreateStreamingSessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -652,7 +671,7 @@ module Aws::NimbleStudio
|
|
652
671
|
# resp = client.create_streaming_session({
|
653
672
|
# client_token: "ClientToken",
|
654
673
|
# 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
|
655
|
-
# launch_profile_id: "String",
|
674
|
+
# launch_profile_id: "String", # required
|
656
675
|
# owned_by: "String",
|
657
676
|
# streaming_image_id: "StreamingImageId",
|
658
677
|
# studio_id: "String", # required
|
@@ -664,14 +683,19 @@ module Aws::NimbleStudio
|
|
664
683
|
# @example Response structure
|
665
684
|
#
|
666
685
|
# resp.session.arn #=> String
|
686
|
+
# resp.session.automatic_termination_mode #=> String, one of "DEACTIVATED", "ACTIVATED"
|
687
|
+
# resp.session.backup_mode #=> String, one of "AUTOMATIC", "DEACTIVATED"
|
667
688
|
# resp.session.created_at #=> Time
|
668
689
|
# resp.session.created_by #=> String
|
669
690
|
# resp.session.ec2_instance_type #=> String
|
670
691
|
# resp.session.launch_profile_id #=> String
|
692
|
+
# resp.session.max_backups_to_retain #=> Integer
|
671
693
|
# resp.session.owned_by #=> String
|
672
694
|
# resp.session.session_id #=> String
|
695
|
+
# resp.session.session_persistence_mode #=> String, one of "DEACTIVATED", "ACTIVATED"
|
673
696
|
# resp.session.started_at #=> Time
|
674
697
|
# resp.session.started_by #=> String
|
698
|
+
# resp.session.started_from_backup_id #=> String
|
675
699
|
# resp.session.state #=> String, one of "CREATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "READY", "DELETED", "CREATE_FAILED", "DELETE_FAILED", "STOP_IN_PROGRESS", "START_IN_PROGRESS", "STOPPED", "STOP_FAILED", "START_FAILED"
|
676
700
|
# resp.session.status_code #=> String, one of "STREAMING_SESSION_READY", "STREAMING_SESSION_DELETED", "STREAMING_SESSION_CREATE_IN_PROGRESS", "STREAMING_SESSION_DELETE_IN_PROGRESS", "INTERNAL_ERROR", "INSUFFICIENT_CAPACITY", "ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR", "NETWORK_CONNECTION_ERROR", "INITIALIZATION_SCRIPT_ERROR", "DECRYPT_STREAMING_IMAGE_ERROR", "NETWORK_INTERFACE_ERROR", "STREAMING_SESSION_STOPPED", "STREAMING_SESSION_STARTED", "STREAMING_SESSION_STOP_IN_PROGRESS", "STREAMING_SESSION_START_IN_PROGRESS", "AMI_VALIDATION_ERROR"
|
677
701
|
# resp.session.status_message #=> String
|
@@ -684,6 +708,10 @@ module Aws::NimbleStudio
|
|
684
708
|
# resp.session.terminate_at #=> Time
|
685
709
|
# resp.session.updated_at #=> Time
|
686
710
|
# resp.session.updated_by #=> String
|
711
|
+
# resp.session.volume_configuration.iops #=> Integer
|
712
|
+
# resp.session.volume_configuration.size #=> Integer
|
713
|
+
# resp.session.volume_configuration.throughput #=> Integer
|
714
|
+
# resp.session.volume_retention_mode #=> String, one of "RETAIN", "DELETE"
|
687
715
|
#
|
688
716
|
# @see http://docs.aws.amazon.com/goto/WebAPI/nimble-2020-08-01/CreateStreamingSession AWS API Documentation
|
689
717
|
#
|
@@ -697,13 +725,14 @@ module Aws::NimbleStudio
|
|
697
725
|
# Creates a streaming session stream for a streaming session.
|
698
726
|
#
|
699
727
|
# After invoking this API, invoke GetStreamingSessionStream with the
|
700
|
-
# returned streamId to poll the resource until it is in
|
728
|
+
# returned streamId to poll the resource until it is in the `READY`
|
729
|
+
# state.
|
701
730
|
#
|
702
731
|
# @option params [String] :client_token
|
703
732
|
# Unique, case-sensitive identifier that you provide to ensure the
|
704
733
|
# idempotency of the request. If you don’t specify a client token, the
|
705
|
-
#
|
706
|
-
# request to ensure idempotency.
|
734
|
+
# Amazon Web Services SDK automatically generates a client token and
|
735
|
+
# uses it for the request to ensure idempotency.
|
707
736
|
#
|
708
737
|
# **A suitable default value is auto-generated.** You should normally
|
709
738
|
# not need to pass this option.**
|
@@ -750,26 +779,26 @@ module Aws::NimbleStudio
|
|
750
779
|
req.send_request(options)
|
751
780
|
end
|
752
781
|
|
753
|
-
# Create a new
|
782
|
+
# Create a new studio.
|
754
783
|
#
|
755
|
-
# When creating a
|
756
|
-
# and the user
|
784
|
+
# When creating a studio, two IAM roles must be provided: the admin role
|
785
|
+
# and the user role. These roles are assumed by your users when they log
|
757
786
|
# in to the Nimble Studio portal.
|
758
787
|
#
|
759
|
-
# The user role must have the AmazonNimbleStudio-StudioUser managed
|
788
|
+
# The user role must have the `AmazonNimbleStudio-StudioUser` managed
|
760
789
|
# policy attached for the portal to function properly.
|
761
790
|
#
|
762
|
-
# The
|
791
|
+
# The admin role must have the `AmazonNimbleStudio-StudioAdmin` managed
|
763
792
|
# policy attached for the portal to function properly.
|
764
793
|
#
|
765
794
|
# You may optionally specify a KMS key in the
|
766
|
-
# StudioEncryptionConfiguration
|
795
|
+
# `StudioEncryptionConfiguration`.
|
767
796
|
#
|
768
797
|
# In Nimble Studio, resource names, descriptions, initialization
|
769
798
|
# scripts, and other data you provide are always encrypted at rest using
|
770
799
|
# an KMS key. By default, this key is owned by Amazon Web Services and
|
771
800
|
# managed on your behalf. You may provide your own KMS key when calling
|
772
|
-
# CreateStudio to encrypt this data using a key you own and manage.
|
801
|
+
# `CreateStudio` to encrypt this data using a key you own and manage.
|
773
802
|
#
|
774
803
|
# When providing an KMS key during studio creation, Nimble Studio
|
775
804
|
# creates KMS grants in your account to provide your studio user and
|
@@ -782,14 +811,14 @@ module Aws::NimbleStudio
|
|
782
811
|
# accessible.
|
783
812
|
#
|
784
813
|
# @option params [required, String] :admin_role_arn
|
785
|
-
# The IAM role that
|
814
|
+
# The IAM role that studio admins will assume when logging in to the
|
786
815
|
# Nimble Studio portal.
|
787
816
|
#
|
788
817
|
# @option params [String] :client_token
|
789
818
|
# Unique, case-sensitive identifier that you provide to ensure the
|
790
819
|
# idempotency of the request. If you don’t specify a client token, the
|
791
|
-
#
|
792
|
-
# request to ensure idempotency.
|
820
|
+
# Amazon Web Services SDK automatically generates a client token and
|
821
|
+
# uses it for the request to ensure idempotency.
|
793
822
|
#
|
794
823
|
# **A suitable default value is auto-generated.** You should normally
|
795
824
|
# not need to pass this option.**
|
@@ -805,11 +834,11 @@ module Aws::NimbleStudio
|
|
805
834
|
# when accessed by Nimble Studio users.
|
806
835
|
#
|
807
836
|
# @option params [Hash<String,String>] :tags
|
808
|
-
# A collection of labels, in the form of key
|
837
|
+
# A collection of labels, in the form of key-value pairs, that apply to
|
809
838
|
# this resource.
|
810
839
|
#
|
811
840
|
# @option params [required, String] :user_role_arn
|
812
|
-
# The IAM role that
|
841
|
+
# The IAM role that studio users will assume when logging in to the
|
813
842
|
# Nimble Studio portal.
|
814
843
|
#
|
815
844
|
# @return [Types::CreateStudioResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -842,7 +871,7 @@ module Aws::NimbleStudio
|
|
842
871
|
# resp.studio.home_region #=> String
|
843
872
|
# resp.studio.sso_client_id #=> String
|
844
873
|
# resp.studio.state #=> String, one of "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED"
|
845
|
-
# resp.studio.status_code #=> String, one of "STUDIO_CREATED", "STUDIO_DELETED", "STUDIO_UPDATED", "STUDIO_CREATE_IN_PROGRESS", "STUDIO_UPDATE_IN_PROGRESS", "STUDIO_DELETE_IN_PROGRESS", "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED", "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED", "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED", "AWS_SSO_NOT_ENABLED", "AWS_SSO_ACCESS_DENIED", "ROLE_NOT_OWNED_BY_STUDIO_OWNER", "ROLE_COULD_NOT_BE_ASSUMED", "INTERNAL_ERROR", "ENCRYPTION_KEY_NOT_FOUND", "ENCRYPTION_KEY_ACCESS_DENIED", "AWS_SSO_CONFIGURATION_REPAIRED", "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS"
|
874
|
+
# resp.studio.status_code #=> String, one of "STUDIO_CREATED", "STUDIO_DELETED", "STUDIO_UPDATED", "STUDIO_CREATE_IN_PROGRESS", "STUDIO_UPDATE_IN_PROGRESS", "STUDIO_DELETE_IN_PROGRESS", "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED", "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED", "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED", "AWS_SSO_NOT_ENABLED", "AWS_SSO_ACCESS_DENIED", "ROLE_NOT_OWNED_BY_STUDIO_OWNER", "ROLE_COULD_NOT_BE_ASSUMED", "INTERNAL_ERROR", "ENCRYPTION_KEY_NOT_FOUND", "ENCRYPTION_KEY_ACCESS_DENIED", "AWS_SSO_CONFIGURATION_REPAIRED", "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS", "AWS_STS_REGION_DISABLED"
|
846
875
|
# resp.studio.status_message #=> String
|
847
876
|
# resp.studio.studio_encryption_configuration.key_arn #=> String
|
848
877
|
# resp.studio.studio_encryption_configuration.key_type #=> String, one of "AWS_OWNED_KEY", "CUSTOMER_MANAGED_KEY"
|
@@ -868,8 +897,8 @@ module Aws::NimbleStudio
|
|
868
897
|
# @option params [String] :client_token
|
869
898
|
# Unique, case-sensitive identifier that you provide to ensure the
|
870
899
|
# idempotency of the request. If you don’t specify a client token, the
|
871
|
-
#
|
872
|
-
# request to ensure idempotency.
|
900
|
+
# Amazon Web Services SDK automatically generates a client token and
|
901
|
+
# uses it for the request to ensure idempotency.
|
873
902
|
#
|
874
903
|
# **A suitable default value is auto-generated.** You should normally
|
875
904
|
# not need to pass this option.**
|
@@ -891,8 +920,8 @@ module Aws::NimbleStudio
|
|
891
920
|
#
|
892
921
|
# @option params [String] :runtime_role_arn
|
893
922
|
# An IAM role attached to a Studio Component that gives the studio
|
894
|
-
# component access to
|
895
|
-
# running.
|
923
|
+
# component access to Amazon Web Services resources at anytime while the
|
924
|
+
# instance is running.
|
896
925
|
#
|
897
926
|
# @option params [Array<Types::ScriptParameterKeyValue>] :script_parameters
|
898
927
|
# Parameters for the studio component scripts.
|
@@ -900,7 +929,8 @@ module Aws::NimbleStudio
|
|
900
929
|
# @option params [String] :secure_initialization_role_arn
|
901
930
|
# An IAM role attached to Studio Component when the system
|
902
931
|
# initialization script runs which give the studio component access to
|
903
|
-
#
|
932
|
+
# Amazon Web Services resources when the system initialization script
|
933
|
+
# runs.
|
904
934
|
#
|
905
935
|
# @option params [required, String] :studio_id
|
906
936
|
# The studio ID.
|
@@ -909,7 +939,7 @@ module Aws::NimbleStudio
|
|
909
939
|
# The specific subtype of a studio component.
|
910
940
|
#
|
911
941
|
# @option params [Hash<String,String>] :tags
|
912
|
-
# A collection of labels, in the form of key
|
942
|
+
# A collection of labels, in the form of key-value pairs, that apply to
|
913
943
|
# this resource.
|
914
944
|
#
|
915
945
|
# @option params [required, String] :type
|
@@ -1033,14 +1063,15 @@ module Aws::NimbleStudio
|
|
1033
1063
|
# @option params [String] :client_token
|
1034
1064
|
# Unique, case-sensitive identifier that you provide to ensure the
|
1035
1065
|
# idempotency of the request. If you don’t specify a client token, the
|
1036
|
-
#
|
1037
|
-
# request to ensure idempotency.
|
1066
|
+
# Amazon Web Services SDK automatically generates a client token and
|
1067
|
+
# uses it for the request to ensure idempotency.
|
1038
1068
|
#
|
1039
1069
|
# **A suitable default value is auto-generated.** You should normally
|
1040
1070
|
# not need to pass this option.**
|
1041
1071
|
#
|
1042
1072
|
# @option params [required, String] :launch_profile_id
|
1043
|
-
# The
|
1073
|
+
# The ID of the launch profile used to control access from the streaming
|
1074
|
+
# session.
|
1044
1075
|
#
|
1045
1076
|
# @option params [required, String] :studio_id
|
1046
1077
|
# The studio ID.
|
@@ -1072,17 +1103,24 @@ module Aws::NimbleStudio
|
|
1072
1103
|
# resp.launch_profile.state #=> String, one of "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED"
|
1073
1104
|
# resp.launch_profile.status_code #=> String, one of "LAUNCH_PROFILE_CREATED", "LAUNCH_PROFILE_UPDATED", "LAUNCH_PROFILE_DELETED", "LAUNCH_PROFILE_CREATE_IN_PROGRESS", "LAUNCH_PROFILE_UPDATE_IN_PROGRESS", "LAUNCH_PROFILE_DELETE_IN_PROGRESS", "INTERNAL_ERROR", "STREAMING_IMAGE_NOT_FOUND", "STREAMING_IMAGE_NOT_READY", "LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED", "ENCRYPTION_KEY_ACCESS_DENIED", "ENCRYPTION_KEY_NOT_FOUND", "INVALID_SUBNETS_PROVIDED", "INVALID_INSTANCE_TYPES_PROVIDED", "INVALID_SUBNETS_COMBINATION"
|
1074
1105
|
# resp.launch_profile.status_message #=> String
|
1106
|
+
# resp.launch_profile.stream_configuration.automatic_termination_mode #=> String, one of "DEACTIVATED", "ACTIVATED"
|
1075
1107
|
# resp.launch_profile.stream_configuration.clipboard_mode #=> String, one of "ENABLED", "DISABLED"
|
1076
1108
|
# resp.launch_profile.stream_configuration.ec2_instance_types #=> Array
|
1077
1109
|
# resp.launch_profile.stream_configuration.ec2_instance_types[0] #=> String, one of "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"
|
1078
1110
|
# resp.launch_profile.stream_configuration.max_session_length_in_minutes #=> Integer
|
1079
1111
|
# resp.launch_profile.stream_configuration.max_stopped_session_length_in_minutes #=> Integer
|
1112
|
+
# resp.launch_profile.stream_configuration.session_backup.max_backups_to_retain #=> Integer
|
1113
|
+
# resp.launch_profile.stream_configuration.session_backup.mode #=> String, one of "AUTOMATIC", "DEACTIVATED"
|
1114
|
+
# resp.launch_profile.stream_configuration.session_persistence_mode #=> String, one of "DEACTIVATED", "ACTIVATED"
|
1080
1115
|
# resp.launch_profile.stream_configuration.session_storage.mode #=> Array
|
1081
1116
|
# resp.launch_profile.stream_configuration.session_storage.mode[0] #=> String, one of "UPLOAD"
|
1082
1117
|
# resp.launch_profile.stream_configuration.session_storage.root.linux #=> String
|
1083
1118
|
# resp.launch_profile.stream_configuration.session_storage.root.windows #=> String
|
1084
1119
|
# resp.launch_profile.stream_configuration.streaming_image_ids #=> Array
|
1085
1120
|
# resp.launch_profile.stream_configuration.streaming_image_ids[0] #=> String
|
1121
|
+
# resp.launch_profile.stream_configuration.volume_configuration.iops #=> Integer
|
1122
|
+
# resp.launch_profile.stream_configuration.volume_configuration.size #=> Integer
|
1123
|
+
# resp.launch_profile.stream_configuration.volume_configuration.throughput #=> Integer
|
1086
1124
|
# resp.launch_profile.studio_component_ids #=> Array
|
1087
1125
|
# resp.launch_profile.studio_component_ids[0] #=> String
|
1088
1126
|
# resp.launch_profile.tags #=> Hash
|
@@ -1109,14 +1147,15 @@ module Aws::NimbleStudio
|
|
1109
1147
|
# @option params [String] :client_token
|
1110
1148
|
# Unique, case-sensitive identifier that you provide to ensure the
|
1111
1149
|
# idempotency of the request. If you don’t specify a client token, the
|
1112
|
-
#
|
1113
|
-
# request to ensure idempotency.
|
1150
|
+
# Amazon Web Services SDK automatically generates a client token and
|
1151
|
+
# uses it for the request to ensure idempotency.
|
1114
1152
|
#
|
1115
1153
|
# **A suitable default value is auto-generated.** You should normally
|
1116
1154
|
# not need to pass this option.**
|
1117
1155
|
#
|
1118
1156
|
# @option params [required, String] :launch_profile_id
|
1119
|
-
# The
|
1157
|
+
# The ID of the launch profile used to control access from the streaming
|
1158
|
+
# session.
|
1120
1159
|
#
|
1121
1160
|
# @option params [required, String] :principal_id
|
1122
1161
|
# The principal ID. This currently supports a IAM Identity Center
|
@@ -1150,8 +1189,8 @@ module Aws::NimbleStudio
|
|
1150
1189
|
# @option params [String] :client_token
|
1151
1190
|
# Unique, case-sensitive identifier that you provide to ensure the
|
1152
1191
|
# idempotency of the request. If you don’t specify a client token, the
|
1153
|
-
#
|
1154
|
-
# request to ensure idempotency.
|
1192
|
+
# Amazon Web Services SDK automatically generates a client token and
|
1193
|
+
# uses it for the request to ensure idempotency.
|
1155
1194
|
#
|
1156
1195
|
# **A suitable default value is auto-generated.** You should normally
|
1157
1196
|
# not need to pass this option.**
|
@@ -1205,16 +1244,16 @@ module Aws::NimbleStudio
|
|
1205
1244
|
# Deletes streaming session resource.
|
1206
1245
|
#
|
1207
1246
|
# After invoking this operation, use GetStreamingSession to poll the
|
1208
|
-
# resource until it transitions to a DELETED state.
|
1247
|
+
# resource until it transitions to a `DELETED` state.
|
1209
1248
|
#
|
1210
1249
|
# A streaming session will count against your streaming session quota
|
1211
|
-
# until it is marked DELETED
|
1250
|
+
# until it is marked `DELETED`.
|
1212
1251
|
#
|
1213
1252
|
# @option params [String] :client_token
|
1214
1253
|
# Unique, case-sensitive identifier that you provide to ensure the
|
1215
1254
|
# idempotency of the request. If you don’t specify a client token, the
|
1216
|
-
#
|
1217
|
-
# request to ensure idempotency.
|
1255
|
+
# Amazon Web Services SDK automatically generates a client token and
|
1256
|
+
# uses it for the request to ensure idempotency.
|
1218
1257
|
#
|
1219
1258
|
# **A suitable default value is auto-generated.** You should normally
|
1220
1259
|
# not need to pass this option.**
|
@@ -1240,14 +1279,19 @@ module Aws::NimbleStudio
|
|
1240
1279
|
# @example Response structure
|
1241
1280
|
#
|
1242
1281
|
# resp.session.arn #=> String
|
1282
|
+
# resp.session.automatic_termination_mode #=> String, one of "DEACTIVATED", "ACTIVATED"
|
1283
|
+
# resp.session.backup_mode #=> String, one of "AUTOMATIC", "DEACTIVATED"
|
1243
1284
|
# resp.session.created_at #=> Time
|
1244
1285
|
# resp.session.created_by #=> String
|
1245
1286
|
# resp.session.ec2_instance_type #=> String
|
1246
1287
|
# resp.session.launch_profile_id #=> String
|
1288
|
+
# resp.session.max_backups_to_retain #=> Integer
|
1247
1289
|
# resp.session.owned_by #=> String
|
1248
1290
|
# resp.session.session_id #=> String
|
1291
|
+
# resp.session.session_persistence_mode #=> String, one of "DEACTIVATED", "ACTIVATED"
|
1249
1292
|
# resp.session.started_at #=> Time
|
1250
1293
|
# resp.session.started_by #=> String
|
1294
|
+
# resp.session.started_from_backup_id #=> String
|
1251
1295
|
# resp.session.state #=> String, one of "CREATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "READY", "DELETED", "CREATE_FAILED", "DELETE_FAILED", "STOP_IN_PROGRESS", "START_IN_PROGRESS", "STOPPED", "STOP_FAILED", "START_FAILED"
|
1252
1296
|
# resp.session.status_code #=> String, one of "STREAMING_SESSION_READY", "STREAMING_SESSION_DELETED", "STREAMING_SESSION_CREATE_IN_PROGRESS", "STREAMING_SESSION_DELETE_IN_PROGRESS", "INTERNAL_ERROR", "INSUFFICIENT_CAPACITY", "ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR", "NETWORK_CONNECTION_ERROR", "INITIALIZATION_SCRIPT_ERROR", "DECRYPT_STREAMING_IMAGE_ERROR", "NETWORK_INTERFACE_ERROR", "STREAMING_SESSION_STOPPED", "STREAMING_SESSION_STARTED", "STREAMING_SESSION_STOP_IN_PROGRESS", "STREAMING_SESSION_START_IN_PROGRESS", "AMI_VALIDATION_ERROR"
|
1253
1297
|
# resp.session.status_message #=> String
|
@@ -1260,6 +1304,10 @@ module Aws::NimbleStudio
|
|
1260
1304
|
# resp.session.terminate_at #=> Time
|
1261
1305
|
# resp.session.updated_at #=> Time
|
1262
1306
|
# resp.session.updated_by #=> String
|
1307
|
+
# resp.session.volume_configuration.iops #=> Integer
|
1308
|
+
# resp.session.volume_configuration.size #=> Integer
|
1309
|
+
# resp.session.volume_configuration.throughput #=> Integer
|
1310
|
+
# resp.session.volume_retention_mode #=> String, one of "RETAIN", "DELETE"
|
1263
1311
|
#
|
1264
1312
|
# @see http://docs.aws.amazon.com/goto/WebAPI/nimble-2020-08-01/DeleteStreamingSession AWS API Documentation
|
1265
1313
|
#
|
@@ -1275,8 +1323,8 @@ module Aws::NimbleStudio
|
|
1275
1323
|
# @option params [String] :client_token
|
1276
1324
|
# Unique, case-sensitive identifier that you provide to ensure the
|
1277
1325
|
# idempotency of the request. If you don’t specify a client token, the
|
1278
|
-
#
|
1279
|
-
# request to ensure idempotency.
|
1326
|
+
# Amazon Web Services SDK automatically generates a client token and
|
1327
|
+
# uses it for the request to ensure idempotency.
|
1280
1328
|
#
|
1281
1329
|
# **A suitable default value is auto-generated.** You should normally
|
1282
1330
|
# not need to pass this option.**
|
@@ -1304,7 +1352,7 @@ module Aws::NimbleStudio
|
|
1304
1352
|
# resp.studio.home_region #=> String
|
1305
1353
|
# resp.studio.sso_client_id #=> String
|
1306
1354
|
# resp.studio.state #=> String, one of "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED"
|
1307
|
-
# resp.studio.status_code #=> String, one of "STUDIO_CREATED", "STUDIO_DELETED", "STUDIO_UPDATED", "STUDIO_CREATE_IN_PROGRESS", "STUDIO_UPDATE_IN_PROGRESS", "STUDIO_DELETE_IN_PROGRESS", "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED", "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED", "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED", "AWS_SSO_NOT_ENABLED", "AWS_SSO_ACCESS_DENIED", "ROLE_NOT_OWNED_BY_STUDIO_OWNER", "ROLE_COULD_NOT_BE_ASSUMED", "INTERNAL_ERROR", "ENCRYPTION_KEY_NOT_FOUND", "ENCRYPTION_KEY_ACCESS_DENIED", "AWS_SSO_CONFIGURATION_REPAIRED", "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS"
|
1355
|
+
# resp.studio.status_code #=> String, one of "STUDIO_CREATED", "STUDIO_DELETED", "STUDIO_UPDATED", "STUDIO_CREATE_IN_PROGRESS", "STUDIO_UPDATE_IN_PROGRESS", "STUDIO_DELETE_IN_PROGRESS", "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED", "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED", "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED", "AWS_SSO_NOT_ENABLED", "AWS_SSO_ACCESS_DENIED", "ROLE_NOT_OWNED_BY_STUDIO_OWNER", "ROLE_COULD_NOT_BE_ASSUMED", "INTERNAL_ERROR", "ENCRYPTION_KEY_NOT_FOUND", "ENCRYPTION_KEY_ACCESS_DENIED", "AWS_SSO_CONFIGURATION_REPAIRED", "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS", "AWS_STS_REGION_DISABLED"
|
1308
1356
|
# resp.studio.status_message #=> String
|
1309
1357
|
# resp.studio.studio_encryption_configuration.key_arn #=> String
|
1310
1358
|
# resp.studio.studio_encryption_configuration.key_type #=> String, one of "AWS_OWNED_KEY", "CUSTOMER_MANAGED_KEY"
|
@@ -1330,8 +1378,8 @@ module Aws::NimbleStudio
|
|
1330
1378
|
# @option params [String] :client_token
|
1331
1379
|
# Unique, case-sensitive identifier that you provide to ensure the
|
1332
1380
|
# idempotency of the request. If you don’t specify a client token, the
|
1333
|
-
#
|
1334
|
-
# request to ensure idempotency.
|
1381
|
+
# Amazon Web Services SDK automatically generates a client token and
|
1382
|
+
# uses it for the request to ensure idempotency.
|
1335
1383
|
#
|
1336
1384
|
# **A suitable default value is auto-generated.** You should normally
|
1337
1385
|
# not need to pass this option.**
|
@@ -1411,8 +1459,8 @@ module Aws::NimbleStudio
|
|
1411
1459
|
# @option params [String] :client_token
|
1412
1460
|
# Unique, case-sensitive identifier that you provide to ensure the
|
1413
1461
|
# idempotency of the request. If you don’t specify a client token, the
|
1414
|
-
#
|
1415
|
-
# request to ensure idempotency.
|
1462
|
+
# Amazon Web Services SDK automatically generates a client token and
|
1463
|
+
# uses it for the request to ensure idempotency.
|
1416
1464
|
#
|
1417
1465
|
# **A suitable default value is auto-generated.** You should normally
|
1418
1466
|
# not need to pass this option.**
|
@@ -1443,7 +1491,7 @@ module Aws::NimbleStudio
|
|
1443
1491
|
req.send_request(options)
|
1444
1492
|
end
|
1445
1493
|
|
1446
|
-
# Get
|
1494
|
+
# Get EULA.
|
1447
1495
|
#
|
1448
1496
|
# @option params [required, String] :eula_id
|
1449
1497
|
# The EULA ID.
|
@@ -1478,7 +1526,8 @@ module Aws::NimbleStudio
|
|
1478
1526
|
# Get a launch profile.
|
1479
1527
|
#
|
1480
1528
|
# @option params [required, String] :launch_profile_id
|
1481
|
-
# The
|
1529
|
+
# The ID of the launch profile used to control access from the streaming
|
1530
|
+
# session.
|
1482
1531
|
#
|
1483
1532
|
# @option params [required, String] :studio_id
|
1484
1533
|
# The studio ID.
|
@@ -1509,17 +1558,24 @@ module Aws::NimbleStudio
|
|
1509
1558
|
# resp.launch_profile.state #=> String, one of "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED"
|
1510
1559
|
# resp.launch_profile.status_code #=> String, one of "LAUNCH_PROFILE_CREATED", "LAUNCH_PROFILE_UPDATED", "LAUNCH_PROFILE_DELETED", "LAUNCH_PROFILE_CREATE_IN_PROGRESS", "LAUNCH_PROFILE_UPDATE_IN_PROGRESS", "LAUNCH_PROFILE_DELETE_IN_PROGRESS", "INTERNAL_ERROR", "STREAMING_IMAGE_NOT_FOUND", "STREAMING_IMAGE_NOT_READY", "LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED", "ENCRYPTION_KEY_ACCESS_DENIED", "ENCRYPTION_KEY_NOT_FOUND", "INVALID_SUBNETS_PROVIDED", "INVALID_INSTANCE_TYPES_PROVIDED", "INVALID_SUBNETS_COMBINATION"
|
1511
1560
|
# resp.launch_profile.status_message #=> String
|
1561
|
+
# resp.launch_profile.stream_configuration.automatic_termination_mode #=> String, one of "DEACTIVATED", "ACTIVATED"
|
1512
1562
|
# resp.launch_profile.stream_configuration.clipboard_mode #=> String, one of "ENABLED", "DISABLED"
|
1513
1563
|
# resp.launch_profile.stream_configuration.ec2_instance_types #=> Array
|
1514
1564
|
# resp.launch_profile.stream_configuration.ec2_instance_types[0] #=> String, one of "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"
|
1515
1565
|
# resp.launch_profile.stream_configuration.max_session_length_in_minutes #=> Integer
|
1516
1566
|
# resp.launch_profile.stream_configuration.max_stopped_session_length_in_minutes #=> Integer
|
1567
|
+
# resp.launch_profile.stream_configuration.session_backup.max_backups_to_retain #=> Integer
|
1568
|
+
# resp.launch_profile.stream_configuration.session_backup.mode #=> String, one of "AUTOMATIC", "DEACTIVATED"
|
1569
|
+
# resp.launch_profile.stream_configuration.session_persistence_mode #=> String, one of "DEACTIVATED", "ACTIVATED"
|
1517
1570
|
# resp.launch_profile.stream_configuration.session_storage.mode #=> Array
|
1518
1571
|
# resp.launch_profile.stream_configuration.session_storage.mode[0] #=> String, one of "UPLOAD"
|
1519
1572
|
# resp.launch_profile.stream_configuration.session_storage.root.linux #=> String
|
1520
1573
|
# resp.launch_profile.stream_configuration.session_storage.root.windows #=> String
|
1521
1574
|
# resp.launch_profile.stream_configuration.streaming_image_ids #=> Array
|
1522
1575
|
# resp.launch_profile.stream_configuration.streaming_image_ids[0] #=> String
|
1576
|
+
# resp.launch_profile.stream_configuration.volume_configuration.iops #=> Integer
|
1577
|
+
# resp.launch_profile.stream_configuration.volume_configuration.size #=> Integer
|
1578
|
+
# resp.launch_profile.stream_configuration.volume_configuration.throughput #=> Integer
|
1523
1579
|
# resp.launch_profile.studio_component_ids #=> Array
|
1524
1580
|
# resp.launch_profile.studio_component_ids[0] #=> String
|
1525
1581
|
# resp.launch_profile.tags #=> Hash
|
@@ -1554,7 +1610,8 @@ module Aws::NimbleStudio
|
|
1554
1610
|
# of streaming images that can be used with this launch profile.
|
1555
1611
|
#
|
1556
1612
|
# @option params [required, String] :launch_profile_id
|
1557
|
-
# The
|
1613
|
+
# The ID of the launch profile used to control access from the streaming
|
1614
|
+
# session.
|
1558
1615
|
#
|
1559
1616
|
# @option params [required, String] :studio_id
|
1560
1617
|
# The studio ID.
|
@@ -1587,17 +1644,24 @@ module Aws::NimbleStudio
|
|
1587
1644
|
# resp.launch_profile.state #=> String, one of "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED"
|
1588
1645
|
# resp.launch_profile.status_code #=> String, one of "LAUNCH_PROFILE_CREATED", "LAUNCH_PROFILE_UPDATED", "LAUNCH_PROFILE_DELETED", "LAUNCH_PROFILE_CREATE_IN_PROGRESS", "LAUNCH_PROFILE_UPDATE_IN_PROGRESS", "LAUNCH_PROFILE_DELETE_IN_PROGRESS", "INTERNAL_ERROR", "STREAMING_IMAGE_NOT_FOUND", "STREAMING_IMAGE_NOT_READY", "LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED", "ENCRYPTION_KEY_ACCESS_DENIED", "ENCRYPTION_KEY_NOT_FOUND", "INVALID_SUBNETS_PROVIDED", "INVALID_INSTANCE_TYPES_PROVIDED", "INVALID_SUBNETS_COMBINATION"
|
1589
1646
|
# resp.launch_profile.status_message #=> String
|
1647
|
+
# resp.launch_profile.stream_configuration.automatic_termination_mode #=> String, one of "DEACTIVATED", "ACTIVATED"
|
1590
1648
|
# resp.launch_profile.stream_configuration.clipboard_mode #=> String, one of "ENABLED", "DISABLED"
|
1591
1649
|
# resp.launch_profile.stream_configuration.ec2_instance_types #=> Array
|
1592
1650
|
# resp.launch_profile.stream_configuration.ec2_instance_types[0] #=> String, one of "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"
|
1593
1651
|
# resp.launch_profile.stream_configuration.max_session_length_in_minutes #=> Integer
|
1594
1652
|
# resp.launch_profile.stream_configuration.max_stopped_session_length_in_minutes #=> Integer
|
1653
|
+
# resp.launch_profile.stream_configuration.session_backup.max_backups_to_retain #=> Integer
|
1654
|
+
# resp.launch_profile.stream_configuration.session_backup.mode #=> String, one of "AUTOMATIC", "DEACTIVATED"
|
1655
|
+
# resp.launch_profile.stream_configuration.session_persistence_mode #=> String, one of "DEACTIVATED", "ACTIVATED"
|
1595
1656
|
# resp.launch_profile.stream_configuration.session_storage.mode #=> Array
|
1596
1657
|
# resp.launch_profile.stream_configuration.session_storage.mode[0] #=> String, one of "UPLOAD"
|
1597
1658
|
# resp.launch_profile.stream_configuration.session_storage.root.linux #=> String
|
1598
1659
|
# resp.launch_profile.stream_configuration.session_storage.root.windows #=> String
|
1599
1660
|
# resp.launch_profile.stream_configuration.streaming_image_ids #=> Array
|
1600
1661
|
# resp.launch_profile.stream_configuration.streaming_image_ids[0] #=> String
|
1662
|
+
# resp.launch_profile.stream_configuration.volume_configuration.iops #=> Integer
|
1663
|
+
# resp.launch_profile.stream_configuration.volume_configuration.size #=> Integer
|
1664
|
+
# resp.launch_profile.stream_configuration.volume_configuration.throughput #=> Integer
|
1601
1665
|
# resp.launch_profile.studio_component_ids #=> Array
|
1602
1666
|
# resp.launch_profile.studio_component_ids[0] #=> String
|
1603
1667
|
# resp.launch_profile.tags #=> Hash
|
@@ -1649,7 +1713,8 @@ module Aws::NimbleStudio
|
|
1649
1713
|
# Get a launch profile initialization.
|
1650
1714
|
#
|
1651
1715
|
# @option params [required, String] :launch_profile_id
|
1652
|
-
# The
|
1716
|
+
# The ID of the launch profile used to control access from the streaming
|
1717
|
+
# session.
|
1653
1718
|
#
|
1654
1719
|
# @option params [required, Array<String>] :launch_profile_protocol_versions
|
1655
1720
|
# The launch profile protocol versions supported by the client.
|
@@ -1658,8 +1723,8 @@ module Aws::NimbleStudio
|
|
1658
1723
|
# The launch purpose.
|
1659
1724
|
#
|
1660
1725
|
# @option params [required, String] :platform
|
1661
|
-
# The platform where this Launch Profile will be used, either
|
1662
|
-
#
|
1726
|
+
# The platform where this Launch Profile will be used, either Windows or
|
1727
|
+
# Linux.
|
1663
1728
|
#
|
1664
1729
|
# @option params [required, String] :studio_id
|
1665
1730
|
# The studio ID.
|
@@ -1722,7 +1787,8 @@ module Aws::NimbleStudio
|
|
1722
1787
|
# Get a user persona in launch profile membership.
|
1723
1788
|
#
|
1724
1789
|
# @option params [required, String] :launch_profile_id
|
1725
|
-
# The
|
1790
|
+
# The ID of the launch profile used to control access from the streaming
|
1791
|
+
# session.
|
1726
1792
|
#
|
1727
1793
|
# @option params [required, String] :principal_id
|
1728
1794
|
# The principal ID. This currently supports a IAM Identity Center
|
@@ -1837,14 +1903,19 @@ module Aws::NimbleStudio
|
|
1837
1903
|
# @example Response structure
|
1838
1904
|
#
|
1839
1905
|
# resp.session.arn #=> String
|
1906
|
+
# resp.session.automatic_termination_mode #=> String, one of "DEACTIVATED", "ACTIVATED"
|
1907
|
+
# resp.session.backup_mode #=> String, one of "AUTOMATIC", "DEACTIVATED"
|
1840
1908
|
# resp.session.created_at #=> Time
|
1841
1909
|
# resp.session.created_by #=> String
|
1842
1910
|
# resp.session.ec2_instance_type #=> String
|
1843
1911
|
# resp.session.launch_profile_id #=> String
|
1912
|
+
# resp.session.max_backups_to_retain #=> Integer
|
1844
1913
|
# resp.session.owned_by #=> String
|
1845
1914
|
# resp.session.session_id #=> String
|
1915
|
+
# resp.session.session_persistence_mode #=> String, one of "DEACTIVATED", "ACTIVATED"
|
1846
1916
|
# resp.session.started_at #=> Time
|
1847
1917
|
# resp.session.started_by #=> String
|
1918
|
+
# resp.session.started_from_backup_id #=> String
|
1848
1919
|
# resp.session.state #=> String, one of "CREATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "READY", "DELETED", "CREATE_FAILED", "DELETE_FAILED", "STOP_IN_PROGRESS", "START_IN_PROGRESS", "STOPPED", "STOP_FAILED", "START_FAILED"
|
1849
1920
|
# resp.session.status_code #=> String, one of "STREAMING_SESSION_READY", "STREAMING_SESSION_DELETED", "STREAMING_SESSION_CREATE_IN_PROGRESS", "STREAMING_SESSION_DELETE_IN_PROGRESS", "INTERNAL_ERROR", "INSUFFICIENT_CAPACITY", "ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR", "NETWORK_CONNECTION_ERROR", "INITIALIZATION_SCRIPT_ERROR", "DECRYPT_STREAMING_IMAGE_ERROR", "NETWORK_INTERFACE_ERROR", "STREAMING_SESSION_STOPPED", "STREAMING_SESSION_STARTED", "STREAMING_SESSION_STOP_IN_PROGRESS", "STREAMING_SESSION_START_IN_PROGRESS", "AMI_VALIDATION_ERROR"
|
1850
1921
|
# resp.session.status_message #=> String
|
@@ -1857,6 +1928,10 @@ module Aws::NimbleStudio
|
|
1857
1928
|
# resp.session.terminate_at #=> Time
|
1858
1929
|
# resp.session.updated_at #=> Time
|
1859
1930
|
# resp.session.updated_by #=> String
|
1931
|
+
# resp.session.volume_configuration.iops #=> Integer
|
1932
|
+
# resp.session.volume_configuration.size #=> Integer
|
1933
|
+
# resp.session.volume_configuration.throughput #=> Integer
|
1934
|
+
# resp.session.volume_retention_mode #=> String, one of "RETAIN", "DELETE"
|
1860
1935
|
#
|
1861
1936
|
#
|
1862
1937
|
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
@@ -1874,13 +1949,58 @@ module Aws::NimbleStudio
|
|
1874
1949
|
req.send_request(options)
|
1875
1950
|
end
|
1876
1951
|
|
1952
|
+
# Gets `StreamingSessionBackup` resource.
|
1953
|
+
#
|
1954
|
+
# Invoke this operation to poll for a streaming session backup while
|
1955
|
+
# stopping a streaming session.
|
1956
|
+
#
|
1957
|
+
# @option params [required, String] :backup_id
|
1958
|
+
# The ID of the backup.
|
1959
|
+
#
|
1960
|
+
# @option params [required, String] :studio_id
|
1961
|
+
# The studio ID.
|
1962
|
+
#
|
1963
|
+
# @return [Types::GetStreamingSessionBackupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1964
|
+
#
|
1965
|
+
# * {Types::GetStreamingSessionBackupResponse#streaming_session_backup #streaming_session_backup} => Types::StreamingSessionBackup
|
1966
|
+
#
|
1967
|
+
# @example Request syntax with placeholder values
|
1968
|
+
#
|
1969
|
+
# resp = client.get_streaming_session_backup({
|
1970
|
+
# backup_id: "String", # required
|
1971
|
+
# studio_id: "String", # required
|
1972
|
+
# })
|
1973
|
+
#
|
1974
|
+
# @example Response structure
|
1975
|
+
#
|
1976
|
+
# resp.streaming_session_backup.arn #=> String
|
1977
|
+
# resp.streaming_session_backup.backup_id #=> String
|
1978
|
+
# resp.streaming_session_backup.created_at #=> Time
|
1979
|
+
# resp.streaming_session_backup.launch_profile_id #=> String
|
1980
|
+
# resp.streaming_session_backup.owned_by #=> String
|
1981
|
+
# resp.streaming_session_backup.session_id #=> String
|
1982
|
+
# resp.streaming_session_backup.state #=> String, one of "CREATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "READY", "DELETED", "CREATE_FAILED", "DELETE_FAILED", "STOP_IN_PROGRESS", "START_IN_PROGRESS", "STOPPED", "STOP_FAILED", "START_FAILED"
|
1983
|
+
# resp.streaming_session_backup.status_code #=> String, one of "STREAMING_SESSION_READY", "STREAMING_SESSION_DELETED", "STREAMING_SESSION_CREATE_IN_PROGRESS", "STREAMING_SESSION_DELETE_IN_PROGRESS", "INTERNAL_ERROR", "INSUFFICIENT_CAPACITY", "ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR", "NETWORK_CONNECTION_ERROR", "INITIALIZATION_SCRIPT_ERROR", "DECRYPT_STREAMING_IMAGE_ERROR", "NETWORK_INTERFACE_ERROR", "STREAMING_SESSION_STOPPED", "STREAMING_SESSION_STARTED", "STREAMING_SESSION_STOP_IN_PROGRESS", "STREAMING_SESSION_START_IN_PROGRESS", "AMI_VALIDATION_ERROR"
|
1984
|
+
# resp.streaming_session_backup.status_message #=> String
|
1985
|
+
# resp.streaming_session_backup.tags #=> Hash
|
1986
|
+
# resp.streaming_session_backup.tags["String"] #=> String
|
1987
|
+
#
|
1988
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/nimble-2020-08-01/GetStreamingSessionBackup AWS API Documentation
|
1989
|
+
#
|
1990
|
+
# @overload get_streaming_session_backup(params = {})
|
1991
|
+
# @param [Hash] params ({})
|
1992
|
+
def get_streaming_session_backup(params = {}, options = {})
|
1993
|
+
req = build_request(:get_streaming_session_backup, params)
|
1994
|
+
req.send_request(options)
|
1995
|
+
end
|
1996
|
+
|
1877
1997
|
# Gets a StreamingSessionStream for a streaming session.
|
1878
1998
|
#
|
1879
1999
|
# Invoke this operation to poll the resource after invoking
|
1880
|
-
# CreateStreamingSessionStream
|
2000
|
+
# `CreateStreamingSessionStream`.
|
1881
2001
|
#
|
1882
|
-
# After the StreamingSessionStream changes to the state
|
1883
|
-
# property will contain a stream to be used with the DCV streaming
|
2002
|
+
# After the `StreamingSessionStream` changes to the `READY` state, the
|
2003
|
+
# url property will contain a stream to be used with the DCV streaming
|
1884
2004
|
# client.
|
1885
2005
|
#
|
1886
2006
|
# @option params [required, String] :session_id
|
@@ -1929,7 +2049,7 @@ module Aws::NimbleStudio
|
|
1929
2049
|
req.send_request(options)
|
1930
2050
|
end
|
1931
2051
|
|
1932
|
-
# Get a
|
2052
|
+
# Get a studio resource.
|
1933
2053
|
#
|
1934
2054
|
# @option params [required, String] :studio_id
|
1935
2055
|
# The studio ID.
|
@@ -1953,7 +2073,7 @@ module Aws::NimbleStudio
|
|
1953
2073
|
# resp.studio.home_region #=> String
|
1954
2074
|
# resp.studio.sso_client_id #=> String
|
1955
2075
|
# resp.studio.state #=> String, one of "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED"
|
1956
|
-
# resp.studio.status_code #=> String, one of "STUDIO_CREATED", "STUDIO_DELETED", "STUDIO_UPDATED", "STUDIO_CREATE_IN_PROGRESS", "STUDIO_UPDATE_IN_PROGRESS", "STUDIO_DELETE_IN_PROGRESS", "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED", "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED", "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED", "AWS_SSO_NOT_ENABLED", "AWS_SSO_ACCESS_DENIED", "ROLE_NOT_OWNED_BY_STUDIO_OWNER", "ROLE_COULD_NOT_BE_ASSUMED", "INTERNAL_ERROR", "ENCRYPTION_KEY_NOT_FOUND", "ENCRYPTION_KEY_ACCESS_DENIED", "AWS_SSO_CONFIGURATION_REPAIRED", "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS"
|
2076
|
+
# resp.studio.status_code #=> String, one of "STUDIO_CREATED", "STUDIO_DELETED", "STUDIO_UPDATED", "STUDIO_CREATE_IN_PROGRESS", "STUDIO_UPDATE_IN_PROGRESS", "STUDIO_DELETE_IN_PROGRESS", "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED", "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED", "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED", "AWS_SSO_NOT_ENABLED", "AWS_SSO_ACCESS_DENIED", "ROLE_NOT_OWNED_BY_STUDIO_OWNER", "ROLE_COULD_NOT_BE_ASSUMED", "INTERNAL_ERROR", "ENCRYPTION_KEY_NOT_FOUND", "ENCRYPTION_KEY_ACCESS_DENIED", "AWS_SSO_CONFIGURATION_REPAIRED", "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS", "AWS_STS_REGION_DISABLED"
|
1957
2077
|
# resp.studio.status_message #=> String
|
1958
2078
|
# resp.studio.studio_encryption_configuration.key_arn #=> String
|
1959
2079
|
# resp.studio.studio_encryption_configuration.key_type #=> String, one of "AWS_OWNED_KEY", "CUSTOMER_MANAGED_KEY"
|
@@ -2093,13 +2213,14 @@ module Aws::NimbleStudio
|
|
2093
2213
|
req.send_request(options)
|
2094
2214
|
end
|
2095
2215
|
|
2096
|
-
# List
|
2216
|
+
# List EULA acceptances.
|
2097
2217
|
#
|
2098
2218
|
# @option params [Array<String>] :eula_ids
|
2099
2219
|
# The list of EULA IDs that have been previously accepted.
|
2100
2220
|
#
|
2101
2221
|
# @option params [String] :next_token
|
2102
|
-
# The token
|
2222
|
+
# The token for the next set of results, or null if there are no more
|
2223
|
+
# results.
|
2103
2224
|
#
|
2104
2225
|
# @option params [required, String] :studio_id
|
2105
2226
|
# The studio ID.
|
@@ -2138,13 +2259,14 @@ module Aws::NimbleStudio
|
|
2138
2259
|
req.send_request(options)
|
2139
2260
|
end
|
2140
2261
|
|
2141
|
-
# List
|
2262
|
+
# List EULAs.
|
2142
2263
|
#
|
2143
2264
|
# @option params [Array<String>] :eula_ids
|
2144
2265
|
# The list of EULA IDs that should be returned
|
2145
2266
|
#
|
2146
2267
|
# @option params [String] :next_token
|
2147
|
-
# The token
|
2268
|
+
# The token for the next set of results, or null if there are no more
|
2269
|
+
# results.
|
2148
2270
|
#
|
2149
2271
|
# @return [Types::ListEulasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2150
2272
|
#
|
@@ -2182,13 +2304,15 @@ module Aws::NimbleStudio
|
|
2182
2304
|
# Get all users in a given launch profile membership.
|
2183
2305
|
#
|
2184
2306
|
# @option params [required, String] :launch_profile_id
|
2185
|
-
# The
|
2307
|
+
# The ID of the launch profile used to control access from the streaming
|
2308
|
+
# session.
|
2186
2309
|
#
|
2187
2310
|
# @option params [Integer] :max_results
|
2188
2311
|
# The max number of results to return in the response.
|
2189
2312
|
#
|
2190
2313
|
# @option params [String] :next_token
|
2191
|
-
# The token
|
2314
|
+
# The token for the next set of results, or null if there are no more
|
2315
|
+
# results.
|
2192
2316
|
#
|
2193
2317
|
# @option params [required, String] :studio_id
|
2194
2318
|
# The studio ID.
|
@@ -2233,7 +2357,8 @@ module Aws::NimbleStudio
|
|
2233
2357
|
# The max number of results to return in the response.
|
2234
2358
|
#
|
2235
2359
|
# @option params [String] :next_token
|
2236
|
-
# The token
|
2360
|
+
# The token for the next set of results, or null if there are no more
|
2361
|
+
# results.
|
2237
2362
|
#
|
2238
2363
|
# @option params [String] :principal_id
|
2239
2364
|
# The principal ID. This currently supports a IAM Identity Center
|
@@ -2278,17 +2403,24 @@ module Aws::NimbleStudio
|
|
2278
2403
|
# resp.launch_profiles[0].state #=> String, one of "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED"
|
2279
2404
|
# resp.launch_profiles[0].status_code #=> String, one of "LAUNCH_PROFILE_CREATED", "LAUNCH_PROFILE_UPDATED", "LAUNCH_PROFILE_DELETED", "LAUNCH_PROFILE_CREATE_IN_PROGRESS", "LAUNCH_PROFILE_UPDATE_IN_PROGRESS", "LAUNCH_PROFILE_DELETE_IN_PROGRESS", "INTERNAL_ERROR", "STREAMING_IMAGE_NOT_FOUND", "STREAMING_IMAGE_NOT_READY", "LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED", "ENCRYPTION_KEY_ACCESS_DENIED", "ENCRYPTION_KEY_NOT_FOUND", "INVALID_SUBNETS_PROVIDED", "INVALID_INSTANCE_TYPES_PROVIDED", "INVALID_SUBNETS_COMBINATION"
|
2280
2405
|
# resp.launch_profiles[0].status_message #=> String
|
2406
|
+
# resp.launch_profiles[0].stream_configuration.automatic_termination_mode #=> String, one of "DEACTIVATED", "ACTIVATED"
|
2281
2407
|
# resp.launch_profiles[0].stream_configuration.clipboard_mode #=> String, one of "ENABLED", "DISABLED"
|
2282
2408
|
# resp.launch_profiles[0].stream_configuration.ec2_instance_types #=> Array
|
2283
2409
|
# resp.launch_profiles[0].stream_configuration.ec2_instance_types[0] #=> String, one of "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"
|
2284
2410
|
# resp.launch_profiles[0].stream_configuration.max_session_length_in_minutes #=> Integer
|
2285
2411
|
# resp.launch_profiles[0].stream_configuration.max_stopped_session_length_in_minutes #=> Integer
|
2412
|
+
# resp.launch_profiles[0].stream_configuration.session_backup.max_backups_to_retain #=> Integer
|
2413
|
+
# resp.launch_profiles[0].stream_configuration.session_backup.mode #=> String, one of "AUTOMATIC", "DEACTIVATED"
|
2414
|
+
# resp.launch_profiles[0].stream_configuration.session_persistence_mode #=> String, one of "DEACTIVATED", "ACTIVATED"
|
2286
2415
|
# resp.launch_profiles[0].stream_configuration.session_storage.mode #=> Array
|
2287
2416
|
# resp.launch_profiles[0].stream_configuration.session_storage.mode[0] #=> String, one of "UPLOAD"
|
2288
2417
|
# resp.launch_profiles[0].stream_configuration.session_storage.root.linux #=> String
|
2289
2418
|
# resp.launch_profiles[0].stream_configuration.session_storage.root.windows #=> String
|
2290
2419
|
# resp.launch_profiles[0].stream_configuration.streaming_image_ids #=> Array
|
2291
2420
|
# resp.launch_profiles[0].stream_configuration.streaming_image_ids[0] #=> String
|
2421
|
+
# resp.launch_profiles[0].stream_configuration.volume_configuration.iops #=> Integer
|
2422
|
+
# resp.launch_profiles[0].stream_configuration.volume_configuration.size #=> Integer
|
2423
|
+
# resp.launch_profiles[0].stream_configuration.volume_configuration.throughput #=> Integer
|
2292
2424
|
# resp.launch_profiles[0].studio_component_ids #=> Array
|
2293
2425
|
# resp.launch_profiles[0].studio_component_ids[0] #=> String
|
2294
2426
|
# resp.launch_profiles[0].tags #=> Hash
|
@@ -2317,7 +2449,8 @@ module Aws::NimbleStudio
|
|
2317
2449
|
# well as streaming images that you have created in your studio.
|
2318
2450
|
#
|
2319
2451
|
# @option params [String] :next_token
|
2320
|
-
# The token
|
2452
|
+
# The token for the next set of results, or null if there are no more
|
2453
|
+
# results.
|
2321
2454
|
#
|
2322
2455
|
# @option params [String] :owner
|
2323
2456
|
# Filter this request to streaming images with the given owner
|
@@ -2370,13 +2503,66 @@ module Aws::NimbleStudio
|
|
2370
2503
|
req.send_request(options)
|
2371
2504
|
end
|
2372
2505
|
|
2506
|
+
# Lists the backups of a streaming session in a studio.
|
2507
|
+
#
|
2508
|
+
# @option params [String] :next_token
|
2509
|
+
# The token for the next set of results, or null if there are no more
|
2510
|
+
# results.
|
2511
|
+
#
|
2512
|
+
# @option params [String] :owned_by
|
2513
|
+
# The user ID of the user that owns the streaming session.
|
2514
|
+
#
|
2515
|
+
# @option params [required, String] :studio_id
|
2516
|
+
# The studio ID.
|
2517
|
+
#
|
2518
|
+
# @return [Types::ListStreamingSessionBackupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2519
|
+
#
|
2520
|
+
# * {Types::ListStreamingSessionBackupsResponse#next_token #next_token} => String
|
2521
|
+
# * {Types::ListStreamingSessionBackupsResponse#streaming_session_backups #streaming_session_backups} => Array<Types::StreamingSessionBackup>
|
2522
|
+
#
|
2523
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2524
|
+
#
|
2525
|
+
# @example Request syntax with placeholder values
|
2526
|
+
#
|
2527
|
+
# resp = client.list_streaming_session_backups({
|
2528
|
+
# next_token: "String",
|
2529
|
+
# owned_by: "String",
|
2530
|
+
# studio_id: "String", # required
|
2531
|
+
# })
|
2532
|
+
#
|
2533
|
+
# @example Response structure
|
2534
|
+
#
|
2535
|
+
# resp.next_token #=> String
|
2536
|
+
# resp.streaming_session_backups #=> Array
|
2537
|
+
# resp.streaming_session_backups[0].arn #=> String
|
2538
|
+
# resp.streaming_session_backups[0].backup_id #=> String
|
2539
|
+
# resp.streaming_session_backups[0].created_at #=> Time
|
2540
|
+
# resp.streaming_session_backups[0].launch_profile_id #=> String
|
2541
|
+
# resp.streaming_session_backups[0].owned_by #=> String
|
2542
|
+
# resp.streaming_session_backups[0].session_id #=> String
|
2543
|
+
# resp.streaming_session_backups[0].state #=> String, one of "CREATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "READY", "DELETED", "CREATE_FAILED", "DELETE_FAILED", "STOP_IN_PROGRESS", "START_IN_PROGRESS", "STOPPED", "STOP_FAILED", "START_FAILED"
|
2544
|
+
# resp.streaming_session_backups[0].status_code #=> String, one of "STREAMING_SESSION_READY", "STREAMING_SESSION_DELETED", "STREAMING_SESSION_CREATE_IN_PROGRESS", "STREAMING_SESSION_DELETE_IN_PROGRESS", "INTERNAL_ERROR", "INSUFFICIENT_CAPACITY", "ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR", "NETWORK_CONNECTION_ERROR", "INITIALIZATION_SCRIPT_ERROR", "DECRYPT_STREAMING_IMAGE_ERROR", "NETWORK_INTERFACE_ERROR", "STREAMING_SESSION_STOPPED", "STREAMING_SESSION_STARTED", "STREAMING_SESSION_STOP_IN_PROGRESS", "STREAMING_SESSION_START_IN_PROGRESS", "AMI_VALIDATION_ERROR"
|
2545
|
+
# resp.streaming_session_backups[0].status_message #=> String
|
2546
|
+
# resp.streaming_session_backups[0].tags #=> Hash
|
2547
|
+
# resp.streaming_session_backups[0].tags["String"] #=> String
|
2548
|
+
#
|
2549
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/nimble-2020-08-01/ListStreamingSessionBackups AWS API Documentation
|
2550
|
+
#
|
2551
|
+
# @overload list_streaming_session_backups(params = {})
|
2552
|
+
# @param [Hash] params ({})
|
2553
|
+
def list_streaming_session_backups(params = {}, options = {})
|
2554
|
+
req = build_request(:list_streaming_session_backups, params)
|
2555
|
+
req.send_request(options)
|
2556
|
+
end
|
2557
|
+
|
2373
2558
|
# Lists the streaming sessions in a studio.
|
2374
2559
|
#
|
2375
2560
|
# @option params [String] :created_by
|
2376
2561
|
# Filters the request to streaming sessions created by the given user.
|
2377
2562
|
#
|
2378
2563
|
# @option params [String] :next_token
|
2379
|
-
# The token
|
2564
|
+
# The token for the next set of results, or null if there are no more
|
2565
|
+
# results.
|
2380
2566
|
#
|
2381
2567
|
# @option params [String] :owned_by
|
2382
2568
|
# Filters the request to streaming session owned by the given user
|
@@ -2409,14 +2595,19 @@ module Aws::NimbleStudio
|
|
2409
2595
|
# resp.next_token #=> String
|
2410
2596
|
# resp.sessions #=> Array
|
2411
2597
|
# resp.sessions[0].arn #=> String
|
2598
|
+
# resp.sessions[0].automatic_termination_mode #=> String, one of "DEACTIVATED", "ACTIVATED"
|
2599
|
+
# resp.sessions[0].backup_mode #=> String, one of "AUTOMATIC", "DEACTIVATED"
|
2412
2600
|
# resp.sessions[0].created_at #=> Time
|
2413
2601
|
# resp.sessions[0].created_by #=> String
|
2414
2602
|
# resp.sessions[0].ec2_instance_type #=> String
|
2415
2603
|
# resp.sessions[0].launch_profile_id #=> String
|
2604
|
+
# resp.sessions[0].max_backups_to_retain #=> Integer
|
2416
2605
|
# resp.sessions[0].owned_by #=> String
|
2417
2606
|
# resp.sessions[0].session_id #=> String
|
2607
|
+
# resp.sessions[0].session_persistence_mode #=> String, one of "DEACTIVATED", "ACTIVATED"
|
2418
2608
|
# resp.sessions[0].started_at #=> Time
|
2419
2609
|
# resp.sessions[0].started_by #=> String
|
2610
|
+
# resp.sessions[0].started_from_backup_id #=> String
|
2420
2611
|
# resp.sessions[0].state #=> String, one of "CREATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "READY", "DELETED", "CREATE_FAILED", "DELETE_FAILED", "STOP_IN_PROGRESS", "START_IN_PROGRESS", "STOPPED", "STOP_FAILED", "START_FAILED"
|
2421
2612
|
# resp.sessions[0].status_code #=> String, one of "STREAMING_SESSION_READY", "STREAMING_SESSION_DELETED", "STREAMING_SESSION_CREATE_IN_PROGRESS", "STREAMING_SESSION_DELETE_IN_PROGRESS", "INTERNAL_ERROR", "INSUFFICIENT_CAPACITY", "ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR", "NETWORK_CONNECTION_ERROR", "INITIALIZATION_SCRIPT_ERROR", "DECRYPT_STREAMING_IMAGE_ERROR", "NETWORK_INTERFACE_ERROR", "STREAMING_SESSION_STOPPED", "STREAMING_SESSION_STARTED", "STREAMING_SESSION_STOP_IN_PROGRESS", "STREAMING_SESSION_START_IN_PROGRESS", "AMI_VALIDATION_ERROR"
|
2422
2613
|
# resp.sessions[0].status_message #=> String
|
@@ -2429,6 +2620,10 @@ module Aws::NimbleStudio
|
|
2429
2620
|
# resp.sessions[0].terminate_at #=> Time
|
2430
2621
|
# resp.sessions[0].updated_at #=> Time
|
2431
2622
|
# resp.sessions[0].updated_by #=> String
|
2623
|
+
# resp.sessions[0].volume_configuration.iops #=> Integer
|
2624
|
+
# resp.sessions[0].volume_configuration.size #=> Integer
|
2625
|
+
# resp.sessions[0].volume_configuration.throughput #=> Integer
|
2626
|
+
# resp.sessions[0].volume_retention_mode #=> String, one of "RETAIN", "DELETE"
|
2432
2627
|
#
|
2433
2628
|
# @see http://docs.aws.amazon.com/goto/WebAPI/nimble-2020-08-01/ListStreamingSessions AWS API Documentation
|
2434
2629
|
#
|
@@ -2439,13 +2634,14 @@ module Aws::NimbleStudio
|
|
2439
2634
|
req.send_request(options)
|
2440
2635
|
end
|
2441
2636
|
|
2442
|
-
# Lists the StudioComponents in a studio.
|
2637
|
+
# Lists the `StudioComponents` in a studio.
|
2443
2638
|
#
|
2444
2639
|
# @option params [Integer] :max_results
|
2445
2640
|
# The max number of results to return in the response.
|
2446
2641
|
#
|
2447
2642
|
# @option params [String] :next_token
|
2448
|
-
# The token
|
2643
|
+
# The token for the next set of results, or null if there are no more
|
2644
|
+
# results.
|
2449
2645
|
#
|
2450
2646
|
# @option params [Array<String>] :states
|
2451
2647
|
# Filters the request to studio components that are in one of the given
|
@@ -2539,7 +2735,8 @@ module Aws::NimbleStudio
|
|
2539
2735
|
# The max number of results to return in the response.
|
2540
2736
|
#
|
2541
2737
|
# @option params [String] :next_token
|
2542
|
-
# The token
|
2738
|
+
# The token for the next set of results, or null if there are no more
|
2739
|
+
# results.
|
2543
2740
|
#
|
2544
2741
|
# @option params [required, String] :studio_id
|
2545
2742
|
# The studio ID.
|
@@ -2577,11 +2774,12 @@ module Aws::NimbleStudio
|
|
2577
2774
|
req.send_request(options)
|
2578
2775
|
end
|
2579
2776
|
|
2580
|
-
# List studios in your Amazon Web Services
|
2777
|
+
# List studios in your Amazon Web Services accounts in the requested
|
2581
2778
|
# Amazon Web Services Region.
|
2582
2779
|
#
|
2583
2780
|
# @option params [String] :next_token
|
2584
|
-
# The token
|
2781
|
+
# The token for the next set of results, or null if there are no more
|
2782
|
+
# results.
|
2585
2783
|
#
|
2586
2784
|
# @return [Types::ListStudiosResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2587
2785
|
#
|
@@ -2607,7 +2805,7 @@ module Aws::NimbleStudio
|
|
2607
2805
|
# resp.studios[0].home_region #=> String
|
2608
2806
|
# resp.studios[0].sso_client_id #=> String
|
2609
2807
|
# resp.studios[0].state #=> String, one of "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED"
|
2610
|
-
# resp.studios[0].status_code #=> String, one of "STUDIO_CREATED", "STUDIO_DELETED", "STUDIO_UPDATED", "STUDIO_CREATE_IN_PROGRESS", "STUDIO_UPDATE_IN_PROGRESS", "STUDIO_DELETE_IN_PROGRESS", "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED", "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED", "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED", "AWS_SSO_NOT_ENABLED", "AWS_SSO_ACCESS_DENIED", "ROLE_NOT_OWNED_BY_STUDIO_OWNER", "ROLE_COULD_NOT_BE_ASSUMED", "INTERNAL_ERROR", "ENCRYPTION_KEY_NOT_FOUND", "ENCRYPTION_KEY_ACCESS_DENIED", "AWS_SSO_CONFIGURATION_REPAIRED", "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS"
|
2808
|
+
# resp.studios[0].status_code #=> String, one of "STUDIO_CREATED", "STUDIO_DELETED", "STUDIO_UPDATED", "STUDIO_CREATE_IN_PROGRESS", "STUDIO_UPDATE_IN_PROGRESS", "STUDIO_DELETE_IN_PROGRESS", "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED", "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED", "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED", "AWS_SSO_NOT_ENABLED", "AWS_SSO_ACCESS_DENIED", "ROLE_NOT_OWNED_BY_STUDIO_OWNER", "ROLE_COULD_NOT_BE_ASSUMED", "INTERNAL_ERROR", "ENCRYPTION_KEY_NOT_FOUND", "ENCRYPTION_KEY_ACCESS_DENIED", "AWS_SSO_CONFIGURATION_REPAIRED", "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS", "AWS_STS_REGION_DISABLED"
|
2611
2809
|
# resp.studios[0].status_message #=> String
|
2612
2810
|
# resp.studios[0].studio_encryption_configuration.key_arn #=> String
|
2613
2811
|
# resp.studios[0].studio_encryption_configuration.key_type #=> String, one of "AWS_OWNED_KEY", "CUSTOMER_MANAGED_KEY"
|
@@ -2669,8 +2867,8 @@ module Aws::NimbleStudio
|
|
2669
2867
|
# @option params [String] :client_token
|
2670
2868
|
# Unique, case-sensitive identifier that you provide to ensure the
|
2671
2869
|
# idempotency of the request. If you don’t specify a client token, the
|
2672
|
-
#
|
2673
|
-
# request to ensure idempotency.
|
2870
|
+
# Amazon Web Services SDK automatically generates a client token and
|
2871
|
+
# uses it for the request to ensure idempotency.
|
2674
2872
|
#
|
2675
2873
|
# **A suitable default value is auto-generated.** You should normally
|
2676
2874
|
# not need to pass this option.**
|
@@ -2679,7 +2877,8 @@ module Aws::NimbleStudio
|
|
2679
2877
|
# The ID of the identity store.
|
2680
2878
|
#
|
2681
2879
|
# @option params [required, String] :launch_profile_id
|
2682
|
-
# The
|
2880
|
+
# The ID of the launch profile used to control access from the streaming
|
2881
|
+
# session.
|
2683
2882
|
#
|
2684
2883
|
# @option params [required, Array<Types::NewLaunchProfileMember>] :members
|
2685
2884
|
# A list of members.
|
@@ -2718,8 +2917,8 @@ module Aws::NimbleStudio
|
|
2718
2917
|
# @option params [String] :client_token
|
2719
2918
|
# Unique, case-sensitive identifier that you provide to ensure the
|
2720
2919
|
# idempotency of the request. If you don’t specify a client token, the
|
2721
|
-
#
|
2722
|
-
# request to ensure idempotency.
|
2920
|
+
# Amazon Web Services SDK automatically generates a client token and
|
2921
|
+
# uses it for the request to ensure idempotency.
|
2723
2922
|
#
|
2724
2923
|
# **A suitable default value is auto-generated.** You should normally
|
2725
2924
|
# not need to pass this option.**
|
@@ -2758,21 +2957,24 @@ module Aws::NimbleStudio
|
|
2758
2957
|
req.send_request(options)
|
2759
2958
|
end
|
2760
2959
|
|
2761
|
-
# Transitions sessions from the STOPPED state into the READY state.
|
2762
|
-
#
|
2763
|
-
# STOPPED and READY states.
|
2960
|
+
# Transitions sessions from the `STOPPED` state into the `READY` state.
|
2961
|
+
# The `START_IN_PROGRESS` state is the intermediate state between the
|
2962
|
+
# `STOPPED` and `READY` states.
|
2963
|
+
#
|
2964
|
+
# @option params [String] :backup_id
|
2965
|
+
# The ID of the backup.
|
2764
2966
|
#
|
2765
2967
|
# @option params [String] :client_token
|
2766
2968
|
# Unique, case-sensitive identifier that you provide to ensure the
|
2767
2969
|
# idempotency of the request. If you don’t specify a client token, the
|
2768
|
-
#
|
2769
|
-
# request to ensure idempotency.
|
2970
|
+
# Amazon Web Services SDK automatically generates a client token and
|
2971
|
+
# uses it for the request to ensure idempotency.
|
2770
2972
|
#
|
2771
2973
|
# **A suitable default value is auto-generated.** You should normally
|
2772
2974
|
# not need to pass this option.**
|
2773
2975
|
#
|
2774
2976
|
# @option params [required, String] :session_id
|
2775
|
-
# The streaming session ID for the StartStreamingSessionRequest
|
2977
|
+
# The streaming session ID for the `StartStreamingSessionRequest`.
|
2776
2978
|
#
|
2777
2979
|
# @option params [required, String] :studio_id
|
2778
2980
|
# The studio ID for the StartStreamingSessionRequest.
|
@@ -2784,6 +2986,7 @@ module Aws::NimbleStudio
|
|
2784
2986
|
# @example Request syntax with placeholder values
|
2785
2987
|
#
|
2786
2988
|
# resp = client.start_streaming_session({
|
2989
|
+
# backup_id: "String",
|
2787
2990
|
# client_token: "ClientToken",
|
2788
2991
|
# session_id: "String", # required
|
2789
2992
|
# studio_id: "String", # required
|
@@ -2792,14 +2995,19 @@ module Aws::NimbleStudio
|
|
2792
2995
|
# @example Response structure
|
2793
2996
|
#
|
2794
2997
|
# resp.session.arn #=> String
|
2998
|
+
# resp.session.automatic_termination_mode #=> String, one of "DEACTIVATED", "ACTIVATED"
|
2999
|
+
# resp.session.backup_mode #=> String, one of "AUTOMATIC", "DEACTIVATED"
|
2795
3000
|
# resp.session.created_at #=> Time
|
2796
3001
|
# resp.session.created_by #=> String
|
2797
3002
|
# resp.session.ec2_instance_type #=> String
|
2798
3003
|
# resp.session.launch_profile_id #=> String
|
3004
|
+
# resp.session.max_backups_to_retain #=> Integer
|
2799
3005
|
# resp.session.owned_by #=> String
|
2800
3006
|
# resp.session.session_id #=> String
|
3007
|
+
# resp.session.session_persistence_mode #=> String, one of "DEACTIVATED", "ACTIVATED"
|
2801
3008
|
# resp.session.started_at #=> Time
|
2802
3009
|
# resp.session.started_by #=> String
|
3010
|
+
# resp.session.started_from_backup_id #=> String
|
2803
3011
|
# resp.session.state #=> String, one of "CREATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "READY", "DELETED", "CREATE_FAILED", "DELETE_FAILED", "STOP_IN_PROGRESS", "START_IN_PROGRESS", "STOPPED", "STOP_FAILED", "START_FAILED"
|
2804
3012
|
# resp.session.status_code #=> String, one of "STREAMING_SESSION_READY", "STREAMING_SESSION_DELETED", "STREAMING_SESSION_CREATE_IN_PROGRESS", "STREAMING_SESSION_DELETE_IN_PROGRESS", "INTERNAL_ERROR", "INSUFFICIENT_CAPACITY", "ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR", "NETWORK_CONNECTION_ERROR", "INITIALIZATION_SCRIPT_ERROR", "DECRYPT_STREAMING_IMAGE_ERROR", "NETWORK_INTERFACE_ERROR", "STREAMING_SESSION_STOPPED", "STREAMING_SESSION_STARTED", "STREAMING_SESSION_STOP_IN_PROGRESS", "STREAMING_SESSION_START_IN_PROGRESS", "AMI_VALIDATION_ERROR"
|
2805
3013
|
# resp.session.status_message #=> String
|
@@ -2812,6 +3020,10 @@ module Aws::NimbleStudio
|
|
2812
3020
|
# resp.session.terminate_at #=> Time
|
2813
3021
|
# resp.session.updated_at #=> Time
|
2814
3022
|
# resp.session.updated_by #=> String
|
3023
|
+
# resp.session.volume_configuration.iops #=> Integer
|
3024
|
+
# resp.session.volume_configuration.size #=> Integer
|
3025
|
+
# resp.session.volume_configuration.throughput #=> Integer
|
3026
|
+
# resp.session.volume_retention_mode #=> String, one of "RETAIN", "DELETE"
|
2815
3027
|
#
|
2816
3028
|
# @see http://docs.aws.amazon.com/goto/WebAPI/nimble-2020-08-01/StartStreamingSession AWS API Documentation
|
2817
3029
|
#
|
@@ -2830,7 +3042,7 @@ module Aws::NimbleStudio
|
|
2830
3042
|
# If the studio does not have a valid IAM Identity Center configuration
|
2831
3043
|
# currently associated with it, then a new IAM Identity Center
|
2832
3044
|
# application is created for the studio and the studio is changed to the
|
2833
|
-
# READY state.
|
3045
|
+
# `READY` state.
|
2834
3046
|
#
|
2835
3047
|
# After the IAM Identity Center application is repaired, you must use
|
2836
3048
|
# the Amazon Nimble Studio console to add administrators and users to
|
@@ -2839,8 +3051,8 @@ module Aws::NimbleStudio
|
|
2839
3051
|
# @option params [String] :client_token
|
2840
3052
|
# Unique, case-sensitive identifier that you provide to ensure the
|
2841
3053
|
# idempotency of the request. If you don’t specify a client token, the
|
2842
|
-
#
|
2843
|
-
# request to ensure idempotency.
|
3054
|
+
# Amazon Web Services SDK automatically generates a client token and
|
3055
|
+
# uses it for the request to ensure idempotency.
|
2844
3056
|
#
|
2845
3057
|
# **A suitable default value is auto-generated.** You should normally
|
2846
3058
|
# not need to pass this option.**
|
@@ -2868,7 +3080,7 @@ module Aws::NimbleStudio
|
|
2868
3080
|
# resp.studio.home_region #=> String
|
2869
3081
|
# resp.studio.sso_client_id #=> String
|
2870
3082
|
# resp.studio.state #=> String, one of "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED"
|
2871
|
-
# resp.studio.status_code #=> String, one of "STUDIO_CREATED", "STUDIO_DELETED", "STUDIO_UPDATED", "STUDIO_CREATE_IN_PROGRESS", "STUDIO_UPDATE_IN_PROGRESS", "STUDIO_DELETE_IN_PROGRESS", "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED", "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED", "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED", "AWS_SSO_NOT_ENABLED", "AWS_SSO_ACCESS_DENIED", "ROLE_NOT_OWNED_BY_STUDIO_OWNER", "ROLE_COULD_NOT_BE_ASSUMED", "INTERNAL_ERROR", "ENCRYPTION_KEY_NOT_FOUND", "ENCRYPTION_KEY_ACCESS_DENIED", "AWS_SSO_CONFIGURATION_REPAIRED", "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS"
|
3083
|
+
# resp.studio.status_code #=> String, one of "STUDIO_CREATED", "STUDIO_DELETED", "STUDIO_UPDATED", "STUDIO_CREATE_IN_PROGRESS", "STUDIO_UPDATE_IN_PROGRESS", "STUDIO_DELETE_IN_PROGRESS", "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED", "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED", "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED", "AWS_SSO_NOT_ENABLED", "AWS_SSO_ACCESS_DENIED", "ROLE_NOT_OWNED_BY_STUDIO_OWNER", "ROLE_COULD_NOT_BE_ASSUMED", "INTERNAL_ERROR", "ENCRYPTION_KEY_NOT_FOUND", "ENCRYPTION_KEY_ACCESS_DENIED", "AWS_SSO_CONFIGURATION_REPAIRED", "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS", "AWS_STS_REGION_DISABLED"
|
2872
3084
|
# resp.studio.status_message #=> String
|
2873
3085
|
# resp.studio.studio_encryption_configuration.key_arn #=> String
|
2874
3086
|
# resp.studio.studio_encryption_configuration.key_type #=> String, one of "AWS_OWNED_KEY", "CUSTOMER_MANAGED_KEY"
|
@@ -2889,25 +3101,29 @@ module Aws::NimbleStudio
|
|
2889
3101
|
req.send_request(options)
|
2890
3102
|
end
|
2891
3103
|
|
2892
|
-
# Transitions sessions from the READY state into the STOPPED state.
|
2893
|
-
#
|
2894
|
-
# and STOPPED states.
|
3104
|
+
# Transitions sessions from the `READY` state into the `STOPPED` state.
|
3105
|
+
# The `STOP_IN_PROGRESS` state is the intermediate state between the
|
3106
|
+
# `READY` and `STOPPED` states.
|
2895
3107
|
#
|
2896
3108
|
# @option params [String] :client_token
|
2897
3109
|
# Unique, case-sensitive identifier that you provide to ensure the
|
2898
3110
|
# idempotency of the request. If you don’t specify a client token, the
|
2899
|
-
#
|
2900
|
-
# request to ensure idempotency.
|
3111
|
+
# Amazon Web Services SDK automatically generates a client token and
|
3112
|
+
# uses it for the request to ensure idempotency.
|
2901
3113
|
#
|
2902
3114
|
# **A suitable default value is auto-generated.** You should normally
|
2903
3115
|
# not need to pass this option.**
|
2904
3116
|
#
|
2905
3117
|
# @option params [required, String] :session_id
|
2906
|
-
# The streaming session ID for the StopStreamingSessionRequest
|
3118
|
+
# The streaming session ID for the `StopStreamingSessionRequest`.
|
2907
3119
|
#
|
2908
3120
|
# @option params [required, String] :studio_id
|
2909
3121
|
# The studioId for the StopStreamingSessionRequest.
|
2910
3122
|
#
|
3123
|
+
# @option params [String] :volume_retention_mode
|
3124
|
+
# Adds additional instructions to a streaming session stop action to
|
3125
|
+
# either retain the EBS volumes or delete the EBS volumes.
|
3126
|
+
#
|
2911
3127
|
# @return [Types::StopStreamingSessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2912
3128
|
#
|
2913
3129
|
# * {Types::StopStreamingSessionResponse#session #session} => Types::StreamingSession
|
@@ -2918,19 +3134,25 @@ module Aws::NimbleStudio
|
|
2918
3134
|
# client_token: "ClientToken",
|
2919
3135
|
# session_id: "String", # required
|
2920
3136
|
# studio_id: "String", # required
|
3137
|
+
# volume_retention_mode: "RETAIN", # accepts RETAIN, DELETE
|
2921
3138
|
# })
|
2922
3139
|
#
|
2923
3140
|
# @example Response structure
|
2924
3141
|
#
|
2925
3142
|
# resp.session.arn #=> String
|
3143
|
+
# resp.session.automatic_termination_mode #=> String, one of "DEACTIVATED", "ACTIVATED"
|
3144
|
+
# resp.session.backup_mode #=> String, one of "AUTOMATIC", "DEACTIVATED"
|
2926
3145
|
# resp.session.created_at #=> Time
|
2927
3146
|
# resp.session.created_by #=> String
|
2928
3147
|
# resp.session.ec2_instance_type #=> String
|
2929
3148
|
# resp.session.launch_profile_id #=> String
|
3149
|
+
# resp.session.max_backups_to_retain #=> Integer
|
2930
3150
|
# resp.session.owned_by #=> String
|
2931
3151
|
# resp.session.session_id #=> String
|
3152
|
+
# resp.session.session_persistence_mode #=> String, one of "DEACTIVATED", "ACTIVATED"
|
2932
3153
|
# resp.session.started_at #=> Time
|
2933
3154
|
# resp.session.started_by #=> String
|
3155
|
+
# resp.session.started_from_backup_id #=> String
|
2934
3156
|
# resp.session.state #=> String, one of "CREATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "READY", "DELETED", "CREATE_FAILED", "DELETE_FAILED", "STOP_IN_PROGRESS", "START_IN_PROGRESS", "STOPPED", "STOP_FAILED", "START_FAILED"
|
2935
3157
|
# resp.session.status_code #=> String, one of "STREAMING_SESSION_READY", "STREAMING_SESSION_DELETED", "STREAMING_SESSION_CREATE_IN_PROGRESS", "STREAMING_SESSION_DELETE_IN_PROGRESS", "INTERNAL_ERROR", "INSUFFICIENT_CAPACITY", "ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR", "NETWORK_CONNECTION_ERROR", "INITIALIZATION_SCRIPT_ERROR", "DECRYPT_STREAMING_IMAGE_ERROR", "NETWORK_INTERFACE_ERROR", "STREAMING_SESSION_STOPPED", "STREAMING_SESSION_STARTED", "STREAMING_SESSION_STOP_IN_PROGRESS", "STREAMING_SESSION_START_IN_PROGRESS", "AMI_VALIDATION_ERROR"
|
2936
3158
|
# resp.session.status_message #=> String
|
@@ -2943,6 +3165,10 @@ module Aws::NimbleStudio
|
|
2943
3165
|
# resp.session.terminate_at #=> Time
|
2944
3166
|
# resp.session.updated_at #=> Time
|
2945
3167
|
# resp.session.updated_by #=> String
|
3168
|
+
# resp.session.volume_configuration.iops #=> Integer
|
3169
|
+
# resp.session.volume_configuration.size #=> Integer
|
3170
|
+
# resp.session.volume_configuration.throughput #=> Integer
|
3171
|
+
# resp.session.volume_retention_mode #=> String, one of "RETAIN", "DELETE"
|
2946
3172
|
#
|
2947
3173
|
# @see http://docs.aws.amazon.com/goto/WebAPI/nimble-2020-08-01/StopStreamingSession AWS API Documentation
|
2948
3174
|
#
|
@@ -2960,7 +3186,7 @@ module Aws::NimbleStudio
|
|
2960
3186
|
# to.
|
2961
3187
|
#
|
2962
3188
|
# @option params [Hash<String,String>] :tags
|
2963
|
-
# A collection of labels, in the form of key
|
3189
|
+
# A collection of labels, in the form of key-value pairs, that apply to
|
2964
3190
|
# this resource.
|
2965
3191
|
#
|
2966
3192
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -3015,8 +3241,8 @@ module Aws::NimbleStudio
|
|
3015
3241
|
# @option params [String] :client_token
|
3016
3242
|
# Unique, case-sensitive identifier that you provide to ensure the
|
3017
3243
|
# idempotency of the request. If you don’t specify a client token, the
|
3018
|
-
#
|
3019
|
-
# request to ensure idempotency.
|
3244
|
+
# Amazon Web Services SDK automatically generates a client token and
|
3245
|
+
# uses it for the request to ensure idempotency.
|
3020
3246
|
#
|
3021
3247
|
# **A suitable default value is auto-generated.** You should normally
|
3022
3248
|
# not need to pass this option.**
|
@@ -3025,7 +3251,8 @@ module Aws::NimbleStudio
|
|
3025
3251
|
# The description.
|
3026
3252
|
#
|
3027
3253
|
# @option params [required, String] :launch_profile_id
|
3028
|
-
# The
|
3254
|
+
# The ID of the launch profile used to control access from the streaming
|
3255
|
+
# session.
|
3029
3256
|
#
|
3030
3257
|
# @option params [Array<String>] :launch_profile_protocol_versions
|
3031
3258
|
# The version number of the protocol that is used by the launch profile.
|
@@ -3057,10 +3284,16 @@ module Aws::NimbleStudio
|
|
3057
3284
|
# launch_profile_protocol_versions: ["LaunchProfileProtocolVersion"],
|
3058
3285
|
# name: "LaunchProfileName",
|
3059
3286
|
# stream_configuration: {
|
3287
|
+
# automatic_termination_mode: "DEACTIVATED", # accepts DEACTIVATED, ACTIVATED
|
3060
3288
|
# clipboard_mode: "ENABLED", # required, accepts ENABLED, DISABLED
|
3061
3289
|
# 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
|
3062
3290
|
# max_session_length_in_minutes: 1,
|
3063
3291
|
# max_stopped_session_length_in_minutes: 1,
|
3292
|
+
# session_backup: {
|
3293
|
+
# max_backups_to_retain: 1,
|
3294
|
+
# mode: "AUTOMATIC", # accepts AUTOMATIC, DEACTIVATED
|
3295
|
+
# },
|
3296
|
+
# session_persistence_mode: "DEACTIVATED", # accepts DEACTIVATED, ACTIVATED
|
3064
3297
|
# session_storage: {
|
3065
3298
|
# mode: ["UPLOAD"], # required, accepts UPLOAD
|
3066
3299
|
# root: {
|
@@ -3069,6 +3302,11 @@ module Aws::NimbleStudio
|
|
3069
3302
|
# },
|
3070
3303
|
# },
|
3071
3304
|
# streaming_image_ids: ["StreamingImageId"], # required
|
3305
|
+
# volume_configuration: {
|
3306
|
+
# iops: 1,
|
3307
|
+
# size: 1,
|
3308
|
+
# throughput: 1,
|
3309
|
+
# },
|
3072
3310
|
# },
|
3073
3311
|
# studio_component_ids: ["String"],
|
3074
3312
|
# studio_id: "String", # required
|
@@ -3089,17 +3327,24 @@ module Aws::NimbleStudio
|
|
3089
3327
|
# resp.launch_profile.state #=> String, one of "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED"
|
3090
3328
|
# resp.launch_profile.status_code #=> String, one of "LAUNCH_PROFILE_CREATED", "LAUNCH_PROFILE_UPDATED", "LAUNCH_PROFILE_DELETED", "LAUNCH_PROFILE_CREATE_IN_PROGRESS", "LAUNCH_PROFILE_UPDATE_IN_PROGRESS", "LAUNCH_PROFILE_DELETE_IN_PROGRESS", "INTERNAL_ERROR", "STREAMING_IMAGE_NOT_FOUND", "STREAMING_IMAGE_NOT_READY", "LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED", "ENCRYPTION_KEY_ACCESS_DENIED", "ENCRYPTION_KEY_NOT_FOUND", "INVALID_SUBNETS_PROVIDED", "INVALID_INSTANCE_TYPES_PROVIDED", "INVALID_SUBNETS_COMBINATION"
|
3091
3329
|
# resp.launch_profile.status_message #=> String
|
3330
|
+
# resp.launch_profile.stream_configuration.automatic_termination_mode #=> String, one of "DEACTIVATED", "ACTIVATED"
|
3092
3331
|
# resp.launch_profile.stream_configuration.clipboard_mode #=> String, one of "ENABLED", "DISABLED"
|
3093
3332
|
# resp.launch_profile.stream_configuration.ec2_instance_types #=> Array
|
3094
3333
|
# resp.launch_profile.stream_configuration.ec2_instance_types[0] #=> String, one of "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"
|
3095
3334
|
# resp.launch_profile.stream_configuration.max_session_length_in_minutes #=> Integer
|
3096
3335
|
# resp.launch_profile.stream_configuration.max_stopped_session_length_in_minutes #=> Integer
|
3336
|
+
# resp.launch_profile.stream_configuration.session_backup.max_backups_to_retain #=> Integer
|
3337
|
+
# resp.launch_profile.stream_configuration.session_backup.mode #=> String, one of "AUTOMATIC", "DEACTIVATED"
|
3338
|
+
# resp.launch_profile.stream_configuration.session_persistence_mode #=> String, one of "DEACTIVATED", "ACTIVATED"
|
3097
3339
|
# resp.launch_profile.stream_configuration.session_storage.mode #=> Array
|
3098
3340
|
# resp.launch_profile.stream_configuration.session_storage.mode[0] #=> String, one of "UPLOAD"
|
3099
3341
|
# resp.launch_profile.stream_configuration.session_storage.root.linux #=> String
|
3100
3342
|
# resp.launch_profile.stream_configuration.session_storage.root.windows #=> String
|
3101
3343
|
# resp.launch_profile.stream_configuration.streaming_image_ids #=> Array
|
3102
3344
|
# resp.launch_profile.stream_configuration.streaming_image_ids[0] #=> String
|
3345
|
+
# resp.launch_profile.stream_configuration.volume_configuration.iops #=> Integer
|
3346
|
+
# resp.launch_profile.stream_configuration.volume_configuration.size #=> Integer
|
3347
|
+
# resp.launch_profile.stream_configuration.volume_configuration.throughput #=> Integer
|
3103
3348
|
# resp.launch_profile.studio_component_ids #=> Array
|
3104
3349
|
# resp.launch_profile.studio_component_ids[0] #=> String
|
3105
3350
|
# resp.launch_profile.tags #=> Hash
|
@@ -3126,14 +3371,15 @@ module Aws::NimbleStudio
|
|
3126
3371
|
# @option params [String] :client_token
|
3127
3372
|
# Unique, case-sensitive identifier that you provide to ensure the
|
3128
3373
|
# idempotency of the request. If you don’t specify a client token, the
|
3129
|
-
#
|
3130
|
-
# request to ensure idempotency.
|
3374
|
+
# Amazon Web Services SDK automatically generates a client token and
|
3375
|
+
# uses it for the request to ensure idempotency.
|
3131
3376
|
#
|
3132
3377
|
# **A suitable default value is auto-generated.** You should normally
|
3133
3378
|
# not need to pass this option.**
|
3134
3379
|
#
|
3135
3380
|
# @option params [required, String] :launch_profile_id
|
3136
|
-
# The
|
3381
|
+
# The ID of the launch profile used to control access from the streaming
|
3382
|
+
# session.
|
3137
3383
|
#
|
3138
3384
|
# @option params [required, String] :persona
|
3139
3385
|
# The persona.
|
@@ -3180,8 +3426,8 @@ module Aws::NimbleStudio
|
|
3180
3426
|
# @option params [String] :client_token
|
3181
3427
|
# Unique, case-sensitive identifier that you provide to ensure the
|
3182
3428
|
# idempotency of the request. If you don’t specify a client token, the
|
3183
|
-
#
|
3184
|
-
# request to ensure idempotency.
|
3429
|
+
# Amazon Web Services SDK automatically generates a client token and
|
3430
|
+
# uses it for the request to ensure idempotency.
|
3185
3431
|
#
|
3186
3432
|
# **A suitable default value is auto-generated.** You should normally
|
3187
3433
|
# not need to pass this option.**
|
@@ -3252,8 +3498,8 @@ module Aws::NimbleStudio
|
|
3252
3498
|
# @option params [String] :client_token
|
3253
3499
|
# Unique, case-sensitive identifier that you provide to ensure the
|
3254
3500
|
# idempotency of the request. If you don’t specify a client token, the
|
3255
|
-
#
|
3256
|
-
# request to ensure idempotency.
|
3501
|
+
# Amazon Web Services SDK automatically generates a client token and
|
3502
|
+
# uses it for the request to ensure idempotency.
|
3257
3503
|
#
|
3258
3504
|
# **A suitable default value is auto-generated.** You should normally
|
3259
3505
|
# not need to pass this option.**
|
@@ -3291,7 +3537,7 @@ module Aws::NimbleStudio
|
|
3291
3537
|
# resp.studio.home_region #=> String
|
3292
3538
|
# resp.studio.sso_client_id #=> String
|
3293
3539
|
# resp.studio.state #=> String, one of "CREATE_IN_PROGRESS", "READY", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "CREATE_FAILED", "UPDATE_FAILED"
|
3294
|
-
# resp.studio.status_code #=> String, one of "STUDIO_CREATED", "STUDIO_DELETED", "STUDIO_UPDATED", "STUDIO_CREATE_IN_PROGRESS", "STUDIO_UPDATE_IN_PROGRESS", "STUDIO_DELETE_IN_PROGRESS", "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED", "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED", "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED", "AWS_SSO_NOT_ENABLED", "AWS_SSO_ACCESS_DENIED", "ROLE_NOT_OWNED_BY_STUDIO_OWNER", "ROLE_COULD_NOT_BE_ASSUMED", "INTERNAL_ERROR", "ENCRYPTION_KEY_NOT_FOUND", "ENCRYPTION_KEY_ACCESS_DENIED", "AWS_SSO_CONFIGURATION_REPAIRED", "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS"
|
3540
|
+
# resp.studio.status_code #=> String, one of "STUDIO_CREATED", "STUDIO_DELETED", "STUDIO_UPDATED", "STUDIO_CREATE_IN_PROGRESS", "STUDIO_UPDATE_IN_PROGRESS", "STUDIO_DELETE_IN_PROGRESS", "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED", "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED", "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED", "AWS_SSO_NOT_ENABLED", "AWS_SSO_ACCESS_DENIED", "ROLE_NOT_OWNED_BY_STUDIO_OWNER", "ROLE_COULD_NOT_BE_ASSUMED", "INTERNAL_ERROR", "ENCRYPTION_KEY_NOT_FOUND", "ENCRYPTION_KEY_ACCESS_DENIED", "AWS_SSO_CONFIGURATION_REPAIRED", "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS", "AWS_STS_REGION_DISABLED"
|
3295
3541
|
# resp.studio.status_message #=> String
|
3296
3542
|
# resp.studio.studio_encryption_configuration.key_arn #=> String
|
3297
3543
|
# resp.studio.studio_encryption_configuration.key_type #=> String, one of "AWS_OWNED_KEY", "CUSTOMER_MANAGED_KEY"
|
@@ -3317,8 +3563,8 @@ module Aws::NimbleStudio
|
|
3317
3563
|
# @option params [String] :client_token
|
3318
3564
|
# Unique, case-sensitive identifier that you provide to ensure the
|
3319
3565
|
# idempotency of the request. If you don’t specify a client token, the
|
3320
|
-
#
|
3321
|
-
# request to ensure idempotency.
|
3566
|
+
# Amazon Web Services SDK automatically generates a client token and
|
3567
|
+
# uses it for the request to ensure idempotency.
|
3322
3568
|
#
|
3323
3569
|
# **A suitable default value is auto-generated.** You should normally
|
3324
3570
|
# not need to pass this option.**
|
@@ -3340,8 +3586,8 @@ module Aws::NimbleStudio
|
|
3340
3586
|
#
|
3341
3587
|
# @option params [String] :runtime_role_arn
|
3342
3588
|
# An IAM role attached to a Studio Component that gives the studio
|
3343
|
-
# component access to
|
3344
|
-
# running.
|
3589
|
+
# component access to Amazon Web Services resources at anytime while the
|
3590
|
+
# instance is running.
|
3345
3591
|
#
|
3346
3592
|
# @option params [Array<Types::ScriptParameterKeyValue>] :script_parameters
|
3347
3593
|
# Parameters for the studio component scripts.
|
@@ -3349,7 +3595,8 @@ module Aws::NimbleStudio
|
|
3349
3595
|
# @option params [String] :secure_initialization_role_arn
|
3350
3596
|
# An IAM role attached to Studio Component when the system
|
3351
3597
|
# initialization script runs which give the studio component access to
|
3352
|
-
#
|
3598
|
+
# Amazon Web Services resources when the system initialization script
|
3599
|
+
# runs.
|
3353
3600
|
#
|
3354
3601
|
# @option params [required, String] :studio_component_id
|
3355
3602
|
# The studio component ID.
|
@@ -3487,7 +3734,7 @@ module Aws::NimbleStudio
|
|
3487
3734
|
params: params,
|
3488
3735
|
config: config)
|
3489
3736
|
context[:gem_name] = 'aws-sdk-nimblestudio'
|
3490
|
-
context[:gem_version] = '1.
|
3737
|
+
context[:gem_version] = '1.17.0'
|
3491
3738
|
Seahorse::Client::Request.new(handlers, context)
|
3492
3739
|
end
|
3493
3740
|
|