C# Class Amazon.WorkSpaces.AmazonWorkSpacesClient

Implementation for accessing WorkSpaces Amazon WorkSpaces Service

This reference provides detailed information about the Amazon WorkSpaces operations.

Inheritance: AmazonServiceClient, IAmazonWorkSpaces
Mostra file Open project: aws/aws-sdk-net

Public Methods

Method Description
AmazonWorkSpacesClient ( ) : System

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. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>

AmazonWorkSpacesClient ( AWSCredentials credentials ) : System

Constructs AmazonWorkSpacesClient with AWS Credentials
AmazonWorkSpacesClient ( AWSCredentials credentials, AmazonWorkSpacesConfig clientConfig ) : System

Constructs AmazonWorkSpacesClient with AWS Credentials and an AmazonWorkSpacesClient Configuration object.
AmazonWorkSpacesClient ( AWSCredentials credentials, RegionEndpoint region ) : System

Constructs AmazonWorkSpacesClient with AWS Credentials
AmazonWorkSpacesClient ( AmazonWorkSpacesConfig config ) : System

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. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>

AmazonWorkSpacesClient ( RegionEndpoint region ) : System

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. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>

AmazonWorkSpacesClient ( string awsAccessKeyId, string awsSecretAccessKey ) : System

Constructs AmazonWorkSpacesClient with AWS Access Key ID and AWS Secret Key
AmazonWorkSpacesClient ( string awsAccessKeyId, string awsSecretAccessKey, AmazonWorkSpacesConfig clientConfig ) : System

Constructs AmazonWorkSpacesClient with AWS Access Key ID, AWS Secret Key and an AmazonWorkSpacesClient Configuration object.
AmazonWorkSpacesClient ( string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region ) : System

Constructs AmazonWorkSpacesClient with AWS Access Key ID and AWS Secret Key
AmazonWorkSpacesClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken ) : System

Constructs AmazonWorkSpacesClient with AWS Access Key ID and AWS Secret Key
AmazonWorkSpacesClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonWorkSpacesConfig clientConfig ) : System

Constructs AmazonWorkSpacesClient with AWS Access Key ID, AWS Secret Key and an AmazonWorkSpacesClient Configuration object.
AmazonWorkSpacesClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region ) : System

