Menu
Amazon WorkSpaces Service
API Reference (API Version 2015-04-08)

DescribeWorkspaces

Describes the specified WorkSpaces.

You can filter the results using bundle ID, directory ID, or owner, but you can specify only one filter at a time.

Request Syntax

{ "BundleId": "string", "DirectoryId": "string", "Limit": number, "NextToken": "string", "UserName": "string", "WorkspaceIds": [ "string" ] }

Request Parameters

The request accepts the following data in JSON format.

BundleId

The ID of the bundle. All WorkSpaces that are created from this bundle are retrieved. This parameter cannot be combined with any other filter.

Type: String

Pattern: ^wsb-[0-9a-z]{8,63}$

Required: No

DirectoryId

The ID of the directory. In addition, you can optionally specify a specific directory user (see UserName). This parameter cannot be combined with any other filter.

Type: String

Pattern: ^d-[0-9a-f]{8,63}$

Required: No

Limit

The maximum number of items to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 25.

Required: No

NextToken

The token for the next set of results. (You received this token from a previous call.)

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Required: No

UserName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Required: No

WorkspaceIds

The IDs of the WorkSpaces. This parameter cannot be combined 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.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Pattern: ^ws-[0-9a-z]{8,63}$

Required: No

Response Syntax

{ "NextToken": "string", "Workspaces": [ { "BundleId": "string", "ComputerName": "string", "DirectoryId": "string", "ErrorCode": "string", "ErrorMessage": "string", "IpAddress": "string", "ModificationStates": [ { "Resource": "string", "State": "string" } ], "RootVolumeEncryptionEnabled": boolean, "State": "string", "SubnetId": "string", "UserName": "string", "UserVolumeEncryptionEnabled": boolean, "VolumeEncryptionKey": "string", "WorkspaceId": "string", "WorkspaceProperties": { "ComputeTypeName": "string", "RootVolumeSizeGib": number, "RunningMode": "string", "RunningModeAutoStopTimeoutInMinutes": number, "UserVolumeSizeGib": number } } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

The token to use to retrieve the next set of results, or null if there are no more results available. This token is valid for one day and must be used within that time frame.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Workspaces

Information about the WorkSpaces.

Because CreateWorkspaces is an asynchronous operation, some of the returned information could be incomplete.

Type: Array of Workspace objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400

ResourceUnavailableException

The specified resource is not available.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: