View Source aws_nimble (aws v1.0.4)
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.Summary
Functions
Creates a streaming session in a studio.
Creates a streaming session stream for a streaming session.
Create a new studio.
Deletes streaming session resource.
Launch profile details include the launch profile resource and summary information of resources that are used by, or available to, the launch profile.
Gets StreamingSession resource.
Gets StreamingSessionBackup resource.
Gets a StreamingSessionStream for a streaming session.
List the streaming image resources available to this studio.
StudioComponents in a studio.Get all users in a given studio membership.
Gets the tags for a resource, given its Amazon Resource Names (ARN).
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.
Update a Studio resource.
Functions
Creates a streaming session in a studio.
After invoking this operation, you must poll GetStreamingSession until the streaming session is in theREADY state.
create_streaming_session_stream(Client, SessionId, StudioId, Input)
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 theREADY state.
create_streaming_session_stream(Client, SessionId, StudioId, Input0, Options0)
View SourceCreate 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.delete_launch_profile(Client, LaunchProfileId, StudioId, Input0, Options0)
View Sourcedelete_launch_profile_member(Client, LaunchProfileId, PrincipalId, StudioId, Input)
View Sourcedelete_launch_profile_member(Client, LaunchProfileId, PrincipalId, StudioId, Input0, Options0)
View Sourcedelete_streaming_image(Client, StreamingImageId, StudioId, Input0, Options0)
View SourceDeletes streaming session resource.
After invoking this operation, use GetStreamingSession to poll the resource until it transitions to a DELETED state.
DELETED.
delete_streaming_session(Client, SessionId, StudioId, Input0, Options0)
View Sourcedelete_studio_component(Client, StudioComponentId, StudioId, Input)
View Sourcedelete_studio_component(Client, StudioComponentId, StudioId, Input0, Options0)
View Sourcedelete_studio_member(Client, PrincipalId, StudioId, Input0, Options0)
View Sourceget_launch_profile(Client, LaunchProfileId, StudioId, QueryMap, HeadersMap)
View Sourceget_launch_profile(Client, LaunchProfileId, StudioId, QueryMap, HeadersMap, Options0)
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_details(Client, LaunchProfileId, StudioId, QueryMap, HeadersMap)
View Sourceget_launch_profile_details(Client, LaunchProfileId, StudioId, QueryMap, HeadersMap, Options0)
View Sourceget_launch_profile_initialization(Client, LaunchProfileId, StudioId, LaunchProfileProtocolVersions, LaunchPurpose, Platform)
View Sourceget_launch_profile_initialization(Client, LaunchProfileId, StudioId, LaunchProfileProtocolVersions, LaunchPurpose, Platform, QueryMap, HeadersMap)
View Sourceget_launch_profile_initialization(Client, LaunchProfileId, StudioId, LaunchProfileProtocolVersions, LaunchPurpose, Platform, QueryMap, HeadersMap, Options0)
View Sourceget_launch_profile_member(Client, LaunchProfileId, PrincipalId, StudioId)
View Sourceget_launch_profile_member(Client, LaunchProfileId, PrincipalId, StudioId, QueryMap, HeadersMap)
View Sourceget_launch_profile_member(Client, LaunchProfileId, PrincipalId, StudioId, QueryMap, HeadersMap, Options0)
View Sourceget_streaming_image(Client, StreamingImageId, StudioId, QueryMap, HeadersMap)
View Sourceget_streaming_image(Client, StreamingImageId, StudioId, QueryMap, HeadersMap, Options0)
View SourceGets StreamingSession resource.
Invoke this operation to poll for a streaming session state while creating or deleting a session.get_streaming_session(Client, SessionId, StudioId, QueryMap, HeadersMap)
View Sourceget_streaming_session(Client, SessionId, StudioId, QueryMap, HeadersMap, Options0)
View SourceGets StreamingSessionBackup resource.
get_streaming_session_backup(Client, BackupId, StudioId, QueryMap, HeadersMap)
View Sourceget_streaming_session_backup(Client, BackupId, StudioId, QueryMap, HeadersMap, Options0)
View Sourceget_streaming_session_stream(Client, SessionId, StreamId, StudioId)
View SourceGets a StreamingSessionStream for a streaming session.
Invoke this operation to poll the resource after invoking CreateStreamingSessionStream.
StreamingSessionStream changes to the READY state, the url property will contain a stream to be used with the DCV streaming client.
get_streaming_session_stream(Client, SessionId, StreamId, StudioId, QueryMap, HeadersMap)
View Sourceget_streaming_session_stream(Client, SessionId, StreamId, StudioId, QueryMap, HeadersMap, Options0)
View Sourceget_studio_component(Client, StudioComponentId, StudioId, QueryMap, HeadersMap)
View Sourceget_studio_component(Client, StudioComponentId, StudioId, QueryMap, HeadersMap, Options0)
View Sourceget_studio_member(Client, PrincipalId, StudioId, QueryMap, HeadersMap)
View Sourceget_studio_member(Client, PrincipalId, StudioId, QueryMap, HeadersMap, Options0)
View Sourcelist_eula_acceptances(Client, StudioId, QueryMap, HeadersMap, Options0)
View Sourcelist_launch_profile_members(Client, LaunchProfileId, StudioId, QueryMap, HeadersMap)
View Sourcelist_launch_profile_members(Client, LaunchProfileId, StudioId, QueryMap, HeadersMap, Options0)
View Sourcelist_launch_profiles(Client, StudioId, QueryMap, HeadersMap, Options0)
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_images(Client, StudioId, QueryMap, HeadersMap, Options0)
View Sourcelist_streaming_session_backups(Client, StudioId, QueryMap, HeadersMap)
View Sourcelist_streaming_session_backups(Client, StudioId, QueryMap, HeadersMap, Options0)
View Sourcelist_streaming_sessions(Client, StudioId, QueryMap, HeadersMap, Options0)
View SourceStudioComponents in a studio.
list_studio_components(Client, StudioId, QueryMap, HeadersMap, Options0)
View SourceGet all users in a given studio membership.
ListStudioMembers only returns admin members.
list_studio_members(Client, StudioId, QueryMap, HeadersMap, Options0)
View SourceGets 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.list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
View Sourceput_launch_profile_members(Client, LaunchProfileId, StudioId, Input)
View Sourceput_launch_profile_members(Client, LaunchProfileId, StudioId, Input0, Options0)
View SourceTransitions sessions from the STOPPED state into the READY state.
START_IN_PROGRESS state is the intermediate state between the STOPPED and READY states.
start_streaming_session(Client, SessionId, StudioId, Input0, Options0)
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.
start_studio_s_s_o_configuration_repair(Client, StudioId, Input0, Options0)
View SourceTransitions sessions from the READY state into the STOPPED state.
STOP_IN_PROGRESS state is the intermediate state between the READY and STOPPED states.
stop_streaming_session(Client, SessionId, StudioId, Input0, Options0)
View Sourceupdate_launch_profile(Client, LaunchProfileId, StudioId, Input0, Options0)
View Sourceupdate_launch_profile_member(Client, LaunchProfileId, PrincipalId, StudioId, Input)
View Sourceupdate_launch_profile_member(Client, LaunchProfileId, PrincipalId, StudioId, Input0, Options0)
View Sourceupdate_streaming_image(Client, StreamingImageId, StudioId, Input0, Options0)
View SourceUpdate a Studio resource.
Currently, this operation only supports updating the displayName of your studio.