AWS SDK Version 2 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

.NET Framework 4.5
 
 

Classes

NameDescription
Class ComputeType Contains information about the compute type of a WorkSpace bundle.
Class CreateWorkspacesRequest Container for the parameters to the CreateWorkspaces operation. Creates one or more WorkSpaces.

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

Class CreateWorkspacesResponse Configuration for accessing Amazon CreateWorkspaces service
Class CreateWorkspacesResult Contains the result of the CreateWorkspaces operation.
Class DefaultWorkspaceCreationProperties Contains default WorkSpace creation information.
Class DescribeWorkspaceBundlesRequest Container for the parameters to the DescribeWorkspaceBundles operation. Obtains information about the WorkSpace bundles that are available to your account in the specified region.

You can filter the results with either the BundleIds parameter, or the Owner parameter, but not both.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.

Class DescribeWorkspaceBundlesResponse Configuration for accessing Amazon DescribeWorkspaceBundles service
Class DescribeWorkspaceBundlesResult Contains the results of the DescribeWorkspaceBundles operation.
Class DescribeWorkspaceDirectoriesRequest Container for the parameters to the DescribeWorkspaceDirectories operation. Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.

Class DescribeWorkspaceDirectoriesResponse Configuration for accessing Amazon DescribeWorkspaceDirectories service
Class DescribeWorkspaceDirectoriesResult Contains the results of the DescribeWorkspaceDirectories operation.
Class DescribeWorkspacesRequest Container for the parameters to the DescribeWorkspaces operation. Obtains information about the specified WorkSpaces.

Only one of the filter parameters, such as BundleId, DirectoryId, or WorkspaceIds, can be specified at a time.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.

Class DescribeWorkspacesResponse Configuration for accessing Amazon DescribeWorkspaces service
Class DescribeWorkspacesResult Contains the results for the DescribeWorkspaces operation.
Class FailedCreateWorkspaceRequest Contains information about a WorkSpace that could not be created.
Class FailedWorkspaceChangeRequest Contains information about a WorkSpace that could not be rebooted (RebootWorkspaces), rebuilt (RebuildWorkspaces), or terminated (TerminateWorkspaces).
Class InvalidParameterValuesException WorkSpaces exception
Class RebootRequest Contains information used with the RebootWorkspaces operation to reboot a WorkSpace.
Class RebootWorkspacesRequest Container for the parameters to the RebootWorkspaces operation. Reboots the specified WorkSpaces.

To be able to reboot a WorkSpace, the WorkSpace must have a State of AVAILABLE, IMPAIRED, or INOPERABLE.

This operation is asynchronous and will return before the WorkSpaces have rebooted.

Class RebootWorkspacesResponse Configuration for accessing Amazon RebootWorkspaces service
Class RebootWorkspacesResult Contains the results of the RebootWorkspaces operation.
Class RebuildRequest Contains information used with the RebuildWorkspaces operation to rebuild a WorkSpace.
Class RebuildWorkspacesRequest Container for the parameters to the RebuildWorkspaces operation. Rebuilds the specified WorkSpaces.

Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. Rebuilding a WorkSpace causes the following to occur:

  • The system is restored to the image of the bundle that the WorkSpace is created from. Any applications that have been installed, or system settings that have been made since the WorkSpace was created will be lost.
  • The data drive (D drive) is re-created from the last automatic snapshot taken of the data drive. The current contents of the data drive are overwritten. Automatic snapshots of the data drive are taken every 12 hours, so the snapshot can be as much as 12 hours old.

To be able to rebuild a WorkSpace, the WorkSpace must have a State of AVAILABLE or ERROR.

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

Class RebuildWorkspacesResponse Configuration for accessing Amazon RebuildWorkspaces service
Class RebuildWorkspacesResult Contains the results of the RebuildWorkspaces operation.
Class ResourceLimitExceededException WorkSpaces exception
Class ResourceUnavailableException WorkSpaces exception
Class TerminateRequest Contains information used with the TerminateWorkspaces operation to terminate a WorkSpace.
Class TerminateWorkspacesRequest Container for the parameters to the TerminateWorkspaces operation. Terminates the specified WorkSpaces.

Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is not maintained and will be 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 will return before the WorkSpaces have been completely terminated.

Class TerminateWorkspacesResponse Configuration for accessing Amazon TerminateWorkspaces service
Class TerminateWorkspacesResult Contains the results of the TerminateWorkspaces operation.
Class UserStorage Contains information about the user storage for a WorkSpace bundle.
Class Workspace Contains information about a WorkSpace.
Class WorkspaceBundle Contains information about a WorkSpace bundle.
Class WorkspaceDirectory Contains information about an AWS Directory Service directory for use with Amazon WorkSpaces.
Class WorkspaceRequest Contains information about a WorkSpace creation request.