Class: Aws::NimbleStudio::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::NimbleStudio::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb
Overview
An API client for NimbleStudio. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::NimbleStudio::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#accept_eulas(params = {}) ⇒ Types::AcceptEulasResponse
Accept EULAs.
-
#create_launch_profile(params = {}) ⇒ Types::CreateLaunchProfileResponse
Create a launch profile.
-
#create_streaming_image(params = {}) ⇒ Types::CreateStreamingImageResponse
Creates a streaming image resource in a studio.
-
#create_streaming_session(params = {}) ⇒ Types::CreateStreamingSessionResponse
Creates a streaming session in a studio.
-
#create_streaming_session_stream(params = {}) ⇒ Types::CreateStreamingSessionStreamResponse
Creates a streaming session stream for a streaming session.
-
#create_studio(params = {}) ⇒ Types::CreateStudioResponse
Create a new studio.
-
#create_studio_component(params = {}) ⇒ Types::CreateStudioComponentResponse
Creates a studio component resource.
-
#delete_launch_profile(params = {}) ⇒ Types::DeleteLaunchProfileResponse
Permanently delete a launch profile.
-
#delete_launch_profile_member(params = {}) ⇒ Struct
Delete a user from launch profile membership.
-
#delete_streaming_image(params = {}) ⇒ Types::DeleteStreamingImageResponse
Delete streaming image.
-
#delete_streaming_session(params = {}) ⇒ Types::DeleteStreamingSessionResponse
Deletes streaming session resource.
-
#delete_studio(params = {}) ⇒ Types::DeleteStudioResponse
Delete a studio resource.
-
#delete_studio_component(params = {}) ⇒ Types::DeleteStudioComponentResponse
Deletes a studio component resource.
-
#delete_studio_member(params = {}) ⇒ Struct
Delete a user from studio membership.
-
#get_eula(params = {}) ⇒ Types::GetEulaResponse
Get EULA.
-
#get_launch_profile(params = {}) ⇒ Types::GetLaunchProfileResponse
Get a launch profile.
-
#get_launch_profile_details(params = {}) ⇒ Types::GetLaunchProfileDetailsResponse
Launch profile details include the launch profile resource and summary information of resources that are used by, or available to, the launch profile.
-
#get_launch_profile_initialization(params = {}) ⇒ Types::GetLaunchProfileInitializationResponse
Get a launch profile initialization.
-
#get_launch_profile_member(params = {}) ⇒ Types::GetLaunchProfileMemberResponse
Get a user persona in launch profile membership.
-
#get_streaming_image(params = {}) ⇒ Types::GetStreamingImageResponse
Get streaming image.
-
#get_streaming_session(params = {}) ⇒ Types::GetStreamingSessionResponse
Gets StreamingSession resource.
-
#get_streaming_session_backup(params = {}) ⇒ Types::GetStreamingSessionBackupResponse
Gets
StreamingSessionBackup
resource. -
#get_streaming_session_stream(params = {}) ⇒ Types::GetStreamingSessionStreamResponse
Gets a StreamingSessionStream for a streaming session.
-
#get_studio(params = {}) ⇒ Types::GetStudioResponse
Get a studio resource.
-
#get_studio_component(params = {}) ⇒ Types::GetStudioComponentResponse
Gets a studio component resource.
-
#get_studio_member(params = {}) ⇒ Types::GetStudioMemberResponse
Get a user's membership in a studio.
-
#list_eula_acceptances(params = {}) ⇒ Types::ListEulaAcceptancesResponse
List EULA acceptances.
-
#list_eulas(params = {}) ⇒ Types::ListEulasResponse
List EULAs.
-
#list_launch_profile_members(params = {}) ⇒ Types::ListLaunchProfileMembersResponse
Get all users in a given launch profile membership.
-
#list_launch_profiles(params = {}) ⇒ Types::ListLaunchProfilesResponse
List all the launch profiles a studio.
-
#list_streaming_images(params = {}) ⇒ Types::ListStreamingImagesResponse
List the streaming image resources available to this studio.
-
#list_streaming_session_backups(params = {}) ⇒ Types::ListStreamingSessionBackupsResponse
Lists the backups of a streaming session in a studio.
-
#list_streaming_sessions(params = {}) ⇒ Types::ListStreamingSessionsResponse
Lists the streaming sessions in a studio.
-
#list_studio_components(params = {}) ⇒ Types::ListStudioComponentsResponse
Lists the
StudioComponents
in a studio. -
#list_studio_members(params = {}) ⇒ Types::ListStudioMembersResponse
Get all users in a given studio membership.
-
#list_studios(params = {}) ⇒ Types::ListStudiosResponse
List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Gets the tags for a resource, given its Amazon Resource Names (ARN).
-
#put_launch_profile_members(params = {}) ⇒ Struct
Add/update users with given persona to launch profile membership.
-
#put_studio_members(params = {}) ⇒ Struct
Add/update users with given persona to studio membership.
-
#start_streaming_session(params = {}) ⇒ Types::StartStreamingSessionResponse
Transitions sessions from the
STOPPED
state into theREADY
state. -
#start_studio_sso_configuration_repair(params = {}) ⇒ Types::StartStudioSSOConfigurationRepairResponse
Repairs the IAM Identity Center configuration for a given studio.
-
#stop_streaming_session(params = {}) ⇒ Types::StopStreamingSessionResponse
Transitions sessions from the
READY
state into theSTOPPED
state. -
#tag_resource(params = {}) ⇒ Struct
Creates tags for a resource, given its ARN.
-
#untag_resource(params = {}) ⇒ Struct
Deletes the tags for a resource.
-
#update_launch_profile(params = {}) ⇒ Types::UpdateLaunchProfileResponse
Update a launch profile.
-
#update_launch_profile_member(params = {}) ⇒ Types::UpdateLaunchProfileMemberResponse
Update a user persona in launch profile membership.
-
#update_streaming_image(params = {}) ⇒ Types::UpdateStreamingImageResponse
Update streaming image.
-
#update_studio(params = {}) ⇒ Types::UpdateStudioResponse
Update a Studio resource.
-
#update_studio_component(params = {}) ⇒ Types::UpdateStudioComponentResponse
Updates a studio component resource.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
385 386 387 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 385 def initialize(*args) super end |
Instance Method Details
#accept_eulas(params = {}) ⇒ Types::AcceptEulasResponse
Accept EULAs.
433 434 435 436 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 433 def accept_eulas(params = {}, = {}) req = build_request(:accept_eulas, params) req.send_request() end |
#create_launch_profile(params = {}) ⇒ Types::CreateLaunchProfileResponse
Create a launch profile.
571 572 573 574 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 571 def create_launch_profile(params = {}, = {}) req = build_request(:create_launch_profile, params) req.send_request() end |
#create_streaming_image(params = {}) ⇒ Types::CreateStreamingImageResponse
Creates a streaming image resource in a studio.
644 645 646 647 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 644 def create_streaming_image(params = {}, = {}) req = build_request(:create_streaming_image, params) req.send_request() end |
#create_streaming_session(params = {}) ⇒ Types::CreateStreamingSessionResponse
Creates a streaming session in a studio.
After invoking this operation, you must poll GetStreamingSession until
the streaming session is in the READY
state.
740 741 742 743 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 740 def create_streaming_session(params = {}, = {}) req = build_request(:create_streaming_session, params) req.send_request() end |
#create_streaming_session_stream(params = {}) ⇒ Types::CreateStreamingSessionStreamResponse
Creates a streaming session stream for a streaming session.
After invoking this API, invoke GetStreamingSessionStream with the
returned streamId to poll the resource until it is in the READY
state.
797 798 799 800 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 797 def create_streaming_session_stream(params = {}, = {}) req = build_request(:create_streaming_session_stream, params) req.send_request() end |
#create_studio(params = {}) ⇒ Types::CreateStudioResponse
Create a new studio.
When creating a studio, two IAM roles must be provided: the admin role and the user role. These roles are assumed by your users when they log in to the Nimble Studio portal.
The user role must have the AmazonNimbleStudio-StudioUser
managed
policy attached for the portal to function properly.
The admin role must have the AmazonNimbleStudio-StudioAdmin
managed
policy attached for the portal to function properly.
You may optionally specify a KMS key in the
StudioEncryptionConfiguration
.
In Nimble Studio, resource names, descriptions, initialization
scripts, and other data you provide are always encrypted at rest using
an KMS key. By default, this key is owned by Amazon Web Services and
managed on your behalf. You may provide your own KMS key when calling
CreateStudio
to encrypt this data using a key you own and manage.
When providing an KMS key during studio creation, Nimble Studio creates KMS grants in your account to provide your studio user and admin roles access to these KMS keys.
If you delete this grant, the studio will no longer be accessible to your portal users.
If you delete the studio KMS key, your studio will no longer be accessible.
910 911 912 913 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 910 def create_studio(params = {}, = {}) req = build_request(:create_studio, params) req.send_request() end |
#create_studio_component(params = {}) ⇒ Types::CreateStudioComponentResponse
Creates a studio component resource.
1076 1077 1078 1079 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1076 def create_studio_component(params = {}, = {}) req = build_request(:create_studio_component, params) req.send_request() end |
#delete_launch_profile(params = {}) ⇒ Types::DeleteLaunchProfileResponse
Permanently delete a launch profile.
1160 1161 1162 1163 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1160 def delete_launch_profile(params = {}, = {}) req = build_request(:delete_launch_profile, params) req.send_request() end |
#delete_launch_profile_member(params = {}) ⇒ Struct
Delete a user from launch profile membership.
1202 1203 1204 1205 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1202 def delete_launch_profile_member(params = {}, = {}) req = build_request(:delete_launch_profile_member, params) req.send_request() end |
#delete_streaming_image(params = {}) ⇒ Types::DeleteStreamingImageResponse
Delete streaming image.
1259 1260 1261 1262 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1259 def delete_streaming_image(params = {}, = {}) req = build_request(:delete_streaming_image, params) req.send_request() end |
#delete_streaming_session(params = {}) ⇒ Types::DeleteStreamingSessionResponse
Deletes streaming session resource.
After invoking this operation, use GetStreamingSession to poll the
resource until it transitions to a DELETED
state.
A streaming session will count against your streaming session quota
until it is marked DELETED
.
1336 1337 1338 1339 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1336 def delete_streaming_session(params = {}, = {}) req = build_request(:delete_streaming_session, params) req.send_request() end |
#delete_studio(params = {}) ⇒ Types::DeleteStudioResponse
Delete a studio resource.
1391 1392 1393 1394 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1391 def delete_studio(params = {}, = {}) req = build_request(:delete_studio, params) req.send_request() end |
#delete_studio_component(params = {}) ⇒ Types::DeleteStudioComponentResponse
Deletes a studio component resource.
1472 1473 1474 1475 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1472 def delete_studio_component(params = {}, = {}) req = build_request(:delete_studio_component, params) req.send_request() end |
#delete_studio_member(params = {}) ⇒ Struct
Delete a user from studio membership.
1509 1510 1511 1512 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1509 def delete_studio_member(params = {}, = {}) req = build_request(:delete_studio_member, params) req.send_request() end |
#get_eula(params = {}) ⇒ Types::GetEulaResponse
Get EULA.
1541 1542 1543 1544 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1541 def get_eula(params = {}, = {}) req = build_request(:get_eula, params) req.send_request() end |
#get_launch_profile(params = {}) ⇒ Types::GetLaunchProfileResponse
Get a launch profile.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- launch_profile_deleted
- launch_profile_ready
1621 1622 1623 1624 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1621 def get_launch_profile(params = {}, = {}) req = build_request(:get_launch_profile, params) req.send_request() end |
#get_launch_profile_details(params = {}) ⇒ Types::GetLaunchProfileDetailsResponse
Launch profile details include the launch profile resource and summary information of resources that are used by, or available to, the launch profile. This includes the name and description of all studio components used by the launch profiles, and the name and description of streaming images that can be used with this launch profile.
1728 1729 1730 1731 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1728 def get_launch_profile_details(params = {}, = {}) req = build_request(:get_launch_profile_details, params) req.send_request() end |
#get_launch_profile_initialization(params = {}) ⇒ Types::GetLaunchProfileInitializationResponse
Get a launch profile initialization.
1802 1803 1804 1805 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1802 def get_launch_profile_initialization(params = {}, = {}) req = build_request(:get_launch_profile_initialization, params) req.send_request() end |
#get_launch_profile_member(params = {}) ⇒ Types::GetLaunchProfileMemberResponse
Get a user persona in launch profile membership.
1843 1844 1845 1846 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1843 def get_launch_profile_member(params = {}, = {}) req = build_request(:get_launch_profile_member, params) req.send_request() end |
#get_streaming_image(params = {}) ⇒ Types::GetStreamingImageResponse
Get streaming image.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- streaming_image_deleted
- streaming_image_ready
1896 1897 1898 1899 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1896 def get_streaming_image(params = {}, = {}) req = build_request(:get_streaming_image, params) req.send_request() end |
#get_streaming_session(params = {}) ⇒ Types::GetStreamingSessionResponse
Gets StreamingSession resource.
Invoke this operation to poll for a streaming session state while creating or deleting a session.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- streaming_session_deleted
- streaming_session_ready
- streaming_session_stopped
1967 1968 1969 1970 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1967 def get_streaming_session(params = {}, = {}) req = build_request(:get_streaming_session, params) req.send_request() end |
#get_streaming_session_backup(params = {}) ⇒ Types::GetStreamingSessionBackupResponse
Gets StreamingSessionBackup
resource.
Invoke this operation to poll for a streaming session backup while stopping a streaming session.
2012 2013 2014 2015 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2012 def get_streaming_session_backup(params = {}, = {}) req = build_request(:get_streaming_session_backup, params) req.send_request() end |
#get_streaming_session_stream(params = {}) ⇒ Types::GetStreamingSessionStreamResponse
Gets a StreamingSessionStream for a streaming session.
Invoke this operation to poll the resource after invoking
CreateStreamingSessionStream
.
After the StreamingSessionStream
changes to the READY
state, the
url property will contain a stream to be used with the DCV streaming
client.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- streaming_session_stream_ready
2067 2068 2069 2070 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2067 def get_streaming_session_stream(params = {}, = {}) req = build_request(:get_streaming_session_stream, params) req.send_request() end |
#get_studio(params = {}) ⇒ Types::GetStudioResponse
Get a studio resource.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- studio_deleted
- studio_ready
2118 2119 2120 2121 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2118 def get_studio(params = {}, = {}) req = build_request(:get_studio, params) req.send_request() end |
#get_studio_component(params = {}) ⇒ Types::GetStudioComponentResponse
Gets a studio component resource.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- studio_component_deleted
- studio_component_ready
2195 2196 2197 2198 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2195 def get_studio_component(params = {}, = {}) req = build_request(:get_studio_component, params) req.send_request() end |
#get_studio_member(params = {}) ⇒ Types::GetStudioMemberResponse
Get a user's membership in a studio.
2231 2232 2233 2234 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2231 def get_studio_member(params = {}, = {}) req = build_request(:get_studio_member, params) req.send_request() end |
#list_eula_acceptances(params = {}) ⇒ Types::ListEulaAcceptancesResponse
List EULA acceptances.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2277 2278 2279 2280 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2277 def list_eula_acceptances(params = {}, = {}) req = build_request(:list_eula_acceptances, params) req.send_request() end |
#list_eulas(params = {}) ⇒ Types::ListEulasResponse
List EULAs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2319 2320 2321 2322 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2319 def list_eulas(params = {}, = {}) req = build_request(:list_eulas, params) req.send_request() end |
#list_launch_profile_members(params = {}) ⇒ Types::ListLaunchProfileMembersResponse
Get all users in a given launch profile membership.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2369 2370 2371 2372 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2369 def list_launch_profile_members(params = {}, = {}) req = build_request(:list_launch_profile_members, params) req.send_request() end |
#list_launch_profiles(params = {}) ⇒ Types::ListLaunchProfilesResponse
List all the launch profiles a studio.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2461 2462 2463 2464 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2461 def list_launch_profiles(params = {}, = {}) req = build_request(:list_launch_profiles, params) req.send_request() end |
#list_streaming_images(params = {}) ⇒ Types::ListStreamingImagesResponse
List the streaming image resources available to this studio.
This list will contain both images provided by Amazon Web Services, as well as streaming images that you have created in your studio.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2521 2522 2523 2524 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2521 def list_streaming_images(params = {}, = {}) req = build_request(:list_streaming_images, params) req.send_request() end |
#list_streaming_session_backups(params = {}) ⇒ Types::ListStreamingSessionBackupsResponse
Lists the backups of a streaming session in a studio.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2573 2574 2575 2576 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2573 def list_streaming_session_backups(params = {}, = {}) req = build_request(:list_streaming_session_backups, params) req.send_request() end |
#list_streaming_sessions(params = {}) ⇒ Types::ListStreamingSessionsResponse
Lists the streaming sessions in a studio.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2652 2653 2654 2655 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2652 def list_streaming_sessions(params = {}, = {}) req = build_request(:list_streaming_sessions, params) req.send_request() end |
#list_studio_components(params = {}) ⇒ Types::ListStudioComponentsResponse
Lists the StudioComponents
in a studio.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2743 2744 2745 2746 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2743 def list_studio_components(params = {}, = {}) req = build_request(:list_studio_components, params) req.send_request() end |
#list_studio_members(params = {}) ⇒ Types::ListStudioMembersResponse
Get all users in a given studio membership.
ListStudioMembers
only returns admin members.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2792 2793 2794 2795 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2792 def list_studio_members(params = {}, = {}) req = build_request(:list_studio_members, params) req.send_request() end |
#list_studios(params = {}) ⇒ Types::ListStudiosResponse
List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2844 2845 2846 2847 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2844 def list_studios(params = {}, = {}) req = build_request(:list_studios, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Gets the tags for a resource, given its Amazon Resource Names (ARN).
This operation supports ARNs for all resource types in Nimble Studio that support tags, including studio, studio component, launch profile, streaming image, and streaming session. All resources that can be tagged will contain an ARN property, so you do not have to create this ARN yourself.
2880 2881 2882 2883 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2880 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_launch_profile_members(params = {}) ⇒ Struct
Add/update users with given persona to launch profile membership.
2930 2931 2932 2933 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2930 def put_launch_profile_members(params = {}, = {}) req = build_request(:put_launch_profile_members, params) req.send_request() end |
#put_studio_members(params = {}) ⇒ Struct
Add/update users with given persona to studio membership.
2975 2976 2977 2978 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2975 def put_studio_members(params = {}, = {}) req = build_request(:put_studio_members, params) req.send_request() end |
#start_streaming_session(params = {}) ⇒ Types::StartStreamingSessionResponse
Transitions sessions from the STOPPED
state into the READY
state.
The START_IN_PROGRESS
state is the intermediate state between the
STOPPED
and READY
states.
3052 3053 3054 3055 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 3052 def start_streaming_session(params = {}, = {}) req = build_request(:start_streaming_session, params) req.send_request() end |
#start_studio_sso_configuration_repair(params = {}) ⇒ Types::StartStudioSSOConfigurationRepairResponse
Repairs the IAM Identity Center configuration for a given studio.
If the studio has a valid IAM Identity Center configuration currently associated with it, this operation will fail with a validation error.
If the studio does not have a valid IAM Identity Center configuration
currently associated with it, then a new IAM Identity Center
application is created for the studio and the studio is changed to the
READY
state.
After the IAM Identity Center application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio.
3119 3120 3121 3122 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 3119 def start_studio_sso_configuration_repair(params = {}, = {}) req = build_request(:start_studio_sso_configuration_repair, params) req.send_request() end |
#stop_streaming_session(params = {}) ⇒ Types::StopStreamingSessionResponse
Transitions sessions from the READY
state into the STOPPED
state.
The STOP_IN_PROGRESS
state is the intermediate state between the
READY
and STOPPED
states.
3197 3198 3199 3200 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 3197 def stop_streaming_session(params = {}, = {}) req = build_request(:stop_streaming_session, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Creates tags for a resource, given its ARN.
3227 3228 3229 3230 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 3227 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Deletes the tags for a resource.
3254 3255 3256 3257 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 3254 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_launch_profile(params = {}) ⇒ Types::UpdateLaunchProfileResponse
Update a launch profile.
3384 3385 3386 3387 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 3384 def update_launch_profile(params = {}, = {}) req = build_request(:update_launch_profile, params) req.send_request() end |
#update_launch_profile_member(params = {}) ⇒ Types::UpdateLaunchProfileMemberResponse
Update a user persona in launch profile membership.
3439 3440 3441 3442 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 3439 def update_launch_profile_member(params = {}, = {}) req = build_request(:update_launch_profile_member, params) req.send_request() end |
#update_streaming_image(params = {}) ⇒ Types::UpdateStreamingImageResponse
Update streaming image.
3504 3505 3506 3507 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 3504 def update_streaming_image(params = {}, = {}) req = build_request(:update_streaming_image, params) req.send_request() end |
#update_studio(params = {}) ⇒ Types::UpdateStudioResponse
Update a Studio resource.
Currently, this operation only supports updating the displayName of your studio.
3576 3577 3578 3579 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 3576 def update_studio(params = {}, = {}) req = build_request(:update_studio, params) req.send_request() end |
#update_studio_component(params = {}) ⇒ Types::UpdateStudioComponentResponse
Updates a studio component resource.
3739 3740 3741 3742 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 3739 def update_studio_component(params = {}, = {}) req = build_request(:update_studio_component, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Basic Usage
A waiter will call an API operation until:
- It is successful
- It enters a terminal state
- It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success
or :failure
from these callbacks,
it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Valid Waiters
The following table lists the valid waiter names, the operations they call,
and the default :delay
and :max_attempts
values.
waiter_name | params | :delay | :max_attempts |
---|---|---|---|
launch_profile_deleted | #get_launch_profile | 5 | 150 |
launch_profile_ready | #get_launch_profile | 5 | 150 |
streaming_image_deleted | #get_streaming_image | 2 | 60 |
streaming_image_ready | #get_streaming_image | 2 | 60 |
streaming_session_deleted | #get_streaming_session | 5 | 180 |
streaming_session_ready | #get_streaming_session | 10 | 180 |
streaming_session_stopped | #get_streaming_session | 5 | 180 |
streaming_session_stream_ready | #get_streaming_session_stream | 5 | 30 |
studio_component_deleted | #get_studio_component | 1 | 120 |
studio_component_ready | #get_studio_component | 2 | 60 |
studio_deleted | #get_studio | 2 | 60 |
studio_ready | #get_studio | 2 | 60 |
3860 3861 3862 3863 3864 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 3860 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |