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

Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows desktops for your users.

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 AssociateIpGroups(AssociateIpGroupsRequest)

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

Public Method AssociateIpGroupsAsync(AssociateIpGroupsRequest, CancellationToken)

Initiates the asynchronous execution of the AssociateIpGroups operation.

Public Method AuthorizeIpRules(AuthorizeIpRulesRequest)

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.

Public Method AuthorizeIpRulesAsync(AuthorizeIpRulesRequest, CancellationToken)

Initiates the asynchronous execution of the AuthorizeIpRules operation.

Public Method CreateIpGroup(CreateIpGroupRequest)

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.

Public Method CreateIpGroupAsync(CreateIpGroupRequest, CancellationToken)

Initiates the asynchronous execution of the CreateIpGroup operation.

Public Method CreateTags(CreateTagsRequest)

Creates the specified tags for the specified 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 DeleteIpGroup(DeleteIpGroupRequest)

Deletes the specified IP access control group.

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

Public Method DeleteIpGroupAsync(DeleteIpGroupRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteIpGroup operation.

Public Method DeleteTags(DeleteTagsRequest)

Deletes the specified tags from the specified WorkSpace.

Public Method DeleteTagsAsync(DeleteTagsRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteTags operation.

Public Method DescribeIpGroups(DescribeIpGroupsRequest)

Describes one or more of your IP access control groups.

Public Method DescribeIpGroupsAsync(DescribeIpGroupsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeIpGroups operation.

Public Method DescribeTags(DescribeTagsRequest)

Describes the specified tags for the specified WorkSpace.

Public Method DescribeTagsAsync(DescribeTagsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeTags operation.

Public Method DescribeWorkspaceBundles()

Describes the available WorkSpace bundles.

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

Public Method DescribeWorkspaceBundles(DescribeWorkspaceBundlesRequest)

Describes the available WorkSpace bundles.

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

Public Method DescribeWorkspaceBundlesAsync(CancellationToken)

Describes the available WorkSpace bundles.

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

Public Method DescribeWorkspaceBundlesAsync(DescribeWorkspaceBundlesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeWorkspaceBundles operation.

Public Method DescribeWorkspaceDirectories()

Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.

Public Method DescribeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest)

Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.

Public Method DescribeWorkspaceDirectoriesAsync(CancellationToken)

Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.

Public Method DescribeWorkspaceDirectoriesAsync(DescribeWorkspaceDirectoriesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeWorkspaceDirectories operation.

Public Method DescribeWorkspaces()

Describes the specified WorkSpaces.

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

Public Method DescribeWorkspaces(DescribeWorkspacesRequest)

Describes the specified WorkSpaces.

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

Public Method DescribeWorkspacesAsync(CancellationToken)

Describes the specified WorkSpaces.

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

Public Method DescribeWorkspacesAsync(DescribeWorkspacesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeWorkspaces operation.

Public Method DescribeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest)

Describes the connection status of the specified WorkSpaces.

Public Method DescribeWorkspacesConnectionStatusAsync(DescribeWorkspacesConnectionStatusRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeWorkspacesConnectionStatus operation.

Public Method DisassociateIpGroups(DisassociateIpGroupsRequest)

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

Public Method DisassociateIpGroupsAsync(DisassociateIpGroupsRequest, CancellationToken)

Initiates the asynchronous execution of the DisassociateIpGroups operation.

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

Modifies the specified WorkSpace properties.

Public Method ModifyWorkspacePropertiesAsync(ModifyWorkspacePropertiesRequest, CancellationToken)

Initiates the asynchronous execution of the ModifyWorkspaceProperties operation.

Public Method ModifyWorkspaceState(ModifyWorkspaceStateRequest)

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.

Public Method ModifyWorkspaceStateAsync(ModifyWorkspaceStateRequest, CancellationToken)

Initiates the asynchronous execution of the ModifyWorkspaceState operation.

Public Method RebootWorkspaces(RebootWorkspacesRequest)

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.

Public Method RebootWorkspacesAsync(RebootWorkspacesRequest, CancellationToken)

Initiates the asynchronous execution of the RebootWorkspaces operation.

Public Method RebuildWorkspaces(RebuildWorkspacesRequest)

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.

Public Method RebuildWorkspacesAsync(RebuildWorkspacesRequest, CancellationToken)

Initiates the asynchronous execution of the RebuildWorkspaces operation.

Public Method RevokeIpRules(RevokeIpRulesRequest)

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

Public Method RevokeIpRulesAsync(RevokeIpRulesRequest, CancellationToken)

Initiates the asynchronous execution of the RevokeIpRules operation.

Public Method StartWorkspaces(StartWorkspacesRequest)

Starts the specified WorkSpaces.

You cannot start a WorkSpace unless it has 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.

You cannot stop a WorkSpace unless it has 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 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.

Public Method UpdateRulesOfIpGroup(UpdateRulesOfIpGroupRequest)

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

Public Method UpdateRulesOfIpGroupAsync(UpdateRulesOfIpGroupRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateRulesOfIpGroup 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