Describe Workspace Directories

workspaces_describe_workspace_directories

R Documentation

Describes the available directories that are registered with Amazon WorkSpaces

Description

Describes the available directories that are registered with Amazon WorkSpaces.

Usage

workspaces_describe_workspace_directories(DirectoryIds,
  WorkspaceDirectoryNames, Limit, NextToken, Filters)

Arguments

DirectoryIds	The identifiers of the directories. If the value is null, all directories are retrieved.
WorkspaceDirectoryNames	The names of the WorkSpace directories.
Limit	The maximum number of directories to return.
NextToken	If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
Filters	The filter condition for the WorkSpaces.

Value

A list with the following syntax:

list(
  Directories = list(
    list(
      DirectoryId = "string",
      Alias = "string",
      DirectoryName = "string",
      RegistrationCode = "string",
      SubnetIds = list(
        "string"
      ),
      DnsIpAddresses = list(
        "string"
      ),
      CustomerUserName = "string",
      IamRoleId = "string",
      DirectoryType = "SIMPLE_AD"|"AD_CONNECTOR"|"CUSTOMER_MANAGED"|"AWS_IAM_IDENTITY_CENTER",
      WorkspaceSecurityGroupId = "string",
      State = "REGISTERING"|"REGISTERED"|"DEREGISTERING"|"DEREGISTERED"|"ERROR",
      WorkspaceCreationProperties = list(
        EnableWorkDocs = TRUE|FALSE,
        EnableInternetAccess = TRUE|FALSE,
        DefaultOu = "string",
        CustomSecurityGroupId = "string",
        UserEnabledAsLocalAdministrator = TRUE|FALSE,
        EnableMaintenanceMode = TRUE|FALSE,
        InstanceIamRoleArn = "string"
      ),
      ipGroupIds = list(
        "string"
      ),
      WorkspaceAccessProperties = list(
        DeviceTypeWindows = "ALLOW"|"DENY",
        DeviceTypeOsx = "ALLOW"|"DENY",
        DeviceTypeWeb = "ALLOW"|"DENY",
        DeviceTypeIos = "ALLOW"|"DENY",
        DeviceTypeAndroid = "ALLOW"|"DENY",
        DeviceTypeChromeOs = "ALLOW"|"DENY",
        DeviceTypeZeroClient = "ALLOW"|"DENY",
        DeviceTypeLinux = "ALLOW"|"DENY"
      ),
      Tenancy = "DEDICATED"|"SHARED",
      SelfservicePermissions = list(
        RestartWorkspace = "ENABLED"|"DISABLED",
        IncreaseVolumeSize = "ENABLED"|"DISABLED",
        ChangeComputeType = "ENABLED"|"DISABLED",
        SwitchRunningMode = "ENABLED"|"DISABLED",
        RebuildWorkspace = "ENABLED"|"DISABLED"
      ),
      SamlProperties = list(
        Status = "DISABLED"|"ENABLED"|"ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK",
        UserAccessUrl = "string",
        RelayStateParameterName = "string"
      ),
      CertificateBasedAuthProperties = list(
        Status = "DISABLED"|"ENABLED",
        CertificateAuthorityArn = "string"
      ),
      MicrosoftEntraConfig = list(
        TenantId = "string",
        ApplicationConfigSecretArn = "string"
      ),
      WorkspaceDirectoryName = "string",
      WorkspaceDirectoryDescription = "string",
      UserIdentityType = "CUSTOMER_MANAGED"|"AWS_DIRECTORY_SERVICE"|"AWS_IAM_IDENTITY_CENTER",
      WorkspaceType = "PERSONAL"|"POOLS",
      IDCConfig = list(
        InstanceArn = "string",
        ApplicationArn = "string"
      ),
      ActiveDirectoryConfig = list(
        DomainName = "string",
        ServiceAccountSecretArn = "string"
      ),
      StreamingProperties = list(
        StreamingExperiencePreferredProtocol = "TCP"|"UDP",
        UserSettings = list(
          list(
            Action = "CLIPBOARD_COPY_FROM_LOCAL_DEVICE"|"CLIPBOARD_COPY_TO_LOCAL_DEVICE"|"PRINTING_TO_LOCAL_DEVICE"|"SMART_CARD",
            Permission = "ENABLED"|"DISABLED",
            MaximumLength = 123
          )
        ),
        StorageConnectors = list(
          list(
            ConnectorType = "HOME_FOLDER",
            Status = "ENABLED"|"DISABLED"
          )
        ),
        GlobalAccelerator = list(
          Mode = "ENABLED_AUTO"|"DISABLED",
          PreferredProtocol = "TCP"|"NONE"
        )
      ),
      ErrorMessage = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_workspace_directories(
  DirectoryIds = list(
    "string"
  ),
  WorkspaceDirectoryNames = list(
    "string"
  ),
  Limit = 123,
  NextToken = "string",
  Filters = list(
    list(
      Name = "USER_IDENTITY_TYPE"|"WORKSPACE_TYPE",
      Values = list(
        "string"
      )
    )
  )
)