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 by using the bundle identifier, directory identifier, 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 identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.

Public Property DirectoryId System.String

Gets and sets the property DirectoryId.

The identifier of the directory. In addition, you can optionally specify a specific directory user (see UserName). You cannot combine this parameter 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.

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

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 identifiers of the WorkSpaces. You cannot combine this parameter 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.

Public Property WorkspaceName System.String

Gets and sets the property WorkspaceName.

The name of the user-decoupled WorkSpace.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5