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.

Container for the parameters to the DescribeWorkspaces operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.WorkSpaces.AmazonWorkSpacesRequest
      Amazon.WorkSpaces.Model.DescribeWorkspacesRequest

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

Syntax

C#
public class DescribeWorkspacesRequest : AmazonWorkSpacesRequest
         IAmazonWebServiceRequest

The DescribeWorkspacesRequest type exposes the following members

Constructors

NameDescription
Public Method DescribeWorkspacesRequest()

Properties

NameTypeDescription
Public Property BundleId System.String

Gets and sets the property BundleId.

The ID of the bundle. All WorkSpaces that are created from this bundle are retrieved. This parameter cannot be combined with any other filter.

Public Property DirectoryId System.String

Gets and sets the property DirectoryId.

The ID of the directory. In addition, you can optionally specify a specific directory user (see UserName). This parameter cannot be combined with any other filter.

Public Property Limit System.Int32

Gets and sets the property Limit.

The maximum number of items to return.

Public Property NextToken System.String

Gets and sets the property NextToken.

The token for the next set of results. (You received this token from a previous call.)

Public Property UserName System.String

Gets and sets the property UserName.

The name of the directory user. You must specify this parameter with DirectoryId.

Public Property WorkspaceIds System.Collections.Generic.List<System.String>

Gets and sets the property WorkspaceIds.

The IDs of the WorkSpaces. This parameter cannot be combined with any other filter.

Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.

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