DescribeWorkspaceDirectories - Amazon WorkSpaces Service


Describes the available directories that are registered with Amazon WorkSpaces.

Request Syntax

{ "DirectoryIds": [ "string" ], "Limit": number, "NextToken": "string" }

Request Parameters

The request accepts the following data in JSON format.


The identifiers of the directories. If the value is null, all directories are retrieved.

Type: Array of strings

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

Length Constraints: Minimum length of 10. Maximum length of 65.

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

Required: No


The maximum number of directories to return.

Type: Integer

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

Required: No


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

Type: String

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

Required: No

Response Syntax

{ "Directories": [ { "Alias": "string", "CertificateBasedAuthProperties": { "CertificateAuthorityArn": "string", "Status": "string" }, "CustomerUserName": "string", "DirectoryId": "string", "DirectoryName": "string", "DirectoryType": "string", "DnsIpAddresses": [ "string" ], "IamRoleId": "string", "ipGroupIds": [ "string" ], "RegistrationCode": "string", "SamlProperties": { "RelayStateParameterName": "string", "Status": "string", "UserAccessUrl": "string" }, "SelfservicePermissions": { "ChangeComputeType": "string", "IncreaseVolumeSize": "string", "RebuildWorkspace": "string", "RestartWorkspace": "string", "SwitchRunningMode": "string" }, "State": "string", "SubnetIds": [ "string" ], "Tenancy": "string", "WorkspaceAccessProperties": { "DeviceTypeAndroid": "string", "DeviceTypeChromeOs": "string", "DeviceTypeIos": "string", "DeviceTypeLinux": "string", "DeviceTypeOsx": "string", "DeviceTypeWeb": "string", "DeviceTypeWindows": "string", "DeviceTypeZeroClient": "string" }, "WorkspaceCreationProperties": { "CustomSecurityGroupId": "string", "DefaultOu": "string", "EnableInternetAccess": boolean, "EnableMaintenanceMode": boolean, "EnableWorkDocs": boolean, "UserEnabledAsLocalAdministrator": boolean }, "WorkspaceSecurityGroupId": "string" } ], "NextToken": "string" }

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.


Information about the directories.

Type: Array of WorkspaceDirectory objects


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

Type: String

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


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


One or more parameter values are not valid.

HTTP Status Code: 400

See Also

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