Class: AWS.WorkSpaces

var params = {
  AliasId: 'STRING_VALUE', /* required */
  ResourceId: 'STRING_VALUE' /* required */
};
workspaces.associateConnectionAlias(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: {}) —
  • AliasId — (String)

    The identifier of the connection alias.

  • ResourceId — (String)

    The identifier of the directory to associate the connection alias with.

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:

    • ConnectionIdentifier — (String)

      The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you're configuring your DNS routing policies.

Returns:

• (AWS.Request) —

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

var params = {
  DirectoryId: 'STRING_VALUE', /* required */
  GroupIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
workspaces.associateIpGroups(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: {}) —
  • DirectoryId — (String)

    The identifier of the directory.

  • GroupIds — (Array<String>)

    The identifiers of one or more IP access control groups.

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 = {
  ApplicationId: 'STRING_VALUE', /* required */
  WorkspaceId: 'STRING_VALUE' /* required */
};
workspaces.associateWorkspaceApplication(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: {}) —
  • WorkspaceId — (String)

    The identifier of the WorkSpace.

  • ApplicationId — (String)

    The identifier of the application.

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:

    • Association — (map)

      Information about the association between the specified WorkSpace and the specified application.

      • AssociatedResourceId — (String)

        The identifier of the associated resource.

      • AssociatedResourceType — (String)

        The resource types of the associated resource.

        Possible values include:
        • "APPLICATION"
      • Created — (Date)

        The time the association is created.

      • LastUpdatedTime — (Date)

        The time the association status was last updated.

      • State — (String)

        The status of the WorkSpace resource association.

        Possible values include:
        • "PENDING_INSTALL"
        • "PENDING_INSTALL_DEPLOYMENT"
        • "PENDING_UNINSTALL"
        • "PENDING_UNINSTALL_DEPLOYMENT"
        • "INSTALLING"
        • "UNINSTALLING"
        • "ERROR"
        • "COMPLETED"
        • "REMOVED"
      • StateReason — (map)

        The reason the association deployment failed.

        • ErrorCode — (String)

          The error code of the association deployment failure.

          Possible values include:
          • "ValidationError.InsufficientDiskSpace"
          • "ValidationError.InsufficientMemory"
          • "ValidationError.UnsupportedOperatingSystem"
          • "DeploymentError.InternalServerError"
          • "DeploymentError.WorkspaceUnreachable"
        • ErrorMessage — (String)

          The error message of the association deployment failure.

      • WorkspaceId — (String)

        The identifier of the WorkSpace.

Returns:

• (AWS.Request) —

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

var params = {
  GroupId: 'STRING_VALUE', /* required */
  UserRules: [ /* required */
    {
      ipRule: 'STRING_VALUE',
      ruleDesc: 'STRING_VALUE'
    },
    /* more items */
  ]
};
workspaces.authorizeIpRules(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: {}) —
  • GroupId — (String)

    The identifier of the group.

  • UserRules — (Array<map>)

    The rules to add to the group.

    • ipRule — (String)

      The IP address range, in CIDR notation.

    • ruleDesc — (String)

      The description.

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 = {
  Name: 'STRING_VALUE', /* required */
  SourceImageId: 'STRING_VALUE', /* required */
  SourceRegion: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
workspaces.copyWorkspaceImage(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: {}) —
  • Name — (String)

    The name of the image.

  • Description — (String)

    A description of the image.

  • SourceImageId — (String)

    The identifier of the source image.

  • SourceRegion — (String)

    The identifier of the source Region.

  • Tags — (Array<map>)

    The tags for the image.

    • Key — required — (String)

      The key of the tag.

    • Value — (String)

      The value of the tag.

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:

    • ImageId — (String)

      The identifier of the image.

Returns:

• (AWS.Request) —

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

var params = {
  TargetAccountId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE'
};
workspaces.createAccountLinkInvitation(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: {}) —
  • TargetAccountId — (String)

    The identifier of the target account.

  • ClientToken — (String)

    A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.

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:

    • AccountLink — (map)

      Information about the account link.

      • AccountLinkId — (String)

        The identifier of the account link.

      • AccountLinkStatus — (String)

        The status of the account link.

        Possible values include:
        • "LINKED"
        • "LINKING_FAILED"
        • "LINK_NOT_FOUND"
        • "PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT"
        • "REJECTED"
      • SourceAccountId — (String)

        The identifier of the source account.

      • TargetAccountId — (String)

        The identifier of the target account.

Returns:

• (AWS.Request) —

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

var params = {
  Name: 'STRING_VALUE', /* required */
  ResourceId: 'STRING_VALUE', /* required */
  URL: 'STRING_VALUE' /* required */
};
workspaces.createConnectClientAddIn(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: {}) —
  • ResourceId — (String)

    The directory identifier for which to configure the client add-in.

  • Name — (String)

    The name of the client add-in.

  • URL — (String)

    The endpoint URL of the Amazon Connect client add-in.

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:

    • AddInId — (String)

      The client add-in identifier.

Returns:

• (AWS.Request) —

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

var params = {
  ConnectionString: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
workspaces.createConnectionAlias(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: {}) —
  • ConnectionString — (String)

    A connection string in the form of a fully qualified domain name (FQDN), such as www.example.com.

    After you create a connection string, it is always associated to your Amazon Web Services account. You cannot recreate the same connection string with a different account, even if you delete all instances of it from the original account. The connection string is globally reserved for your account.

  • Tags — (Array<map>)

    The tags to associate with the connection alias.

    • Key — required — (String)

      The key of the tag.

    • Value — (String)

      The value of the tag.

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:

    • AliasId — (String)

      The identifier of the connection alias.

Returns:

• (AWS.Request) —

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

var params = {
  GroupName: 'STRING_VALUE', /* required */
  GroupDesc: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  UserRules: [
    {
      ipRule: 'STRING_VALUE',
      ruleDesc: 'STRING_VALUE'
    },
    /* more items */
  ]
};
workspaces.createIpGroup(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: {}) —
  • GroupName — (String)

    The name of the group.

  • GroupDesc — (String)

    The description of the group.

  • UserRules — (Array<map>)

    The rules to add to the group.

    • ipRule — (String)

      The IP address range, in CIDR notation.

    • ruleDesc — (String)

      The description.

  • Tags — (Array<map>)

    The tags. Each WorkSpaces resource can have a maximum of 50 tags.

    • Key — required — (String)

      The key of the tag.

    • Value — (String)

      The value of the tag.

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:

    • GroupId — (String)

      The identifier of the group.

Returns:

• (AWS.Request) —

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

var params = {
  PrimaryRegion: 'STRING_VALUE', /* required */
  StandbyWorkspaces: [ /* required */
    {
      DirectoryId: 'STRING_VALUE', /* required */
      PrimaryWorkspaceId: 'STRING_VALUE', /* required */
      DataReplication: NO_REPLICATION | PRIMARY_AS_SOURCE,
      Tags: [
        {
          Key: 'STRING_VALUE', /* required */
          Value: 'STRING_VALUE'
        },
        /* more items */
      ],
      VolumeEncryptionKey: 'STRING_VALUE'
    },
    /* more items */
  ]
};
workspaces.createStandbyWorkspaces(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: {}) —
  • PrimaryRegion — (String)

    The Region of the primary WorkSpace.

  • StandbyWorkspaces — (Array<map>)

    Information about the standby WorkSpace to be created.

    • PrimaryWorkspaceId — required — (String)

      The identifier of the standby WorkSpace.

    • VolumeEncryptionKey — (String)

      The volume encryption key of the standby WorkSpace.

    • DirectoryId — required — (String)

      The identifier of the directory for the standby WorkSpace.

    • Tags — (Array<map>)

      The tags associated with the standby WorkSpace.

      • Key — required — (String)

        The key of the tag.

      • Value — (String)

        The value of the tag.

    • DataReplication — (String)

      Indicates whether data replication is enabled, and if enabled, the type of data replication.

      Possible values include:
      • "NO_REPLICATION"
      • "PRIMARY_AS_SOURCE"

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:

    • FailedStandbyRequests — (Array<map>)

      Information about the standby WorkSpace that could not be created.

      • StandbyWorkspaceRequest — (map)

        Information about the standby WorkSpace that could not be created.

        • PrimaryWorkspaceId — required — (String)

          The identifier of the standby WorkSpace.

        • VolumeEncryptionKey — (String)

          The volume encryption key of the standby WorkSpace.

        • DirectoryId — required — (String)

          The identifier of the directory for the standby WorkSpace.

        • Tags — (Array<map>)

          The tags associated with the standby WorkSpace.

          • Key — required — (String)

            The key of the tag.

          • Value — (String)

            The value of the tag.

        • DataReplication — (String)

          Indicates whether data replication is enabled, and if enabled, the type of data replication.

          Possible values include:
          • "NO_REPLICATION"
          • "PRIMARY_AS_SOURCE"
      • ErrorCode — (String)

        The error code that is returned if the standby WorkSpace could not be created.

      • ErrorMessage — (String)

        The text of the error message that is returned if the standby WorkSpace could not be created.

    • PendingStandbyRequests — (Array<map>)

      Information about the standby WorkSpace that was created.

      • UserName — (String)

        Describes the standby WorkSpace that was created.

        Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned can be incomplete.

      • DirectoryId — (String)

        The identifier of the directory for the standby WorkSpace.

      • State — (String)

        The operational state of the standby WorkSpace.

        Possible values include:
        • "PENDING"
        • "AVAILABLE"
        • "IMPAIRED"
        • "UNHEALTHY"
        • "REBOOTING"
        • "STARTING"
        • "REBUILDING"
        • "RESTORING"
        • "MAINTENANCE"
        • "ADMIN_MAINTENANCE"
        • "TERMINATING"
        • "TERMINATED"
        • "SUSPENDED"
        • "UPDATING"
        • "STOPPING"
        • "STOPPED"
        • "ERROR"
      • WorkspaceId — (String)

        The identifier of the standby WorkSpace.

Returns:

• (AWS.Request) —

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

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
workspaces.createTags(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: {}) —
  • ResourceId — (String)

    The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.

  • Tags — (Array<map>)

    The tags. Each WorkSpaces resource can have a maximum of 50 tags.

    • Key — required — (String)

      The key of the tag.

    • Value — (String)

      The value of the tag.

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 = {
  Description: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  SourceImageId: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
workspaces.createUpdatedWorkspaceImage(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: {}) —
  • Name — (String)

    The name of the new updated WorkSpace image.

  • Description — (String)

    A description of whether updates for the WorkSpace image are available.

  • SourceImageId — (String)

    The identifier of the source WorkSpace image.

  • Tags — (Array<map>)

    The tags that you want to add to the new updated WorkSpace image.

    Note: To add tags at the same time when you're creating the updated image, you must create an IAM policy that grants your IAM user permissions to use workspaces:CreateTags.
    • Key — required — (String)

      The key of the tag.

    • Value — (String)

      The value of the tag.

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:

    • ImageId — (String)

      The identifier of the new updated WorkSpace image.

Returns:

• (AWS.Request) —

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

var params = {
  BundleDescription: 'STRING_VALUE', /* required */
  BundleName: 'STRING_VALUE', /* required */
  ComputeType: { /* required */
    Name: VALUE | STANDARD | PERFORMANCE | POWER | GRAPHICS | POWERPRO | GRAPHICSPRO | GRAPHICS_G4DN | GRAPHICSPRO_G4DN
  },
  ImageId: 'STRING_VALUE', /* required */
  UserStorage: { /* required */
    Capacity: 'STRING_VALUE' /* required */
  },
  RootStorage: {
    Capacity: 'STRING_VALUE' /* required */
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
workspaces.createWorkspaceBundle(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: {}) —
  • BundleName — (String)

    The name of the bundle.

  • BundleDescription — (String)

    The description of the bundle.

  • ImageId — (String)

    The identifier of the image that is used to create the bundle.

  • ComputeType — (map)

    Describes the compute type of the bundle.

    • Name — (String)

      The compute type.

      Possible values include:
      • "VALUE"
      • "STANDARD"
      • "PERFORMANCE"
      • "POWER"
      • "GRAPHICS"
      • "POWERPRO"
      • "GRAPHICSPRO"
      • "GRAPHICS_G4DN"
      • "GRAPHICSPRO_G4DN"
  • UserStorage — (map)

    Describes the user volume for a WorkSpace bundle.

    • Capacity — required — (String)

      The size of the user volume.

  • RootStorage — (map)

    Describes the root volume for a WorkSpace bundle.

    • Capacity — required — (String)

      The size of the root volume.

  • Tags — (Array<map>)

    The tags associated with the bundle.

    Note: To add tags at the same time when you're creating the bundle, you must create an IAM policy that grants your IAM user permissions to use workspaces:CreateTags.
    • Key — required — (String)

      The key of the tag.

    • Value — (String)

      The value of the tag.

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:

    • WorkspaceBundle — (map)

      Describes a WorkSpace bundle.

      • BundleId — (String)

        The identifier of the bundle.

      • Name — (String)

        The name of the bundle.

      • Owner — (String)

        The owner of the bundle. This is the account identifier of the owner, or AMAZON if the bundle is provided by Amazon Web Services.

      • Description — (String)

        The description of the bundle.

      • ImageId — (String)

        The identifier of the image that was used to create the bundle.

      • RootStorage — (map)

        The size of the root volume.

        • Capacity — required — (String)

          The size of the root volume.

      • UserStorage — (map)

        The size of the user volume.

        • Capacity — required — (String)

          The size of the user volume.

      • ComputeType — (map)

        The compute type of the bundle. For more information, see Amazon WorkSpaces Bundles.

        • Name — (String)

          The compute type.

          Possible values include:
          • "VALUE"
          • "STANDARD"
          • "PERFORMANCE"
          • "POWER"
          • "GRAPHICS"
          • "POWERPRO"
          • "GRAPHICSPRO"
          • "GRAPHICS_G4DN"
          • "GRAPHICSPRO_G4DN"
      • LastUpdatedTime — (Date)

        The last time that the bundle was updated.

      • CreationTime — (Date)

        The time when the bundle was created.

      • State — (String)

        The state of the WorkSpace bundle.

        Possible values include:
        • "AVAILABLE"
        • "PENDING"
        • "ERROR"
      • BundleType — (String)

        The type of WorkSpace bundle.

        Possible values include:
        • "REGULAR"
        • "STANDBY"

Returns:

• (AWS.Request) —

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

var params = {
  Description: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  WorkspaceId: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
workspaces.createWorkspaceImage(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: {}) —
  • Name — (String)

    The name of the new WorkSpace image.

  • Description — (String)

    The description of the new WorkSpace image.

  • WorkspaceId — (String)

    The identifier of the source WorkSpace

  • Tags — (Array<map>)

    The tags that you want to add to the new WorkSpace image. To add tags when you're creating the image, you must create an IAM policy that grants your IAM user permission to use workspaces:CreateTags.

    • Key — required — (String)

      The key of the tag.

    • Value — (String)

      The value of the tag.

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:

    • ImageId — (String)

      The identifier of the new WorkSpace image.

    • Name — (String)

      The name of the image.

    • Description — (String)

      The description of the image.

    • OperatingSystem — (map)

      The operating system that the image is running.

      • Type — (String)

        The operating system.

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

      The availability status of the image.

      Possible values include:
      • "AVAILABLE"
      • "PENDING"
      • "ERROR"
    • RequiredTenancy — (String)

      Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images..

      Possible values include:
      • "DEFAULT"
      • "DEDICATED"
    • Created — (Date)

      The date when the image was created.

    • OwnerAccountId — (String)

      The identifier of the Amazon Web Services account that owns the image.

Returns:

• (AWS.Request) —

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

var params = {
  Workspaces: [ /* required */
    {
      BundleId: 'STRING_VALUE', /* required */
      DirectoryId: 'STRING_VALUE', /* required */
      UserName: 'STRING_VALUE', /* required */
      RootVolumeEncryptionEnabled: true || false,
      Tags: [
        {
          Key: 'STRING_VALUE', /* required */
          Value: 'STRING_VALUE'
        },
        /* more items */
      ],
      UserVolumeEncryptionEnabled: true || false,
      VolumeEncryptionKey: 'STRING_VALUE',
      WorkspaceName: 'STRING_VALUE',
      WorkspaceProperties: {
        ComputeTypeName: VALUE | STANDARD | PERFORMANCE | POWER | GRAPHICS | POWERPRO | GRAPHICSPRO | GRAPHICS_G4DN | GRAPHICSPRO_G4DN,
        OperatingSystemName: AMAZON_LINUX_2 | UBUNTU_18_04 | UBUNTU_20_04 | UBUNTU_22_04 | UNKNOWN | WINDOWS_10 | WINDOWS_11 | WINDOWS_7 | WINDOWS_SERVER_2016 | WINDOWS_SERVER_2019 | WINDOWS_SERVER_2022 | RHEL_8,
        Protocols: [
          PCOIP | WSP,
          /* more items */
        ],
        RootVolumeSizeGib: 'NUMBER_VALUE',
        RunningMode: AUTO_STOP | ALWAYS_ON | MANUAL,
        RunningModeAutoStopTimeoutInMinutes: 'NUMBER_VALUE',
        UserVolumeSizeGib: 'NUMBER_VALUE'
      }
    },
    /* more items */
  ]
};
workspaces.createWorkspaces(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: {}) —
  • Workspaces — (Array<map>)

    The WorkSpaces to create. You can specify up to 25 WorkSpaces.

    • DirectoryId — required — (String)

      The identifier of the Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.

    • UserName — required — (String)

      The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.

      The reserved keyword, [UNDEFINED], is used when creating user-decoupled WorkSpaces.

    • BundleId — required — (String)

      The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.

    • VolumeEncryptionKey — (String)

      The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.

    • UserVolumeEncryptionEnabled — (Boolean)

      Indicates whether the data stored on the user volume is encrypted.

    • RootVolumeEncryptionEnabled — (Boolean)

      Indicates whether the data stored on the root volume is encrypted.

    • WorkspaceProperties — (map)

      The WorkSpace properties.

      • RunningMode — (String)

        The running mode. For more information, see Manage the WorkSpace Running Mode.

        Note: The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.

        Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?

        Possible values include:
        • "AUTO_STOP"
        • "ALWAYS_ON"
        • "MANUAL"
      • RunningModeAutoStopTimeoutInMinutes — (Integer)

        The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.

      • RootVolumeSizeGib — (Integer)

        The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

      • UserVolumeSizeGib — (Integer)

        The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

      • ComputeTypeName — (String)

        The compute type. For more information, see Amazon WorkSpaces Bundles.

        Possible values include:
        • "VALUE"
        • "STANDARD"
        • "PERFORMANCE"
        • "POWER"
        • "GRAPHICS"
        • "POWERPRO"
        • "GRAPHICSPRO"
        • "GRAPHICS_G4DN"
        • "GRAPHICSPRO_G4DN"
      • Protocols — (Array<String>)

        The protocol. For more information, see Protocols for Amazon WorkSpaces.

        Note:

        • Only available for WorkSpaces created with PCoIP bundles.
        • The Protocols property is case sensitive. Ensure you use PCOIP or WSP.
        • Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
      • OperatingSystemName — (String)

        The name of the operating system.

        Possible values include:
        • "AMAZON_LINUX_2"
        • "UBUNTU_18_04"
        • "UBUNTU_20_04"
        • "UBUNTU_22_04"
        • "UNKNOWN"
        • "WINDOWS_10"
        • "WINDOWS_11"
        • "WINDOWS_7"
        • "WINDOWS_SERVER_2016"
        • "WINDOWS_SERVER_2019"
        • "WINDOWS_SERVER_2022"
        • "RHEL_8"
    • Tags — (Array<map>)

      The tags for the WorkSpace.

      • Key — required — (String)

        The key of the tag.

      • Value — (String)

        The value of the tag.

    • WorkspaceName — (String)

      The name of the user-decoupled WorkSpace.

      Note: WorkspaceName is required if UserName is [UNDEFINED] for user-decoupled WorkSpaces. WorkspaceName is not applicable if UserName is specified for user-assigned WorkSpaces.

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:

    • FailedRequests — (Array<map>)

      Information about the WorkSpaces that could not be created.

      • WorkspaceRequest — (map)

        Information about the WorkSpace.

        • DirectoryId — required — (String)

          The identifier of the Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.

        • UserName — required — (String)

          The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.

          The reserved keyword, [UNDEFINED], is used when creating user-decoupled WorkSpaces.

        • BundleId — required — (String)

          The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.

        • VolumeEncryptionKey — (String)

          The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.

        • UserVolumeEncryptionEnabled — (Boolean)

          Indicates whether the data stored on the user volume is encrypted.

        • RootVolumeEncryptionEnabled — (Boolean)

          Indicates whether the data stored on the root volume is encrypted.

        • WorkspaceProperties — (map)

          The WorkSpace properties.

          • RunningMode — (String)

            The running mode. For more information, see Manage the WorkSpace Running Mode.

            Note: The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.

            Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?

            Possible values include:
            • "AUTO_STOP"
            • "ALWAYS_ON"
            • "MANUAL"
          • RunningModeAutoStopTimeoutInMinutes — (Integer)

            The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.

          • RootVolumeSizeGib — (Integer)

            The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

          • UserVolumeSizeGib — (Integer)

            The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

          • ComputeTypeName — (String)

            The compute type. For more information, see Amazon WorkSpaces Bundles.

            Possible values include:
            • "VALUE"
            • "STANDARD"
            • "PERFORMANCE"
            • "POWER"
            • "GRAPHICS"
            • "POWERPRO"
            • "GRAPHICSPRO"
            • "GRAPHICS_G4DN"
            • "GRAPHICSPRO_G4DN"
          • Protocols — (Array<String>)

            The protocol. For more information, see Protocols for Amazon WorkSpaces.

            Note:

            • Only available for WorkSpaces created with PCoIP bundles.
            • The Protocols property is case sensitive. Ensure you use PCOIP or WSP.
            • Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
          • OperatingSystemName — (String)

            The name of the operating system.

            Possible values include:
            • "AMAZON_LINUX_2"
            • "UBUNTU_18_04"
            • "UBUNTU_20_04"
            • "UBUNTU_22_04"
            • "UNKNOWN"
            • "WINDOWS_10"
            • "WINDOWS_11"
            • "WINDOWS_7"
            • "WINDOWS_SERVER_2016"
            • "WINDOWS_SERVER_2019"
            • "WINDOWS_SERVER_2022"
            • "RHEL_8"
        • Tags — (Array<map>)

          The tags for the WorkSpace.

          • Key — required — (String)

            The key of the tag.

          • Value — (String)

            The value of the tag.

        • WorkspaceName — (String)

          The name of the user-decoupled WorkSpace.

          Note: WorkspaceName is required if UserName is [UNDEFINED] for user-decoupled WorkSpaces. WorkspaceName is not applicable if UserName is specified for user-assigned WorkSpaces.
      • ErrorCode — (String)

        The error code that is returned if the WorkSpace cannot be created.

      • ErrorMessage — (String)

        The text of the error message that is returned if the WorkSpace cannot be created.

    • PendingRequests — (Array<map>)

      Information about the WorkSpaces that were created.

      Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned can be incomplete.

      • WorkspaceId — (String)

        The identifier of the WorkSpace.

      • DirectoryId — (String)

        The identifier of the Directory Service directory for the WorkSpace.

      • UserName — (String)

        The user for the WorkSpace.

      • IpAddress — (String)

        The IP address of the WorkSpace.

      • State — (String)

        The operational state of the WorkSpace.

        • PENDING – The WorkSpace is in a waiting state (for example, the WorkSpace is being created).

        • AVAILABLE – The WorkSpace is running and has passed the health checks.

        • IMPAIRED – Refer to UNHEALTHY state.

        • UNHEALTHY – The WorkSpace is not responding to health checks.

        • REBOOTING – The WorkSpace is being rebooted (restarted).

        • STARTING – The WorkSpace is starting up and health checks are being run.

        • REBUILDING – The WorkSpace is being rebuilt.

        • RESTORING – The WorkSpace is being restored.

        • MAINTENANCE – The WorkSpace is undergoing scheduled maintenance by Amazon Web Services.

        • ADMIN_MAINTENANCE – The WorkSpace is undergoing maintenance by the WorkSpaces administrator.

        • TERMINATING – The WorkSpace is being deleted.

        • TERMINATED – The WorkSpace has been deleted.

        • SUSPENDED – The WorkSpace has been suspended for image creation.

        • UPDATING – The WorkSpace is undergoing an update.

        • STOPPING – The WorkSpace is being stopped.

        • STOPPED – The WorkSpace has been stopped.

        • ERROR – The WorkSpace is an error state (for example, an error occurred during startup).

        Note: After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.
        Possible values include:
        • "PENDING"
        • "AVAILABLE"
        • "IMPAIRED"
        • "UNHEALTHY"
        • "REBOOTING"
        • "STARTING"
        • "REBUILDING"
        • "RESTORING"
        • "MAINTENANCE"
        • "ADMIN_MAINTENANCE"
        • "TERMINATING"
        • "TERMINATED"
        • "SUSPENDED"
        • "UPDATING"
        • "STOPPING"
        • "STOPPED"
        • "ERROR"
      • BundleId — (String)

        The identifier of the bundle used to create the WorkSpace.

      • SubnetId — (String)

        The identifier of the subnet for the WorkSpace.

      • ErrorMessage — (String)

        The text of the error message that is returned if the WorkSpace cannot be created.

      • ErrorCode — (String)

        The error code that is returned if the WorkSpace cannot be created.

      • ComputerName — (String)

        The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace.

      • VolumeEncryptionKey — (String)

        The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.

      • UserVolumeEncryptionEnabled — (Boolean)

        Indicates whether the data stored on the user volume is encrypted.

      • RootVolumeEncryptionEnabled — (Boolean)

        Indicates whether the data stored on the root volume is encrypted.

      • WorkspaceName — (String)

        The name of the user-decoupled WorkSpace.

      • WorkspaceProperties — (map)

        The properties of the WorkSpace.

        • RunningMode — (String)

          The running mode. For more information, see Manage the WorkSpace Running Mode.

          Note: The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.

          Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?

          Possible values include:
          • "AUTO_STOP"
          • "ALWAYS_ON"
          • "MANUAL"
        • RunningModeAutoStopTimeoutInMinutes — (Integer)

          The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.

        • RootVolumeSizeGib — (Integer)

          The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

        • UserVolumeSizeGib — (Integer)

          The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

        • ComputeTypeName — (String)

          The compute type. For more information, see Amazon WorkSpaces Bundles.

          Possible values include:
          • "VALUE"
          • "STANDARD"
          • "PERFORMANCE"
          • "POWER"
          • "GRAPHICS"
          • "POWERPRO"
          • "GRAPHICSPRO"
          • "GRAPHICS_G4DN"
          • "GRAPHICSPRO_G4DN"
        • Protocols — (Array<String>)

          The protocol. For more information, see Protocols for Amazon WorkSpaces.

          Note:

          • Only available for WorkSpaces created with PCoIP bundles.
          • The Protocols property is case sensitive. Ensure you use PCOIP or WSP.
          • Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
        • OperatingSystemName — (String)

          The name of the operating system.

          Possible values include:
          • "AMAZON_LINUX_2"
          • "UBUNTU_18_04"
          • "UBUNTU_20_04"
          • "UBUNTU_22_04"
          • "UNKNOWN"
          • "WINDOWS_10"
          • "WINDOWS_11"
          • "WINDOWS_7"
          • "WINDOWS_SERVER_2016"
          • "WINDOWS_SERVER_2019"
          • "WINDOWS_SERVER_2022"
          • "RHEL_8"
      • ModificationStates — (Array<map>)

        The modification states of the WorkSpace.

        • Resource — (String)

          The resource.

          Possible values include:
          • "ROOT_VOLUME"
          • "USER_VOLUME"
          • "COMPUTE_TYPE"
        • State — (String)

          The modification state.

          Possible values include:
          • "UPDATE_INITIATED"
          • "UPDATE_IN_PROGRESS"
      • RelatedWorkspaces — (Array<map>)

        The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.

        • WorkspaceId — (String)

          The identifier of the related WorkSpace.

        • Region — (String)

          The Region of the related WorkSpace.

        • State — (String)

          Indicates the state of the WorkSpace.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "IMPAIRED"
          • "UNHEALTHY"
          • "REBOOTING"
          • "STARTING"
          • "REBUILDING"
          • "RESTORING"
          • "MAINTENANCE"
          • "ADMIN_MAINTENANCE"
          • "TERMINATING"
          • "TERMINATED"
          • "SUSPENDED"
          • "UPDATING"
          • "STOPPING"
          • "STOPPED"
          • "ERROR"
        • Type — (String)

          Indicates the type of WorkSpace.

          Possible values include:
          • "PRIMARY"
          • "STANDBY"
      • DataReplicationSettings — (map)

        Indicates the settings of the data replication.

        • DataReplication — (String)

          Indicates whether data replication is enabled, and if enabled, the type of data replication.

          Possible values include:
          • "NO_REPLICATION"
          • "PRIMARY_AS_SOURCE"
        • RecoverySnapshotTime — (Date)

          The date and time at which the last successful snapshot was taken of the primary WorkSpace used for replicating data.

      • StandbyWorkspacesProperties — (Array<map>)

        The properties of the standby WorkSpace

        • StandbyWorkspaceId — (String)

          The identifier of the standby WorkSpace

        • DataReplication — (String)

          Indicates whether data replication is enabled, and if enabled, the type of data replication.

          Possible values include:
          • "NO_REPLICATION"
          • "PRIMARY_AS_SOURCE"
        • RecoverySnapshotTime — (Date)

          The date and time at which the last successful snapshot was taken of the primary WorkSpace used for replicating data.

Returns:

• (AWS.Request) —

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

var params = {
  BundleId: 'STRING_VALUE', /* required */
  Capacity: { /* required */
    DesiredUserSessions: 'NUMBER_VALUE' /* required */
  },
  Description: 'STRING_VALUE', /* required */
  DirectoryId: 'STRING_VALUE', /* required */
  PoolName: 'STRING_VALUE', /* required */
  ApplicationSettings: {
    Status: DISABLED | ENABLED, /* required */
    SettingsGroup: 'STRING_VALUE'
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  TimeoutSettings: {
    DisconnectTimeoutInSeconds: 'NUMBER_VALUE',
    IdleDisconnectTimeoutInSeconds: 'NUMBER_VALUE',
    MaxUserDurationInSeconds: 'NUMBER_VALUE'
  }
};
workspaces.createWorkspacesPool(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: {}) —
  • PoolName — (String)

    The name of the pool.

  • Description — (String)

    The pool description.

  • BundleId — (String)

    The identifier of the bundle for the pool.

  • DirectoryId — (String)

    The identifier of the directory for the pool.

  • Capacity — (map)

    The user capacity of the pool.

    • DesiredUserSessions — required — (Integer)

      The desired number of user sessions for the WorkSpaces in the pool.

  • Tags — (Array<map>)

    The tags for the pool.

    • Key — required — (String)

      The key of the tag.

    • Value — (String)

      The value of the tag.

  • ApplicationSettings — (map)

    Indicates the application settings of the pool.

    • Status — required — (String)

      Enables or disables persistent application settings for users during their pool sessions.

      Possible values include:
      • "DISABLED"
      • "ENABLED"
    • SettingsGroup — (String)

      The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple pools by specifying the same settings group for each pool.

  • TimeoutSettings — (map)

    Indicates the timeout settings of the pool.

    • DisconnectTimeoutInSeconds — (Integer)

      Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

    • IdleDisconnectTimeoutInSeconds — (Integer)

      The amount of time in seconds a connection will stay active while idle.

    • MaxUserDurationInSeconds — (Integer)

      Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

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:

    • WorkspacesPool — (map)

      Indicates the pool to create.

      • PoolId — required — (String)

        The identifier of a pool.

      • PoolArn — required — (String)

        The Amazon Resource Name (ARN) for the pool.

      • CapacityStatus — required — (map)

        The capacity status for the pool

        • AvailableUserSessions — required — (Integer)

          The number of user sessions currently available for streaming from your pool.

          AvailableUserSessions = ActualUserSessions - ActiveUserSessions

        • DesiredUserSessions — required — (Integer)

          The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your pool can support in a steady state.

        • ActualUserSessions — required — (Integer)

          The total number of user sessions that are available for streaming or are currently streaming in your pool.

          ActualUserSessions = AvailableUserSessions + ActiveUserSessions

        • ActiveUserSessions — required — (Integer)

          The number of user sessions currently being used for your pool.

      • PoolName — required — (String)

        The name of the pool,

      • Description — (String)

        The description of the pool.

      • State — required — (String)

        The current state of the pool.

        Possible values include:
        • "CREATING"
        • "DELETING"
        • "RUNNING"
        • "STARTING"
        • "STOPPED"
        • "STOPPING"
        • "UPDATING"
      • CreatedAt — required — (Date)

        The time the pool was created.

      • BundleId — required — (String)

        The identifier of the bundle used by the pool.

      • DirectoryId — required — (String)

        The identifier of the directory used by the pool.

      • Errors — (Array<map>)

        The pool errors.

        • ErrorCode — (String)

          The error code.

          Possible values include:
          • "IAM_SERVICE_ROLE_IS_MISSING"
          • "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION"
          • "IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION"
          • "IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION"
          • "NETWORK_INTERFACE_LIMIT_EXCEEDED"
          • "INTERNAL_SERVICE_ERROR"
          • "MACHINE_ROLE_IS_MISSING"
          • "STS_DISABLED_IN_REGION"
          • "SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES"
          • "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION"
          • "SUBNET_NOT_FOUND"
          • "IMAGE_NOT_FOUND"
          • "INVALID_SUBNET_CONFIGURATION"
          • "SECURITY_GROUPS_NOT_FOUND"
          • "IGW_NOT_ATTACHED"
          • "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION"
          • "WORKSPACES_POOL_STOPPED"
          • "WORKSPACES_POOL_INSTANCE_PROVISIONING_FAILURE"
          • "DOMAIN_JOIN_ERROR_FILE_NOT_FOUND"
          • "DOMAIN_JOIN_ERROR_ACCESS_DENIED"
          • "DOMAIN_JOIN_ERROR_LOGON_FAILURE"
          • "DOMAIN_JOIN_ERROR_INVALID_PARAMETER"
          • "DOMAIN_JOIN_ERROR_MORE_DATA"
          • "DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN"
          • "DOMAIN_JOIN_ERROR_NOT_SUPPORTED"
          • "DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME"
          • "DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED"
          • "DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED"
          • "DOMAIN_JOIN_NERR_PASSWORD_EXPIRED"
          • "DOMAIN_JOIN_INTERNAL_SERVICE_ERROR"
          • "DOMAIN_JOIN_ERROR_SECRET_ACTION_PERMISSION_IS_MISSING"
          • "DOMAIN_JOIN_ERROR_SECRET_DECRYPTION_FAILURE"
          • "DOMAIN_JOIN_ERROR_SECRET_STATE_INVALID"
          • "DOMAIN_JOIN_ERROR_SECRET_NOT_FOUND"
          • "DOMAIN_JOIN_ERROR_SECRET_VALUE_KEY_NOT_FOUND"
          • "DOMAIN_JOIN_ERROR_SECRET_INVALID"
          • "BUNDLE_NOT_FOUND"
          • "DIRECTORY_NOT_FOUND"
          • "INSUFFICIENT_PERMISSIONS_ERROR"
          • "DEFAULT_OU_IS_MISSING"
        • ErrorMessage — (String)

          The error message.

      • ApplicationSettings — (map)

        The persistent application settings for users of the pool.

        • Status — required — (String)

          Specifies whether persistent application settings are enabled for users during their pool sessions.

          Possible values include:
          • "DISABLED"
          • "ENABLED"
        • SettingsGroup — (String)

          The path prefix for the S3 bucket where users’ persistent application settings are stored.

        • S3BucketName — (String)

          The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an Amazon Web Services Region, an S3 bucket is created. The bucket is unique to the Amazon Web Services account and the Region.

      • TimeoutSettings — (map)

        The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.

        • DisconnectTimeoutInSeconds — (Integer)

          Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

        • IdleDisconnectTimeoutInSeconds — (Integer)

          The amount of time in seconds a connection will stay active while idle.

        • MaxUserDurationInSeconds — (Integer)

          Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

Returns:

• (AWS.Request) —

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

var params = {
  LinkId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE'
};
workspaces.deleteAccountLinkInvitation(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: {}) —
  • LinkId — (String)

    The identifier of the account link.

  • ClientToken — (String)

    A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.

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:

    • AccountLink — (map)

      Information about the account link.

      • AccountLinkId — (String)

        The identifier of the account link.

      • AccountLinkStatus — (String)

        The status of the account link.

        Possible values include:
        • "LINKED"
        • "LINKING_FAILED"
        • "LINK_NOT_FOUND"
        • "PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT"
        • "REJECTED"
      • SourceAccountId — (String)

        The identifier of the source account.

      • TargetAccountId — (String)

        The identifier of the target account.

Returns:

• (AWS.Request) —

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

var params = {
  Platforms: [ /* required */
    DeviceTypeWindows | DeviceTypeOsx | DeviceTypeAndroid | DeviceTypeIos | DeviceTypeLinux | DeviceTypeWeb,
    /* more items */
  ],
  ResourceId: 'STRING_VALUE' /* required */
};
workspaces.deleteClientBranding(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: {}) —
  • ResourceId — (String)

    The directory identifier of the WorkSpace for which you want to delete client branding.

  • Platforms — (Array<String>)

    The device type for which you want to delete client branding.

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 = {
  AddInId: 'STRING_VALUE', /* required */
  ResourceId: 'STRING_VALUE' /* required */
};
workspaces.deleteConnectClientAddIn(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: {}) —
  • AddInId — (String)

    The identifier of the client add-in to delete.

  • ResourceId — (String)

    The directory identifier for which the client add-in is configured.

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

    The identifier of the connection alias to delete.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

    The identifier of the IP access control group.

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 = {
  ResourceId: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
workspaces.deleteTags(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: {}) —
  • ResourceId — (String)

    The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.

  • TagKeys — (Array<String>)

    The tag keys.

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 = {
  BundleId: 'STRING_VALUE'
};
workspaces.deleteWorkspaceBundle(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: {}) —
  • BundleId — (String)

    The identifier of the bundle.

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

    The identifier of the image.

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 = {
  WorkspaceId: 'STRING_VALUE', /* required */
  Force: true || false
};
workspaces.deployWorkspaceApplications(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: {}) —
  • WorkspaceId — (String)

    The identifier of the WorkSpace.

  • Force — (Boolean)

    Indicates whether the force flag is applied for the specified WorkSpace. When the force flag is enabled, it allows previously failed deployments to be retried.

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:

    • Deployment — (map)

      The list of deployed associations and information about them.

      • Associations — (Array<map>)

        The associations between the applications and the associated resources.

        • AssociatedResourceId — (String)

          The identifier of the associated resource.

        • AssociatedResourceType — (String)

          The resource types of the associated resource.

          Possible values include:
          • "APPLICATION"
        • Created — (Date)

          The time the association is created.

        • LastUpdatedTime — (Date)

          The time the association status was last updated.

        • State — (String)

          The status of the WorkSpace resource association.

          Possible values include:
          • "PENDING_INSTALL"
          • "PENDING_INSTALL_DEPLOYMENT"
          • "PENDING_UNINSTALL"
          • "PENDING_UNINSTALL_DEPLOYMENT"
          • "INSTALLING"
          • "UNINSTALLING"
          • "ERROR"
          • "COMPLETED"
          • "REMOVED"
        • StateReason — (map)

          The reason the association deployment failed.

          • ErrorCode — (String)

            The error code of the association deployment failure.

            Possible values include:
            • "ValidationError.InsufficientDiskSpace"
            • "ValidationError.InsufficientMemory"
            • "ValidationError.UnsupportedOperatingSystem"
            • "DeploymentError.InternalServerError"
            • "DeploymentError.WorkspaceUnreachable"
          • ErrorMessage — (String)

            The error message of the association deployment failure.

        • WorkspaceId — (String)

          The identifier of the WorkSpace.

Returns:

• (AWS.Request) —

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

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

    The identifier of the directory. If any WorkSpaces are registered to this directory, you must remove them before you deregister the directory, or you will receive an OperationNotSupportedException error.

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 = {
};
workspaces.describeAccount(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: {})

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:

    • DedicatedTenancySupport — (String)

      The status of BYOL (whether BYOL is enabled or disabled).

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • DedicatedTenancyManagementCidrRange — (String)

      The IP address range, specified as an IPv4 CIDR block, used for the management network interface.

      The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.

    • DedicatedTenancyAccountType — (String)

      The type of linked account.

      Possible values include:
      • "SOURCE_ACCOUNT"
      • "TARGET_ACCOUNT"

Returns:

• (AWS.Request) —

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

var params = {
  NextToken: 'STRING_VALUE'
};
workspaces.describeAccountModifications(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 you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • AccountModifications — (Array<map>)

      The list of modifications to the configuration of BYOL.

      • ModificationState — (String)

        The state of the modification to the configuration of BYOL.

        Possible values include:
        • "PENDING"
        • "COMPLETED"
        • "FAILED"
      • DedicatedTenancySupport — (String)

        The status of BYOL (whether BYOL is being enabled or disabled).

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • DedicatedTenancyManagementCidrRange — (String)

        The IP address range, specified as an IPv4 CIDR block, for the management network interface used for the account.

      • StartTime — (Date)

        The timestamp when the modification of the BYOL configuration was started.

      • ErrorCode — (String)

        The error code that is returned if the configuration of BYOL cannot be modified.

      • ErrorMessage — (String)

        The text of the error message that is returned if the configuration of BYOL cannot be modified.

    • NextToken — (String)

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

• (AWS.Request) —

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

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  AssociatedResourceTypes: [ /* required */
    WORKSPACE | BUNDLE | IMAGE,
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
workspaces.describeApplicationAssociations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The maximum number of associations to return.

  • NextToken — (String)

    If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

  • ApplicationId — (String)

    The identifier of the specified application.

  • AssociatedResourceTypes — (Array<String>)

    The resource type of the associated resources.

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:

    • Associations — (Array<map>)

      List of associations and information about them.

      • ApplicationId — (String)

        The identifier of the application.

      • AssociatedResourceId — (String)

        The identifier of the associated resource.

      • AssociatedResourceType — (String)

        The resource type of the associated resource.

        Possible values include:
        • "WORKSPACE"
        • "BUNDLE"
        • "IMAGE"
      • Created — (Date)

        The time the association was created.

      • LastUpdatedTime — (Date)

        The time the association status was last updated.

      • State — (String)

        The status of the application resource association.

        Possible values include:
        • "PENDING_INSTALL"
        • "PENDING_INSTALL_DEPLOYMENT"
        • "PENDING_UNINSTALL"
        • "PENDING_UNINSTALL_DEPLOYMENT"
        • "INSTALLING"
        • "UNINSTALLING"
        • "ERROR"
        • "COMPLETED"
        • "REMOVED"
      • StateReason — (map)

        The reason the association deployment failed.

        • ErrorCode — (String)

          The error code of the association deployment failure.

          Possible values include:
          • "ValidationError.InsufficientDiskSpace"
          • "ValidationError.InsufficientMemory"
          • "ValidationError.UnsupportedOperatingSystem"
          • "DeploymentError.InternalServerError"
          • "DeploymentError.WorkspaceUnreachable"
        • ErrorMessage — (String)

          The error message of the association deployment failure.

    • NextToken — (String)

      If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Returns:

• (AWS.Request) —

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

var params = {
  ApplicationIds: [
    'STRING_VALUE',
    /* more items */
  ],
  ComputeTypeNames: [
    VALUE | STANDARD | PERFORMANCE | POWER | GRAPHICS | POWERPRO | GRAPHICSPRO | GRAPHICS_G4DN | GRAPHICSPRO_G4DN,
    /* more items */
  ],
  LicenseType: LICENSED | UNLICENSED,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  OperatingSystemNames: [
    AMAZON_LINUX_2 | UBUNTU_18_04 | UBUNTU_20_04 | UBUNTU_22_04 | UNKNOWN | WINDOWS_10 | WINDOWS_11 | WINDOWS_7 | WINDOWS_SERVER_2016 | WINDOWS_SERVER_2019 | WINDOWS_SERVER_2022 | RHEL_8,
    /* more items */
  ],
  Owner: 'STRING_VALUE'
};
workspaces.describeApplications(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: {}) —
  • ApplicationIds — (Array<String>)

    The identifiers of one or more applications.

  • ComputeTypeNames — (Array<String>)

    The compute types supported by the applications.

  • LicenseType — (String)

    The license availability for the applications.

    Possible values include:
    • "LICENSED"
    • "UNLICENSED"
  • OperatingSystemNames — (Array<String>)

    The operating systems supported by the applications.

  • Owner — (String)

    The owner of the applications.

  • MaxResults — (Integer)

    The maximum number of applications to return.

  • NextToken — (String)

    If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • Applications — (Array<map>)

      List of information about the specified applications.

      • ApplicationId — (String)

        The identifier of the application.

      • Created — (Date)

        The time the application is created.

      • Description — (String)

        The description of the WorkSpace application.

      • LicenseType — (String)

        The license availability for the applications.

        Possible values include:
        • "LICENSED"
        • "UNLICENSED"
      • Name — (String)

        The name of the WorkSpace application.

      • Owner — (String)

        The owner of the WorkSpace application.

      • State — (String)

        The status of WorkSpace application.

        Possible values include:
        • "PENDING"
        • "ERROR"
        • "AVAILABLE"
        • "UNINSTALL_ONLY"
      • SupportedComputeTypeNames — (Array<String>)

        The supported compute types of the WorkSpace application.

      • SupportedOperatingSystemNames — (Array<String>)

        The supported operating systems of the WorkSpace application.

    • NextToken — (String)

      If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Returns:

• (AWS.Request) —

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

var params = {
  AssociatedResourceTypes: [ /* required */
    APPLICATION,
    /* more items */
  ],
  BundleId: 'STRING_VALUE' /* required */
};
workspaces.describeBundleAssociations(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: {}) —
  • BundleId — (String)

    The identifier of the bundle.

  • AssociatedResourceTypes — (Array<String>)

    The resource types of the associated 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:

    • Associations — (Array<map>)

      List of information about the specified associations.

      • AssociatedResourceId — (String)

        The identifier of the associated resource.

      • AssociatedResourceType — (String)

        The resource type of the associated resources.

        Possible values include:
        • "APPLICATION"
      • BundleId — (String)

        The identifier of the bundle.

      • Created — (Date)

        The time the association is created.

      • LastUpdatedTime — (Date)

        The time the association status was last updated.

      • State — (String)

        The status of the bundle resource association.

        Possible values include:
        • "PENDING_INSTALL"
        • "PENDING_INSTALL_DEPLOYMENT"
        • "PENDING_UNINSTALL"
        • "PENDING_UNINSTALL_DEPLOYMENT"
        • "INSTALLING"
        • "UNINSTALLING"
        • "ERROR"
        • "COMPLETED"
        • "REMOVED"
      • StateReason — (map)

        The reason the association deployment failed.

        • ErrorCode — (String)

          The error code of the association deployment failure.

          Possible values include:
          • "ValidationError.InsufficientDiskSpace"
          • "ValidationError.InsufficientMemory"
          • "ValidationError.UnsupportedOperatingSystem"
          • "DeploymentError.InternalServerError"
          • "DeploymentError.WorkspaceUnreachable"
        • ErrorMessage — (String)

          The error message of the association deployment failure.

Returns:

• (AWS.Request) —

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

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

    The directory identifier of the WorkSpace for which you want to view client branding 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:

    • DeviceTypeWindows — (map)

      The branding information for Windows devices.

      • LogoUrl — (String)

        The logo. The only image format accepted is a binary data object that is converted from a .png file.

      • SupportEmail — (String)

        The support email. The company's customer support email address.

        Note:

        • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
        • The default email is workspaces-feedback@amazon.com.
      • SupportLink — (String)

        The support link. The link for the company's customer support page for their WorkSpace.

        Note:

        • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.
        • The default support link is workspaces-feedback@amazon.com.
      • ForgotPasswordLink — (String)

        The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

      • LoginMessage — (map<String>)

        The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.

    • DeviceTypeOsx — (map)

      The branding information for macOS devices.

      • LogoUrl — (String)

        The logo. The only image format accepted is a binary data object that is converted from a .png file.

      • SupportEmail — (String)

        The support email. The company's customer support email address.

        Note:

        • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
        • The default email is workspaces-feedback@amazon.com.
      • SupportLink — (String)

        The support link. The link for the company's customer support page for their WorkSpace.

        Note:

        • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.
        • The default support link is workspaces-feedback@amazon.com.
      • ForgotPasswordLink — (String)

        The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

      • LoginMessage — (map<String>)

        The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.

    • DeviceTypeAndroid — (map)

      The branding information for Android devices.

      • LogoUrl — (String)

        The logo. The only image format accepted is a binary data object that is converted from a .png file.

      • SupportEmail — (String)

        The support email. The company's customer support email address.

        Note:

        • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
        • The default email is workspaces-feedback@amazon.com.
      • SupportLink — (String)

        The support link. The link for the company's customer support page for their WorkSpace.

        Note:

        • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.
        • The default support link is workspaces-feedback@amazon.com.
      • ForgotPasswordLink — (String)

        The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

      • LoginMessage — (map<String>)

        The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.

    • DeviceTypeIos — (map)

      The branding information for iOS devices.

      • LogoUrl — (String)

        The logo. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point. The only image format accepted is a binary data object that is converted from a .png file.

      • Logo2xUrl — (String)

        The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x). The only image format accepted is a binary data object that is converted from a .png file.

        Note: For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
      • Logo3xUrl — (String)

        The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x).The only image format accepted is a binary data object that is converted from a .png file.

        Note: For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
      • SupportEmail — (String)

        The support email. The company's customer support email address.

        Note:

        • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
        • The default email is workspaces-feedback@amazon.com.
      • SupportLink — (String)

        The support link. The link for the company's customer support page for their WorkSpace.

        Note:

        • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
        • The default support link is workspaces-feedback@amazon.com.
      • ForgotPasswordLink — (String)

        The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

      • LoginMessage — (map<String>)

        The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.

    • DeviceTypeLinux — (map)

      The branding information for Linux devices.

      • LogoUrl — (String)

        The logo. The only image format accepted is a binary data object that is converted from a .png file.

      • SupportEmail — (String)

        The support email. The company's customer support email address.

        Note:

        • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
        • The default email is workspaces-feedback@amazon.com.
      • SupportLink — (String)

        The support link. The link for the company's customer support page for their WorkSpace.

        Note:

        • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.
        • The default support link is workspaces-feedback@amazon.com.
      • ForgotPasswordLink — (String)

        The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

      • LoginMessage — (map<String>)

        The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.

    • DeviceTypeWeb — (map)

      The branding information for Web access.

      • LogoUrl — (String)

        The logo. The only image format accepted is a binary data object that is converted from a .png file.

      • SupportEmail — (String)

        The support email. The company's customer support email address.

        Note:

        • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
        • The default email is workspaces-feedback@amazon.com.
      • SupportLink — (String)

        The support link. The link for the company's customer support page for their WorkSpace.

        Note:

        • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.
        • The default support link is workspaces-feedback@amazon.com.
      • ForgotPasswordLink — (String)

        The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

      • LoginMessage — (map<String>)

        The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.

Returns:

• (AWS.Request) —

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

var params = {
  ResourceIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
workspaces.describeClientProperties(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: {}) —
  • ResourceIds — (Array<String>)

    The resource identifier, in the form of directory IDs.

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:

    • ClientPropertiesList — (Array<map>)

      Information about the specified Amazon WorkSpaces clients.

      • ResourceId — (String)

        The resource identifier, in the form of a directory ID.

      • ClientProperties — (map)

        Information about the Amazon WorkSpaces client.

        • ReconnectEnabled — (String)

          Specifies whether users can cache their credentials on the Amazon WorkSpaces client. When enabled, users can choose to reconnect to their WorkSpaces without re-entering their credentials.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
        • LogUploadEnabled — (String)

          Specifies whether users can upload diagnostic log files of Amazon WorkSpaces client directly to WorkSpaces to troubleshoot issues when using the WorkSpaces client. When enabled, the log files will be sent to WorkSpaces automatically and will be applied to all users in the specified directory.

          Possible values include:
          • "ENABLED"
          • "DISABLED"

Returns:

• (AWS.Request) —

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

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
workspaces.describeConnectClientAddIns(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: {}) —
  • ResourceId — (String)

    The directory identifier for which the client add-in is configured.

  • NextToken — (String)

    If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

  • MaxResults — (Integer)

    The maximum number of items to return.

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:

    • AddIns — (Array<map>)

      Information about client add-ins.

      • AddInId — (String)

        The client add-in identifier.

      • ResourceId — (String)

        The directory identifier for which the client add-in is configured.

      • Name — (String)

        The name of the client add in.

      • URL — (String)

        The endpoint URL of the client add-in.

    • NextToken — (String)

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

• (AWS.Request) —

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

var params = {
  AliasIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ResourceId: 'STRING_VALUE'
};
workspaces.describeConnectionAliases(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: {}) —
  • AliasIds — (Array<String>)

    The identifiers of the connection aliases to describe.

  • ResourceId — (String)

    The identifier of the directory associated with the connection alias.

  • Limit — (Integer)

    The maximum number of connection aliases to return.

  • NextToken — (String)

    If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ConnectionAliases — (Array<map>)

      Information about the specified connection aliases.

      • ConnectionString — (String)

        The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com.

      • AliasId — (String)

        The identifier of the connection alias.

      • State — (String)

        The current state of the connection alias.

        Possible values include:
        • "CREATING"
        • "CREATED"
        • "DELETING"
      • OwnerAccountId — (String)

        The identifier of the Amazon Web Services account that owns the connection alias.

      • Associations — (Array<map>)

        The association status of the connection alias.

        • AssociationStatus — (String)

          The association status of the connection alias.

          Possible values include:
          • "NOT_ASSOCIATED"
          • "ASSOCIATED_WITH_OWNER_ACCOUNT"
          • "ASSOCIATED_WITH_SHARED_ACCOUNT"
          • "PENDING_ASSOCIATION"
          • "PENDING_DISASSOCIATION"
        • AssociatedAccountId — (String)

          The identifier of the Amazon Web Services account that associated the connection alias with a directory.

        • ResourceId — (String)

          The identifier of the directory associated with a connection alias.

        • ConnectionIdentifier — (String)

          The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you're configuring your DNS routing policies.

    • NextToken — (String)

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

• (AWS.Request) —

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

var params = {
  AliasId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
workspaces.describeConnectionAliasPermissions(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: {}) —
  • AliasId — (String)

    The identifier of the connection alias.

  • NextToken — (String)

    If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

  • MaxResults — (Integer)

    The maximum number of results to return.

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:

    • AliasId — (String)

      The identifier of the connection alias.

    • ConnectionAliasPermissions — (Array<map>)

      The permissions associated with a connection alias.

      • SharedAccountId — required — (String)

        The identifier of the Amazon Web Services account that the connection alias is shared with.

      • AllowAssociation — required — (Boolean)

        Indicates whether the specified Amazon Web Services account is allowed to associate the connection alias with a directory.

    • NextToken — (String)

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

• (AWS.Request) —

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

var params = {
  AssociatedResourceTypes: [ /* required */
    APPLICATION,
    /* more items */
  ],
  ImageId: 'STRING_VALUE' /* required */
};
workspaces.describeImageAssociations(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: {}) —
  • ImageId — (String)

    The identifier of the image.

  • AssociatedResourceTypes — (Array<String>)

    The resource types of the associated 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:

    • Associations — (Array<map>)

      List of information about the specified associations.

      • AssociatedResourceId — (String)

        The identifier of the associated resource.

      • AssociatedResourceType — (String)

        The resource type of the associated resources.

        Possible values include:
        • "APPLICATION"
      • Created — (Date)

        The time the association is created.

      • LastUpdatedTime — (Date)

        The time the association status was last updated.

      • ImageId — (String)

        The identifier of the image.

      • State — (String)

        The status of the image resource association.

        Possible values include:
        • "PENDING_INSTALL"
        • "PENDING_INSTALL_DEPLOYMENT"
        • "PENDING_UNINSTALL"
        • "PENDING_UNINSTALL_DEPLOYMENT"
        • "INSTALLING"
        • "UNINSTALLING"
        • "ERROR"
        • "COMPLETED"
        • "REMOVED"
      • StateReason — (map)

        The reason the association deployment failed.

        • ErrorCode — (String)

          The error code of the association deployment failure.

          Possible values include:
          • "ValidationError.InsufficientDiskSpace"
          • "ValidationError.InsufficientMemory"
          • "ValidationError.UnsupportedOperatingSystem"
          • "DeploymentError.InternalServerError"
          • "DeploymentError.WorkspaceUnreachable"
        • ErrorMessage — (String)

          The error message of the association deployment failure.

Returns:

• (AWS.Request) —

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

var params = {
  GroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
workspaces.describeIpGroups(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: {}) —
  • GroupIds — (Array<String>)

    The identifiers of one or more IP access control groups.

  • NextToken — (String)

    If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

  • MaxResults — (Integer)

    The maximum number of items to return.

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:

    • Result — (Array<map>)

      Information about the IP access control groups.

      • groupId — (String)

        The identifier of the group.

      • groupName — (String)

        The name of the group.

      • groupDesc — (String)

        The description of the group.

      • userRules — (Array<map>)

        The rules.

        • ipRule — (String)

          The IP address range, in CIDR notation.

        • ruleDesc — (String)

          The description.

    • NextToken — (String)

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

• (AWS.Request) —

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

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

    The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.

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:

    • TagList — (Array<map>)

      The tags.

      • Key — required — (String)

        The key of the tag.

      • Value — (String)

        The value of the tag.

Returns:

• (AWS.Request) —

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

var params = {
  AssociatedResourceTypes: [ /* required */
    APPLICATION,
    /* more items */
  ],
  WorkspaceId: 'STRING_VALUE' /* required */
};
workspaces.describeWorkspaceAssociations(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: {}) —
  • WorkspaceId — (String)

    The identifier of the WorkSpace.

  • AssociatedResourceTypes — (Array<String>)

    The resource types of the associated resources.

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:

    • Associations — (Array<map>)

      List of information about the specified associations.

      • AssociatedResourceId — (String)

        The identifier of the associated resource.

      • AssociatedResourceType — (String)

        The resource types of the associated resource.

        Possible values include:
        • "APPLICATION"
      • Created — (Date)

        The time the association is created.

      • LastUpdatedTime — (Date)

        The time the association status was last updated.

      • State — (String)

        The status of the WorkSpace resource association.

        Possible values include:
        • "PENDING_INSTALL"
        • "PENDING_INSTALL_DEPLOYMENT"
        • "PENDING_UNINSTALL"
        • "PENDING_UNINSTALL_DEPLOYMENT"
        • "INSTALLING"
        • "UNINSTALLING"
        • "ERROR"
        • "COMPLETED"
        • "REMOVED"
      • StateReason — (map)

        The reason the association deployment failed.

        • ErrorCode — (String)

          The error code of the association deployment failure.

          Possible values include:
          • "ValidationError.InsufficientDiskSpace"
          • "ValidationError.InsufficientMemory"
          • "ValidationError.UnsupportedOperatingSystem"
          • "DeploymentError.InternalServerError"
          • "DeploymentError.WorkspaceUnreachable"
        • ErrorMessage — (String)

          The error message of the association deployment failure.

      • WorkspaceId — (String)

        The identifier of the WorkSpace.

Returns:

• (AWS.Request) —

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