DescribeWorkspacesRequest

import type { DescribeWorkspacesRequest } from "https://aws-api.deno.dev/v0.4/services/workspaces.ts?docs=full";

interface DescribeWorkspacesRequest {

BundleId?: string | null;

DirectoryId?: string | null;

Limit?: number | null;

NextToken?: string | null;

UserName?: string | null;

WorkspaceIds?: string[] | null;

}

§Properties

BundleId?: string | null

[src]

The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.

DirectoryId?: string | null

[src]

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.

Limit?: number | null

[src]

The maximum number of items to return.

NextToken?: string | null

[src]

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

UserName?: string | null

[src]

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

WorkspaceIds?: string[] | null

[src]

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.