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. Obtains information about the specified WorkSpaces.
Only one of the filter parameters, such as
WorkspaceIds, can be specified at a time.
This operation supports pagination with the use of the
and response parameters. If more results are available, the
response member contains a token that you pass in the next call to this operation
to retrieve the next set of items.
public class DescribeWorkspacesRequest : AmazonWorkSpacesRequest IAmazonWebServiceRequest
The DescribeWorkspacesRequest type exposes the following members
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.
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
Gets and sets the property Limit.
The maximum number of items to return.
Gets and sets the property NextToken.
Gets and sets the property UserName.
Used with the
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 it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.
Supported in: 1.3
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