AWS SDK Version 3 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.

Implementation for accessing WorkSpaces Amazon WorkSpaces Service

This reference provides detailed information about the Amazon WorkSpaces operations.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.WorkSpaces.AmazonWorkSpacesClient

Namespace: Amazon.WorkSpaces
Assembly: AWSSDK.WorkSpaces.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonWorkSpacesClient : AmazonServiceClient
         IAmazonService, IAmazonWorkSpaces, IDisposable

The AmazonWorkSpacesClient type exposes the following members

Constructors

NameDescription
Public Method AmazonWorkSpacesClient()

Constructs AmazonWorkSpacesClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonWorkSpacesClient(RegionEndpoint)

Constructs AmazonWorkSpacesClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonWorkSpacesClient(AmazonWorkSpacesConfig)

Constructs AmazonWorkSpacesClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonWorkSpacesClient(AWSCredentials)

Constructs AmazonWorkSpacesClient with AWS Credentials

Public Method AmazonWorkSpacesClient(AWSCredentials, RegionEndpoint)

Constructs AmazonWorkSpacesClient with AWS Credentials

Public Method AmazonWorkSpacesClient(AWSCredentials, AmazonWorkSpacesConfig)

Constructs AmazonWorkSpacesClient with AWS Credentials and an AmazonWorkSpacesClient Configuration object.

Public Method AmazonWorkSpacesClient(string, string)

Constructs AmazonWorkSpacesClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonWorkSpacesClient(string, string, RegionEndpoint)

Constructs AmazonWorkSpacesClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonWorkSpacesClient(string, string, AmazonWorkSpacesConfig)

Constructs AmazonWorkSpacesClient with AWS Access Key ID, AWS Secret Key and an AmazonWorkSpacesClient Configuration object.

Public Method AmazonWorkSpacesClient(string, string, string)

Constructs AmazonWorkSpacesClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonWorkSpacesClient(string, string, string, RegionEndpoint)

Constructs AmazonWorkSpacesClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonWorkSpacesClient(string, string, string, AmazonWorkSpacesConfig)

Constructs AmazonWorkSpacesClient with AWS Access Key ID, AWS Secret Key and an AmazonWorkSpacesClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CreateTags(CreateTagsRequest)

Creates tags for a WorkSpace.

Public Method CreateTagsAsync(CreateTagsRequest, CancellationToken)

Initiates the asynchronous execution of the CreateTags operation.

Public Method CreateWorkspaces(CreateWorkspacesRequest)

Creates one or more WorkSpaces.

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

Public Method CreateWorkspacesAsync(CreateWorkspacesRequest, CancellationToken)

Initiates the asynchronous execution of the CreateWorkspaces operation.

Public Method DeleteTags(DeleteTagsRequest)

Deletes tags from a WorkSpace.

Public Method DeleteTagsAsync(DeleteTagsRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteTags operation.

Public Method DescribeTags(DescribeTagsRequest)

Describes tags for a WorkSpace.

Public Method DescribeTagsAsync(DescribeTagsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeTags operation.

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 DescribeWorkspaceBundlesAsync(CancellationToken)

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 DescribeWorkspaceBundlesAsync(DescribeWorkspaceBundlesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeWorkspaceBundles operation.

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 DescribeWorkspaceDirectoriesAsync(CancellationToken)

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 DescribeWorkspaceDirectoriesAsync(DescribeWorkspaceDirectoriesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeWorkspaceDirectories operation.

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 DescribeWorkspacesAsync(CancellationToken)

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 DescribeWorkspacesAsync(DescribeWorkspacesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeWorkspaces operation.

Public Method DescribeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest)

Describes the connection status of a specified WorkSpace.

Public Method DescribeWorkspacesConnectionStatusAsync(DescribeWorkspacesConnectionStatusRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeWorkspacesConnectionStatus operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method ModifyWorkspaceProperties(ModifyWorkspacePropertiesRequest)

Modifies the WorkSpace properties, including the running mode and AutoStop time.

Public Method ModifyWorkspacePropertiesAsync(ModifyWorkspacePropertiesRequest, CancellationToken)

Initiates the asynchronous execution of the ModifyWorkspaceProperties 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 returns before the WorkSpaces have rebooted.

Public Method RebootWorkspacesAsync(RebootWorkspacesRequest, CancellationToken)

Initiates the asynchronous execution of the RebootWorkspaces operation.

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 returns before the WorkSpaces have been completely rebuilt.

Public Method RebuildWorkspacesAsync(RebuildWorkspacesRequest, CancellationToken)

Initiates the asynchronous execution of the RebuildWorkspaces operation.

Public Method StartWorkspaces(StartWorkspacesRequest)

Starts the specified WorkSpaces. The WorkSpaces must have a running mode of AutoStop and a state of STOPPED.

Public Method StartWorkspacesAsync(StartWorkspacesRequest, CancellationToken)

Initiates the asynchronous execution of the StartWorkspaces operation.

Public Method StopWorkspaces(StopWorkspacesRequest)

Stops the specified WorkSpaces. The WorkSpaces must have a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.

Public Method StopWorkspacesAsync(StopWorkspacesRequest, CancellationToken)

Initiates the asynchronous execution of the StopWorkspaces operation.

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 returns before the WorkSpaces have been completely terminated.

Public Method TerminateWorkspacesAsync(TerminateWorkspacesRequest, CancellationToken)

Initiates the asynchronous execution of the TerminateWorkspaces operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms