Class: AWS.WorkSpacesThinClient

var params = {
  id: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
workspacesthinclient.deleteDevice(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: {}) —
  • id — (String)

    The ID of the device to delete.

  • clientToken — (String)

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

    If a token is not provided, the SDK will use a version 4 UUID.

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 = {
  id: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
workspacesthinclient.deleteEnvironment(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: {}) —
  • id — (String)

    The ID of the environment to delete.

  • clientToken — (String)

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

    If a token is not provided, the SDK will use a version 4 UUID.

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 = {
  id: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  targetDeviceStatus: DEREGISTERED | ARCHIVED
};
workspacesthinclient.deregisterDevice(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: {}) —
  • id — (String)

    The ID of the device to deregister.

  • targetDeviceStatus — (String)

    The desired new status for the device.

    Possible values include:
    • "DEREGISTERED"
    • "ARCHIVED"
  • clientToken — (String)

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

    If a token is not provided, the SDK will use a version 4 UUID.

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 = {
  id: 'STRING_VALUE' /* required */
};
workspacesthinclient.getDevice(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: {}) —
  • id — (String)

    The ID of the device for which to return information.

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:

    • device — (map)

      Describes an device.

      • id — (String)

        The ID of the device.

      • serialNumber — (String)

        The hardware serial number of the device.

      • name — (String)

        The name of the device.

      • model — (String)

        The model number of the device.

      • environmentId — (String)

        The ID of the environment the device is associated with.

      • status — (String)

        The status of the device.

        Possible values include:
        • "REGISTERED"
        • "DEREGISTERING"
        • "DEREGISTERED"
        • "ARCHIVED"
      • currentSoftwareSetId — (String)

        The ID of the software set currently installed on the device.

      • currentSoftwareSetVersion — (String)

        The version of the software set currently installed on the device.

      • desiredSoftwareSetId — (String)

        The ID of the software set which the device has been set to.

      • pendingSoftwareSetId — (String)

        The ID of the software set that is pending to be installed on the device.

      • pendingSoftwareSetVersion — (String)

        The version of the software set that is pending to be installed on the device.

      • softwareSetUpdateSchedule — (String)

        An option to define if software updates should be applied within a maintenance window.

        Possible values include:
        • "USE_MAINTENANCE_WINDOW"
        • "APPLY_IMMEDIATELY"
      • softwareSetComplianceStatus — (String)

        Describes if the software currently installed on the device is a supported version.

        Possible values include:
        • "NONE"
        • "COMPLIANT"
        • "NOT_COMPLIANT"
      • softwareSetUpdateStatus — (String)

        Describes if the device has a supported version of software installed.

        Possible values include:
        • "AVAILABLE"
        • "IN_PROGRESS"
        • "UP_TO_DATE"
      • lastConnectedAt — (Date)

        The timestamp of the most recent session on the device.

      • lastPostureAt — (Date)

        The timestamp of the most recent check-in of the device.

      • createdAt — (Date)

        The timestamp of when the device was created.

      • updatedAt — (Date)

        The timestamp of when the device was updated.

      • arn — (String)

        The Amazon Resource Name (ARN) of the device.

      • kmsKeyArn — (String)

        The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the device.

      • tags — (map<String>)

        The tag keys and optional values for the resource.

Returns:

• (AWS.Request) —

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

var params = {
  id: 'STRING_VALUE' /* required */
};
workspacesthinclient.getEnvironment(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: {}) —
  • id — (String)

    The ID of the environment for which to return information.

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:

    • environment — (map)

      Describes an environment.

      • id — (String)

        The ID of the environment.

      • name — (String)

        The name of the environment.

      • desktopArn — (String)

        The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.

      • desktopEndpoint — (String)

        The URL for the identity provider login (only for environments that use AppStream 2.0).

      • desktopType — (String)

        The type of streaming desktop for the environment.

        Possible values include:
        • "workspaces"
        • "appstream"
        • "workspaces-web"
      • activationCode — (String)

        The activation code to register a device to the environment.

      • registeredDevicesCount — (Integer)

        The number of devices registered to the environment.

      • softwareSetUpdateSchedule — (String)

        An option to define if software updates should be applied within a maintenance window.

        Possible values include:
        • "USE_MAINTENANCE_WINDOW"
        • "APPLY_IMMEDIATELY"
      • maintenanceWindow — (map)

        A specification for a time window to apply software updates.

        • type — (String)

          An option to select the default or custom maintenance window.

          Possible values include:
          • "SYSTEM"
          • "CUSTOM"
        • startTimeHour — (Integer)

          The hour for the maintenance window start (00-23).

        • startTimeMinute — (Integer)

          The minutes past the hour for the maintenance window start (00-59).

        • endTimeHour — (Integer)

          The hour for the maintenance window end (00-23).

        • endTimeMinute — (Integer)

          The minutes for the maintenance window end (00-59).

        • daysOfTheWeek — (Array<String>)

          The days of the week during which the maintenance window is open.

        • applyTimeOf — (String)

          The option to set the maintenance window during the device local time or Universal Coordinated Time (UTC).

          Possible values include:
          • "UTC"
          • "DEVICE"
      • softwareSetUpdateMode — (String)

        An option to define which software updates to apply.

        Possible values include:
        • "USE_LATEST"
        • "USE_DESIRED"
      • desiredSoftwareSetId — (String)

        The ID of the software set to apply.

      • pendingSoftwareSetId — (String)

        The ID of the software set that is pending to be installed.

      • pendingSoftwareSetVersion — (String)

        The version of the software set that is pending to be installed.

      • softwareSetComplianceStatus — (String)

        Describes if the software currently installed on all devices in the environment is a supported version.

        Possible values include:
        • "NO_REGISTERED_DEVICES"
        • "COMPLIANT"
        • "NOT_COMPLIANT"
      • createdAt — (Date)

        The timestamp of when the environment was created.

      • updatedAt — (Date)

        The timestamp of when the device was updated.

      • arn — (String)

        The Amazon Resource Name (ARN) of the environment.

      • kmsKeyArn — (String)

        The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the environment.

      • tags — (map<String>)

        The tag keys and optional values for the resource.

Returns:

• (AWS.Request) —

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

var params = {
  id: 'STRING_VALUE' /* required */
};
workspacesthinclient.getSoftwareSet(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: {}) —
  • id — (String)

    The ID of the software set for which to return information.

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:

    • softwareSet — (map)

      Describes a software set.

      • id — (String)

        The ID of the software set.

      • version — (String)

        The version of the software set.

      • releasedAt — (Date)

        The timestamp of when the software set was released.

      • supportedUntil — (Date)

        The timestamp of the end of support for the software set.

      • validationStatus — (String)

        An option to define if the software set has been validated.

        Possible values include:
        • "VALIDATED"
        • "NOT_VALIDATED"
      • software — (Array<map>)

        A list of the software components in the software set.

        • name — (String)

          The name of the software component.

        • version — (String)

          The version of the software component.

      • arn — (String)

        The Amazon Resource Name (ARN) of the software set.

      • tags — (map<String>)

        The tag keys and optional values for the resource.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

  • maxResults — (Integer)

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

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:

    • devices — (Array<map>)

      Describes devices.

      • id — (String)

        The ID of the device.

      • serialNumber — (String)

        The hardware serial number of the device.

      • name — (String)

        The name of the device.

      • model — (String)

        The model number of the device.

      • environmentId — (String)

        The ID of the environment the device is associated with.

      • status — (String)

        The status of the device.

        Possible values include:
        • "REGISTERED"
        • "DEREGISTERING"
        • "DEREGISTERED"
        • "ARCHIVED"
      • currentSoftwareSetId — (String)

        The ID of the software set currently installed on the device.

      • desiredSoftwareSetId — (String)

        The ID of the software set which the device has been set to.

      • pendingSoftwareSetId — (String)

        The ID of the software set that is pending to be installed on the device.

      • softwareSetUpdateSchedule — (String)

        An option to define if software updates should be applied within a maintenance window.

        Possible values include:
        • "USE_MAINTENANCE_WINDOW"
        • "APPLY_IMMEDIATELY"
      • lastConnectedAt — (Date)

        The timestamp of the most recent session on the device.

      • lastPostureAt — (Date)

        The timestamp of the most recent check-in of the device.

      • createdAt — (Date)

        The timestamp of when the device was created.

      • updatedAt — (Date)

        The timestamp of when the device was updated.

      • arn — (String)

        The Amazon Resource Name (ARN) of the device.

    • nextToken — (String)

      If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

  • maxResults — (Integer)

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

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:

    • environments — (Array<map>)

      Describes environments.

      • id — (String)

        The ID of the environment.

      • name — (String)

        The name of the environment.

      • desktopArn — (String)

        The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.

      • desktopEndpoint — (String)

        The URL for the identity provider login (only for environments that use AppStream 2.0).

      • desktopType — (String)

        The type of streaming desktop for the environment.

        Possible values include:
        • "workspaces"
        • "appstream"
        • "workspaces-web"
      • activationCode — (String)

        The activation code to register a device to the environment.

      • softwareSetUpdateSchedule — (String)

        An option to define if software updates should be applied within a maintenance window.

        Possible values include:
        • "USE_MAINTENANCE_WINDOW"
        • "APPLY_IMMEDIATELY"
      • maintenanceWindow — (map)

        A specification for a time window to apply software updates.

        • type — (String)

          An option to select the default or custom maintenance window.

          Possible values include:
          • "SYSTEM"
          • "CUSTOM"
        • startTimeHour — (Integer)

          The hour for the maintenance window start (00-23).

        • startTimeMinute — (Integer)

          The minutes past the hour for the maintenance window start (00-59).

        • endTimeHour — (Integer)

          The hour for the maintenance window end (00-23).

        • endTimeMinute — (Integer)

          The minutes for the maintenance window end (00-59).

        • daysOfTheWeek — (Array<String>)

          The days of the week during which the maintenance window is open.

        • applyTimeOf — (String)

          The option to set the maintenance window during the device local time or Universal Coordinated Time (UTC).

          Possible values include:
          • "UTC"
          • "DEVICE"
      • softwareSetUpdateMode — (String)

        An option to define which software updates to apply.

        Possible values include:
        • "USE_LATEST"
        • "USE_DESIRED"
      • desiredSoftwareSetId — (String)

        The ID of the software set to apply.

      • pendingSoftwareSetId — (String)

        The ID of the software set that is pending to be installed.

      • createdAt — (Date)

        The timestamp of when the environment was created.

      • updatedAt — (Date)

        The timestamp of when the device was updated.

      • arn — (String)

        The Amazon Resource Name (ARN) of the environment.

    • nextToken — (String)

      If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

  • maxResults — (Integer)

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

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:

    • softwareSets — (Array<map>)

      Describes software sets.

      • id — (String)

        The ID of the software set.

      • version — (String)

        The version of the software set.

      • releasedAt — (Date)

        The timestamp of when the software set was released.

      • supportedUntil — (Date)

        The timestamp of the end of support for the software set.

      • validationStatus — (String)

        An option to define if the software set has been validated.

        Possible values include:
        • "VALIDATED"
        • "NOT_VALIDATED"
      • arn — (String)

        The Amazon Resource Name (ARN) of the software set.

    • nextToken — (String)

      If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The Amazon Resource Name (ARN) of the resource for which you want to retrieve tags.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • tags — (map<String>)

      A map of the key-value pairs for the tag or tags assigned to the specified resource.

Returns:

• (AWS.Request) —

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

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  }
};
workspacesthinclient.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The Amazon Resource Name (ARN) of the resource that you want to tag.

  • tags — (map<String>)

    A map of the key-value pairs of the tag or tags to assign to the resource.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
