2025/05/15 - Amazon WorkSpaces - 4 updated api methods
Changes Added the new AlwaysOn running mode for WorkSpaces Pools. Customers can now choose between AlwaysOn (for instant access, with hourly usage billing regardless of connection status), or AutoStop (to optimize cost, with a brief startup delay) for their pools.
{'RunningMode': 'AUTO_STOP | ALWAYS_ON'}
Response {'WorkspacesPool': {'RunningMode': 'AUTO_STOP | ALWAYS_ON'}}
Creates a pool of WorkSpaces.
See also: AWS API Documentation
Request Syntax
client.create_workspaces_pool(
PoolName='string',
Description='string',
BundleId='string',
DirectoryId='string',
Capacity={
'DesiredUserSessions': 123
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ApplicationSettings={
'Status': 'DISABLED'|'ENABLED',
'SettingsGroup': 'string'
},
TimeoutSettings={
'DisconnectTimeoutInSeconds': 123,
'IdleDisconnectTimeoutInSeconds': 123,
'MaxUserDurationInSeconds': 123
},
RunningMode='AUTO_STOP'|'ALWAYS_ON'
)
string
[REQUIRED]
The name of the pool.
string
[REQUIRED]
The pool description.
string
[REQUIRED]
The identifier of the bundle for the pool.
string
[REQUIRED]
The identifier of the directory for the pool.
dict
[REQUIRED]
The user capacity of the pool.
DesiredUserSessions (integer) -- [REQUIRED]
The desired number of user sessions for the WorkSpaces in the pool.
list
The tags for the pool.
(dict) --
Describes a tag.
Key (string) -- [REQUIRED]
The key of the tag.
Value (string) --
The value of the tag.
dict
Indicates the application settings of the pool.
Status (string) -- [REQUIRED]
Enables or disables persistent application settings for users during their pool sessions.
SettingsGroup (string) --
The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple pools by specifying the same settings group for each pool.
dict
Indicates the timeout settings of the pool.
DisconnectTimeoutInSeconds (integer) --
Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
IdleDisconnectTimeoutInSeconds (integer) --
The amount of time in seconds a connection will stay active while idle.
MaxUserDurationInSeconds (integer) --
Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
string
The running mode for the pool.
dict
Response Syntax
{
'WorkspacesPool': {
'PoolId': 'string',
'PoolArn': 'string',
'CapacityStatus': {
'AvailableUserSessions': 123,
'DesiredUserSessions': 123,
'ActualUserSessions': 123,
'ActiveUserSessions': 123
},
'PoolName': 'string',
'Description': 'string',
'State': 'CREATING'|'DELETING'|'RUNNING'|'STARTING'|'STOPPED'|'STOPPING'|'UPDATING',
'CreatedAt': datetime(2015, 1, 1),
'BundleId': 'string',
'DirectoryId': 'string',
'Errors': [
{
'ErrorCode': 'IAM_SERVICE_ROLE_IS_MISSING'|'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'MACHINE_ROLE_IS_MISSING'|'STS_DISABLED_IN_REGION'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'WORKSPACES_POOL_STOPPED'|'WORKSPACES_POOL_INSTANCE_PROVISIONING_FAILURE'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR'|'DOMAIN_JOIN_ERROR_SECRET_ACTION_PERMISSION_IS_MISSING'|'DOMAIN_JOIN_ERROR_SECRET_DECRYPTION_FAILURE'|'DOMAIN_JOIN_ERROR_SECRET_STATE_INVALID'|'DOMAIN_JOIN_ERROR_SECRET_NOT_FOUND'|'DOMAIN_JOIN_ERROR_SECRET_VALUE_KEY_NOT_FOUND'|'DOMAIN_JOIN_ERROR_SECRET_INVALID'|'BUNDLE_NOT_FOUND'|'DIRECTORY_NOT_FOUND'|'INSUFFICIENT_PERMISSIONS_ERROR'|'DEFAULT_OU_IS_MISSING',
'ErrorMessage': 'string'
},
],
'ApplicationSettings': {
'Status': 'DISABLED'|'ENABLED',
'SettingsGroup': 'string',
'S3BucketName': 'string'
},
'TimeoutSettings': {
'DisconnectTimeoutInSeconds': 123,
'IdleDisconnectTimeoutInSeconds': 123,
'MaxUserDurationInSeconds': 123
},
'RunningMode': 'AUTO_STOP'|'ALWAYS_ON'
}
}
Response Structure
(dict) --
WorkspacesPool (dict) --
Indicates the pool to create.
PoolId (string) --
The identifier of a pool.
PoolArn (string) --
The Amazon Resource Name (ARN) for the pool.
CapacityStatus (dict) --
The capacity status for the pool
AvailableUserSessions (integer) --
The number of user sessions currently available for streaming from your pool.
AvailableUserSessions = ActualUserSessions - ActiveUserSessions
DesiredUserSessions (integer) --
The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your pool can support in a steady state.
ActualUserSessions (integer) --
The total number of user sessions that are available for streaming or are currently streaming in your pool.
ActualUserSessions = AvailableUserSessions + ActiveUserSessions
ActiveUserSessions (integer) --
The number of user sessions currently being used for your pool.
PoolName (string) --
The name of the pool.
Description (string) --
The description of the pool.
State (string) --
The current state of the pool.
CreatedAt (datetime) --
The time the pool was created.
BundleId (string) --
The identifier of the bundle used by the pool.
DirectoryId (string) --
The identifier of the directory used by the pool.
Errors (list) --
The pool errors.
(dict) --
Describes a pool error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
ApplicationSettings (dict) --
The persistent application settings for users of the pool.
Status (string) --
Specifies whether persistent application settings are enabled for users during their pool sessions.
SettingsGroup (string) --
The path prefix for the S3 bucket where users’ persistent application settings are stored.
S3BucketName (string) --
The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an Amazon Web Services Region, an S3 bucket is created. The bucket is unique to the Amazon Web Services account and the Region.
TimeoutSettings (dict) --
The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.
DisconnectTimeoutInSeconds (integer) --
Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
IdleDisconnectTimeoutInSeconds (integer) --
The amount of time in seconds a connection will stay active while idle.
MaxUserDurationInSeconds (integer) --
Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
RunningMode (string) --
The running mode of the pool.
{'Images': {'ErrorDetails': {'ErrorCode': {'MemoryIntegrityIncompatibility',
'ProtocolOSIncompatibility',
'RestrictedDriveLetterInUse'}}}}
Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.
See also: AWS API Documentation
Request Syntax
client.describe_workspace_images(
ImageIds=[
'string',
],
ImageType='OWNED'|'SHARED',
NextToken='string',
MaxResults=123
)
list
The identifier of the image.
(string) --
string
The type (owned or shared) of the image.
string
If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
integer
The maximum number of items to return.
dict
Response Syntax
{
'Images': [
{
'ImageId': 'string',
'Name': 'string',
'Description': 'string',
'OperatingSystem': {
'Type': 'WINDOWS'|'LINUX'
},
'State': 'AVAILABLE'|'PENDING'|'ERROR',
'RequiredTenancy': 'DEFAULT'|'DEDICATED',
'ErrorCode': 'string',
'ErrorMessage': 'string',
'Created': datetime(2015, 1, 1),
'OwnerAccountId': 'string',
'Updates': {
'UpdateAvailable': True|False,
'Description': 'string'
},
'ErrorDetails': [
{
'ErrorCode': 'OutdatedPowershellVersion'|'OfficeInstalled'|'PCoIPAgentInstalled'|'WindowsUpdatesEnabled'|'AutoMountDisabled'|'WorkspacesBYOLAccountNotFound'|'WorkspacesBYOLAccountDisabled'|'DHCPDisabled'|'DiskFreeSpace'|'AdditionalDrivesAttached'|'OSNotSupported'|'DomainJoined'|'AzureDomainJoined'|'FirewallEnabled'|'VMWareToolsInstalled'|'DiskSizeExceeded'|'IncompatiblePartitioning'|'PendingReboot'|'AutoLogonEnabled'|'RealTimeUniversalDisabled'|'MultipleBootPartition'|'Requires64BitOS'|'ZeroRearmCount'|'InPlaceUpgrade'|'AntiVirusInstalled'|'UEFINotSupported'|'UnknownError'|'AppXPackagesInstalled'|'ReservedStorageInUse'|'AdditionalDrivesPresent'|'WindowsUpdatesRequired'|'SysPrepFileMissing'|'UserProfileMissing'|'InsufficientDiskSpace'|'EnvironmentVariablesPathMissingEntries'|'DomainAccountServicesFound'|'InvalidIp'|'RemoteDesktopServicesDisabled'|'WindowsModulesInstallerDisabled'|'AmazonSsmAgentEnabled'|'UnsupportedSecurityProtocol'|'MultipleUserProfiles'|'StagedAppxPackage'|'UnsupportedOsUpgrade'|'InsufficientRearmCount'|'ProtocolOSIncompatibility'|'MemoryIntegrityIncompatibility'|'RestrictedDriveLetterInUse',
'ErrorMessage': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Images (list) --
Information about the images.
(dict) --
Describes a WorkSpace image.
ImageId (string) --
The identifier of the image.
Name (string) --
The name of the image.
Description (string) --
The description of the image.
OperatingSystem (dict) --
The operating system that the image is running.
Type (string) --
The operating system.
State (string) --
The status of the image.
RequiredTenancy (string) --
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.
ErrorCode (string) --
The error code that is returned for the image.
ErrorMessage (string) --
The text of the error message that is returned for the image.
Created (datetime) --
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.
OwnerAccountId (string) --
The identifier of the Amazon Web Services account that owns the image.
Updates (dict) --
The updates (if any) that are available for the specified image.
UpdateAvailable (boolean) --
Indicates whether updated drivers or other components are available for the specified WorkSpace image.
Description (string) --
A description of whether updates for the WorkSpace image are pending or available.
ErrorDetails (list) --
Additional details of the error returned for the image, including the possible causes of the errors and troubleshooting information.
(dict) --
Describes in-depth details about the error. These details include the possible causes of the error and troubleshooting information.
ErrorCode (string) --
Indicates the error code returned.
ErrorMessage (string) --
The text of the error message related the error code.
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.
{'WorkspacesPools': {'RunningMode': 'AUTO_STOP | ALWAYS_ON'}}
Describes the specified WorkSpaces Pools.
See also: AWS API Documentation
Request Syntax
client.describe_workspaces_pools(
PoolIds=[
'string',
],
Filters=[
{
'Name': 'PoolName',
'Values': [
'string',
],
'Operator': 'EQUALS'|'NOTEQUALS'|'CONTAINS'|'NOTCONTAINS'
},
],
Limit=123,
NextToken='string'
)
list
The identifier of the WorkSpaces Pools.
(string) --
list
The filter conditions for the WorkSpaces Pool to return.
(dict) --
Describes the filter conditions for WorkSpaces Pools to return.
Name (string) -- [REQUIRED]
The name of the pool to filter.
Values (list) -- [REQUIRED]
The values for filtering WorkSpaces Pools.
(string) --
Operator (string) -- [REQUIRED]
The operator values for filtering WorkSpaces Pools.
integer
The maximum number of items to return.
string
If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
dict
Response Syntax
{
'WorkspacesPools': [
{
'PoolId': 'string',
'PoolArn': 'string',
'CapacityStatus': {
'AvailableUserSessions': 123,
'DesiredUserSessions': 123,
'ActualUserSessions': 123,
'ActiveUserSessions': 123
},
'PoolName': 'string',
'Description': 'string',
'State': 'CREATING'|'DELETING'|'RUNNING'|'STARTING'|'STOPPED'|'STOPPING'|'UPDATING',
'CreatedAt': datetime(2015, 1, 1),
'BundleId': 'string',
'DirectoryId': 'string',
'Errors': [
{
'ErrorCode': 'IAM_SERVICE_ROLE_IS_MISSING'|'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'MACHINE_ROLE_IS_MISSING'|'STS_DISABLED_IN_REGION'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'WORKSPACES_POOL_STOPPED'|'WORKSPACES_POOL_INSTANCE_PROVISIONING_FAILURE'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR'|'DOMAIN_JOIN_ERROR_SECRET_ACTION_PERMISSION_IS_MISSING'|'DOMAIN_JOIN_ERROR_SECRET_DECRYPTION_FAILURE'|'DOMAIN_JOIN_ERROR_SECRET_STATE_INVALID'|'DOMAIN_JOIN_ERROR_SECRET_NOT_FOUND'|'DOMAIN_JOIN_ERROR_SECRET_VALUE_KEY_NOT_FOUND'|'DOMAIN_JOIN_ERROR_SECRET_INVALID'|'BUNDLE_NOT_FOUND'|'DIRECTORY_NOT_FOUND'|'INSUFFICIENT_PERMISSIONS_ERROR'|'DEFAULT_OU_IS_MISSING',
'ErrorMessage': 'string'
},
],
'ApplicationSettings': {
'Status': 'DISABLED'|'ENABLED',
'SettingsGroup': 'string',
'S3BucketName': 'string'
},
'TimeoutSettings': {
'DisconnectTimeoutInSeconds': 123,
'IdleDisconnectTimeoutInSeconds': 123,
'MaxUserDurationInSeconds': 123
},
'RunningMode': 'AUTO_STOP'|'ALWAYS_ON'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
WorkspacesPools (list) --
Information about the WorkSpaces Pools.
(dict) --
Describes a pool of WorkSpaces.
PoolId (string) --
The identifier of a pool.
PoolArn (string) --
The Amazon Resource Name (ARN) for the pool.
CapacityStatus (dict) --
The capacity status for the pool
AvailableUserSessions (integer) --
The number of user sessions currently available for streaming from your pool.
AvailableUserSessions = ActualUserSessions - ActiveUserSessions
DesiredUserSessions (integer) --
The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your pool can support in a steady state.
ActualUserSessions (integer) --
The total number of user sessions that are available for streaming or are currently streaming in your pool.
ActualUserSessions = AvailableUserSessions + ActiveUserSessions
ActiveUserSessions (integer) --
The number of user sessions currently being used for your pool.
PoolName (string) --
The name of the pool.
Description (string) --
The description of the pool.
State (string) --
The current state of the pool.
CreatedAt (datetime) --
The time the pool was created.
BundleId (string) --
The identifier of the bundle used by the pool.
DirectoryId (string) --
The identifier of the directory used by the pool.
Errors (list) --
The pool errors.
(dict) --
Describes a pool error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
ApplicationSettings (dict) --
The persistent application settings for users of the pool.
Status (string) --
Specifies whether persistent application settings are enabled for users during their pool sessions.
SettingsGroup (string) --
The path prefix for the S3 bucket where users’ persistent application settings are stored.
S3BucketName (string) --
The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an Amazon Web Services Region, an S3 bucket is created. The bucket is unique to the Amazon Web Services account and the Region.
TimeoutSettings (dict) --
The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.
DisconnectTimeoutInSeconds (integer) --
Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
IdleDisconnectTimeoutInSeconds (integer) --
The amount of time in seconds a connection will stay active while idle.
MaxUserDurationInSeconds (integer) --
Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
RunningMode (string) --
The running mode of the pool.
NextToken (string) --
If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
{'RunningMode': 'AUTO_STOP | ALWAYS_ON'}
Response {'WorkspacesPool': {'RunningMode': 'AUTO_STOP | ALWAYS_ON'}}
Updates the specified pool.
See also: AWS API Documentation
Request Syntax
client.update_workspaces_pool(
PoolId='string',
Description='string',
BundleId='string',
DirectoryId='string',
Capacity={
'DesiredUserSessions': 123
},
ApplicationSettings={
'Status': 'DISABLED'|'ENABLED',
'SettingsGroup': 'string'
},
TimeoutSettings={
'DisconnectTimeoutInSeconds': 123,
'IdleDisconnectTimeoutInSeconds': 123,
'MaxUserDurationInSeconds': 123
},
RunningMode='AUTO_STOP'|'ALWAYS_ON'
)
string
[REQUIRED]
The identifier of the specified pool to update.
string
Describes the specified pool to update.
string
The identifier of the bundle.
string
The identifier of the directory.
dict
The desired capacity for the pool.
DesiredUserSessions (integer) -- [REQUIRED]
The desired number of user sessions for the WorkSpaces in the pool.
dict
The persistent application settings for users in the pool.
Status (string) -- [REQUIRED]
Enables or disables persistent application settings for users during their pool sessions.
SettingsGroup (string) --
The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple pools by specifying the same settings group for each pool.
dict
Indicates the timeout settings of the specified pool.
DisconnectTimeoutInSeconds (integer) --
Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
IdleDisconnectTimeoutInSeconds (integer) --
The amount of time in seconds a connection will stay active while idle.
MaxUserDurationInSeconds (integer) --
Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
string
The desired running mode for the pool. The running mode can only be updated when the pool is in a stopped state.
dict
Response Syntax
{
'WorkspacesPool': {
'PoolId': 'string',
'PoolArn': 'string',
'CapacityStatus': {
'AvailableUserSessions': 123,
'DesiredUserSessions': 123,
'ActualUserSessions': 123,
'ActiveUserSessions': 123
},
'PoolName': 'string',
'Description': 'string',
'State': 'CREATING'|'DELETING'|'RUNNING'|'STARTING'|'STOPPED'|'STOPPING'|'UPDATING',
'CreatedAt': datetime(2015, 1, 1),
'BundleId': 'string',
'DirectoryId': 'string',
'Errors': [
{
'ErrorCode': 'IAM_SERVICE_ROLE_IS_MISSING'|'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'MACHINE_ROLE_IS_MISSING'|'STS_DISABLED_IN_REGION'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'WORKSPACES_POOL_STOPPED'|'WORKSPACES_POOL_INSTANCE_PROVISIONING_FAILURE'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR'|'DOMAIN_JOIN_ERROR_SECRET_ACTION_PERMISSION_IS_MISSING'|'DOMAIN_JOIN_ERROR_SECRET_DECRYPTION_FAILURE'|'DOMAIN_JOIN_ERROR_SECRET_STATE_INVALID'|'DOMAIN_JOIN_ERROR_SECRET_NOT_FOUND'|'DOMAIN_JOIN_ERROR_SECRET_VALUE_KEY_NOT_FOUND'|'DOMAIN_JOIN_ERROR_SECRET_INVALID'|'BUNDLE_NOT_FOUND'|'DIRECTORY_NOT_FOUND'|'INSUFFICIENT_PERMISSIONS_ERROR'|'DEFAULT_OU_IS_MISSING',
'ErrorMessage': 'string'
},
],
'ApplicationSettings': {
'Status': 'DISABLED'|'ENABLED',
'SettingsGroup': 'string',
'S3BucketName': 'string'
},
'TimeoutSettings': {
'DisconnectTimeoutInSeconds': 123,
'IdleDisconnectTimeoutInSeconds': 123,
'MaxUserDurationInSeconds': 123
},
'RunningMode': 'AUTO_STOP'|'ALWAYS_ON'
}
}
Response Structure
(dict) --
WorkspacesPool (dict) --
Describes the specified pool.
PoolId (string) --
The identifier of a pool.
PoolArn (string) --
The Amazon Resource Name (ARN) for the pool.
CapacityStatus (dict) --
The capacity status for the pool
AvailableUserSessions (integer) --
The number of user sessions currently available for streaming from your pool.
AvailableUserSessions = ActualUserSessions - ActiveUserSessions
DesiredUserSessions (integer) --
The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your pool can support in a steady state.
ActualUserSessions (integer) --
The total number of user sessions that are available for streaming or are currently streaming in your pool.
ActualUserSessions = AvailableUserSessions + ActiveUserSessions
ActiveUserSessions (integer) --
The number of user sessions currently being used for your pool.
PoolName (string) --
The name of the pool.
Description (string) --
The description of the pool.
State (string) --
The current state of the pool.
CreatedAt (datetime) --
The time the pool was created.
BundleId (string) --
The identifier of the bundle used by the pool.
DirectoryId (string) --
The identifier of the directory used by the pool.
Errors (list) --
The pool errors.
(dict) --
Describes a pool error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
ApplicationSettings (dict) --
The persistent application settings for users of the pool.
Status (string) --
Specifies whether persistent application settings are enabled for users during their pool sessions.
SettingsGroup (string) --
The path prefix for the S3 bucket where users’ persistent application settings are stored.
S3BucketName (string) --
The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an Amazon Web Services Region, an S3 bucket is created. The bucket is unique to the Amazon Web Services account and the Region.
TimeoutSettings (dict) --
The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.
DisconnectTimeoutInSeconds (integer) --
Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
IdleDisconnectTimeoutInSeconds (integer) --
The amount of time in seconds a connection will stay active while idle.
MaxUserDurationInSeconds (integer) --
Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
RunningMode (string) --
The running mode of the pool.