AWS.Nimble — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.Nimble

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Sending a Request Using Nimble

var nimble = new AWS.Nimble();
nimble.acceptEulas(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Nimble object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var nimble = new AWS.Nimble({apiVersion: '2020-08-01'});

You can also set the API version globally in AWS.config.apiVersions using the nimble service identifier:

AWS.config.apiVersions = {
  nimble: '2020-08-01',
  // other service API versions
};

var nimble = new AWS.Nimble();

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

launchProfileDeleted, launchProfileReady, streamingImageDeleted, streamingImageReady, streamingSessionDeleted, streamingSessionReady, streamingSessionStopped, streamingSessionStreamReady, studioComponentDeleted, studioComponentReady, studioDeleted, studioReady

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.Nimble(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createLaunchProfile(params = {}, callback) ⇒ AWS.Request

createStreamingImage(params = {}, callback) ⇒ AWS.Request

Creates a streaming image resource in a studio.

createStreamingSession(params = {}, callback) ⇒ AWS.Request

Creates a streaming session in a studio.

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

createStreamingSessionStream(params = {}, callback) ⇒ AWS.Request

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.

createStudio(params = {}, callback) ⇒ AWS.Request

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.

createStudioComponent(params = {}, callback) ⇒ AWS.Request

Creates a studio component resource.

deleteLaunchProfile(params = {}, callback) ⇒ AWS.Request

Permanently delete a launch profile.

deleteLaunchProfileMember(params = {}, callback) ⇒ AWS.Request

Delete a user from launch profile membership.

deleteStreamingImage(params = {}, callback) ⇒ AWS.Request

deleteStreamingSession(params = {}, callback) ⇒ AWS.Request

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.

deleteStudio(params = {}, callback) ⇒ AWS.Request

Delete a studio resource.

deleteStudioComponent(params = {}, callback) ⇒ AWS.Request

Deletes a studio component resource.

deleteStudioMember(params = {}, callback) ⇒ AWS.Request

Delete a user from studio membership.

getLaunchProfile(params = {}, callback) ⇒ AWS.Request

getLaunchProfileDetails(params = {}, callback) ⇒ AWS.Request

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.

getLaunchProfileInitialization(params = {}, callback) ⇒ AWS.Request

Get a launch profile initialization.

getLaunchProfileMember(params = {}, callback) ⇒ AWS.Request

Get a user persona in launch profile membership.

getStreamingImage(params = {}, callback) ⇒ AWS.Request

getStreamingSession(params = {}, callback) ⇒ AWS.Request

Gets StreamingSession resource.

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

getStreamingSessionBackup(params = {}, callback) ⇒ AWS.Request

Gets StreamingSessionBackup resource.

Invoke this operation to poll for a streaming session backup while stopping a streaming session.

getStreamingSessionStream(params = {}, callback) ⇒ AWS.Request

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.

getStudioComponent(params = {}, callback) ⇒ AWS.Request

Gets a studio component resource.

getStudioMember(params = {}, callback) ⇒ AWS.Request

Get a user's membership in a studio.

listEulaAcceptances(params = {}, callback) ⇒ AWS.Request

listLaunchProfileMembers(params = {}, callback) ⇒ AWS.Request

Get all users in a given launch profile membership.

listLaunchProfiles(params = {}, callback) ⇒ AWS.Request

List all the launch profiles a studio.

listStreamingImages(params = {}, callback) ⇒ AWS.Request

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.

listStreamingSessionBackups(params = {}, callback) ⇒ AWS.Request

Lists the backups of a streaming session in a studio.

listStreamingSessions(params = {}, callback) ⇒ AWS.Request

Lists the streaming sessions in a studio.

listStudioComponents(params = {}, callback) ⇒ AWS.Request

Lists the StudioComponents in a studio.

listStudioMembers(params = {}, callback) ⇒ AWS.Request

Get all users in a given studio membership.

Note: ListStudioMembers only returns admin members.

listStudios(params = {}, callback) ⇒ AWS.Request

List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

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.

putLaunchProfileMembers(params = {}, callback) ⇒ AWS.Request

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

putStudioMembers(params = {}, callback) ⇒ AWS.Request

Add/update users with given persona to studio membership.

startStreamingSession(params = {}, callback) ⇒ AWS.Request

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.

startStudioSSOConfigurationRepair(params = {}, callback) ⇒ AWS.Request

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.

stopStreamingSession(params = {}, callback) ⇒ AWS.Request

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.

tagResource(params = {}, callback) ⇒ AWS.Request

Creates tags for a resource, given its ARN.

untagResource(params = {}, callback) ⇒ AWS.Request

Deletes the tags for a resource.

updateLaunchProfile(params = {}, callback) ⇒ AWS.Request

updateLaunchProfileMember(params = {}, callback) ⇒ AWS.Request

Update a user persona in launch profile membership.

updateStreamingImage(params = {}, callback) ⇒ AWS.Request

updateStudio(params = {}, callback) ⇒ AWS.Request

Update a Studio resource.

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

updateStudioComponent(params = {}, callback) ⇒ AWS.Request

Updates a studio component resource.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given Nimble resource. The final callback or'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Waiter Resource Details

nimble.waitFor('launchProfileDeleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the launchProfileDeleted state by periodically calling the underlyingNimble.getLaunchProfile() operation every 5 seconds (at most 150 times).

nimble.waitFor('launchProfileReady', params = {}, [callback]) ⇒ AWS.Request

Waits for the launchProfileReady state by periodically calling the underlyingNimble.getLaunchProfile() operation every 5 seconds (at most 150 times).

nimble.waitFor('streamingImageDeleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the streamingImageDeleted state by periodically calling the underlyingNimble.getStreamingImage() operation every 2 seconds (at most 60 times).

nimble.waitFor('streamingImageReady', params = {}, [callback]) ⇒ AWS.Request

Waits for the streamingImageReady state by periodically calling the underlyingNimble.getStreamingImage() operation every 2 seconds (at most 60 times).

nimble.waitFor('streamingSessionDeleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the streamingSessionDeleted state by periodically calling the underlyingNimble.getStreamingSession() operation every 5 seconds (at most 180 times).

nimble.waitFor('streamingSessionReady', params = {}, [callback]) ⇒ AWS.Request

Waits for the streamingSessionReady state by periodically calling the underlyingNimble.getStreamingSession() operation every 10 seconds (at most 180 times).

nimble.waitFor('streamingSessionStopped', params = {}, [callback]) ⇒ AWS.Request

Waits for the streamingSessionStopped state by periodically calling the underlyingNimble.getStreamingSession() operation every 5 seconds (at most 180 times).

nimble.waitFor('streamingSessionStreamReady', params = {}, [callback]) ⇒ AWS.Request

Waits for the streamingSessionStreamReady state by periodically calling the underlyingNimble.getStreamingSessionStream() operation every 5 seconds (at most 30 times).

nimble.waitFor('studioComponentDeleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the studioComponentDeleted state by periodically calling the underlyingNimble.getStudioComponent() operation every 1 seconds (at most 120 times).

nimble.waitFor('studioComponentReady', params = {}, [callback]) ⇒ AWS.Request

Waits for the studioComponentReady state by periodically calling the underlyingNimble.getStudioComponent() operation every 2 seconds (at most 60 times).

nimble.waitFor('studioDeleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the studioDeleted state by periodically calling the underlyingNimble.getStudio() operation every 2 seconds (at most 60 times).

nimble.waitFor('studioReady', params = {}, [callback]) ⇒ AWS.Request

Waits for the studioReady state by periodically calling the underlyingNimble.getStudio() operation every 2 seconds (at most 60 times).