Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeWorkspaceDirectories

Describes the available directories that are registered with Amazon WorkSpaces.

Request Syntax


{
   "DirectoryIds": [ "string" ],
   "Filters": [ 
      { 
         "Name": "string",
         "Values": [ "string" ]
      }
   ],
   "Limit": number,
   "NextToken": "string",
   "WorkspaceDirectoryNames": [ "string" ]
}

Request Parameters

The request accepts the following data in JSON format.

DirectoryIds

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}$)|(wsd-[0-9a-z]{8,63}$)

Required: No

Filters

The filter condition for the WorkSpaces.

Type: Array of DescribeWorkspaceDirectoriesFilter objects

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

Required: No

Limit

The maximum number of directories to return.

Type: Integer

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

Required: No

NextToken

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

WorkspaceDirectoryNames

The names of the WorkSpace directories.

Type: Array of strings

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

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.\s-]{1,64}$

Required: No

Response Syntax


{
   "Directories": [ 
      { 
         "ActiveDirectoryConfig": { 
            "DomainName": "string",
            "ServiceAccountSecretArn": "string"
         },
         "Alias": "string",
         "CertificateBasedAuthProperties": { 
            "CertificateAuthorityArn": "string",
            "Status": "string"
         },
         "CustomerUserName": "string",
         "DirectoryId": "string",
         "DirectoryName": "string",
         "DirectoryType": "string",
         "DnsIpAddresses": [ "string" ],
         "EndpointEncryptionMode": "string",
         "ErrorMessage": "string",
         "IamRoleId": "string",
         "IDCConfig": { 
            "ApplicationArn": "string",
            "InstanceArn": "string"
         },
         "ipGroupIds": [ "string" ],
         "MicrosoftEntraConfig": { 
            "ApplicationConfigSecretArn": "string",
            "TenantId": "string"
         },
         "RegistrationCode": "string",
         "SamlProperties": { 
            "RelayStateParameterName": "string",
            "Status": "string",
            "UserAccessUrl": "string"
         },
         "SelfservicePermissions": { 
            "ChangeComputeType": "string",
            "IncreaseVolumeSize": "string",
            "RebuildWorkspace": "string",
            "RestartWorkspace": "string",
            "SwitchRunningMode": "string"
         },
         "State": "string",
         "StreamingProperties": { 
            "GlobalAccelerator": { 
               "Mode": "string",
               "PreferredProtocol": "string"
            },
            "StorageConnectors": [ 
               { 
                  "ConnectorType": "string",
                  "Status": "string"
               }
            ],
            "StreamingExperiencePreferredProtocol": "string",
            "UserSettings": [ 
               { 
                  "Action": "string",
                  "MaximumLength": number,
                  "Permission": "string"
               }
            ]
         },
         "SubnetIds": [ "string" ],
         "Tenancy": "string",
         "UserIdentityType": "string",
         "WorkspaceAccessProperties": { 
            "AccessEndpointConfig": { 
               "AccessEndpoints": [ 
                  { 
                     "AccessEndpointType": "string",
                     "VpcEndpointId": "string"
                  }
               ],
               "InternetFallbackProtocols": [ "string" ]
            },
            "DeviceTypeAndroid": "string",
            "DeviceTypeChromeOs": "string",
            "DeviceTypeIos": "string",
            "DeviceTypeLinux": "string",
            "DeviceTypeOsx": "string",
            "DeviceTypeWeb": "string",
            "DeviceTypeWindows": "string",
            "DeviceTypeWorkSpacesThinClient": "string",
            "DeviceTypeZeroClient": "string"
         },
         "WorkspaceCreationProperties": { 
            "CustomSecurityGroupId": "string",
            "DefaultOu": "string",
            "EnableInternetAccess": boolean,
            "EnableMaintenanceMode": boolean,
            "InstanceIamRoleArn": "string",
            "UserEnabledAsLocalAdministrator": boolean
         },
         "WorkspaceDirectoryDescription": "string",
         "WorkspaceDirectoryName": "string",
         "WorkspaceSecurityGroupId": "string",
         "WorkspaceType": "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

Information about the directories.

Type: Array of WorkspaceDirectory objects

NextToken

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.

Errors

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

InvalidParameterValuesException

One or more parameter values are not valid.

message: The exception error message.

HTTP Status Code: 400