workspacesthinclient.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The Amazon Resource Name (ARN) of the resource that you want to untag.

  • tagKeys — (Array<String>)

    The keys of the key-value pairs for the tag or tags you want to remove from the specified resource.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  id: 'STRING_VALUE', /* required */
  desiredSoftwareSetId: 'STRING_VALUE',
  name: 'STRING_VALUE',
  softwareSetUpdateSchedule: USE_MAINTENANCE_WINDOW | APPLY_IMMEDIATELY
};
workspacesthinclient.updateDevice(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: {}) —
  • id — (String)

    The ID of the device to update.

  • name — (String)

    The name of the device to update.

  • desiredSoftwareSetId — (String)

    The ID of the software set to apply.

  • softwareSetUpdateSchedule — (String)

    An option to define if software updates should be applied within a maintenance window.

    Possible values include:
    • "USE_MAINTENANCE_WINDOW"
    • "APPLY_IMMEDIATELY"

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:

    • device — (map)

      Describes a device.

      • id — (String)

        The ID of the device.

      • serialNumber — (String)

        The hardware serial number of the device.

      • name — (String)

        The name of the device.

      • model — (String)

        The model number of the device.

      • environmentId — (String)

        The ID of the environment the device is associated with.

      • status — (String)

        The status of the device.

        Possible values include:
        • "REGISTERED"
        • "DEREGISTERING"
        • "DEREGISTERED"
        • "ARCHIVED"
      • currentSoftwareSetId — (String)

        The ID of the software set currently installed on the device.

      • desiredSoftwareSetId — (String)

        The ID of the software set which the device has been set to.

      • pendingSoftwareSetId — (String)

        The ID of the software set that is pending to be installed on the device.

      • softwareSetUpdateSchedule — (String)

        An option to define if software updates should be applied within a maintenance window.

        Possible values include:
        • "USE_MAINTENANCE_WINDOW"
        • "APPLY_IMMEDIATELY"
      • lastConnectedAt — (Date)

        The timestamp of the most recent session on the device.

      • lastPostureAt — (Date)

        The timestamp of the most recent check-in of the device.

      • createdAt — (Date)

        The timestamp of when the device was created.

      • updatedAt — (Date)

        The timestamp of when the device was updated.

      • arn — (String)

        The Amazon Resource Name (ARN) of the device.

