AWS SDK Version 2 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.

.NET Framework 3.5
 
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.

Inheritance Hierarchy

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

Namespace: Amazon.WorkSpaces.Model
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public class DescribeWorkspacesRequest : AmazonWorkSpacesRequest
         IRequestEvents

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 a bundle to obtain the WorkSpaces for. All WorkSpaces that are created from this bundle will be retrieved. This parameter cannot be combined with any other filter parameter.

Public Property DirectoryId System.String Gets and sets the property DirectoryId.

Specifies the directory identifier to which to limit the WorkSpaces. Optionally, you can specify a specific directory user with the UserName parameter. This parameter cannot be combined with any other filter parameter.

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 NextToken value from a previous call to this operation. Pass null if this is the first call.

Public Property UserName System.String Gets and sets the property UserName.

Used with the DirectoryId parameter to specify the directory user for which to obtain the WorkSpace.

Public Property WorkspaceIds System.Collections.Generic.List<System.String> Gets and sets the property WorkspaceIds.

An array of strings that contain the identifiers of the WorkSpaces for which to retrieve information. This parameter cannot be combined with any other filter parameter.

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

Version Information

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