Class: AWS.Nimble

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 | g3.4xlarge | g3s.xlarge | g5.xlarge | g5.2xlarge | g5.4xlarge | g5.8xlarge | g5.16xlarge,
      /* more items */
    ],
    streamingImageIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    automaticTerminationMode: DEACTIVATED | ACTIVATED,
    maxSessionLengthInMinutes: 'NUMBER_VALUE',
    maxStoppedSessionLengthInMinutes: 'NUMBER_VALUE',
    sessionBackup: {
      maxBackupsToRetain: 'NUMBER_VALUE',
      mode: AUTOMATIC | DEACTIVATED
    },
    sessionPersistenceMode: DEACTIVATED | ACTIVATED,
    sessionStorage: {
      mode: [ /* required */
        UPLOAD,
        /* more items */
      ],
      root: {
        linux: 'STRING_VALUE',
        windows: 'STRING_VALUE'
      }
    },
    volumeConfiguration: {
      iops: 'NUMBER_VALUE',
      size: 'NUMBER_VALUE',
      throughput: '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)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

    The description.

  • ec2SubnetIds — (Array<String>)

    Specifies the IDs of the EC2 subnets where streaming sessions will be accessible from. These subnets must support the specified instance types.

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

    • automaticTerminationMode — (String)

      Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.

      • When ACTIVATED, the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes.

      • When DEACTIVATED, the streaming session can remain in the STOPPED state indefinitely.

      This parameter is only allowed when sessionPersistenceMode is ACTIVATED. When allowed, the default value for this parameter is DEACTIVATED.

      Possible values include:
      • "DEACTIVATED"
      • "ACTIVATED"
    • clipboardMode — required — (String)

      Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • ec2InstanceTypes — required — (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 be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.

    • maxStoppedSessionLengthInMinutes — (Integer)

      Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.

      This field is allowed only when sessionPersistenceMode is ACTIVATED and automaticTerminationMode is ACTIVATED.

      If the value is set to 0, your sessions can’t be STOPPED. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated (instead of STOPPED).

      If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped (instead of terminated).

    • sessionBackup — (map)

      Configures how streaming sessions are backed up when launched from this launch profile.

      • maxBackupsToRetain — (Integer)

        The maximum number of backups that each streaming session created from this launch profile can have.

      • mode — (String)

        Specifies how artists sessions are backed up.

        Configures backups for streaming sessions launched with this launch profile. The default value is DEACTIVATED, which means that backups are deactivated. To allow backups, set this value to AUTOMATIC.

        Possible values include:
        • "AUTOMATIC"
        • "DEACTIVATED"
    • sessionPersistenceMode — (String)

      Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

      Possible values include:
      • "DEACTIVATED"
      • "ACTIVATED"
    • sessionStorage — (map)

      The upload storage for a streaming workstation that is created using this launch profile.

      • mode — required — (Array<String>)

        Allows artists to upload files to their workstations. The only valid option is UPLOAD.

      • root — (map)

        The configuration for the upload storage root of the streaming session.

        • linux — (String)

          The folder path in Linux workstations where files are uploaded.

        • windows — (String)

          The folder path in Windows workstations where files are uploaded.

    • streamingImageIds — required — (Array<String>)

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

    • volumeConfiguration — (map)

      Custom volume configuration for the root volumes that are attached to streaming sessions.

      This parameter is only allowed when sessionPersistenceMode is ACTIVATED.

      • iops — (Integer)

        The number of I/O operations per second for the root volume that is attached to streaming session.

      • size — (Integer)

        The size of the root volume that is attached to the streaming session. The root volume size is measured in GiBs.

      • throughput — (Integer)

        The throughput to provision for the root volume that is attached to the streaming session. The throughput is measured in MiB/s.

  • 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 Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

      • createdAt — (Date)

        The ISO 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 ID of the launch profile used to control access from the streaming session.

      • 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"
        • "INVALID_INSTANCE_TYPES_PROVIDED"
        • "INVALID_SUBNETS_COMBINATION"
      • statusMessage — (String)

        The status message for the launch profile.

      • streamConfiguration — (map)

        A configuration for a streaming session.

        • automaticTerminationMode — (String)

          Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.

          • When ACTIVATED, the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes.

          • When DEACTIVATED, the streaming session can remain in the STOPPED state indefinitely.

          This parameter is only allowed when sessionPersistenceMode is ACTIVATED. When allowed, the default value for this parameter is DEACTIVATED.

          Possible values include:
          • "DEACTIVATED"
          • "ACTIVATED"
        • clipboardMode — required — (String)

          Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
        • ec2InstanceTypes — required — (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 be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.

        • maxStoppedSessionLengthInMinutes — (Integer)

          Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.

          This field is allowed only when sessionPersistenceMode is ACTIVATED and automaticTerminationMode is ACTIVATED.

          If the value is set to 0, your sessions can’t be STOPPED. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated (instead of STOPPED).

          If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped (instead of terminated).

        • sessionBackup — (map)

          Information about the streaming session backup.

          • maxBackupsToRetain — (Integer)

            The maximum number of backups that each streaming session created from this launch profile can have.

          • mode — (String)

            Specifies how artists sessions are backed up.

            Configures backups for streaming sessions launched with this launch profile. The default value is DEACTIVATED, which means that backups are deactivated. To allow backups, set this value to AUTOMATIC.

            Possible values include:
            • "AUTOMATIC"
            • "DEACTIVATED"
        • sessionPersistenceMode — (String)

          Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

          Possible values include:
          • "DEACTIVATED"
          • "ACTIVATED"
        • sessionStorage — (map)

          The upload storage for a streaming session.

          • mode — required — (Array<String>)

            Allows artists to upload files to their workstations. The only valid option is UPLOAD.

          • root — (map)

            The configuration for the upload storage root of the streaming session.

            • linux — (String)

              The folder path in Linux workstations where files are uploaded.

            • windows — (String)

              The folder path in Windows workstations where files are uploaded.

        • streamingImageIds — required — (Array<String>)

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

        • volumeConfiguration — (map)

          Custom volume configuration for the root volumes that are attached to streaming sessions.

          This parameter is only allowed when sessionPersistenceMode is ACTIVATED.

          • iops — (Integer)

            The number of I/O operations per second for the root volume that is attached to streaming session.

          • size — (Integer)

            The size of the root volume that is attached to the streaming session. The root volume size is measured in GiBs.

          • throughput — (Integer)

            The throughput to provision for the root volume that is attached to the streaming session. The throughput is measured in MiB/s.

      • 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 ISO timestamp in seconds for when the resource was updated.

      • updatedBy — (String)

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

      • validationResults — (Array<map>)

        The list of the latest validation results.

        • state — required — (String)

          The current state.

          Possible values include:
          • "VALIDATION_NOT_STARTED"
          • "VALIDATION_IN_PROGRESS"
          • "VALIDATION_SUCCESS"
          • "VALIDATION_FAILED"
          • "VALIDATION_FAILED_INTERNAL_SERVER_ERROR"
        • statusCode — required — (String)

          The status code. This will contain the failure reason if the state is VALIDATION_FAILED.

          Possible values include:
          • "VALIDATION_NOT_STARTED"
          • "VALIDATION_IN_PROGRESS"
          • "VALIDATION_SUCCESS"
          • "VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION"
          • "VALIDATION_FAILED_SUBNET_NOT_FOUND"
          • "VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION"
          • "VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY"
          • "VALIDATION_FAILED_UNAUTHORIZED"
          • "VALIDATION_FAILED_INTERNAL_SERVER_ERROR"
        • statusMessage — required — (String)

          The status message for the validation result.

        • type — required — (String)

          The type of the validation result.

          Possible values include:
          • "VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT"
          • "VALIDATE_SUBNET_ASSOCIATION"
          • "VALIDATE_NETWORK_ACL_ASSOCIATION"
          • "VALIDATE_SECURITY_GROUP_ASSOCIATION"

Returns:

• (AWS.Request) —

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

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)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

    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)

      The streaming image.

      • arn — (String)

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

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

        • keyType — required — (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"
        • "ACCESS_DENIED"
      • 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.

var params = {
  launchProfileId: 'STRING_VALUE', /* required */
  studioId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  ec2InstanceType: g4dn.xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.12xlarge | g4dn.16xlarge | g3.4xlarge | g3s.xlarge | g5.xlarge | g5.2xlarge | g5.4xlarge | g5.8xlarge | g5.16xlarge,
  ownedBy: '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)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

    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"
    • "g3.4xlarge"
    • "g3s.xlarge"
    • "g5.xlarge"
    • "g5.2xlarge"
    • "g5.4xlarge"
    • "g5.8xlarge"
    • "g5.16xlarge"
  • launchProfileId — (String)

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

  • ownedBy — (String)

    The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.

  • 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 Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

      • automaticTerminationMode — (String)

        Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.

        • When ACTIVATED, the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes.

        • When DEACTIVATED, the streaming session can remain in the STOPPED state indefinitely.

        This parameter is only allowed when sessionPersistenceMode is ACTIVATED. When allowed, the default value for this parameter is DEACTIVATED.

        Possible values include:
        • "DEACTIVATED"
        • "ACTIVATED"
      • backupMode — (String)

        Shows the current backup setting of the session.

        Possible values include:
        • "AUTOMATIC"
        • "DEACTIVATED"
      • createdAt — (Date)

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

      • maxBackupsToRetain — (Integer)

        The maximum number of backups of a streaming session that you can have. When the maximum number of backups is reached, the oldest backup is deleted.

      • ownedBy — (String)

        The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.

      • sessionId — (String)

        The session ID.

      • sessionPersistenceMode — (String)

        Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

        Possible values include:
        • "DEACTIVATED"
        • "ACTIVATED"
      • startedAt — (Date)

        The time the session entered START_IN_PROGRESS state.

      • startedBy — (String)

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

      • startedFromBackupId — (String)

        The backup ID used to restore a streaming session.

      • state — (String)

        The current state.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "DELETE_IN_PROGRESS"
        • "READY"
        • "DELETED"
        • "CREATE_FAILED"
        • "DELETE_FAILED"
        • "STOP_IN_PROGRESS"
        • "START_IN_PROGRESS"
        • "STOPPED"
        • "STOP_FAILED"
        • "START_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"
        • "STREAMING_SESSION_STOPPED"
        • "STREAMING_SESSION_STARTED"
        • "STREAMING_SESSION_STOP_IN_PROGRESS"
        • "STREAMING_SESSION_START_IN_PROGRESS"
        • "AMI_VALIDATION_ERROR"
      • statusMessage — (String)

        The status message for the streaming session.

      • stopAt — (Date)

        The time the streaming session will automatically be stopped if the user doesn’t stop the session themselves.

      • stoppedAt — (Date)

        The time the session entered STOP_IN_PROGRESS state.

      • stoppedBy — (String)

        The user ID of the user that stopped 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 ISO timestamp in seconds for when the resource was updated.

      • updatedBy — (String)

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

      • volumeConfiguration — (map)

        Custom volume configuration for the root volumes that are attached to streaming sessions.

        This parameter is only allowed when sessionPersistenceMode is ACTIVATED.

        • iops — (Integer)

          The number of I/O operations per second for the root volume that is attached to streaming session.

        • size — (Integer)

          The size of the root volume that is attached to the streaming session. The root volume size is measured in GiBs.

        • throughput — (Integer)

          The throughput to provision for the root volume that is attached to the streaming session. The throughput is measured in MiB/s.

      • volumeRetentionMode — (String)

        Determine if an EBS volume created from this streaming session will be backed up.

        Possible values include:
        • "RETAIN"
        • "DELETE"

Returns:

• (AWS.Request) —

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

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)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

    The expiration time in seconds.

  • sessionId — (String)

    The streaming 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 ISO 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 ISO timestamp in seconds for when the resource expires.

      • ownedBy — (String)

        The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.

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

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)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

    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.

    • keyType — required — (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 ISO timestamp in seconds for when the resource was created.

      • displayName — (String)

        A friendly name for the studio.

      • homeRegion — (String)

        The Amazon Web Services Region where the studio resource is located.

      • ssoClientId — (String)

        The IAM Identity Center application client ID used to integrate with IAM Identity Center. This ID allows IAM Identity Center users to log in to Nimble Studio 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"
        • "AWS_STS_REGION_DISABLED"
      • 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.

        • keyType — required — (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 ISO 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.

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 */
  ],
  runtimeRoleArn: 'STRING_VALUE',
  scriptParameters: [
    {
      key: 'STRING_VALUE',
      value: 'STRING_VALUE'
    },
    /* more items */
  ],
  secureInitializationRoleArn: 'STRING_VALUE',
  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)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

    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 Directory Service for Microsoft Active Directory 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 Directory Service for Microsoft Active Directory 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.

  • runtimeRoleArn — (String)

    An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.

  • scriptParameters — (Array<map>)

    Parameters for the studio component scripts.

    • key — (String)

      A script parameter key.

    • value — (String)

      A script parameter value.

  • secureInitializationRoleArn — (String)

    An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.

  • 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 Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

      • configuration — (map)

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

        • activeDirectoryConfiguration — (map)

          The configuration for a Directory Service for Microsoft Active Directory 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 Directory Service for Microsoft Active Directory 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 ISO 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.

      • runtimeRoleArn — (String)

        An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.

      • scriptParameters — (Array<map>)

        Parameters for the studio component scripts.

        • key — (String)

          A script parameter key.

        • value — (String)

          A script parameter value.

      • secureInitializationRoleArn — (String)

        An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.

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

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)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

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

  • 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 Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

      • createdAt — (Date)

        The ISO 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 ID of the launch profile used to control access from the streaming session.

      • 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"
        • "INVALID_INSTANCE_TYPES_PROVIDED"
        • "INVALID_SUBNETS_COMBINATION"
      • statusMessage — (String)

        The status message for the launch profile.

      • streamConfiguration — (map)

        A configuration for a streaming session.

        • automaticTerminationMode — (String)

          Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.

          • When ACTIVATED, the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes.

          • When DEACTIVATED, the streaming session can remain in the STOPPED state indefinitely.

          This parameter is only allowed when sessionPersistenceMode is ACTIVATED. When allowed, the default value for this parameter is DEACTIVATED.

          Possible values include:
          • "DEACTIVATED"
          • "ACTIVATED"
        • clipboardMode — required — (String)

          Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
        • ec2InstanceTypes — required — (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 be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.

        • maxStoppedSessionLengthInMinutes — (Integer)

          Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.

          This field is allowed only when sessionPersistenceMode is ACTIVATED and automaticTerminationMode is ACTIVATED.

          If the value is set to 0, your sessions can’t be STOPPED. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated (instead of STOPPED).

          If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped (instead of terminated).

        • sessionBackup — (map)

          Information about the streaming session backup.

          • maxBackupsToRetain — (Integer)

            The maximum number of backups that each streaming session created from this launch profile can have.

          • mode — (String)

            Specifies how artists sessions are backed up.

            Configures backups for streaming sessions launched with this launch profile. The default value is DEACTIVATED, which means that backups are deactivated. To allow backups, set this value to AUTOMATIC.

            Possible values include:
            • "AUTOMATIC"
            • "DEACTIVATED"
        • sessionPersistenceMode — (String)

          Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

          Possible values include:
          • "DEACTIVATED"
          • "ACTIVATED"
        • sessionStorage — (map)

          The upload storage for a streaming session.

          • mode — required — (Array<String>)

            Allows artists to upload files to their workstations. The only valid option is UPLOAD.

          • root — (map)

            The configuration for the upload storage root of the streaming session.

            • linux — (String)

              The folder path in Linux workstations where files are uploaded.

            • windows — (String)

              The folder path in Windows workstations where files are uploaded.

        • streamingImageIds — required — (Array<String>)

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

        • volumeConfiguration — (map)

          Custom volume configuration for the root volumes that are attached to streaming sessions.

          This parameter is only allowed when sessionPersistenceMode is ACTIVATED.

          • iops — (Integer)

            The number of I/O operations per second for the root volume that is attached to streaming session.

          • size — (Integer)

            The size of the root volume that is attached to the streaming session. The root volume size is measured in GiBs.

          • throughput — (Integer)

            The throughput to provision for the root volume that is attached to the streaming session. The throughput is measured in MiB/s.

      • 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 ISO timestamp in seconds for when the resource was updated.

      • updatedBy — (String)

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

      • validationResults — (Array<map>)

        The list of the latest validation results.

        • state — required — (String)

          The current state.

          Possible values include:
          • "VALIDATION_NOT_STARTED"
          • "VALIDATION_IN_PROGRESS"
          • "VALIDATION_SUCCESS"
          • "VALIDATION_FAILED"
          • "VALIDATION_FAILED_INTERNAL_SERVER_ERROR"
        • statusCode — required — (String)

          The status code. This will contain the failure reason if the state is VALIDATION_FAILED.

          Possible values include:
          • "VALIDATION_NOT_STARTED"
          • "VALIDATION_IN_PROGRESS"
          • "VALIDATION_SUCCESS"
          • "VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION"
          • "VALIDATION_FAILED_SUBNET_NOT_FOUND"
          • "VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION"
          • "VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY"
          • "VALIDATION_FAILED_UNAUTHORIZED"
          • "VALIDATION_FAILED_INTERNAL_SERVER_ERROR"
        • statusMessage — required — (String)

          The status message for the validation result.

        • type — required — (String)

          The type of the validation result.

          Possible values include:
          • "VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT"
          • "VALIDATE_SUBNET_ASSOCIATION"
          • "VALIDATE_NETWORK_ACL_ASSOCIATION"
          • "VALIDATE_SECURITY_GROUP_ASSOCIATION"

Returns:

• (AWS.Request) —

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

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)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

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

  • principalId — (String)

    The principal ID. This currently supports a IAM Identity Center UserId.

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

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)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

    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 Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

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

        • keyType — required — (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"
        • "ACCESS_DENIED"
      • 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.

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)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

    The streaming 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 Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

      • automaticTerminationMode — (String)

        Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.

        • When ACTIVATED, the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes.

        • When DEACTIVATED, the streaming session can remain in the STOPPED state indefinitely.

        This parameter is only allowed when sessionPersistenceMode is ACTIVATED. When allowed, the default value for this parameter is DEACTIVATED.

        Possible values include:
        • "DEACTIVATED"
        • "ACTIVATED"
      • backupMode — (String)

        Shows the current backup setting of the session.

        Possible values include:
        • "AUTOMATIC"
        • "DEACTIVATED"
      • createdAt — (Date)

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

      • maxBackupsToRetain — (Integer)

        The maximum number of backups of a streaming session that you can have. When the maximum number of backups is reached, the oldest backup is deleted.

      • ownedBy — (String)

        The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.

      • sessionId — (String)

        The session ID.

      • sessionPersistenceMode — (String)

        Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

        Possible values include:
        • "DEACTIVATED"
        • "ACTIVATED"
      • startedAt — (Date)

        The time the session entered START_IN_PROGRESS state.

      • startedBy — (String)

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

      • startedFromBackupId — (String)

        The backup ID used to restore a streaming session.

      • state — (String)

        The current state.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "DELETE_IN_PROGRESS"
        • "READY"
        • "DELETED"
        • "CREATE_FAILED"
        • "DELETE_FAILED"
        • "STOP_IN_PROGRESS"
        • "START_IN_PROGRESS"
        • "STOPPED"
        • "STOP_FAILED"
        • "START_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"
        • "STREAMING_SESSION_STOPPED"
        • "STREAMING_SESSION_STARTED"
        • "STREAMING_SESSION_STOP_IN_PROGRESS"
        • "STREAMING_SESSION_START_IN_PROGRESS"
        • "AMI_VALIDATION_ERROR"
      • statusMessage — (String)

        The status message for the streaming session.

      • stopAt — (Date)

        The time the streaming session will automatically be stopped if the user doesn’t stop the session themselves.

      • stoppedAt — (Date)

        The time the session entered STOP_IN_PROGRESS state.

      • stoppedBy — (String)

        The user ID of the user that stopped 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 ISO timestamp in seconds for when the resource was updated.

      • updatedBy — (String)

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

      • volumeConfiguration — (map)

        Custom volume configuration for the root volumes that are attached to streaming sessions.

        This parameter is only allowed when sessionPersistenceMode is ACTIVATED.

        • iops — (Integer)

          The number of I/O operations per second for the root volume that is attached to streaming session.

        • size — (Integer)

          The size of the root volume that is attached to the streaming session. The root volume size is measured in GiBs.

        • throughput — (Integer)

          The throughput to provision for the root volume that is attached to the streaming session. The throughput is measured in MiB/s.

      • volumeRetentionMode — (String)

        Determine if an EBS volume created from this streaming session will be backed up.

        Possible values include:
        • "RETAIN"
        • "DELETE"

