Note: You are viewing the documentation for an older major version of the AWS SDK for JavaScript (v2).

The modular AWS SDK for JavaScript (v3) is now General Available. For more information see the Developer Guide or API Reference.

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: AWS.Nimble

Inherits:
AWS.Service show all
Identifier:
nimble
API Version:
2020-08-01
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on 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();

Version:

  • 2020-08-01

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a Nimble object

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

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.Nimble.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.Nimble.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.Nimble.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Accept EULAs.

Service Reference:

Examples:

Calling the acceptEulas operation

var params = {
  studioId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  eulaIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
nimble.acceptEulas(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

      If a token is not provided, the SDK will use a version 4 UUID.
    • eulaIds — (Array<String>)

      The EULA ID.

    • studioId — (String)

      The studio ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • eulaAcceptances — (Array<map>)

        A collection of EULA acceptances.

        • acceptedAt — (Date)

          The Unix epoch timestamp in seconds for when the EULA was accepted.

        • acceptedBy — (String)

          The ID of the person who accepted the EULA.

        • accepteeId — (String)

          The ID of the acceptee.

        • eulaAcceptanceId — (String)

          The EULA acceptance ID.

        • eulaId — (String)

          The EULA ID.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Create a launch profile.

Service Reference:

Examples:

Calling the createLaunchProfile operation

var params = {
  ec2SubnetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  launchProfileProtocolVersions: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  name: 'STRING_VALUE', /* required */
  streamConfiguration: { /* required */
    clipboardMode: ENABLED | DISABLED, /* required */
    ec2InstanceTypes: [ /* required */
      g4dn.xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.12xlarge | g4dn.16xlarge,
      /* more items */
    ],
    streamingImageIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    maxSessionLengthInMinutes: 'NUMBER_VALUE'
  },
  studioComponentIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  studioId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
nimble.createLaunchProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

      If a token is not provided, the SDK will use a version 4 UUID.
    • description — (String)

      The description.

    • ec2SubnetIds — (Array<String>)
    • launchProfileProtocolVersions — (Array<String>)

      The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".

    • name — (String)

      The name for the launch profile.

    • streamConfiguration — (map)

      A configuration for a streaming session.

      • clipboardModerequired — (String)

        Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • ec2InstanceTypesrequired — (Array<String>)

        The EC2 instance types that users can select from when launching a streaming session with this launch profile.

      • maxSessionLengthInMinutes — (Integer)

        The length of time, in minutes, that a streaming session can run. After this point, Nimble Studio automatically terminates the session.

      • streamingImageIdsrequired — (Array<String>)

        The streaming images that users can select from when launching a streaming session with this launch profile.

    • studioComponentIds — (Array<String>)

      Unique identifiers for a collection of studio components that can be used with this launch profile.

    • studioId — (String)

      The studio ID.

    • tags — (map<String>)

      A collection of labels, in the form of key:value pairs, that apply to this resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • launchProfile — (map)

        The launch profile.

        • arn — (String)

          The ARN of the resource.

        • createdAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was created.

        • createdBy — (String)

          The user ID of the user that created the launch profile.

        • description — (String)

          A human-readable description of the launch profile.

        • ec2SubnetIds — (Array<String>)

          Unique identifiers for a collection of EC2 subnets.

        • launchProfileId — (String)

          The launch profile ID.

        • launchProfileProtocolVersions — (Array<String>)

          The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".

        • name — (String)

          A friendly name for the launch profile.

        • state — (String)

          The current state.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "READY"
          • "UPDATE_IN_PROGRESS"
          • "DELETE_IN_PROGRESS"
          • "DELETED"
          • "DELETE_FAILED"
          • "CREATE_FAILED"
          • "UPDATE_FAILED"
        • statusCode — (String)

          The status code.

          Possible values include:
          • "LAUNCH_PROFILE_CREATED"
          • "LAUNCH_PROFILE_UPDATED"
          • "LAUNCH_PROFILE_DELETED"
          • "LAUNCH_PROFILE_CREATE_IN_PROGRESS"
          • "LAUNCH_PROFILE_UPDATE_IN_PROGRESS"
          • "LAUNCH_PROFILE_DELETE_IN_PROGRESS"
          • "INTERNAL_ERROR"
          • "STREAMING_IMAGE_NOT_FOUND"
          • "STREAMING_IMAGE_NOT_READY"
          • "LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED"
          • "ENCRYPTION_KEY_ACCESS_DENIED"
          • "ENCRYPTION_KEY_NOT_FOUND"
          • "INVALID_SUBNETS_PROVIDED"
        • statusMessage — (String)

          The status message for the launch profile.

        • streamConfiguration — (map)

          A configuration for a streaming session.

          • clipboardMode — (String)

            Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
          • ec2InstanceTypes — (Array<String>)

            The EC2 instance types that users can select from when launching a streaming session with this launch profile.

          • maxSessionLengthInMinutes — (Integer)

            The length of time, in minutes, that a streaming session can run. After this point, Nimble Studio automatically terminates the session.

          • streamingImageIds — (Array<String>)

            The streaming images that users can select from when launching a streaming session with this launch profile.

        • studioComponentIds — (Array<String>)

          Unique identifiers for a collection of studio components that can be used with this launch profile.

        • tags — (map<String>)

          A collection of labels, in the form of key:value pairs, that apply to this resource.

        • updatedAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was updated.

        • updatedBy — (String)

          The user ID of the user that most recently updated the resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Creates a streaming image resource in a studio.

Service Reference:

Examples:

Calling the createStreamingImage operation

var params = {
  ec2ImageId: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  studioId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
nimble.createStreamingImage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

      If a token is not provided, the SDK will use a version 4 UUID.
    • description — (String)

      A human-readable description of the streaming image.

    • ec2ImageId — (String)

      The ID of an EC2 machine image with which to create this streaming image.

    • name — (String)

      A friendly name for a streaming image resource.

    • studioId — (String)

      The studio ID.

    • tags — (map<String>)

      A collection of labels, in the form of key:value pairs, that apply to this resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • streamingImage — (map)
        • arn — (String)

          The ARN of the resource.

        • description — (String)

          A human-readable description of the streaming image.

        • ec2ImageId — (String)

          The ID of an EC2 machine image with which to create the streaming image.

        • encryptionConfiguration — (map)

          The encryption configuration.

          • keyArn — (String)

            The ARN for a KMS key that is used to encrypt studio data.

          • keyTyperequired — (String)

            The type of KMS key that is used to encrypt studio data.

            Possible values include:
            • "CUSTOMER_MANAGED_KEY"
        • eulaIds — (Array<String>)

          The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.

        • name — (String)

          A friendly name for a streaming image resource.

        • owner — (String)

          The owner of the streaming image, either the studioId that contains the streaming image, or 'amazon' for images that are provided by Amazon Nimble Studio.

        • platform — (String)

          The platform of the streaming image, either WINDOWS or LINUX.

        • state — (String)

          The current state.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "READY"
          • "DELETE_IN_PROGRESS"
          • "DELETED"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_FAILED"
          • "CREATE_FAILED"
          • "DELETE_FAILED"
        • statusCode — (String)

          The status code.

          Possible values include:
          • "STREAMING_IMAGE_CREATE_IN_PROGRESS"
          • "STREAMING_IMAGE_READY"
          • "STREAMING_IMAGE_DELETE_IN_PROGRESS"
          • "STREAMING_IMAGE_DELETED"
          • "STREAMING_IMAGE_UPDATE_IN_PROGRESS"
          • "INTERNAL_ERROR"
        • statusMessage — (String)

          The status message for the streaming image.

        • streamingImageId — (String)

          The ID of the streaming image.

        • tags — (map<String>)

          A collection of labels, in the form of key:value pairs, that apply to this resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Service Reference:

Examples:

Calling the createStreamingSession operation

var params = {
  studioId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  ec2InstanceType: g4dn.xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.12xlarge | g4dn.16xlarge,
  launchProfileId: 'STRING_VALUE',
  streamingImageId: 'STRING_VALUE',
  tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
nimble.createStreamingSession(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

      If a token is not provided, the SDK will use a version 4 UUID.
    • ec2InstanceType — (String)

      The EC2 Instance type used for the streaming session.

      Possible values include:
      • "g4dn.xlarge"
      • "g4dn.2xlarge"
      • "g4dn.4xlarge"
      • "g4dn.8xlarge"
      • "g4dn.12xlarge"
      • "g4dn.16xlarge"
    • launchProfileId — (String)

      The launch profile ID.

    • streamingImageId — (String)

      The ID of the streaming image.

    • studioId — (String)

      The studio ID.

    • tags — (map<String>)

      A collection of labels, in the form of key:value pairs, that apply to this resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • session — (map)

        The session.

        • arn — (String)

          The ARN of the resource.

        • createdAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was created.

        • createdBy — (String)

          The user ID of the user that created the streaming session.

        • ec2InstanceType — (String)

          The EC2 Instance type used for the streaming session.

        • launchProfileId — (String)

          The ID of the launch profile used to control access from the streaming session.

        • sessionId — (String)

          The session ID.

        • state — (String)

          The current state.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "DELETE_IN_PROGRESS"
          • "READY"
          • "DELETED"
          • "CREATE_FAILED"
          • "DELETE_FAILED"
        • statusCode — (String)

          The status code.

          Possible values include:
          • "STREAMING_SESSION_READY"
          • "STREAMING_SESSION_DELETED"
          • "STREAMING_SESSION_CREATE_IN_PROGRESS"
          • "STREAMING_SESSION_DELETE_IN_PROGRESS"
          • "INTERNAL_ERROR"
          • "INSUFFICIENT_CAPACITY"
          • "ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR"
          • "NETWORK_CONNECTION_ERROR"
          • "INITIALIZATION_SCRIPT_ERROR"
          • "DECRYPT_STREAMING_IMAGE_ERROR"
          • "NETWORK_INTERFACE_ERROR"
        • statusMessage — (String)

          The status message for the streaming session.

        • streamingImageId — (String)

          The ID of the streaming image.

        • tags — (map<String>)

          A collection of labels, in the form of key:value pairs, that apply to this resource.

        • terminateAt — (Date)

          The time the streaming session will automatically terminate if not terminated by the user.

        • updatedAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was updated.

        • updatedBy — (String)

          The user ID of the user that most recently updated the resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Service Reference:

Examples:

Calling the createStreamingSessionStream operation

var params = {
  sessionId: 'STRING_VALUE', /* required */
  studioId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  expirationInSeconds: 'NUMBER_VALUE'
};
nimble.createStreamingSessionStream(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

      If a token is not provided, the SDK will use a version 4 UUID.
    • expirationInSeconds — (Integer)

      The expiration time in seconds.

    • sessionId — (String)

      The session ID.

    • studioId — (String)

      The studio ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • stream — (map)

        The stream.

        • createdAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was created.

        • createdBy — (String)

          The user ID of the user that created the streaming session stream.

        • expiresAt — (Date)

          The Unix epoch timestamp in seconds for when the resource expires.

        • state — (String)

          The current state.

          Possible values include:
          • "READY"
          • "CREATE_IN_PROGRESS"
          • "DELETE_IN_PROGRESS"
          • "DELETED"
          • "CREATE_FAILED"
          • "DELETE_FAILED"
        • statusCode — (String)

          The streaming session stream status code.

          Possible values include:
          • "STREAM_CREATE_IN_PROGRESS"
          • "STREAM_READY"
          • "STREAM_DELETE_IN_PROGRESS"
          • "STREAM_DELETED"
          • "INTERNAL_ERROR"
          • "NETWORK_CONNECTION_ERROR"
        • streamId — (String)

          The stream ID.

        • url — (String)

          The URL to connect to this stream using the DCV client.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Service Reference:

Examples:

Calling the createStudio operation

var params = {
  adminRoleArn: 'STRING_VALUE', /* required */
  displayName: 'STRING_VALUE', /* required */
  studioName: 'STRING_VALUE', /* required */
  userRoleArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  studioEncryptionConfiguration: {
    keyType: AWS_OWNED_KEY | CUSTOMER_MANAGED_KEY, /* required */
    keyArn: 'STRING_VALUE'
  },
  tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
nimble.createStudio(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • adminRoleArn — (String)

      The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.

    • clientToken — (String)

      To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

      If a token is not provided, the SDK will use a version 4 UUID.
    • displayName — (String)

      A friendly name for the studio.

    • studioEncryptionConfiguration — (map)

      The studio encryption configuration.

      • keyArn — (String)

        The ARN for a KMS key that is used to encrypt studio data.

      • keyTyperequired — (String)

        The type of KMS key that is used to encrypt studio data.

        Possible values include:
        • "AWS_OWNED_KEY"
        • "CUSTOMER_MANAGED_KEY"
    • studioName — (String)

      The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.

    • tags — (map<String>)

      A collection of labels, in the form of key:value pairs, that apply to this resource.

    • userRoleArn — (String)

      The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • studio — (map)

        Information about a studio.

        • adminRoleArn — (String)

          The IAM role that studio admins assume when logging in to the Nimble Studio portal.

        • arn — (String)

          The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

        • createdAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was created.

        • displayName — (String)

          A friendly name for the studio.

        • homeRegion — (String)

          The AWS region where the studio resource is located.

        • ssoClientId — (String)

          The AWS SSO application client ID used to integrate with AWS SSO to enable AWS SSO users to log in to Nimble portal.

        • state — (String)

          The current state of the studio resource.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "READY"
          • "UPDATE_IN_PROGRESS"
          • "DELETE_IN_PROGRESS"
          • "DELETED"
          • "DELETE_FAILED"
          • "CREATE_FAILED"
          • "UPDATE_FAILED"
        • statusCode — (String)

          Status codes that provide additional detail on the studio state.

          Possible values include:
          • "STUDIO_CREATED"
          • "STUDIO_DELETED"
          • "STUDIO_UPDATED"
          • "STUDIO_CREATE_IN_PROGRESS"
          • "STUDIO_UPDATE_IN_PROGRESS"
          • "STUDIO_DELETE_IN_PROGRESS"
          • "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED"
          • "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED"
          • "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED"
          • "AWS_SSO_NOT_ENABLED"
          • "AWS_SSO_ACCESS_DENIED"
          • "ROLE_NOT_OWNED_BY_STUDIO_OWNER"
          • "ROLE_COULD_NOT_BE_ASSUMED"
          • "INTERNAL_ERROR"
          • "ENCRYPTION_KEY_NOT_FOUND"
          • "ENCRYPTION_KEY_ACCESS_DENIED"
          • "AWS_SSO_CONFIGURATION_REPAIRED"
          • "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS"
        • statusMessage — (String)

          Additional detail on the studio state.

        • studioEncryptionConfiguration — (map)

          Configuration of the encryption method that is used for the studio.

          • keyArn — (String)

            The ARN for a KMS key that is used to encrypt studio data.

          • keyTyperequired — (String)

            The type of KMS key that is used to encrypt studio data.

            Possible values include:
            • "AWS_OWNED_KEY"
            • "CUSTOMER_MANAGED_KEY"
        • studioId — (String)

          The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.

        • studioName — (String)

          The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.

        • studioUrl — (String)

          The address of the web page for the studio.

        • tags — (map<String>)

          A collection of labels, in the form of key:value pairs, that apply to this resource.

        • updatedAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was updated.

        • userRoleArn — (String)

          The IAM role that studio users assume when logging in to the Nimble Studio portal.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Creates a studio component resource.

Service Reference:

Examples:

Calling the createStudioComponent operation

var params = {
  name: 'STRING_VALUE', /* required */
  studioId: 'STRING_VALUE', /* required */
  type: ACTIVE_DIRECTORY | SHARED_FILE_SYSTEM | COMPUTE_FARM | LICENSE_SERVICE | CUSTOM, /* required */
  clientToken: 'STRING_VALUE',
  configuration: {
    activeDirectoryConfiguration: {
      computerAttributes: [
        {
          name: 'STRING_VALUE',
          value: 'STRING_VALUE'
        },
        /* more items */
      ],
      directoryId: 'STRING_VALUE',
      organizationalUnitDistinguishedName: 'STRING_VALUE'
    },
    computeFarmConfiguration: {
      activeDirectoryUser: 'STRING_VALUE',
      endpoint: 'STRING_VALUE'
    },
    licenseServiceConfiguration: {
      endpoint: 'STRING_VALUE'
    },
    sharedFileSystemConfiguration: {
      endpoint: 'STRING_VALUE',
      fileSystemId: 'STRING_VALUE',
      linuxMountPoint: 'STRING_VALUE',
      shareName: 'STRING_VALUE',
      windowsMountDrive: 'STRING_VALUE'
    }
  },
  description: 'STRING_VALUE',
  ec2SecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  initializationScripts: [
    {
      launchProfileProtocolVersion: 'STRING_VALUE',
      platform: LINUX | WINDOWS,
      runContext: SYSTEM_INITIALIZATION | USER_INITIALIZATION,
      script: 'STRING_VALUE'
    },
    /* more items */
  ],
  scriptParameters: [
    {
      key: 'STRING_VALUE',
      value: 'STRING_VALUE'
    },
    /* more items */
  ],
  subtype: AWS_MANAGED_MICROSOFT_AD | AMAZON_FSX_FOR_WINDOWS | AMAZON_FSX_FOR_LUSTRE | CUSTOM,
  tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
nimble.createStudioComponent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

      If a token is not provided, the SDK will use a version 4 UUID.
    • configuration — (map)

      The configuration of the studio component, based on component type.

      • activeDirectoryConfiguration — (map)

        The configuration for a Microsoft Active Directory (Microsoft AD) studio resource.

        • computerAttributes — (Array<map>)

          A collection of custom attributes for an Active Directory computer.

          • name — (String)

            The name for the LDAP attribute.

          • value — (String)

            The value for the LDAP attribute.

        • directoryId — (String)

          The directory ID of the AWS Directory Service for Microsoft AD to access using this studio component.

        • organizationalUnitDistinguishedName — (String)

          The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.

      • computeFarmConfiguration — (map)

        The configuration for a render farm that is associated with a studio resource.

        • activeDirectoryUser — (String)

          The name of an Active Directory user that is used on ComputeFarm worker instances.

        • endpoint — (String)

          The endpoint of the ComputeFarm that is accessed by the studio component resource.

      • licenseServiceConfiguration — (map)

        The configuration for a license service that is associated with a studio resource.

        • endpoint — (String)

          The endpoint of the license service that is accessed by the studio component resource.

      • sharedFileSystemConfiguration — (map)

        The configuration for a shared file storage system that is associated with a studio resource.

        • endpoint — (String)

          The endpoint of the shared file system that is accessed by the studio component resource.

        • fileSystemId — (String)

          The unique identifier for a file system.

        • linuxMountPoint — (String)

          The mount location for a shared file system on a Linux virtual workstation.

        • shareName — (String)

          The name of the file share.

        • windowsMountDrive — (String)

          The mount location for a shared file system on a Windows virtual workstation.

    • description — (String)

      The description.

    • ec2SecurityGroupIds — (Array<String>)

      The EC2 security groups that control access to the studio component.

    • initializationScripts — (Array<map>)

      Initialization scripts for studio components.

      • launchProfileProtocolVersion — (String)

        The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".

      • platform — (String)

        The platform of the initialization script, either WINDOWS or LINUX.

        Possible values include:
        • "LINUX"
        • "WINDOWS"
      • runContext — (String)

        The method to use when running the initialization script.

        Possible values include:
        • "SYSTEM_INITIALIZATION"
        • "USER_INITIALIZATION"
      • script — (String)

        The initialization script.

    • name — (String)

      The name for the studio component.

    • scriptParameters — (Array<map>)

      Parameters for the studio component scripts.

      • key — (String)

        A script parameter key.

      • value — (String)

        A script parameter value.

    • studioId — (String)

      The studio ID.

    • subtype — (String)

      The specific subtype of a studio component.

      Possible values include:
      • "AWS_MANAGED_MICROSOFT_AD"
      • "AMAZON_FSX_FOR_WINDOWS"
      • "AMAZON_FSX_FOR_LUSTRE"
      • "CUSTOM"
    • tags — (map<String>)

      A collection of labels, in the form of key:value pairs, that apply to this resource.

    • type — (String)

      The type of the studio component.

      Possible values include:
      • "ACTIVE_DIRECTORY"
      • "SHARED_FILE_SYSTEM"
      • "COMPUTE_FARM"
      • "LICENSE_SERVICE"
      • "CUSTOM"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • studioComponent — (map)

        Information about the studio component.

        • arn — (String)

          The ARN of the resource.

        • configuration — (map)

          The configuration of the studio component, based on component type.

          • activeDirectoryConfiguration — (map)

            The configuration for a Microsoft Active Directory (Microsoft AD) studio resource.

            • computerAttributes — (Array<map>)

              A collection of custom attributes for an Active Directory computer.

              • name — (String)

                The name for the LDAP attribute.

              • value — (String)

                The value for the LDAP attribute.

            • directoryId — (String)

              The directory ID of the AWS Directory Service for Microsoft AD to access using this studio component.

            • organizationalUnitDistinguishedName — (String)

              The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.

          • computeFarmConfiguration — (map)

            The configuration for a render farm that is associated with a studio resource.

            • activeDirectoryUser — (String)

              The name of an Active Directory user that is used on ComputeFarm worker instances.

            • endpoint — (String)

              The endpoint of the ComputeFarm that is accessed by the studio component resource.

          • licenseServiceConfiguration — (map)

            The configuration for a license service that is associated with a studio resource.

            • endpoint — (String)

              The endpoint of the license service that is accessed by the studio component resource.

          • sharedFileSystemConfiguration — (map)

            The configuration for a shared file storage system that is associated with a studio resource.

            • endpoint — (String)

              The endpoint of the shared file system that is accessed by the studio component resource.

            • fileSystemId — (String)

              The unique identifier for a file system.

            • linuxMountPoint — (String)

              The mount location for a shared file system on a Linux virtual workstation.

            • shareName — (String)

              The name of the file share.

            • windowsMountDrive — (String)

              The mount location for a shared file system on a Windows virtual workstation.

        • createdAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was created.

        • createdBy — (String)

          The user ID of the user that created the studio component.

        • description — (String)

          A human-readable description for the studio component resource.

        • ec2SecurityGroupIds — (Array<String>)

          The EC2 security groups that control access to the studio component.

        • initializationScripts — (Array<map>)

          Initialization scripts for studio components.

          • launchProfileProtocolVersion — (String)

            The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".

          • platform — (String)

            The platform of the initialization script, either WINDOWS or LINUX.

            Possible values include:
            • "LINUX"
            • "WINDOWS"
          • runContext — (String)

            The method to use when running the initialization script.

            Possible values include:
            • "SYSTEM_INITIALIZATION"
            • "USER_INITIALIZATION"
          • script — (String)

            The initialization script.

        • name — (String)

          A friendly name for the studio component resource.

        • scriptParameters — (Array<map>)

          Parameters for the studio component scripts.

          • key — (String)

            A script parameter key.

          • value — (String)

            A script parameter value.

        • state — (String)

          The current state.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "READY"
          • "UPDATE_IN_PROGRESS"
          • "DELETE_IN_PROGRESS"
          • "DELETED"
          • "DELETE_FAILED"
          • "CREATE_FAILED"
          • "UPDATE_FAILED"
        • statusCode — (String)

          The status code.

          Possible values include:
          • "ACTIVE_DIRECTORY_ALREADY_EXISTS"
          • "STUDIO_COMPONENT_CREATED"
          • "STUDIO_COMPONENT_UPDATED"
          • "STUDIO_COMPONENT_DELETED"
          • "ENCRYPTION_KEY_ACCESS_DENIED"
          • "ENCRYPTION_KEY_NOT_FOUND"
          • "STUDIO_COMPONENT_CREATE_IN_PROGRESS"
          • "STUDIO_COMPONENT_UPDATE_IN_PROGRESS"
          • "STUDIO_COMPONENT_DELETE_IN_PROGRESS"
          • "INTERNAL_ERROR"
        • statusMessage — (String)

          The status message for the studio component.

        • studioComponentId — (String)

          The unique identifier for a studio component resource.

        • subtype — (String)

          The specific subtype of a studio component.

          Possible values include:
          • "AWS_MANAGED_MICROSOFT_AD"
          • "AMAZON_FSX_FOR_WINDOWS"
          • "AMAZON_FSX_FOR_LUSTRE"
          • "CUSTOM"
        • tags — (map<String>)

          A collection of labels, in the form of key:value pairs, that apply to this resource.

        • type — (String)

          The type of the studio component.

          Possible values include:
          • "ACTIVE_DIRECTORY"
          • "SHARED_FILE_SYSTEM"
          • "COMPUTE_FARM"
          • "LICENSE_SERVICE"
          • "CUSTOM"
        • updatedAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was updated.

        • updatedBy — (String)

          The user ID of the user that most recently updated the resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Permanently delete a launch profile.

Service Reference:

Examples:

Calling the deleteLaunchProfile operation

var params = {
  launchProfileId: 'STRING_VALUE', /* required */
  studioId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
nimble.deleteLaunchProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

      If a token is not provided, the SDK will use a version 4 UUID.
    • launchProfileId — (String)

      The launch profile ID.

    • studioId — (String)

      The studio ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • launchProfile — (map)

        The launch profile.

        • arn — (String)

          The ARN of the resource.

        • createdAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was created.

        • createdBy — (String)

          The user ID of the user that created the launch profile.

        • description — (String)

          A human-readable description of the launch profile.

        • ec2SubnetIds — (Array<String>)

          Unique identifiers for a collection of EC2 subnets.

        • launchProfileId — (String)

          The launch profile ID.

        • launchProfileProtocolVersions — (Array<String>)

          The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".

        • name — (String)

          A friendly name for the launch profile.

        • state — (String)

          The current state.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "READY"
          • "UPDATE_IN_PROGRESS"
          • "DELETE_IN_PROGRESS"
          • "DELETED"
          • "DELETE_FAILED"
          • "CREATE_FAILED"
          • "UPDATE_FAILED"
        • statusCode — (String)

          The status code.

          Possible values include:
          • "LAUNCH_PROFILE_CREATED"
          • "LAUNCH_PROFILE_UPDATED"
          • "LAUNCH_PROFILE_DELETED"
          • "LAUNCH_PROFILE_CREATE_IN_PROGRESS"
          • "LAUNCH_PROFILE_UPDATE_IN_PROGRESS"
          • "LAUNCH_PROFILE_DELETE_IN_PROGRESS"
          • "INTERNAL_ERROR"
          • "STREAMING_IMAGE_NOT_FOUND"
          • "STREAMING_IMAGE_NOT_READY"
          • "LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED"
          • "ENCRYPTION_KEY_ACCESS_DENIED"
          • "ENCRYPTION_KEY_NOT_FOUND"
          • "INVALID_SUBNETS_PROVIDED"
        • statusMessage — (String)

          The status message for the launch profile.

        • streamConfiguration — (map)

          A configuration for a streaming session.

          • clipboardMode — (String)

            Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
          • ec2InstanceTypes — (Array<String>)

            The EC2 instance types that users can select from when launching a streaming session with this launch profile.

          • maxSessionLengthInMinutes — (Integer)

            The length of time, in minutes, that a streaming session can run. After this point, Nimble Studio automatically terminates the session.

          • streamingImageIds — (Array<String>)

            The streaming images that users can select from when launching a streaming session with this launch profile.

        • studioComponentIds — (Array<String>)

          Unique identifiers for a collection of studio components that can be used with this launch profile.

        • tags — (map<String>)

          A collection of labels, in the form of key:value pairs, that apply to this resource.

        • updatedAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was updated.

        • updatedBy — (String)

          The user ID of the user that most recently updated the resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Delete a user from launch profile membership.

Service Reference:

Examples:

Calling the deleteLaunchProfileMember operation

var params = {
  launchProfileId: 'STRING_VALUE', /* required */
  principalId: 'STRING_VALUE', /* required */
  studioId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
nimble.deleteLaunchProfileMember(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

      If a token is not provided, the SDK will use a version 4 UUID.
    • launchProfileId — (String)

      The launch profile ID.

    • principalId — (String)

      The principal ID.

    • studioId — (String)

      The studio ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Delete streaming image.

Service Reference:

Examples:

Calling the deleteStreamingImage operation

var params = {
  streamingImageId: 'STRING_VALUE', /* required */
  studioId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
nimble.deleteStreamingImage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

      If a token is not provided, the SDK will use a version 4 UUID.
    • streamingImageId — (String)

      The streaming image ID.

    • studioId — (String)

      The studio ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • streamingImage — (map)

        The streaming image.

        • arn — (String)

          The ARN of the resource.

        • description — (String)

          A human-readable description of the streaming image.

        • ec2ImageId — (String)

          The ID of an EC2 machine image with which to create the streaming image.

        • encryptionConfiguration — (map)

          The encryption configuration.

          • keyArn — (String)

            The ARN for a KMS key that is used to encrypt studio data.

          • keyTyperequired — (String)

            The type of KMS key that is used to encrypt studio data.

            Possible values include:
            • "CUSTOMER_MANAGED_KEY"
        • eulaIds — (Array<String>)

          The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.

        • name — (String)

          A friendly name for a streaming image resource.

        • owner — (String)

          The owner of the streaming image, either the studioId that contains the streaming image, or 'amazon' for images that are provided by Amazon Nimble Studio.

        • platform — (String)

          The platform of the streaming image, either WINDOWS or LINUX.

        • state — (String)

          The current state.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "READY"
          • "DELETE_IN_PROGRESS"
          • "DELETED"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_FAILED"
          • "CREATE_FAILED"
          • "DELETE_FAILED"
        • statusCode — (String)

          The status code.

          Possible values include:
          • "STREAMING_IMAGE_CREATE_IN_PROGRESS"
          • "STREAMING_IMAGE_READY"
          • "STREAMING_IMAGE_DELETE_IN_PROGRESS"
          • "STREAMING_IMAGE_DELETED"
          • "STREAMING_IMAGE_UPDATE_IN_PROGRESS"
          • "INTERNAL_ERROR"
        • statusMessage — (String)

          The status message for the streaming image.

        • streamingImageId — (String)

          The ID of the streaming image.

        • tags — (map<String>)

          A collection of labels, in the form of key:value pairs, that apply to this resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the deleteStreamingSession operation

var params = {
  sessionId: 'STRING_VALUE', /* required */
  studioId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
nimble.deleteStreamingSession(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

      If a token is not provided, the SDK will use a version 4 UUID.
    • sessionId — (String)

      The session ID.

    • studioId — (String)

      The studio ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • session — (map)

        The session.

        • arn — (String)

          The ARN of the resource.

        • createdAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was created.

        • createdBy — (String)

          The user ID of the user that created the streaming session.

        • ec2InstanceType — (String)

          The EC2 Instance type used for the streaming session.

        • launchProfileId — (String)

          The ID of the launch profile used to control access from the streaming session.

        • sessionId — (String)

          The session ID.

        • state — (String)

          The current state.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "DELETE_IN_PROGRESS"
          • "READY"
          • "DELETED"
          • "CREATE_FAILED"
          • "DELETE_FAILED"
        • statusCode — (String)

          The status code.

          Possible values include:
          • "STREAMING_SESSION_READY"
          • "STREAMING_SESSION_DELETED"
          • "STREAMING_SESSION_CREATE_IN_PROGRESS"
          • "STREAMING_SESSION_DELETE_IN_PROGRESS"
          • "INTERNAL_ERROR"
          • "INSUFFICIENT_CAPACITY"
          • "ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR"
          • "NETWORK_CONNECTION_ERROR"
          • "INITIALIZATION_SCRIPT_ERROR"
          • "DECRYPT_STREAMING_IMAGE_ERROR"
          • "NETWORK_INTERFACE_ERROR"
        • statusMessage — (String)

          The status message for the streaming session.

        • streamingImageId — (String)

          The ID of the streaming image.

        • tags — (map<String>)

          A collection of labels, in the form of key:value pairs, that apply to this resource.

        • terminateAt — (Date)

          The time the streaming session will automatically terminate if not terminated by the user.

        • updatedAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was updated.

        • updatedBy — (String)

          The user ID of the user that most recently updated the resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Delete a studio resource.

Service Reference:

Examples:

Calling the deleteStudio operation

var params = {
  studioId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
nimble.deleteStudio(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

      If a token is not provided, the SDK will use a version 4 UUID.
    • studioId — (String)

      The studio ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • studio — (map)

        Information about a studio.

        • adminRoleArn — (String)

          The IAM role that studio admins assume when logging in to the Nimble Studio portal.

        • arn — (String)

          The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

        • createdAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was created.

        • displayName — (String)

          A friendly name for the studio.

        • homeRegion — (String)

          The AWS region where the studio resource is located.

        • ssoClientId — (String)

          The AWS SSO application client ID used to integrate with AWS SSO to enable AWS SSO users to log in to Nimble portal.

        • state — (String)

          The current state of the studio resource.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "READY"
          • "UPDATE_IN_PROGRESS"
          • "DELETE_IN_PROGRESS"
          • "DELETED"
          • "DELETE_FAILED"
          • "CREATE_FAILED"
          • "UPDATE_FAILED"
        • statusCode — (String)

          Status codes that provide additional detail on the studio state.

          Possible values include:
          • "STUDIO_CREATED"
          • "STUDIO_DELETED"
          • "STUDIO_UPDATED"
          • "STUDIO_CREATE_IN_PROGRESS"
          • "STUDIO_UPDATE_IN_PROGRESS"
          • "STUDIO_DELETE_IN_PROGRESS"
          • "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED"
          • "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED"
          • "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED"
          • "AWS_SSO_NOT_ENABLED"
          • "AWS_SSO_ACCESS_DENIED"
          • "ROLE_NOT_OWNED_BY_STUDIO_OWNER"
          • "ROLE_COULD_NOT_BE_ASSUMED"
          • "INTERNAL_ERROR"
          • "ENCRYPTION_KEY_NOT_FOUND"
          • "ENCRYPTION_KEY_ACCESS_DENIED"
          • "AWS_SSO_CONFIGURATION_REPAIRED"
          • "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS"
        • statusMessage — (String)

          Additional detail on the studio state.

        • studioEncryptionConfiguration — (map)

          Configuration of the encryption method that is used for the studio.

          • keyArn — (String)

            The ARN for a KMS key that is used to encrypt studio data.

          • keyTyperequired — (String)

            The type of KMS key that is used to encrypt studio data.

            Possible values include:
            • "AWS_OWNED_KEY"
            • "CUSTOMER_MANAGED_KEY"
        • studioId — (String)

          The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.

        • studioName — (String)

          The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.

        • studioUrl — (String)

          The address of the web page for the studio.

        • tags — (map<String>)

          A collection of labels, in the form of key:value pairs, that apply to this resource.

        • updatedAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was updated.

        • userRoleArn — (String)

          The IAM role that studio users assume when logging in to the Nimble Studio portal.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Deletes a studio component resource.

Service Reference:

Examples:

Calling the deleteStudioComponent operation

var params = {
  studioComponentId: 'STRING_VALUE', /* required */
  studioId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
nimble.deleteStudioComponent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

      If a token is not provided, the SDK will use a version 4 UUID.
    • studioComponentId — (String)

      The studio component ID.

    • studioId — (String)

      The studio ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • studioComponent — (map)

        Information about the studio component.

        • arn — (String)

          The ARN of the resource.

        • configuration — (map)

          The configuration of the studio component, based on component type.

          • activeDirectoryConfiguration — (map)

            The configuration for a Microsoft Active Directory (Microsoft AD) studio resource.

            • computerAttributes — (Array<map>)

              A collection of custom attributes for an Active Directory computer.

              • name — (String)

                The name for the LDAP attribute.

              • value — (String)

                The value for the LDAP attribute.

            • directoryId — (String)

              The directory ID of the AWS Directory Service for Microsoft AD to access using this studio component.

            • organizationalUnitDistinguishedName — (String)

              The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.

          • computeFarmConfiguration — (map)

            The configuration for a render farm that is associated with a studio resource.

            • activeDirectoryUser — (String)

              The name of an Active Directory user that is used on ComputeFarm worker instances.

            • endpoint — (String)

              The endpoint of the ComputeFarm that is accessed by the studio component resource.

          • licenseServiceConfiguration — (map)

            The configuration for a license service that is associated with a studio resource.

            • endpoint — (String)

              The endpoint of the license service that is accessed by the studio component resource.

          • sharedFileSystemConfiguration — (map)

            The configuration for a shared file storage system that is associated with a studio resource.

            • endpoint — (String)

              The endpoint of the shared file system that is accessed by the studio component resource.

            • fileSystemId — (String)

              The unique identifier for a file system.

            • linuxMountPoint — (String)

              The mount location for a shared file system on a Linux virtual workstation.

            • shareName — (String)

              The name of the file share.

            • windowsMountDrive — (String)

              The mount location for a shared file system on a Windows virtual workstation.

        • createdAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was created.

        • createdBy — (String)

          The user ID of the user that created the studio component.

        • description — (String)

          A human-readable description for the studio component resource.

        • ec2SecurityGroupIds — (Array<String>)

          The EC2 security groups that control access to the studio component.

        • initializationScripts — (Array<map>)

          Initialization scripts for studio components.

          • launchProfileProtocolVersion — (String)

            The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".

          • platform — (String)

            The platform of the initialization script, either WINDOWS or LINUX.

            Possible values include:
            • "LINUX"
            • "WINDOWS"
          • runContext — (String)

            The method to use when running the initialization script.

            Possible values include:
            • "SYSTEM_INITIALIZATION"
            • "USER_INITIALIZATION"
          • script — (String)

            The initialization script.

        • name — (String)

          A friendly name for the studio component resource.

        • scriptParameters — (Array<map>)

          Parameters for the studio component scripts.

          • key — (String)

            A script parameter key.

          • value — (String)

            A script parameter value.

        • state — (String)

          The current state.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "READY"
          • "UPDATE_IN_PROGRESS"
          • "DELETE_IN_PROGRESS"
          • "DELETED"
          • "DELETE_FAILED"
          • "CREATE_FAILED"
          • "UPDATE_FAILED"
        • statusCode — (String)

          The status code.

          Possible values include:
          • "ACTIVE_DIRECTORY_ALREADY_EXISTS"
          • "STUDIO_COMPONENT_CREATED"
          • "STUDIO_COMPONENT_UPDATED"
          • "STUDIO_COMPONENT_DELETED"
          • "ENCRYPTION_KEY_ACCESS_DENIED"
          • "ENCRYPTION_KEY_NOT_FOUND"
          • "STUDIO_COMPONENT_CREATE_IN_PROGRESS"
          • "STUDIO_COMPONENT_UPDATE_IN_PROGRESS"
          • "STUDIO_COMPONENT_DELETE_IN_PROGRESS"
          • "INTERNAL_ERROR"
        • statusMessage — (String)

          The status message for the studio component.

        • studioComponentId — (String)

          The unique identifier for a studio component resource.

        • subtype — (String)

          The specific subtype of a studio component.

          Possible values include:
          • "AWS_MANAGED_MICROSOFT_AD"
          • "AMAZON_FSX_FOR_WINDOWS"
          • "AMAZON_FSX_FOR_LUSTRE"
          • "CUSTOM"
        • tags — (map<String>)

          A collection of labels, in the form of key:value pairs, that apply to this resource.

        • type — (String)

          The type of the studio component.

          Possible values include:
          • "ACTIVE_DIRECTORY"
          • "SHARED_FILE_SYSTEM"
          • "COMPUTE_FARM"
          • "LICENSE_SERVICE"
          • "CUSTOM"
        • updatedAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was updated.

        • updatedBy — (String)

          The user ID of the user that most recently updated the resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Delete a user from studio membership.

Service Reference:

Examples:

Calling the deleteStudioMember operation

var params = {
  principalId: 'STRING_VALUE', /* required */
  studioId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
nimble.deleteStudioMember(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

      If a token is not provided, the SDK will use a version 4 UUID.
    • principalId — (String)

      The principal ID.

    • studioId — (String)

      The studio ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Get Eula.

Service Reference:

Examples:

Calling the getEula operation

var params = {
  eulaId: 'STRING_VALUE' /* required */
};
nimble.getEula(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • eulaId — (String)

      The EULA ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • eula — (map)

        The EULA.

        • content — (String)

          The EULA content.

        • createdAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was created.

        • eulaId — (String)

          The EULA ID.

        • name — (String)

          The name for the EULA.

        • updatedAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was updated.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Get a launch profile.

Service Reference:

Examples:

Calling the getLaunchProfile operation

var params = {
  launchProfileId: 'STRING_VALUE', /* required */
  studioId: 'STRING_VALUE' /* required */
};
nimble.getLaunchProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • launchProfileId — (String)

      The launch profile ID.

    • studioId — (String)

      The studio ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • launchProfile — (map)

        The launch profile.

        • arn — (String)

          The ARN of the resource.

        • createdAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was created.

        • createdBy — (String)

          The user ID of the user that created the launch profile.

        • description — (String)

          A human-readable description of the launch profile.

        • ec2SubnetIds — (Array<String>)

          Unique identifiers for a collection of EC2 subnets.

        • launchProfileId — (String)

          The launch profile ID.

        • launchProfileProtocolVersions — (Array<String>)

          The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".

        • name — (String)

          A friendly name for the launch profile.

        • state — (String)

          The current state.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "READY"
          • "UPDATE_IN_PROGRESS"
          • "DELETE_IN_PROGRESS"
          • "DELETED"
          • "DELETE_FAILED"
          • "CREATE_FAILED"
          • "UPDATE_FAILED"
        • statusCode — (String)

          The status code.

          Possible values include:
          • "LAUNCH_PROFILE_CREATED"
          • "LAUNCH_PROFILE_UPDATED"
          • "LAUNCH_PROFILE_DELETED"
          • "LAUNCH_PROFILE_CREATE_IN_PROGRESS"
          • "LAUNCH_PROFILE_UPDATE_IN_PROGRESS"
          • "LAUNCH_PROFILE_DELETE_IN_PROGRESS"
          • "INTERNAL_ERROR"
          • "STREAMING_IMAGE_NOT_FOUND"
          • "STREAMING_IMAGE_NOT_READY"
          • "LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED"
          • "ENCRYPTION_KEY_ACCESS_DENIED"
          • "ENCRYPTION_KEY_NOT_FOUND"
          • "INVALID_SUBNETS_PROVIDED"
        • statusMessage — (String)

          The status message for the launch profile.

        • streamConfiguration — (map)

          A configuration for a streaming session.

          • clipboardMode — (String)

            Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
          • ec2InstanceTypes — (Array<String>)

            The EC2 instance types that users can select from when launching a streaming session with this launch profile.

          • maxSessionLengthInMinutes — (Integer)

            The length of time, in minutes, that a streaming session can run. After this point, Nimble Studio automatically terminates the session.

          • streamingImageIds — (Array<String>)

            The streaming images that users can select from when launching a streaming session with this launch profile.

        • studioComponentIds — (Array<String>)

          Unique identifiers for a collection of studio components that can be used with this launch profile.

        • tags — (map<String>)

          A collection of labels, in the form of key:value pairs, that apply to this resource.

        • updatedAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was updated.

        • updatedBy — (String)

          The user ID of the user that most recently updated the resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the getLaunchProfileDetails operation

var params = {
  launchProfileId: 'STRING_VALUE', /* required */
  studioId: 'STRING_VALUE' /* required */
};
nimble.getLaunchProfileDetails(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • launchProfileId — (String)

      The launch profile ID.

    • studioId — (String)

      The studio ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • launchProfile — (map)

        The launch profile.

        • arn — (String)

          The ARN of the resource.

        • createdAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was created.

        • createdBy — (String)

          The user ID of the user that created the launch profile.

        • description — (String)

          A human-readable description of the launch profile.

        • ec2SubnetIds — (Array<String>)

          Unique identifiers for a collection of EC2 subnets.

        • launchProfileId — (String)

          The launch profile ID.

        • launchProfileProtocolVersions — (Array<String>)

          The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".

        • name — (String)

          A friendly name for the launch profile.

        • state — (String)

          The current state.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "READY"
          • "UPDATE_IN_PROGRESS"
          • "DELETE_IN_PROGRESS"
          • "DELETED"
          • "DELETE_FAILED"
          • "CREATE_FAILED"
          • "UPDATE_FAILED"
        • statusCode — (String)

          The status code.

          Possible values include:
          • "LAUNCH_PROFILE_CREATED"
          • "LAUNCH_PROFILE_UPDATED"
          • "LAUNCH_PROFILE_DELETED"
          • "LAUNCH_PROFILE_CREATE_IN_PROGRESS"
          • "LAUNCH_PROFILE_UPDATE_IN_PROGRESS"
          • "LAUNCH_PROFILE_DELETE_IN_PROGRESS"
          • "INTERNAL_ERROR"
          • "STREAMING_IMAGE_NOT_FOUND"
          • "STREAMING_IMAGE_NOT_READY"
          • "LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED"
          • "ENCRYPTION_KEY_ACCESS_DENIED"
          • "ENCRYPTION_KEY_NOT_FOUND"
          • "INVALID_SUBNETS_PROVIDED"
        • statusMessage — (String)

          The status message for the launch profile.

        • streamConfiguration — (map)

          A configuration for a streaming session.

          • clipboardMode — (String)

            Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
          • ec2InstanceTypes — (Array<String>)

            The EC2 instance types that users can select from when launching a streaming session with this launch profile.

          • maxSessionLengthInMinutes — (Integer)

            The length of time, in minutes, that a streaming session can run. After this point, Nimble Studio automatically terminates the session.

          • streamingImageIds — (Array<String>)

            The streaming images that users can select from when launching a streaming session with this launch profile.

        • studioComponentIds — (Array<String>)

          Unique identifiers for a collection of studio components that can be used with this launch profile.

        • tags — (map<String>)

          A collection of labels, in the form of key:value pairs, that apply to this resource.

        • updatedAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was updated.

        • updatedBy — (String)

          The user ID of the user that most recently updated the resource.

      • streamingImages — (Array<map>)

        A collection of streaming images.

        • arn — (String)

          The ARN of the resource.

        • description — (String)

          A human-readable description of the streaming image.

        • ec2ImageId — (String)

          The ID of an EC2 machine image with which to create the streaming image.

        • encryptionConfiguration — (map)

          The encryption configuration.

          • keyArn — (String)

            The ARN for a KMS key that is used to encrypt studio data.

          • keyTyperequired — (String)

            The type of KMS key that is used to encrypt studio data.

            Possible values include:
            • "CUSTOMER_MANAGED_KEY"
        • eulaIds — (Array<String>)

          The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.

        • name — (String)

          A friendly name for a streaming image resource.

        • owner — (String)

          The owner of the streaming image, either the studioId that contains the streaming image, or 'amazon' for images that are provided by Amazon Nimble Studio.

        • platform — (String)

          The platform of the streaming image, either WINDOWS or LINUX.

        • state — (String)

          The current state.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "READY"
          • "DELETE_IN_PROGRESS"
          • "DELETED"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_FAILED"
          • "CREATE_FAILED"
          • "DELETE_FAILED"
        • statusCode — (String)

          The status code.

          Possible values include:
          • "STREAMING_IMAGE_CREATE_IN_PROGRESS"
          • "STREAMING_IMAGE_READY"
          • "STREAMING_IMAGE_DELETE_IN_PROGRESS"
          • "STREAMING_IMAGE_DELETED"
          • "STREAMING_IMAGE_UPDATE_IN_PROGRESS"
          • "INTERNAL_ERROR"
        • statusMessage — (String)

          The status message for the streaming image.

        • streamingImageId — (String)

          The ID of the streaming image.

        • tags — (map<String>)

          A collection of labels, in the form of key:value pairs, that apply to this resource.

      • studioComponentSummaries — (Array<map>)

        A collection of studio component summaries.

        • createdAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was created.

        • createdBy — (String)

          The user ID of the user that created the studio component.

        • description — (String)

          The description.

        • name — (String)

          The name for the studio component.

        • studioComponentId — (String)

          The unique identifier for a studio component resource.

        • subtype — (String)

          The specific subtype of a studio component.

          Possible values include:
          • "AWS_MANAGED_MICROSOFT_AD"
          • "AMAZON_FSX_FOR_WINDOWS"
          • "AMAZON_FSX_FOR_LUSTRE"
          • "CUSTOM"
        • type — (String)

          The type of the studio component.

          Possible values include:
          • "ACTIVE_DIRECTORY"
          • "SHARED_FILE_SYSTEM"
          • "COMPUTE_FARM"
          • "LICENSE_SERVICE"
          • "CUSTOM"
        • updatedAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was updated.

        • updatedBy — (String)

          The user ID of the user that most recently updated the resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Get a launch profile initialization.

Service Reference:

Examples:

Calling the getLaunchProfileInitialization operation

var params = {
  launchProfileId: 'STRING_VALUE', /* required */
  launchProfileProtocolVersions: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  launchPurpose: 'STRING_VALUE', /* required */
  platform: 'STRING_VALUE', /* required */
  studioId: 'STRING_VALUE' /* required */
};
nimble.getLaunchProfileInitialization(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • launchProfileId — (String)

      The launch profile ID.

    • launchProfileProtocolVersions — (Array<String>)

      A collection of launch profile protocol versions.

    • launchPurpose — (String)

      The launch purpose.

    • platform — (String)

      The platform.

    • studioId — (String)

      The studio ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • launchProfileInitialization — (map)

        The launch profile initialization.

        • activeDirectory — (map)

          A LaunchProfileInitializationActiveDirectory resource.

          • computerAttributes — (Array<map>)

            A collection of custom attributes for an Active Directory computer.

            • name — (String)

              The name for the LDAP attribute.

            • value — (String)

              The value for the LDAP attribute.

          • directoryId — (String)

            The directory ID of the AWS Directory Service for Microsoft AD to access using this launch profile.

          • directoryName — (String)

            The directory name.

          • dnsIpAddresses — (Array<String>)

            The DNS IP address.

          • organizationalUnitDistinguishedName — (String)

            The name for the organizational unit distinguished name.

          • studioComponentId — (String)

            The unique identifier for a studio component resource.

          • studioComponentName — (String)

            The name for the studio component.

        • ec2SecurityGroupIds — (Array<String>)

          The EC2 security groups that control access to the studio component.

        • launchProfileId — (String)

          The launch profile ID.

        • launchProfileProtocolVersion — (String)

          The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".

        • launchPurpose — (String)

          The launch purpose.

        • name — (String)

          The name for the launch profile.

        • platform — (String)

          The platform of the launch platform, either WINDOWS or LINUX.

          Possible values include:
          • "LINUX"
          • "WINDOWS"
        • systemInitializationScripts — (Array<map>)

          The system initializtion scripts.

          • script — (String)

            The initialization script.

          • studioComponentId — (String)

            The unique identifier for a studio component resource.

          • studioComponentName — (String)

            The name for the studio component.

        • userInitializationScripts — (Array<map>)

          The user initializtion scripts.

          • script — (String)

            The initialization script.

          • studioComponentId — (String)

            The unique identifier for a studio component resource.

          • studioComponentName — (String)

            The name for the studio component.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Get a user persona in launch profile membership.

Service Reference:

Examples:

Calling the getLaunchProfileMember operation

var params = {
  launchProfileId: 'STRING_VALUE', /* required */
  principalId: 'STRING_VALUE', /* required */
  studioId: 'STRING_VALUE' /* required */
};
nimble.getLaunchProfileMember(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • launchProfileId — (String)

      The launch profile ID.

    • principalId — (String)

      The principal ID.

    • studioId — (String)

      The studio ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • member — (map)

        The member.

        • identityStoreId — (String)

          The ID of the identity store.

        • persona — (String)

          The persona.

          Possible values include:
          • "USER"
        • principalId — (String)

          The principal ID.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Get streaming image.

Service Reference:

Examples:

Calling the getStreamingImage operation

var params = {
  streamingImageId: 'STRING_VALUE', /* required */
  studioId: 'STRING_VALUE' /* required */
};
nimble.getStreamingImage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • streamingImageId — (String)

      The streaming image ID.

    • studioId — (String)

      The studio ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • streamingImage — (map)

        The streaming image.

        • arn — (String)

          The ARN of the resource.

        • description — (String)

          A human-readable description of the streaming image.

        • ec2ImageId — (String)

          The ID of an EC2 machine image with which to create the streaming image.

        • encryptionConfiguration — (map)

          The encryption configuration.

          • keyArn — (String)

            The ARN for a KMS key that is used to encrypt studio data.

          • keyTyperequired — (String)

            The type of KMS key that is used to encrypt studio data.

            Possible values include:
            • "CUSTOMER_MANAGED_KEY"
        • eulaIds — (Array<String>)

          The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.

        • name — (String)

          A friendly name for a streaming image resource.

        • owner — (String)

          The owner of the streaming image, either the studioId that contains the streaming image, or 'amazon' for images that are provided by Amazon Nimble Studio.

        • platform — (String)

          The platform of the streaming image, either WINDOWS or LINUX.

        • state — (String)

          The current state.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "READY"
          • "DELETE_IN_PROGRESS"
          • "DELETED"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_FAILED"
          • "CREATE_FAILED"
          • "DELETE_FAILED"
        • statusCode — (String)

          The status code.

          Possible values include:
          • "STREAMING_IMAGE_CREATE_IN_PROGRESS"
          • "STREAMING_IMAGE_READY"
          • "STREAMING_IMAGE_DELETE_IN_PROGRESS"
          • "STREAMING_IMAGE_DELETED"
          • "STREAMING_IMAGE_UPDATE_IN_PROGRESS"
          • "INTERNAL_ERROR"
        • statusMessage — (String)

          The status message for the streaming image.

        • streamingImageId — (String)

          The ID of the streaming image.

        • tags — (map<String>)

          A collection of labels, in the form of key:value pairs, that apply to this resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Gets StreamingSession resource.

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

Service Reference:

Examples:

Calling the getStreamingSession operation

var params = {
  sessionId: 'STRING_VALUE', /* required */
  studioId: 'STRING_VALUE' /* required */
};
nimble.getStreamingSession(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • sessionId — (String)

      The session ID.

    • studioId — (String)

      The studio ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • session — (map)

        The session.

        • arn — (String)

          The ARN of the resource.

        • createdAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was created.

        • createdBy — (String)

          The user ID of the user that created the streaming session.

        • ec2InstanceType — (String)

          The EC2 Instance type used for the streaming session.

        • launchProfileId — (String)

          The ID of the launch profile used to control access from the streaming session.

        • sessionId — (String)

          The session ID.

        • state — (String)

          The current state.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "DELETE_IN_PROGRESS"
          • "READY"
          • "DELETED"
          • "CREATE_FAILED"
          • "DELETE_FAILED"
        • statusCode — (String)

          The status code.

          Possible values include:
          • "STREAMING_SESSION_READY"
          • "STREAMING_SESSION_DELETED"
          • "STREAMING_SESSION_CREATE_IN_PROGRESS"
          • "STREAMING_SESSION_DELETE_IN_PROGRESS"
          • "INTERNAL_ERROR"
          • "INSUFFICIENT_CAPACITY"
          • "ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR"
          • "NETWORK_CONNECTION_ERROR"
          • "INITIALIZATION_SCRIPT_ERROR"
          • "DECRYPT_STREAMING_IMAGE_ERROR"
          • "NETWORK_INTERFACE_ERROR"
        • statusMessage — (String)

          The status message for the streaming session.

        • streamingImageId — (String)

          The ID of the streaming image.

        • tags — (map<String>)

          A collection of labels, in the form of key:value pairs, that apply to this resource.

        • terminateAt — (Date)

          The time the streaming session will automatically terminate if not terminated by the user.

        • updatedAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was updated.

        • updatedBy — (String)

          The user ID of the user that most recently updated the resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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 state READY, the url property will contain a stream to be used with the DCV streaming client.

Service Reference:

Examples:

Calling the getStreamingSessionStream operation

var params = {
  sessionId: 'STRING_VALUE', /* required */
  streamId: 'STRING_VALUE', /* required */
  studioId: 'STRING_VALUE' /* required */
};
nimble.getStreamingSessionStream(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • sessionId — (String)

      The session ID.

    • streamId — (String)

      The stream ID.

    • studioId — (String)

      The studio ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • stream — (map)

        The stream.

        • createdAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was created.

        • createdBy — (String)

          The user ID of the user that created the streaming session stream.

        • expiresAt — (Date)

          The Unix epoch timestamp in seconds for when the resource expires.

        • state — (String)

          The current state.

          Possible values include:
          • "READY"
          • "CREATE_IN_PROGRESS"
          • "DELETE_IN_PROGRESS"
          • "DELETED"
          • "CREATE_FAILED"
          • "DELETE_FAILED"
        • statusCode — (String)

          The streaming session stream status code.

          Possible values include:
          • "STREAM_CREATE_IN_PROGRESS"
          • "STREAM_READY"
          • "STREAM_DELETE_IN_PROGRESS"
          • "STREAM_DELETED"
          • "INTERNAL_ERROR"
          • "NETWORK_CONNECTION_ERROR"
        • streamId — (String)

          The stream ID.

        • url — (String)

          The URL to connect to this stream using the DCV client.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Get a Studio resource.

Service Reference:

Examples:

Calling the getStudio operation

var params = {
  studioId: 'STRING_VALUE' /* required */
};
nimble.getStudio(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • studioId — (String)

      The studio ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • studio — (map)

        Information about a studio.

        • adminRoleArn — (String)

          The IAM role that studio admins assume when logging in to the Nimble Studio portal.

        • arn — (String)

          The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

        • createdAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was created.

        • displayName — (String)

          A friendly name for the studio.

        • homeRegion — (String)

          The AWS region where the studio resource is located.

        • ssoClientId — (String)

          The AWS SSO application client ID used to integrate with AWS SSO to enable AWS SSO users to log in to Nimble portal.

        • state — (String)

          The current state of the studio resource.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "READY"
          • "UPDATE_IN_PROGRESS"
          • "DELETE_IN_PROGRESS"
          • "DELETED"
          • "DELETE_FAILED"
          • "CREATE_FAILED"
          • "UPDATE_FAILED"
        • statusCode — (String)

          Status codes that provide additional detail on the studio state.

          Possible values include:
          • "STUDIO_CREATED"
          • "STUDIO_DELETED"
          • "STUDIO_UPDATED"
          • "STUDIO_CREATE_IN_PROGRESS"
          • "STUDIO_UPDATE_IN_PROGRESS"
          • "STUDIO_DELETE_IN_PROGRESS"
          • "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED"
          • "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED"
          • "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED"
          • "AWS_SSO_NOT_ENABLED"
          • "AWS_SSO_ACCESS_DENIED"
          • "ROLE_NOT_OWNED_BY_STUDIO_OWNER"
          • "ROLE_COULD_NOT_BE_ASSUMED"
          • "INTERNAL_ERROR"
          • "ENCRYPTION_KEY_NOT_FOUND"
          • "ENCRYPTION_KEY_ACCESS_DENIED"
          • "AWS_SSO_CONFIGURATION_REPAIRED"
          • "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS"
        • statusMessage — (String)

          Additional detail on the studio state.

        • studioEncryptionConfiguration — (map)

          Configuration of the encryption method that is used for the studio.

          • keyArn — (String)

            The ARN for a KMS key that is used to encrypt studio data.

          • keyTyperequired — (String)

            The type of KMS key that is used to encrypt studio data.

            Possible values include:
            • "AWS_OWNED_KEY"
            • "CUSTOMER_MANAGED_KEY"
        • studioId — (String)

          The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.

        • studioName — (String)

          The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.

        • studioUrl — (String)

          The address of the web page for the studio.

        • tags — (map<String>)

          A collection of labels, in the form of key:value pairs, that apply to this resource.

        • updatedAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was updated.

        • userRoleArn — (String)

          The IAM role that studio users assume when logging in to the Nimble Studio portal.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Gets a studio component resource.

Service Reference:

Examples:

Calling the getStudioComponent operation

var params = {
  studioComponentId: 'STRING_VALUE', /* required */
  studioId: 'STRING_VALUE' /* required */
};
nimble.getStudioComponent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • studioComponentId — (String)

      The studio component ID.

    • studioId — (String)

      The studio ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • studioComponent — (map)

        Information about the studio component.

        • arn — (String)

          The ARN of the resource.

        • configuration — (map)

          The configuration of the studio component, based on component type.

          • activeDirectoryConfiguration — (map)

            The configuration for a Microsoft Active Directory (Microsoft AD) studio resource.

            • computerAttributes — (Array<map>)

              A collection of custom attributes for an Active Directory computer.

              • name — (String)

                The name for the LDAP attribute.

              • value — (String)

                The value for the LDAP attribute.

            • directoryId — (String)

              The directory ID of the AWS Directory Service for Microsoft AD to access using this studio component.

            • organizationalUnitDistinguishedName — (String)

              The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.

          • computeFarmConfiguration — (map)

            The configuration for a render farm that is associated with a studio resource.

            • activeDirectoryUser — (String)

              The name of an Active Directory user that is used on ComputeFarm worker instances.

            • endpoint — (String)

              The endpoint of the ComputeFarm that is accessed by the studio component resource.

          • licenseServiceConfiguration — (map)

            The configuration for a license service that is associated with a studio resource.

            • endpoint — (String)

              The endpoint of the license service that is accessed by the studio component resource.

          • sharedFileSystemConfiguration — (map)

            The configuration for a shared file storage system that is associated with a studio resource.

            • endpoint — (String)

              The endpoint of the shared file system that is accessed by the studio component resource.

            • fileSystemId — (String)

              The unique identifier for a file system.

            • linuxMountPoint — (String)

              The mount location for a shared file system on a Linux virtual workstation.

            • shareName — (String)

              The name of the file share.

            • windowsMountDrive — (String)

              The mount location for a shared file system on a Windows virtual workstation.

        • createdAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was created.

        • createdBy — (String)

          The user ID of the user that created the studio component.

        • description — (String)

          A human-readable description for the studio component resource.

        • ec2SecurityGroupIds — (Array<String>)

          The EC2 security groups that control access to the studio component.

        • initializationScripts — (Array<map>)

          Initialization scripts for studio components.

          • launchProfileProtocolVersion — (String)

            The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".

          • platform — (String)

            The platform of the initialization script, either WINDOWS or LINUX.

            Possible values include:
            • "LINUX"
            • "WINDOWS"
          • runContext — (String)

            The method to use when running the initialization script.

            Possible values include:
            • "SYSTEM_INITIALIZATION"
            • "USER_INITIALIZATION"
          • script — (String)

            The initialization script.

        • name — (String)

          A friendly name for the studio component resource.

        • scriptParameters — (Array<map>)

          Parameters for the studio component scripts.

          • key — (String)

            A script parameter key.

          • value — (String)

            A script parameter value.

        • state — (String)

          The current state.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "READY"
          • "UPDATE_IN_PROGRESS"
          • "DELETE_IN_PROGRESS"
          • "DELETED"
          • "DELETE_FAILED"
          • "CREATE_FAILED"
          • "UPDATE_FAILED"
        • statusCode — (String)

          The status code.

          Possible values include:
          • "ACTIVE_DIRECTORY_ALREADY_EXISTS"
          • "STUDIO_COMPONENT_CREATED"
          • "STUDIO_COMPONENT_UPDATED"
          • "STUDIO_COMPONENT_DELETED"
          • "ENCRYPTION_KEY_ACCESS_DENIED"
          • "ENCRYPTION_KEY_NOT_FOUND"
          • "STUDIO_COMPONENT_CREATE_IN_PROGRESS"
          • "STUDIO_COMPONENT_UPDATE_IN_PROGRESS"
          • "STUDIO_COMPONENT_DELETE_IN_PROGRESS"
          • "INTERNAL_ERROR"
        • statusMessage — (String)

          The status message for the studio component.

        • studioComponentId — (String)

          The unique identifier for a studio component resource.

        • subtype — (String)

          The specific subtype of a studio component.

          Possible values include:
          • "AWS_MANAGED_MICROSOFT_AD"
          • "AMAZON_FSX_FOR_WINDOWS"
          • "AMAZON_FSX_FOR_LUSTRE"
          • "CUSTOM"
        • tags — (map<String>)

          A collection of labels, in the form of key:value pairs, that apply to this resource.

        • type — (String)

          The type of the studio component.

          Possible values include:
          • "ACTIVE_DIRECTORY"
          • "SHARED_FILE_SYSTEM"
          • "COMPUTE_FARM"
          • "LICENSE_SERVICE"
          • "CUSTOM"
        • updatedAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was updated.

        • updatedBy — (String)

          The user ID of the user that most recently updated the resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Get a user's membership in a studio.

Service Reference:

Examples:

Calling the getStudioMember operation

var params = {
  principalId: 'STRING_VALUE', /* required */
  studioId: 'STRING_VALUE' /* required */
};
nimble.getStudioMember(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • principalId — (String)

      The principal ID.

    • studioId — (String)

      The studio ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • member — (map)

        The member.

        • identityStoreId — (String)

          The ID of the identity store.

        • persona — (String)

          The persona.

          Possible values include:
          • "ADMINISTRATOR"
        • principalId — (String)

          The principal ID.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

List Eula Acceptances.

Service Reference:

Examples:

Calling the listEulaAcceptances operation

var params = {
  studioId: 'STRING_VALUE', /* required */
  eulaIds: [
    'STRING_VALUE',
    /* more items */
  ],
  nextToken: 'STRING_VALUE'
};
nimble.listEulaAcceptances(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • eulaIds — (Array<String>)

      A collection of EULA IDs.

    • nextToken — (String)

      The token for the next set of results, or null if there are no more results.

    • studioId — (String)

      The studio ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • eulaAcceptances — (Array<map>)

        A collection of EULA acceptances.

        • acceptedAt — (Date)

          The Unix epoch timestamp in seconds for when the EULA was accepted.

        • acceptedBy — (String)

          The ID of the person who accepted the EULA.

        • accepteeId — (String)

          The ID of the acceptee.

        • eulaAcceptanceId — (String)

          The EULA acceptance ID.

        • eulaId — (String)

          The EULA ID.

      • nextToken — (String)

        The token for the next set of results, or null if there are no more results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

List Eulas.

Service Reference:

Examples:

Calling the listEulas operation

var params = {
  eulaIds: [
    'STRING_VALUE',
    /* more items */
  ],
  nextToken: 'STRING_VALUE'
};
nimble.listEulas(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • eulaIds — (Array<String>)

      A collection of EULA IDs.

    • nextToken — (String)

      The token for the next set of results, or null if there are no more results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • eulas — (Array<map>)

        A collection of EULA resources.

        • content — (String)

          The EULA content.

        • createdAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was created.

        • eulaId — (String)

          The EULA ID.

        • name — (String)

          The name for the EULA.

        • updatedAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was updated.

      • nextToken — (String)

        The token for the next set of results, or null if there are no more results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Get all users in a given launch profile membership.

Service Reference:

Examples:

Calling the listLaunchProfileMembers operation

var params = {
  launchProfileId: 'STRING_VALUE', /* required */
  studioId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
nimble.listLaunchProfileMembers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • launchProfileId — (String)

      The launch profile ID.

    • maxResults — (Integer)

      The maximum number of results to be returned per request.

    • nextToken — (String)

      The token for the next set of results, or null if there are no more results.

    • studioId — (String)

      The studio ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • members — (Array<map>)

        A list of members.

        • identityStoreId — (String)

          The ID of the identity store.

        • persona — (String)

          The persona.

          Possible values include:
          • "USER"
        • principalId — (String)

          The principal ID.

      • nextToken — (String)

        The token for the next set of results, or null if there are no more results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

List all the launch profiles a studio.

Service Reference:

Examples:

Calling the listLaunchProfiles operation

var params = {
  studioId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  principalId: 'STRING_VALUE',
  states: [
    'STRING_VALUE',
    /* more items */
  ]
};
nimble.listLaunchProfiles(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      The maximum number of results to be returned per request.

    • nextToken — (String)

      The token for the next set of results, or null if there are no more results.

    • principalId — (String)

      The principal ID.

    • states — (Array<String>)

      A list of states.

    • studioId — (String)

      The studio ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • launchProfiles — (Array<map>)

        A collection of launch profiles.

        • arn — (String)

          The ARN of the resource.

        • createdAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was created.

        • createdBy — (String)

          The user ID of the user that created the launch profile.

        • description — (String)

          A human-readable description of the launch profile.

        • ec2SubnetIds — (Array<String>)

          Unique identifiers for a collection of EC2 subnets.

        • launchProfileId — (String)

          The launch profile ID.

        • launchProfileProtocolVersions — (Array<String>)

          The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".

        • name — (String)

          A friendly name for the launch profile.

        • state — (String)

          The current state.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "READY"
          • "UPDATE_IN_PROGRESS"
          • "DELETE_IN_PROGRESS"
          • "DELETED"
          • "DELETE_FAILED"
          • "CREATE_FAILED"
          • "UPDATE_FAILED"
        • statusCode — (String)

          The status code.

          Possible values include:
          • "LAUNCH_PROFILE_CREATED"
          • "LAUNCH_PROFILE_UPDATED"
          • "LAUNCH_PROFILE_DELETED"
          • "LAUNCH_PROFILE_CREATE_IN_PROGRESS"
          • "LAUNCH_PROFILE_UPDATE_IN_PROGRESS"
          • "LAUNCH_PROFILE_DELETE_IN_PROGRESS"
          • "INTERNAL_ERROR"
          • "STREAMING_IMAGE_NOT_FOUND"
          • "STREAMING_IMAGE_NOT_READY"
          • "LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED"
          • "ENCRYPTION_KEY_ACCESS_DENIED"
          • "ENCRYPTION_KEY_NOT_FOUND"
          • "INVALID_SUBNETS_PROVIDED"
        • statusMessage — (String)

          The status message for the launch profile.

        • streamConfiguration — (map)

          A configuration for a streaming session.

          • clipboardMode — (String)

            Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
          • ec2InstanceTypes — (Array<String>)

            The EC2 instance types that users can select from when launching a streaming session with this launch profile.

          • maxSessionLengthInMinutes — (Integer)

            The length of time, in minutes, that a streaming session can run. After this point, Nimble Studio automatically terminates the session.

          • streamingImageIds — (Array<String>)

            The streaming images that users can select from when launching a streaming session with this launch profile.

        • studioComponentIds — (Array<String>)

          Unique identifiers for a collection of studio components that can be used with this launch profile.

        • tags — (map<String>)

          A collection of labels, in the form of key:value pairs, that apply to this resource.

        • updatedAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was updated.

        • updatedBy — (String)

          The user ID of the user that most recently updated the resource.

      • nextToken — (String)

        The token for the next set of results, or null if there are no more results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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.

Service Reference:

Examples:

Calling the listStreamingImages operation

var params = {
  studioId: 'STRING_VALUE', /* required */
  nextToken: 'STRING_VALUE',
  owner: 'STRING_VALUE'
};
nimble.listStreamingImages(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • nextToken — (String)

      The token for the next set of results, or null if there are no more results.

    • owner — (String)

      The owner.

    • studioId — (String)

      The studio ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        The token for the next set of results, or null if there are no more results.

      • streamingImages — (Array<map>)

        A collection of streaming images.

        • arn — (String)

          The ARN of the resource.

        • description — (String)

          A human-readable description of the streaming image.

        • ec2ImageId — (String)

          The ID of an EC2 machine image with which to create the streaming image.

        • encryptionConfiguration — (map)

          The encryption configuration.

          • keyArn — (String)

            The ARN for a KMS key that is used to encrypt studio data.

          • keyTyperequired — (String)

            The type of KMS key that is used to encrypt studio data.

            Possible values include:
            • "CUSTOMER_MANAGED_KEY"
        • eulaIds — (Array<String>)

          The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.

        • name — (String)

          A friendly name for a streaming image resource.

        • owner — (String)

          The owner of the streaming image, either the studioId that contains the streaming image, or 'amazon' for images that are provided by Amazon Nimble Studio.

        • platform — (String)

          The platform of the streaming image, either WINDOWS or LINUX.

        • state — (String)

          The current state.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "READY"
          • "DELETE_IN_PROGRESS"
          • "DELETED"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_FAILED"
          • "CREATE_FAILED"
          • "DELETE_FAILED"
        • statusCode — (String)

          The status code.

          Possible values include:
          • "STREAMING_IMAGE_CREATE_IN_PROGRESS"
          • "STREAMING_IMAGE_READY"
          • "STREAMING_IMAGE_DELETE_IN_PROGRESS"
          • "STREAMING_IMAGE_DELETED"
          • "STREAMING_IMAGE_UPDATE_IN_PROGRESS"
          • "INTERNAL_ERROR"
        • statusMessage — (String)

          The status message for the streaming image.

        • streamingImageId — (String)

          The ID of the streaming image.

        • tags — (map<String>)

          A collection of labels, in the form of key:value pairs, that apply to this resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Lists the streaming image resources in a studio.

Service Reference:

Examples:

Calling the listStreamingSessions operation

var params = {
  studioId: 'STRING_VALUE', /* required */
  createdBy: 'STRING_VALUE',
  nextToken: 'STRING_VALUE',
  sessionIds: 'STRING_VALUE'
};
nimble.listStreamingSessions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • createdBy — (String)

      The user ID.

    • nextToken — (String)

      The token for the next set of results, or null if there are no more results.

    • sessionIds — (String)

      A collection of session IDs.

    • studioId — (String)

      The studio ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        The token for the next set of results, or null if there are no more results.

      • sessions — (Array<map>)

        A collection of streaming sessions.

        • arn — (String)

          The ARN of the resource.

        • createdAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was created.

        • createdBy — (String)

          The user ID of the user that created the streaming session.

        • ec2InstanceType — (String)

          The EC2 Instance type used for the streaming session.

        • launchProfileId — (String)

          The ID of the launch profile used to control access from the streaming session.

        • sessionId — (String)

          The session ID.

        • state — (String)

          The current state.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "DELETE_IN_PROGRESS"
          • "READY"
          • "DELETED"
          • "CREATE_FAILED"
          • "DELETE_FAILED"
        • statusCode — (String)

          The status code.

          Possible values include:
          • "STREAMING_SESSION_READY"
          • "STREAMING_SESSION_DELETED"
          • "STREAMING_SESSION_CREATE_IN_PROGRESS"
          • "STREAMING_SESSION_DELETE_IN_PROGRESS"
          • "INTERNAL_ERROR"
          • "INSUFFICIENT_CAPACITY"
          • "ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR"
          • "NETWORK_CONNECTION_ERROR"
          • "INITIALIZATION_SCRIPT_ERROR"
          • "DECRYPT_STREAMING_IMAGE_ERROR"
          • "NETWORK_INTERFACE_ERROR"
        • statusMessage — (String)

          The status message for the streaming session.

        • streamingImageId — (String)

          The ID of the streaming image.

        • tags — (map<String>)

          A collection of labels, in the form of key:value pairs, that apply to this resource.

        • terminateAt — (Date)

          The time the streaming session will automatically terminate if not terminated by the user.

        • updatedAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was updated.

        • updatedBy — (String)

          The user ID of the user that most recently updated the resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Lists the StudioComponents in a studio.

Service Reference:

Examples:

Calling the listStudioComponents operation

var params = {
  studioId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  states: [
    'STRING_VALUE',
    /* more items */
  ],
  types: [
    'STRING_VALUE',
    /* more items */
  ]
};
nimble.listStudioComponents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      The maximum number of results to be returned per request.

    • nextToken — (String)

      The token for the next set of results, or null if there are no more results.

    • states — (Array<String>)

      A list of states.

    • studioId — (String)

      The studio ID.

    • types — (Array<String>)

      The types.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        The token for the next set of results, or null if there are no more results.

      • studioComponents — (Array<map>)

        A collection of studio components.

        • arn — (String)

          The ARN of the resource.

        • configuration — (map)

          The configuration of the studio component, based on component type.

          • activeDirectoryConfiguration — (map)

            The configuration for a Microsoft Active Directory (Microsoft AD) studio resource.

            • computerAttributes — (Array<map>)

              A collection of custom attributes for an Active Directory computer.

              • name — (String)

                The name for the LDAP attribute.

              • value — (String)

                The value for the LDAP attribute.

            • directoryId — (String)

              The directory ID of the AWS Directory Service for Microsoft AD to access using this studio component.

            • organizationalUnitDistinguishedName — (String)

              The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.

          • computeFarmConfiguration — (map)

            The configuration for a render farm that is associated with a studio resource.

            • activeDirectoryUser — (String)

              The name of an Active Directory user that is used on ComputeFarm worker instances.

            • endpoint — (String)

              The endpoint of the ComputeFarm that is accessed by the studio component resource.

          • licenseServiceConfiguration — (map)

            The configuration for a license service that is associated with a studio resource.

            • endpoint — (String)

              The endpoint of the license service that is accessed by the studio component resource.

          • sharedFileSystemConfiguration — (map)

            The configuration for a shared file storage system that is associated with a studio resource.

            • endpoint — (String)

              The endpoint of the shared file system that is accessed by the studio component resource.

            • fileSystemId — (String)

              The unique identifier for a file system.

            • linuxMountPoint — (String)

              The mount location for a shared file system on a Linux virtual workstation.

            • shareName — (String)

              The name of the file share.

            • windowsMountDrive — (String)

              The mount location for a shared file system on a Windows virtual workstation.

        • createdAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was created.

        • createdBy — (String)

          The user ID of the user that created the studio component.

        • description — (String)

          A human-readable description for the studio component resource.

        • ec2SecurityGroupIds — (Array<String>)

          The EC2 security groups that control access to the studio component.

        • initializationScripts — (Array<map>)

          Initialization scripts for studio components.

          • launchProfileProtocolVersion — (String)

            The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".

          • platform — (String)

            The platform of the initialization script, either WINDOWS or LINUX.

            Possible values include:
            • "LINUX"
            • "WINDOWS"
          • runContext — (String)

            The method to use when running the initialization script.

            Possible values include:
            • "SYSTEM_INITIALIZATION"
            • "USER_INITIALIZATION"
          • script — (String)

            The initialization script.

        • name — (String)

          A friendly name for the studio component resource.

        • scriptParameters — (Array<map>)

          Parameters for the studio component scripts.

          • key — (String)

            A script parameter key.

          • value — (String)

            A script parameter value.

        • state — (String)

          The current state.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "READY"
          • "UPDATE_IN_PROGRESS"
          • "DELETE_IN_PROGRESS"
          • "DELETED"
          • "DELETE_FAILED"
          • "CREATE_FAILED"
          • "UPDATE_FAILED"
        • statusCode — (String)

          The status code.

          Possible values include:
          • "ACTIVE_DIRECTORY_ALREADY_EXISTS"
          • "STUDIO_COMPONENT_CREATED"
          • "STUDIO_COMPONENT_UPDATED"
          • "STUDIO_COMPONENT_DELETED"
          • "ENCRYPTION_KEY_ACCESS_DENIED"
          • "ENCRYPTION_KEY_NOT_FOUND"
          • "STUDIO_COMPONENT_CREATE_IN_PROGRESS"
          • "STUDIO_COMPONENT_UPDATE_IN_PROGRESS"
          • "STUDIO_COMPONENT_DELETE_IN_PROGRESS"
          • "INTERNAL_ERROR"
        • statusMessage — (String)

          The status message for the studio component.

        • studioComponentId — (String)

          The unique identifier for a studio component resource.

        • subtype — (String)

          The specific subtype of a studio component.

          Possible values include:
          • "AWS_MANAGED_MICROSOFT_AD"
          • "AMAZON_FSX_FOR_WINDOWS"
          • "AMAZON_FSX_FOR_LUSTRE"
          • "CUSTOM"
        • tags — (map<String>)

          A collection of labels, in the form of key:value pairs, that apply to this resource.

        • type — (String)

          The type of the studio component.

          Possible values include:
          • "ACTIVE_DIRECTORY"
          • "SHARED_FILE_SYSTEM"
          • "COMPUTE_FARM"
          • "LICENSE_SERVICE"
          • "CUSTOM"
        • updatedAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was updated.

        • updatedBy — (String)

          The user ID of the user that most recently updated the resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Get all users in a given studio membership.

Service Reference:

Examples:

Calling the listStudioMembers operation

var params = {
  studioId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
nimble.listStudioMembers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      The maximum number of results to be returned per request.

    • nextToken — (String)

      The token for the next set of results, or null if there are no more results.

    • studioId — (String)

      The studio ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • members — (Array<map>)

        A list of members.

        • identityStoreId — (String)

          The ID of the identity store.

        • persona — (String)

          The persona.

          Possible values include:
          • "ADMINISTRATOR"
        • principalId — (String)

          The principal ID.

      • nextToken — (String)

        The token for the next set of results, or null if there are no more results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the listStudios operation

var params = {
  nextToken: 'STRING_VALUE'
};
nimble.listStudios(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • nextToken — (String)

      The token for the next set of results, or null if there are no more results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        The token for the next set of results, or null if there are no more results.

      • studios — (Array<map>)

        A collection of studios.

        • adminRoleArn — (String)

          The IAM role that studio admins assume when logging in to the Nimble Studio portal.

        • arn — (String)

          The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

        • createdAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was created.

        • displayName — (String)

          A friendly name for the studio.

        • homeRegion — (String)

          The AWS region where the studio resource is located.

        • ssoClientId — (String)

          The AWS SSO application client ID used to integrate with AWS SSO to enable AWS SSO users to log in to Nimble portal.

        • state — (String)

          The current state of the studio resource.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "READY"
          • "UPDATE_IN_PROGRESS"
          • "DELETE_IN_PROGRESS"
          • "DELETED"
          • "DELETE_FAILED"
          • "CREATE_FAILED"
          • "UPDATE_FAILED"
        • statusCode — (String)

          Status codes that provide additional detail on the studio state.

          Possible values include:
          • "STUDIO_CREATED"
          • "STUDIO_DELETED"
          • "STUDIO_UPDATED"
          • "STUDIO_CREATE_IN_PROGRESS"
          • "STUDIO_UPDATE_IN_PROGRESS"
          • "STUDIO_DELETE_IN_PROGRESS"
          • "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED"
          • "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED"
          • "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED"
          • "AWS_SSO_NOT_ENABLED"
          • "AWS_SSO_ACCESS_DENIED"
          • "ROLE_NOT_OWNED_BY_STUDIO_OWNER"
          • "ROLE_COULD_NOT_BE_ASSUMED"
          • "INTERNAL_ERROR"
          • "ENCRYPTION_KEY_NOT_FOUND"
          • "ENCRYPTION_KEY_ACCESS_DENIED"
          • "AWS_SSO_CONFIGURATION_REPAIRED"
          • "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS"
        • statusMessage — (String)

          Additional detail on the studio state.

        • studioEncryptionConfiguration — (map)

          Configuration of the encryption method that is used for the studio.

          • keyArn — (String)

            The ARN for a KMS key that is used to encrypt studio data.

          • keyTyperequired — (String)

            The type of KMS key that is used to encrypt studio data.

            Possible values include:
            • "AWS_OWNED_KEY"
            • "CUSTOMER_MANAGED_KEY"
        • studioId — (String)

          The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.

        • studioName — (String)

          The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.

        • studioUrl — (String)

          The address of the web page for the studio.

        • tags — (map<String>)

          A collection of labels, in the form of key:value pairs, that apply to this resource.

        • updatedAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was updated.

        • userRoleArn — (String)

          The IAM role that studio users assume when logging in to the Nimble Studio portal.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
nimble.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The ARN of the target resource for tagging operations.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • tags — (map<String>)

        A collection of labels, in the form of key:value pairs, that apply to this resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the putLaunchProfileMembers operation

var params = {
  identityStoreId: 'STRING_VALUE', /* required */
  launchProfileId: 'STRING_VALUE', /* required */
  members: [ /* required */
    {
      persona: USER, /* required */
      principalId: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  studioId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
nimble.putLaunchProfileMembers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

      If a token is not provided, the SDK will use a version 4 UUID.
    • identityStoreId — (String)

      The ID of the identity store.

    • launchProfileId — (String)

      The launch profile ID.

    • members — (Array<map>)

      A list of members.

      • personarequired — (String)

        The persona.

        Possible values include:
        • "USER"
      • principalIdrequired — (String)

        The principal ID.

    • studioId — (String)

      The studio ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Add/update users with given persona to studio membership.

Service Reference:

Examples:

Calling the putStudioMembers operation

var params = {
  identityStoreId: 'STRING_VALUE', /* required */
  members: [ /* required */
    {
      persona: ADMINISTRATOR, /* required */
      principalId: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  studioId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
nimble.putStudioMembers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

      If a token is not provided, the SDK will use a version 4 UUID.
    • identityStoreId — (String)

      The ID of the identity store.

    • members — (Array<map>)

      A list of members.

      • personarequired — (String)

        The persona.

        Possible values include:
        • "ADMINISTRATOR"
      • principalIdrequired — (String)

        The principal ID.

    • studioId — (String)

      The studio ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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.

Examples:

Calling the startStudioSSOConfigurationRepair operation

var params = {
  studioId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
nimble.startStudioSSOConfigurationRepair(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

      If a token is not provided, the SDK will use a version 4 UUID.
    • studioId — (String)

      The studio ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • studio — (map)

        Information about a studio.

        • adminRoleArn — (String)

          The IAM role that studio admins assume when logging in to the Nimble Studio portal.

        • arn — (String)

          The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

        • createdAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was created.

        • displayName — (String)

          A friendly name for the studio.

        • homeRegion — (String)

          The AWS region where the studio resource is located.

        • ssoClientId — (String)

          The AWS SSO application client ID used to integrate with AWS SSO to enable AWS SSO users to log in to Nimble portal.

        • state — (String)

          The current state of the studio resource.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "READY"
          • "UPDATE_IN_PROGRESS"
          • "DELETE_IN_PROGRESS"
          • "DELETED"
          • "DELETE_FAILED"
          • "CREATE_FAILED"
          • "UPDATE_FAILED"
        • statusCode — (String)

          Status codes that provide additional detail on the studio state.

          Possible values include:
          • "STUDIO_CREATED"
          • "STUDIO_DELETED"
          • "STUDIO_UPDATED"
          • "STUDIO_CREATE_IN_PROGRESS"
          • "STUDIO_UPDATE_IN_PROGRESS"
          • "STUDIO_DELETE_IN_PROGRESS"
          • "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED"
          • "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED"
          • "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED"
          • "AWS_SSO_NOT_ENABLED"
          • "AWS_SSO_ACCESS_DENIED"
          • "ROLE_NOT_OWNED_BY_STUDIO_OWNER"
          • "ROLE_COULD_NOT_BE_ASSUMED"
          • "INTERNAL_ERROR"
          • "ENCRYPTION_KEY_NOT_FOUND"
          • "ENCRYPTION_KEY_ACCESS_DENIED"
          • "AWS_SSO_CONFIGURATION_REPAIRED"
          • "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS"
        • statusMessage — (String)

          Additional detail on the studio state.

        • studioEncryptionConfiguration — (map)

          Configuration of the encryption method that is used for the studio.

          • keyArn — (String)

            The ARN for a KMS key that is used to encrypt studio data.

          • keyTyperequired — (String)

            The type of KMS key that is used to encrypt studio data.

            Possible values include:
            • "AWS_OWNED_KEY"
            • "CUSTOMER_MANAGED_KEY"
        • studioId — (String)

          The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.

        • studioName — (String)

          The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.

        • studioUrl — (String)

          The address of the web page for the studio.

        • tags — (map<String>)

          A collection of labels, in the form of key:value pairs, that apply to this resource.

        • updatedAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was updated.

        • userRoleArn — (String)

          The IAM role that studio users assume when logging in to the Nimble Studio portal.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Creates tags for a resource, given its ARN.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
nimble.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The ARN of the target resource for tagging operations.

    • tags — (map<String>)

      A collection of labels, in the form of key:value pairs, that apply to this resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Deletes the tags for a resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
nimble.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The ARN of the target resource for tagging operations.

    • tagKeys — (Array<String>)

      An array of tag keys to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Update a launch profile.

Service Reference:

Examples:

Calling the updateLaunchProfile operation

var params = {
  launchProfileId: 'STRING_VALUE', /* required */
  studioId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  launchProfileProtocolVersions: [
    'STRING_VALUE',
    /* more items */
  ],
  name: 'STRING_VALUE',
  streamConfiguration: {
    clipboardMode: ENABLED | DISABLED, /* required */
    ec2InstanceTypes: [ /* required */
      g4dn.xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.12xlarge | g4dn.16xlarge,
      /* more items */
    ],
    streamingImageIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    maxSessionLengthInMinutes: 'NUMBER_VALUE'
  },
  studioComponentIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
nimble.updateLaunchProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

      If a token is not provided, the SDK will use a version 4 UUID.
    • description — (String)

      The description.

    • launchProfileId — (String)

      The launch profile ID.

    • launchProfileProtocolVersions — (Array<String>)

      The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".

    • name — (String)

      The name for the launch profile.

    • streamConfiguration — (map)

      A configuration for a streaming session.

      • clipboardModerequired — (String)

        Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • ec2InstanceTypesrequired — (Array<String>)

        The EC2 instance types that users can select from when launching a streaming session with this launch profile.

      • maxSessionLengthInMinutes — (Integer)

        The length of time, in minutes, that a streaming session can run. After this point, Nimble Studio automatically terminates the session.

      • streamingImageIdsrequired — (Array<String>)

        The streaming images that users can select from when launching a streaming session with this launch profile.

    • studioComponentIds — (Array<String>)

      Unique identifiers for a collection of studio components that can be used with this launch profile.

    • studioId — (String)

      The studio ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • launchProfile — (map)

        The launch profile.

        • arn — (String)

          The ARN of the resource.

        • createdAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was created.

        • createdBy — (String)

          The user ID of the user that created the launch profile.

        • description — (String)

          A human-readable description of the launch profile.

        • ec2SubnetIds — (Array<String>)

          Unique identifiers for a collection of EC2 subnets.

        • launchProfileId — (String)

          The launch profile ID.

        • launchProfileProtocolVersions — (Array<String>)

          The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".

        • name — (String)

          A friendly name for the launch profile.

        • state — (String)

          The current state.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "READY"
          • "UPDATE_IN_PROGRESS"
          • "DELETE_IN_PROGRESS"
          • "DELETED"
          • "DELETE_FAILED"
          • "CREATE_FAILED"
          • "UPDATE_FAILED"
        • statusCode — (String)

          The status code.

          Possible values include:
          • "LAUNCH_PROFILE_CREATED"
          • "LAUNCH_PROFILE_UPDATED"
          • "LAUNCH_PROFILE_DELETED"
          • "LAUNCH_PROFILE_CREATE_IN_PROGRESS"
          • "LAUNCH_PROFILE_UPDATE_IN_PROGRESS"
          • "LAUNCH_PROFILE_DELETE_IN_PROGRESS"
          • "INTERNAL_ERROR"
          • "STREAMING_IMAGE_NOT_FOUND"
          • "STREAMING_IMAGE_NOT_READY"
          • "LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED"
          • "ENCRYPTION_KEY_ACCESS_DENIED"
          • "ENCRYPTION_KEY_NOT_FOUND"
          • "INVALID_SUBNETS_PROVIDED"
        • statusMessage — (String)

          The status message for the launch profile.

        • streamConfiguration — (map)

          A configuration for a streaming session.

          • clipboardMode — (String)

            Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
          • ec2InstanceTypes — (Array<String>)

            The EC2 instance types that users can select from when launching a streaming session with this launch profile.

          • maxSessionLengthInMinutes — (Integer)

            The length of time, in minutes, that a streaming session can run. After this point, Nimble Studio automatically terminates the session.

          • streamingImageIds — (Array<String>)

            The streaming images that users can select from when launching a streaming session with this launch profile.

        • studioComponentIds — (Array<String>)

          Unique identifiers for a collection of studio components that can be used with this launch profile.

        • tags — (map<String>)

          A collection of labels, in the form of key:value pairs, that apply to this resource.

        • updatedAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was updated.

        • updatedBy — (String)

          The user ID of the user that most recently updated the resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Update a user persona in launch profile membership.

Service Reference:

Examples:

Calling the updateLaunchProfileMember operation

var params = {
  launchProfileId: 'STRING_VALUE', /* required */
  persona: USER, /* required */
  principalId: 'STRING_VALUE', /* required */
  studioId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
nimble.updateLaunchProfileMember(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

      If a token is not provided, the SDK will use a version 4 UUID.
    • launchProfileId — (String)

      The launch profile ID.

    • persona — (String)

      The persona.

      Possible values include:
      • "USER"
    • principalId — (String)

      The principal ID.

    • studioId — (String)

      The studio ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • member — (map)

        The member.

        • identityStoreId — (String)

          The ID of the identity store.

        • persona — (String)

          The persona.

          Possible values include:
          • "USER"
        • principalId — (String)

          The principal ID.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Update streaming image.

Service Reference:

Examples:

Calling the updateStreamingImage operation

var params = {
  streamingImageId: 'STRING_VALUE', /* required */
  studioId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  name: 'STRING_VALUE'
};
nimble.updateStreamingImage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

      If a token is not provided, the SDK will use a version 4 UUID.
    • description — (String)

      The description.

    • name — (String)

      The name for the streaming image.

    • streamingImageId — (String)

      The streaming image ID.

    • studioId — (String)

      The studio ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • streamingImage — (map)

        • arn — (String)

          The ARN of the resource.

        • description — (String)

          A human-readable description of the streaming image.

        • ec2ImageId — (String)

          The ID of an EC2 machine image with which to create the streaming image.

        • encryptionConfiguration — (map)

          The encryption configuration.

          • keyArn — (String)

            The ARN for a KMS key that is used to encrypt studio data.

          • keyTyperequired — (String)

            The type of KMS key that is used to encrypt studio data.

            Possible values include:
            • "CUSTOMER_MANAGED_KEY"
        • eulaIds — (Array<String>)

          The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.

        • name — (String)

          A friendly name for a streaming image resource.

        • owner — (String)

          The owner of the streaming image, either the studioId that contains the streaming image, or 'amazon' for images that are provided by Amazon Nimble Studio.

        • platform — (String)

          The platform of the streaming image, either WINDOWS or LINUX.

        • state — (String)

          The current state.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "READY"
          • "DELETE_IN_PROGRESS"
          • "DELETED"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_FAILED"
          • "CREATE_FAILED"
          • "DELETE_FAILED"
        • statusCode — (String)

          The status code.

          Possible values include:
          • "STREAMING_IMAGE_CREATE_IN_PROGRESS"
          • "STREAMING_IMAGE_READY"
          • "STREAMING_IMAGE_DELETE_IN_PROGRESS"
          • "STREAMING_IMAGE_DELETED"
          • "STREAMING_IMAGE_UPDATE_IN_PROGRESS"
          • "INTERNAL_ERROR"
        • statusMessage — (String)

          The status message for the streaming image.

        • streamingImageId — (String)

          The ID of the streaming image.

        • tags — (map<String>)

          A collection of labels, in the form of key:value pairs, that apply to this resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Update a Studio resource.

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

Service Reference:

Examples:

Calling the updateStudio operation

var params = {
  studioId: 'STRING_VALUE', /* required */
  adminRoleArn: 'STRING_VALUE',
  clientToken: 'STRING_VALUE',
  displayName: 'STRING_VALUE',
  userRoleArn: 'STRING_VALUE'
};
nimble.updateStudio(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • adminRoleArn — (String)

      The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.

    • clientToken — (String)

      To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

      If a token is not provided, the SDK will use a version 4 UUID.
    • displayName — (String)

      A friendly name for the studio.

    • studioId — (String)

      The studio ID.

    • userRoleArn — (String)

      The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • studio — (map)

        Information about a studio.

        • adminRoleArn — (String)

          The IAM role that studio admins assume when logging in to the Nimble Studio portal.

        • arn — (String)

          The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

        • createdAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was created.

        • displayName — (String)

          A friendly name for the studio.

        • homeRegion — (String)

          The AWS region where the studio resource is located.

        • ssoClientId — (String)

          The AWS SSO application client ID used to integrate with AWS SSO to enable AWS SSO users to log in to Nimble portal.

        • state — (String)

          The current state of the studio resource.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "READY"
          • "UPDATE_IN_PROGRESS"
          • "DELETE_IN_PROGRESS"
          • "DELETED"
          • "DELETE_FAILED"
          • "CREATE_FAILED"
          • "UPDATE_FAILED"
        • statusCode — (String)

          Status codes that provide additional detail on the studio state.

          Possible values include:
          • "STUDIO_CREATED"
          • "STUDIO_DELETED"
          • "STUDIO_UPDATED"
          • "STUDIO_CREATE_IN_PROGRESS"
          • "STUDIO_UPDATE_IN_PROGRESS"
          • "STUDIO_DELETE_IN_PROGRESS"
          • "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED"
          • "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED"
          • "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED"
          • "AWS_SSO_NOT_ENABLED"
          • "AWS_SSO_ACCESS_DENIED"
          • "ROLE_NOT_OWNED_BY_STUDIO_OWNER"
          • "ROLE_COULD_NOT_BE_ASSUMED"
          • "INTERNAL_ERROR"
          • "ENCRYPTION_KEY_NOT_FOUND"
          • "ENCRYPTION_KEY_ACCESS_DENIED"
          • "AWS_SSO_CONFIGURATION_REPAIRED"
          • "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS"
        • statusMessage — (String)

          Additional detail on the studio state.

        • studioEncryptionConfiguration — (map)

          Configuration of the encryption method that is used for the studio.

          • keyArn — (String)

            The ARN for a KMS key that is used to encrypt studio data.

          • keyTyperequired — (String)

            The type of KMS key that is used to encrypt studio data.

            Possible values include:
            • "AWS_OWNED_KEY"
            • "CUSTOMER_MANAGED_KEY"
        • studioId — (String)

          The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.

        • studioName — (String)

          The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.

        • studioUrl — (String)

          The address of the web page for the studio.

        • tags — (map<String>)

          A collection of labels, in the form of key:value pairs, that apply to this resource.

        • updatedAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was updated.

        • userRoleArn — (String)

          The IAM role that studio users assume when logging in to the Nimble Studio portal.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Updates a studio component resource.

Service Reference:

Examples:

Calling the updateStudioComponent operation

var params = {
  studioComponentId: 'STRING_VALUE', /* required */
  studioId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  configuration: {
    activeDirectoryConfiguration: {
      computerAttributes: [
        {
          name: 'STRING_VALUE',
          value: 'STRING_VALUE'
        },
        /* more items */
      ],
      directoryId: 'STRING_VALUE',
      organizationalUnitDistinguishedName: 'STRING_VALUE'
    },
    computeFarmConfiguration: {
      activeDirectoryUser: 'STRING_VALUE',
      endpoint: 'STRING_VALUE'
    },
    licenseServiceConfiguration: {
      endpoint: 'STRING_VALUE'
    },
    sharedFileSystemConfiguration: {
      endpoint: 'STRING_VALUE',
      fileSystemId: 'STRING_VALUE',
      linuxMountPoint: 'STRING_VALUE',
      shareName: 'STRING_VALUE',
      windowsMountDrive: 'STRING_VALUE'
    }
  },
  description: 'STRING_VALUE',
  ec2SecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  initializationScripts: [
    {
      launchProfileProtocolVersion: 'STRING_VALUE',
      platform: LINUX | WINDOWS,
      runContext: SYSTEM_INITIALIZATION | USER_INITIALIZATION,
      script: 'STRING_VALUE'
    },
    /* more items */
  ],
  name: 'STRING_VALUE',
  scriptParameters: [
    {
      key: 'STRING_VALUE',
      value: 'STRING_VALUE'
    },
    /* more items */
  ],
  subtype: AWS_MANAGED_MICROSOFT_AD | AMAZON_FSX_FOR_WINDOWS | AMAZON_FSX_FOR_LUSTRE | CUSTOM,
  type: ACTIVE_DIRECTORY | SHARED_FILE_SYSTEM | COMPUTE_FARM | LICENSE_SERVICE | CUSTOM
};
nimble.updateStudioComponent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

      If a token is not provided, the SDK will use a version 4 UUID.
    • configuration — (map)

      The configuration of the studio component, based on component type.

      • activeDirectoryConfiguration — (map)

        The configuration for a Microsoft Active Directory (Microsoft AD) studio resource.

        • computerAttributes — (Array<map>)

          A collection of custom attributes for an Active Directory computer.

          • name — (String)

            The name for the LDAP attribute.

          • value — (String)

            The value for the LDAP attribute.

        • directoryId — (String)

          The directory ID of the AWS Directory Service for Microsoft AD to access using this studio component.

        • organizationalUnitDistinguishedName — (String)

          The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.

      • computeFarmConfiguration — (map)

        The configuration for a render farm that is associated with a studio resource.

        • activeDirectoryUser — (String)

          The name of an Active Directory user that is used on ComputeFarm worker instances.

        • endpoint — (String)

          The endpoint of the ComputeFarm that is accessed by the studio component resource.

      • licenseServiceConfiguration — (map)

        The configuration for a license service that is associated with a studio resource.

        • endpoint — (String)

          The endpoint of the license service that is accessed by the studio component resource.

      • sharedFileSystemConfiguration — (map)

        The configuration for a shared file storage system that is associated with a studio resource.

        • endpoint — (String)

          The endpoint of the shared file system that is accessed by the studio component resource.

        • fileSystemId — (String)

          The unique identifier for a file system.

        • linuxMountPoint — (String)

          The mount location for a shared file system on a Linux virtual workstation.

        • shareName — (String)

          The name of the file share.

        • windowsMountDrive — (String)

          The mount location for a shared file system on a Windows virtual workstation.

    • description — (String)

      The description.

    • ec2SecurityGroupIds — (Array<String>)

      The EC2 security groups that control access to the studio component.

    • initializationScripts — (Array<map>)

      Initialization scripts for studio components.

      • launchProfileProtocolVersion — (String)

        The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".

      • platform — (String)

        The platform of the initialization script, either WINDOWS or LINUX.

        Possible values include:
        • "LINUX"
        • "WINDOWS"
      • runContext — (String)

        The method to use when running the initialization script.

        Possible values include:
        • "SYSTEM_INITIALIZATION"
        • "USER_INITIALIZATION"
      • script — (String)

        The initialization script.

    • name — (String)

      The name for the studio component.

    • scriptParameters — (Array<map>)

      Parameters for the studio component scripts.

      • key — (String)

        A script parameter key.

      • value — (String)

        A script parameter value.

    • studioComponentId — (String)

      The studio component ID.

    • studioId — (String)

      The studio ID.

    • subtype — (String)

      The specific subtype of a studio component.

      Possible values include:
      • "AWS_MANAGED_MICROSOFT_AD"
      • "AMAZON_FSX_FOR_WINDOWS"
      • "AMAZON_FSX_FOR_LUSTRE"
      • "CUSTOM"
    • type — (String)

      The type of the studio component.

      Possible values include:
      • "ACTIVE_DIRECTORY"
      • "SHARED_FILE_SYSTEM"
      • "COMPUTE_FARM"
      • "LICENSE_SERVICE"
      • "CUSTOM"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • studioComponent — (map)

        Information about the studio component.

        • arn — (String)

          The ARN of the resource.

        • configuration — (map)

          The configuration of the studio component, based on component type.

          • activeDirectoryConfiguration — (map)

            The configuration for a Microsoft Active Directory (Microsoft AD) studio resource.

            • computerAttributes — (Array<map>)

              A collection of custom attributes for an Active Directory computer.

              • name — (String)

                The name for the LDAP attribute.

              • value — (String)

                The value for the LDAP attribute.

            • directoryId — (String)

              The directory ID of the AWS Directory Service for Microsoft AD to access using this studio component.

            • organizationalUnitDistinguishedName — (String)

              The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.

          • computeFarmConfiguration — (map)

            The configuration for a render farm that is associated with a studio resource.

            • activeDirectoryUser — (String)

              The name of an Active Directory user that is used on ComputeFarm worker instances.

            • endpoint — (String)

              The endpoint of the ComputeFarm that is accessed by the studio component resource.

          • licenseServiceConfiguration — (map)

            The configuration for a license service that is associated with a studio resource.

            • endpoint — (String)

              The endpoint of the license service that is accessed by the studio component resource.

          • sharedFileSystemConfiguration — (map)

            The configuration for a shared file storage system that is associated with a studio resource.

            • endpoint — (String)

              The endpoint of the shared file system that is accessed by the studio component resource.

            • fileSystemId — (String)

              The unique identifier for a file system.

            • linuxMountPoint — (String)

              The mount location for a shared file system on a Linux virtual workstation.

            • shareName — (String)

              The name of the file share.

            • windowsMountDrive — (String)

              The mount location for a shared file system on a Windows virtual workstation.

        • createdAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was created.

        • createdBy — (String)

          The user ID of the user that created the studio component.

        • description — (String)

          A human-readable description for the studio component resource.

        • ec2SecurityGroupIds — (Array<String>)

          The EC2 security groups that control access to the studio component.

        • initializationScripts — (Array<map>)

          Initialization scripts for studio components.

          • launchProfileProtocolVersion — (String)

            The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".

          • platform — (String)

            The platform of the initialization script, either WINDOWS or LINUX.

            Possible values include:
            • "LINUX"
            • "WINDOWS"
          • runContext — (String)

            The method to use when running the initialization script.

            Possible values include:
            • "SYSTEM_INITIALIZATION"
            • "USER_INITIALIZATION"
          • script — (String)

            The initialization script.

        • name — (String)

          A friendly name for the studio component resource.

        • scriptParameters — (Array<map>)

          Parameters for the studio component scripts.

          • key — (String)

            A script parameter key.

          • value — (String)

            A script parameter value.

        • state — (String)

          The current state.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "READY"
          • "UPDATE_IN_PROGRESS"
          • "DELETE_IN_PROGRESS"
          • "DELETED"
          • "DELETE_FAILED"
          • "CREATE_FAILED"
          • "UPDATE_FAILED"
        • statusCode — (String)

          The status code.

          Possible values include:
          • "ACTIVE_DIRECTORY_ALREADY_EXISTS"
          • "STUDIO_COMPONENT_CREATED"
          • "STUDIO_COMPONENT_UPDATED"
          • "STUDIO_COMPONENT_DELETED"
          • "ENCRYPTION_KEY_ACCESS_DENIED"
          • "ENCRYPTION_KEY_NOT_FOUND"
          • "STUDIO_COMPONENT_CREATE_IN_PROGRESS"
          • "STUDIO_COMPONENT_UPDATE_IN_PROGRESS"
          • "STUDIO_COMPONENT_DELETE_IN_PROGRESS"
          • "INTERNAL_ERROR"
        • statusMessage — (String)

          The status message for the studio component.

        • studioComponentId — (String)

          The unique identifier for a studio component resource.

        • subtype — (String)

          The specific subtype of a studio component.

          Possible values include:
          • "AWS_MANAGED_MICROSOFT_AD"
          • "AMAZON_FSX_FOR_WINDOWS"
          • "AMAZON_FSX_FOR_LUSTRE"
          • "CUSTOM"
        • tags — (map<String>)

          A collection of labels, in the form of key:value pairs, that apply to this resource.

        • type — (String)

          The type of the studio component.

          Possible values include:
          • "ACTIVE_DIRECTORY"
          • "SHARED_FILE_SYSTEM"
          • "COMPUTE_FARM"
          • "LICENSE_SERVICE"
          • "CUSTOM"
        • updatedAt — (Date)

          The Unix epoch timestamp in seconds for when the resource was updated.

        • updatedBy — (String)

          The user ID of the user that most recently updated the resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.