Returns:

• (AWS.Request) —

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

var params = {
  id: 'STRING_VALUE', /* required */
  desiredSoftwareSetId: 'STRING_VALUE',
  desktopArn: 'STRING_VALUE',
  desktopEndpoint: 'STRING_VALUE',
  maintenanceWindow: {
    applyTimeOf: UTC | DEVICE,
    daysOfTheWeek: [
      MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY,
      /* more items */
    ],
    endTimeHour: 'NUMBER_VALUE',
    endTimeMinute: 'NUMBER_VALUE',
    startTimeHour: 'NUMBER_VALUE',
    startTimeMinute: 'NUMBER_VALUE',
    type: SYSTEM | CUSTOM
  },
  name: 'STRING_VALUE',
  softwareSetUpdateMode: USE_LATEST | USE_DESIRED,
  softwareSetUpdateSchedule: USE_MAINTENANCE_WINDOW | APPLY_IMMEDIATELY
};
workspacesthinclient.updateEnvironment(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: {}) —
  • id — (String)

    The ID of the environment to update.

  • name — (String)

    The name of the environment to update.

  • desktopArn — (String)

    The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.

  • desktopEndpoint — (String)

    The URL for the identity provider login (only for environments that use AppStream 2.0).

  • softwareSetUpdateSchedule — (String)

    An option to define if software updates should be applied within a maintenance window.

    Possible values include:
    • "USE_MAINTENANCE_WINDOW"
    • "APPLY_IMMEDIATELY"
  • maintenanceWindow — (map)

    A specification for a time window to apply software updates.

    • type — (String)

      An option to select the default or custom maintenance window.

      Possible values include:
      • "SYSTEM"
      • "CUSTOM"
    • startTimeHour — (Integer)

      The hour for the maintenance window start (00-23).

    • startTimeMinute — (Integer)

      The minutes past the hour for the maintenance window start (00-59).

    • endTimeHour — (Integer)

      The hour for the maintenance window end (00-23).

    • endTimeMinute — (Integer)

      The minutes for the maintenance window end (00-59).

    • daysOfTheWeek — (Array<String>)

      The days of the week during which the maintenance window is open.

    • applyTimeOf — (String)

      The option to set the maintenance window during the device local time or Universal Coordinated Time (UTC).

      Possible values include:
      • "UTC"
      • "DEVICE"
  • softwareSetUpdateMode — (String)

    An option to define which software updates to apply.

    Possible values include:
    • "USE_LATEST"
    • "USE_DESIRED"
  • desiredSoftwareSetId — (String)

    The ID of the software set to apply.

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:

    • environment — (map)

      Describes an environment.

      • id — (String)

        The ID of the environment.

      • name — (String)

        The name of the environment.

      • desktopArn — (String)

        The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.

      • desktopEndpoint — (String)

        The URL for the identity provider login (only for environments that use AppStream 2.0).

      • desktopType — (String)

        The type of streaming desktop for the environment.

        Possible values include:
        • "workspaces"
        • "appstream"
        • "workspaces-web"
      • activationCode — (String)

        The activation code to register a device to the environment.

      • softwareSetUpdateSchedule — (String)

        An option to define if software updates should be applied within a maintenance window.

        Possible values include:
        • "USE_MAINTENANCE_WINDOW"
        • "APPLY_IMMEDIATELY"
      • maintenanceWindow — (map)

        A specification for a time window to apply software updates.

        • type — (String)

          An option to select the default or custom maintenance window.

          Possible values include:
          • "SYSTEM"
          • "CUSTOM"
        • startTimeHour — (Integer)

          The hour for the maintenance window start (00-23).

        • startTimeMinute — (Integer)

          The minutes past the hour for the maintenance window start (00-59).

        • endTimeHour — (Integer)

          The hour for the maintenance window end (00-23).

        • endTimeMinute — (Integer)

          The minutes for the maintenance window end (00-59).

        • daysOfTheWeek — (Array<String>)

          The days of the week during which the maintenance window is open.

        • applyTimeOf — (String)

          The option to set the maintenance window during the device local time or Universal Coordinated Time (UTC).

          Possible values include:
          • "UTC"
          • "DEVICE"
      • softwareSetUpdateMode — (String)

        An option to define which software updates to apply.

        Possible values include:
        • "USE_LATEST"
        • "USE_DESIRED"
      • desiredSoftwareSetId — (String)

        The ID of the software set to apply.

      • pendingSoftwareSetId — (String)

        The ID of the software set that is pending to be installed.

      • createdAt — (Date)

        The timestamp of when the environment was created.

      • updatedAt — (Date)

        The timestamp of when the device was updated.

      • arn — (String)

        The Amazon Resource Name (ARN) of the environment.

Returns:

• (AWS.Request) —

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

var params = {
  id: 'STRING_VALUE', /* required */
  validationStatus: VALIDATED | NOT_VALIDATED /* required */
};
workspacesthinclient.updateSoftwareSet(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: {}) —
  • id — (String)

    The ID of the software set to update.

  • validationStatus — (String)

    An option to define if the software set has been validated.

    Possible values include:
    • "VALIDATED"
    • "NOT_VALIDATED"

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.