| Column Name | Column Data Type |
|---|
directory_ids Input Column
The identifiers of the directories. If the value is null, all directories are retrieved. | VARCHAR[] |
Show child fields- directory_ids[]
|
limit Input Column
The maximum number of directories to return. | BIGINT |
workspace_directory_names Input Column
The names of the WorkSpace directories. | VARCHAR[] |
Show child fields- workspace_directory_names[]
|
_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
Show child fields- _aws_profile.account_id
The AWS account id - _aws_profile.assumed_role_arn
The ARN of the assumed role - _aws_profile.name
The unique name of the profile. - _aws_profile.organization
Information about this profile's membership in the AWS organization. Show child fields- _aws_profile.organization.account_name
The name of account speciifed by the organization - _aws_profile.organization.id
The organization id - _aws_profile.organization.master_account
Show child fields- _aws_profile.organization.master_account.email
The organization master account email address - _aws_profile.organization.master_account.id
The organization master account id
- _aws_profile.organization.parents[]
Show child fields- _aws_profile.organization.parents[].id
The id of the parent - _aws_profile.organization.parents[].name
The name of the parent - _aws_profile.organization.parents[].tags[]
Show child fields- _aws_profile.organization.parents[].tags[].key
- _aws_profile.organization.parents[].tags[].value
- _aws_profile.organization.parents[].type
The type of parent can be an organization unit or a root
- _aws_profile.organization.tags[]
Show child fields- _aws_profile.organization.tags[].key
- _aws_profile.organization.tags[].value
- _aws_profile.type
The type of profile, either 'credentials' or 'assumed_role' - _aws_profile.via_profile_name
This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
|
_aws_region Input Column
The AWS region to use. | VARCHAR |
active_directory_config
Information about the Active Directory config. | STRUCT(
"domain_name" VARCHAR,
"service_account_secret_arn" VARCHAR
) |
Show child fields- active_directory_config.domain_name
The name of the domain. - active_directory_config.service_account_secret_arn
Indicates the secret ARN on the service account.
|
alias
The directory alias. | VARCHAR |
certificate_based_auth_properties
The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login. | STRUCT(
"status" VARCHAR,
"certificate_authority_arn" VARCHAR
) |
Show child fields- certificate_based_auth_properties.certificate_authority_arn
The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager Private CA resource. - certificate_based_auth_properties.status
The status of the certificate-based authentication properties.
|
customer_user_name
The user name for the service account. | VARCHAR |
directory_id
The directory identifier. | VARCHAR |
directory_name
The name of the directory. | VARCHAR |
directory_type
The directory type. | VARCHAR |
dns_ip_addresses
The IP addresses of the DNS servers for the directory. | VARCHAR[] |
Show child fields- dns_ip_addresses[]
|
error_message
The error message returned. | VARCHAR |
iam_role_id
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. | VARCHAR |
ip_group_ids
The identifiers of the IP access control groups associated with the directory. | VARCHAR[] |
Show child fields- ip_group_ids[]
|
registration_code
The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory. | VARCHAR |
saml_properties
Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider. | STRUCT(
"status" VARCHAR,
"user_access_url" VARCHAR,
"relay_state_parameter_name" VARCHAR
) |
Show child fields- saml_properties.relay_state_parameter_name
The relay state parameter name supported by the SAML 2.0 identity provider (IdP). When the end user is redirected to the user access URL from the WorkSpaces client application, this relay state parameter name is appended as a query parameter to the URL along with the relay state endpoint to return the user to the client application session. To use SAML 2.0 authentication with WorkSpaces, the IdP must support IdP-initiated deep linking for the relay state URL. Consult your IdP documentation for more information. - saml_properties.status
Indicates the status of SAML 2.0 authentication. These statuses include the following. -
If the setting is DISABLED, end users will be directed to login with their directory credentials. -
If the setting is ENABLED, end users will be directed to login via the user access URL. Users attempting to connect to WorkSpaces from a client application that does not support SAML 2.0 authentication will not be able to connect. -
If the setting is ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK, end users will be directed to login via the user access URL on supported client applications, but will not prevent clients that do not support SAML 2.0 authentication from connecting as if SAML 2.0 authentication was disabled. - saml_properties.user_access_url
The SAML 2.0 identity provider (IdP) user access URL is the URL a user would navigate to in their web browser in order to federate from the IdP and directly access the application, without any SAML 2.0 service provider (SP) bindings.
|
selfservice_permissions
The default self-service permissions for WorkSpaces in the directory. | STRUCT(
"restart_workspace" VARCHAR,
"increase_volume_size" VARCHAR,
"change_compute_type" VARCHAR,
"switch_running_mode" VARCHAR,
"rebuild_workspace" VARCHAR
) |
Show child fields- selfservice_permissions.change_compute_type
Specifies whether users can change the compute type (bundle) for their WorkSpace. - selfservice_permissions.increase_volume_size
Specifies whether users can increase the volume size of the drives on their WorkSpace. - selfservice_permissions.rebuild_workspace
Specifies whether users can rebuild the operating system of a WorkSpace to its original state. - selfservice_permissions.restart_workspace
Specifies whether users can restart their WorkSpace. - selfservice_permissions.switch_running_mode
Specifies whether users can switch the running mode of their WorkSpace.
|
state
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. | VARCHAR |
streaming_properties
The streaming properties to configure. | STRUCT(
"streaming_experience_preferred_protocol" VARCHAR,
"user_settings" STRUCT(
"action" VARCHAR,
"permission" VARCHAR,
"maximum_length" BIGINT
)[],
"storage_connectors" STRUCT(
"connector_type" VARCHAR,
"status" VARCHAR
)[]
) |
Show child fields- streaming_properties.storage_connectors[]
Show child fields- streaming_properties.storage_connectors[].connector_type
The type of connector used to save user files. - streaming_properties.storage_connectors[].status
Indicates if the storage connetor is enabled or disabled.
- streaming_properties.streaming_experience_preferred_protocol
Indicates the type of preferred protocol for the streaming experience. - streaming_properties.user_settings[]
Show child fields- streaming_properties.user_settings[].action
Indicates the type of action. - streaming_properties.user_settings[].maximum_length
Indicates the maximum character length for the specified user setting. - streaming_properties.user_settings[].permission
Indicates if the setting is enabled or disabled.
|
subnet_ids
The identifiers of the subnets used with the directory. | VARCHAR[] |
Show child fields- subnet_ids[]
|
tenancy
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. | VARCHAR |
user_identity_type
Indicates the identity type of the specifired user. | VARCHAR |
workspace_access_properties
The devices and operating systems that users can use to access WorkSpaces. | STRUCT(
"device_type_windows" VARCHAR,
"device_type_osx" VARCHAR,
"device_type_web" VARCHAR,
"device_type_ios" VARCHAR,
"device_type_android" VARCHAR,
"device_type_chrome_os" VARCHAR,
"device_type_zero_client" VARCHAR,
"device_type_linux" VARCHAR
) |
Show child fields- workspace_access_properties.device_type_android
Indicates whether users can use Android and Android-compatible Chrome OS devices to access their WorkSpaces. - workspace_access_properties.device_type_chrome_os
Indicates whether users can use Chromebooks to access their WorkSpaces. - workspace_access_properties.device_type_ios
Indicates whether users can use iOS devices to access their WorkSpaces. - workspace_access_properties.device_type_linux
Indicates whether users can use Linux clients to access their WorkSpaces. - workspace_access_properties.device_type_osx
Indicates whether users can use macOS clients to access their WorkSpaces. - workspace_access_properties.device_type_web
Indicates whether users can access their WorkSpaces through a web browser. - workspace_access_properties.device_type_windows
Indicates whether users can use Windows clients to access their WorkSpaces. - workspace_access_properties.device_type_zero_client
Indicates whether users can use zero client devices to access their WorkSpaces.
|
workspace_creation_properties
The default creation properties for all WorkSpaces in the directory. | STRUCT(
"enable_work_docs" BOOLEAN,
"enable_internet_access" BOOLEAN,
"default_ou" VARCHAR,
"custom_security_group_id" VARCHAR,
"user_enabled_as_local_administrator" BOOLEAN,
"enable_maintenance_mode" BOOLEAN,
"instance_iam_role_arn" VARCHAR
) |
Show child fields- workspace_creation_properties.custom_security_group_id
The identifier of the default security group to apply to WorkSpaces when they are created. For more information, see Security Groups for Your WorkSpaces. - workspace_creation_properties.default_ou
The organizational unit (OU) in the directory for the WorkSpace machine accounts. - workspace_creation_properties.enable_internet_access
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. - workspace_creation_properties.enable_maintenance_mode
Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see WorkSpace Maintenance. - workspace_creation_properties.enable_work_docs
Specifies whether the directory is enabled for Amazon WorkDocs. - workspace_creation_properties.instance_iam_role_arn
Indicates the IAM role ARN of the instance. - workspace_creation_properties.user_enabled_as_local_administrator
Specifies whether WorkSpace users are local administrators on their WorkSpaces.
|
workspace_directory_description
The description of the WorkSpace directory | VARCHAR |
workspace_directory_name
The name fo the WorkSpace directory. | VARCHAR |
workspace_security_group_id
The identifier of the security group that is assigned to new WorkSpaces. | VARCHAR |
workspace_type
Indicates whether the directory's WorkSpace type is personal or pools. | VARCHAR |