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.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDescribeWorkspaces and EndDescribeWorkspaces.

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

Syntax

C#
public virtual Task<DescribeWorkspacesResponse> DescribeWorkspacesAsync(
         CancellationToken cancellationToken
)
Parameters
cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value
The response from the DescribeWorkspaces service method, as returned by WorkSpaces.

Exceptions

ExceptionCondition
InvalidParameterValuesException One or more parameter values are not valid.
ResourceUnavailableException The specified resource is not available.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.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

See Also