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.

Classes

NameDescription
Class AccessDeniedException

WorkSpaces exception

Class ComputeType

Contains information about the compute type of a WorkSpace bundle.

Class CreateTagsRequest

Container for the parameters to the CreateTags operation. Creates tags for a WorkSpace.

Class CreateTagsResponse

The result of the CreateTags operation.

Class CreateWorkspacesRequest

Container for the parameters to the CreateWorkspaces operation. Creates one or more WorkSpaces.

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

Class CreateWorkspacesResponse

Contains the result of the CreateWorkspaces operation.

Class DefaultWorkspaceCreationProperties

Contains default WorkSpace creation information.

Class DeleteTagsRequest

Container for the parameters to the DeleteTags operation. Deletes tags from a WorkSpace.

Class DeleteTagsResponse

The result of the DeleteTags operation.

Class DescribeTagsRequest

Container for the parameters to the DescribeTags operation. Describes tags for a WorkSpace.

Class DescribeTagsResponse

The result of the DescribeTags operation.

Class DescribeWorkspaceBundlesRequest

Container for the parameters to the DescribeWorkspaceBundles operation. Obtains information about the WorkSpace bundles that are available to your account in the specified region.

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

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

Class DescribeWorkspaceBundlesResponse

Contains the results of the DescribeWorkspaceBundles operation.

Class DescribeWorkspaceDirectoriesRequest

Container for the parameters to the DescribeWorkspaceDirectories operation. Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account.

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

Class DescribeWorkspaceDirectoriesResponse

Contains the results of the DescribeWorkspaceDirectories operation.

Class DescribeWorkspacesConnectionStatusRequest

Container for the parameters to the DescribeWorkspacesConnectionStatus operation. Describes the connection status of a specified WorkSpace.

Class DescribeWorkspacesConnectionStatusResponse

This is the response object from the DescribeWorkspacesConnectionStatus operation.

Class DescribeWorkspacesRequest

Container for the parameters to the DescribeWorkspaces operation. Obtains information about the specified WorkSpaces.

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

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

Class DescribeWorkspacesResponse

Contains the results for the DescribeWorkspaces operation.

Class FailedCreateWorkspaceRequest

Contains information about a WorkSpace that could not be created.

Class FailedWorkspaceChangeRequest

Contains information about a WorkSpace that could not be rebooted (RebootWorkspaces), rebuilt (RebuildWorkspaces), terminated (TerminateWorkspaces), started (StartWorkspaces), or stopped (StopWorkspaces).

Class InvalidParameterValuesException

WorkSpaces exception

Class InvalidResourceStateException

WorkSpaces exception

Class ModifyWorkspacePropertiesRequest

Container for the parameters to the ModifyWorkspaceProperties operation. Modifies the WorkSpace properties, including the running mode and AutoStop time.

Class ModifyWorkspacePropertiesResponse

This is the response object from the ModifyWorkspaceProperties operation.

Class OperationInProgressException

WorkSpaces exception

Class RebootRequest

Contains information used with the RebootWorkspaces operation to reboot a WorkSpace.

Class RebootWorkspacesRequest

Container for the parameters to the RebootWorkspaces operation. Reboots the specified WorkSpaces.

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

This operation is asynchronous and returns before the WorkSpaces have rebooted.

Class RebootWorkspacesResponse

Contains the results of the RebootWorkspaces operation.

Class RebuildRequest

Contains information used with the RebuildWorkspaces operation to rebuild a WorkSpace.

Class RebuildWorkspacesRequest

Container for the parameters to the RebuildWorkspaces operation. Rebuilds the specified WorkSpaces.

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

  • The system is restored to the image of the bundle that the WorkSpace is created from. Any applications that have been installed, or system settings that have been made since the WorkSpace was created will be lost.

  • The data drive (D drive) is re-created from the last automatic snapshot taken of the data drive. The current contents of the data drive are overwritten. Automatic snapshots of the data drive are taken every 12 hours, so the snapshot can be as much as 12 hours old.

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

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

Class RebuildWorkspacesResponse

Contains the results of the RebuildWorkspaces operation.

Class ResourceLimitExceededException

WorkSpaces exception

Class ResourceNotFoundException

WorkSpaces exception

Class ResourceUnavailableException

WorkSpaces exception

Class StartRequest

Describes the start request.

Class StartWorkspacesRequest

Container for the parameters to the StartWorkspaces operation. Starts the specified WorkSpaces. The WorkSpaces must have a running mode of AutoStop and a state of STOPPED.

Class StartWorkspacesResponse

This is the response object from the StartWorkspaces operation.

Class StopRequest

Describes the stop request.

Class StopWorkspacesRequest

Container for the parameters to the StopWorkspaces operation. Stops the specified WorkSpaces. The WorkSpaces must have a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.

Class StopWorkspacesResponse

This is the response object from the StopWorkspaces operation.

Class Tag

Describes the tag of the WorkSpace.

Class TerminateRequest

Contains information used with the TerminateWorkspaces operation to terminate a WorkSpace.

Class TerminateWorkspacesRequest

Container for the parameters to the TerminateWorkspaces operation. Terminates the specified WorkSpaces.

Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is not maintained and will be destroyed. If you need to archive any user data, contact Amazon Web Services before terminating the WorkSpace.

You can terminate a WorkSpace that is in any state except SUSPENDED.

This operation is asynchronous and returns before the WorkSpaces have been completely terminated.

Class TerminateWorkspacesResponse

Contains the results of the TerminateWorkspaces operation.

Class UnsupportedWorkspaceConfigurationException

WorkSpaces exception

Class UserStorage

Contains information about the user storage for a WorkSpace bundle.

Class Workspace

Contains information about a WorkSpace.

Class WorkspaceBundle

Contains information about a WorkSpace bundle.

Class WorkspaceConnectionStatus

Describes the connection status of a WorkSpace.

Class WorkspaceDirectory

Contains information about an AWS Directory Service directory for use with Amazon WorkSpaces.

Class WorkspaceProperties

Describes the properties of a WorkSpace.

Class WorkspaceRequest

Contains information about a WorkSpace creation request.