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.
440 441 442 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 440 def initialize(*args) super end |
Instance Method Details
#accept_eulas(params = {}) ⇒ Types::AcceptEulasResponse
Accept EULAs.
488 489 490 491 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 488 def accept_eulas(params = {}, = {}) req = build_request(:accept_eulas, params) req.send_request() end |
#create_launch_profile(params = {}) ⇒ Types::CreateLaunchProfileResponse
Create a launch profile.
626 627 628 629 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 626 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.
699 700 701 702 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 699 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.
795 796 797 798 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 795 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.
852 853 854 855 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 852 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.
965 966 967 968 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 965 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.
1131 1132 1133 1134 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1131 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.
1215 1216 1217 1218 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1215 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.
1257 1258 1259 1260 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1257 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.
1314 1315 1316 1317 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1314 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
.
1391 1392 1393 1394 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1391 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.
1446 1447 1448 1449 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1446 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.
1527 1528 1529 1530 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1527 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.
1564 1565 1566 1567 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1564 def delete_studio_member(params = {}, = {}) req = build_request(:delete_studio_member, params) req.send_request() end |
#get_eula(params = {}) ⇒ Types::GetEulaResponse
Get EULA.
1596 1597 1598 1599 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1596 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
1676 1677 1678 1679 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1676 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.
1783 1784 1785 1786 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1783 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.
1857 1858 1859 1860 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1857 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.
1898 1899 1900 1901 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1898 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
1951 1952 1953 1954 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 1951 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
2022 2023 2024 2025 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2022 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.
2067 2068 2069 2070 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2067 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
2122 2123 2124 2125 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2122 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
2173 2174 2175 2176 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2173 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
2250 2251 2252 2253 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2250 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.
2286 2287 2288 2289 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2286 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.
2332 2333 2334 2335 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2332 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.
2374 2375 2376 2377 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2374 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.
2424 2425 2426 2427 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2424 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.
2516 2517 2518 2519 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2516 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.
2576 2577 2578 2579 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2576 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.
2628 2629 2630 2631 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2628 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.
2707 2708 2709 2710 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2707 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.
2798 2799 2800 2801 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2798 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.
2847 2848 2849 2850 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2847 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.
2899 2900 2901 2902 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2899 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.
2935 2936 2937 2938 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2935 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.
2985 2986 2987 2988 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 2985 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.
3030 3031 3032 3033 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 3030 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.
3107 3108 3109 3110 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 3107 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.
3174 3175 3176 3177 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 3174 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.
3252 3253 3254 3255 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 3252 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.
3282 3283 3284 3285 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 3282 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Deletes the tags for a resource.
3309 3310 3311 3312 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 3309 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_launch_profile(params = {}) ⇒ Types::UpdateLaunchProfileResponse
Update a launch profile.
3439 3440 3441 3442 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 3439 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.
3494 3495 3496 3497 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 3494 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.
3559 3560 3561 3562 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 3559 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.
3631 3632 3633 3634 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 3631 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.
3794 3795 3796 3797 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 3794 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 |
3920 3921 3922 3923 3924 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb', line 3920 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |