We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.WorkSpaces

Inherits:
AWS.Service show all
Identifier:
workspaces
API Version:
2015-04-08
Defined in:
(unknown)

Overview

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

Service Description

Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows or Amazon Linux desktops for your users, known as WorkSpaces. WorkSpaces eliminates the need to procure and deploy hardware or install complex software. You can quickly add or remove users as your needs change. Users can access their virtual desktops from multiple devices or web browsers.

This API Reference provides detailed information about the actions, data types, parameters, and errors of the WorkSpaces service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Amazon WorkSpaces service, see WorkSpaces endpoints and quotas in the Amazon Web Services General Reference.

You can also manage your WorkSpaces resources using the WorkSpaces console, Command Line Interface (CLI), and SDKs. For more information about administering WorkSpaces, see the Amazon WorkSpaces Administration Guide. For more information about using the Amazon WorkSpaces client application or web browser to access provisioned WorkSpaces, see the Amazon WorkSpaces User Guide. For more information about using the CLI to manage your WorkSpaces resources, see the WorkSpaces section of the CLI Reference.

Sending a Request Using WorkSpaces

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

Locking the API Version

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

var workspaces = new AWS.WorkSpaces({apiVersion: '2015-04-08'});

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

AWS.config.apiVersions = {
  workspaces: '2015-04-08',
  // other service API versions
};

var workspaces = new AWS.WorkSpaces();

Version:

  • 2015-04-08

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a WorkSpaces object

var workspaces = new AWS.WorkSpaces({apiVersion: '2015-04-08'});

