describe-workspace-directories¶

Description¶

Describes the available directories that are registered with Amazon WorkSpaces.

Synopsis¶

  describe-workspace-directories
[--directory-ids <value>]
[--limit <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options¶

--directory-ids (list)

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

(string)

Syntax:

"string" "string" ...

--limit (integer)

The maximum number of directories to return.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To describe your WorkSpace directories

This example describes all of your WorkSpace directories.

Command:

aws workspaces describe-workspace-directories

Output:

{
  "Directories" : [
    {
      "CustomerUserName" : "Administrator",
      "DirectoryId" : "d-906735683d",
      "DirectoryName" : "example.awsapps.com",
      "SubnetIds" : [
        "subnet-af0e2a87",
        "subnet-657e7a23"
      ],
      "WorkspaceCreationProperties" :
      {
        "EnableInternetAccess" : false,
        "EnableWorkDocs" : false,
        "UserEnabledAsLocalAdministrator" : true
      },
      "Alias" : "example",
      "State" : "REGISTERED",
      "DirectoryType" : "SIMPLE_AD",
      "RegistrationCode" : "SLiad+S393HD",
      "IamRoleId" : "arn:aws:iam::972506530580:role/workspaces_DefaultRole",
      "DnsIpAddresses" : [
        "10.0.2.190",
        "10.0.1.202"
      ],
      "WorkspaceSecurityGroupId" : "sg-6e40640b"
    },
    {
      "CustomerUserName" : "Administrator",
      "DirectoryId" : "d-906732325d",
      "DirectoryName" : "exampledomain.com",
      "SubnetIds" : [
        "subnet-775a6531",
        "subnet-435c036b"
      ],
      "WorkspaceCreationProperties" :
      {
        "EnableInternetAccess" : false,
        "EnableWorkDocs" : true,
        "UserEnabledAsLocalAdministrator" : true
      },
      "Alias" : "example-domain",
      "State" : "REGISTERED",
      "DirectoryType" : "AD_CONNECTOR",
      "RegistrationCode" : "SLiad+UBZGNH",
      "IamRoleId" : "arn:aws:iam::972506530580:role/workspaces_DefaultRole",
      "DnsIpAddresses" : [
        "50.0.2.223",
        "50.0.2.184"
      ]
    }
  ]
}

Output¶

Directories -> (list)

Information about the directories.

(structure)

Describes a directory that is used with Amazon WorkSpaces.

DirectoryId -> (string)

The directory identifier.

Alias -> (string)

The directory alias.

DirectoryName -> (string)

The name of the directory.

RegistrationCode -> (string)

The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.

SubnetIds -> (list)

The identifiers of the subnets used with the directory.

(string)

DnsIpAddresses -> (list)

The IP addresses of the DNS servers for the directory.

(string)

CustomerUserName -> (string)

The user name for the service account.

IamRoleId -> (string)

The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.

DirectoryType -> (string)

The directory type.

WorkspaceSecurityGroupId -> (string)

The identifier of the security group that is assigned to new WorkSpaces.

State -> (string)

The state of the directory’s registration with Amazon WorkSpaces. After a directory is deregistered, the DEREGISTERED state is returned very briefly before the directory metadata is cleaned up, so this state is rarely returned. To confirm that a directory is deregistered, check for the directory ID by using DescribeWorkspaceDirectories . If the directory ID isn’t returned, then the directory has been successfully deregistered.

WorkspaceCreationProperties -> (structure)

The default creation properties for all WorkSpaces in the directory.

EnableWorkDocs -> (boolean)

Specifies whether the directory is enabled for Amazon WorkDocs.

EnableInternetAccess -> (boolean)

Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in this directory by default. If enabled, the Elastic public IP address allows outbound internet access from your WorkSpaces when you’re using an internet gateway in the Amazon VPC in which your WorkSpaces are located. If you’re using a Network Address Translation (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in public subnets and you manually assign them Elastic IP addresses, you should disable this setting. This setting applies to new WorkSpaces that you launch or to existing WorkSpaces that you rebuild. For more information, see Configure a VPC for Amazon WorkSpaces .

DefaultOu -> (string)

The organizational unit (OU) in the directory for the WorkSpace machine accounts.

CustomSecurityGroupId -> (string)

The identifier of the default security group to apply to WorkSpaces when they are created. For more information, see Security Groups for Your WorkSpaces .

UserEnabledAsLocalAdministrator -> (boolean)

Specifies whether WorkSpace users are local administrators on their WorkSpaces.

EnableMaintenanceMode -> (boolean)

Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see WorkSpace Maintenance .

ipGroupIds -> (list)

The identifiers of the IP access control groups associated with the directory.

(string)

WorkspaceAccessProperties -> (structure)

The devices and operating systems that users can use to access WorkSpaces.

DeviceTypeWindows -> (string)

Indicates whether users can use Windows clients to access their WorkSpaces.

DeviceTypeOsx -> (string)

Indicates whether users can use macOS clients to access their WorkSpaces.

DeviceTypeWeb -> (string)

Indicates whether users can access their WorkSpaces through a web browser.

DeviceTypeIos -> (string)

Indicates whether users can use iOS devices to access their WorkSpaces.

DeviceTypeAndroid -> (string)

Indicates whether users can use Android and Android-compatible Chrome OS devices to access their WorkSpaces.

DeviceTypeChromeOs -> (string)

Indicates whether users can use Chromebooks to access their WorkSpaces.

DeviceTypeZeroClient -> (string)

Indicates whether users can use zero client devices to access their WorkSpaces.

DeviceTypeLinux -> (string)

Indicates whether users can use Linux clients to access their WorkSpaces.

Tenancy -> (string)

Specifies whether the directory is dedicated or shared. To use Bring Your Own License (BYOL), this value must be set to DEDICATED . For more information, see Bring Your Own Windows Desktop Images .

SelfservicePermissions -> (structure)

The default self-service permissions for WorkSpaces in the directory.

RestartWorkspace -> (string)

Specifies whether users can restart their WorkSpace.

IncreaseVolumeSize -> (string)

Specifies whether users can increase the volume size of the drives on their WorkSpace.

ChangeComputeType -> (string)

Specifies whether users can change the compute type (bundle) for their WorkSpace.

SwitchRunningMode -> (string)

Specifies whether users can switch the running mode of their WorkSpace.

RebuildWorkspace -> (string)

Specifies whether users can rebuild the operating system of a WorkSpace to its original state.

NextToken -> (string)

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

Table of Contents

Feedback

User Guide