Constructs AmazonWorkSpacesClient with AWS Access Key ID and AWS Secret Key
BeginCreateTags ( CreateTagsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the CreateTags operation.
BeginCreateWorkspaces ( Amazon.WorkSpaces.Model.CreateWorkspacesRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the CreateWorkspaces operation.
BeginDeleteTags ( DeleteTagsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DeleteTags operation.
BeginDescribeTags ( DescribeTagsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DescribeTags operation.
BeginDescribeWorkspaceBundles ( DescribeWorkspaceBundlesRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DescribeWorkspaceBundles operation.
BeginDescribeWorkspaceDirectories ( Amazon.WorkSpaces.Model.DescribeWorkspaceDirectoriesRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DescribeWorkspaceDirectories operation.
BeginDescribeWorkspaces ( DescribeWorkspacesRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DescribeWorkspaces operation.
BeginDescribeWorkspacesConnectionStatus ( DescribeWorkspacesConnectionStatusRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DescribeWorkspacesConnectionStatus operation.
BeginModifyWorkspaceProperties ( ModifyWorkspacePropertiesRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the ModifyWorkspaceProperties operation.
BeginRebootWorkspaces ( RebootWorkspacesRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the RebootWorkspaces operation.
BeginRebuildWorkspaces ( RebuildWorkspacesRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the RebuildWorkspaces operation.
BeginStartWorkspaces ( StartWorkspacesRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the StartWorkspaces operation.
BeginStopWorkspaces ( StopWorkspacesRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the StopWorkspaces operation.
BeginTerminateWorkspaces ( TerminateWorkspacesRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the TerminateWorkspaces operation.
CreateTags ( CreateTagsRequest request ) : CreateTagsResponse

Creates tags for a WorkSpace.
CreateTagsAsync ( CreateTagsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the CreateTags operation.
CreateWorkspaces ( Amazon.WorkSpaces.Model.CreateWorkspacesRequest request ) : Amazon.WorkSpaces.Model.CreateWorkspacesResponse

Creates one or more WorkSpaces.

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

CreateWorkspacesAsync ( Amazon.WorkSpaces.Model.CreateWorkspacesRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the CreateWorkspaces operation.
DeleteTags ( DeleteTagsRequest request ) : DeleteTagsResponse

Deletes tags from a WorkSpace.
DeleteTagsAsync ( DeleteTagsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DeleteTags operation.
DescribeTags ( DescribeTagsRequest request ) : DescribeTagsResponse

Describes tags for a WorkSpace.
DescribeTagsAsync ( DescribeTagsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeTags operation.
DescribeWorkspaceBundles ( ) : DescribeWorkspaceBundlesResponse

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.

DescribeWorkspaceBundles ( DescribeWorkspaceBundlesRequest request ) : DescribeWorkspaceBundlesResponse

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.

DescribeWorkspaceBundlesAsync ( DescribeWorkspaceBundlesRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeWorkspaceBundles operation.
DescribeWorkspaceBundlesAsync ( System cancellationToken = default(CancellationToken) ) : Task

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.

DescribeWorkspaceDirectories ( ) : DescribeWorkspaceDirectoriesResponse

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.

DescribeWorkspaceDirectories ( Amazon.WorkSpaces.Model.DescribeWorkspaceDirectoriesRequest request ) : DescribeWorkspaceDirectoriesResponse

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.

DescribeWorkspaceDirectoriesAsync ( Amazon.WorkSpaces.Model.DescribeWorkspaceDirectoriesRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeWorkspaceDirectories operation.
DescribeWorkspaceDirectoriesAsync ( System cancellationToken = default(CancellationToken) ) : Task

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.

DescribeWorkspaces ( ) : DescribeWorkspacesResponse

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.

DescribeWorkspaces ( DescribeWorkspacesRequest request ) : DescribeWorkspacesResponse

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.

DescribeWorkspacesAsync ( DescribeWorkspacesRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeWorkspaces operation.
DescribeWorkspacesAsync ( System cancellationToken = default(CancellationToken) ) : Task

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.

DescribeWorkspacesConnectionStatus ( DescribeWorkspacesConnectionStatusRequest request ) : DescribeWorkspacesConnectionStatusResponse

Describes the connection status of a specified WorkSpace.
DescribeWorkspacesConnectionStatusAsync ( DescribeWorkspacesConnectionStatusRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeWorkspacesConnectionStatus operation.
EndCreateTags ( IAsyncResult asyncResult ) : CreateTagsResponse

Finishes the asynchronous execution of the CreateTags operation.
EndCreateWorkspaces ( IAsyncResult asyncResult ) : Amazon.WorkSpaces.Model.CreateWorkspacesResponse

Finishes the asynchronous execution of the CreateWorkspaces operation.
EndDeleteTags ( IAsyncResult asyncResult ) : DeleteTagsResponse

Finishes the asynchronous execution of the DeleteTags operation.
EndDescribeTags ( IAsyncResult asyncResult ) : DescribeTagsResponse

Finishes the asynchronous execution of the DescribeTags operation.
EndDescribeWorkspaceBundles ( IAsyncResult asyncResult ) : DescribeWorkspaceBundlesResponse

Finishes the asynchronous execution of the DescribeWorkspaceBundles operation.
EndDescribeWorkspaceDirectories ( IAsyncResult asyncResult ) : DescribeWorkspaceDirectoriesResponse

Finishes the asynchronous execution of the DescribeWorkspaceDirectories operation.
EndDescribeWorkspaces ( IAsyncResult asyncResult ) : DescribeWorkspacesResponse

Finishes the asynchronous execution of the DescribeWorkspaces operation.
EndDescribeWorkspacesConnectionStatus ( IAsyncResult asyncResult ) : DescribeWorkspacesConnectionStatusResponse

Finishes the asynchronous execution of the DescribeWorkspacesConnectionStatus operation.
EndModifyWorkspaceProperties ( IAsyncResult asyncResult ) : ModifyWorkspacePropertiesResponse

Finishes the asynchronous execution of the ModifyWorkspaceProperties operation.
EndRebootWorkspaces ( IAsyncResult asyncResult ) : RebootWorkspacesResponse

Finishes the asynchronous execution of the RebootWorkspaces operation.
EndRebuildWorkspaces ( IAsyncResult asyncResult ) : RebuildWorkspacesResponse

Finishes the asynchronous execution of the RebuildWorkspaces operation.
EndStartWorkspaces ( IAsyncResult asyncResult ) : StartWorkspacesResponse

Finishes the asynchronous execution of the StartWorkspaces operation.
EndStopWorkspaces ( IAsyncResult asyncResult ) : StopWorkspacesResponse

Finishes the asynchronous execution of the StopWorkspaces operation.
EndTerminateWorkspaces ( IAsyncResult asyncResult ) : TerminateWorkspacesResponse

Finishes the asynchronous execution of the TerminateWorkspaces operation.
ModifyWorkspaceProperties ( ModifyWorkspacePropertiesRequest request ) : ModifyWorkspacePropertiesResponse

Modifies the WorkSpace properties, including the RunningMode and AutoStop time.
ModifyWorkspacePropertiesAsync ( ModifyWorkspacePropertiesRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the ModifyWorkspaceProperties operation.
RebootWorkspaces ( RebootWorkspacesRequest request ) : RebootWorkspacesResponse

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.

RebootWorkspacesAsync ( RebootWorkspacesRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the RebootWorkspaces operation.
RebuildWorkspaces ( RebuildWorkspacesRequest request ) : RebuildWorkspacesResponse

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.

RebuildWorkspacesAsync ( RebuildWorkspacesRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the RebuildWorkspaces operation.
StartWorkspaces ( StartWorkspacesRequest request ) : StartWorkspacesResponse

Starts the specified WorkSpaces. The API only works with WorkSpaces that have RunningMode configured as AutoStop and the State set to “STOPPED.”
StartWorkspacesAsync ( StartWorkspacesRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the StartWorkspaces operation.
StopWorkspaces ( StopWorkspacesRequest request ) : StopWorkspacesResponse

Stops the specified WorkSpaces. The API only works with WorkSpaces that have RunningMode configured as AutoStop and the State set to AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.
StopWorkspacesAsync ( StopWorkspacesRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the StopWorkspaces operation.
TerminateWorkspaces ( TerminateWorkspacesRequest request ) : TerminateWorkspacesResponse

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.

TerminateWorkspacesAsync ( TerminateWorkspacesRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the TerminateWorkspaces operation.

Protected Methods

Method Description
CreateSigner ( ) : AbstractAWSSigner

Creates the signer for the service.
Dispose ( bool disposing ) : void

Disposes the service client.

Method Details

AmazonWorkSpacesClient() public method

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. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>
public AmazonWorkSpacesClient ( ) : System
return System

AmazonWorkSpacesClient() public method

Constructs AmazonWorkSpacesClient with AWS Credentials
public AmazonWorkSpacesClient ( AWSCredentials credentials ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
return System

AmazonWorkSpacesClient() public method

Constructs AmazonWorkSpacesClient with AWS Credentials and an AmazonWorkSpacesClient Configuration object.
public AmazonWorkSpacesClient ( AWSCredentials credentials, AmazonWorkSpacesConfig clientConfig ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
clientConfig AmazonWorkSpacesConfig The AmazonWorkSpacesClient Configuration Object
return System

AmazonWorkSpacesClient() public method

Constructs AmazonWorkSpacesClient with AWS Credentials
public AmazonWorkSpacesClient ( AWSCredentials credentials, RegionEndpoint region ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
region RegionEndpoint The region to connect.
return System

AmazonWorkSpacesClient() public method

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. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>
public AmazonWorkSpacesClient ( AmazonWorkSpacesConfig config ) : System
config AmazonWorkSpacesConfig The AmazonWorkSpacesClient Configuration Object
return System

AmazonWorkSpacesClient() public method

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. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>
public AmazonWorkSpacesClient ( RegionEndpoint region ) : System
region RegionEndpoint The region to connect.
return System

AmazonWorkSpacesClient() public method

Constructs AmazonWorkSpacesClient with AWS Access Key ID and AWS Secret Key
public AmazonWorkSpacesClient ( string awsAccessKeyId, string awsSecretAccessKey ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
return System

AmazonWorkSpacesClient() public method

Constructs AmazonWorkSpacesClient with AWS Access Key ID, AWS Secret Key and an AmazonWorkSpacesClient Configuration object.
public AmazonWorkSpacesClient ( string awsAccessKeyId, string awsSecretAccessKey, AmazonWorkSpacesConfig clientConfig ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
clientConfig AmazonWorkSpacesConfig The AmazonWorkSpacesClient Configuration Object
return System

AmazonWorkSpacesClient() public method

Constructs AmazonWorkSpacesClient with AWS Access Key ID and AWS Secret Key
public AmazonWorkSpacesClient ( string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
region RegionEndpoint The region to connect.
return System

AmazonWorkSpacesClient() public method

Constructs AmazonWorkSpacesClient with AWS Access Key ID and AWS Secret Key
public AmazonWorkSpacesClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
return System

AmazonWorkSpacesClient() public method

Constructs AmazonWorkSpacesClient with AWS Access Key ID, AWS Secret Key and an AmazonWorkSpacesClient Configuration object.
public AmazonWorkSpacesClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonWorkSpacesConfig clientConfig ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
clientConfig AmazonWorkSpacesConfig The AmazonWorkSpacesClient Configuration Object
return System

AmazonWorkSpacesClient() public method

Constructs AmazonWorkSpacesClient with AWS Access Key ID and AWS Secret Key
public AmazonWorkSpacesClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
region RegionEndpoint The region to connect.
return System

BeginCreateTags() public method

Initiates the asynchronous execution of the CreateTags operation.
public BeginCreateTags ( CreateTagsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WorkSpaces.Model.CreateTagsRequest Container for the necessary parameters to execute the CreateTags operation on AmazonWorkSpacesClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginCreateWorkspaces() public method

Initiates the asynchronous execution of the CreateWorkspaces operation.
public BeginCreateWorkspaces ( Amazon.WorkSpaces.Model.CreateWorkspacesRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WorkSpaces.Model.CreateWorkspacesRequest Container for the necessary parameters to execute the CreateWorkspaces operation on AmazonWorkSpacesClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDeleteTags() public method

Initiates the asynchronous execution of the DeleteTags operation.
public BeginDeleteTags ( DeleteTagsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WorkSpaces.Model.DeleteTagsRequest Container for the necessary parameters to execute the DeleteTags operation on AmazonWorkSpacesClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDescribeTags() public method

Initiates the asynchronous execution of the DescribeTags operation.
public BeginDescribeTags ( DescribeTagsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WorkSpaces.Model.DescribeTagsRequest Container for the necessary parameters to execute the DescribeTags operation on AmazonWorkSpacesClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDescribeWorkspaceBundles() public method

Initiates the asynchronous execution of the DescribeWorkspaceBundles operation.
public BeginDescribeWorkspaceBundles ( DescribeWorkspaceBundlesRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WorkSpaces.Model.DescribeWorkspaceBundlesRequest Container for the necessary parameters to execute the DescribeWorkspaceBundles operation on AmazonWorkSpacesClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDescribeWorkspaceDirectories() public method

Initiates the asynchronous execution of the DescribeWorkspaceDirectories operation.
public BeginDescribeWorkspaceDirectories ( Amazon.WorkSpaces.Model.DescribeWorkspaceDirectoriesRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WorkSpaces.Model.DescribeWorkspaceDirectoriesRequest Container for the necessary parameters to execute the DescribeWorkspaceDirectories operation on AmazonWorkSpacesClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDescribeWorkspaces() public method

Initiates the asynchronous execution of the DescribeWorkspaces operation.
public BeginDescribeWorkspaces ( DescribeWorkspacesRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WorkSpaces.Model.DescribeWorkspacesRequest Container for the necessary parameters to execute the DescribeWorkspaces operation on AmazonWorkSpacesClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDescribeWorkspacesConnectionStatus() public method

Initiates the asynchronous execution of the DescribeWorkspacesConnectionStatus operation.
public BeginDescribeWorkspacesConnectionStatus ( DescribeWorkspacesConnectionStatusRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WorkSpaces.Model.DescribeWorkspacesConnectionStatusRequest Container for the necessary parameters to execute the DescribeWorkspacesConnectionStatus operation on AmazonWorkSpacesClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginModifyWorkspaceProperties() public method

Initiates the asynchronous execution of the ModifyWorkspaceProperties operation.
public BeginModifyWorkspaceProperties ( ModifyWorkspacePropertiesRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WorkSpaces.Model.ModifyWorkspacePropertiesRequest Container for the necessary parameters to execute the ModifyWorkspaceProperties operation on AmazonWorkSpacesClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginRebootWorkspaces() public method

Initiates the asynchronous execution of the RebootWorkspaces operation.
public BeginRebootWorkspaces ( RebootWorkspacesRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WorkSpaces.Model.RebootWorkspacesRequest Container for the necessary parameters to execute the RebootWorkspaces operation on AmazonWorkSpacesClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginRebuildWorkspaces() public method

Initiates the asynchronous execution of the RebuildWorkspaces operation.
public BeginRebuildWorkspaces ( RebuildWorkspacesRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WorkSpaces.Model.RebuildWorkspacesRequest Container for the necessary parameters to execute the RebuildWorkspaces operation on AmazonWorkSpacesClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginStartWorkspaces() public method

Initiates the asynchronous execution of the StartWorkspaces operation.
public BeginStartWorkspaces ( StartWorkspacesRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WorkSpaces.Model.StartWorkspacesRequest Container for the necessary parameters to execute the StartWorkspaces operation on AmazonWorkSpacesClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginStopWorkspaces() public method

Initiates the asynchronous execution of the StopWorkspaces operation.
public BeginStopWorkspaces ( StopWorkspacesRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WorkSpaces.Model.StopWorkspacesRequest Container for the necessary parameters to execute the StopWorkspaces operation on AmazonWorkSpacesClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginTerminateWorkspaces() public method

Initiates the asynchronous execution of the TerminateWorkspaces operation.
public BeginTerminateWorkspaces ( TerminateWorkspacesRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.WorkSpaces.Model.TerminateWorkspacesRequest Container for the necessary parameters to execute the TerminateWorkspaces operation on AmazonWorkSpacesClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

CreateSigner() protected method

Creates the signer for the service.
protected CreateSigner ( ) : AbstractAWSSigner
return Amazon.Runtime.Internal.Auth.AbstractAWSSigner

CreateTags() public method

Creates tags for a WorkSpace.
/// One or more parameter values are not valid. /// /// Your resource limits have been exceeded. /// /// The resource could not be found. ///
public CreateTags ( CreateTagsRequest request ) : CreateTagsResponse
request Amazon.WorkSpaces.Model.CreateTagsRequest Container for the necessary parameters to execute the CreateTags service method.
return CreateTagsResponse

CreateTagsAsync() public method

Initiates the asynchronous execution of the CreateTags operation.
public CreateTagsAsync ( CreateTagsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.WorkSpaces.Model.CreateTagsRequest Container for the necessary parameters to execute the CreateTags operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

CreateWorkspaces() public method

Creates one or more WorkSpaces.

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

/// One or more parameter values are not valid. /// /// Your resource limits have been exceeded. ///
public CreateWorkspaces ( Amazon.WorkSpaces.Model.CreateWorkspacesRequest request ) : Amazon.WorkSpaces.Model.CreateWorkspacesResponse
request Amazon.WorkSpaces.Model.CreateWorkspacesRequest Container for the necessary parameters to execute the CreateWorkspaces service method.
return Amazon.WorkSpaces.Model.CreateWorkspacesResponse

CreateWorkspacesAsync() public method

Initiates the asynchronous execution of the CreateWorkspaces operation.
public CreateWorkspacesAsync ( Amazon.WorkSpaces.Model.CreateWorkspacesRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.WorkSpaces.Model.CreateWorkspacesRequest Container for the necessary parameters to execute the CreateWorkspaces operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeleteTags() public method

Deletes tags from a WorkSpace.
/// One or more parameter values are not valid. /// /// The resource could not be found. ///
public DeleteTags ( DeleteTagsRequest request ) : DeleteTagsResponse
request Amazon.WorkSpaces.Model.DeleteTagsRequest Container for the necessary parameters to execute the DeleteTags service method.
return DeleteTagsResponse

DeleteTagsAsync() public method

Initiates the asynchronous execution of the DeleteTags operation.
public DeleteTagsAsync ( DeleteTagsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.WorkSpaces.Model.DeleteTagsRequest Container for the necessary parameters to execute the DeleteTags operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeTags() public method

Describes tags for a WorkSpace.
/// The resource could not be found. ///
public DescribeTags ( DescribeTagsRequest request ) : DescribeTagsResponse
request Amazon.WorkSpaces.Model.DescribeTagsRequest Container for the necessary parameters to execute the DescribeTags service method.
return Amazon.WorkSpaces.Model.DescribeTagsResponse

DescribeTagsAsync() public method

Initiates the asynchronous execution of the DescribeTags operation.
public DescribeTagsAsync ( DescribeTagsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.WorkSpaces.Model.DescribeTagsRequest Container for the necessary parameters to execute the DescribeTags operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeWorkspaceBundles() public method

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.

/// One or more parameter values are not valid. ///
public DescribeWorkspaceBundles ( ) : DescribeWorkspaceBundlesResponse
return Amazon.WorkSpaces.Model.DescribeWorkspaceBundlesResponse

DescribeWorkspaceBundles() public method

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.

/// One or more parameter values are not valid. ///
public DescribeWorkspaceBundles ( DescribeWorkspaceBundlesRequest request ) : DescribeWorkspaceBundlesResponse
request Amazon.WorkSpaces.Model.DescribeWorkspaceBundlesRequest Container for the necessary parameters to execute the DescribeWorkspaceBundles service method.
return Amazon.WorkSpaces.Model.DescribeWorkspaceBundlesResponse

DescribeWorkspaceBundlesAsync() public method

Initiates the asynchronous execution of the DescribeWorkspaceBundles operation.
public DescribeWorkspaceBundlesAsync ( DescribeWorkspaceBundlesRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.WorkSpaces.Model.DescribeWorkspaceBundlesRequest Container for the necessary parameters to execute the DescribeWorkspaceBundles operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeWorkspaceBundlesAsync() public method

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.

/// One or more parameter values are not valid. ///
public DescribeWorkspaceBundlesAsync ( System cancellationToken = default(CancellationToken) ) : Task
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeWorkspaceDirectories() public method

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.

/// One or more parameter values are not valid. ///
public DescribeWorkspaceDirectories ( ) : DescribeWorkspaceDirectoriesResponse
return Amazon.WorkSpaces.Model.DescribeWorkspaceDirectoriesResponse

DescribeWorkspaceDirectories() public method

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.

/// One or more parameter values are not valid. ///
public DescribeWorkspaceDirectories ( Amazon.WorkSpaces.Model.DescribeWorkspaceDirectoriesRequest request ) : DescribeWorkspaceDirectoriesResponse
request Amazon.WorkSpaces.Model.DescribeWorkspaceDirectoriesRequest Container for the necessary parameters to execute the DescribeWorkspaceDirectories service method.
return Amazon.WorkSpaces.Model.DescribeWorkspaceDirectoriesResponse

DescribeWorkspaceDirectoriesAsync() public method

Initiates the asynchronous execution of the DescribeWorkspaceDirectories operation.
public DescribeWorkspaceDirectoriesAsync ( Amazon.WorkSpaces.Model.DescribeWorkspaceDirectoriesRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.WorkSpaces.Model.DescribeWorkspaceDirectoriesRequest Container for the necessary parameters to execute the DescribeWorkspaceDirectories operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeWorkspaceDirectoriesAsync() public method

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.

/// One or more parameter values are not valid. ///
public DescribeWorkspaceDirectoriesAsync ( System cancellationToken = default(CancellationToken) ) : Task
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeWorkspaces() public method

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.

/// One or more parameter values are not valid. /// /// The specified resource is not available. ///
public DescribeWorkspaces ( ) : DescribeWorkspacesResponse
return Amazon.WorkSpaces.Model.DescribeWorkspacesResponse

DescribeWorkspaces() public method

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.

/// One or more parameter values are not valid. /// /// The specified resource is not available. ///
public DescribeWorkspaces ( DescribeWorkspacesRequest request ) : DescribeWorkspacesResponse
request Amazon.WorkSpaces.Model.DescribeWorkspacesRequest Container for the necessary parameters to execute the DescribeWorkspaces service method.
return Amazon.WorkSpaces.Model.DescribeWorkspacesResponse

DescribeWorkspacesAsync() public method

Initiates the asynchronous execution of the DescribeWorkspaces operation.
public DescribeWorkspacesAsync ( DescribeWorkspacesRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.WorkSpaces.Model.DescribeWorkspacesRequest Container for the necessary parameters to execute the DescribeWorkspaces operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeWorkspacesAsync() public method

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.

/// One or more parameter values are not valid. /// /// The specified resource is not available. ///
public DescribeWorkspacesAsync ( System cancellationToken = default(CancellationToken) ) : Task
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeWorkspacesConnectionStatus() public method

Describes the connection status of a specified WorkSpace.
/// One or more parameter values are not valid. ///
public DescribeWorkspacesConnectionStatus ( DescribeWorkspacesConnectionStatusRequest request ) : DescribeWorkspacesConnectionStatusResponse
request Amazon.WorkSpaces.Model.DescribeWorkspacesConnectionStatusRequest Container for the necessary parameters to execute the DescribeWorkspacesConnectionStatus service method.
return Amazon.WorkSpaces.Model.DescribeWorkspacesConnectionStatusResponse

DescribeWorkspacesConnectionStatusAsync() public method

Initiates the asynchronous execution of the DescribeWorkspacesConnectionStatus operation.
public DescribeWorkspacesConnectionStatusAsync ( DescribeWorkspacesConnectionStatusRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.WorkSpaces.Model.DescribeWorkspacesConnectionStatusRequest Container for the necessary parameters to execute the DescribeWorkspacesConnectionStatus operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

Dispose() protected method

Disposes the service client.
protected Dispose ( bool disposing ) : void
disposing bool
return void

EndCreateTags() public method

Finishes the asynchronous execution of the CreateTags operation.
public EndCreateTags ( IAsyncResult asyncResult ) : CreateTagsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginCreateTags.
return CreateTagsResponse

EndCreateWorkspaces() public method

Finishes the asynchronous execution of the CreateWorkspaces operation.
public EndCreateWorkspaces ( IAsyncResult asyncResult ) : Amazon.WorkSpaces.Model.CreateWorkspacesResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginCreateWorkspaces.
return Amazon.WorkSpaces.Model.CreateWorkspacesResponse

EndDeleteTags() public method

Finishes the asynchronous execution of the DeleteTags operation.
public EndDeleteTags ( IAsyncResult asyncResult ) : DeleteTagsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDeleteTags.
return DeleteTagsResponse

EndDescribeTags() public method

Finishes the asynchronous execution of the DescribeTags operation.
public EndDescribeTags ( IAsyncResult asyncResult ) : DescribeTagsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDescribeTags.
return Amazon.WorkSpaces.Model.DescribeTagsResponse

EndDescribeWorkspaceBundles() public method

Finishes the asynchronous execution of the DescribeWorkspaceBundles operation.
public EndDescribeWorkspaceBundles ( IAsyncResult asyncResult ) : DescribeWorkspaceBundlesResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDescribeWorkspaceBundles.
return Amazon.WorkSpaces.Model.DescribeWorkspaceBundlesResponse

EndDescribeWorkspaceDirectories() public method

Finishes the asynchronous execution of the DescribeWorkspaceDirectories operation.
public EndDescribeWorkspaceDirectories ( IAsyncResult asyncResult ) : DescribeWorkspaceDirectoriesResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDescribeWorkspaceDirectories.
return Amazon.WorkSpaces.Model.DescribeWorkspaceDirectoriesResponse

EndDescribeWorkspaces() public method

Finishes the asynchronous execution of the DescribeWorkspaces operation.
public EndDescribeWorkspaces ( IAsyncResult asyncResult ) : DescribeWorkspacesResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDescribeWorkspaces.
return Amazon.WorkSpaces.Model.DescribeWorkspacesResponse

EndDescribeWorkspacesConnectionStatus() public method

Finishes the asynchronous execution of the DescribeWorkspacesConnectionStatus operation.
public EndDescribeWorkspacesConnectionStatus ( IAsyncResult asyncResult ) : DescribeWorkspacesConnectionStatusResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDescribeWorkspacesConnectionStatus.
return Amazon.WorkSpaces.Model.DescribeWorkspacesConnectionStatusResponse

EndModifyWorkspaceProperties() public method

Finishes the asynchronous execution of the ModifyWorkspaceProperties operation.
public EndModifyWorkspaceProperties ( IAsyncResult asyncResult ) : ModifyWorkspacePropertiesResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginModifyWorkspaceProperties.
return ModifyWorkspacePropertiesResponse

EndRebootWorkspaces() public method

Finishes the asynchronous execution of the RebootWorkspaces operation.
public EndRebootWorkspaces ( IAsyncResult asyncResult ) : RebootWorkspacesResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginRebootWorkspaces.
return Amazon.WorkSpaces.Model.RebootWorkspacesResponse

EndRebuildWorkspaces() public method

Finishes the asynchronous execution of the RebuildWorkspaces operation.
public EndRebuildWorkspaces ( IAsyncResult asyncResult ) : RebuildWorkspacesResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginRebuildWorkspaces.
return Amazon.WorkSpaces.Model.RebuildWorkspacesResponse

EndStartWorkspaces() public method

Finishes the asynchronous execution of the StartWorkspaces operation.
public EndStartWorkspaces ( IAsyncResult asyncResult ) : StartWorkspacesResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginStartWorkspaces.
return Amazon.WorkSpaces.Model.StartWorkspacesResponse

EndStopWorkspaces() public method

Finishes the asynchronous execution of the StopWorkspaces operation.
public EndStopWorkspaces ( IAsyncResult asyncResult ) : StopWorkspacesResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginStopWorkspaces.
return Amazon.WorkSpaces.Model.StopWorkspacesResponse

EndTerminateWorkspaces() public method

Finishes the asynchronous execution of the TerminateWorkspaces operation.
public EndTerminateWorkspaces ( IAsyncResult asyncResult ) : TerminateWorkspacesResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginTerminateWorkspaces.
return Amazon.WorkSpaces.Model.TerminateWorkspacesResponse

ModifyWorkspaceProperties() public method

Modifies the WorkSpace properties, including the RunningMode and AutoStop time.
/// /// /// One or more parameter values are not valid. /// /// The specified WorkSpace has an invalid state for this operation. /// /// The properties of this WorkSpace are currently being modified. Try again in a moment. /// /// The resource could not be found. /// /// The specified resource is not available. /// /// The WorkSpace does not have the supported configuration for this operation. For more /// information, see the Amazon /// WorkSpaces Administration Guide. ///
public ModifyWorkspaceProperties ( ModifyWorkspacePropertiesRequest request ) : ModifyWorkspacePropertiesResponse
request Amazon.WorkSpaces.Model.ModifyWorkspacePropertiesRequest Container for the necessary parameters to execute the ModifyWorkspaceProperties service method.
return ModifyWorkspacePropertiesResponse

ModifyWorkspacePropertiesAsync() public method

Initiates the asynchronous execution of the ModifyWorkspaceProperties operation.
public ModifyWorkspacePropertiesAsync ( ModifyWorkspacePropertiesRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.WorkSpaces.Model.ModifyWorkspacePropertiesRequest Container for the necessary parameters to execute the ModifyWorkspaceProperties operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

RebootWorkspaces() public method

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 RebootWorkspaces ( RebootWorkspacesRequest request ) : RebootWorkspacesResponse
request Amazon.WorkSpaces.Model.RebootWorkspacesRequest Container for the necessary parameters to execute the RebootWorkspaces service method.
return Amazon.WorkSpaces.Model.RebootWorkspacesResponse

RebootWorkspacesAsync() public method

Initiates the asynchronous execution of the RebootWorkspaces operation.
public RebootWorkspacesAsync ( RebootWorkspacesRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.WorkSpaces.Model.RebootWorkspacesRequest Container for the necessary parameters to execute the RebootWorkspaces operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

RebuildWorkspaces() public method

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 RebuildWorkspaces ( RebuildWorkspacesRequest request ) : RebuildWorkspacesResponse
request Amazon.WorkSpaces.Model.RebuildWorkspacesRequest Container for the necessary parameters to execute the RebuildWorkspaces service method.
return Amazon.WorkSpaces.Model.RebuildWorkspacesResponse

RebuildWorkspacesAsync() public method

Initiates the asynchronous execution of the RebuildWorkspaces operation.
public RebuildWorkspacesAsync ( RebuildWorkspacesRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.WorkSpaces.Model.RebuildWorkspacesRequest Container for the necessary parameters to execute the RebuildWorkspaces operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

StartWorkspaces() public method

Starts the specified WorkSpaces. The API only works with WorkSpaces that have RunningMode configured as AutoStop and the State set to “STOPPED.”
public StartWorkspaces ( StartWorkspacesRequest request ) : StartWorkspacesResponse
request Amazon.WorkSpaces.Model.StartWorkspacesRequest Container for the necessary parameters to execute the StartWorkspaces service method.
return Amazon.WorkSpaces.Model.StartWorkspacesResponse

StartWorkspacesAsync() public method

Initiates the asynchronous execution of the StartWorkspaces operation.
public StartWorkspacesAsync ( StartWorkspacesRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.WorkSpaces.Model.StartWorkspacesRequest Container for the necessary parameters to execute the StartWorkspaces operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

StopWorkspaces() public method

Stops the specified WorkSpaces. The API only works with WorkSpaces that have RunningMode configured as AutoStop and the State set to AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.
public StopWorkspaces ( StopWorkspacesRequest request ) : StopWorkspacesResponse
request Amazon.WorkSpaces.Model.StopWorkspacesRequest Container for the necessary parameters to execute the StopWorkspaces service method.
return Amazon.WorkSpaces.Model.StopWorkspacesResponse

StopWorkspacesAsync() public method

Initiates the asynchronous execution of the StopWorkspaces operation.
public StopWorkspacesAsync ( StopWorkspacesRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.WorkSpaces.Model.StopWorkspacesRequest Container for the necessary parameters to execute the StopWorkspaces operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

TerminateWorkspaces() public method

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 TerminateWorkspaces ( TerminateWorkspacesRequest request ) : TerminateWorkspacesResponse
request Amazon.WorkSpaces.Model.TerminateWorkspacesRequest Container for the necessary parameters to execute the TerminateWorkspaces service method.
return Amazon.WorkSpaces.Model.TerminateWorkspacesResponse

TerminateWorkspacesAsync() public method

Initiates the asynchronous execution of the TerminateWorkspaces operation.
public TerminateWorkspacesAsync ( TerminateWorkspacesRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.WorkSpaces.Model.TerminateWorkspacesRequest Container for the necessary parameters to execute the TerminateWorkspaces operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task