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

DescribeWorkspaceDirectories

Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.

Request Syntax

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

Request Parameters

The request accepts the following data in JSON format.

DirectoryIds

An array of strings that contains the directory identifiers to retrieve information for. If this member is null, all directories are retrieved.

Type: Array of strings

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

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

Required: No

NextToken

The NextToken value from a previous call to this operation. Pass null if this is the first call.

Type: String

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

Required: No

Response Syntax

{
   "Directories": [ 
      { 
         "Alias": "string",
         "CustomerUserName": "string",
         "DirectoryId": "string",
         "DirectoryName": "string",
         "DirectoryType": "string",
         "DnsIpAddresses": [ "string" ],
         "IamRoleId": "string",
         "RegistrationCode": "string",
         "State": "string",
         "SubnetIds": [ "string" ],
         "WorkspaceCreationProperties": { 
            "CustomSecurityGroupId": "string",
            "DefaultOu": "string",
            "EnableInternetAccess": 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.

Directories

An array of structures that contain information about the directories.

Type: Array of WorkspaceDirectory objects

NextToken

If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to this operation to retrieve the next set of items. 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.

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

See Also

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