View Source AWS.Nimble (aws-elixir v0.13.3)
Welcome to the Amazon Nimble Studio API reference.
This API reference provides methods, schema, resources, parameters, and more to help you get the most out of Nimble Studio.
Nimble Studio is a virtual studio that empowers visual effects, animation, and interactive content teams to create content securely within a scalable, private cloud service.
Link to this section Summary
Functions
Accept EULAs.
Create a launch profile.
Creates a streaming image resource in a studio.
Creates a streaming session in a studio.
Creates a streaming session stream for a streaming session.
Create a new studio.
Creates a studio component resource.
Permanently delete a launch profile.
Delete a user from launch profile membership.
Delete streaming image.
Deletes streaming session resource.
Delete a studio resource.
Deletes a studio component resource.
Delete a user from studio membership.
Get EULA.
Get a launch profile.
Launch profile details include the launch profile resource and summary information of resources that are used by, or available to, the launch profile.
Get a launch profile initialization.
Get a user persona in launch profile membership.
Get streaming image.
Gets StreamingSession resource.
Gets StreamingSessionBackup
resource.
Gets a StreamingSessionStream for a streaming session.
Get a studio resource.
Gets a studio component resource.
Get a user's membership in a studio.
List EULA acceptances.
Get all users in a given launch profile membership.
List all the launch profiles a studio.
List the streaming image resources available to this studio.
Lists the backups of a streaming session in a studio.
Lists the streaming sessions in a studio.
Lists the StudioComponents
in a studio.
Get all users in a given studio membership.
List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.
Gets the tags for a resource, given its Amazon Resource Names (ARN).
Add/update users with given persona to launch profile membership.
Add/update users with given persona to studio membership.
Transitions sessions from the STOPPED
state into the READY
state.
Repairs the IAM Identity Center configuration for a given studio.
Transitions sessions from the READY
state into the STOPPED
state.
Creates tags for a resource, given its ARN.
Deletes the tags for a resource.
Update a launch profile.
Update a user persona in launch profile membership.
Update streaming image.
Update a Studio resource.
Updates a studio component resource.
Link to this section Functions
Accept EULAs.
Create a launch profile.
Creates a streaming image resource in a studio.
Creates a streaming session in a studio.
After invoking this operation, you must poll GetStreamingSession until the
streaming session is in the READY
state.
create_streaming_session_stream(client, session_id, studio_id, input, options \\ [])
View SourceCreates 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.
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.
Creates a studio component resource.
delete_launch_profile(client, launch_profile_id, studio_id, input, options \\ [])
View SourcePermanently delete a launch profile.
delete_launch_profile_member(client, launch_profile_id, principal_id, studio_id, input, options \\ [])
View SourceDelete a user from launch profile membership.
delete_streaming_image(client, streaming_image_id, studio_id, input, options \\ [])
View SourceDelete streaming image.
delete_streaming_session(client, session_id, studio_id, input, options \\ [])
View SourceDeletes 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
.
Delete a studio resource.
delete_studio_component(client, studio_component_id, studio_id, input, options \\ [])
View SourceDeletes a studio component resource.
delete_studio_member(client, principal_id, studio_id, input, options \\ [])
View SourceDelete a user from studio membership.
Get EULA.
get_launch_profile(client, launch_profile_id, studio_id, options \\ [])
View SourceGet a launch profile.
get_launch_profile_details(client, launch_profile_id, studio_id, options \\ [])
View SourceLaunch 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.
get_launch_profile_initialization(client, launch_profile_id, studio_id, launch_profile_protocol_versions, launch_purpose, platform, options \\ [])
View SourceGet a launch profile initialization.
get_launch_profile_member(client, launch_profile_id, principal_id, studio_id, options \\ [])
View SourceGet a user persona in launch profile membership.
get_streaming_image(client, streaming_image_id, studio_id, options \\ [])
View SourceGet streaming image.
get_streaming_session(client, session_id, studio_id, options \\ [])
View SourceGets StreamingSession resource.
Invoke this operation to poll for a streaming session state while creating or deleting a session.
get_streaming_session_backup(client, backup_id, studio_id, options \\ [])
View SourceGets StreamingSessionBackup
resource.
Invoke this operation to poll for a streaming session backup while stopping a streaming session.
get_streaming_session_stream(client, session_id, stream_id, studio_id, options \\ [])
View SourceGets 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.
Get a studio resource.
get_studio_component(client, studio_component_id, studio_id, options \\ [])
View SourceGets a studio component resource.
Get a user's membership in a studio.
list_eula_acceptances(client, studio_id, eula_ids \\ nil, next_token \\ nil, options \\ [])
View SourceList EULA acceptances.
list_eulas(client, eula_ids \\ nil, next_token \\ nil, options \\ [])
View SourceList EULAs.
list_launch_profile_members(client, launch_profile_id, studio_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceGet all users in a given launch profile membership.
list_launch_profiles(client, studio_id, max_results \\ nil, next_token \\ nil, principal_id \\ nil, states \\ nil, options \\ [])
View SourceList all the launch profiles a studio.
list_streaming_images(client, studio_id, next_token \\ nil, owner \\ nil, options \\ [])
View SourceList 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.
list_streaming_session_backups(client, studio_id, next_token \\ nil, owned_by \\ nil, options \\ [])
View SourceLists the backups of a streaming session in a studio.
list_streaming_sessions(client, studio_id, created_by \\ nil, next_token \\ nil, owned_by \\ nil, session_ids \\ nil, options \\ [])
View SourceLists the streaming sessions in a studio.
list_studio_components(client, studio_id, max_results \\ nil, next_token \\ nil, states \\ nil, types \\ nil, options \\ [])
View SourceLists the StudioComponents
in a studio.
list_studio_members(client, studio_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceGet all users in a given studio membership.
ListStudioMembers
only returns admin members.
List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.
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.
put_launch_profile_members(client, launch_profile_id, studio_id, input, options \\ [])
View SourceAdd/update users with given persona to launch profile membership.
Add/update users with given persona to studio membership.
start_streaming_session(client, session_id, studio_id, input, options \\ [])
View SourceTransitions sessions from the STOPPED
state into the READY
state.
The START_IN_PROGRESS
state is the intermediate state between the STOPPED
and READY
states.
start_studio_s_s_o_configuration_repair(client, studio_id, input, options \\ [])
View SourceRepairs 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.
stop_streaming_session(client, session_id, studio_id, input, options \\ [])
View SourceTransitions sessions from the READY
state into the STOPPED
state.
The STOP_IN_PROGRESS
state is the intermediate state between the READY
and
STOPPED
states.
Creates tags for a resource, given its ARN.
Deletes the tags for a resource.
update_launch_profile(client, launch_profile_id, studio_id, input, options \\ [])
View SourceUpdate a launch profile.
update_launch_profile_member(client, launch_profile_id, principal_id, studio_id, input, options \\ [])
View SourceUpdate a user persona in launch profile membership.
update_streaming_image(client, streaming_image_id, studio_id, input, options \\ [])
View SourceUpdate streaming image.
Update a Studio resource.
Currently, this operation only supports updating the displayName of your studio.
update_studio_component(client, studio_component_id, studio_id, input, options \\ [])
View SourceUpdates a studio component resource.