Options Hash (options):

  • params (map)

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

  • endpoint (String|AWS.Endpoint)

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

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

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

  • credentialProvider (AWS.CredentialProviderChain)

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

  • region (String)

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

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

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

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

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

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

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

  • convertResponseTypes (Boolean)

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

  • correctClockSkew (Boolean)

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

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

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

  • s3DisableBodySigning (Boolean)

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

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

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

  • s3UseArnRegion (Boolean)

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

  • retryDelayOptions (map)

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

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

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

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

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

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

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

  • logger (#write, #log)

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

  • systemClockOffset (Number)

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

  • signatureVersion (String)

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

  • signatureCache (Boolean)

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

  • dynamoDbCrc32 (Boolean)

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

  • useAccelerateEndpoint (Boolean)

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

  • clientSideMonitoring (Boolean)

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

  • endpointDiscoveryEnabled (Boolean|undefined)

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

  • endpointCacheSize (Number)

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

  • hostPrefixEnabled (Boolean)

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

  • stsRegionalEndpoints ('legacy'|'regional')

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

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Accepts the account link invitation.

There's currently no unlinking capability after you accept the account linking invitation.

Service Reference:

Examples:

Calling the acceptAccountLinkInvitation operation

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

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

Associates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Note: Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.

Service Reference:

Examples:

Calling the associateConnectionAlias operation

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.

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

Associates the specified IP access control group with the specified directory.

Service Reference:

Examples:

Calling the associateIpGroups operation

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.

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

Associates the specified application to the specified WorkSpace.

Service Reference:

Examples:

Calling the associateWorkspaceApplication operation

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.

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

Adds one or more rules to the specified IP access control group.

This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules.

Service Reference:

Examples:

Calling the authorizeIpRules operation

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.

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

Copies the specified image from the specified Region to the current Region. For more information about copying images, see Copy a Custom WorkSpaces Image.

In the China (Ningxia) Region, you can copy images only within the same Region.

In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.

Before copying a shared image, be sure to verify that it has been shared from the correct Amazon Web Services account. To determine if an image has been shared and to see the ID of the Amazon Web Services account that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations.

Service Reference:

Examples:

Calling the copyWorkspaceImage operation

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.

      • Keyrequired — (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.

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

Creates the account link invitation.

Service Reference:

Examples:

Calling the createAccountLinkInvitation operation

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.

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

Creates a client-add-in for Amazon Connect within a directory. You can create only one Amazon Connect client add-in within a directory.

This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect.

Service Reference:

Examples:

Calling the createConnectClientAddIn operation

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.

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

Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Service Reference:

Examples:

Calling the createConnectionAlias operation

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.

      • Keyrequired — (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.

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

Creates an IP access control group.

An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using AuthorizeIpRules.

There is a default IP access control group associated with your directory. If you don't associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory.

Service Reference:

Examples:

Calling the createIpGroup operation

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.

      • Keyrequired — (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.

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

Creates a standby WorkSpace in a secondary Region.

Service Reference:

Examples:

Calling the createStandbyWorkspaces operation

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.

      • PrimaryWorkspaceIdrequired — (String)

        The identifier of the standby WorkSpace.

      • VolumeEncryptionKey — (String)

        The volume encryption key of the standby WorkSpace.

      • DirectoryIdrequired — (String)

        The identifier of the directory for the standby WorkSpace.

      • Tags — (Array<map>)

        The tags associated with the standby WorkSpace.

        • Keyrequired — (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.

          • PrimaryWorkspaceIdrequired — (String)

            The identifier of the standby WorkSpace.

          • VolumeEncryptionKey — (String)

            The volume encryption key of the standby WorkSpace.

          • DirectoryIdrequired — (String)

            The identifier of the directory for the standby WorkSpace.

          • Tags — (Array<map>)

            The tags associated with the standby WorkSpace.

            • Keyrequired — (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.

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

Creates the specified tags for the specified WorkSpaces resource.

Service Reference:

Examples:

Calling the createTags operation

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.

      • Keyrequired — (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.

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

Creates a new updated WorkSpace image based on the specified source image. The new updated WorkSpace image has the latest drivers and other updates required by the Amazon WorkSpaces components.

To determine which WorkSpace images need to be updated with the latest Amazon WorkSpaces requirements, use DescribeWorkspaceImages.

Note:
  • Only Windows 10, Windows Server 2016, and Windows Server 2019 WorkSpace images can be programmatically updated at this time.
  • Microsoft Windows updates and other application updates are not included in the update process.
  • The source WorkSpace image is not deleted. You can delete the source image after you've verified your new updated image and created a new bundle.

Service Reference:

Examples:

Calling the createUpdatedWorkspaceImage operation

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.
      • Keyrequired — (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.

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

Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle.

Service Reference:

Examples:

Calling the createWorkspaceBundle operation

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.

      • Capacityrequired — (String)

        The size of the user volume.

    • RootStorage — (map)

      Describes the root volume for a WorkSpace bundle.

      • Capacityrequired — (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.
      • Keyrequired — (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.

          • Capacityrequired — (String)

            The size of the root volume.

        • UserStorage — (map)

          The size of the user volume.

          • Capacityrequired — (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.

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

Creates a new WorkSpace image from an existing WorkSpace.

Service Reference:

Examples:

Calling the createWorkspaceImage operation

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.

      • Keyrequired — (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.

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

Creates one or more WorkSpaces.

This operation is asynchronous and returns before the WorkSpaces are created.

Note:
  • The MANUAL running mode 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.
  • You don't need to specify the PCOIP protocol for Linux bundles because WSP is the default protocol for those bundles.
  • User-decoupled WorkSpaces are only supported by 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?

Service Reference:

Examples:

Calling the createWorkspaces operation

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.

      • DirectoryIdrequired — (String)

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

      • UserNamerequired — (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.

      • BundleIdrequired — (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.

        • Keyrequired — (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.

          • DirectoryIdrequired — (String)

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

          • UserNamerequired — (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.

          • BundleIdrequired — (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.

            • Keyrequired — (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.

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

Creates a pool of WorkSpaces.

Service Reference:

Examples:

Calling the createWorkspacesPool operation

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.

      • DesiredUserSessionsrequired — (Integer)

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

    • Tags — (Array<map>)

      The tags for the pool.

      • Keyrequired — (String)

        The key of the tag.

      • Value — (String)

        The value of the tag.

    • ApplicationSettings — (map)

      Indicates the application settings of the pool.

      • Statusrequired — (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.

        • PoolIdrequired — (String)

          The identifier of a pool.

        • PoolArnrequired — (String)

          The Amazon Resource Name (ARN) for the pool.

        • CapacityStatusrequired — (map)

          The capacity status for the pool

          • AvailableUserSessionsrequired — (Integer)

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

            AvailableUserSessions = ActualUserSessions - ActiveUserSessions

          • DesiredUserSessionsrequired — (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.

          • ActualUserSessionsrequired — (Integer)

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

            ActualUserSessions = AvailableUserSessions + ActiveUserSessions

          • ActiveUserSessionsrequired — (Integer)

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

        • PoolNamerequired — (String)

          The name of the pool,

        • Description — (String)

          The description of the pool.

        • Staterequired — (String)

          The current state of the pool.

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

          The time the pool was created.

        • BundleIdrequired — (String)

          The identifier of the bundle used by the pool.

        • DirectoryIdrequired — (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.

          • Statusrequired — (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.

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

Deletes the account link invitation.

Service Reference:

Examples:

Calling the deleteAccountLinkInvitation operation

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.

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

Deletes customized client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.

After you delete your customized client branding, your login portal reverts to the default client branding.

Service Reference:

Examples:

Calling the deleteClientBranding operation

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.

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

Deletes a client-add-in for Amazon Connect that is configured within a directory.

Service Reference:

Examples:

Calling the deleteConnectClientAddIn operation

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.

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

Deletes the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

If you will no longer be using a fully qualified domain name (FQDN) as the registration code for your WorkSpaces users, you must take certain precautions to prevent potential security issues. For more information, see Security Considerations if You Stop Using Cross-Region Redirection.

Note: To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.

Service Reference:

Examples:

Calling the deleteConnectionAlias operation

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.

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

Deletes the specified IP access control group.

You cannot delete an IP access control group that is associated with a directory.

Service Reference:

Examples:

Calling the deleteIpGroup operation

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.

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

Deletes the specified tags from the specified WorkSpaces resource.

Service Reference:

Examples:

Calling the deleteTags operation

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.

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

Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image.

Service Reference:

Examples:

Calling the deleteWorkspaceBundle operation

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.

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

Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and unshare the image if it is shared with other accounts.

Service Reference:

Examples:

Calling the deleteWorkspaceImage operation

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.

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

Deploys associated applications to the specified WorkSpace

Service Reference:

Examples:

Calling the deployWorkspaceApplications operation

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.

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

Deregisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is deregistered. If any WorkSpaces are registered to this directory, you must remove them before you can deregister the directory.

Note: Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing terms. To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.

Service Reference:

Examples:

Calling the deregisterWorkspaceDirectory operation

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.

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

Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.

Service Reference:

Examples:

Calling the describeAccount operation

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.

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

Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.

Service Reference:

Examples:

Calling the describeAccountModifications operation

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.

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

Describes the associations between the application and the specified associated resources.

Service Reference:

Examples:

Calling the describeApplicationAssociations operation

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.

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

Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.

Service Reference:

Examples:

Calling the describeApplications operation

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.

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

Describes the associations between the applications and the specified bundle.

Service Reference:

Examples:

Calling the describeBundleAssociations operation

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.

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

Describes the specified client branding. Client branding allows you to customize the log in page of various device types for your users. You can add your company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.

Note: Only device types that have branding information configured will be shown in the response.

Service Reference:

Examples:

Calling the describeClientBranding operation

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.

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

Retrieves a list that describes one or more specified Amazon WorkSpaces clients.

Service Reference:

Examples:

Calling the describeClientProperties operation

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.

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

Retrieves a list of Amazon Connect client add-ins that have been created.

Service Reference:

Examples:

Calling the describeConnectClientAddIns operation

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.

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

Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Service Reference:

Examples:

Calling the describeConnectionAliases operation

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.

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

Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Examples:

Calling the describeConnectionAliasPermissions operation

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.

        • SharedAccountIdrequired — (String)

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

        • AllowAssociationrequired — (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.

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

Describes the associations between the applications and the specified image.

Service Reference:

Examples:

Calling the describeImageAssociations operation

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.

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

Describes one or more of your IP access control groups.

Service Reference:

Examples:

Calling the describeIpGroups operation

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.

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

Describes the specified tags for the specified WorkSpaces resource.

Service Reference:

Examples:

Calling the describeTags operation

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.

        • Keyrequired — (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.

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

Describes the associations betweens applications and the specified WorkSpace.

Service Reference:

Examples:

Calling the describeWorkspaceAssociations operation

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.

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

Retrieves a list that describes the available WorkSpace bundles.

You can filter the results using either bundle ID or owner, but not both.

Service Reference:

Examples:

Calling the describeWorkspaceBundles operation

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

      The identifiers of the bundles. You cannot combine this parameter with any other filter.

    • Owner — (String)

      The owner of the bundles. You cannot combine this parameter with any other filter.

      To describe the bundles provided by Amazon Web Services, specify AMAZON. To describe the bundles that belong to your account, don't specify a value.

    • NextToken — (String)

      The token for the next set of results. (You received this token from a previous call.)

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:

      • Bundles — (Array<map>)

        Information about the bundles.

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

          • Capacityrequired — (String)

            The size of the root volume.

        • UserStorage — (map)

          The size of the user volume.

          • Capacityrequired — (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"
      • 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. This token is valid for one day and must be used within that time frame.

Returns:

  • (AWS.Request)

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

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

Describes the available directories that are registered with Amazon WorkSpaces.

Service Reference:

Examples:

Calling the describeWorkspaceDirectories operation

var params = {
  DirectoryIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Filters: [
    {
      Name: USER_IDENTITY_TYPE | WORKSPACE_TYPE, /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  WorkspaceDirectoryNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
workspaces.describeWorkspaceDirectories(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: {})
    • DirectoryIds — (Array<String>)

      The identifiers of the directories. If the value is null, all directories are retrieved.

    • WorkspaceDirectoryNames — (Array<String>)

      The names of the WorkSpace directories.

    • Limit — (Integer)

      The maximum number of directories 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.

    • Filters — (Array<map>)

      The filter condition for the WorkSpaces.

      • Namerequired — (String)

        The name of the WorkSpaces to filter.

        Possible values include:
        • "USER_IDENTITY_TYPE"
        • "WORKSPACE_TYPE"
      • Valuesrequired — (Array<String>)

        The values for filtering 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:

      • Directories — (Array<map>)

        Information about the directories.

        • DirectoryId — (String)

          The directory identifier.

        • Alias — (String)

          The directory alias.

        • DirectoryName — (String)

          The name of the directory.

        • RegistrationCode — (String)

          The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.

        • SubnetIds — (Array<String>)

          The identifiers of the subnets used with the directory.

        • DnsIpAddresses — (Array<String>)

          The IP addresses of the DNS servers for the directory.

        • CustomerUserName — (String)

          The user name for the service account.

        • IamRoleId — (String)

          The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.

        • DirectoryType — (String)

          The directory type.

          Possible values include:
          • "SIMPLE_AD"
          • "AD_CONNECTOR"
          • "CUSTOMER_MANAGED"
          • "AWS_IAM_IDENTITY_CENTER"
        • WorkspaceSecurityGroupId — (String)

          The identifier of the security group that is assigned to new WorkSpaces.

        • State — (String)

          The state of the directory's registration with Amazon WorkSpaces. After a directory is deregistered, the DEREGISTERED state is returned very briefly before the directory metadata is cleaned up, so this state is rarely returned. To confirm that a directory is deregistered, check for the directory ID by using DescribeWorkspaceDirectories. If the directory ID isn't returned, then the directory has been successfully deregistered.

          Possible values include:
          • "REGISTERING"
          • "REGISTERED"
          • "DEREGISTERING"
          • "DEREGISTERED"
          • "ERROR"
        • WorkspaceCreationProperties — (map)

          The default creation properties for all WorkSpaces in the directory.

          • EnableWorkDocs — (Boolean)

            Specifies whether the directory is enabled for Amazon WorkDocs.

          • EnableInternetAccess — (Boolean)

            Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in this directory by default. If enabled, the Elastic public IP address allows outbound internet access from your WorkSpaces when you’re using an internet gateway in the Amazon VPC in which your WorkSpaces are located. If you're using a Network Address Translation (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in public subnets and you manually assign them Elastic IP addresses, you should disable this setting. This setting applies to new WorkSpaces that you launch or to existing WorkSpaces that you rebuild. For more information, see Configure a VPC for Amazon WorkSpaces.

          • DefaultOu — (String)

            The organizational unit (OU) in the directory for the WorkSpace machine accounts.

          • CustomSecurityGroupId — (String)

            The identifier of the default security group to apply to WorkSpaces when they are created. For more information, see Security Groups for Your WorkSpaces.

          • UserEnabledAsLocalAdministrator — (Boolean)

            Specifies whether WorkSpace users are local administrators on their WorkSpaces.

          • EnableMaintenanceMode — (Boolean)

            Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see WorkSpace Maintenance.

          • InstanceIamRoleArn — (String)

            Indicates the IAM role ARN of the instance.

        • ipGroupIds — (Array<String>)

          The identifiers of the IP access control groups associated with the directory.

        • WorkspaceAccessProperties — (map)

          The devices and operating systems that users can use to access WorkSpaces.

          • DeviceTypeWindows — (String)

            Indicates whether users can use Windows clients to access their WorkSpaces.

            Possible values include:
            • "ALLOW"
            • "DENY"
          • DeviceTypeOsx — (String)

            Indicates whether users can use macOS clients to access their WorkSpaces.

            Possible values include:
            • "ALLOW"
            • "DENY"
          • DeviceTypeWeb — (String)

            Indicates whether users can access their WorkSpaces through a web browser.

            Possible values include:
            • "ALLOW"
            • "DENY"
          • DeviceTypeIos — (String)

            Indicates whether users can use iOS devices to access their WorkSpaces.

            Possible values include:
            • "ALLOW"
            • "DENY"
          • DeviceTypeAndroid — (String)

            Indicates whether users can use Android and Android-compatible Chrome OS devices to access their WorkSpaces.

            Possible values include:
            • "ALLOW"
            • "DENY"
          • DeviceTypeChromeOs — (String)

            Indicates whether users can use Chromebooks to access their WorkSpaces.

            Possible values include:
            • "ALLOW"
            • "DENY"
          • DeviceTypeZeroClient — (String)

            Indicates whether users can use zero client devices to access their WorkSpaces.

            Possible values include:
            • "ALLOW"
            • "DENY"
          • DeviceTypeLinux — (String)

            Indicates whether users can use Linux clients to access their WorkSpaces.

            Possible values include:
            • "ALLOW"
            • "DENY"
        • Tenancy — (String)

          Specifies whether the directory is dedicated or shared. To use Bring Your Own License (BYOL), this value must be set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.

          Possible values include:
          • "DEDICATED"
          • "SHARED"
        • SelfservicePermissions — (map)

          The default self-service permissions for WorkSpaces in the directory.

          • RestartWorkspace — (String)

            Specifies whether users can restart their WorkSpace.

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

            Specifies whether users can increase the volume size of the drives on their WorkSpace.

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

            Specifies whether users can change the compute type (bundle) for their WorkSpace.

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

            Specifies whether users can switch the running mode of their WorkSpace.

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

            Specifies whether users can rebuild the operating system of a WorkSpace to its original state.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
        • SamlProperties — (map)

          Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.

          • Status — (String)

            Indicates the status of SAML 2.0 authentication. These statuses include the following.

            • If the setting is DISABLED, end users will be directed to login with their directory credentials.

            • If the setting is ENABLED, end users will be directed to login via the user access URL. Users attempting to connect to WorkSpaces from a client application that does not support SAML 2.0 authentication will not be able to connect.

            • If the setting is ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK, end users will be directed to login via the user access URL on supported client applications, but will not prevent clients that do not support SAML 2.0 authentication from connecting as if SAML 2.0 authentication was disabled.

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

            The SAML 2.0 identity provider (IdP) user access URL is the URL a user would navigate to in their web browser in order to federate from the IdP and directly access the application, without any SAML 2.0 service provider (SP) bindings.

          • RelayStateParameterName — (String)

            The relay state parameter name supported by the SAML 2.0 identity provider (IdP). When the end user is redirected to the user access URL from the WorkSpaces client application, this relay state parameter name is appended as a query parameter to the URL along with the relay state endpoint to return the user to the client application session.

            To use SAML 2.0 authentication with WorkSpaces, the IdP must support IdP-initiated deep linking for the relay state URL. Consult your IdP documentation for more information.

        • CertificateBasedAuthProperties — (map)

          The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.

          • Status — (String)

            The status of the certificate-based authentication properties.

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

            The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager Private CA resource.

        • MicrosoftEntraConfig — (map)

          Specifies details about Microsoft Entra configurations.

          • TenantId — (String)

            The identifier of the tenant.

          • ApplicationConfigSecretArn — (String)

            The Amazon Resource Name (ARN) of the application config.

        • WorkspaceDirectoryName — (String)

          The name fo the WorkSpace directory.

        • WorkspaceDirectoryDescription — (String)

          The description of the WorkSpace directory

        • UserIdentityType — (String)

          Indicates the identity type of the specifired user.

          Possible values include:
          • "CUSTOMER_MANAGED"
          • "AWS_DIRECTORY_SERVICE"
          • "AWS_IAM_IDENTITY_CENTER"
        • WorkspaceType — (String)

          Indicates whether the directory's WorkSpace type is personal or pools.

          Possible values include:
          • "PERSONAL"
          • "POOLS"
        • IDCConfig — (map)

          Specifies details about identity center configurations.

          • InstanceArn — (String)

            The Amazon Resource Name (ARN) of the identity center instance.

          • ApplicationArn — (String)

            The Amazon Resource Name (ARN) of the application.

        • ActiveDirectoryConfig — (map)

          Information about the Active Directory config.

          • DomainNamerequired — (String)

            The name of the domain.

          • ServiceAccountSecretArnrequired — (String)

            Indicates the secret ARN on the service account.

        • StreamingProperties — (map)

          The streaming properties to configure.

          • StreamingExperiencePreferredProtocol — (String)

            Indicates the type of preferred protocol for the streaming experience.

            Possible values include:
            • "TCP"
            • "UDP"
          • UserSettings — (Array<map>)

            Indicates the permission settings asscoiated with the user.

            • Actionrequired — (String)

              Indicates the type of action.

              Possible values include:
              • "CLIPBOARD_COPY_FROM_LOCAL_DEVICE"
              • "CLIPBOARD_COPY_TO_LOCAL_DEVICE"
              • "PRINTING_TO_LOCAL_DEVICE"
              • "SMART_CARD"
            • Permissionrequired — (String)

              Indicates if the setting is enabled or disabled.

              Possible values include:
              • "ENABLED"
              • "DISABLED"
            • MaximumLength — (Integer)

              Indicates the maximum character length for the specified user setting.

          • StorageConnectors — (Array<map>)

            Indicates the storage connector used

            • ConnectorTyperequired — (String)

              The type of connector used to save user files.

              Possible values include:
              • "HOME_FOLDER"
            • Statusrequired — (String)

              Indicates if the storage connetor is enabled or disabled.

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

          The error message returned.

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

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

Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.

Examples:

Calling the describeWorkspaceImagePermissions operation

var params = {
  ImageId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
workspaces.describeWorkspaceImagePermissions(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.

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

      • ImageId — (String)

        The identifier of the image.

      • ImagePermissions — (Array<map>)

        The identifiers of the Amazon Web Services accounts that the image has been shared with.

        • SharedAccountId — (String)

          The identifier of the Amazon Web Services account that an image has been shared with.

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

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

Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.

Service Reference:

Examples:

Calling the describeWorkspaceImages operation

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

      The identifier of the image.

    • ImageType — (String)

      The type (owned or shared) of the image.

      Possible values include:
      • "OWNED"
      • "SHARED"
    • 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:

      • Images — (Array<map>)

        Information about the images.

        • ImageId — (String)

          The identifier of the 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 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"
        • ErrorCode — (String)

          The error code that is returned for the image.

        • ErrorMessage — (String)

          The text of the error message that is returned for the image.

        • Created — (Date)

          The date when the image was created. If the image has been shared, the Amazon Web Services account that the image has been shared with sees the original creation date of the image.

        • OwnerAccountId — (String)

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

        • Updates — (map)

          The updates (if any) that are available for the specified image.

          • UpdateAvailable — (Boolean)

            Indicates whether updated drivers or other components are available for the specified WorkSpace image.

          • Description — (String)

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

        • ErrorDetails — (Array<map>)

          Additional details of the error returned for the image, including the possible causes of the errors and troubleshooting information.

          • ErrorCode — (String)

            Indicates the error code returned.

            Possible values include:
            • "OutdatedPowershellVersion"
            • "OfficeInstalled"
            • "PCoIPAgentInstalled"
            • "WindowsUpdatesEnabled"
            • "AutoMountDisabled"
            • "WorkspacesBYOLAccountNotFound"
            • "WorkspacesBYOLAccountDisabled"
            • "DHCPDisabled"
            • "DiskFreeSpace"
            • "AdditionalDrivesAttached"
            • "OSNotSupported"
            • "DomainJoined"
            • "AzureDomainJoined"
            • "FirewallEnabled"
            • "VMWareToolsInstalled"
            • "DiskSizeExceeded"
            • "IncompatiblePartitioning"
            • "PendingReboot"
            • "AutoLogonEnabled"
            • "RealTimeUniversalDisabled"
            • "MultipleBootPartition"
            • "Requires64BitOS"
            • "ZeroRearmCount"
            • "InPlaceUpgrade"
            • "AntiVirusInstalled"
            • "UEFINotSupported"
          • ErrorMessage — (String)

            The text of the error message related the error code.

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

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

Describes the specified WorkSpaces.

You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.

Service Reference:

Examples:

Calling the describeWorkspaces operation

var params = {
  BundleId: 'STRING_VALUE',
  DirectoryId: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  UserName: 'STRING_VALUE',
  WorkspaceIds: [
    'STRING_VALUE',
    /* more items */
  ],
  WorkspaceName: 'STRING_VALUE'
};
workspaces.describeWorkspaces(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: {})
    • WorkspaceIds — (Array<String>)

      The identifiers of the WorkSpaces. You cannot combine this parameter with any other filter.

      Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.

    • DirectoryId — (String)

      The identifier of the directory. In addition, you can optionally specify a specific directory user (see UserName). You cannot combine this parameter with any other filter.

    • UserName — (String)

      The name of the directory user. You must specify this parameter with DirectoryId.

    • BundleId — (String)

      The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.

    • Limit — (Integer)

      The maximum number of items 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.

    • WorkspaceName — (String)

      The name of the user-decoupled WorkSpace.

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:

      • Workspaces — (Array<map>)

        Information about the WorkSpaces.

        Because CreateWorkspaces is an asynchronous operation, some of the returned information could 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.

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

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

Describes the connection status of the specified WorkSpaces.

Examples:

Calling the describeWorkspacesConnectionStatus operation

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

      The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.

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

      • WorkspacesConnectionStatus — (Array<map>)

        Information about the connection status of the WorkSpace.

        • WorkspaceId — (String)

          The identifier of the WorkSpace.

        • ConnectionState — (String)

          The connection state of the WorkSpace. The connection state is unknown if the WorkSpace is stopped.

          Possible values include:
          • "CONNECTED"
          • "DISCONNECTED"
          • "UNKNOWN"
        • ConnectionStateCheckTimestamp — (Date)

          The timestamp of the connection status check.

        • LastKnownUserConnectionTimestamp — (Date)

          The timestamp of the last known user connection.

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

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

Describes the snapshots for the specified WorkSpace.

Service Reference:

Examples:

Calling the describeWorkspaceSnapshots operation

var params = {
  WorkspaceId: 'STRING_VALUE' /* required */
};
workspaces.describeWorkspaceSnapshots(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.

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:

      • RebuildSnapshots — (Array<map>)

        Information about the snapshots that can be used to rebuild a WorkSpace. These snapshots include the user volume.

        • SnapshotTime — (Date)

          The time when the snapshot was created.

      • RestoreSnapshots — (Array<map>)

        Information about the snapshots that can be used to restore a WorkSpace. These snapshots include both the root volume and the user volume.

        • SnapshotTime — (Date)

          The time when the snapshot was created.

Returns:

  • (AWS.Request)

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

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

Describes the specified WorkSpaces Pools.

Service Reference:

Examples:

Calling the describeWorkspacesPools operation

var params = {
  Filters: [
    {
      Name: PoolName, /* required */
      Operator: EQUALS | NOTEQUALS | CONTAINS | NOTCONTAINS, /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  PoolIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
workspaces.describeWorkspacesPools(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: {})
    • PoolIds — (Array<String>)

      The identifier of the WorkSpaces Pools.

    • Filters — (Array<map>)

      The filter conditions for the WorkSpaces Pool to return.

      • Namerequired — (String)

        The name of the pool to filter.

        Possible values include:
        • "PoolName"
      • Valuesrequired — (Array<String>)

        The values for filtering WorkSpaces Pools.

      • Operatorrequired — (String)

        The operator values for filtering WorkSpaces Pools.

        Possible values include:
        • "EQUALS"
        • "NOTEQUALS"
        • "CONTAINS"
        • "NOTCONTAINS"
    • Limit — (Integer)

      The maximum number of items 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:

      • WorkspacesPools — (Array<map>)

        Information about the WorkSpaces Pools.

        • PoolIdrequired — (String)

          The identifier of a pool.

        • PoolArnrequired — (String)

          The Amazon Resource Name (ARN) for the pool.

        • CapacityStatusrequired — (map)

          The capacity status for the pool

          • AvailableUserSessionsrequired — (Integer)

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

            AvailableUserSessions = ActualUserSessions - ActiveUserSessions

          • DesiredUserSessionsrequired — (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.

          • ActualUserSessionsrequired — (Integer)

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

            ActualUserSessions = AvailableUserSessions + ActiveUserSessions

          • ActiveUserSessionsrequired — (Integer)

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

        • PoolNamerequired — (String)

          The name of the pool,

        • Description — (String)

          The description of the pool.

        • Staterequired — (String)

          The current state of the pool.

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

          The time the pool was created.

        • BundleIdrequired — (String)

          The identifier of the bundle used by the pool.

        • DirectoryIdrequired — (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.

          • Statusrequired — (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.

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

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

Retrieves a list that describes the streaming sessions for a specified pool.

Service Reference:

Examples:

Calling the describeWorkspacesPoolSessions operation

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

      The identifier of the pool.

    • UserId — (String)

      The identifier of the user.

    • Limit — (Integer)

      The maximum number of items 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:

      • Sessions — (Array<map>)

        Describes the pool sessions.

        • AuthenticationType — (String)

          The authentication method. The user is authenticated using a WorkSpaces Pools URL (API) or SAML 2.0 federation (SAML).

          Possible values include:
          • "SAML"
        • ConnectionState — (String)

          Specifies whether a user is connected to the pool session.

          Possible values include:
          • "CONNECTED"
          • "NOT_CONNECTED"
        • SessionIdrequired — (String)

          The identifier of the session.

        • InstanceId — (String)

          The identifier for the instance hosting the session.

        • PoolIdrequired — (String)

          The identifier of the pool.

        • ExpirationTime — (Date)

          The time that the pool session ended.

        • NetworkAccessConfiguration — (map)

          Describes the network details of the pool.

          • EniPrivateIpAddress — (String)

            The private IP address of the elastic network interface that is attached to instances in your VPC.

          • EniId — (String)

            The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.

        • StartTime — (Date)

          The time that the pool sission started.

        • UserIdrequired — (String)

          The identifier of the user.

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

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

Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Note: Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.

Service Reference:

Examples:

Calling the disassociateConnectionAlias operation

var params = {
  AliasId: 'STRING_VALUE' /* required */
};
workspaces.disassociateConnectionAlias(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 disassociate.

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.

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

Disassociates the specified IP access control group from the specified directory.

Service Reference:

Examples:

Calling the disassociateIpGroups operation

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

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

Disassociates the specified application from a WorkSpace.

Examples:

Calling the disassociateWorkspaceApplication operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  WorkspaceId: 'STRING_VALUE' /* required */
};
workspaces.disassociateWorkspaceApplication(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 targeted association.

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

Retrieves account link information.

Service Reference:

Examples:

Calling the getAccountLink operation

var params = {
  LinkId: 'STRING_VALUE',
  LinkedAccountId: 'STRING_VALUE'
};
workspaces.getAccountLink(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 to link.

    • LinkedAccountId — (String)

      The identifier of the account link

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)

        The account link of the account link to retrieve.

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

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

Imports client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.

After you import client branding, the default branding experience for the specified platform type is replaced with the imported experience

Note:
  • You must specify at least one platform type when importing client branding.
  • You can import up to 6 MB of data with each request. If your request exceeds this limit, you can import client branding for different platform types using separate requests.
  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify only one parameter for each platform type, but not both.
  • Imported data can take up to a minute to appear in the WorkSpaces client.

Service Reference:

Examples:

Calling the importClientBranding operation

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  DeviceTypeAndroid: {
    ForgotPasswordLink: 'STRING_VALUE',
    LoginMessage: {
      '<ClientLocale>': 'STRING_VALUE',
      /* '<ClientLocale>': ... */
    },
    Logo: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    SupportEmail: 'STRING_VALUE',
    SupportLink: 'STRING_VALUE'
  },
  DeviceTypeIos: {
    ForgotPasswordLink: 'STRING_VALUE',
    LoginMessage: {
      '<ClientLocale>': 'STRING_VALUE',
      /* '<ClientLocale>': ... */
    },
    Logo: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    Logo2x: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    Logo3x: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    SupportEmail: 'STRING_VALUE',
    SupportLink: 'STRING_VALUE'
  },
  DeviceTypeLinux: {
    ForgotPasswordLink: 'STRING_VALUE',
    LoginMessage: {
      '<ClientLocale>': 'STRING_VALUE',
      /* '<ClientLocale>': ... */
    },
    Logo: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    SupportEmail: 'STRING_VALUE',
    SupportLink: 'STRING_VALUE'
  },
  DeviceTypeOsx: {
    ForgotPasswordLink: 'STRING_VALUE',
    LoginMessage: {
      '<ClientLocale>': 'STRING_VALUE',
      /* '<ClientLocale>': ... */
    },
    Logo: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    SupportEmail: 'STRING_VALUE',
    SupportLink: 'STRING_VALUE'
  },
  DeviceTypeWeb: {
    ForgotPasswordLink: 'STRING_VALUE',
    LoginMessage: {
      '<ClientLocale>': 'STRING_VALUE',
      /* '<ClientLocale>': ... */
    },
    Logo: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    SupportEmail: 'STRING_VALUE',
    SupportLink: 'STRING_VALUE'
  },
  DeviceTypeWindows: {
    ForgotPasswordLink: 'STRING_VALUE',
    LoginMessage: {
      '<ClientLocale>': 'STRING_VALUE',
      /* '<ClientLocale>': ... */
    },
    Logo: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    SupportEmail: 'STRING_VALUE',
    SupportLink: 'STRING_VALUE'
  }
};
workspaces.importClientBranding(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 import client branding.

    • DeviceTypeWindows — (map)

      The branding information to import for Windows devices.

      • Logo — (Buffer, Typed Array, Blob, 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 to import for macOS devices.

      • Logo — (Buffer, Typed Array, Blob, 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 to import for Android devices.

      • Logo — (Buffer, Typed Array, Blob, 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 to import for iOS devices.

      • Logo — (Buffer, Typed Array, Blob, 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.

      • Logo2x — (Buffer, Typed Array, Blob, 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.
      • Logo3x — (Buffer, Typed Array, Blob, 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 to import for Linux devices.

      • Logo — (Buffer, Typed Array, Blob, 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 to import for web access.

      • Logo — (Buffer, Typed Array, Blob, 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.

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

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

Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your Amazon Web Services account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.

Service Reference:

Examples:

Calling the importWorkspaceImage operation

var params = {
  Ec2ImageId: 'STRING_VALUE', /* required */
  ImageDescription: 'STRING_VALUE', /* required */
  ImageName: 'STRING_VALUE', /* required */
  IngestionProcess: BYOL_REGULAR | BYOL_GRAPHICS | BYOL_GRAPHICSPRO | BYOL_GRAPHICS_G4DN | BYOL_REGULAR_WSP | BYOL_GRAPHICS_G4DN_WSP | BYOL_REGULAR_BYOP | BYOL_GRAPHICS_G4DN_BYOP, /* required */
  Applications: [
    Microsoft_Office_2016 | Microsoft_Office_2019,
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
workspaces.importWorkspaceImage(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: {})
    • Ec2ImageId — (String)

      The identifier of the EC2 image.

    • IngestionProcess — (String)

      The ingestion process to be used when importing the image, depending on which protocol you want to use for your BYOL Workspace image, either PCoIP, WorkSpaces Streaming Protocol (WSP), or bring your own protocol (BYOP). To use WSP, specify a value that ends in _WSP. To use PCoIP, specify a value that does not end in _WSP. To use BYOP, specify a value that ends in _BYOP.

      For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify BYOL_REGULAR, BYOL_REGULAR_WSP, or BYOL_REGULAR_BYOP, depending on the protocol.

      Note: The BYOL_REGULAR_BYOP and BYOL_GRAPHICS_G4DN_BYOP values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see Amazon WorkSpaces Core.
      Possible values include:
      • "BYOL_REGULAR"
      • "BYOL_GRAPHICS"
      • "BYOL_GRAPHICSPRO"
      • "BYOL_GRAPHICS_G4DN"
      • "BYOL_REGULAR_WSP"
      • "BYOL_GRAPHICS_G4DN_WSP"
      • "BYOL_REGULAR_BYOP"
      • "BYOL_GRAPHICS_G4DN_BYOP"
    • ImageName — (String)

      The name of the WorkSpace image.

    • ImageDescription — (String)

      The description of the WorkSpace image.

    • Tags — (Array<map>)

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

      • Keyrequired — (String)

        The key of the tag.

      • Value — (String)

        The value of the tag.

    • Applications — (Array<String>)

      If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11 BYOL images. For more information about subscribing to Office for BYOL images, see Bring Your Own Windows Desktop Licenses.

      Note:
      • Although this parameter is an array, only one item is allowed at this time.
      • During the image import process, non-GPU WSP WorkSpaces with Windows 11 support only Microsoft_Office_2019. GPU WSP WorkSpaces with Windows 11 do not support Office installation.

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

Returns:

  • (AWS.Request)

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

Lists all account links.

Service Reference:

Examples:

Calling the listAccountLinks operation

var params = {
  LinkStatusFilter: [
    LINKED | LINKING_FAILED | LINK_NOT_FOUND | PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT | REJECTED,
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
workspaces.listAccountLinks(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: {})
    • LinkStatusFilter — (Array<String>)

      Filters the account based on their link status.

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

    • MaxResults — (Integer)

      The maximum number of accounts 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:

      • AccountLinks — (Array<map>)

        Information about the account links.

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

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

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

Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable Bring Your Own License (BYOL).

This operation can be run only by Amazon Web Services accounts that are enabled for BYOL. If your account isn't enabled for BYOL, you'll receive an AccessDeniedException error.

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.

Examples:

Calling the listAvailableManagementCidrRanges operation

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

      The IP address range to search. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block).

    • MaxResults — (Integer)

      The maximum number of items 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:

      • ManagementCidrRanges — (Array<String>)

        The list of available IP address ranges, specified as IPv4 CIDR blocks.

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

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

Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume.

The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the user volume from the last available snapshot of the original WorkSpace. During migration, the original D:\Users\%USERNAME% user profile folder is renamed to D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new D:\Users\%USERNAME%\ folder is generated by the new OS. Certain files in the old user profile are moved to the new user profile.

For available migration scenarios, details about what happens during migration, and best practices, see Migrate a WorkSpace.

Service Reference:

Examples:

Calling the migrateWorkspace operation

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

      The identifier of the WorkSpace to migrate from.

    • BundleId — (String)

      The identifier of the target bundle type to migrate the WorkSpace 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:

      • SourceWorkspaceId — (String)

        The original identifier of the WorkSpace that is being migrated.

      • TargetWorkspaceId — (String)

        The new identifier of the WorkSpace that is being migrated. If the migration does not succeed, the target WorkSpace ID will not be used, and the WorkSpace will still have the original WorkSpace ID.

Returns:

  • (AWS.Request)

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

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

Modifies the configuration of Bring Your Own License (BYOL) for the specified account.

Service Reference:

Examples:

Calling the modifyAccount operation

var params = {
  DedicatedTenancyManagementCidrRange: 'STRING_VALUE',
  DedicatedTenancySupport: ENABLED
};
workspaces.modifyAccount(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: {})
    • DedicatedTenancySupport — (String)

      The status of BYOL.

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

      The IP address range, specified as an IPv4 CIDR block, for the management network interface. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block). The CIDR block size must be /16 (for example, 203.0.113.25/16). It must also be specified as available by the ListAvailableManagementCidrRanges operation.

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.

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

Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces.

Examples:

Calling the modifyCertificateBasedAuthProperties operation

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  CertificateBasedAuthProperties: {
    CertificateAuthorityArn: 'STRING_VALUE',
    Status: DISABLED | ENABLED
  },
  PropertiesToDelete: [
    CERTIFICATE_BASED_AUTH_PROPERTIES_CERTIFICATE_AUTHORITY_ARN,
    /* more items */
  ]
};
workspaces.modifyCertificateBasedAuthProperties(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 resource identifiers, in the form of directory IDs.

    • CertificateBasedAuthProperties — (map)

      The properties of the certificate-based authentication.

      • Status — (String)

        The status of the certificate-based authentication properties.

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

        The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager Private CA resource.

    • PropertiesToDelete — (Array<String>)

      The properties of the certificate-based authentication you want 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.

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

Modifies the properties of the specified Amazon WorkSpaces clients.

Service Reference:

Examples:

Calling the modifyClientProperties operation

var params = {
  ClientProperties: { /* required */
    LogUploadEnabled: ENABLED | DISABLED,
    ReconnectEnabled: ENABLED | DISABLED
  },
  ResourceId: 'STRING_VALUE' /* required */
};
workspaces.modifyClientProperties(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 resource identifiers, in the form of directory IDs.

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

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.

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

Modifies multiple properties related to SAML 2.0 authentication, including the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.

Service Reference:

Examples:

Calling the modifySamlProperties operation

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  PropertiesToDelete: [
    SAML_PROPERTIES_USER_ACCESS_URL | SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME,
    /* more items */
  ],
  SamlProperties: {
    RelayStateParameterName: 'STRING_VALUE',
    Status: DISABLED | ENABLED | ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK,
    UserAccessUrl: 'STRING_VALUE'
  }
};
workspaces.modifySamlProperties(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 you want to configure SAML properties.

    • SamlProperties — (map)

      The properties for configuring SAML 2.0 authentication.

      • Status — (String)

        Indicates the status of SAML 2.0 authentication. These statuses include the following.

        • If the setting is DISABLED, end users will be directed to login with their directory credentials.

        • If the setting is ENABLED, end users will be directed to login via the user access URL. Users attempting to connect to WorkSpaces from a client application that does not support SAML 2.0 authentication will not be able to connect.

        • If the setting is ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK, end users will be directed to login via the user access URL on supported client applications, but will not prevent clients that do not support SAML 2.0 authentication from connecting as if SAML 2.0 authentication was disabled.

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

        The SAML 2.0 identity provider (IdP) user access URL is the URL a user would navigate to in their web browser in order to federate from the IdP and directly access the application, without any SAML 2.0 service provider (SP) bindings.

      • RelayStateParameterName — (String)

        The relay state parameter name supported by the SAML 2.0 identity provider (IdP). When the end user is redirected to the user access URL from the WorkSpaces client application, this relay state parameter name is appended as a query parameter to the URL along with the relay state endpoint to return the user to the client application session.

        To use SAML 2.0 authentication with WorkSpaces, the IdP must support IdP-initiated deep linking for the relay state URL. Consult your IdP documentation for more information.

    • PropertiesToDelete — (Array<String>)

      The SAML properties to delete as part of your request.

      Specify one of the following options:

      • SAML_PROPERTIES_USER_ACCESS_URL to delete the user access URL.

      • SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME to delete the relay state parameter name.

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.

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

Modifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.

Service Reference:

Examples:

Calling the modifySelfservicePermissions operation

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  SelfservicePermissions: { /* required */
    ChangeComputeType: ENABLED | DISABLED,
    IncreaseVolumeSize: ENABLED | DISABLED,
    RebuildWorkspace: ENABLED | DISABLED,
    RestartWorkspace: ENABLED | DISABLED,
    SwitchRunningMode: ENABLED | DISABLED
  }
};
workspaces.modifySelfservicePermissions(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 directory.

    • SelfservicePermissions — (map)

      The permissions to enable or disable self-service capabilities.

      • RestartWorkspace — (String)

        Specifies whether users can restart their WorkSpace.

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

        Specifies whether users can increase the volume size of the drives on their WorkSpace.

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

        Specifies whether users can change the compute type (bundle) for their WorkSpace.

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

        Specifies whether users can switch the running mode of their WorkSpace.

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

        Specifies whether users can rebuild the operating system of a WorkSpace to its original state.

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

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.

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

Modifies the specified streaming properties.

Service Reference:

Examples:

Calling the modifyStreamingProperties operation

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  StreamingProperties: {
    StorageConnectors: [
      {
        ConnectorType: HOME_FOLDER, /* required */
        Status: ENABLED | DISABLED /* required */
      },
      /* more items */
    ],
    StreamingExperiencePreferredProtocol: TCP | UDP,
    UserSettings: [
      {
        Action: CLIPBOARD_COPY_FROM_LOCAL_DEVICE | CLIPBOARD_COPY_TO_LOCAL_DEVICE | PRINTING_TO_LOCAL_DEVICE | SMART_CARD, /* required */
        Permission: ENABLED | DISABLED, /* required */
        MaximumLength: 'NUMBER_VALUE'
      },
      /* more items */
    ]
  }
};
workspaces.modifyStreamingProperties(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 resource.

    • StreamingProperties — (map)

      The streaming properties to configure.

      • StreamingExperiencePreferredProtocol — (String)

        Indicates the type of preferred protocol for the streaming experience.

        Possible values include:
        • "TCP"
        • "UDP"
      • UserSettings — (Array<map>)

        Indicates the permission settings asscoiated with the user.

        • Actionrequired — (String)

          Indicates the type of action.

          Possible values include:
          • "CLIPBOARD_COPY_FROM_LOCAL_DEVICE"
          • "CLIPBOARD_COPY_TO_LOCAL_DEVICE"
          • "PRINTING_TO_LOCAL_DEVICE"
          • "SMART_CARD"
        • Permissionrequired — (String)

          Indicates if the setting is enabled or disabled.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
        • MaximumLength — (Integer)

          Indicates the maximum character length for the specified user setting.

      • StorageConnectors — (Array<map>)

        Indicates the storage connector used

        • ConnectorTyperequired — (String)

          The type of connector used to save user files.

          Possible values include:
          • "HOME_FOLDER"
        • Statusrequired — (String)

          Indicates if the storage connetor is enabled or disabled.

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

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.

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

Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access.

Service Reference:

Examples:

Calling the modifyWorkspaceAccessProperties operation

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  WorkspaceAccessProperties: { /* required */
    DeviceTypeAndroid: ALLOW | DENY,
    DeviceTypeChromeOs: ALLOW | DENY,
    DeviceTypeIos: ALLOW | DENY,
    DeviceTypeLinux: ALLOW | DENY,
    DeviceTypeOsx: ALLOW | DENY,
    DeviceTypeWeb: ALLOW | DENY,
    DeviceTypeWindows: ALLOW | DENY,
    DeviceTypeZeroClient: ALLOW | DENY
  }
};
workspaces.modifyWorkspaceAccessProperties(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 directory.

    • WorkspaceAccessProperties — (map)

      The device types and operating systems to enable or disable for access.

      • DeviceTypeWindows — (String)

        Indicates whether users can use Windows clients to access their WorkSpaces.

        Possible values include:
        • "ALLOW"
        • "DENY"
      • DeviceTypeOsx — (String)

        Indicates whether users can use macOS clients to access their WorkSpaces.

        Possible values include:
        • "ALLOW"
        • "DENY"
      • DeviceTypeWeb — (String)

        Indicates whether users can access their WorkSpaces through a web browser.

        Possible values include:
        • "ALLOW"
        • "DENY"
      • DeviceTypeIos — (String)

        Indicates whether users can use iOS devices to access their WorkSpaces.

        Possible values include:
        • "ALLOW"
        • "DENY"
      • DeviceTypeAndroid — (String)

        Indicates whether users can use Android and Android-compatible Chrome OS devices to access their WorkSpaces.

        Possible values include:
        • "ALLOW"
        • "DENY"
      • DeviceTypeChromeOs — (String)

        Indicates whether users can use Chromebooks to access their WorkSpaces.

        Possible values include:
        • "ALLOW"
        • "DENY"
      • DeviceTypeZeroClient — (String)

        Indicates whether users can use zero client devices to access their WorkSpaces.

        Possible values include:
        • "ALLOW"
        • "DENY"
      • DeviceTypeLinux — (String)

        Indicates whether users can use Linux clients to access their WorkSpaces.

        Possible values include:
        • "ALLOW"
        • "DENY"

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.

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

Modify the default properties used to create WorkSpaces.

Examples:

Calling the modifyWorkspaceCreationProperties operation

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  WorkspaceCreationProperties: { /* required */
    CustomSecurityGroupId: 'STRING_VALUE',
    DefaultOu: 'STRING_VALUE',
    EnableInternetAccess: true || false,
    EnableMaintenanceMode: true || false,
    EnableWorkDocs: true || false,
    InstanceIamRoleArn: 'STRING_VALUE',
    UserEnabledAsLocalAdministrator: true || false
  }
};
workspaces.modifyWorkspaceCreationProperties(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 directory.

    • WorkspaceCreationProperties — (map)

      The default properties for creating WorkSpaces.

      • EnableWorkDocs — (Boolean)

        Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.

        Note: If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless you either disable users' access to WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, see Disabling Users in the Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see Deleting a Site in the Amazon WorkDocs Administration Guide. If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are launched in the directory will have WorkDocs enabled.
      • EnableInternetAccess — (Boolean)

        Indicates whether internet access is enabled for your WorkSpaces.

      • DefaultOu — (String)

        The default organizational unit (OU) for your WorkSpaces directories. This string must be the full Lightweight Directory Access Protocol (LDAP) distinguished name for the target domain and OU. It must be in the form "OU=value,DC=value,DC=value", where value is any string of characters, and the number of domain components (DCs) is two or more. For example, OU=WorkSpaces_machines,DC=machines,DC=example,DC=com.

        • To avoid errors, certain characters in the distinguished name must be escaped. For more information, see Distinguished Names in the Microsoft documentation.

        • The API doesn't validate whether the OU exists.

      • CustomSecurityGroupId — (String)

        The identifier of your custom security group.

      • UserEnabledAsLocalAdministrator — (Boolean)

        Indicates whether users are local administrators of their WorkSpaces.

      • EnableMaintenanceMode — (Boolean)

        Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.

      • InstanceIamRoleArn — (String)

        Indicates the IAM role ARN of the 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.

Returns:

  • (AWS.Request)

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

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

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

Note: The MANUAL running mode 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.

Service Reference:

Examples:

Calling the modifyWorkspaceProperties operation

var params = {
  WorkspaceId: 'STRING_VALUE', /* required */
  DataReplication: NO_REPLICATION | PRIMARY_AS_SOURCE,
  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'
  }
};
workspaces.modifyWorkspaceProperties(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.

    • 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"
    • DataReplication — (String)

      Indicates the data replication status.

      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.

Returns:

  • (AWS.Request)

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

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

Sets the state of the specified WorkSpace.

To maintain a WorkSpace without being interrupted, set the WorkSpace state to ADMIN_MAINTENANCE. WorkSpaces in this state do not respond to requests to reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE state.

Service Reference:

Examples:

Calling the modifyWorkspaceState operation

var params = {
  WorkspaceId: 'STRING_VALUE', /* required */
  WorkspaceState: AVAILABLE | ADMIN_MAINTENANCE /* required */
};
workspaces.modifyWorkspaceState(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.

    • WorkspaceState — (String)

      The WorkSpace state.

      Possible values include:
      • "AVAILABLE"
      • "ADMIN_MAINTENANCE"

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.

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

Reboots the specified WorkSpaces.

You cannot reboot a WorkSpace unless its state is AVAILABLE, UNHEALTHY, or REBOOTING. Reboot a WorkSpace in the REBOOTING state only if your WorkSpace has been stuck in the REBOOTING state for over 20 minutes.

This operation is asynchronous and returns before the WorkSpaces have rebooted.

Service Reference:

Examples:

Calling the rebootWorkspaces operation

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

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

      • WorkspaceIdrequired — (String)

        The identifier of the WorkSpace.

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

        • WorkspaceId — (String)

          The identifier of the WorkSpace.

        • ErrorCode — (String)

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

        • ErrorMessage — (String)

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

Returns:

  • (AWS.Request)

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

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

Rebuilds the specified WorkSpace.

You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, STOPPED, or REBOOTING.

Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace.

This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.

Service Reference:

Examples:

Calling the rebuildWorkspaces operation

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

      The WorkSpace to rebuild. You can specify a single WorkSpace.

      • WorkspaceIdrequired — (String)

        The identifier of the WorkSpace.

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 WorkSpace that could not be rebuilt.

        • WorkspaceId — (String)

          The identifier of the WorkSpace.

        • ErrorCode — (String)

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

        • ErrorMessage — (String)

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

Returns:

  • (AWS.Request)

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

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

Registers the specified directory. This operation is asynchronous and returns before the WorkSpace directory is registered. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.

Service Reference:

Examples:

Calling the registerWorkspaceDirectory operation

var params = {
  ActiveDirectoryConfig: {
    DomainName: 'STRING_VALUE', /* required */
    ServiceAccountSecretArn: 'STRING_VALUE' /* required */
  },
  DirectoryId: 'STRING_VALUE',
  EnableSelfService: true || false,
  EnableWorkDocs: true || false,
  IdcInstanceArn: 'STRING_VALUE',
  MicrosoftEntraConfig: {
    ApplicationConfigSecretArn: 'STRING_VALUE',
    TenantId: 'STRING_VALUE'
  },
  SubnetIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  Tenancy: DEDICATED | SHARED,
  UserIdentityType: CUSTOMER_MANAGED | AWS_DIRECTORY_SERVICE | AWS_IAM_IDENTITY_CENTER,
  WorkspaceDirectoryDescription: 'STRING_VALUE',
  WorkspaceDirectoryName: 'STRING_VALUE',
  WorkspaceType: PERSONAL | POOLS
};
workspaces.registerWorkspaceDirectory(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. You cannot register a directory if it does not have a status of Active. If the directory does not have a status of Active, you will receive an InvalidResourceStateException error. If you have already registered the maximum number of directories that you can register with Amazon WorkSpaces, you will receive a ResourceLimitExceededException error. Deregister directories that you are not using for WorkSpaces, and try again.

    • SubnetIds — (Array<String>)

      The identifiers of the subnets for your virtual private cloud (VPC). Make sure that the subnets are in supported Availability Zones. The subnets must also be in separate Availability Zones. If these conditions are not met, you will receive an OperationNotSupportedException error.

    • EnableWorkDocs — (Boolean)

      Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this parameter and WorkDocs is not available in the Region, you will receive an OperationNotSupportedException error. Set EnableWorkDocs to disabled, and try again.

    • EnableSelfService — (Boolean)

      Indicates whether self-service capabilities are enabled or disabled.

    • Tenancy — (String)

      Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own License (BYOL) images, this value must be set to DEDICATED and your Amazon Web Services account must be enabled for BYOL. If your account has not been enabled for BYOL, you will receive an InvalidParameterValuesException error. For more information about BYOL images, see Bring Your Own Windows Desktop Images.

      Possible values include:
      • "DEDICATED"
      • "SHARED"
    • Tags — (Array<map>)

      The tags associated with the directory.

      • Keyrequired — (String)

        The key of the tag.

      • Value — (String)

        The value of the tag.

    • WorkspaceDirectoryName — (String)

      The name of the directory to register.

    • WorkspaceDirectoryDescription — (String)

      Description of the directory to register.

    • UserIdentityType — (String)

      The type of identity management the user is using.

      Possible values include:
      • "CUSTOMER_MANAGED"
      • "AWS_DIRECTORY_SERVICE"
      • "AWS_IAM_IDENTITY_CENTER"
    • IdcInstanceArn — (String)

      The Amazon Resource Name (ARN) of the identity center instance.

    • MicrosoftEntraConfig — (map)

      The details about Microsoft Entra config.

      • TenantId — (String)

        The identifier of the tenant.

      • ApplicationConfigSecretArn — (String)

        The Amazon Resource Name (ARN) of the application config.

    • WorkspaceType — (String)

      Indicates whether the directory's WorkSpace type is personal or pools.

      Possible values include:
      • "PERSONAL"
      • "POOLS"
    • ActiveDirectoryConfig — (map)

      The active directory config of the directory.

      • DomainNamerequired — (String)

        The name of the domain.

      • ServiceAccountSecretArnrequired — (String)

        Indicates the secret ARN on the service account.

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:

      • DirectoryId — (String)

        The identifier of the directory.

      • State — (String)

        The registration status of the WorkSpace directory.

        Possible values include:
        • "REGISTERING"
        • "REGISTERED"
        • "DEREGISTERING"
        • "DEREGISTERED"
        • "ERROR"

Returns:

  • (AWS.Request)

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

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

Rejects the account link invitation.

Service Reference:

Examples:

Calling the rejectAccountLinkInvitation operation

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

      The client token of the account link invitation to reject.

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.

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

Restores the specified WorkSpace to its last known healthy state.

You cannot restore a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, or STOPPED.

Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Restore a WorkSpace.

This operation is asynchronous and returns before the WorkSpace is completely restored.

Service Reference:

Examples:

Calling the restoreWorkspace operation

var params = {
  WorkspaceId: 'STRING_VALUE' /* required */
};
workspaces.restoreWorkspace(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.

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.

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

Removes one or more rules from the specified IP access control group.

Service Reference:

Examples:

Calling the revokeIpRules operation

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

      The rules to remove from the 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.

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

Starts the specified WorkSpaces.

You cannot start a WorkSpace unless it has a running mode of AutoStop or Manual and a state of STOPPED.

Service Reference:

Examples:

Calling the startWorkspaces operation

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

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

      • WorkspaceId — (String)

        The identifier of the WorkSpace.

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

        • WorkspaceId — (String)

          The identifier of the WorkSpace.

        • ErrorCode — (String)

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

        • ErrorMessage — (String)

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

Returns:

  • (AWS.Request)

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

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

Starts the specified pool.

You cannot start a pool unless it has a running mode of AutoStop and a state of STOPPED.

Service Reference:

Examples:

Calling the startWorkspacesPool operation

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

      The identifier of the pool.

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.

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

Stops the specified WorkSpaces.

You cannot stop a WorkSpace unless it has a running mode of AutoStop or Manual and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.

Service Reference:

Examples:

Calling the stopWorkspaces operation

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

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

      • WorkspaceId — (String)

        The identifier of the WorkSpace.

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

        • WorkspaceId — (String)

          The identifier of the WorkSpace.

        • ErrorCode — (String)

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

        • ErrorMessage — (String)

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

Returns:

  • (AWS.Request)

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

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

Stops the specified pool.

You cannot stop a WorkSpace pool unless it has a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.

Service Reference:

Examples:

Calling the stopWorkspacesPool operation

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

      The identifier of the pool.

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.

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

Terminates the specified WorkSpaces.

Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact Amazon Web Services Support before terminating the WorkSpace.

You can terminate a WorkSpace that is in any state except SUSPENDED.

This operation is asynchronous and returns before the WorkSpaces have been completely terminated. 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.

Note: Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing terms. To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.

Service Reference:

Examples:

Calling the terminateWorkspaces operation

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

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

      • WorkspaceIdrequired — (String)

        The identifier of the WorkSpace.

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

        • WorkspaceId — (String)

          The identifier of the WorkSpace.

        • ErrorCode — (String)

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

        • ErrorMessage — (String)

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

Returns:

  • (AWS.Request)

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

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

Terminates the specified pool.

Service Reference:

Examples:

Calling the terminateWorkspacesPool operation

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

      The identifier of the pool.

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.

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

Terminates the pool session.

Service Reference:

Examples:

Calling the terminateWorkspacesPoolSession operation

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

Parameters:

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

      The identifier of the pool session.

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.

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

Updates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon Connect client add-in.

Service Reference:

Examples:

Calling the updateConnectClientAddIn operation

var params = {
  AddInId: 'STRING_VALUE', /* required */
  ResourceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE',
  URL: 'STRING_VALUE'
};
workspaces.updateConnectClientAddIn(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 update.

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

Returns:

  • (AWS.Request)

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

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

Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory. If the association permission is granted, the connection alias is shared with that account. If the association permission is revoked, the connection alias is unshared with the account. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Note:
  • Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.
  • To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.

Service Reference:

Examples:

Calling the updateConnectionAliasPermission operation

var params = {
  AliasId: 'STRING_VALUE', /* required */
  ConnectionAliasPermission: { /* required */
    AllowAssociation: true || false, /* required */
    SharedAccountId: 'STRING_VALUE' /* required */
  }
};
workspaces.updateConnectionAliasPermission(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 that you want to update permissions for.

    • ConnectionAliasPermission — (map)

      Indicates whether to share or unshare the connection alias with the specified Amazon Web Services account.

      • SharedAccountIdrequired — (String)

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

      • AllowAssociationrequired — (Boolean)

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

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.

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

Replaces the current rules of the specified IP access control group with the specified rules.

Service Reference:

Examples:

Calling the updateRulesOfIpGroup operation

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

      One or more rules.

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

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

Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see Update a Custom WorkSpaces Bundle.

Existing WorkSpaces aren't automatically updated when you update the bundle that they're based on. To update existing WorkSpaces that are based on a bundle that you've updated, you must either rebuild the WorkSpaces or delete and recreate them.

Service Reference:

Examples:

Calling the updateWorkspaceBundle operation

var params = {
  BundleId: 'STRING_VALUE',
  ImageId: 'STRING_VALUE'
};
workspaces.updateWorkspaceBundle(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.

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

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

Shares or unshares an image with one account in the same Amazon Web Services Region by specifying whether that account has permission to copy the image. If the copy image permission is granted, the image is shared with that account. If the copy image permission is revoked, the image is unshared with the account.

After an image has been shared, the recipient account can copy the image to other Regions as needed.

In the China (Ningxia) Region, you can copy images only within the same Region.

In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.

For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image.

Note:
  • To delete an image that has been shared, you must unshare the image before you delete it.
  • Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts isn't supported at this time in Amazon Web Services GovCloud (US). To share BYOL images across accounts in Amazon Web Services GovCloud (US), contact Amazon Web Services Support.

Service Reference:

Examples:

Calling the updateWorkspaceImagePermission operation

var params = {
  AllowCopyImage: true || false, /* required */
  ImageId: 'STRING_VALUE', /* required */
  SharedAccountId: 'STRING_VALUE' /* required */
};
workspaces.updateWorkspaceImagePermission(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.

    • AllowCopyImage — (Boolean)

      The permission to copy the image. This permission can be revoked only after an image has been shared.

    • SharedAccountId — (String)

      The identifier of the Amazon Web Services account to share or unshare the image with.

      Before sharing the image, confirm that you are sharing to the correct Amazon Web Services account ID.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Updates the specified pool.

Service Reference:

Examples:

Calling the updateWorkspacesPool operation

var params = {
  PoolId: 'STRING_VALUE', /* required */
  ApplicationSettings: {
    Status: DISABLED | ENABLED, /* required */
    SettingsGroup: 'STRING_VALUE'
  },
  BundleId: 'STRING_VALUE',
  Capacity: {
    DesiredUserSessions: 'NUMBER_VALUE' /* required */
  },
  Description: 'STRING_VALUE',
  DirectoryId: 'STRING_VALUE',
  TimeoutSettings: {
    DisconnectTimeoutInSeconds: 'NUMBER_VALUE',
    IdleDisconnectTimeoutInSeconds: 'NUMBER_VALUE',
    MaxUserDurationInSeconds: 'NUMBER_VALUE'
  }
};
workspaces.updateWorkspacesPool(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: {})
    • PoolId — (String)

      The identifier of the specified pool to update.

    • Description — (String)

      Describes the specified pool to update.

    • BundleId — (String)

      The identifier of the bundle.

    • DirectoryId — (String)

      The identifier of the directory.

    • Capacity — (map)

      The desired capacity for the pool.

      • DesiredUserSessionsrequired — (Integer)

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

    • ApplicationSettings — (map)

      The persistent application settings for users in the pool.

      • Statusrequired — (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 specified 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)

        Describes the specified pool.

        • PoolIdrequired — (String)

          The identifier of a pool.

        • PoolArnrequired — (String)

          The Amazon Resource Name (ARN) for the pool.

        • CapacityStatusrequired — (map)

          The capacity status for the pool

          • AvailableUserSessionsrequired — (Integer)

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

            AvailableUserSessions = ActualUserSessions - ActiveUserSessions

          • DesiredUserSessionsrequired — (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.

          • ActualUserSessionsrequired — (Integer)

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

            ActualUserSessions = AvailableUserSessions + ActiveUserSessions

          • ActiveUserSessionsrequired — (Integer)

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

        • PoolNamerequired — (String)

          The name of the pool,

        • Description — (String)

          The description of the pool.

        • Staterequired — (String)

          The current state of the pool.

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

          The time the pool was created.

        • BundleIdrequired — (String)

          The identifier of the bundle used by the pool.

        • DirectoryIdrequired — (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.

          • Statusrequired — (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.