String modificationState
The state of the modification to the configuration of BYOL.
String dedicatedTenancySupport
The status of BYOL (whether BYOL is being enabled or disabled).
String dedicatedTenancyManagementCidrRange
The IP address range, specified as an IPv4 CIDR block, for the management network interface used for the account.
Date startTime
The timestamp when the modification of the BYOL configuration was started.
String errorCode
The error code that is returned if the configuration of BYOL cannot be modified.
String errorMessage
The text of the error message that is returned if the configuration of BYOL cannot be modified.
String connectionIdentifier
The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you're configuring your DNS routing policies.
String directoryId
The identifier of the directory.
SdkInternalList<T> groupIds
The identifiers of one or more IP access control groups.
String groupId
The identifier of the group.
SdkInternalList<T> userRules
The rules to add to the group.
String reconnectEnabled
Specifies whether users can cache their credentials on the Amazon WorkSpaces client. When enabled, users can choose to reconnect to their WorkSpaces without re-entering their credentials.
String logUploadEnabled
Specifies whether users can upload diagnostic log files of Amazon WorkSpaces client directly to WorkSpaces to troubleshoot issues when using the WorkSpaces client. When enabled, the log files will be sent to WorkSpaces automatically and will be applied to all users in the specified directory.
String resourceId
The resource identifier, in the form of a directory ID.
ClientProperties clientProperties
Information about the Amazon WorkSpaces client.
String name
The compute type.
String connectionString
The connection string specified for the connection alias. The connection string must be in the form of a fully
qualified domain name (FQDN), such as www.example.com
.
String aliasId
The identifier of the connection alias.
String state
The current state of the connection alias.
String ownerAccountId
The identifier of the Amazon Web Services account that owns the connection alias.
SdkInternalList<T> associations
The association status of the connection alias.
String associationStatus
The association status of the connection alias.
String associatedAccountId
The identifier of the Amazon Web Services account that associated the connection alias with a directory.
String resourceId
The identifier of the directory associated with a connection alias.
String connectionIdentifier
The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you're configuring your DNS routing policies.
String imageId
The identifier of the image.
String addInId
The client add-in identifier.
String connectionString
A connection string in the form of a fully qualified domain name (FQDN), such as www.example.com
.
After you create a connection string, it is always associated to your Amazon Web Services account. You cannot recreate the same connection string with a different account, even if you delete all instances of it from the original account. The connection string is globally reserved for your account.
SdkInternalList<T> tags
The tags to associate with the connection alias.
String aliasId
The identifier of the connection alias.
String groupName
The name of the group.
String groupDesc
The description of the group.
SdkInternalList<T> userRules
The rules to add to the group.
SdkInternalList<T> tags
The tags. Each WorkSpaces resource can have a maximum of 50 tags.
String groupId
The identifier of the group.
String primaryRegion
The Region of the primary WorkSpace.
SdkInternalList<T> standbyWorkspaces
Information about the standby WorkSpace to be created.
SdkInternalList<T> failedStandbyRequests
Information about the standby WorkSpace that could not be created.
SdkInternalList<T> pendingStandbyRequests
Information about the standby WorkSpace that was created.
String resourceId
The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.
SdkInternalList<T> tags
The tags. Each WorkSpaces resource can have a maximum of 50 tags.
String name
The name of the new updated WorkSpace image.
String description
A description of whether updates for the WorkSpace image are available.
String sourceImageId
The identifier of the source WorkSpace image.
SdkInternalList<T> tags
The tags that you want to add to the new updated WorkSpace image.
To add tags at the same time when you're creating the updated image, you must create an IAM policy that grants
your IAM user permissions to use workspaces:CreateTags
.
String imageId
The identifier of the new updated WorkSpace image.
String bundleName
The name of the bundle.
String bundleDescription
The description of the bundle.
String imageId
The identifier of the image that is used to create the bundle.
ComputeType computeType
UserStorage userStorage
RootStorage rootStorage
SdkInternalList<T> tags
The tags associated with the bundle.
To add tags at the same time when you're creating the bundle, you must create an IAM policy that grants your IAM
user permissions to use workspaces:CreateTags
.
WorkspaceBundle workspaceBundle
String name
The name of the new WorkSpace image.
String description
The description of the new WorkSpace image.
String workspaceId
The identifier of the source WorkSpace
SdkInternalList<T> tags
The tags that you want to add to the new WorkSpace image. To add tags when you're creating the image, you must
create an IAM policy that grants your IAM user permission to use workspaces:CreateTags
.
String imageId
The identifier of the new WorkSpace image.
String name
The name of the image.
String description
The description of the image.
OperatingSystem operatingSystem
The operating system that the image is running.
String state
The availability status of the image.
String requiredTenancy
Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images..
Date created
The date when the image was created.
String ownerAccountId
The identifier of the Amazon Web Services account that owns the image.
SdkInternalList<T> workspaces
The WorkSpaces to create. You can specify up to 25 WorkSpaces.
SdkInternalList<T> failedRequests
Information about the WorkSpaces that could not be created.
SdkInternalList<T> pendingRequests
Information about the WorkSpaces that were created.
Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned can be incomplete.
String logoUrl
The logo. The only image format accepted is a binary data object that is converted from a .png
file.
String supportEmail
The support email. The company's customer support email address.
In each platform type, the SupportEmail
and SupportLink
parameters are mutually
exclusive. You can specify one parameter for each platform type, but not both.
The default email is [email protected]
.
String supportLink
The support link. The link for the company's customer support page for their WorkSpace.
In each platform type, the SupportEmail
and SupportLink
parameters are mutually
exclusive.You can specify one parameter for each platform type, but not both.
The default support link is [email protected]
.
String forgotPasswordLink
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
Map<K,V> loginMessage
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized
message for that locale. The only key supported is en_US
. The HTML tags supported include the
following:
a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul
.
ByteBuffer logo
The logo. The only image format accepted is a binary data object that is converted from a .png
file.
String supportEmail
The support email. The company's customer support email address.
In each platform type, the SupportEmail
and SupportLink
parameters are mutually
exclusive. You can specify one parameter for each platform type, but not both.
The default email is [email protected]
.
String supportLink
The support link. The link for the company's customer support page for their WorkSpace.
In each platform type, the SupportEmail
and SupportLink
parameters are mutually
exclusive. You can specify one parameter for each platform type, but not both.
The default support link is [email protected]
.
String forgotPasswordLink
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
Map<K,V> loginMessage
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized
message for that locale. The only key supported is en_US
. The HTML tags supported include the
following:
a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul
.
Boolean enableWorkDocs
Specifies whether the directory is enabled for Amazon WorkDocs.
Boolean enableInternetAccess
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.
String defaultOu
The organizational unit (OU) in the directory for the WorkSpace machine accounts.
String customSecurityGroupId
The identifier of the default security group to apply to WorkSpaces when they are created. For more information, see Security Groups for Your WorkSpaces.
Boolean userEnabledAsLocalAdministrator
Specifies whether WorkSpace users are local administrators on their WorkSpaces.
Boolean enableMaintenanceMode
Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see WorkSpace Maintenance.
String resourceId
The directory identifier of the WorkSpace for which you want to delete client branding.
SdkInternalList<T> platforms
The device type for which you want to delete client branding.
String aliasId
The identifier of the connection alias to delete.
String groupId
The identifier of the IP access control group.
String resourceId
The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.
SdkInternalList<T> tagKeys
The tag keys.
String bundleId
The identifier of the bundle.
String imageId
The identifier of the image.
String directoryId
The identifier of the directory. If any WorkSpaces are registered to this directory, you must remove them before you deregister the directory, or you will receive an OperationNotSupportedException error.
String nextToken
If you received a NextToken
from a previous call that was paginated, provide this token to receive
the next set of results.
SdkInternalList<T> accountModifications
The list of modifications to the configuration of BYOL.
String nextToken
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
String dedicatedTenancySupport
The status of BYOL (whether BYOL is enabled or disabled).
String dedicatedTenancyManagementCidrRange
The IP address range, specified as an IPv4 CIDR block, used for the management network interface.
The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.
String resourceId
The directory identifier of the WorkSpace for which you want to view client branding information.
DefaultClientBrandingAttributes deviceTypeWindows
The branding information for Windows devices.
DefaultClientBrandingAttributes deviceTypeOsx
The branding information for macOS devices.
DefaultClientBrandingAttributes deviceTypeAndroid
The branding information for Android devices.
IosClientBrandingAttributes deviceTypeIos
The branding information for iOS devices.
DefaultClientBrandingAttributes deviceTypeLinux
The branding information for Linux devices.
DefaultClientBrandingAttributes deviceTypeWeb
The branding information for Web access.
SdkInternalList<T> resourceIds
The resource identifier, in the form of directory IDs.
SdkInternalList<T> clientPropertiesList
Information about the specified Amazon WorkSpaces clients.
String resourceId
The directory identifier for which the client add-in is configured.
String nextToken
If you received a NextToken
from a previous call that was paginated, provide this token to receive
the next set of results.
Integer maxResults
The maximum number of items to return.
SdkInternalList<T> addIns
Information about client add-ins.
String nextToken
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
SdkInternalList<T> aliasIds
The identifiers of the connection aliases to describe.
String resourceId
The identifier of the directory associated with the connection alias.
Integer limit
The maximum number of connection aliases to return.
String nextToken
If you received a NextToken
from a previous call that was paginated, provide this token to receive
the next set of results.
SdkInternalList<T> connectionAliases
Information about the specified connection aliases.
String nextToken
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
String aliasId
The identifier of the connection alias.
SdkInternalList<T> connectionAliasPermissions
The permissions associated with a connection alias.
String nextToken
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
SdkInternalList<T> groupIds
The identifiers of one or more IP access control groups.
String nextToken
If you received a NextToken
from a previous call that was paginated, provide this token to receive
the next set of results.
Integer maxResults
The maximum number of items to return.
SdkInternalList<T> result
Information about the IP access control groups.
String nextToken
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
String resourceId
The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.
SdkInternalList<T> tagList
The tags.
SdkInternalList<T> bundleIds
The identifiers of the bundles. You cannot combine this parameter with any other filter.
String owner
The owner of the bundles. You cannot combine this parameter with any other filter.
To describe the bundles provided by Amazon Web Services, specify AMAZON
. To describe the bundles
that belong to your account, don't specify a value.
String nextToken
The token for the next set of results. (You received this token from a previous call.)
SdkInternalList<T> bundles
Information about the bundles.
String nextToken
The token to use to retrieve the next page of results. This value is null when there are no more results to return. This token is valid for one day and must be used within that time frame.
SdkInternalList<T> directoryIds
The identifiers of the directories. If the value is null, all directories are retrieved.
Integer limit
The maximum number of directories to return.
String nextToken
If you received a NextToken
from a previous call that was paginated, provide this token to receive
the next set of results.
SdkInternalList<T> directories
Information about the directories.
String nextToken
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
String imageId
The identifier of the image.
SdkInternalList<T> imagePermissions
The identifiers of the Amazon Web Services accounts that the image has been shared with.
String nextToken
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
SdkInternalList<T> imageIds
The identifier of the image.
String imageType
The type (owned or shared) of the image.
String nextToken
If you received a NextToken
from a previous call that was paginated, provide this token to receive
the next set of results.
Integer maxResults
The maximum number of items to return.
SdkInternalList<T> images
Information about the images.
String nextToken
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
SdkInternalList<T> workspaceIds
The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.
String nextToken
If you received a NextToken
from a previous call that was paginated, provide this token to receive
the next set of results.
SdkInternalList<T> workspacesConnectionStatus
Information about the connection status of the WorkSpace.
String nextToken
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
String workspaceId
The identifier of the WorkSpace.
SdkInternalList<T> rebuildSnapshots
Information about the snapshots that can be used to rebuild a WorkSpace. These snapshots include the user volume.
SdkInternalList<T> restoreSnapshots
Information about the snapshots that can be used to restore a WorkSpace. These snapshots include both the root volume and the user volume.
SdkInternalList<T> workspaceIds
The identifiers of the WorkSpaces. You cannot combine this parameter with any other filter.
Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.
String directoryId
The identifier of the directory. In addition, you can optionally specify a specific directory user (see
UserName
). You cannot combine this parameter with any other filter.
String userName
The name of the directory user. You must specify this parameter with DirectoryId
.
String bundleId
The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.
Integer limit
The maximum number of items to return.
String nextToken
If you received a NextToken
from a previous call that was paginated, provide this token to receive
the next set of results.
SdkInternalList<T> workspaces
Information about the WorkSpaces.
Because CreateWorkspaces is an asynchronous operation, some of the returned information could be incomplete.
String nextToken
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
String aliasId
The identifier of the connection alias to disassociate.
String directoryId
The identifier of the directory.
SdkInternalList<T> groupIds
The identifiers of one or more IP access control groups.
StandbyWorkspace standbyWorkspaceRequest
Information about the standby WorkSpace that could not be created.
String errorCode
The error code that is returned if the standby WorkSpace could not be created.
String errorMessage
The text of the error message that is returned if the standby WorkSpace could not be created.
WorkspaceRequest workspaceRequest
Information about the WorkSpace.
String errorCode
The error code that is returned if the WorkSpace cannot be created.
String errorMessage
The text of the error message that is returned if the WorkSpace cannot be created.
String sharedAccountId
The identifier of the Amazon Web Services account that an image has been shared with.
String resourceId
The directory identifier of the WorkSpace for which you want to import client branding.
DefaultImportClientBrandingAttributes deviceTypeWindows
The branding information to import for Windows devices.
DefaultImportClientBrandingAttributes deviceTypeOsx
The branding information to import for macOS devices.
DefaultImportClientBrandingAttributes deviceTypeAndroid
The branding information to import for Android devices.
IosImportClientBrandingAttributes deviceTypeIos
The branding information to import for iOS devices.
DefaultImportClientBrandingAttributes deviceTypeLinux
The branding information to import for Linux devices.
DefaultImportClientBrandingAttributes deviceTypeWeb
The branding information to import for web access.
DefaultClientBrandingAttributes deviceTypeWindows
The branding information configured for Windows devices.
DefaultClientBrandingAttributes deviceTypeOsx
The branding information configured for macOS devices.
DefaultClientBrandingAttributes deviceTypeAndroid
The branding information configured for Android devices.
IosClientBrandingAttributes deviceTypeIos
The branding information configured for iOS devices.
DefaultClientBrandingAttributes deviceTypeLinux
The branding information configured for Linux devices.
DefaultClientBrandingAttributes deviceTypeWeb
The branding information configured for web access.
String ec2ImageId
The identifier of the EC2 image.
String ingestionProcess
The ingestion process to be used when importing the image, depending on which protocol you want to use for your
BYOL Workspace image, either PCoIP, WorkSpaces Streaming Protocol (WSP), or bring your own protocol (BYOP). To
use WSP, specify a value that ends in _WSP
. To use PCoIP, specify a value that does not end in
_WSP
. To use BYOP, specify a value that ends in _BYOP
.
For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify BYOL_REGULAR
,
BYOL_REGULAR_WSP
, or BYOL_REGULAR_BYOP
, depending on the protocol.
The BYOL_REGULAR_BYOP
and BYOL_GRAPHICS_G4DN_BYOP
values are only supported by Amazon
WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see Amazon WorkSpaces Core.
String imageName
The name of the WorkSpace image.
String imageDescription
The description of the WorkSpace image.
SdkInternalList<T> tags
The tags. Each WorkSpaces resource can have a maximum of 50 tags.
SdkInternalList<T> applications
If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11 BYOL images. For more information about subscribing to Office for BYOL images, see Bring Your Own Windows Desktop Licenses.
Although this parameter is an array, only one item is allowed at this time.
Windows 11 only supports Microsoft_Office_2019
.
String imageId
The identifier of the WorkSpace image.
String logoUrl
The logo. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal
to one point. The only image format accepted is a binary data object that is converted from a .png
file.
String logo2xUrl
The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x).
The only image format accepted is a binary data object that is converted from a .png
file.
For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
String logo3xUrl
The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x).The
only image format accepted is a binary data object that is converted from a .png
file.
For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
String supportEmail
The support email. The company's customer support email address.
In each platform type, the SupportEmail
and SupportLink
parameters are mutually
exclusive. You can specify one parameter for each platform type, but not both.
The default email is [email protected]
.
String supportLink
The support link. The link for the company's customer support page for their WorkSpace.
In each platform type, the SupportEmail
and SupportLink
parameters are mutually
exclusive. You can specify one parameter for each platform type, but not both.
The default support link is [email protected]
.
String forgotPasswordLink
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
Map<K,V> loginMessage
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized
message for that locale. The only key supported is en_US
. The HTML tags supported include the
following:
a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul
.
ByteBuffer logo
The logo. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal
to one point. The only image format accepted is a binary data object that is converted from a .png
file.
ByteBuffer logo2x
The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x).
The only image format accepted is a binary data object that is converted from a .png
file.
For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
ByteBuffer logo3x
The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x).
The only image format accepted is a binary data object that is converted from a .png
file.
For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
String supportEmail
The support email. The company's customer support email address.
In each platform type, the SupportEmail
and SupportLink
parameters are mutually
exclusive. You can specify one parameter for each platform type, but not both.
The default email is [email protected]
.
String supportLink
The support link. The link for the company's customer support page for their WorkSpace.
In each platform type, the SupportEmail
and SupportLink
parameters are mutually
exclusive. You can specify one parameter for each platform type, but not both.
The default support link is [email protected]
.
String forgotPasswordLink
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
Map<K,V> loginMessage
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized
message for that locale. The only key supported is en_US
. The HTML tags supported include the
following:
a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul
.
String managementCidrRangeConstraint
The IP address range to search. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block).
Integer maxResults
The maximum number of items to return.
String nextToken
If you received a NextToken
from a previous call that was paginated, provide this token to receive
the next set of results.
SdkInternalList<T> managementCidrRanges
The list of available IP address ranges, specified as IPv4 CIDR blocks.
String nextToken
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
String sourceWorkspaceId
The original identifier of the WorkSpace that is being migrated.
String targetWorkspaceId
The new identifier of the WorkSpace that is being migrated. If the migration does not succeed, the target WorkSpace ID will not be used, and the WorkSpace will still have the original WorkSpace ID.
String dedicatedTenancySupport
The status of BYOL.
String dedicatedTenancyManagementCidrRange
The IP address range, specified as an IPv4 CIDR block, for the management network interface. Specify an IP
address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4
CIDR block). The CIDR block size must be /16 (for example, 203.0.113.25/16). It must also be specified as
available by the ListAvailableManagementCidrRanges
operation.
String resourceId
The resource identifiers, in the form of directory IDs.
CertificateBasedAuthProperties certificateBasedAuthProperties
The properties of the certificate-based authentication.
SdkInternalList<T> propertiesToDelete
The properties of the certificate-based authentication you want to delete.
String resourceId
The resource identifiers, in the form of directory IDs.
ClientProperties clientProperties
Information about the Amazon WorkSpaces client.
String resourceId
The directory identifier for which you want to configure SAML properties.
SamlProperties samlProperties
The properties for configuring SAML 2.0 authentication.
SdkInternalList<T> propertiesToDelete
The SAML properties to delete as part of your request.
Specify one of the following options:
SAML_PROPERTIES_USER_ACCESS_URL
to delete the user access URL.
SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME
to delete the relay state parameter name.
String resourceId
The identifier of the directory.
SelfservicePermissions selfservicePermissions
The permissions to enable or disable self-service capabilities.
String resourceId
The identifier of the directory.
WorkspaceAccessProperties workspaceAccessProperties
The device types and operating systems to enable or disable for access.
String resourceId
The identifier of the directory.
WorkspaceCreationProperties workspaceCreationProperties
The default properties for creating WorkSpaces.
String workspaceId
The identifier of the WorkSpace.
WorkspaceProperties workspaceProperties
The properties of the WorkSpace.
String type
The operating system.
String reason
The exception error reason.
String userName
Describes the standby WorkSpace that was created.
Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned can be incomplete.
String directoryId
The identifier of the directory for the standby WorkSpace.
String state
The operational state of the standby WorkSpace.
String workspaceId
The identifier of the standby WorkSpace.
String workspaceId
The identifier of the WorkSpace.
SdkInternalList<T> rebootWorkspaceRequests
The WorkSpaces to reboot. You can specify up to 25 WorkSpaces.
SdkInternalList<T> failedRequests
Information about the WorkSpaces that could not be rebooted.
String workspaceId
The identifier of the WorkSpace.
SdkInternalList<T> rebuildWorkspaceRequests
The WorkSpace to rebuild. You can specify a single WorkSpace.
SdkInternalList<T> failedRequests
Information about the WorkSpace that could not be rebuilt.
String directoryId
The identifier of the directory. You cannot register a directory if it does not have a status of Active. If the directory does not have a status of Active, you will receive an InvalidResourceStateException error. If you have already registered the maximum number of directories that you can register with Amazon WorkSpaces, you will receive a ResourceLimitExceededException error. Deregister directories that you are not using for WorkSpaces, and try again.
SdkInternalList<T> subnetIds
The identifiers of the subnets for your virtual private cloud (VPC). Make sure that the subnets are in supported Availability Zones. The subnets must also be in separate Availability Zones. If these conditions are not met, you will receive an OperationNotSupportedException error.
Boolean enableWorkDocs
Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this parameter and WorkDocs is not
available in the Region, you will receive an OperationNotSupportedException error. Set
EnableWorkDocs
to disabled, and try again.
Boolean enableSelfService
Indicates whether self-service capabilities are enabled or disabled.
String tenancy
Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own License (BYOL) images,
this value must be set to DEDICATED
and your Amazon Web Services account must be enabled for BYOL.
If your account has not been enabled for BYOL, you will receive an InvalidParameterValuesException error. For
more information about BYOL images, see Bring Your Own Windows
Desktop Images.
SdkInternalList<T> tags
The tags associated with the directory.
String resourceId
The ID of the resource that could not be found.
String resourceId
The identifier of the resource that is not available.
String workspaceId
The identifier of the WorkSpace.
String groupId
The identifier of the group.
SdkInternalList<T> userRules
The rules to remove from the group.
String capacity
The size of the root volume.
String 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.
String userAccessUrl
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.
String relayStateParameterName
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.
String restartWorkspace
Specifies whether users can restart their WorkSpace.
String increaseVolumeSize
Specifies whether users can increase the volume size of the drives on their WorkSpace.
String changeComputeType
Specifies whether users can change the compute type (bundle) for their WorkSpace.
String switchRunningMode
Specifies whether users can switch the running mode of their WorkSpace.
String rebuildWorkspace
Specifies whether users can rebuild the operating system of a WorkSpace to its original state.
Date snapshotTime
The time when the snapshot was created.
String primaryWorkspaceId
The identifier of the standby WorkSpace.
String volumeEncryptionKey
The volume encryption key of the standby WorkSpace.
String directoryId
The identifier of the directory for the standby WorkSpace.
SdkInternalList<T> tags
The tags associated with the standby WorkSpace.
String workspaceId
The identifier of the WorkSpace.
SdkInternalList<T> startWorkspaceRequests
The WorkSpaces to start. You can specify up to 25 WorkSpaces.
SdkInternalList<T> failedRequests
Information about the WorkSpaces that could not be started.
String workspaceId
The identifier of the WorkSpace.
SdkInternalList<T> stopWorkspaceRequests
The WorkSpaces to stop. You can specify up to 25 WorkSpaces.
SdkInternalList<T> failedRequests
Information about the WorkSpaces that could not be stopped.
String workspaceId
The identifier of the WorkSpace.
SdkInternalList<T> terminateWorkspaceRequests
The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.
SdkInternalList<T> failedRequests
Information about the WorkSpaces that could not be terminated.
String aliasId
The identifier of the connection alias that you want to update permissions for.
ConnectionAliasPermission connectionAliasPermission
Indicates whether to share or unshare the connection alias with the specified Amazon Web Services account.
String groupId
The identifier of the group.
SdkInternalList<T> userRules
One or more rules.
String imageId
The identifier of the image.
Boolean allowCopyImage
The permission to copy the image. This permission can be revoked only after an image has been shared.
String sharedAccountId
The identifier of the Amazon Web Services account to share or unshare the image with.
Before sharing the image, confirm that you are sharing to the correct Amazon Web Services account ID.
String capacity
The size of the user volume.
String workspaceId
The identifier of the WorkSpace.
String directoryId
The identifier of the Directory Service directory for the WorkSpace.
String userName
The user for the WorkSpace.
String ipAddress
The IP address of the WorkSpace.
String state
The operational state of the WorkSpace.
After a WorkSpace is terminated, the TERMINATED
state is returned only briefly before the WorkSpace
directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated,
check for the WorkSpace ID by using DescribeWorkSpaces. If
the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.
String bundleId
The identifier of the bundle used to create the WorkSpace.
String subnetId
The identifier of the subnet for the WorkSpace.
String errorMessage
The text of the error message that is returned if the WorkSpace cannot be created.
String errorCode
The error code that is returned if the WorkSpace cannot be created.
String computerName
The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace.
String volumeEncryptionKey
The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
Boolean userVolumeEncryptionEnabled
Indicates whether the data stored on the user volume is encrypted.
Boolean rootVolumeEncryptionEnabled
Indicates whether the data stored on the root volume is encrypted.
WorkspaceProperties workspaceProperties
The properties of the WorkSpace.
SdkInternalList<T> modificationStates
The modification states of the WorkSpace.
SdkInternalList<T> relatedWorkspaces
The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
String deviceTypeWindows
Indicates whether users can use Windows clients to access their WorkSpaces.
String deviceTypeOsx
Indicates whether users can use macOS clients to access their WorkSpaces.
String deviceTypeWeb
Indicates whether users can access their WorkSpaces through a web browser.
String deviceTypeIos
Indicates whether users can use iOS devices to access their WorkSpaces.
String deviceTypeAndroid
Indicates whether users can use Android and Android-compatible Chrome OS devices to access their WorkSpaces.
String deviceTypeChromeOs
Indicates whether users can use Chromebooks to access their WorkSpaces.
String deviceTypeZeroClient
Indicates whether users can use zero client devices to access their WorkSpaces.
String deviceTypeLinux
Indicates whether users can use Linux clients to access their WorkSpaces.
String bundleId
The identifier of the bundle.
String name
The name of the bundle.
String owner
The owner of the bundle. This is the account identifier of the owner, or AMAZON
if the bundle is
provided by Amazon Web Services.
String description
The description of the bundle.
String imageId
The identifier of the image that was used to create the bundle.
RootStorage rootStorage
The size of the root volume.
UserStorage userStorage
The size of the user volume.
ComputeType computeType
The compute type of the bundle. For more information, see Amazon WorkSpaces Bundles.
Date lastUpdatedTime
The last time that the bundle was updated.
Date creationTime
The time when the bundle was created.
String state
The state of the WorkSpace bundle.
String bundleType
The type of WorkSpace bundle.
String workspaceId
The identifier of the WorkSpace.
String connectionState
The connection state of the WorkSpace. The connection state is unknown if the WorkSpace is stopped.
Date connectionStateCheckTimestamp
The timestamp of the connection status check.
Date lastKnownUserConnectionTimestamp
The timestamp of the last known user connection.
Boolean enableWorkDocs
Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.
If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless you either disable users' access to WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, see Disabling Users in the Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see Deleting a Site in the Amazon WorkDocs Administration Guide.
If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are launched in the directory will have WorkDocs enabled.
Boolean enableInternetAccess
Indicates whether internet access is enabled for your WorkSpaces.
String defaultOu
The default organizational unit (OU) for your WorkSpaces directories. This string must be the full Lightweight
Directory Access Protocol (LDAP) distinguished name for the target domain and OU. It must be in the form
"OU=value,DC=value,DC=value"
, where value is any string of characters,
and the number of domain components (DCs) is two or more. For example,
OU=WorkSpaces_machines,DC=machines,DC=example,DC=com
.
To avoid errors, certain characters in the distinguished name must be escaped. For more information, see Distinguished Names in the Microsoft documentation.
The API doesn't validate whether the OU exists.
String customSecurityGroupId
The identifier of your custom security group.
Boolean userEnabledAsLocalAdministrator
Indicates whether users are local administrators of their WorkSpaces.
Boolean enableMaintenanceMode
Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.
String directoryId
The directory identifier.
String alias
The directory alias.
String directoryName
The name of the directory.
String registrationCode
The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.
SdkInternalList<T> subnetIds
The identifiers of the subnets used with the directory.
SdkInternalList<T> dnsIpAddresses
The IP addresses of the DNS servers for the directory.
String customerUserName
The user name for the service account.
String iamRoleId
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.
String directoryType
The directory type.
String workspaceSecurityGroupId
The identifier of the security group that is assigned to new WorkSpaces.
String 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.
DefaultWorkspaceCreationProperties workspaceCreationProperties
The default creation properties for all WorkSpaces in the directory.
SdkInternalList<T> ipGroupIds
The identifiers of the IP access control groups associated with the directory.
WorkspaceAccessProperties workspaceAccessProperties
The devices and operating systems that users can use to access WorkSpaces.
String 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.
SelfservicePermissions selfservicePermissions
The default self-service permissions for WorkSpaces in the directory.
SamlProperties samlProperties
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.
CertificateBasedAuthProperties certificateBasedAuthProperties
The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.
String imageId
The identifier of the image.
String name
The name of the image.
String description
The description of the image.
OperatingSystem operatingSystem
The operating system that the image is running.
String state
The status of the image.
String requiredTenancy
Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this
value is set to DEDICATED
. For more information, see Bring Your Own Windows
Desktop Images.
String errorCode
The error code that is returned for the image.
String errorMessage
The text of the error message that is returned for the image.
Date created
The date when the image was created. If the image has been shared, the Amazon Web Services account that the image has been shared with sees the original creation date of the image.
String ownerAccountId
The identifier of the Amazon Web Services account that owns the image.
UpdateResult updates
The updates (if any) that are available for the specified image.
SdkInternalList<T> errorDetails
The details of the error returned for the image.
String runningMode
The running mode. For more information, see Manage the WorkSpace Running Mode.
The MANUAL
value is only supported by Amazon WorkSpaces Core. Contact your account team to be
allow-listed to use this value. For more information, see Amazon
WorkSpaces Core.
Integer runningModeAutoStopTimeoutInMinutes
The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
Integer rootVolumeSizeGib
The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
Integer userVolumeSizeGib
The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
String computeTypeName
The compute type. For more information, see Amazon WorkSpaces Bundles.
SdkInternalList<T> protocols
The protocol. For more information, see Protocols for Amazon WorkSpaces.
Only available for WorkSpaces created with PCoIP bundles.
The Protocols
property is case sensitive. Ensure you use PCOIP
or WSP
.
Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
String directoryId
The identifier of the Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.
String userName
The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.
String bundleId
The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.
String volumeEncryptionKey
The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
Boolean userVolumeEncryptionEnabled
Indicates whether the data stored on the user volume is encrypted.
Boolean rootVolumeEncryptionEnabled
Indicates whether the data stored on the root volume is encrypted.
WorkspaceProperties workspaceProperties
The WorkSpace properties.
SdkInternalList<T> tags
The tags for the WorkSpace.
String groupId
The identifier of the group.
String groupName
The name of the group.
String groupDesc
The description of the group.
SdkInternalList<T> userRules
The rules.
Copyright © 2023. All rights reserved.