AWS.Nimble (aws-elixir v0.8.0) View Source

Link to this section Summary

Functions

Creates a streaming image resource in a studio.

Creates a streaming session stream for a streaming session.

Launch profile details include the launch profile resource and summary information of resources that are used by, or available to, the launch profile.

Gets a StreamingSessionStream for a streaming session.

List the streaming image resources available to this studio.

List studios in your AWS account in the requested AWS 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.

Creates tags for a resource, given its ARN.

Link to this section Functions

Link to this function

accept_eulas(client, studio_id, input, options \\ [])

View Source

Accept EULAs.

Link to this function

create_launch_profile(client, studio_id, input, options \\ [])

View Source

Create a launch profile.

Link to this function

create_streaming_image(client, studio_id, input, options \\ [])

View Source

Creates a streaming image resource in a studio.

Link to this function

create_streaming_session(client, studio_id, input, options \\ [])

View Source

Creates a streaming session in a studio.

After invoking this operation, you must poll GetStreamingSession until the streaming session is in state READY.

Link to this function

create_streaming_session_stream(client, session_id, studio_id, input, options \\ [])

View Source

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 state READY.

Link to this function

create_studio(client, input, options \\ [])

View Source

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 AWS KMS key. By default, this key is owned by AWS and managed on your behalf. You may provide your own AWS KMS key when calling CreateStudio to encrypt this data using a key you own and manage.

When providing an AWS 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.

Link to this function

create_studio_component(client, studio_id, input, options \\ [])

View Source

Creates a studio component resource.

Link to this function

delete_launch_profile(client, launch_profile_id, studio_id, input, options \\ [])

View Source

Permanently delete a launch profile.

Link to this function

delete_launch_profile_member(client, launch_profile_id, principal_id, studio_id, input, options \\ [])

View Source

Delete a user from launch profile membership.

Link to this function

delete_streaming_image(client, streaming_image_id, studio_id, input, options \\ [])

View Source

Delete streaming image.

Link to this function

delete_streaming_session(client, session_id, studio_id, input, options \\ [])

View Source

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.

Link to this function

delete_studio(client, studio_id, input, options \\ [])

View Source

Delete a studio resource.

Link to this function

delete_studio_component(client, studio_component_id, studio_id, input, options \\ [])

View Source

Deletes a studio component resource.

Link to this function

delete_studio_member(client, principal_id, studio_id, input, options \\ [])

View Source

Delete a user from studio membership.

Link to this function

get_eula(client, eula_id, options \\ [])

View Source

Get Eula.

Link to this function

get_launch_profile(client, launch_profile_id, studio_id, options \\ [])

View Source

Get a launch profile.

Link to this function

get_launch_profile_details(client, launch_profile_id, studio_id, options \\ [])

View Source

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.

Link to this function

get_launch_profile_initialization(client, launch_profile_id, studio_id, launch_profile_protocol_versions, launch_purpose, platform, options \\ [])

View Source

Get a launch profile initialization.

Link to this function

get_launch_profile_member(client, launch_profile_id, principal_id, studio_id, options \\ [])

View Source

Get a user persona in launch profile membership.

Link to this function

get_streaming_image(client, streaming_image_id, studio_id, options \\ [])

View Source

Get streaming image.

Link to this function

get_streaming_session(client, session_id, studio_id, options \\ [])

View Source

Gets StreamingSession resource.

Invoke this operation to poll for a streaming session state while creating or deleting a session.

Link to this function

get_streaming_session_stream(client, session_id, stream_id, studio_id, options \\ [])

View Source

Gets a StreamingSessionStream for a streaming session.

Invoke this operation to poll the resource after invoking CreateStreamingSessionStream.

After the StreamingSessionStream changes to the state READY, the url property will contain a stream to be used with the DCV streaming client.

Link to this function

get_studio(client, studio_id, options \\ [])

View Source

Get a Studio resource.

Link to this function

get_studio_component(client, studio_component_id, studio_id, options \\ [])

View Source

Gets a studio component resource.

Link to this function

get_studio_member(client, principal_id, studio_id, options \\ [])

View Source

Get a user's membership in a studio.

Link to this function

list_eula_acceptances(client, studio_id, eula_ids \\ nil, next_token \\ nil, options \\ [])

View Source

List Eula Acceptances.

Link to this function

list_eulas(client, eula_ids \\ nil, next_token \\ nil, options \\ [])

View Source

List Eulas.

Link to this function

list_launch_profile_members(client, launch_profile_id, studio_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Get all users in a given launch profile membership.

Link to this function

list_launch_profiles(client, studio_id, max_results \\ nil, next_token \\ nil, principal_id \\ nil, states \\ nil, options \\ [])

View Source

List all the launch profiles a studio.

Link to this function

list_streaming_images(client, studio_id, next_token \\ nil, owner \\ nil, options \\ [])

View Source

List the streaming image resources available to this studio.

This list will contain both images provided by AWS, as well as streaming images that you have created in your studio.

Link to this function

list_streaming_sessions(client, studio_id, created_by \\ nil, next_token \\ nil, session_ids \\ nil, options \\ [])

View Source

Lists the streaming image resources in a studio.

Link to this function

list_studio_components(client, studio_id, max_results \\ nil, next_token \\ nil, states \\ nil, types \\ nil, options \\ [])

View Source

Lists the StudioComponents in a studio.

Link to this function

list_studio_members(client, studio_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Get all users in a given studio membership.

Link to this function

list_studios(client, next_token \\ nil, options \\ [])

View Source

List studios in your AWS account in the requested AWS Region.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

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.

Link to this function

put_launch_profile_members(client, launch_profile_id, studio_id, input, options \\ [])

View Source

Add/update users with given persona to launch profile membership.

Link to this function

put_studio_members(client, studio_id, input, options \\ [])

View Source

Add/update users with given persona to studio membership.

Link to this function

start_studio_s_s_o_configuration_repair(client, studio_id, input, options \\ [])

View Source

Repairs the SSO configuration for a given studio.

If the studio has a valid AWS SSO configuration currently associated with it, this operation will fail with a validation error.

If the studio does not have a valid AWS SSO configuration currently associated with it, then a new AWS SSO application is created for the studio and the studio is changed to the READY state.

After the AWS SSO application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Creates tags for a resource, given its ARN.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Deletes the tags for a resource.

Link to this function

update_launch_profile(client, launch_profile_id, studio_id, input, options \\ [])

View Source

Update a launch profile.

Link to this function

update_launch_profile_member(client, launch_profile_id, principal_id, studio_id, input, options \\ [])

View Source

Update a user persona in launch profile membership.

Link to this function

update_streaming_image(client, streaming_image_id, studio_id, input, options \\ [])

View Source

Update streaming image.

Link to this function

update_studio(client, studio_id, input, options \\ [])

View Source

Update a Studio resource.

Currently, this operation only supports updating the displayName of your studio.

Link to this function

update_studio_component(client, studio_component_id, studio_id, input, options \\ [])

View Source

Updates a studio component resource.