Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1465336243.7 KB

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.

post/#X-Amz-Target=WorkspacesService.DescribeWorkspaces

Query parameters

Limitstring

Pagination limit

NextTokenstring

Pagination token

Headers

X-Amz-Target'WorkspacesService.DescribeWorkspaces' required

Request body

WorkspaceIdsWorkspaceId[]
<p>The identifiers of the WorkSpaces. You cannot combine this parameter with any other filter.</p> <p>Because the <a>CreateWorkspaces</a> operation is asynchronous, the identifier it returns is not immediately available. If you immediately call <a>DescribeWorkspaces</a> with this identifier, no information is returned.</p>
DirectoryIdstring

The identifier of the directory. In addition, you can optionally specify a specific directory user (see <code>UserName</code>). You cannot combine this parameter with any other filter.

UserNamestring

The name of the directory user. You must specify this parameter with <code>DirectoryId</code>.

BundleIdstring

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

Limitinteger

The maximum number of items to return.

NextTokenstring

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

Response

Success

NextTokenstring

The token to use to retrieve the next page of results. This value is null when there are no more results to return.