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 3.5
 
Interface for accessing WorkSpaces Amazon WorkSpaces Service

This is the Amazon WorkSpaces API Reference. This guide provides detailed information about Amazon WorkSpaces operations, data types, parameters, and errors.

Inheritance Hierarchy

Amazon.WorkSpaces.IAmazonWorkSpaces

Namespace: Amazon.WorkSpaces
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public interface IAmazonWorkSpaces
         IDisposable

The IAmazonWorkSpaces type exposes the following members

Methods

NameDescription
Public Method BeginCreateWorkspaces(CreateWorkspacesRequest, AsyncCallback, object) Initiates the asynchronous execution of the CreateWorkspaces operation.
Public Method BeginDescribeWorkspaceBundles(DescribeWorkspaceBundlesRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeWorkspaceBundles operation.
Public Method BeginDescribeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeWorkspaceDirectories operation.
Public Method BeginDescribeWorkspaces(DescribeWorkspacesRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeWorkspaces operation.
Public Method BeginRebootWorkspaces(RebootWorkspacesRequest, AsyncCallback, object) Initiates the asynchronous execution of the RebootWorkspaces operation.
Public Method BeginRebuildWorkspaces(RebuildWorkspacesRequest, AsyncCallback, object) Initiates the asynchronous execution of the RebuildWorkspaces operation.
Public Method BeginTerminateWorkspaces(TerminateWorkspacesRequest, AsyncCallback, object) Initiates the asynchronous execution of the TerminateWorkspaces operation.
Public Method CreateWorkspaces(CreateWorkspacesRequest) Creates one or more WorkSpaces.

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

Public Method DescribeWorkspaceBundles() 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.

Public Method DescribeWorkspaceBundles(DescribeWorkspaceBundlesRequest) 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.

Public Method DescribeWorkspaceDirectories() 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.

Public Method DescribeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest) 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.

Public Method DescribeWorkspaces() 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.

Public Method DescribeWorkspaces(DescribeWorkspacesRequest) 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.

Public Method EndCreateWorkspaces(IAsyncResult) Finishes the asynchronous execution of the CreateWorkspaces operation.
Public Method EndDescribeWorkspaceBundles(IAsyncResult) Finishes the asynchronous execution of the DescribeWorkspaceBundles operation.
Public Method EndDescribeWorkspaceDirectories(IAsyncResult) Finishes the asynchronous execution of the DescribeWorkspaceDirectories operation.
Public Method EndDescribeWorkspaces(IAsyncResult) Finishes the asynchronous execution of the DescribeWorkspaces operation.
Public Method EndRebootWorkspaces(IAsyncResult) Finishes the asynchronous execution of the RebootWorkspaces operation.
Public Method EndRebuildWorkspaces(IAsyncResult) Finishes the asynchronous execution of the RebuildWorkspaces operation.
Public Method EndTerminateWorkspaces(IAsyncResult) Finishes the asynchronous execution of the TerminateWorkspaces operation.
Public Method RebootWorkspaces(RebootWorkspacesRequest) 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.

Public Method RebuildWorkspaces(RebuildWorkspacesRequest) 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.

Public Method TerminateWorkspaces(TerminateWorkspacesRequest) 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.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5