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.
This is the Amazon WorkSpaces API Reference. This guide provides detailed information about Amazon WorkSpaces operations, data types, parameters, and errors.
Namespace: Amazon.WorkSpaces
Assembly: AWSSDK.dll
Version: (assembly version)
public class AmazonWorkSpacesClient : AmazonServiceClient IAmazonWorkSpaces, IDisposable
The AmazonWorkSpacesClient type exposes the following members
Name | Description | |
---|---|---|
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.
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
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.
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
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.
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonWorkSpacesClient(AWSCredentials) | Constructs AmazonWorkSpacesClient with AWS Credentials | |
AmazonWorkSpacesClient(AWSCredentials, RegionEndpoint) | Constructs AmazonWorkSpacesClient with AWS Credentials | |
AmazonWorkSpacesClient(AWSCredentials, AmazonWorkSpacesConfig) | Constructs AmazonWorkSpacesClient with AWS Credentials and an AmazonWorkSpacesClient Configuration object. | |
AmazonWorkSpacesClient(string, string) | Constructs AmazonWorkSpacesClient with AWS Access Key ID and AWS Secret Key | |
AmazonWorkSpacesClient(string, string, RegionEndpoint) | Constructs AmazonWorkSpacesClient with AWS Access Key ID and AWS Secret Key | |
AmazonWorkSpacesClient(string, string, AmazonWorkSpacesConfig) | Constructs AmazonWorkSpacesClient with AWS Access Key ID, AWS Secret Key and an AmazonWorkSpacesClient Configuration object. | |
AmazonWorkSpacesClient(string, string, string) | Constructs AmazonWorkSpacesClient with AWS Access Key ID and AWS Secret Key | |
AmazonWorkSpacesClient(string, string, string, RegionEndpoint) | Constructs AmazonWorkSpacesClient with AWS Access Key ID and AWS Secret Key | |
AmazonWorkSpacesClient(string, string, string, AmazonWorkSpacesConfig) | Constructs AmazonWorkSpacesClient with AWS Access Key ID, AWS Secret Key and an AmazonWorkSpacesClient Configuration object. |
Name | Description | |
---|---|---|
CreateWorkspaces(CreateWorkspacesRequest) |
Creates one or more WorkSpaces.
This operation is asynchronous and returns before the WorkSpaces are created. |
|
CreateWorkspacesAsync(CreateWorkspacesRequest, CancellationToken) | Initiates the asynchronous execution of the CreateWorkspaces operation. | |
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
This operation supports pagination with the use of the |
|
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
This operation supports pagination with the use of the |
|
DescribeWorkspaceBundlesAsync(DescribeWorkspaceBundlesRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeWorkspaceBundles operation. | |
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 |
|
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 |
|
DescribeWorkspaceDirectoriesAsync(DescribeWorkspaceDirectoriesRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeWorkspaceDirectories operation. | |
DescribeWorkspaces() |
Obtains information about the specified WorkSpaces.
Only one of the filter parameters, such as
This operation supports pagination with the use of the |
|
DescribeWorkspaces(DescribeWorkspacesRequest) |
Obtains information about the specified WorkSpaces.
Only one of the filter parameters, such as
This operation supports pagination with the use of the |
|
DescribeWorkspacesAsync(DescribeWorkspacesRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeWorkspaces operation. | |
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. | |
RebootWorkspaces(RebootWorkspacesRequest) |
Reboots the specified WorkSpaces.
To be able to reboot a WorkSpace, the WorkSpace must have a State of This operation is asynchronous and will return before the WorkSpaces have rebooted. |
|
RebootWorkspacesAsync(RebootWorkspacesRequest, CancellationToken) | Initiates the asynchronous execution of the RebootWorkspaces operation. | |
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:
To be able to rebuild a WorkSpace, the WorkSpace must have a State of This operation is asynchronous and will return before the WorkSpaces have been completely rebuilt. |
|
RebuildWorkspacesAsync(RebuildWorkspacesRequest, CancellationToken) | Initiates the asynchronous execution of the RebuildWorkspaces operation. | |
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 This operation is asynchronous and will return before the WorkSpaces have been completely terminated. |
|
TerminateWorkspacesAsync(TerminateWorkspacesRequest, CancellationToken) | Initiates the asynchronous execution of the TerminateWorkspaces operation. |
Name | Description | |
---|---|---|
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5