Class: AWS.WorkSpaces
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.WorkSpaces
- 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 and Amazon Linux desktops for your users.
Sending a Request Using WorkSpaces
var workspaces = new AWS.WorkSpaces();
workspaces.associateIpGroups(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();
Constructor Summary
-
new AWS.WorkSpaces(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary
-
associateIpGroups(params = {}, callback) ⇒ AWS.Request
Associates the specified IP access control group with the specified directory.
-
authorizeIpRules(params = {}, callback) ⇒ AWS.Request
Adds one or more rules to the specified IP access control group.
-
createIpGroup(params = {}, callback) ⇒ AWS.Request
Creates an IP access control group.
-
createTags(params = {}, callback) ⇒ AWS.Request
Creates the specified tags for the specified WorkSpaces resource.
-
createWorkspaces(params = {}, callback) ⇒ AWS.Request
Creates one or more WorkSpaces.
-
deleteIpGroup(params = {}, callback) ⇒ AWS.Request
Deletes the specified IP access control group.
-
deleteTags(params = {}, callback) ⇒ AWS.Request
Deletes the specified tags from the specified WorkSpaces resource.
-
deleteWorkspaceImage(params = {}, callback) ⇒ AWS.Request
Deletes the specified image from your account.
-
describeAccount(params = {}, callback) ⇒ AWS.Request
Retrieves a list that describes the configuration of bring your own license (BYOL) for the specified account.
-
describeAccountModifications(params = {}, callback) ⇒ AWS.Request
Retrieves a list that describes modifications to the configuration of bring your own license (BYOL) for the specified account.
-
describeClientProperties(params = {}, callback) ⇒ AWS.Request
Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
-
describeIpGroups(params = {}, callback) ⇒ AWS.Request
Describes one or more of your IP access control groups.
-
describeTags(params = {}, callback) ⇒ AWS.Request
Describes the specified tags for the specified WorkSpaces resource.
-
describeWorkspaceBundles(params = {}, callback) ⇒ AWS.Request
Retrieves a list that describes the available WorkSpace bundles.
-
describeWorkspaceDirectories(params = {}, callback) ⇒ AWS.Request
Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
-
describeWorkspaceImages(params = {}, callback) ⇒ AWS.Request
Retrieves a list that describes one or more specified images, if the image identifiers are provided.
-
describeWorkspaces(params = {}, callback) ⇒ AWS.Request
Describes the specified WorkSpaces.
-
describeWorkspacesConnectionStatus(params = {}, callback) ⇒ AWS.Request
Describes the connection status of the specified WorkSpaces.
-
disassociateIpGroups(params = {}, callback) ⇒ AWS.Request
Disassociates the specified IP access control group from the specified directory.
-
importWorkspaceImage(params = {}, callback) ⇒ AWS.Request
Imports the specified Windows 7 or Windows 10 bring your own license (BYOL) image into Amazon WorkSpaces.
-
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).
-
modifyAccount(params = {}, callback) ⇒ AWS.Request
Modifies the configuration of bring your own license (BYOL) for the specified account.
-
modifyClientProperties(params = {}, callback) ⇒ AWS.Request
Modifies the properties of the specified Amazon WorkSpaces clients.
-
modifyWorkspaceProperties(params = {}, callback) ⇒ AWS.Request
Modifies the specified WorkSpace properties.
-
modifyWorkspaceState(params = {}, callback) ⇒ AWS.Request
Sets the state of the specified WorkSpace.
-
rebootWorkspaces(params = {}, callback) ⇒ AWS.Request
Reboots the specified WorkSpaces.
-
rebuildWorkspaces(params = {}, callback) ⇒ AWS.Request
Rebuilds the specified WorkSpace.
-
revokeIpRules(params = {}, callback) ⇒ AWS.Request
Removes one or more rules from the specified IP access control group.
-
startWorkspaces(params = {}, callback) ⇒ AWS.Request
Starts the specified WorkSpaces.
-
stopWorkspaces(params = {}, callback) ⇒ AWS.Request
Stops the specified WorkSpaces.
-
terminateWorkspaces(params = {}, callback) ⇒ AWS.Request
Terminates the specified WorkSpaces.
-
updateRulesOfIpGroup(params = {}, callback) ⇒ AWS.Request
Replaces the current rules of the specified IP access control group with the specified rules.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService
Constructor Details
Property Details
Method Details
associateIpGroups(params = {}, callback) ⇒ AWS.Request
Associates the specified IP access control group with the specified directory.
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.
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.
createTags(params = {}, callback) ⇒ AWS.Request
Creates the specified tags for the specified WorkSpaces resource.
createWorkspaces(params = {}, callback) ⇒ AWS.Request
Creates one or more WorkSpaces.
This operation is asynchronous and returns before the WorkSpaces are created.
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.
deleteTags(params = {}, callback) ⇒ AWS.Request
Deletes the specified tags from the specified WorkSpaces resource.
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.
describeAccount(params = {}, callback) ⇒ AWS.Request
Retrieves a list that describes the configuration of bring your own license (BYOL) for the specified account.
describeAccountModifications(params = {}, callback) ⇒ AWS.Request
Retrieves a list that describes modifications to the configuration of bring your own license (BYOL) for the specified account.
describeClientProperties(params = {}, callback) ⇒ AWS.Request
Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
describeIpGroups(params = {}, callback) ⇒ AWS.Request
Describes one or more of your IP access control groups.
describeTags(params = {}, callback) ⇒ AWS.Request
Describes the specified tags for the specified WorkSpaces resource.
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.
describeWorkspaceDirectories(params = {}, callback) ⇒ AWS.Request
Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
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.
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.
describeWorkspacesConnectionStatus(params = {}, callback) ⇒ AWS.Request
Describes the connection status of the specified WorkSpaces.
disassociateIpGroups(params = {}, callback) ⇒ AWS.Request
Disassociates the specified IP access control group from the specified directory.
importWorkspaceImage(params = {}, callback) ⇒ AWS.Request
Imports the specified Windows 7 or Windows 10 bring your own license (BYOL) image into Amazon WorkSpaces. The image must be an already licensed EC2 image that is in your AWS account, and you must own the image.
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).
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.
modifyAccount(params = {}, callback) ⇒ AWS.Request
Modifies the configuration of bring your own license (BYOL) for the specified account.
modifyClientProperties(params = {}, callback) ⇒ AWS.Request
Modifies the properties of the specified Amazon WorkSpaces clients.
modifyWorkspaceProperties(params = {}, callback) ⇒ AWS.Request
Modifies the specified WorkSpace properties.
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, or rebuild. An AutoStop WorkSpace in this state is not stopped. Users can log into a WorkSpace in the ADMIN_MAINTENANCE
state.
rebootWorkspaces(params = {}, callback) ⇒ AWS.Request
Reboots the specified WorkSpaces.
You cannot reboot a WorkSpace unless its state is AVAILABLE
or UNHEALTHY
.
This operation is asynchronous and returns before the WorkSpaces have rebooted.
rebuildWorkspaces(params = {}, callback) ⇒ AWS.Request
Rebuilds the specified WorkSpace.
You cannot rebuild a WorkSpace unless its state is AVAILABLE
, ERROR
, or UNHEALTHY
.
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.
revokeIpRules(params = {}, callback) ⇒ AWS.Request
Removes one or more rules from the specified IP access control group.
startWorkspaces(params = {}, callback) ⇒ AWS.Request
Starts the specified WorkSpaces.
You cannot start a WorkSpace unless it has a running mode of AutoStop
and a state of STOPPED
.
stopWorkspaces(params = {}, callback) ⇒ AWS.Request
Stops the specified WorkSpaces.
You cannot stop a WorkSpace unless it has a running mode of AutoStop
and a state of AVAILABLE
, IMPAIRED
, UNHEALTHY
, or ERROR
.
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 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.