Returns:

• (AWS.Request) —

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

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)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

    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 ISO timestamp in seconds for when the resource was created.

      • displayName — (String)

        A friendly name for the studio.

      • homeRegion — (String)

        The Amazon Web Services Region where the studio resource is located.

      • ssoClientId — (String)

        The IAM Identity Center application client ID used to integrate with IAM Identity Center. This ID allows IAM Identity Center users to log in to Nimble Studio 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"
        • "AWS_STS_REGION_DISABLED"
      • 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.

        • keyType — required — (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 ISO 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.

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)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

    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 Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

      • configuration — (map)

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

        • activeDirectoryConfiguration — (map)

          The configuration for a Directory Service for Microsoft Active Directory 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 Directory Service for Microsoft Active Directory 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 ISO 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.

      • runtimeRoleArn — (String)

        An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.

      • scriptParameters — (Array<map>)

        Parameters for the studio component scripts.

        • key — (String)

          A script parameter key.

        • value — (String)

          A script parameter value.

      • secureInitializationRoleArn — (String)

        An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.

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

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)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

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

    The principal ID. This currently supports a IAM Identity Center UserId.

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

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 ISO timestamp in seconds for when the resource was created.

      • eulaId — (String)

        The EULA ID.

      • name — (String)

        The name for the EULA.

      • updatedAt — (Date)

        The ISO timestamp in seconds for when the resource was updated.

Returns:

• (AWS.Request) —

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

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 ID of the launch profile used to control access from the streaming session.

  • 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 Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

      • createdAt — (Date)

        The ISO 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 ID of the launch profile used to control access from the streaming session.

      • 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"
        • "INVALID_INSTANCE_TYPES_PROVIDED"
        • "INVALID_SUBNETS_COMBINATION"
      • statusMessage — (String)

        The status message for the launch profile.

      • streamConfiguration — (map)

        A configuration for a streaming session.

        • automaticTerminationMode — (String)

          Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.

          • When ACTIVATED, the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes.

          • When DEACTIVATED, the streaming session can remain in the STOPPED state indefinitely.

          This parameter is only allowed when sessionPersistenceMode is ACTIVATED. When allowed, the default value for this parameter is DEACTIVATED.

          Possible values include:
          • "DEACTIVATED"
          • "ACTIVATED"
        • clipboardMode — required — (String)

          Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
        • ec2InstanceTypes — required — (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 be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.

        • maxStoppedSessionLengthInMinutes — (Integer)

          Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.

          This field is allowed only when sessionPersistenceMode is ACTIVATED and automaticTerminationMode is ACTIVATED.

          If the value is set to 0, your sessions can’t be STOPPED. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated (instead of STOPPED).

          If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped (instead of terminated).

        • sessionBackup — (map)

          Information about the streaming session backup.

          • maxBackupsToRetain — (Integer)

            The maximum number of backups that each streaming session created from this launch profile can have.

          • mode — (String)

            Specifies how artists sessions are backed up.

            Configures backups for streaming sessions launched with this launch profile. The default value is DEACTIVATED, which means that backups are deactivated. To allow backups, set this value to AUTOMATIC.

            Possible values include:
            • "AUTOMATIC"
            • "DEACTIVATED"
        • sessionPersistenceMode — (String)

          Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

          Possible values include:
          • "DEACTIVATED"
          • "ACTIVATED"
        • sessionStorage — (map)

          The upload storage for a streaming session.

          • mode — required — (Array<String>)

            Allows artists to upload files to their workstations. The only valid option is UPLOAD.

          • root — (map)

            The configuration for the upload storage root of the streaming session.

            • linux — (String)

              The folder path in Linux workstations where files are uploaded.

            • windows — (String)

              The folder path in Windows workstations where files are uploaded.

        • streamingImageIds — required — (Array<String>)

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

        • volumeConfiguration — (map)

          Custom volume configuration for the root volumes that are attached to streaming sessions.

          This parameter is only allowed when sessionPersistenceMode is ACTIVATED.

          • iops — (Integer)

            The number of I/O operations per second for the root volume that is attached to streaming session.

          • size — (Integer)

            The size of the root volume that is attached to the streaming session. The root volume size is measured in GiBs.

          • throughput — (Integer)

            The throughput to provision for the root volume that is attached to the streaming session. The throughput is measured in MiB/s.

      • 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 ISO timestamp in seconds for when the resource was updated.

      • updatedBy — (String)

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

      • validationResults — (Array<map>)

        The list of the latest validation results.

        • state — required — (String)

          The current state.

          Possible values include:
          • "VALIDATION_NOT_STARTED"
          • "VALIDATION_IN_PROGRESS"
          • "VALIDATION_SUCCESS"
          • "VALIDATION_FAILED"
          • "VALIDATION_FAILED_INTERNAL_SERVER_ERROR"
        • statusCode — required — (String)

          The status code. This will contain the failure reason if the state is VALIDATION_FAILED.

          Possible values include:
          • "VALIDATION_NOT_STARTED"
          • "VALIDATION_IN_PROGRESS"
          • "VALIDATION_SUCCESS"
          • "VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION"
          • "VALIDATION_FAILED_SUBNET_NOT_FOUND"
          • "VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION"
          • "VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY"
          • "VALIDATION_FAILED_UNAUTHORIZED"
          • "VALIDATION_FAILED_INTERNAL_SERVER_ERROR"
        • statusMessage — required — (String)

          The status message for the validation result.

        • type — required — (String)

          The type of the validation result.

          Possible values include:
          • "VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT"
          • "VALIDATE_SUBNET_ASSOCIATION"
          • "VALIDATE_NETWORK_ACL_ASSOCIATION"
          • "VALIDATE_SECURITY_GROUP_ASSOCIATION"

Returns:

• (AWS.Request) —

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

Waiter Resource States:

• launchProfileDeleted

• launchProfileReady

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 ID of the launch profile used to control access from the streaming session.

  • 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 Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

      • createdAt — (Date)

        The ISO 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 ID of the launch profile used to control access from the streaming session.

      • 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"
        • "INVALID_INSTANCE_TYPES_PROVIDED"
        • "INVALID_SUBNETS_COMBINATION"
      • statusMessage — (String)

        The status message for the launch profile.

      • streamConfiguration — (map)

        A configuration for a streaming session.

        • automaticTerminationMode — (String)

          Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.

          • When ACTIVATED, the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes.

          • When DEACTIVATED, the streaming session can remain in the STOPPED state indefinitely.

          This parameter is only allowed when sessionPersistenceMode is ACTIVATED. When allowed, the default value for this parameter is DEACTIVATED.

          Possible values include:
          • "DEACTIVATED"
          • "ACTIVATED"
        • clipboardMode — required — (String)

          Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
        • ec2InstanceTypes — required — (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 be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.

        • maxStoppedSessionLengthInMinutes — (Integer)

          Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.

          This field is allowed only when sessionPersistenceMode is ACTIVATED and automaticTerminationMode is ACTIVATED.

          If the value is set to 0, your sessions can’t be STOPPED. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated (instead of STOPPED).

          If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped (instead of terminated).

        • sessionBackup — (map)

          Information about the streaming session backup.

          • maxBackupsToRetain — (Integer)

            The maximum number of backups that each streaming session created from this launch profile can have.

          • mode — (String)

            Specifies how artists sessions are backed up.

            Configures backups for streaming sessions launched with this launch profile. The default value is DEACTIVATED, which means that backups are deactivated. To allow backups, set this value to AUTOMATIC.

            Possible values include:
            • "AUTOMATIC"
            • "DEACTIVATED"
        • sessionPersistenceMode — (String)

          Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

          Possible values include:
          • "DEACTIVATED"
          • "ACTIVATED"
        • sessionStorage — (map)

          The upload storage for a streaming session.

          • mode — required — (Array<String>)

            Allows artists to upload files to their workstations. The only valid option is UPLOAD.

          • root — (map)

            The configuration for the upload storage root of the streaming session.

            • linux — (String)

              The folder path in Linux workstations where files are uploaded.

            • windows — (String)

              The folder path in Windows workstations where files are uploaded.

        • streamingImageIds — required — (Array<String>)

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

        • volumeConfiguration — (map)

          Custom volume configuration for the root volumes that are attached to streaming sessions.

          This parameter is only allowed when sessionPersistenceMode is ACTIVATED.

          • iops — (Integer)

            The number of I/O operations per second for the root volume that is attached to streaming session.

          • size — (Integer)

            The size of the root volume that is attached to the streaming session. The root volume size is measured in GiBs.

          • throughput — (Integer)

            The throughput to provision for the root volume that is attached to the streaming session. The throughput is measured in MiB/s.

      • 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 ISO timestamp in seconds for when the resource was updated.

      • updatedBy — (String)

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

      • validationResults — (Array<map>)

        The list of the latest validation results.

        • state — required — (String)

          The current state.

          Possible values include:
          • "VALIDATION_NOT_STARTED"
          • "VALIDATION_IN_PROGRESS"
          • "VALIDATION_SUCCESS"
          • "VALIDATION_FAILED"
          • "VALIDATION_FAILED_INTERNAL_SERVER_ERROR"
        • statusCode — required — (String)

          The status code. This will contain the failure reason if the state is VALIDATION_FAILED.

          Possible values include:
          • "VALIDATION_NOT_STARTED"
          • "VALIDATION_IN_PROGRESS"
          • "VALIDATION_SUCCESS"
          • "VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION"
          • "VALIDATION_FAILED_SUBNET_NOT_FOUND"
          • "VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION"
          • "VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY"
          • "VALIDATION_FAILED_UNAUTHORIZED"
          • "VALIDATION_FAILED_INTERNAL_SERVER_ERROR"
        • statusMessage — required — (String)

          The status message for the validation result.

        • type — required — (String)

          The type of the validation result.

          Possible values include:
          • "VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT"
          • "VALIDATE_SUBNET_ASSOCIATION"
          • "VALIDATE_NETWORK_ACL_ASSOCIATION"
          • "VALIDATE_SECURITY_GROUP_ASSOCIATION"
    • streamingImages — (Array<map>)

      A collection of streaming images.

      • arn — (String)

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

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

        • keyType — required — (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"
        • "ACCESS_DENIED"
      • 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 ISO 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 ISO 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.

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 ID of the launch profile used to control access from the streaming session.

  • launchProfileProtocolVersions — (Array<String>)

    The launch profile protocol versions supported by the client.

  • launchPurpose — (String)

    The launch purpose.

  • platform — (String)

    The platform where this Launch Profile will be used, either Windows or Linux.

  • 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 Directory Service for Microsoft Active Directory 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 ID of the launch profile used to control access from the streaming session.

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

        • runtimeRoleArn — (String)

          An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.

        • script — (String)

          The initialization script.

        • secureInitializationRoleArn — (String)

          An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.

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

        • runtimeRoleArn — (String)

          An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.

        • script — (String)

          The initialization script.

        • secureInitializationRoleArn — (String)

          An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.

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

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 ID of the launch profile used to control access from the streaming session.

  • principalId — (String)

    The principal ID. This currently supports a IAM Identity Center UserId.

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

      • sid — (String)

        The Active Directory Security Identifier for this user, if available.

Returns:

• (AWS.Request) —

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

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 Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

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

        • keyType — required — (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"
        • "ACCESS_DENIED"
      • 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.

Waiter Resource States:

• streamingImageDeleted

• streamingImageReady

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 streaming 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 Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

      • automaticTerminationMode — (String)

        Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.

        • When ACTIVATED, the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes.

        • When DEACTIVATED, the streaming session can remain in the STOPPED state indefinitely.

        This parameter is only allowed when sessionPersistenceMode is ACTIVATED. When allowed, the default value for this parameter is DEACTIVATED.

        Possible values include:
        • "DEACTIVATED"
        • "ACTIVATED"
      • backupMode — (String)

        Shows the current backup setting of the session.

        Possible values include:
        • "AUTOMATIC"
        • "DEACTIVATED"
      • createdAt — (Date)

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

      • maxBackupsToRetain — (Integer)

        The maximum number of backups of a streaming session that you can have. When the maximum number of backups is reached, the oldest backup is deleted.

      • ownedBy — (String)

        The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.

      • sessionId — (String)

        The session ID.

      • sessionPersistenceMode — (String)

        Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

        Possible values include:
        • "DEACTIVATED"
        • "ACTIVATED"
      • startedAt — (Date)

        The time the session entered START_IN_PROGRESS state.

      • startedBy — (String)

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

      • startedFromBackupId — (String)

        The backup ID used to restore a streaming session.

      • state — (String)

        The current state.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "DELETE_IN_PROGRESS"
        • "READY"
        • "DELETED"
        • "CREATE_FAILED"
        • "DELETE_FAILED"
        • "STOP_IN_PROGRESS"
        • "START_IN_PROGRESS"
        • "STOPPED"
        • "STOP_FAILED"
        • "START_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"
        • "STREAMING_SESSION_STOPPED"
        • "STREAMING_SESSION_STARTED"
        • "STREAMING_SESSION_STOP_IN_PROGRESS"
        • "STREAMING_SESSION_START_IN_PROGRESS"
        • "AMI_VALIDATION_ERROR"
      • statusMessage — (String)

        The status message for the streaming session.

      • stopAt — (Date)

        The time the streaming session will automatically be stopped if the user doesn’t stop the session themselves.

      • stoppedAt — (Date)

        The time the session entered STOP_IN_PROGRESS state.

      • stoppedBy — (String)

        The user ID of the user that stopped 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 ISO timestamp in seconds for when the resource was updated.

      • updatedBy — (String)

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

      • volumeConfiguration — (map)

        Custom volume configuration for the root volumes that are attached to streaming sessions.

        This parameter is only allowed when sessionPersistenceMode is ACTIVATED.

        • iops — (Integer)

          The number of I/O operations per second for the root volume that is attached to streaming session.

        • size — (Integer)

          The size of the root volume that is attached to the streaming session. The root volume size is measured in GiBs.

        • throughput — (Integer)

          The throughput to provision for the root volume that is attached to the streaming session. The throughput is measured in MiB/s.

      • volumeRetentionMode — (String)

        Determine if an EBS volume created from this streaming session will be backed up.

        Possible values include:
        • "RETAIN"
        • "DELETE"

Returns:

• (AWS.Request) —

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

Waiter Resource States:

• streamingSessionDeleted

• streamingSessionReady

• streamingSessionStopped

var params = {
  backupId: 'STRING_VALUE', /* required */
  studioId: 'STRING_VALUE' /* required */
};
nimble.getStreamingSessionBackup(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: {}) —
  • backupId — (String)

    The ID of the backup.

  • 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:

    • streamingSessionBackup — (map)

      Information about the streaming session backup.

      • arn — (String)

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

      • backupId — (String)

        The ID of the backup.

      • createdAt — (Date)

        The ISO timestamp in for when the resource was created.

      • launchProfileId — (String)

        The ID of the launch profile which allowed the backups for the streaming session.

      • ownedBy — (String)

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

      • sessionId — (String)

        The streaming session ID for the StreamingSessionBackup.

      • state — (String)

        The streaming session state.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "DELETE_IN_PROGRESS"
        • "READY"
        • "DELETED"
        • "CREATE_FAILED"
        • "DELETE_FAILED"
        • "STOP_IN_PROGRESS"
        • "START_IN_PROGRESS"
        • "STOPPED"
        • "STOP_FAILED"
        • "START_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"
        • "STREAMING_SESSION_STOPPED"
        • "STREAMING_SESSION_STARTED"
        • "STREAMING_SESSION_STOP_IN_PROGRESS"
        • "STREAMING_SESSION_START_IN_PROGRESS"
        • "AMI_VALIDATION_ERROR"
      • statusMessage — (String)

        The status message for the streaming session backup.

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

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 streaming session ID.

  • streamId — (String)

    The streaming session 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 ISO 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 ISO timestamp in seconds for when the resource expires.

      • ownedBy — (String)

        The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.

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

Waiter Resource States:

• streamingSessionStreamReady

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 ISO timestamp in seconds for when the resource was created.

      • displayName — (String)

        A friendly name for the studio.

      • homeRegion — (String)

        The Amazon Web Services Region where the studio resource is located.

      • ssoClientId — (String)

        The IAM Identity Center application client ID used to integrate with IAM Identity Center. This ID allows IAM Identity Center users to log in to Nimble Studio 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"
        • "AWS_STS_REGION_DISABLED"
      • 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.

        • keyType — required — (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 ISO 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.

Waiter Resource States:

• studioDeleted

• studioReady

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 Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

      • configuration — (map)

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

        • activeDirectoryConfiguration — (map)

          The configuration for a Directory Service for Microsoft Active Directory 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 Directory Service for Microsoft Active Directory 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 ISO 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.

      • runtimeRoleArn — (String)

        An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.

      • scriptParameters — (Array<map>)

        Parameters for the studio component scripts.

        • key — (String)

          A script parameter key.

        • value — (String)

          A script parameter value.

      • secureInitializationRoleArn — (String)

        An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.

      • 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 ISO timestamp in seconds for when the resource was updated.

      • updatedBy — (String)

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