id
stringlengths 8
78
| source
stringclasses 743
values | chunk_id
int64 1
5.05k
| text
stringlengths 593
49.7k
|
|---|---|---|---|
workspaces-api-048 | workspaces-api.pdf | 48 | API Reference StopWorkspacesPool Stops the specified pool. You cannot stop a WorkSpace pool unless it has a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR. Request Syntax { "PoolId": "string" } Request Parameters The request accepts the following data in JSON format. PoolId The identifier of the pool. Type: String Pattern: ^wspool-[0-9a-z]{9}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The user is not authorized to access a resource. HTTP Status Code: 400 StopWorkspacesPool API Version 2015-04-08 278 Amazon WorkSpaces Service API Reference InvalidParameterValuesException One or more parameter values are not valid. HTTP Status Code: 400 InvalidResourceStateException The state of the resource is not valid for this operation. HTTP Status Code: 400 OperationInProgressException The properties of this WorkSpace are currently being modified. Try again in a moment. HTTP Status Code: 400 ResourceNotFoundException The resource could not be found. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2015-04-08 279 Amazon WorkSpaces Service API Reference TerminateWorkspaces Terminates the specified WorkSpaces. Important Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact Support before terminating the WorkSpace. You can terminate a WorkSpace that is in any state except SUSPENDED. This operation is asynchronous and returns before the WorkSpaces have been completely terminated. 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. Note Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the AWS Directory Service pricing terms. To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again. Request Syntax { "TerminateWorkspaceRequests": [ { "WorkspaceId": "string" } TerminateWorkspaces API Version 2015-04-08 280 Amazon WorkSpaces Service API Reference ] } Request Parameters The request accepts the following data in JSON format. TerminateWorkspaceRequests The WorkSpaces to terminate. You can specify up to 25 WorkSpaces. Type: Array of TerminateRequest objects Array Members: Minimum number of 1 item. Maximum number of 25 items. Required: Yes Response Syntax { "FailedRequests": [ { "ErrorCode": "string", "ErrorMessage": "string", "WorkspaceId": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. FailedRequests Information about the WorkSpaces that could not be terminated. Type: Array of FailedWorkspaceChangeRequest objects Request Parameters API Version 2015-04-08 281 Amazon WorkSpaces Service Errors API Reference For information about the errors that are common to all actions, see Common Errors. See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Errors API Version 2015-04-08 282 Amazon WorkSpaces Service API Reference TerminateWorkspacesPool Terminates the specified pool. Request Syntax { "PoolId": "string" } Request Parameters The request accepts the following data in JSON format. PoolId The identifier of the pool. Type: String Pattern: ^wspool-[0-9a-z]{9}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The user is not authorized to access a resource. HTTP Status Code: 400 InvalidParameterValuesException One or more parameter values are not valid. TerminateWorkspacesPool API |
workspaces-api-049 | workspaces-api.pdf | 49 | 282 Amazon WorkSpaces Service API Reference TerminateWorkspacesPool Terminates the specified pool. Request Syntax { "PoolId": "string" } Request Parameters The request accepts the following data in JSON format. PoolId The identifier of the pool. Type: String Pattern: ^wspool-[0-9a-z]{9}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The user is not authorized to access a resource. HTTP Status Code: 400 InvalidParameterValuesException One or more parameter values are not valid. TerminateWorkspacesPool API Version 2015-04-08 283 Amazon WorkSpaces Service HTTP Status Code: 400 InvalidResourceStateException The state of the resource is not valid for this operation. HTTP Status Code: 400 OperationInProgressException API Reference The properties of this WorkSpace are currently being modified. Try again in a moment. HTTP Status Code: 400 ResourceNotFoundException The resource could not be found. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2015-04-08 284 Amazon WorkSpaces Service API Reference TerminateWorkspacesPoolSession Terminates the pool session. Request Syntax { "SessionId": "string" } Request Parameters The request accepts the following data in JSON format. SessionId The identifier of the pool session. Type: String Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The user is not authorized to access a resource. HTTP Status Code: 400 TerminateWorkspacesPoolSession API Version 2015-04-08 285 Amazon WorkSpaces Service API Reference InvalidParameterValuesException One or more parameter values are not valid. HTTP Status Code: 400 OperationInProgressException The properties of this WorkSpace are currently being modified. Try again in a moment. HTTP Status Code: 400 OperationNotSupportedException This operation is not supported. HTTP Status Code: 400 ResourceNotFoundException The resource could not be found. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2015-04-08 286 Amazon WorkSpaces Service API Reference UpdateConnectClientAddIn Updates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon Connect client add-in. Request Syntax { "AddInId": "string", "Name": "string", "ResourceId": "string", "URL": "string" } Request Parameters The request accepts the following data in JSON format. AddInId The identifier of the client add-in to update. Type: String Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes Name The name of the client add-in. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^.*$ Required: No UpdateConnectClientAddIn API Version 2015-04-08 287 Amazon WorkSpaces Service ResourceId API Reference The directory identifier for which the client add-in is configured. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: ^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$) Required: Yes URL The endpoint URL of the Amazon Connect client add-in. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: ^(http|https)\://\S+ Required: No Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The user is not authorized to access a resource. HTTP Status Code: 400 InvalidParameterValuesException One or more parameter values are not valid. HTTP Status Code: 400 Response Elements API Version 2015-04-08 288 Amazon WorkSpaces Service ResourceNotFoundException The resource could not be found. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2015-04-08 289 Amazon WorkSpaces |
workspaces-api-050 | workspaces-api.pdf | 50 | 2015-04-08 288 Amazon WorkSpaces Service ResourceNotFoundException The resource could not be found. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2015-04-08 289 Amazon WorkSpaces Service API Reference UpdateConnectionAliasPermission Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory. If the association permission is granted, the connection alias is shared with that account. If the association permission is revoked, the connection alias is unshared with the account. For more information, see Cross-Region Redirection for Amazon WorkSpaces. Note • Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED. • To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories. Request Syntax { "AliasId": "string", "ConnectionAliasPermission": { "AllowAssociation": boolean, "SharedAccountId": "string" } } Request Parameters The request accepts the following data in JSON format. AliasId The identifier of the connection alias that you want to update permissions for. Type: String UpdateConnectionAliasPermission API Version 2015-04-08 290 Amazon WorkSpaces Service API Reference Length Constraints: Minimum length of 13. Maximum length of 68. Pattern: ^wsca-[0-9a-z]{8,63}$ Required: Yes ConnectionAliasPermission Indicates whether to share or unshare the connection alias with the specified AWS account. Type: ConnectionAliasPermission object Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The user is not authorized to access a resource. HTTP Status Code: 400 InvalidParameterValuesException One or more parameter values are not valid. HTTP Status Code: 400 InvalidResourceStateException The state of the resource is not valid for this operation. HTTP Status Code: 400 OperationNotSupportedException This operation is not supported. HTTP Status Code: 400 Response Elements API Version 2015-04-08 291 API Reference Amazon WorkSpaces Service ResourceAssociatedException The resource is associated with a directory. HTTP Status Code: 400 ResourceLimitExceededException Your resource limits have been exceeded. HTTP Status Code: 400 ResourceNotFoundException The resource could not be found. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2015-04-08 292 Amazon WorkSpaces Service API Reference UpdateRulesOfIpGroup Replaces the current rules of the specified IP access control group with the specified rules. Request Syntax { "GroupId": "string", "UserRules": [ { "ipRule": "string", "ruleDesc": "string" } ] } Request Parameters The request accepts the following data in JSON format. GroupId The identifier of the group. Type: String Pattern: wsipg-[0-9a-z]{8,63}$ Required: Yes UserRules One or more rules. Type: Array of IpRuleItem objects Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. UpdateRulesOfIpGroup API Version 2015-04-08 293 Amazon WorkSpaces Service Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The user is not authorized to access a resource. HTTP Status Code: 400 InvalidParameterValuesException One or more parameter values are not valid. HTTP Status Code: 400 InvalidResourceStateException The state of the resource is not valid for this operation. HTTP Status Code: 400 ResourceLimitExceededException Your resource limits have been exceeded. HTTP Status Code: 400 ResourceNotFoundException The resource could not be found. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 Errors API Version 2015-04-08 294 Amazon WorkSpaces Service • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS |
workspaces-api-051 | workspaces-api.pdf | 51 | operation. HTTP Status Code: 400 ResourceLimitExceededException Your resource limits have been exceeded. HTTP Status Code: 400 ResourceNotFoundException The resource could not be found. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 Errors API Version 2015-04-08 294 Amazon WorkSpaces Service • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2015-04-08 295 Amazon WorkSpaces Service API Reference UpdateWorkspaceBundle Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see Update a Custom WorkSpaces Bundle. Important Existing WorkSpaces aren't automatically updated when you update the bundle that they're based on. To update existing WorkSpaces that are based on a bundle that you've updated, you must either rebuild the WorkSpaces or delete and recreate them. Request Syntax { "BundleId": "string", "ImageId": "string" } Request Parameters The request accepts the following data in JSON format. BundleId The identifier of the bundle. Type: String Pattern: ^wsb-[0-9a-z]{8,63}$ Required: No ImageId The identifier of the image. Type: String Pattern: wsi-[0-9a-z]{9,63}$ UpdateWorkspaceBundle API Version 2015-04-08 296 Amazon WorkSpaces Service Required: No Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The user is not authorized to access a resource. HTTP Status Code: 400 InvalidParameterValuesException One or more parameter values are not valid. HTTP Status Code: 400 OperationNotSupportedException This operation is not supported. HTTP Status Code: 400 ResourceNotFoundException The resource could not be found. HTTP Status Code: 400 ResourceUnavailableException The specified resource is not available. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: Response Elements API Version 2015-04-08 297 API Reference Amazon WorkSpaces Service • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2015-04-08 298 Amazon WorkSpaces Service API Reference UpdateWorkspaceImagePermission Shares or unshares an image with one account in the same AWS Region by specifying whether that account has permission to copy the image. If the copy image permission is granted, the image is shared with that account. If the copy image permission is revoked, the image is unshared with the account. After an image has been shared, the recipient account can copy the image to other Regions as needed. In the China (Ningxia) Region, you can copy images only within the same Region. In AWS GovCloud (US), to copy images to and from other Regions, contact Support. For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image. Note • To delete an image that has been shared, you must unshare the image before you delete it. • Sharing Bring Your Own License (BYOL) images across AWS accounts isn't supported at this time in AWS GovCloud (US). To share BYOL images across accounts in AWS GovCloud (US), contact Support. Request Syntax { "AllowCopyImage": boolean, "ImageId": "string", "SharedAccountId": "string" } Request Parameters The request accepts the following data in JSON format. UpdateWorkspaceImagePermission API Version 2015-04-08 299 Amazon WorkSpaces Service AllowCopyImage API Reference The permission to copy the image. This permission can be revoked only after an image has been shared. Type: Boolean Required: Yes ImageId The identifier of the image. Type: String Pattern: wsi-[0-9a-z]{9,63}$ Required: Yes SharedAccountId The identifier of the AWS account to share or unshare the image with. Important Before sharing the image, confirm that you are sharing to the correct AWS account ID. Type: String Pattern: ^\d{12}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2015-04-08 300 API Reference Amazon WorkSpaces Service AccessDeniedException The user is not authorized to access a resource. HTTP Status Code: 400 InvalidParameterValuesException One or more parameter values are not valid. HTTP Status Code: 400 OperationNotSupportedException This operation is not supported. HTTP Status Code: 400 ResourceNotFoundException The resource could not be found. HTTP Status Code: 400 ResourceUnavailableException The specified resource is not available. HTTP Status Code: 400 See Also For |
workspaces-api-052 | workspaces-api.pdf | 52 | service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2015-04-08 300 API Reference Amazon WorkSpaces Service AccessDeniedException The user is not authorized to access a resource. HTTP Status Code: 400 InvalidParameterValuesException One or more parameter values are not valid. HTTP Status Code: 400 OperationNotSupportedException This operation is not supported. HTTP Status Code: 400 ResourceNotFoundException The resource could not be found. HTTP Status Code: 400 ResourceUnavailableException The specified resource is not available. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also API Version 2015-04-08 301 Amazon WorkSpaces Service • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2015-04-08 302 Amazon WorkSpaces Service API Reference UpdateWorkspacesPool Updates the specified pool. Request Syntax { "ApplicationSettings": { "SettingsGroup": "string", "Status": "string" }, "BundleId": "string", "Capacity": { "DesiredUserSessions": number }, "Description": "string", "DirectoryId": "string", "PoolId": "string", "RunningMode": "string", "TimeoutSettings": { "DisconnectTimeoutInSeconds": number, "IdleDisconnectTimeoutInSeconds": number, "MaxUserDurationInSeconds": number } } Request Parameters The request accepts the following data in JSON format. ApplicationSettings The persistent application settings for users in the pool. Type: ApplicationSettingsRequest object Required: No BundleId The identifier of the bundle. Type: String UpdateWorkspacesPool API Version 2015-04-08 303 Amazon WorkSpaces Service API Reference Pattern: ^wsb-[0-9a-z]{8,63}$ Required: No Capacity The desired capacity for the pool. Type: Capacity object Required: No Description Describes the specified pool to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^[a-zA-Z0-9_./() -]+$ Required: No DirectoryId The identifier of the directory. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: ^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$) Required: No PoolId The identifier of the specified pool to update. Type: String Pattern: ^wspool-[0-9a-z]{9}$ Required: Yes Request Parameters API Version 2015-04-08 304 Amazon WorkSpaces Service RunningMode API Reference The desired running mode for the pool. The running mode can only be updated when the pool is in a stopped state. Type: String Valid Values: AUTO_STOP | ALWAYS_ON Required: No TimeoutSettings Indicates the timeout settings of the specified pool. Type: TimeoutSettings object Required: No Response Syntax { "WorkspacesPool": { "ApplicationSettings": { "S3BucketName": "string", "SettingsGroup": "string", "Status": "string" }, "BundleId": "string", "CapacityStatus": { "ActiveUserSessions": number, "ActualUserSessions": number, "AvailableUserSessions": number, "DesiredUserSessions": number }, "CreatedAt": number, "Description": "string", "DirectoryId": "string", "Errors": [ { "ErrorCode": "string", "ErrorMessage": "string" } ], Response Syntax API Version 2015-04-08 305 Amazon WorkSpaces Service API Reference "PoolArn": "string", "PoolId": "string", "PoolName": "string", "RunningMode": "string", "State": "string", "TimeoutSettings": { "DisconnectTimeoutInSeconds": number, "IdleDisconnectTimeoutInSeconds": number, "MaxUserDurationInSeconds": number } } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. WorkspacesPool Describes the specified pool. Type: WorkspacesPool object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The user is not authorized to access a resource. HTTP Status Code: 400 InvalidParameterValuesException One or more parameter values are not valid. HTTP Status Code: 400 InvalidResourceStateException The state of the resource is not valid for this operation. Response Elements API Version 2015-04-08 306 Amazon WorkSpaces Service HTTP Status Code: 400 OperationInProgressException API Reference The properties of this WorkSpace are currently being modified. Try again in a moment. HTTP Status Code: 400 OperationNotSupportedException This operation is not supported. HTTP Status Code: 400 ResourceLimitExceededException Your resource limits have been exceeded. HTTP Status Code: 400 ResourceNotFoundException The resource could not be found. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2015-04-08 307 Amazon WorkSpaces Service Data Types API Reference The Amazon WorkSpaces API contains several data types that various actions use. This section describes each data type in detail. Note The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order. The following data types are supported: • AccountLink • AccountModification • ActiveDirectoryConfig • ApplicationResourceAssociation • ApplicationSettingsRequest • ApplicationSettingsResponse • AssociationStateReason • BundleResourceAssociation • Capacity • CapacityStatus • CertificateBasedAuthProperties • ClientProperties • ClientPropertiesResult • |
workspaces-api-053 | workspaces-api.pdf | 53 | PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2015-04-08 307 Amazon WorkSpaces Service Data Types API Reference The Amazon WorkSpaces API contains several data types that various actions use. This section describes each data type in detail. Note The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order. The following data types are supported: • AccountLink • AccountModification • ActiveDirectoryConfig • ApplicationResourceAssociation • ApplicationSettingsRequest • ApplicationSettingsResponse • AssociationStateReason • BundleResourceAssociation • Capacity • CapacityStatus • CertificateBasedAuthProperties • ClientProperties • ClientPropertiesResult • ComputeType • ConnectClientAddIn • ConnectionAlias • ConnectionAliasAssociation • ConnectionAliasPermission • DataReplicationSettings • DefaultClientBrandingAttributes API Version 2015-04-08 308 Amazon WorkSpaces Service API Reference • DefaultImportClientBrandingAttributes • DefaultWorkspaceCreationProperties • DescribeWorkspaceDirectoriesFilter • DescribeWorkspacesPoolsFilter • ErrorDetails • FailedCreateStandbyWorkspacesRequest • FailedCreateWorkspaceRequest • FailedWorkspaceChangeRequest • GlobalAcceleratorForDirectory • GlobalAcceleratorForWorkSpace • IDCConfig • ImagePermission • ImageResourceAssociation • IosClientBrandingAttributes • IosImportClientBrandingAttributes • IpRuleItem • MicrosoftEntraConfig • ModificationState • NetworkAccessConfiguration • OperatingSystem • PendingCreateStandbyWorkspacesRequest • RebootRequest • RebuildRequest • RelatedWorkspaceProperties • RootStorage • SamlProperties • SelfservicePermissions • Snapshot • StandbyWorkspace • StandbyWorkspacesProperties API Version 2015-04-08 309 Amazon WorkSpaces Service • StartRequest • StopRequest • StorageConnector • StreamingProperties • Tag • TerminateRequest • TimeoutSettings • UpdateResult • UserSetting • UserStorage • Workspace • WorkspaceAccessProperties • WorkSpaceApplication • WorkSpaceApplicationDeployment • WorkspaceBundle • WorkspaceConnectionStatus • WorkspaceCreationProperties • WorkspaceDirectory • WorkspaceImage • WorkspaceProperties • WorkspaceRequest • WorkspaceResourceAssociation • WorkspacesIpGroup • WorkspacesPool • WorkspacesPoolError • WorkspacesPoolSession API Reference API Version 2015-04-08 310 API Reference Amazon WorkSpaces Service AccountLink Information about about the account link. Contents AccountLinkId The identifier of the account link. Type: String Pattern: ^link-.{8,24}$ Required: No AccountLinkStatus The status of the account link. Type: String Valid Values: LINKED | LINKING_FAILED | LINK_NOT_FOUND | PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT | REJECTED Required: No SourceAccountId The identifier of the source account. Type: String Pattern: ^\d{12}$ Required: No TargetAccountId The identifier of the target account. Type: String Pattern: ^\d{12}$ AccountLink API Version 2015-04-08 311 Amazon WorkSpaces Service Required: No See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 312 Amazon WorkSpaces Service API Reference AccountModification Describes a modification to the configuration of Bring Your Own License (BYOL) for the specified account. Contents DedicatedTenancyManagementCidrRange The IP address range, specified as an IPv4 CIDR block, for the management network interface used for the account. Type: String Pattern: (^([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9] [0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.0\.0)(\/(16$))$ Required: No DedicatedTenancySupport The status of BYOL (whether BYOL is being enabled or disabled). Type: String Valid Values: ENABLED | DISABLED Required: No ErrorCode The error code that is returned if the configuration of BYOL cannot be modified. Type: String Required: No ErrorMessage The text of the error message that is returned if the configuration of BYOL cannot be modified. Type: String Required: No AccountModification API Version 2015-04-08 313 Amazon WorkSpaces Service ModificationState API Reference The state of the modification to the configuration of BYOL. Type: String Valid Values: PENDING | COMPLETED | FAILED Required: No StartTime The timestamp when the modification of the BYOL configuration was started. Type: Timestamp Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 314 Amazon WorkSpaces Service API Reference ActiveDirectoryConfig Information about the Active Directory config. Contents DomainName The name of the domain. Type: String Pattern: ^([a-zA-Z0-9]+[.-])+([a-zA-Z0-9])+$ Required: Yes ServiceAccountSecretArn Indicates the secret ARN on the service account. Type: String Pattern: ^arn:aws[a-z-]{0,7}:secretsmanager:[A-za-z0-9_/.-]{0,63}:[A-za- z0-9_/.-]{0,63}:secret:[A-Za-z0-9][A-za-z0-9_/.-]{8,519}$ Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ActiveDirectoryConfig API Version 2015-04-08 315 Amazon WorkSpaces Service API Reference ApplicationResourceAssociation Describes the association between an application and an application resource. Contents ApplicationId The identifier of the application. Type: String Pattern: ^wsa-[0-9a-z]{8,63}$ Required: No AssociatedResourceId The identifier of the associated resource. Type: String Length Constraints: Minimum length of 1. Required: No AssociatedResourceType The resource type of the associated resource. Type: String Valid Values: WORKSPACE | BUNDLE | IMAGE Required: No Created The time the association was created. Type: Timestamp Required: No LastUpdatedTime The time the association status was last updated. ApplicationResourceAssociation API Version 2015-04-08 316 Amazon WorkSpaces Service Type: Timestamp Required: No State API Reference The status of the application resource association. Type: String Valid Values: PENDING_INSTALL | PENDING_INSTALL_DEPLOYMENT | PENDING_UNINSTALL | PENDING_UNINSTALL_DEPLOYMENT | INSTALLING | UNINSTALLING | ERROR | COMPLETED | REMOVED Required: No StateReason The reason the association deployment failed. Type: AssociationStateReason object Required: No See |
workspaces-api-054 | workspaces-api.pdf | 54 | 1. Required: No AssociatedResourceType The resource type of the associated resource. Type: String Valid Values: WORKSPACE | BUNDLE | IMAGE Required: No Created The time the association was created. Type: Timestamp Required: No LastUpdatedTime The time the association status was last updated. ApplicationResourceAssociation API Version 2015-04-08 316 Amazon WorkSpaces Service Type: Timestamp Required: No State API Reference The status of the application resource association. Type: String Valid Values: PENDING_INSTALL | PENDING_INSTALL_DEPLOYMENT | PENDING_UNINSTALL | PENDING_UNINSTALL_DEPLOYMENT | INSTALLING | UNINSTALLING | ERROR | COMPLETED | REMOVED Required: No StateReason The reason the association deployment failed. Type: AssociationStateReason object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 317 Amazon WorkSpaces Service API Reference ApplicationSettingsRequest The persistent application settings for WorkSpaces Pools users. Contents Status Enables or disables persistent application settings for users during their pool sessions. Type: String Valid Values: DISABLED | ENABLED Required: Yes SettingsGroup 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. Type: String Length Constraints: Maximum length of 100. Pattern: ^[A-Za-z0-9_./()!*'-]+$ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ApplicationSettingsRequest API Version 2015-04-08 318 Amazon WorkSpaces Service API Reference ApplicationSettingsResponse Describes the persistent application settings for WorkSpaces Pools users. Contents Status Specifies whether persistent application settings are enabled for users during their pool sessions. Type: String Valid Values: DISABLED | ENABLED Required: Yes S3BucketName 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 AWS Region, an S3 bucket is created. The bucket is unique to the AWS account and the Region. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: ^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$ Required: No SettingsGroup The path prefix for the S3 bucket where users’ persistent application settings are stored. Type: String Length Constraints: Maximum length of 100. Pattern: ^[A-Za-z0-9_./()!*'-]+$ Required: No ApplicationSettingsResponse API Version 2015-04-08 319 Amazon WorkSpaces Service See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 320 Amazon WorkSpaces Service API Reference AssociationStateReason Indicates the reason that the association deployment failed, including the error code and error message. Contents ErrorCode The error code of the association deployment failure. Type: String Valid Values: ValidationError.InsufficientDiskSpace | ValidationError.InsufficientMemory | ValidationError.UnsupportedOperatingSystem | DeploymentError.InternalServerError | DeploymentError.WorkspaceUnreachable Required: No ErrorMessage The error message of the association deployment failure. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AssociationStateReason API Version 2015-04-08 321 Amazon WorkSpaces Service API Reference BundleResourceAssociation Describes the association between an application and a bundle resource. Contents AssociatedResourceId The identifier of the associated resource. Type: String Length Constraints: Minimum length of 1. Required: No AssociatedResourceType The resource type of the associated resources. Type: String Valid Values: APPLICATION Required: No BundleId The identifier of the bundle. Type: String Pattern: ^wsb-[0-9a-z]{8,63}$ Required: No Created The time the association is created. Type: Timestamp Required: No LastUpdatedTime The time the association status was last updated. BundleResourceAssociation API Version 2015-04-08 322 Amazon WorkSpaces Service Type: Timestamp Required: No State API Reference The status of the bundle resource association. Type: String Valid Values: PENDING_INSTALL | PENDING_INSTALL_DEPLOYMENT | PENDING_UNINSTALL | PENDING_UNINSTALL_DEPLOYMENT | INSTALLING | UNINSTALLING | ERROR | COMPLETED | REMOVED Required: No StateReason The reason the association deployment failed. Type: AssociationStateReason object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 323 Amazon WorkSpaces Service Capacity Describes the user capacity for a pool of WorkSpaces. Contents DesiredUserSessions The desired number of user sessions for the WorkSpaces in the pool. API Reference Type: Integer Valid Range: Minimum value of 0. Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ |
workspaces-api-055 | workspaces-api.pdf | 55 | about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 323 Amazon WorkSpaces Service Capacity Describes the user capacity for a pool of WorkSpaces. Contents DesiredUserSessions The desired number of user sessions for the WorkSpaces in the pool. API Reference Type: Integer Valid Range: Minimum value of 0. Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Capacity API Version 2015-04-08 324 API Reference Amazon WorkSpaces Service CapacityStatus Describes the capacity status for a pool of WorkSpaces. Contents ActiveUserSessions The number of user sessions currently being used for your pool. Type: Integer Valid Range: Minimum value of 0. Required: Yes ActualUserSessions The total number of user sessions that are available for streaming or are currently streaming in your pool. ActualUserSessions = AvailableUserSessions + ActiveUserSessions Type: Integer Valid Range: Minimum value of 0. Required: Yes AvailableUserSessions The number of user sessions currently available for streaming from your pool. AvailableUserSessions = ActualUserSessions - ActiveUserSessions Type: Integer Valid Range: Minimum value of 0. Required: Yes DesiredUserSessions 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. CapacityStatus API Version 2015-04-08 325 Amazon WorkSpaces Service Type: Integer Valid Range: Minimum value of 0. Required: Yes See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 326 Amazon WorkSpaces Service API Reference CertificateBasedAuthProperties Describes the properties of the certificate-based authentication you want to use with your WorkSpaces. Contents CertificateAuthorityArn The Amazon Resource Name (ARN) of the AWS Certificate Manager Private CA resource. Type: String Length Constraints: Minimum length of 5. Maximum length of 200. Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:[\w+=/,.@-]*:[0-9]*:[\w+=,.@-]+(/[\w +=,.@-]+)* Required: No Status The status of the certificate-based authentication properties. Type: String Valid Values: DISABLED | ENABLED Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CertificateBasedAuthProperties API Version 2015-04-08 327 Amazon WorkSpaces Service ClientProperties Describes an Amazon WorkSpaces client. Contents LogUploadEnabled API Reference 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. Type: String Valid Values: ENABLED | DISABLED Required: No 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. Type: String Valid Values: ENABLED | DISABLED Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ClientProperties API Version 2015-04-08 328 Amazon WorkSpaces Service API Reference ClientPropertiesResult Information about the Amazon WorkSpaces client. Contents ClientProperties Information about the Amazon WorkSpaces client. Type: ClientProperties object Required: No ResourceId The resource identifier, in the form of a directory ID. Type: String Length Constraints: Minimum length of 1. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ClientPropertiesResult API Version 2015-04-08 329 API Reference Amazon WorkSpaces Service ComputeType Describes the compute type of the bundle. Contents Name The compute type. Type: String Valid Values: VALUE | STANDARD | PERFORMANCE | POWER | GRAPHICS | POWERPRO | GENERALPURPOSE_4XLARGE | GENERALPURPOSE_8XLARGE | GRAPHICSPRO | GRAPHICS_G4DN | GRAPHICSPRO_G4DN Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ComputeType API Version 2015-04-08 330 Amazon WorkSpaces Service API Reference ConnectClientAddIn Describes an Amazon Connect client add-in. Contents AddInId The client add-in identifier. Type: String Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: No Name The name of the client add in. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^.*$ Required: No ResourceId The directory identifier for which the client add-in is |
workspaces-api-056 | workspaces-api.pdf | 56 | about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ComputeType API Version 2015-04-08 330 Amazon WorkSpaces Service API Reference ConnectClientAddIn Describes an Amazon Connect client add-in. Contents AddInId The client add-in identifier. Type: String Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: No Name The name of the client add in. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^.*$ Required: No ResourceId The directory identifier for which the client add-in is configured. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: ^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$) Required: No URL The endpoint URL of the client add-in. ConnectClientAddIn API Version 2015-04-08 331 Amazon WorkSpaces Service Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: ^(http|https)\://\S+ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 332 Amazon WorkSpaces Service ConnectionAlias API Reference Describes a connection alias. Connection aliases are used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces. Contents AliasId The identifier of the connection alias. Type: String Length Constraints: Minimum length of 13. Maximum length of 68. Pattern: ^wsca-[0-9a-z]{8,63}$ Required: No Associations The association status of the connection alias. Type: Array of ConnectionAliasAssociation objects Array Members: Minimum number of 1 item. Maximum number of 25 items. Required: No 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^[.0-9a-zA-Z\-]{1,255}$ Required: No OwnerAccountId The identifier of the AWS account that owns the connection alias. ConnectionAlias API Version 2015-04-08 333 API Reference Amazon WorkSpaces Service Type: String Pattern: ^\d{12}$ Required: No State The current state of the connection alias. Type: String Valid Values: CREATING | CREATED | DELETING Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 334 Amazon WorkSpaces Service API Reference ConnectionAliasAssociation Describes a connection alias association that is used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces. Contents AssociatedAccountId The identifier of the AWS account that associated the connection alias with a directory. Type: String Pattern: ^\d{12}$ Required: No AssociationStatus The association status of the connection alias. Type: String Valid Values: NOT_ASSOCIATED | ASSOCIATED_WITH_OWNER_ACCOUNT | ASSOCIATED_WITH_SHARED_ACCOUNT | PENDING_ASSOCIATION | PENDING_DISASSOCIATION Required: No 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: ^[a-zA-Z0-9]+$ Required: No ResourceId The identifier of the directory associated with a connection alias. ConnectionAliasAssociation API Version 2015-04-08 335 Amazon WorkSpaces Service Type: String Length Constraints: Minimum length of 1. Required: No See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 336 Amazon WorkSpaces Service API Reference ConnectionAliasPermission Describes the permissions for a connection alias. Connection aliases are used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces. Contents AllowAssociation Indicates whether the specified AWS account is allowed to associate the connection alias with a directory. Type: Boolean Required: Yes SharedAccountId The identifier of the AWS account that the connection alias is shared with. Type: String Pattern: ^\d{12}$ Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ConnectionAliasPermission API Version 2015-04-08 337 Amazon WorkSpaces Service API Reference DataReplicationSettings Describes the data replication settings. Contents DataReplication Indicates whether data replication is enabled, and if enabled, the type of data replication. Type: String Valid Values: NO_REPLICATION | PRIMARY_AS_SOURCE Required: No RecoverySnapshotTime The date and time at which the last successful snapshot was taken of the primary WorkSpace used for replicating data. Type: Timestamp Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DataReplicationSettings API Version 2015-04-08 |
workspaces-api-057 | workspaces-api.pdf | 57 | WorkSpaces Service API Reference DataReplicationSettings Describes the data replication settings. Contents DataReplication Indicates whether data replication is enabled, and if enabled, the type of data replication. Type: String Valid Values: NO_REPLICATION | PRIMARY_AS_SOURCE Required: No RecoverySnapshotTime The date and time at which the last successful snapshot was taken of the primary WorkSpace used for replicating data. Type: Timestamp Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DataReplicationSettings API Version 2015-04-08 338 Amazon WorkSpaces Service API Reference DefaultClientBrandingAttributes Returns default client branding attributes that were imported. These attributes display on the client login screen. Important Client branding attributes are public facing. Ensure that you don't include sensitive information. Contents ForgotPasswordLink The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^(http|https)\://\S+ Required: No 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. Type: String to string map Key Length Constraints: Fixed length of 5. Key Pattern: ^[a-z]{2}_[A-Z]{2}$ Value Length Constraints: Minimum length of 0. Maximum length of 2000. Value Pattern: ^.*$ DefaultClientBrandingAttributes API Version 2015-04-08 339 Amazon WorkSpaces Service Required: No LogoUrl API Reference The logo. The only image format accepted is a binary data object that is converted from a .png file. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^(http|https)\://\S+ Required: No SupportEmail The support email. The company's customer support email address. Note • 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 workspaces-feedback@amazon.com. Type: String Length Constraints: Minimum length of 6. Maximum length of 64. Pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,4}$ Required: No SupportLink The support link. The link for the company's customer support page for their WorkSpace. Note • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both. Contents API Version 2015-04-08 340 Amazon WorkSpaces Service API Reference • The default support link is workspaces-feedback@amazon.com. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^(http|https)\://\S+ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 341 Amazon WorkSpaces Service API Reference DefaultImportClientBrandingAttributes The default client branding attributes to be imported. These attributes display on the client login screen. Important Client branding attributes are public facing. Ensure that you do not include sensitive information. Contents ForgotPasswordLink The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^(http|https)\://\S+ Required: No 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. Type: String to string map Key Length Constraints: Fixed length of 5. Key Pattern: ^[a-z]{2}_[A-Z]{2}$ Value Length Constraints: Minimum length of 0. Maximum length of 2000. Value Pattern: ^.*$ DefaultImportClientBrandingAttributes API Version 2015-04-08 342 Amazon WorkSpaces Service Required: No Logo API Reference The logo. The only image format accepted is a binary data object that is converted from a .png file. Type: Base64-encoded binary data object Length Constraints: Minimum length of 1. Maximum length of 1500000. Required: No SupportEmail The support email. The company's customer support email address. Note • 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 workspaces-feedback@amazon.com. Type: String Length Constraints: Minimum length of 6. Maximum length of 64. Pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,4}$ Required: No SupportLink The support link. The link for the company's customer support page for their WorkSpace. Note • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You |
workspaces-api-058 | workspaces-api.pdf | 58 | Length Constraints: Minimum length of 1. Maximum length of 1500000. Required: No SupportEmail The support email. The company's customer support email address. Note • 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 workspaces-feedback@amazon.com. Type: String Length Constraints: Minimum length of 6. Maximum length of 64. Pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,4}$ Required: No SupportLink The support link. The link for the company's customer support page for their WorkSpace. Note • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both. Contents API Version 2015-04-08 343 Amazon WorkSpaces Service API Reference • The default support link is workspaces-feedback@amazon.com. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^(http|https)\://\S+ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 344 Amazon WorkSpaces Service API Reference DefaultWorkspaceCreationProperties Describes the default values that are used to create WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces. Contents 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. Type: String Length Constraints: Minimum length of 11. Maximum length of 20. Pattern: ^(sg-([0-9a-f]{8}|[0-9a-f]{17}))$ Required: No DefaultOu The organizational unit (OU) in the directory for the WorkSpace machine accounts. Type: String Required: No 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. Type: Boolean Required: No DefaultWorkspaceCreationProperties API Version 2015-04-08 345 Amazon WorkSpaces Service EnableMaintenanceMode API Reference Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see WorkSpace Maintenance. Type: Boolean Required: No InstanceIamRoleArn Indicates the IAM role ARN of the instance. Type: String Pattern: ^arn:aws[a-z-]{0,7}:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za- z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\-] {0,1023}$ Required: No UserEnabledAsLocalAdministrator Specifies whether WorkSpace users are local administrators on their WorkSpaces. Type: Boolean Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 346 Amazon WorkSpaces Service API Reference DescribeWorkspaceDirectoriesFilter Describes the filter conditions for the WorkSpaces to return. Contents Name The name of the WorkSpaces to filter. Type: String Valid Values: USER_IDENTITY_TYPE | WORKSPACE_TYPE Required: Yes Values The values for filtering WorkSpaces Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 25 items. Pattern: ^[0-9a-zA-Z\*\.\\/\?-_]{0,64}$ Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DescribeWorkspaceDirectoriesFilter API Version 2015-04-08 347 Amazon WorkSpaces Service API Reference DescribeWorkspacesPoolsFilter Describes the filter conditions for WorkSpaces Pools to return. Contents Name The name of the pool to filter. Type: String Valid Values: PoolName Required: Yes Operator The operator values for filtering WorkSpaces Pools. Type: String Valid Values: EQUALS | NOTEQUALS | CONTAINS | NOTCONTAINS Required: Yes Values The values for filtering WorkSpaces Pools. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 25 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[A-Za-z0-9][A-Za-z0-9_.-]+$ Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: DescribeWorkspacesPoolsFilter API Version 2015-04-08 348 Amazon WorkSpaces Service • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2015-04-08 349 Amazon WorkSpaces Service ErrorDetails API Reference Describes in-depth details about the error. These details include the possible causes of the error and troubleshooting information. Contents ErrorCode Indicates the error code returned. Type: String Valid Values: OutdatedPowershellVersion | OfficeInstalled | PCoIPAgentInstalled | WindowsUpdatesEnabled | AutoMountDisabled | WorkspacesBYOLAccountNotFound | WorkspacesBYOLAccountDisabled | DHCPDisabled | DiskFreeSpace | AdditionalDrivesAttached | OSNotSupported | DomainJoined | AzureDomainJoined | FirewallEnabled | VMWareToolsInstalled | DiskSizeExceeded | IncompatiblePartitioning | PendingReboot |
workspaces-api-059 | workspaces-api.pdf | 59 | 2015-04-08 348 Amazon WorkSpaces Service • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2015-04-08 349 Amazon WorkSpaces Service ErrorDetails API Reference Describes in-depth details about the error. These details include the possible causes of the error and troubleshooting information. Contents ErrorCode Indicates the error code returned. Type: String Valid Values: 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 Required: No ErrorMessage The text of the error message related the error code. Type: String ErrorDetails API Version 2015-04-08 350 Amazon WorkSpaces Service Required: No See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 351 Amazon WorkSpaces Service API Reference FailedCreateStandbyWorkspacesRequest Describes the standby WorkSpace that could not be created. Contents ErrorCode The error code that is returned if the standby WorkSpace could not be created. Type: String Required: No ErrorMessage The text of the error message that is returned if the standby WorkSpace could not be created. Type: String Required: No StandbyWorkspaceRequest Information about the standby WorkSpace that could not be created. Type: StandbyWorkspace object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 FailedCreateStandbyWorkspacesRequest API Version 2015-04-08 352 Amazon WorkSpaces Service API Reference FailedCreateWorkspaceRequest Describes a WorkSpace that cannot be created. Contents ErrorCode The error code that is returned if the WorkSpace cannot be created. Type: String Required: No ErrorMessage The text of the error message that is returned if the WorkSpace cannot be created. Type: String Required: No WorkspaceRequest Information about the WorkSpace. Type: WorkspaceRequest object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 FailedCreateWorkspaceRequest API Version 2015-04-08 353 Amazon WorkSpaces Service API Reference FailedWorkspaceChangeRequest Describes a WorkSpace that could not be rebooted. (RebootWorkspaces), rebuilt (RebuildWorkspaces), restored (RestoreWorkspace), terminated (TerminateWorkspaces), started (StartWorkspaces), or stopped (StopWorkspaces). Contents ErrorCode The error code that is returned if the WorkSpace cannot be rebooted. Type: String Required: No ErrorMessage The text of the error message that is returned if the WorkSpace cannot be rebooted. Type: String Required: No WorkspaceId The identifier of the WorkSpace. Type: String Pattern: ^ws-[0-9a-z]{8,63}$ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 FailedWorkspaceChangeRequest API Version 2015-04-08 354 Amazon WorkSpaces Service API Reference See Also API Version 2015-04-08 355 Amazon WorkSpaces Service API Reference GlobalAcceleratorForDirectory Describes the Global Accelerator for directory Contents Mode Indicates if Global Accelerator for directory is enabled or disabled. Type: String Valid Values: ENABLED_AUTO | DISABLED Required: Yes PreferredProtocol Indicates the preferred protocol for Global Accelerator. Type: String Valid Values: TCP | NONE Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 GlobalAcceleratorForDirectory API Version 2015-04-08 356 Amazon WorkSpaces Service API Reference GlobalAcceleratorForWorkSpace Describes the Global Accelerator for WorkSpaces. Contents Mode Indicates if Global Accelerator for WorkSpaces is enabled, disabled, or the same mode as the associated directory. Type: String Valid Values: ENABLED_AUTO | DISABLED | INHERITED Required: Yes PreferredProtocol Indicates the preferred protocol for Global Accelerator. Type: String Valid Values: TCP | NONE | INHERITED Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 GlobalAcceleratorForWorkSpace API Version 2015-04-08 357 API Reference Amazon WorkSpaces Service IDCConfig Specifies the configurations of the identity center. Contents ApplicationArn The Amazon Resource Name (ARN) of the application. Type: String Pattern: ^arn:aws[a-z-]{0,7}:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za- z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\-] {0,1023}$ Required: No InstanceArn The Amazon |
workspaces-api-060 | workspaces-api.pdf | 60 | | DISABLED | INHERITED Required: Yes PreferredProtocol Indicates the preferred protocol for Global Accelerator. Type: String Valid Values: TCP | NONE | INHERITED Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 GlobalAcceleratorForWorkSpace API Version 2015-04-08 357 API Reference Amazon WorkSpaces Service IDCConfig Specifies the configurations of the identity center. Contents ApplicationArn The Amazon Resource Name (ARN) of the application. Type: String Pattern: ^arn:aws[a-z-]{0,7}:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za- z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\-] {0,1023}$ Required: No InstanceArn The Amazon Resource Name (ARN) of the identity center instance. Type: String Pattern: ^arn:aws[a-z-]{0,7}:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za- z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\-] {0,1023}$ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 IDCConfig API Version 2015-04-08 358 Amazon WorkSpaces Service ImagePermission API Reference Describes the AWS accounts that have been granted permission to use a shared image. For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image. Contents SharedAccountId The identifier of the AWS account that an image has been shared with. Type: String Pattern: ^\d{12}$ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ImagePermission API Version 2015-04-08 359 Amazon WorkSpaces Service API Reference ImageResourceAssociation Describes the association between an application and an image resource. Contents AssociatedResourceId The identifier of the associated resource. Type: String Length Constraints: Minimum length of 1. Required: No AssociatedResourceType The resource type of the associated resources. Type: String Valid Values: APPLICATION Required: No Created The time the association is created. Type: Timestamp Required: No ImageId The identifier of the image. Type: String Pattern: wsi-[0-9a-z]{9,63}$ Required: No LastUpdatedTime The time the association status was last updated. ImageResourceAssociation API Version 2015-04-08 360 Amazon WorkSpaces Service Type: Timestamp Required: No State API Reference The status of the image resource association. Type: String Valid Values: PENDING_INSTALL | PENDING_INSTALL_DEPLOYMENT | PENDING_UNINSTALL | PENDING_UNINSTALL_DEPLOYMENT | INSTALLING | UNINSTALLING | ERROR | COMPLETED | REMOVED Required: No StateReason The reason the association deployment failed. Type: AssociationStateReason object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 361 Amazon WorkSpaces Service API Reference IosClientBrandingAttributes The client branding attributes for iOS device types. These attributes are displayed on the iOS client login screen only. Important Client branding attributes are public facing. Ensure you do not include sensitive information. Contents ForgotPasswordLink The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^(http|https)\://\S+ Required: No 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. Type: String to string map Key Length Constraints: Fixed length of 5. Key Pattern: ^[a-z]{2}_[A-Z]{2}$ Value Length Constraints: Minimum length of 0. Maximum length of 2000. Value Pattern: ^.*$ IosClientBrandingAttributes API Version 2015-04-08 362 Amazon WorkSpaces Service Required: No Logo2xUrl API Reference 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. Note For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^(http|https)\://\S+ Required: No 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. Note For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^(http|https)\://\S+ Required: No Contents API Version 2015-04-08 363 Amazon WorkSpaces Service LogoUrl API Reference The logo. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal |
workspaces-api-061 | workspaces-api.pdf | 61 | 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. Note For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^(http|https)\://\S+ Required: No Contents API Version 2015-04-08 363 Amazon WorkSpaces Service LogoUrl API Reference 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^(http|https)\://\S+ Required: No SupportEmail The support email. The company's customer support email address. Note • 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 workspaces-feedback@amazon.com. Type: String Length Constraints: Minimum length of 6. Maximum length of 64. Pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,4}$ Required: No SupportLink The support link. The link for the company's customer support page for their WorkSpace. Note • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both. Contents API Version 2015-04-08 364 Amazon WorkSpaces Service API Reference • The default support link is workspaces-feedback@amazon.com. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^(http|https)\://\S+ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 365 Amazon WorkSpaces Service API Reference IosImportClientBrandingAttributes The client branding attributes to import for iOS device types. These attributes are displayed on the iOS client login screen. Important Client branding attributes are public facing. Ensure you do not include sensitive information. Contents ForgotPasswordLink The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^(http|https)\://\S+ Required: No 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. Type: String to string map Key Length Constraints: Fixed length of 5. Key Pattern: ^[a-z]{2}_[A-Z]{2}$ Value Length Constraints: Minimum length of 0. Maximum length of 2000. Value Pattern: ^.*$ IosImportClientBrandingAttributes API Version 2015-04-08 366 Amazon WorkSpaces Service Required: No Logo API Reference 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. Type: Base64-encoded binary data object Length Constraints: Minimum length of 1. Maximum length of 447000. Required: No 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. Note For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines. Type: Base64-encoded binary data object Length Constraints: Minimum length of 1. Maximum length of 1770000. Required: No 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. Note For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines. Contents API Version 2015-04-08 367 Amazon WorkSpaces Service API Reference Type: Base64-encoded binary data object Length Constraints: Minimum length of 1. Maximum length of 1770000. Required: No SupportEmail The support email. The company's customer support email address. Note • 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 workspaces-feedback@amazon.com. Type: String Length Constraints: Minimum length of 6. Maximum length of 64. Pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,4}$ Required: No SupportLink The support link. The link for the company's customer support page for their WorkSpace. Note • In each platform type, the SupportEmail and |
workspaces-api-062 | workspaces-api.pdf | 62 | Reference Type: Base64-encoded binary data object Length Constraints: Minimum length of 1. Maximum length of 1770000. Required: No SupportEmail The support email. The company's customer support email address. Note • 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 workspaces-feedback@amazon.com. Type: String Length Constraints: Minimum length of 6. Maximum length of 64. Pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,4}$ Required: No SupportLink The support link. The link for the company's customer support page for their WorkSpace. Note • 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 workspaces-feedback@amazon.com. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Contents API Version 2015-04-08 368 Amazon WorkSpaces Service API Reference Pattern: ^(http|https)\://\S+ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 369 API Reference Amazon WorkSpaces Service IpRuleItem Describes a rule for an IP access control group. Contents ipRule The IP address range, in CIDR notation. Type: String Required: No ruleDesc The description. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 IpRuleItem API Version 2015-04-08 370 Amazon WorkSpaces Service API Reference MicrosoftEntraConfig Specifies the configurations of the Microsoft Entra. Contents ApplicationConfigSecretArn The Amazon Resource Name (ARN) of the application config. Type: String Pattern: ^arn:aws[a-z-]{0,7}:secretsmanager:[A-za-z0-9_/.-]{0,63}:[A-za- z0-9_/.-]{0,63}:secret:[A-Za-z0-9][A-za-z0-9_/.-]{8,519}$ Required: No TenantId The identifier of the tenant. Type: String Pattern: ^[a-zA-Z0-9-]{1,100}$ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MicrosoftEntraConfig API Version 2015-04-08 371 API Reference Amazon WorkSpaces Service ModificationState Describes a WorkSpace modification. Contents Resource The resource. Type: String Valid Values: ROOT_VOLUME | USER_VOLUME | COMPUTE_TYPE Required: No State The modification state. Type: String Valid Values: UPDATE_INITIATED | UPDATE_IN_PROGRESS Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ModificationState API Version 2015-04-08 372 Amazon WorkSpaces Service API Reference NetworkAccessConfiguration Describes the network details of a WorkSpaces Pool. Contents EniId The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier. Type: String Length Constraints: Minimum length of 1. Required: No EniPrivateIpAddress The private IP address of the elastic network interface that is attached to instances in your VPC. Type: String Length Constraints: Minimum length of 1. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 NetworkAccessConfiguration API Version 2015-04-08 373 API Reference Amazon WorkSpaces Service OperatingSystem The operating system that the image is running. Contents Type The operating system. Type: String Valid Values: WINDOWS | LINUX Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 OperatingSystem API Version 2015-04-08 374 Amazon WorkSpaces Service API Reference PendingCreateStandbyWorkspacesRequest Information about the standby WorkSpace. Contents DirectoryId The identifier of the directory for the standby WorkSpace. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: ^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$) Required: No State The operational state of the standby WorkSpace. Type: String Valid Values: PENDING | AVAILABLE | IMPAIRED | UNHEALTHY | REBOOTING | STARTING | REBUILDING | RESTORING | MAINTENANCE | ADMIN_MAINTENANCE | TERMINATING | TERMINATED | SUSPENDED | UPDATING | STOPPING | STOPPED | ERROR Required: No 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Required: No PendingCreateStandbyWorkspacesRequest API Version 2015-04-08 375 API Reference Amazon WorkSpaces Service WorkspaceId The identifier of the standby WorkSpace. Type: String Pattern: ^ws-[0-9a-z]{8,63}$ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see |
workspaces-api-063 | workspaces-api.pdf | 63 | | ERROR Required: No 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Required: No PendingCreateStandbyWorkspacesRequest API Version 2015-04-08 375 API Reference Amazon WorkSpaces Service WorkspaceId The identifier of the standby WorkSpace. Type: String Pattern: ^ws-[0-9a-z]{8,63}$ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 376 Amazon WorkSpaces Service RebootRequest Describes the information used to reboot a WorkSpace. API Reference Contents WorkspaceId The identifier of the WorkSpace. Type: String Pattern: ^ws-[0-9a-z]{8,63}$ Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RebootRequest API Version 2015-04-08 377 Amazon WorkSpaces Service RebuildRequest Describes the information used to rebuild a WorkSpace. API Reference Contents WorkspaceId The identifier of the WorkSpace. Type: String Pattern: ^ws-[0-9a-z]{8,63}$ Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RebuildRequest API Version 2015-04-08 378 Amazon WorkSpaces Service API Reference RelatedWorkspaceProperties Describes the related WorkSpace. The related WorkSpace could be a standby WorkSpace or primary WorkSpace related to the specified WorkSpace. Contents Region The Region of the related WorkSpace. Type: String Length Constraints: Minimum length of 1. Maximum length of 31. Pattern: ^[-0-9a-z]{1,31}$ Required: No State Indicates the state of the WorkSpace. Type: String Valid Values: PENDING | AVAILABLE | IMPAIRED | UNHEALTHY | REBOOTING | STARTING | REBUILDING | RESTORING | MAINTENANCE | ADMIN_MAINTENANCE | TERMINATING | TERMINATED | SUSPENDED | UPDATING | STOPPING | STOPPED | ERROR Required: No Type Indicates the type of WorkSpace. Type: String Valid Values: PRIMARY | STANDBY Required: No WorkspaceId The identifier of the related WorkSpace. RelatedWorkspaceProperties API Version 2015-04-08 379 Amazon WorkSpaces Service Type: String Pattern: ^ws-[0-9a-z]{8,63}$ Required: No See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 380 API Reference Amazon WorkSpaces Service RootStorage Describes the root volume for a WorkSpace bundle. Contents Capacity The size of the root volume. Type: String Length Constraints: Minimum length of 1. Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RootStorage API Version 2015-04-08 381 Amazon WorkSpaces Service SamlProperties API Reference 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. Contents 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. Type: String Length Constraints: Minimum length of 1. Required: No 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. Type: String Valid Values: DISABLED | ENABLED | ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK Required: No SamlProperties API Version 2015-04-08 382 Amazon WorkSpaces Service UserAccessUrl API Reference 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 |
workspaces-api-064 | workspaces-api.pdf | 64 | 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. Type: String Valid Values: DISABLED | ENABLED | ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK Required: No SamlProperties API Version 2015-04-08 382 Amazon WorkSpaces Service UserAccessUrl API Reference 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. Type: String Length Constraints: Minimum length of 8. Maximum length of 200. Pattern: ^(http|https)\://\S+$ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 383 Amazon WorkSpaces Service API Reference SelfservicePermissions Describes the self-service permissions for a directory. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users. Contents ChangeComputeType Specifies whether users can change the compute type (bundle) for their WorkSpace. Type: String Valid Values: ENABLED | DISABLED Required: No IncreaseVolumeSize Specifies whether users can increase the volume size of the drives on their WorkSpace. Type: String Valid Values: ENABLED | DISABLED Required: No RebuildWorkspace Specifies whether users can rebuild the operating system of a WorkSpace to its original state. Type: String Valid Values: ENABLED | DISABLED Required: No RestartWorkspace Specifies whether users can restart their WorkSpace. Type: String Valid Values: ENABLED | DISABLED SelfservicePermissions API Version 2015-04-08 384 Amazon WorkSpaces Service Required: No SwitchRunningMode API Reference Specifies whether users can switch the running mode of their WorkSpace. Type: String Valid Values: ENABLED | DISABLED Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 385 API Reference Amazon WorkSpaces Service Snapshot Describes a snapshot. Contents SnapshotTime The time when the snapshot was created. Type: Timestamp Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Snapshot API Version 2015-04-08 386 API Reference Amazon WorkSpaces Service StandbyWorkspace Describes a standby WorkSpace. Contents DirectoryId The identifier of the directory for the standby WorkSpace. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: ^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$) Required: Yes PrimaryWorkspaceId The identifier of the standby WorkSpace. Type: String Pattern: ^ws-[0-9a-z]{8,63}$ Required: Yes DataReplication Indicates whether data replication is enabled, and if enabled, the type of data replication. Type: String Valid Values: NO_REPLICATION | PRIMARY_AS_SOURCE Required: No Tags The tags associated with the standby WorkSpace. Type: Array of Tag objects Required: No StandbyWorkspace API Version 2015-04-08 387 Amazon WorkSpaces Service VolumeEncryptionKey The volume encryption key of the standby WorkSpace. API Reference Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 388 Amazon WorkSpaces Service API Reference StandbyWorkspacesProperties Describes the properties of the related standby WorkSpaces. Contents DataReplication Indicates whether data replication is enabled, and if enabled, the type of data replication. Type: String Valid Values: NO_REPLICATION | PRIMARY_AS_SOURCE Required: No RecoverySnapshotTime The date and time at which the last successful snapshot was taken of the primary WorkSpace used for replicating data. Type: Timestamp Required: No StandbyWorkspaceId The identifier of the standby WorkSpace Type: String Pattern: ^ws-[0-9a-z]{8,63}$ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 StandbyWorkspacesProperties API Version 2015-04-08 389 Amazon WorkSpaces Service • AWS SDK for Ruby V3 API Reference See Also API Version 2015-04-08 390 API Reference Amazon WorkSpaces Service StartRequest Information used to start a WorkSpace. Contents WorkspaceId The identifier of the WorkSpace. Type: String Pattern: ^ws-[0-9a-z]{8,63}$ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 StartRequest API Version 2015-04-08 391 Amazon WorkSpaces Service StopRequest Describes the information used to stop a WorkSpace. API Reference Contents WorkspaceId The identifier of the WorkSpace. Type: String Pattern: ^ws-[0-9a-z]{8,63}$ Required: No See Also For |
workspaces-api-065 | workspaces-api.pdf | 65 | API Version 2015-04-08 390 API Reference Amazon WorkSpaces Service StartRequest Information used to start a WorkSpace. Contents WorkspaceId The identifier of the WorkSpace. Type: String Pattern: ^ws-[0-9a-z]{8,63}$ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 StartRequest API Version 2015-04-08 391 Amazon WorkSpaces Service StopRequest Describes the information used to stop a WorkSpace. API Reference Contents WorkspaceId The identifier of the WorkSpace. Type: String Pattern: ^ws-[0-9a-z]{8,63}$ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 StopRequest API Version 2015-04-08 392 API Reference Amazon WorkSpaces Service StorageConnector Describes the storage connector. Contents ConnectorType The type of connector used to save user files. Type: String Valid Values: HOME_FOLDER Required: Yes Status Indicates if the storage connetor is enabled or disabled. Type: String Valid Values: ENABLED | DISABLED Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 StorageConnector API Version 2015-04-08 393 Amazon WorkSpaces Service API Reference StreamingProperties Describes the streaming properties. Contents GlobalAccelerator Indicates the Global Accelerator properties. Type: GlobalAcceleratorForDirectory object Required: No StorageConnectors Indicates the storage connector used Type: Array of StorageConnector objects Array Members: Minimum number of 1 item. Required: No StreamingExperiencePreferredProtocol Indicates the type of preferred protocol for the streaming experience. Type: String Valid Values: TCP | UDP Required: No UserSettings Indicates the permission settings asscoiated with the user. Type: Array of UserSetting objects Array Members: Minimum number of 1 item. Required: No StreamingProperties API Version 2015-04-08 394 Amazon WorkSpaces Service See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 395 Amazon WorkSpaces Service API Reference Tag Describes a tag. Contents Key The key of the tag. Type: String Length Constraints: Minimum length of 1. Maximum length of 127. Required: Yes Value The value of the tag. Type: String Length Constraints: Maximum length of 255. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Tag API Version 2015-04-08 396 Amazon WorkSpaces Service TerminateRequest Describes the information used to terminate a WorkSpace. API Reference Contents WorkspaceId The identifier of the WorkSpace. Type: String Pattern: ^ws-[0-9a-z]{8,63}$ Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TerminateRequest API Version 2015-04-08 397 Amazon WorkSpaces Service TimeoutSettings Describes the timeout settings for a pool of WorkSpaces. Contents DisconnectTimeoutInSeconds API Reference 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. Type: Integer Valid Range: Minimum value of 60. Maximum value of 36000. Required: No IdleDisconnectTimeoutInSeconds The amount of time in seconds a connection will stay active while idle. Type: Integer Valid Range: Minimum value of 0. Maximum value of 36000. Required: No MaxUserDurationInSeconds 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. Type: Integer Valid Range: Minimum value of 600. Maximum value of 432000. Required: No TimeoutSettings API Version 2015-04-08 398 Amazon WorkSpaces Service See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 399 Amazon WorkSpaces Service UpdateResult API Reference Describes whether a WorkSpace image needs to be updated with the latest drivers and other components required by Amazon WorkSpaces. Note Only Windows 10 WorkSpace images can be programmatically updated at this time. Contents Description A description of whether |
workspaces-api-066 | workspaces-api.pdf | 66 | 432000. Required: No TimeoutSettings API Version 2015-04-08 398 Amazon WorkSpaces Service See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 399 Amazon WorkSpaces Service UpdateResult API Reference Describes whether a WorkSpace image needs to be updated with the latest drivers and other components required by Amazon WorkSpaces. Note Only Windows 10 WorkSpace images can be programmatically updated at this time. Contents Description A description of whether updates for the WorkSpace image are pending or available. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^[a-zA-Z0-9_./() -]+$ Required: No UpdateAvailable Indicates whether updated drivers or other components are available for the specified WorkSpace image. Type: Boolean Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 UpdateResult API Version 2015-04-08 400 Amazon WorkSpaces Service • AWS SDK for Ruby V3 API Reference See Also API Version 2015-04-08 401 API Reference Amazon WorkSpaces Service UserSetting Information about the user's permission settings. Contents Action Indicates the type of action. Type: String Valid Values: CLIPBOARD_COPY_FROM_LOCAL_DEVICE | CLIPBOARD_COPY_TO_LOCAL_DEVICE | PRINTING_TO_LOCAL_DEVICE | SMART_CARD Required: Yes Permission Indicates if the setting is enabled or disabled. Type: String Valid Values: ENABLED | DISABLED Required: Yes MaximumLength Indicates the maximum character length for the specified user setting. Type: Integer Valid Range: Minimum value of 0. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ UserSetting API Version 2015-04-08 402 Amazon WorkSpaces Service • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2015-04-08 403 API Reference Amazon WorkSpaces Service UserStorage Describes the user volume for a WorkSpace bundle. Contents Capacity The size of the user volume. Type: String Length Constraints: Minimum length of 1. Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 UserStorage API Version 2015-04-08 404 Amazon WorkSpaces Service Workspace Describes a WorkSpace. Contents BundleId API Reference The identifier of the bundle used to create the WorkSpace. Type: String Pattern: ^wsb-[0-9a-z]{8,63}$ Required: No 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. Type: String Required: No DataReplicationSettings Indicates the settings of the data replication. Type: DataReplicationSettings object Required: No DirectoryId The identifier of the AWS Directory Service directory for the WorkSpace. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: ^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$) Required: No Workspace API Version 2015-04-08 405 Amazon WorkSpaces Service ErrorCode API Reference The error code that is returned if the WorkSpace cannot be created. Type: String Required: No ErrorMessage The text of the error message that is returned if the WorkSpace cannot be created. Type: String Required: No IpAddress The IP address of the WorkSpace. Type: String Required: No ModificationStates The modification states of the WorkSpace. Type: Array of ModificationState objects Required: No RelatedWorkspaces The standby WorkSpace or primary WorkSpace related to the specified WorkSpace. Type: Array of RelatedWorkspaceProperties objects Required: No RootVolumeEncryptionEnabled Indicates whether the data stored on the root volume is encrypted. Type: Boolean Contents API Version 2015-04-08 406 Amazon WorkSpaces Service Required: No StandbyWorkspacesProperties The properties of the standby WorkSpace Type: Array of StandbyWorkspacesProperties objects Required: No State API Reference The operational state of the WorkSpace. • PENDING – The WorkSpace is in a waiting state (for example, the WorkSpace is being created). • AVAILABLE – The WorkSpace is running and has passed the health checks. • IMPAIRED – Refer to UNHEALTHY state. • UNHEALTHY – The WorkSpace is not responding to health checks. • REBOOTING – The WorkSpace is being rebooted (restarted). • STARTING – The WorkSpace is starting up and health checks are being run. • REBUILDING – The WorkSpace is being rebuilt. • RESTORING – The WorkSpace is being restored. • MAINTENANCE – The WorkSpace is undergoing scheduled maintenance by AWS. • ADMIN_MAINTENANCE – The WorkSpace is undergoing maintenance by the WorkSpaces administrator. • TERMINATING – The WorkSpace is being deleted. • TERMINATED – The WorkSpace has been deleted. • SUSPENDED – The WorkSpace has been suspended for image creation. • UPDATING – The WorkSpace is undergoing an update. • STOPPING – The WorkSpace is being stopped. • STOPPED – The WorkSpace has been stopped. • ERROR – The WorkSpace is an error state (for |
workspaces-api-067 | workspaces-api.pdf | 67 | REBUILDING – The WorkSpace is being rebuilt. • RESTORING – The WorkSpace is being restored. • MAINTENANCE – The WorkSpace is undergoing scheduled maintenance by AWS. • ADMIN_MAINTENANCE – The WorkSpace is undergoing maintenance by the WorkSpaces administrator. • TERMINATING – The WorkSpace is being deleted. • TERMINATED – The WorkSpace has been deleted. • SUSPENDED – The WorkSpace has been suspended for image creation. • UPDATING – The WorkSpace is undergoing an update. • STOPPING – The WorkSpace is being stopped. • STOPPED – The WorkSpace has been stopped. • ERROR – The WorkSpace is an error state (for example, an error occurred during startup). Note 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. Contents API Version 2015-04-08 407 Amazon WorkSpaces Service API Reference 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. Type: String Valid Values: PENDING | AVAILABLE | IMPAIRED | UNHEALTHY | REBOOTING | STARTING | REBUILDING | RESTORING | MAINTENANCE | ADMIN_MAINTENANCE | TERMINATING | TERMINATED | SUSPENDED | UPDATING | STOPPING | STOPPED | ERROR Required: No SubnetId The identifier of the subnet for the WorkSpace. Type: String Length Constraints: Minimum length of 15. Maximum length of 24. Pattern: ^(subnet-([0-9a-f]{8}|[0-9a-f]{17}))$ Required: No UserName The user for the WorkSpace. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Required: No UserVolumeEncryptionEnabled Indicates whether the data stored on the user volume is encrypted. Type: Boolean Required: No Contents API Version 2015-04-08 408 Amazon WorkSpaces Service VolumeEncryptionKey API Reference The ARN of the symmetric AWS KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys. Type: String Required: No WorkspaceId The identifier of the WorkSpace. Type: String Pattern: ^ws-[0-9a-z]{8,63}$ Required: No WorkspaceName The name of the user-decoupled WorkSpace. Type: String Pattern: ^[a-zA-Z0-9_()][a-zA-Z0-9_.()-]{1,63}$ Required: No WorkspaceProperties The properties of the WorkSpace. Type: WorkspaceProperties object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 See Also API Version 2015-04-08 409 Amazon WorkSpaces Service • AWS SDK for Ruby V3 API Reference See Also API Version 2015-04-08 410 Amazon WorkSpaces Service API Reference WorkspaceAccessProperties The device types and operating systems that can be used to access a WorkSpace. For more information, see Amazon WorkSpaces Client Network Requirements. Contents DeviceTypeAndroid Indicates whether users can use Android and Android-compatible Chrome OS devices to access their WorkSpaces. Type: String Valid Values: ALLOW | DENY Required: No DeviceTypeChromeOs Indicates whether users can use Chromebooks to access their WorkSpaces. Type: String Valid Values: ALLOW | DENY Required: No DeviceTypeIos Indicates whether users can use iOS devices to access their WorkSpaces. Type: String Valid Values: ALLOW | DENY Required: No DeviceTypeLinux Indicates whether users can use Linux clients to access their WorkSpaces. Type: String Valid Values: ALLOW | DENY WorkspaceAccessProperties API Version 2015-04-08 411 Amazon WorkSpaces Service Required: No DeviceTypeOsx API Reference Indicates whether users can use macOS clients to access their WorkSpaces. Type: String Valid Values: ALLOW | DENY Required: No DeviceTypeWeb Indicates whether users can access their WorkSpaces through a web browser. Type: String Valid Values: ALLOW | DENY Required: No DeviceTypeWindows Indicates whether users can use Windows clients to access their WorkSpaces. Type: String Valid Values: ALLOW | DENY Required: No DeviceTypeWorkSpacesThinClient Indicates whether users can access their WorkSpaces through a WorkSpaces Thin Client. Type: String Valid Values: ALLOW | DENY Required: No DeviceTypeZeroClient Indicates whether users can use zero client devices to access their WorkSpaces. Type: String Contents API Version 2015-04-08 412 Amazon WorkSpaces Service API Reference Valid Values: ALLOW | DENY Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 413 Amazon WorkSpaces Service API Reference WorkSpaceApplication Describes the WorkSpace application. Contents ApplicationId The identifier of the application. Type: String Pattern: ^wsa-[0-9a-z]{8,63}$ Required: No Created The time the application is created. Type: Timestamp Required: No Description The description of the WorkSpace application. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Required: No LicenseType The license availability for the applications. Type: String Valid Values: LICENSED | UNLICENSED Required: No WorkSpaceApplication API Version 2015-04-08 414 API Reference Amazon WorkSpaces Service Name The name of the WorkSpace application. Type: String Length Constraints: Minimum length of 1. Required: No Owner The owner of the WorkSpace application. Type: String Pattern: ^\d{12}|AMAZON$ Required: No State The status of |
workspaces-api-068 | workspaces-api.pdf | 68 | the application. Type: String Pattern: ^wsa-[0-9a-z]{8,63}$ Required: No Created The time the application is created. Type: Timestamp Required: No Description The description of the WorkSpace application. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Required: No LicenseType The license availability for the applications. Type: String Valid Values: LICENSED | UNLICENSED Required: No WorkSpaceApplication API Version 2015-04-08 414 API Reference Amazon WorkSpaces Service Name The name of the WorkSpace application. Type: String Length Constraints: Minimum length of 1. Required: No Owner The owner of the WorkSpace application. Type: String Pattern: ^\d{12}|AMAZON$ Required: No State The status of WorkSpace application. Type: String Valid Values: PENDING | ERROR | AVAILABLE | UNINSTALL_ONLY Required: No SupportedComputeTypeNames The supported compute types of the WorkSpace application. Type: Array of strings Valid Values: VALUE | STANDARD | PERFORMANCE | POWER | GRAPHICS | POWERPRO | GENERALPURPOSE_4XLARGE | GENERALPURPOSE_8XLARGE | GRAPHICSPRO | GRAPHICS_G4DN | GRAPHICSPRO_G4DN Required: No SupportedOperatingSystemNames The supported operating systems of the WorkSpace application. Contents API Version 2015-04-08 415 Amazon WorkSpaces Service Type: Array of strings API Reference Valid Values: AMAZON_LINUX_2 | UBUNTU_18_04 | UBUNTU_20_04 | UBUNTU_22_04 | UNKNOWN | WINDOWS_10 | WINDOWS_11 | WINDOWS_7 | WINDOWS_SERVER_2016 | WINDOWS_SERVER_2019 | WINDOWS_SERVER_2022 | RHEL_8 | ROCKY_8 Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 416 Amazon WorkSpaces Service API Reference WorkSpaceApplicationDeployment Describes the WorkSpace application deployment. Contents Associations The associations between the applications and the associated resources. Type: Array of WorkspaceResourceAssociation objects Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 WorkSpaceApplicationDeployment API Version 2015-04-08 417 API Reference Amazon WorkSpaces Service WorkspaceBundle Describes a WorkSpace bundle. Contents BundleId The identifier of the bundle. Type: String Pattern: ^wsb-[0-9a-z]{8,63}$ Required: No BundleType The type of WorkSpace bundle. Type: String Valid Values: REGULAR | STANDBY Required: No ComputeType The compute type of the bundle. For more information, see Amazon WorkSpaces Bundles. Type: ComputeType object Required: No CreationTime The time when the bundle was created. Type: Timestamp Required: No Description The description of the bundle. WorkspaceBundle API Version 2015-04-08 418 Amazon WorkSpaces Service Type: String Required: No ImageId The identifier of the image that was used to create the bundle. API Reference Type: String Pattern: wsi-[0-9a-z]{9,63}$ Required: No LastUpdatedTime The last time that the bundle was updated. Type: Timestamp Required: No Name The name of the bundle. Type: String Length Constraints: Minimum length of 1. Required: No Owner The owner of the bundle. This is the account identifier of the owner, or AMAZON if the bundle is provided by AWS. Type: String Required: No RootStorage The size of the root volume. Type: RootStorage object Contents API Version 2015-04-08 419 API Reference Amazon WorkSpaces Service Required: No State The state of the WorkSpace bundle. Type: String Valid Values: AVAILABLE | PENDING | ERROR Required: No UserStorage The size of the user volume. Type: UserStorage object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 420 Amazon WorkSpaces Service API Reference WorkspaceConnectionStatus Describes the connection status of a WorkSpace. Contents ConnectionState The connection state of the WorkSpace. The connection state is unknown if the WorkSpace is stopped. Type: String Valid Values: CONNECTED | DISCONNECTED | UNKNOWN Required: No ConnectionStateCheckTimestamp The timestamp of the connection status check. Type: Timestamp Required: No LastKnownUserConnectionTimestamp The timestamp of the last known user connection. Type: Timestamp Required: No WorkspaceId The identifier of the WorkSpace. Type: String Pattern: ^ws-[0-9a-z]{8,63}$ Required: No WorkspaceConnectionStatus API Version 2015-04-08 421 Amazon WorkSpaces Service See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 422 Amazon WorkSpaces Service API Reference WorkspaceCreationProperties Describes the default properties that are used for creating WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces. Contents CustomSecurityGroupId The identifier of your custom security group. Type: String Length Constraints: Minimum length of 11. Maximum length of 20. Pattern: ^(sg-([0-9a-f]{8}|[0-9a-f]{17}))$ Required: No 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, |
workspaces-api-069 | workspaces-api.pdf | 69 | See Also API Version 2015-04-08 422 Amazon WorkSpaces Service API Reference WorkspaceCreationProperties Describes the default properties that are used for creating WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces. Contents CustomSecurityGroupId The identifier of your custom security group. Type: String Length Constraints: Minimum length of 11. Maximum length of 20. Pattern: ^(sg-([0-9a-f]{8}|[0-9a-f]{17}))$ Required: No 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. Important • 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. Type: String Required: No EnableInternetAccess Indicates whether internet access is enabled for your WorkSpaces. WorkspaceCreationProperties API Version 2015-04-08 423 Amazon WorkSpaces Service Type: Boolean Required: No EnableMaintenanceMode API Reference Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance. Type: Boolean Required: No InstanceIamRoleArn Indicates the IAM role ARN of the instance. Type: String Pattern: ^arn:aws[a-z-]{0,7}:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za- z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\-] {0,1023}$ Required: No UserEnabledAsLocalAdministrator Indicates whether users are local administrators of their WorkSpaces. Type: Boolean Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 424 Amazon WorkSpaces Service API Reference WorkspaceDirectory Describes a directory that is used with Amazon WorkSpaces. Contents ActiveDirectoryConfig Information about the Active Directory config. Type: ActiveDirectoryConfig object Required: No Alias The directory alias. Type: String Required: No CertificateBasedAuthProperties The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login. Type: CertificateBasedAuthProperties object Required: No CustomerUserName The user name for the service account. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Required: No DirectoryId The directory identifier. Type: String WorkspaceDirectory API Version 2015-04-08 425 Amazon WorkSpaces Service API Reference Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: ^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$) Required: No DirectoryName The name of the directory. Type: String Required: No DirectoryType The directory type. Type: String Valid Values: SIMPLE_AD | AD_CONNECTOR | CUSTOMER_MANAGED | AWS_IAM_IDENTITY_CENTER Required: No DnsIpAddresses The IP addresses of the DNS servers for the directory. Type: Array of strings Required: No EndpointEncryptionMode Endpoint encryption mode that allows you to configure the specified directory between Standard TLS and FIPS 140-2 validated mode. Type: String Valid Values: STANDARD_TLS | FIPS_VALIDATED Required: No ErrorMessage The error message returned. Contents API Version 2015-04-08 426 Amazon WorkSpaces Service Type: String Required: No IamRoleId API Reference 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. Type: String Pattern: ^arn:aws[a-z-]{0,7}:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za- z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\-] {0,1023}$ Required: No IDCConfig Specifies details about identity center configurations. Type: IDCConfig object Required: No ipGroupIds The identifiers of the IP access control groups associated with the directory. Type: Array of strings Pattern: wsipg-[0-9a-z]{8,63}$ Required: No MicrosoftEntraConfig Specifies details about Microsoft Entra configurations. Type: MicrosoftEntraConfig object Required: No 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. Contents API Version 2015-04-08 427 Amazon WorkSpaces Service Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 20. Required: No 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. Type: SamlProperties object Required: No SelfservicePermissions The default self-service permissions for WorkSpaces in the directory. Type: SelfservicePermissions object Required: No 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. Type: String Valid Values: REGISTERING | REGISTERED | DEREGISTERING | DEREGISTERED | ERROR Required: No StreamingProperties The streaming properties to configure. Type: StreamingProperties object Required: No Contents API Version 2015-04-08 428 Amazon WorkSpaces Service SubnetIds API Reference The identifiers of the subnets used with the directory. Type: Array of strings Array Members: Maximum number of 2 items. Length Constraints: Minimum length of 15. Maximum length of 24. Pattern: ^(subnet-([0-9a-f]{8}|[0-9a-f]{17}))$ Required: No Tenancy Specifies whether the directory is dedicated or shared. To use Bring Your Own License (BYOL), this |
workspaces-api-070 | workspaces-api.pdf | 70 | the directory ID isn't returned, then the directory has been successfully deregistered. Type: String Valid Values: REGISTERING | REGISTERED | DEREGISTERING | DEREGISTERED | ERROR Required: No StreamingProperties The streaming properties to configure. Type: StreamingProperties object Required: No Contents API Version 2015-04-08 428 Amazon WorkSpaces Service SubnetIds API Reference The identifiers of the subnets used with the directory. Type: Array of strings Array Members: Maximum number of 2 items. Length Constraints: Minimum length of 15. Maximum length of 24. Pattern: ^(subnet-([0-9a-f]{8}|[0-9a-f]{17}))$ Required: No 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. Type: String Valid Values: DEDICATED | SHARED Required: No UserIdentityType Indicates the identity type of the specifired user. Type: String Valid Values: CUSTOMER_MANAGED | AWS_DIRECTORY_SERVICE | AWS_IAM_IDENTITY_CENTER Required: No WorkspaceAccessProperties The devices and operating systems that users can use to access WorkSpaces. Type: WorkspaceAccessProperties object Required: No Contents API Version 2015-04-08 429 Amazon WorkSpaces Service WorkspaceCreationProperties API Reference The default creation properties for all WorkSpaces in the directory. Type: DefaultWorkspaceCreationProperties object Required: No WorkspaceDirectoryDescription The description of the WorkSpace directory Type: String Pattern: ^([a-zA-Z0-9_])[\\a-zA-Z0-9_@#%*+=:?./!\s-]{1,255}$ Required: No WorkspaceDirectoryName The name fo the WorkSpace directory. Type: String Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.\s-]{1,64}$ Required: No WorkspaceSecurityGroupId The identifier of the security group that is assigned to new WorkSpaces. Type: String Length Constraints: Minimum length of 11. Maximum length of 20. Pattern: ^(sg-([0-9a-f]{8}|[0-9a-f]{17}))$ Required: No WorkspaceType Indicates whether the directory's WorkSpace type is personal or pools. Type: String Valid Values: PERSONAL | POOLS Contents API Version 2015-04-08 430 Amazon WorkSpaces Service Required: No See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 431 Amazon WorkSpaces Service WorkspaceImage Describes a WorkSpace image. Contents Created API Reference The date when the image was created. If the image has been shared, the AWS account that the image has been shared with sees the original creation date of the image. Type: Timestamp Required: No Description The description of the image. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[a-zA-Z0-9_./() -]+$ Required: No ErrorCode The error code that is returned for the image. Type: String Required: No ErrorDetails Additional details of the error returned for the image, including the possible causes of the errors and troubleshooting information. Type: Array of ErrorDetails objects Required: No WorkspaceImage API Version 2015-04-08 432 Amazon WorkSpaces Service ErrorMessage API Reference The text of the error message that is returned for the image. Type: String Required: No ImageId The identifier of the image. Type: String Pattern: wsi-[0-9a-z]{9,63}$ Required: No Name The name of the image. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[a-zA-Z0-9_./()\\-]+$ Required: No OperatingSystem The operating system that the image is running. Type: OperatingSystem object Required: No OwnerAccountId The identifier of the AWS account that owns the image. Type: String Pattern: ^\d{12}$ Required: No Contents API Version 2015-04-08 433 Amazon WorkSpaces Service RequiredTenancy API Reference 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. Type: String Valid Values: DEFAULT | DEDICATED Required: No State The status of the image. Type: String Valid Values: AVAILABLE | PENDING | ERROR Required: No Updates The updates (if any) that are available for the specified image. Type: UpdateResult object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 434 Amazon WorkSpaces Service API Reference WorkspaceProperties Describes a WorkSpace. Contents ComputeTypeName The compute type. For more information, see Amazon WorkSpaces Bundles. Type: String Valid Values: VALUE | STANDARD | PERFORMANCE | POWER | GRAPHICS | POWERPRO | GENERALPURPOSE_4XLARGE | GENERALPURPOSE_8XLARGE | GRAPHICSPRO | GRAPHICS_G4DN | GRAPHICSPRO_G4DN Required: No GlobalAccelerator Indicates the Global Accelerator properties. Type: GlobalAcceleratorForWorkSpace object Required: No OperatingSystemName The name of the operating system. Type: String Valid Values: AMAZON_LINUX_2 | UBUNTU_18_04 | UBUNTU_20_04 | UBUNTU_22_04 | UNKNOWN | WINDOWS_10 | WINDOWS_11 | WINDOWS_7 | WINDOWS_SERVER_2016 | WINDOWS_SERVER_2019 | WINDOWS_SERVER_2022 | RHEL_8 | ROCKY_8 Required: No Protocols The protocol. For more information, see Protocols for Amazon WorkSpaces. Note • Only available for WorkSpaces created with PCoIP bundles. WorkspaceProperties API Version 2015-04-08 435 Amazon WorkSpaces Service API Reference • The Protocols property is case sensitive. Ensure you use PCOIP or DCV (formerly WSP). • Unavailable for Windows 7 WorkSpaces and WorkSpaces using |
workspaces-api-071 | workspaces-api.pdf | 71 | Accelerator properties. Type: GlobalAcceleratorForWorkSpace object Required: No OperatingSystemName The name of the operating system. Type: String Valid Values: AMAZON_LINUX_2 | UBUNTU_18_04 | UBUNTU_20_04 | UBUNTU_22_04 | UNKNOWN | WINDOWS_10 | WINDOWS_11 | WINDOWS_7 | WINDOWS_SERVER_2016 | WINDOWS_SERVER_2019 | WINDOWS_SERVER_2022 | RHEL_8 | ROCKY_8 Required: No Protocols The protocol. For more information, see Protocols for Amazon WorkSpaces. Note • Only available for WorkSpaces created with PCoIP bundles. WorkspaceProperties API Version 2015-04-08 435 Amazon WorkSpaces Service API Reference • The Protocols property is case sensitive. Ensure you use PCOIP or DCV (formerly WSP). • Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn). Type: Array of strings Valid Values: PCOIP | WSP Required: No 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. Type: Integer Required: No RunningMode The running mode. For more information, see Manage the WorkSpace Running Mode. Note 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. Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing? Type: String Valid Values: AUTO_STOP | ALWAYS_ON | MANUAL Required: No Contents API Version 2015-04-08 436 Amazon WorkSpaces Service API Reference RunningModeAutoStopTimeoutInMinutes The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60- minute intervals. Type: Integer Required: No 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. Type: Integer Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 437 Amazon WorkSpaces Service WorkspaceRequest Describes the information used to create a WorkSpace. Contents BundleId API Reference The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles. Type: String Pattern: ^wsb-[0-9a-z]{8,63}$ Required: Yes DirectoryId The identifier of the AWS Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: ^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$) Required: Yes UserName The user name of the user for the WorkSpace. This user name must exist in the AWS Directory Service directory for the WorkSpace. The username is not case-sensitive, but we recommend matching the case in the AWS Directory Service directory to avoid potential incompatibilities. The reserved keyword, [UNDEFINED], is used when creating user-decoupled WorkSpaces. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. WorkspaceRequest API Version 2015-04-08 438 Amazon WorkSpaces Service Required: Yes RootVolumeEncryptionEnabled Indicates whether the data stored on the root volume is encrypted. API Reference Type: Boolean Required: No Tags The tags for the WorkSpace. Type: Array of Tag objects Required: No UserVolumeEncryptionEnabled Indicates whether the data stored on the user volume is encrypted. Type: Boolean Required: No VolumeEncryptionKey The ARN of the symmetric AWS KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys. Type: String Required: No WorkspaceName The name of the user-decoupled WorkSpace. Note WorkspaceName is required if UserName is [UNDEFINED] for user-decoupled WorkSpaces. WorkspaceName is not applicable if UserName is specified for user- assigned WorkSpaces. Contents API Version 2015-04-08 439 Amazon WorkSpaces Service Type: String API Reference Pattern: ^[a-zA-Z0-9_()][a-zA-Z0-9_.()-]{1,63}$ Required: No WorkspaceProperties The WorkSpace properties. Type: WorkspaceProperties object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 440 Amazon WorkSpaces Service API Reference WorkspaceResourceAssociation Describes the association between an application and a WorkSpace resource. Contents AssociatedResourceId The identifier of the associated resource. Type: String Length Constraints: Minimum length of 1. Required: No AssociatedResourceType The resource types of the associated resource. Type: String Valid Values: APPLICATION Required: No Created The time the association is created. Type: Timestamp Required: No LastUpdatedTime The time the association status was last updated. Type: Timestamp Required: No State The status of the WorkSpace resource association. WorkspaceResourceAssociation API Version 2015-04-08 441 Amazon WorkSpaces Service Type: String API Reference Valid Values: PENDING_INSTALL | PENDING_INSTALL_DEPLOYMENT | PENDING_UNINSTALL | PENDING_UNINSTALL_DEPLOYMENT | INSTALLING | UNINSTALLING | ERROR | COMPLETED | REMOVED Required: No StateReason The reason the association deployment failed. Type: AssociationStateReason object Required: No WorkspaceId The identifier of the WorkSpace. Type: String Pattern: |
workspaces-api-072 | workspaces-api.pdf | 72 | The resource types of the associated resource. Type: String Valid Values: APPLICATION Required: No Created The time the association is created. Type: Timestamp Required: No LastUpdatedTime The time the association status was last updated. Type: Timestamp Required: No State The status of the WorkSpace resource association. WorkspaceResourceAssociation API Version 2015-04-08 441 Amazon WorkSpaces Service Type: String API Reference Valid Values: PENDING_INSTALL | PENDING_INSTALL_DEPLOYMENT | PENDING_UNINSTALL | PENDING_UNINSTALL_DEPLOYMENT | INSTALLING | UNINSTALLING | ERROR | COMPLETED | REMOVED Required: No StateReason The reason the association deployment failed. Type: AssociationStateReason object Required: No WorkspaceId The identifier of the WorkSpace. Type: String Pattern: ^ws-[0-9a-z]{8,63}$ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 442 Amazon WorkSpaces Service API Reference WorkspacesIpGroup Describes an IP access control group. Contents groupDesc The description of the group. Type: String Required: No groupId The identifier of the group. Type: String Pattern: wsipg-[0-9a-z]{8,63}$ Required: No groupName The name of the group. Type: String Required: No userRules The rules. Type: Array of IpRuleItem objects Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: WorkspacesIpGroup API Version 2015-04-08 443 Amazon WorkSpaces Service • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2015-04-08 444 API Reference Amazon WorkSpaces Service WorkspacesPool Describes a pool of WorkSpaces. Contents BundleId The identifier of the bundle used by the pool. Type: String Pattern: ^wsb-[0-9a-z]{8,63}$ Required: Yes CapacityStatus The capacity status for the pool Type: CapacityStatus object Required: Yes CreatedAt The time the pool was created. Type: Timestamp Required: Yes DirectoryId The identifier of the directory used by the pool. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: ^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$) Required: Yes PoolArn The Amazon Resource Name (ARN) for the pool. WorkspacesPool API Version 2015-04-08 445 Amazon WorkSpaces Service Type: String API Reference Pattern: ^arn:aws[a-z-]{0,7}:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za- z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\-] {0,1023}$ Required: Yes PoolId The identifier of a pool. Type: String Pattern: ^wspool-[0-9a-z]{9}$ Required: Yes PoolName The name of the pool. Type: String Pattern: ^[A-Za-z0-9][A-Za-z0-9_.-]{0,63}$ Required: Yes RunningMode The running mode of the pool. Type: String Valid Values: AUTO_STOP | ALWAYS_ON Required: Yes State The current state of the pool. Type: String Valid Values: CREATING | DELETING | RUNNING | STARTING | STOPPED | STOPPING | UPDATING Contents API Version 2015-04-08 446 API Reference Amazon WorkSpaces Service Required: Yes ApplicationSettings The persistent application settings for users of the pool. Type: ApplicationSettingsResponse object Required: No Description The description of the pool. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^[a-zA-Z0-9_./() -]+$ Required: No Errors The pool errors. Type: Array of WorkspacesPoolError objects Required: No TimeoutSettings 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. Type: TimeoutSettings object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: See Also API Version 2015-04-08 447 Amazon WorkSpaces Service • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2015-04-08 448 Amazon WorkSpaces Service API Reference WorkspacesPoolError Describes a pool error. Contents ErrorCode The error code. Type: String Valid Values: 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 | WorkspacesPoolError API Version 2015-04-08 449 Amazon WorkSpaces Service API Reference DIRECTORY_NOT_FOUND | INSUFFICIENT_PERMISSIONS_ERROR | DEFAULT_OU_IS_MISSING Required: No ErrorMessage The error message. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 450 Amazon WorkSpaces Service API Reference WorkspacesPoolSession Describes a pool session. Contents PoolId The identifier of the pool. Type: String Pattern: ^wspool-[0-9a-z]{9}$ Required: Yes SessionId The identifier of the session. Type: String Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes UserId The identifier of the user. Type: |
workspaces-api-073 | workspaces-api.pdf | 73 | Required: No ErrorMessage The error message. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 450 Amazon WorkSpaces Service API Reference WorkspacesPoolSession Describes a pool session. Contents PoolId The identifier of the pool. Type: String Pattern: ^wspool-[0-9a-z]{9}$ Required: Yes SessionId The identifier of the session. Type: String Length Constraints: Fixed length of 36. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes UserId The identifier of the user. Type: String Length Constraints: Minimum length of 2. Maximum length of 128. Required: Yes AuthenticationType The authentication method. The user is authenticated using a WorkSpaces Pools URL (API) or SAML 2.0 federation (SAML). Type: String WorkspacesPoolSession API Version 2015-04-08 451 API Reference Amazon WorkSpaces Service Valid Values: SAML Required: No ConnectionState Specifies whether a user is connected to the pool session. Type: String Valid Values: CONNECTED | NOT_CONNECTED Required: No ExpirationTime The time that the pool session ended. Type: Timestamp Required: No InstanceId The identifier for the instance hosting the session. Type: String Pattern: ^i-[a-f0-9]{8}(?:[a-f0-9]{9})?$ Required: No NetworkAccessConfiguration Describes the network details of the pool. Type: NetworkAccessConfiguration object Required: No StartTime The time that the pool sission started. Type: Timestamp Required: No Contents API Version 2015-04-08 452 Amazon WorkSpaces Service See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2015-04-08 453 Amazon WorkSpaces Service API Reference Common Errors This section lists the errors common to the API actions of all AWS services. For errors specific to an API action for this service, see the topic for that API action. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 400 IncompleteSignature The request signature does not conform to AWS standards. HTTP Status Code: 400 InternalFailure The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 InvalidAction The action or operation requested is invalid. Verify that the action is typed correctly. HTTP Status Code: 400 InvalidClientTokenId The X.509 certificate or AWS access key ID provided does not exist in our records. HTTP Status Code: 403 NotAuthorized You do not have permission to perform this action. HTTP Status Code: 400 OptInRequired The AWS access key ID needs a subscription for the service. HTTP Status Code: 403 API Version 2015-04-08 454 Amazon WorkSpaces Service RequestExpired API Reference The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future. HTTP Status Code: 400 ServiceUnavailable The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 ValidationError The input fails to satisfy the constraints specified by an AWS service. HTTP Status Code: 400 API Version 2015-04-08 455 Amazon WorkSpaces Service API Reference WorkSpaces Core API actions You can use the following APIs to perform various actions for WorkSpaces Core. We have provided some recommendations next to these actions to help you create your workflow. • Deployment and setup • CreateTags - Possible • CreateWorkspaceBundle - Required • CreateWorkspaces - Required • DescribeAccount - Required • DescribeAccountModifications - Possible • ImportWorkspaceImage - Possible, but we highly recommend partners have an interface to import images into Amazon WorkSpaces using this API. • ModifyAccount - Possible • ListAvailableManagementCidrRanges - Possible, but we highly recommend partners have an interface to onboard customers into Amazon WorkSpaces BYOL using this API. • RegisterWorkspaceDirectory - Required • EnableInternetAccess - Optional • EnableWorkDocs - Optional • Tags - Optional • Operations • CopyWorkspaceImage - Possible, but we highly recommend this action. It supports an UpdateWorkspaceBundle image process and copying from one region to another. • CreateWorkspaceImage - Required • DescribeTags - Possible, but we highly recommend partners have an interface to use and modify tags on Amazon WorkSpaces desktops using this API. • DescribeWorkspaceBundles - Required • DescribeWorkspaceDirectories - Required • DescribeWorkspaceImagePermissions - Required • DescribeWorkspaceImages - Required for creation of new desktops and within a workflow to use the UpdateWorkspaceBundle API that updates an image within a bundle. • DescribeWorkspaces - Required API Version 2015-04-08 456 Amazon WorkSpaces Service API Reference • DescribeWorkspaceSnapshots - Possible, but we highly recommend partners have an interface to view snapshots into Amazon WorkSpaces desktops using this API. • MigrateWorkspace - Possible, but we highly recommend partners have an interface to |
workspaces-api-074 | workspaces-api.pdf | 74 | have an interface to use and modify tags on Amazon WorkSpaces desktops using this API. • DescribeWorkspaceBundles - Required • DescribeWorkspaceDirectories - Required • DescribeWorkspaceImagePermissions - Required • DescribeWorkspaceImages - Required for creation of new desktops and within a workflow to use the UpdateWorkspaceBundle API that updates an image within a bundle. • DescribeWorkspaces - Required API Version 2015-04-08 456 Amazon WorkSpaces Service API Reference • DescribeWorkspaceSnapshots - Possible, but we highly recommend partners have an interface to view snapshots into Amazon WorkSpaces desktops using this API. • MigrateWorkspace - Possible, but we highly recommend partners have an interface to migrate an Amazon WorkSpaces desktop from one bundle to another using this API. • ModifyWorkspaceCreationProperties - Possible, but we highly recommend partners have an interface to modify the following properties: • Custom Security Group • Default OU • EnableInternetAccess • EnableMaintenanceMode • EnableWorkDocs • UserEnabledAsLocalAdministrator • ModifyWorkspaceProperties - Possible, but we highly recommend partners have an interface to modify the following properties: • ComputeTypeName • RootVolumeSizeGib • RunningMode (can change to Manual) • RunningModeAutoStopTimeoutInMinutes • UserVolumeSizeGib • ModifyWorkspaceState - Required • RebootWorkspaces - Required • RebuildWorkspaces - Required • RestoreWorkspace - Required • StartWorkspaces - Required • StopWorkspaces - Required • UpdateWorkspaceBundle - Required • UpdateWorkspaceImagePermission - Possible, but we highly recommend partners have an interface to modify these properties. • Termination • DeleteTags - Possible • DeleteWorkspaceBundle - Required API Version 2015-04-08 457 Amazon WorkSpaces Service API Reference • DeleteWorkspaceImage - Required • DeregisterWorkspaceDirectory - Required • TerminateWorkspaces - Required API Version 2015-04-08 458 Amazon WorkSpaces Service API Reference Logging WorkSpaces API Calls by Using CloudTrail The WorkSpaces API is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service in WorkSpaces. CloudTrail captures API calls for WorkSpaces as events. The calls captured include calls from the WorkSpaces console and code calls to the WorkSpaces API operations. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for WorkSpaces. If you don't configure a trail, you can still view the most recent events in the CloudTrail console in Event history. Using the information collected by CloudTrail, you can determine the request that was made to WorkSpaces, the IP address from which the request was made, who made the request, when it was made, and additional details. To learn more about CloudTrail, including how to configure and enable it, see the AWS CloudTrail User Guide. WorkSpaces Information in CloudTrail CloudTrail is enabled on your AWS account when you create the account. When supported event activity occurs in WorkSpaces, that activity is recorded in a CloudTrail event along with other AWS service events in Event history. For example, calls to create, rebuild, or terminate WorkSpaces generate entries in CloudTrail log files. For more information, see Actions. You can view, search, and download recent events in your AWS account. For more information, see Viewing Events with CloudTrail Event History. For an ongoing record of events in your AWS account, including events for WorkSpaces, create a trail. A trail enables CloudTrail to deliver log files to an Amazon S3 bucket. By default, when you create a trail in the console, the trail applies to all AWS Regions. The trail logs events from all Regions in the AWS partition and delivers the log files to the Amazon S3 bucket that you specify. Additionally, you can configure other AWS services to further analyze and act upon the event data collected in CloudTrail logs. For more information, see the following: • Overview for Creating a Trail • CloudTrail Supported Services and Integrations • Configuring Amazon SNS Notifications for CloudTrail • Receiving CloudTrail Log Files from Multiple Regions and Receiving CloudTrail Log Files from Multiple Accounts WorkSpaces Information in CloudTrail API Version 2015-04-08 459 Amazon WorkSpaces Service API Reference Example: WorkSpaces Log File Entry A trail is a configuration that enables delivery of events as log files to an Amazon S3 bucket that you specify. CloudTrail log files contain one or more log entries. An event represents a single request from any source and includes information about the requested action, the date and time of the action, request parameters, and so on. CloudTrail log files aren't an ordered stack trace of the public API calls, so they don't appear in any specific order. Any sensitive information, such as passwords, authentication tokens, file comments, and file contents are redacted in the log entries. The following shows an example of a CloudTrail log entry for WorkSpaces. { "Records" : [ { "eventVersion" : "1.02", "userIdentity" : { "type" : "IAMUser", "principalId" : "user_id", "arn" : "user_arn", "accountId" : "account_id", "accessKeyId" : "access_key_id", "userName" : "username" }, "eventTime" : "event_time", "eventSource" : "workspaces.amazonaws.com", "eventName" : "DescribeWorkspaces", "awsRegion" : "region", |
workspaces-api-075 | workspaces-api.pdf | 75 | action, request parameters, and so on. CloudTrail log files aren't an ordered stack trace of the public API calls, so they don't appear in any specific order. Any sensitive information, such as passwords, authentication tokens, file comments, and file contents are redacted in the log entries. The following shows an example of a CloudTrail log entry for WorkSpaces. { "Records" : [ { "eventVersion" : "1.02", "userIdentity" : { "type" : "IAMUser", "principalId" : "user_id", "arn" : "user_arn", "accountId" : "account_id", "accessKeyId" : "access_key_id", "userName" : "username" }, "eventTime" : "event_time", "eventSource" : "workspaces.amazonaws.com", "eventName" : "DescribeWorkspaces", "awsRegion" : "region", "sourceIPAddress" : "IP_address", "userAgent" : "user_agent", "requestParameters" : { "requestContext" : { "awsAccountId" : "account_id" } }, "responseElements" : { "workspaces" : [ Example: WorkSpaces Log File Entry API Version 2015-04-08 460 API Reference Amazon WorkSpaces Service { "bundleId" : "bundle_id", "userName" : "workspace_user_name", "ipAddress" : ";ip_address", "directoryId" : ";directory_id", "state" : "state", "workspaceId" : "workspace_id", "subnetId" : "subnet_id" } ] }, "requestID" : "request_id", "eventID" : "event_id", "eventType" : "AwsApiCall", "recipientAccountId" : "account_id" } ] } Example: WorkSpaces Log File Entry API Version 2015-04-08 461 |
workspaces-thin-client-admin-guide-001 | workspaces-thin-client-admin-guide.pdf | 1 | Administrator Guide Amazon WorkSpaces Thin Client Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon WorkSpaces Thin Client Administrator Guide Amazon WorkSpaces Thin Client: Administrator Guide Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. Amazon WorkSpaces Thin Client Table of Contents Administrator Guide What is the Amazon WorkSpaces Thin Client administrator console? ......................................... 1 Are you a first-time user? ........................................................................................................................... 1 Architecture .................................................................................................................................................... 1 Setting up Amazon WorkSpaces Thin Client administrator console ............................................ 4 Sign up for AWS ........................................................................................................................................... 4 Create an IAM user ....................................................................................................................................... 4 Getting started with your VDI for Amazon WorkSpaces Thin Client administrator console ........ 6 Configuring WorkSpaces Personal for WorkSpaces Thin Client .......................................................... 6 Before you begin ..................................................................................................................................... 7 Step 1: Verify that your system meets WorkSpaces Personal required features ........................ 7 Step 2: Use advanced setup to launch your WorkSpace ................................................................. 8 Business continuity ................................................................................................................................. 9 Configuring WorkSpaces Pools for WorkSpaces Thin Client ............................................................. 10 Before you begin .................................................................................................................................. 10 Create a WorkSpaces Pool .................................................................................................................. 10 Configuring WorkSpaces Thin Client access .................................................................................... 13 Configuring AppStream 2.0 for Amazon WorkSpaces Thin Client ................................................... 14 Step 1: Verify that your system meets AppStream 2.0 required features ................................. 14 Step 2: Set up your AppStream 2.0 stacks ..................................................................................... 15 Configuring Amazon WorkSpaces Secure Browser for Amazon WorkSpaces Thin Client ............ 15 Step 1: Verify that your system meets Amazon WorkSpaces Secure Browser required features ................................................................................................................................................... 16 Step 2: Set up WorkSpaces Secure Browser portals ...................................................................... 16 Starting the WorkSpaces Thin Client administrator console ...................................................... 17 Covered regions .......................................................................................................................................... 17 Launching the WorkSpaces Thin Client administrator console ........................................................ 18 Using WorkSpaces Thin Client administrator console ................................................................ 19 Environments .............................................................................................................................................. 20 Environment list .................................................................................................................................... 20 Environment Details ............................................................................................................................. 22 Creating an environment .................................................................................................................... 25 Editing an environment ....................................................................................................................... 29 Deleting an environment .................................................................................................................... 30 Devices .......................................................................................................................................................... 30 iii Amazon WorkSpaces Thin Client Administrator Guide Device list ............................................................................................................................................... 30 Device details ......................................................................................................................................... 33 Editing a device name ......................................................................................................................... 40 Resetting and deregistering a device ............................................................................................... 40 Archiving a device ................................................................................................................................. 40 Deleting a device .................................................................................................................................. 41 Exporting device details ...................................................................................................................... 41 Software updates ....................................................................................................................................... 41 Updating environment software ....................................................................................................... 42 Updating device software ................................................................................................................... 42 WorkSpaces Thin Client software releases ...................................................................................... 43 Using tags on WorkSpaces Thin Client resources ........................................................................ 51 Security .......................................................................................................................................... 54 Data protection ........................................................................................................................................... 54 Data encryption ..................................................................................................................................... 56 Encryption at rest ................................................................................................................................. 57 Encryption in transit ............................................................................................................................ 70 Key management .................................................................................................................................. 70 Internet work traffic privacy ............................................................................................................... 71 Identity and access management ........................................................................................................... 71 Audience .................................................................................................................................................. 71 Authenticating with identities ............................................................................................................ 72 Managing access using policies .......................................................................................................... 75 How Amazon WorkSpaces Thin Client works with IAM ................................................................ 78 Identity-based policy examples ......................................................................................................... 84 AWS managed policies ........................................................................................................................ 89 Troubleshooting .................................................................................................................................... 94 Resilience ...................................................................................................................................................... 96 Vulnerability Analysis and Management ............................................................................................... 97 Monitoring ...................................................................................................................................... 98 CloudTrail logs ............................................................................................................................................ 98 CloudTrail data events ....................................................................................................................... 100 CloudTrail management events ....................................................................................................... 101 CloudTrail event examples ............................................................................................................... 101 AWS CloudFormation resources ................................................................................................. 105 WorkSpaces Thin Client and AWS CloudFormation templates ....................................................... 105 iv Amazon WorkSpaces Thin Client Administrator Guide Learn more about AWS CloudFormation ............................................................................................ 105 AWS PrivateLink .......................................................................................................................... 106 Considerations .......................................................................................................................................... 106 Create an interface endpoint ................................................................................................................ 106 Create an endpoint policy ..................................................................................................................... 107 Document history ........................................................................................................................ 108 v Amazon WorkSpaces Thin Client Administrator Guide What is the Amazon WorkSpaces Thin Client administrator console? With the Amazon WorkSpaces Thin Client administrator console, administrators can manage WorkSpaces Thin Client environments and devices through a WorkSpaces Thin Client portal. From this web console, administrators can create environments, manage devices, and set parameters for WorkSpaces Thin Client users within their network. Virtual desktop environments that you use for WorkSpaces Thin Client must be created or modified within their own console. Important For WorkSpaces Thin Client administrator console to work properly, your system must first meet specific requirements. These requirements are listed in Prerequisites and Configurations. Topics • Are you a first-time user? • Architecture Are you a first-time user? If you are a first-time user of WorkSpaces Thin Client administrator console, we recommend that you begin by reading the following sections: • Starting the WorkSpaces Thin Client administrator console • Using WorkSpaces Thin Client administrator console Architecture Each WorkSpaces Thin Client is associated with a virtual desktop interface (VDI) provider. WorkSpaces Thin Client supports three VDI providers: Are you a first-time user? 1 Amazon WorkSpaces Thin Client • Amazon WorkSpaces • AppStream 2.0 • Amazon WorkSpaces |
workspaces-thin-client-admin-guide-002 | workspaces-thin-client-admin-guide.pdf | 2 | requirements. These requirements are listed in Prerequisites and Configurations. Topics • Are you a first-time user? • Architecture Are you a first-time user? If you are a first-time user of WorkSpaces Thin Client administrator console, we recommend that you begin by reading the following sections: • Starting the WorkSpaces Thin Client administrator console • Using WorkSpaces Thin Client administrator console Architecture Each WorkSpaces Thin Client is associated with a virtual desktop interface (VDI) provider. WorkSpaces Thin Client supports three VDI providers: Are you a first-time user? 1 Amazon WorkSpaces Thin Client • Amazon WorkSpaces • AppStream 2.0 • Amazon WorkSpaces Secure Browser Administrator Guide Depending on the VDI used, information for your WorkSpaces Thin Client is accessed and managed either via directories for WorkSpaces, stacks for AppStream 2.0, and web portal endpoints for WorkSpaces Secure Browser. For more information on Amazon WorkSpaces, see Get started with WorkSpaces quick setup. Directories are managed through the AWS Directory Service, which offers the following options: Simple AD, AD Connector, or AWS Directory Service for Microsoft Active Directory, also known as AWS Managed Microsoft AD. For more information, see the AWS Directory Service Administration Guide. For more information on AppStream 2.0, see Get Started with Amazon AppStream 2.0: Set Up With Sample Applications. AppStream 2.0 manages the AWS resources required to host and run your applications, scales automatically, and provides access to your users on demand. AppStream 2.0 provides users access to the applications they need on the device of their choice, with a responsive, fluid user experience that is indistinguishable from natively installed applications. For information on WorkSpaces Secure Browser, see Getting started with Amazon WorkSpaces Secure Browser. Amazon WorkSpaces Secure Browser is an on-demand, fully managed, Linux-based service designed to facilitate secure browser access to internal websites and software-as-a-service (SaaS) applications. Access the service from existing web browsers, without the administrative burden of infrastructure management, specialized client software, or virtual private network (VPN) solutions. The following diagram shows the architecture of WorkSpaces Thin Client. Architecture 2 Amazon WorkSpaces Thin Client Administrator Guide Architecture 3 Amazon WorkSpaces Thin Client Administrator Guide Setting up Amazon WorkSpaces Thin Client administrator console Topics • Sign up for AWS • Create an IAM user Sign up for AWS If you do not have an AWS account, complete the following steps to create one. To sign up for an AWS account 1. Open https://portal.aws.amazon.com/billing/signup. 2. Follow the online instructions. Part of the sign-up procedure involves receiving a phone call and entering a verification code on the phone keypad. When you sign up for an AWS account, an AWS account root user is created. The root user has access to all AWS services and resources in the account. As a security best practice, assign administrative access to a user, and use only the root user to perform tasks that require root user access. Create an IAM user To create an administrator user, choose one of the following options. Sign up for AWS 4 Amazon WorkSpaces Thin Client Administrator Guide To By You can also Choose one way to manage your administr ator In IAM Identity Use short-term credentials to access Following the instructions in Getting started in the Configure programmatic access by Configuring the Center AWS. AWS IAM Identity Center AWS CLI to use AWS IAM (Recommen ded) This aligns with the security best practices User Guide. Identity Center in the AWS Command Line Interface User Guide. . For information about best practices , see Security best practices in IAM in the IAM User Guide. In IAM (Not Use long-term credentials to access Following the instructions in Create an IAM user for Configure programmatic access by Manage access keys AWS. emergency access in the for IAM users in the IAM User recommend ed) IAM User Guide. Guide. Create an IAM user 5 Amazon WorkSpaces Thin Client Administrator Guide Getting started with your VDI for Amazon WorkSpaces Thin Client Amazon WorkSpaces Thin Client is a cost-effective thin client device built to work with AWS End User Computing services to provide you with secure, instant access to applications and virtual desktops. Choose a virtual desktop infrastructure (VDI), and configure it to work with WorkSpaces Thin Client. Important For WorkSpaces Thin Client administrator console to work properly, your system must first meet specific requirements. These requirements are listed in the configuration procedure for each virtual desktop provider. WorkSpaces Thin Client requires specific software configurations, depending on your virtual desktop provider. Topics • Configuring WorkSpaces Personal for WorkSpaces Thin Client • Configuring WorkSpaces Pools for WorkSpaces Thin Client • Configuring AppStream 2.0 for Amazon WorkSpaces Thin Client • Configuring Amazon WorkSpaces Secure Browser for Amazon WorkSpaces Thin Client Configuring WorkSpaces Personal for WorkSpaces Thin Client For WorkSpaces Thin Client to be used with Amazon WorkSpaces Personal, your service will need to be configured |
workspaces-thin-client-admin-guide-003 | workspaces-thin-client-admin-guide.pdf | 3 | administrator console to work properly, your system must first meet specific requirements. These requirements are listed in the configuration procedure for each virtual desktop provider. WorkSpaces Thin Client requires specific software configurations, depending on your virtual desktop provider. Topics • Configuring WorkSpaces Personal for WorkSpaces Thin Client • Configuring WorkSpaces Pools for WorkSpaces Thin Client • Configuring AppStream 2.0 for Amazon WorkSpaces Thin Client • Configuring Amazon WorkSpaces Secure Browser for Amazon WorkSpaces Thin Client Configuring WorkSpaces Personal for WorkSpaces Thin Client For WorkSpaces Thin Client to be used with Amazon WorkSpaces Personal, your service will need to be configured to access the WorkSpaces directories. Amazon WorkSpaces Personal directories are listed based on their directory names on the WorkSpaces Thin Client Create environment page within AWS console. Configuring WorkSpaces Personal for WorkSpaces Thin Client 6 Amazon WorkSpaces Thin Client Administrator Guide Note Configurations must be made before using the console for the first time. It is not recommended that you modify any prerequisite features after you start using the console. Before you begin Make sure that you have an AWS account to create or administer a WorkSpace. Device users, however, don't need an AWS account to connect to and use their WorkSpaces. Review and understand the following concepts before you proceed with your configuration: • When you launch a WorkSpace, select a WorkSpace bundle. For more information, see Amazon WorkSpaces Bundles. • When you launch a WorkSpace, select which protocol that you want to use with your bundle. For more information, see Protocols for Amazon WorkSpaces Personal. • When you launch a WorkSpace, specify the profile information for each user, including username and email address. Users complete their profiles by creating a password. Information about WorkSpaces and users is stored in a directory. For more information, see Manage directories for WorkSpaces Personal. • When you launch a WorkSpace, enable and configure the WorkSpaces Thin Client web access. For more information, see Configure WorkSpaces Thin Client Step 1: Verify that your system meets WorkSpaces Personal required features For WorkSpaces Thin Client administrator console to work properly with Amazon WorkSpaces Personal, your system must meet the following specific requirements. This table lists all of these supported features and their requirements. Feature Web access Requirement Enabled Supported operating system • Windows 10 Before you begin 7 Amazon WorkSpaces Thin Client Administrator Guide Feature Requirement • Windows 10 (Bring Your Own License) • Windows 11 • Windows 11 (Bring Your Own License) Supported bundles • Microsoft Power with Windows 10 (Server 2016, 2019, and 2022 based) • Microsoft Power with Windows 10 (Server 2016, 2019, and 2022 based) w Office • Microsoft PowerPro with Windows 10 (Server 2016, 2019, and 2022 based) • Microsoft PowerPro with Windows 10 (Server 2016, 2019, and 2022 based) w Office • Microsoft Performance with Windows 10 (Server 2016, 2019, and 2022 based) • Microsoft Performance with Windows 10 (Server 2016, 2019, and 2022 based) w Office Supported protocol DCV only Step 2: Use advanced setup to launch your WorkSpace To use advanced setup to launch your WorkSpace 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home/. 2. Choose one of the following directory types, and then choose Next: • AWS Managed Microsoft AD • Simple AD • AD Connector 3. Enter the directory information. 4. Choose two subnets in a VPC from two different Availability Zones. For more information, see Configure a VPC with public subnets. Step 2: Use advanced setup to launch your WorkSpace 8 Amazon WorkSpaces Thin Client Administrator Guide 5. Review your directory information and choose Create directory. Business continuity WorkSpaces Thin Client provides support for Business continuity as part of a Business Continuity Plan (BCP). WorkSpaces Thin Client business continuity is available for use with WorkSpaces Personal only. For more information on business continuity, see Business continuity for WorkSpaces Personal in the Amazon WorkSpaces Administration guide. Prerequisites For business continuity to work on WorkSpaces Thin Client, the following prerequisites must be met: • For WorkSpaces Cross-Region Redirection – DNS service and routing polices have been configured. To set these up, see Configure your DNS service and set up DNS routing policies. • For WorkSpaces Multi-Region Resilience – A standby WorkSpaces has been created. To create this, see Create a standby WorkSpace. • A connection alias in the region using WorkSpaces Thin Client. To verify your region, see Covered regions. Configuring business continuity for WorkSpaces Thin Client To enable WorkSpaces Personal DR on Amazon WorkSpaces Thin Client, you will need to configure connection aliases to map to the environment using the SDK. Sample doc explanation for setting up disaster recovery: Example An example command using the AWS CLI to create a new environment using a WorkSpaces connection alias for the streaming desktop: aws workspaces-thin-client create-environment --region region --desktop-arn/ arn:aws:workspaces:region:account:connectionalias/wsca-id Replace wsca-id with your WorkSpaces Personal connection alias. |
workspaces-thin-client-admin-guide-004 | workspaces-thin-client-admin-guide.pdf | 4 | see Create a standby WorkSpace. • A connection alias in the region using WorkSpaces Thin Client. To verify your region, see Covered regions. Configuring business continuity for WorkSpaces Thin Client To enable WorkSpaces Personal DR on Amazon WorkSpaces Thin Client, you will need to configure connection aliases to map to the environment using the SDK. Sample doc explanation for setting up disaster recovery: Example An example command using the AWS CLI to create a new environment using a WorkSpaces connection alias for the streaming desktop: aws workspaces-thin-client create-environment --region region --desktop-arn/ arn:aws:workspaces:region:account:connectionalias/wsca-id Replace wsca-id with your WorkSpaces Personal connection alias. The ID of the WorkSpaces connection alias can be found in the WorkSpaces Management Console or from the SDK. Business continuity 9 Amazon WorkSpaces Thin Client End user experience Administrator Guide Once business continuity is configured, devices must be registered and active within the last 15 days. After that, should WorkSpaces Thin Client management services become unavailable, users then can stay connected to their sessions for up to 24 hours . In this condition, the device will not receive software updates, exchange posture information, and cannot be activated. The corresponding device entry in WorkSpaces Thin Client console will not show the latest information. If the WorkSpaces Thin Client device management services remain unavailable beyond 24 hours, the following error message will display: "An error has occurred. Please try again. If the issue persists, contact your IT administrator. (Error Code: 3006)." Configuring WorkSpaces Pools for WorkSpaces Thin Client For WorkSpaces Thin Client to be used with Amazon WorkSpaces Pools, your SAML 2.0 identity provider (IdP) will need to be configured to access the WorkSpaces Pools directory. Amazon WorkSpaces Pools directories are a non-persistent pool of WorkSpaces assigned to a group of users. Note Configurations must be made before using the console for the first time. Before you begin Make sure that you have an AWS account to create or administer a WorkSpace. Device users, however, don't need an AWS account to connect to and use their WorkSpaces. Review and understand the concepts listed in Before You Begin Using Active Directory with WorkSpaces Pools in the Amazon WorkSpaces Administration Guide before you proceed with your configuration. Create a WorkSpaces Pool Set up and create a pool from which user applications are launched and streamed. Configuring WorkSpaces Pools for WorkSpaces Thin Client 10 Amazon WorkSpaces Thin Client Administrator Guide Note You should create a directory before you create a WorkSpaces Pool. For more information, see Configure SAML 2.0 and create a WorkSpaces Pools directory directory. To set up and create a pool 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home/. 2. In the navigation pane, choose WorkSpaces, Pools. 3. Choose Create WorkSpaces Pools. 4. Under Onboarding (optional), you can choose Recommend options to me based on my use case to get recommendations on the type of WorkSpaces you want to use. You can skip this step if you know that you want to use WorkSpaces Pools. 5. Under Configure WorkSpaces, enter the following details: • For Name, enter a unique name identifier for the pool. Special characters aren't allowed. • For Description, enter a description for the pool (maximum of 256 characters). • For Bundle, choose from the following the bundle type that you want to use for your WorkSpaces. • Use a base WorkSpaces bundle – Choose one of the bundles from the drop down. For more information about the bundle type you selected, choose Bundle details. To compare bundles offered for pools, choose Compare all bundles. • Use your own custom bundle – Choose a bundle that you previously created. To create a custom bundle, see Create a custom WorkSpaces image and bundle for WorkSpaces Personal. Note BYOL is currently unavailable for WorkSpaces Pools. • For Maximum session duration in minutes, choose the maximum amount of time 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. The maximum session duration that you can set in the WorkSpaces Pools Create a WorkSpaces Pool 11 Amazon WorkSpaces Thin Client Administrator Guide console is 5760 minutes (96 hours). The maximum session duration that you can set using the WorkSpaces Pools API and CLI is 432000 seconds (120 hours). • For Disconnect timeout in minutes, choose the amount of time 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 this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance. • If a user ends the session by choosing |
workspaces-thin-client-admin-guide-005 | workspaces-thin-client-admin-guide.pdf | 5 | Amazon WorkSpaces Thin Client Administrator Guide console is 5760 minutes (96 hours). The maximum session duration that you can set using the WorkSpaces Pools API and CLI is 432000 seconds (120 hours). • For Disconnect timeout in minutes, choose the amount of time 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 this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance. • If a user ends the session by choosing End Session or Logout on the pools toolbar, the disconnect timeout doesn’t apply. Instead, the user is prompted to save any open documents, and then immediately disconnected from the streaming instance. The instance the user was using is then terminated. • For Idle disconnect timeout in minutes, choose the amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the Disconnect timeout in minutes time interval begins. Users are notified before they are disconnected due to inactivity. If they try to reconnect to the streaming session before the time interval specified in Disconnect timeout in minutes has elapsed, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance. Setting this value to 0 disables it. When this value is disabled, users are not disconnected due to inactivity. Note Users are considered idle when they stop providing keyboard or mouse input during their streaming session. For domain-joined pools, the countdown for the idle disconnect timeout doesn't begin until users log in with their Active Directory domain password or with a smart card. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in Idle disconnect timeout in minutes elapses, they are disconnected. • For Scheduled capacity policies (optional), choose Add new schedule capacity. Indicate the start and end date and time for when to provision the minimum and maximum number of instances for your pool based on the minimum number of expected concurrent users. • For Manual scaling policies (optional), specify the scaling policies for pools to use to increase and decrease the capacity of your pool. Expand Manual scaling policies to add new scaling policies. Create a WorkSpaces Pool 12 Amazon WorkSpaces Thin Client Administrator Guide Note The size of your pool is limited by the minimum and maximum capacity that you specified. • Choose Add new scale out policies and enter the values for adding specified instances if the specified capacity utilization is less or more than the specified threshold value. • Choose Add new scale in policies and enter the values for removing specified instances if the specified capacity utilization is less or more than the specified threshold value. • For Tags, specify the key pair value that you want to use. A key can be a general category, such as "project," "owner," or "environment," with specific associated values. 6. On the Select directory page, choose the directory that you created. To create a directory, choose Create directory. For more information, see Manage directories for WorkSpaces Pools. 7. Choose Create WorkSpace Pool. Configuring WorkSpaces Thin Client access Configuring web access for WorkSpaces Pools to use WorkSpaces Thin Client, you will need to use the AWS command land interface. 1. Install or update the AWS Command Line Interface. 2. Configure your AWS CLI settings. 3. Open the AWS CLI. 4. Run the following replacing WORKSPACES_DIRECTORY_ID and REGION with the appropriate information: aws workspaces modify-workspace-access-properties --resource- id WORKSPACES_DIRECTORY_ID --workspace-access-properties '{"DeviceTypeWorkSpacesThinClient":"ALLOW"}' --region REGION Configuring WorkSpaces Thin Client access 13 Amazon WorkSpaces Thin Client Administrator Guide Configuring AppStream 2.0 for Amazon WorkSpaces Thin Client AppStream 2.0 instances will be listed based on Stack names and will require an IdP login URL to be configured on the create environment page. Because SAML authentication for AppStream 2.0 only supports initiated authentication, the administrator will have to enter the correct login URL manually. Note Configurations must be made before using the console for the first time. It is not recommended that you modify any prerequisite features after you start using the console. Step 1: Verify that your system meets AppStream 2.0 required features For WorkSpaces Thin Client administrator console to work with AppStream 2.0 properly, your system must meet the following specific requirements. This table lists all of these supported features and their requirements. Feature Identity Provider Requirement Go to Setting Up SAML in the AppStream 2.0 Administrator Guide to create an Identity Provider. When prompted to Create env console, enter your IDP Login URL. Operating system Windows Platform Type Clipboard Windows Server (2012 R2, 2016 or 2019) Disable Configured |
workspaces-thin-client-admin-guide-006 | workspaces-thin-client-admin-guide.pdf | 6 | that you modify any prerequisite features after you start using the console. Step 1: Verify that your system meets AppStream 2.0 required features For WorkSpaces Thin Client administrator console to work with AppStream 2.0 properly, your system must meet the following specific requirements. This table lists all of these supported features and their requirements. Feature Identity Provider Requirement Go to Setting Up SAML in the AppStream 2.0 Administrator Guide to create an Identity Provider. When prompted to Create env console, enter your IDP Login URL. Operating system Windows Platform Type Clipboard Windows Server (2012 R2, 2016 or 2019) Disable Configured at AppStream 2.0 stack level File transfer Disable Configured at AppStream 2.0 stack level Configuring AppStream 2.0 for Amazon WorkSpaces Thin Client 14 Amazon WorkSpaces Thin Client Feature Print to local device Administrator Guide Requirement Disable Configured at AppStream 2.0 stack level The screen lock requirement through SAML authentication on AppStream 2.0 is also supported. The User Pool and Programmatic authentication mechanisms are not supported on WorkSpaces Thin Client. Step 2: Set up your AppStream 2.0 stacks To stream your applications, AppStream 2.0 requires an environment that includes a fleet that is associated with a stack, and at least one application image. Follow these steps to set up a fleet and stack and give users access to the stack. If you haven't already done so, we recommend that you try the procedures in Get Started with AppStream 2.0: Set Up With Sample Applications. If you want to create an image to use, see Tutorial: Create a Custom AppStream 2.0 Image by Using the AppStream 2.0 Console. If you plan to join a fleet to an Active Directory domain, configure your Active Directory domain before completing the following steps. For more information, see Using Active Directory with AppStream 2.0. Tasks • Create a Fleet • Create a Stack • Provide Access to Users • Clean Up Resources Configuring Amazon WorkSpaces Secure Browser for Amazon WorkSpaces Thin Client Amazon WorkSpaces Secure Browser are based on their web portal endpoints on the WorkSpaces Thin Client Create environment page within AWS console. Step 2: Set up your AppStream 2.0 stacks 15 Amazon WorkSpaces Thin Client Administrator Guide Note Configurations must be made before using the console for the first time. It is not recommended that you modify any prerequisite features after you start using the console. Step 1: Verify that your system meets Amazon WorkSpaces Secure Browser required features For WorkSpaces Thin Client Administrator Console to work properly with Amazon WorkSpaces Secure Browser, your system must meet the following specific requirements. This table lists all of these supported features and their requirements. Feature Clipboard File transfer Print to local device Note Requirement Disable Disable Disable The WorkSpaces Secure Browser extension for single sign-on is not currently supported on WorkSpaces Thin Client. Step 2: Set up WorkSpaces Secure Browser portals WorkSpaces Thin Client works with the WorkSpaces Secure Browser VPC in a specific configuration: 1. Create a VPC using the AWS CodeBuild Cloudformation template. 2. Set up your Identity Provider. 3. Create an Amazon WorkSpaces Secure Browser portal. 4. Test your new Amazon WorkSpaces Secure Browser portal. Step 1: Verify that your system meets Amazon WorkSpaces Secure Browser required features 16 Amazon WorkSpaces Thin Client Administrator Guide Starting the WorkSpaces Thin Client administrator console WorkSpaces Thin Client is a cost-effective thin client device built to work with AWS End User Computing services to provide you with secure, instant access to applications and virtual desktops. Topics • Covered regions • Launching the WorkSpaces Thin Client administrator console Covered regions WorkSpaces Thin Client is available in the following Regions. Only the WorkSpaces Thin Client administrator console is available in these Regions. WorkSpaces Thin Client devices are only currently available in the US, Germany, France, Italy, and Spain. Region Name Region Endpoint Console link US East (N. Virginia) us-east-1 US West (Oregon) us-west-2 Asia Pacific (Mumbai) ap-south-1 thinclien t.us-east -1.amazon aws.com thinclien t.us-west -2.amazon aws.com thinclien t.ap-sout h-1.amazo naws.com https://us-east-1.console.aws.amazon.com/ workspaces-thin-client/home https://us-west-2.console.aws.amazon.com/ workspaces-thin-client/home https://ap-south-1.console.aws.amazon.com/ workspaces-thin-client/home Covered regions 17 Amazon WorkSpaces Thin Client Administrator Guide Region Endpoint Console link Region Name Europe (Ireland) eu-west-1 Canada (Central) ca-central-1 Europe (Frankfurt) eu-central-1 Europe (London) eu-west-2 https://eu-west-1.console.aws.amazon.com/ workspaces-thin-client/home https://ca-central-1.console.aws.amazon.com/ workspaces-thin-client/home https://eu-central-1.console.aws.am azon.com/workspaces-thin-client/home https://eu-west-2.console.aws.amazon.com/ workspaces-thin-client/home thinclien t.eu-west -1.amazon aws.com thinclien t.ca-cent ral-1.ama zonaws.com thinclien t.eu-cent ral-1.ama zonaws.com thinclien t.eu-west -2.amazon aws.com Launching the WorkSpaces Thin Client administrator console When you have an AWS account, you can launch the administrator console and go to the WorkSpaces Thin Client console. To launch the console, do the following: 1. Log on to your AWS account. 2. Access the WorkSpaces Thin Client console. 3. Select Get Started and you will be directed to Environments. Launching the WorkSpaces Thin Client administrator console 18 Amazon WorkSpaces Thin Client Administrator Guide Using WorkSpaces Thin Client administrator console Welcome to the |
workspaces-thin-client-admin-guide-007 | workspaces-thin-client-admin-guide.pdf | 7 | https://eu-west-2.console.aws.amazon.com/ workspaces-thin-client/home thinclien t.eu-west -1.amazon aws.com thinclien t.ca-cent ral-1.ama zonaws.com thinclien t.eu-cent ral-1.ama zonaws.com thinclien t.eu-west -2.amazon aws.com Launching the WorkSpaces Thin Client administrator console When you have an AWS account, you can launch the administrator console and go to the WorkSpaces Thin Client console. To launch the console, do the following: 1. Log on to your AWS account. 2. Access the WorkSpaces Thin Client console. 3. Select Get Started and you will be directed to Environments. Launching the WorkSpaces Thin Client administrator console 18 Amazon WorkSpaces Thin Client Administrator Guide Using WorkSpaces Thin Client administrator console Welcome to the WorkSpaces Thin Client Administrator Console! From here, you can manage your fleet of WorkSpaces Thin Client devices and environments for your team. For information regarding the WorkSpaces Thin Client device, please refer to the WorkSpaces Thin Client User Guide. Let's get started. Topics • Environments • Devices • Software updates 19 Amazon WorkSpaces Thin Client Environments Administrator Guide Each WorkSpaces Thin Client device uses an individual virtual desktop environment to access its online resources. Users access this environment by using one of the following virtual desktop providers: • Amazon WorkSpaces • AppStream 2.0 • Amazon WorkSpaces Secure Browser Environment list There are a number of parameters for your environment for you to review as well as some actions you can take. Environment list details The parameters for your environment are listed for your review. The following table lists each element in the summary and how it functions. Element Name Environments Description The unique identifier associated with this environment. 20 Amazon WorkSpaces Thin Client Administrator Guide Element Description Virtual desktop service Virtual desktop service ID Activation code Device count Time Created Environment list actions The virtual desktop provider that this environment uses. The unique identifier that the virtual desktop service provider assigns to this environment. The code that is used by end users to access the virtual desktop environment. The number of WorkSpaces Thin Client devices that are accessing this environment. The date and time that the environment was created. There are a number of actions you can perform from here. Select any of these to perform the corresponding action. Element Search Refresh View details Actions Description Searches all environments that you manage. Refreshes the environment list. Displays Environment details. Opens a dropdown list where you can Edit or Delete an environment. Create environment Starts the process of creating an environment. Topics • Environment Details • Creating an environment Environment list 21 Amazon WorkSpaces Thin Client • Editing an environment • Deleting an environment Environment Details Administrator Guide When you select an environment, the WorkSpaces Thin Client console displays the details for that environment for you to review. The console also displays the details about the virtual desktop provider that this environment uses. Topics • Summary • Virtual desktop environment details Summary The Summary section provides a high-level overview of the key features of the WorkSpaces Thin Client Environment. The following table lists each element in the summary and how it functions. Element Name Virtual desktop service Virtual desktop service name Description The unique identifier associated with this environment. The virtual desktop provider that this environment uses. The unique identifier that the virtual desktop service provider assigns to this environment. Environment Details 22 Amazon WorkSpaces Thin Client Administrator Guide Element Activation code Always keep software up-to-date Maintenance window start time Maintenance window end time Maintenance window days of the week Associated devices Time created Description This code is used by end users to access the virtual desktop environment. This setting enables automatic software updates. The time each week when automatic software updates begin. The time each week when automatic software updates finish. The days that automatic software updates occur. The number of WorkSpaces Thin Client devices that are accessing this environment. The date and time that this environment was created. Virtual desktop environment details WorkSpaces Thin Client environments are run on a virtual desktop interface. Each interfaces has a different set of parameters that control the dedicated environment. Amazon WorkSpaces directory details WorkSpaces Thin Client environments run on Amazon WorkSpaces use directories to create and run their virtual desktops. The following table lists each element in the details and how it functions. Environment Details 23 Amazon WorkSpaces Thin Client Administrator Guide Element Directory ID Directory name Organization name Directory type Registered Status Description The Amazon WorkSpaces directory associated with this environment. The unique identifier associated with this Amazon WorkSpaces directory. The name of the organization that controls the Amazon WorkSpaces directory. The format of the Amazon WorkSpaces directory. Whether this Amazon WorkSpaces directory is registered. Whether this Amazon WorkSpaces directory is active. Amazon WorkSpaces Secure Browser portal details WorkSpaces Thin Client environments run on Amazon WorkSpaces Secure Browser use web portals to create and run their virtual desktops. The following table |
workspaces-thin-client-admin-guide-008 | workspaces-thin-client-admin-guide.pdf | 8 | functions. Environment Details 23 Amazon WorkSpaces Thin Client Administrator Guide Element Directory ID Directory name Organization name Directory type Registered Status Description The Amazon WorkSpaces directory associated with this environment. The unique identifier associated with this Amazon WorkSpaces directory. The name of the organization that controls the Amazon WorkSpaces directory. The format of the Amazon WorkSpaces directory. Whether this Amazon WorkSpaces directory is registered. Whether this Amazon WorkSpaces directory is active. Amazon WorkSpaces Secure Browser portal details WorkSpaces Thin Client environments run on Amazon WorkSpaces Secure Browser use web portals to create and run their virtual desktops. The following table lists each element in the details and how it functions. Element Name Description The unique identifier associated with this WorkSpaces Secure Browser portal. Environment Details 24 Amazon WorkSpaces Thin Client Administrator Guide Element Time created Web portal endpoint AppStream 2.0 details Description The date and time when this WorkSpaces Secure Browser portal was created. The url used to access your virtual desktop environment. WorkSpaces Thin Client environments run on AppStream 2.0 information stacks to create and run their virtual desktops. The following table lists each element in the details and how it functions. Element Stack name IdP login url Time created Description The unique identifier associated with this AppStream 2.0 stack. The identity provider url that is used to log in and out of your AppStream 2.0 stack. The date and time when this AppStream 2.0 stack was created. Creating an environment To begin, each device requires an AWS End User Computing service. WorkSpaces Thin Client uses the following services: • Amazon WorkSpaces through an assigned directory • AppStream 2.0 through an assigned stack Creating an environment 25 Amazon WorkSpaces Thin Client Administrator Guide • Amazon WorkSpaces Secure Browser through a web portal address You must either assign a service to an existing environment or create a new one. Note WorkSpaces Thin Client only displays virtual desktops in the same Region. Topics • Step 1: Enter your environment details • Step 2: Select your virtual desktop provider • Step 3: Send the activation code to your device users Step 1: Enter your environment details 1. 2. Enter a name for your environment in the Environment details field. To set up automatic software patches, check the box for Always keep software up-to-date. Note If automatic software updates is not enabled, the devices registered to this environment won't receive software updates until you manually push the update or when the software reaches its expiration and the system forces an update. Also, the devices Software Set version is determined by the system. This version may not be the most recent one. 3. Select when you want to schedule the maintenance window for your environment. • Apply system wide maintenance window - Automatically updates the environment software at a determined time each week. • Apply custom maintenance window - Set a day and time when you want the environment software to update each week. 4. Select a virtual desktop service. • Amazon WorkSpaces Creating an environment 26 Amazon WorkSpaces Thin Client Administrator Guide • Amazon WorkSpaces Secure Browser • AppStream 2.0 Step 2: Select your virtual desktop provider You must have a service to provide your users access to their virtual desktop and compatible resources. Important For WorkSpaces Thin Client Administrator Console to work properly, your system must meet specific requirements. These requirements are listed in Prerequisites and Configurations. Make sure that your system meets these requirements before you set up your console. Using Amazon WorkSpaces Amazon WorkSpaces is a fully managed desktop virtualization service for Windows that enables you to access resources from any supported device. 1. To use Amazon WorkSpaces, do one of the following: • Select the directory that you want to use for your environment. You can either browse through the dropdown list or you can search the directories by using the search field. • Create a directory by selecting the Create WorkSpaces directory button. For more information on creating WorkSpaces directories, see Manage directories for WorkSpaces. 2. Select the Create environment button. When you create your environment, you can still edit the details later. For more information, see Editing an environment. Using AppStream 2.0 AppStream 2.0 is a fully managed, secure application streaming service that you can use to stream desktop applications from AWS to a web browser. Creating an environment 27 Amazon WorkSpaces Thin Client Administrator Guide Important In order to create an AppStream 2.0 environment, you must have cli_follow_urlparam set to false. To achieve this, do the following: • For a default profile, run aws configure set cli_follow_urlparam false. • For a profile with name ProfileName, run aws configure set cli_follow_urlparam false --profile ProfileName. 1. To set up AppStream 2.0, do one of the following: • Select the stack that you want to use for your environment. |
workspaces-thin-client-admin-guide-009 | workspaces-thin-client-admin-guide.pdf | 9 | managed, secure application streaming service that you can use to stream desktop applications from AWS to a web browser. Creating an environment 27 Amazon WorkSpaces Thin Client Administrator Guide Important In order to create an AppStream 2.0 environment, you must have cli_follow_urlparam set to false. To achieve this, do the following: • For a default profile, run aws configure set cli_follow_urlparam false. • For a profile with name ProfileName, run aws configure set cli_follow_urlparam false --profile ProfileName. 1. To set up AppStream 2.0, do one of the following: • Select the stack that you want to use for your environment. You can either browse through the dropdown list or you can search the stacks by using the search field. • Create a stack by selecting the Create Stack button. For more information on creating AppStream 2.0 stacks, see Create a Stack. 2. Enter your identity provider login and logout URL in the IdP login URL field. This provides users with a place to log in and out of WorkSpaces Thin Client. 3. Select the Create environment button. After you create your environment, you can still edit the details later. For more information, see Editing an environment. Using Amazon WorkSpaces Secure Browser Amazon WorkSpaces Secure Browser is a low-cost, fully managed WorkSpaces console that is built to deliver secure web-based workloads and software as a service (SaaS) application access to users within existing web browsers. 1. To set up Amazon WorkSpaces Secure Browser, do one of the following: • Select the web portal that you want to use for your environment. You can either browse through the dropdown list or you can search the web portals by using the search field. • Create a web portal by selecting the Create WorkSpaces Secure Browser button. For more information on creating WorkSpaces Secure Browser web portals, see Setting up Amazon WorkSpaces Secure Browser. 2. Select the Create environment button. Creating an environment 28 Amazon WorkSpaces Thin Client Administrator Guide After you create your environment, you can still edit the details later. For more information, see Editing an environment. Step 3: Send the activation code to your device users After you set your environment and virtual desktop service, you will receive a unique activation code for your setup on the AWS Management Console. Provide this activation code to any WorkSpaces Thin Client device user, and they can use it to access their virtual desktop. See the WorkSpaces Thin Client User Guide for additional information on how to help your device user set up their Amazon WorkSpaces Thin Client. Editing an environment The WorkSpaces Thin Client administration console manages virtual desktop environments for individual users. From this console, you can edit or delete virtual desktop environments. 1. Select the environment that you want to edit. 2. 3. 4. Note You can either browse through the dropdown list or you can search the environments by using the search field. Select the Actions button. Select Edit from the dropdown list. You will be directed to the Edit environment window. Edit any of the following: • Change the name of your environment in the Environment name field. • Change the check box for Software updates details for automatic software patch updates. • Change when you want to schedule the maintenance window for your environment. 5. Select the Edit environment button. Editing an environment 29 Amazon WorkSpaces Thin Client Administrator Guide Deleting an environment Note You cannot delete an environment if it has any devices registered to it. First, you must deregister and delete all devices in an environment. 1. Select the environment that you want to delete. You can either browse through the dropdown list or you can search the environments by using the search field. 2. 3. 4. 5. Select the Actions button. Select Delete from the dropdown list. The Delete environment confirmation window appears. Type "delete" in the confirmation field. Select the Delete button. Devices Each WorkSpaces Thin Client end user has a dedicated device that connects them to their virtual desktop environments and online resources. These devices are managed through the WorkSpaces Thin Client administrator console on the AWS site. From this console, you can order devices for your team. Device list There are a number of parameters for any device in your network for you to review as well as some actions you can take. Deleting an environment 30 Amazon WorkSpaces Thin Client Device list details Administrator Guide The parameters for your device are listed for your review. The following table lists each element in the summary and how it functions. Element Device ID Device name Activity status Enrollment status Description The identification number assigned to an individual device. (optional) The unique name that you give to a device. The current status of a device. There are two status states: • Active – Connected |
workspaces-thin-client-admin-guide-010 | workspaces-thin-client-admin-guide.pdf | 10 | number of parameters for any device in your network for you to review as well as some actions you can take. Deleting an environment 30 Amazon WorkSpaces Thin Client Device list details Administrator Guide The parameters for your device are listed for your review. The following table lists each element in the summary and how it functions. Element Device ID Device name Activity status Enrollment status Description The identification number assigned to an individual device. (optional) The unique name that you give to a device. The current status of a device. There are two status states: • Active – Connected to a network at least once in the past seven days. • Inactive – Not connected to a network in the past seven days. Confirmation that a device has been set up, is associated with this AWS account, and is part of a specific environment. It can be in one of the following states: • Registered – This is the default status. • Deregistering – The device is in the Reset and Deregister process. Note You can delete a device if it is in a deregistering state. • Deregsitered – The device has been successfully deregistered. Device list 31 Amazon WorkSpaces Thin Client Administrator Guide Element Environment ID Software compliance Device list actions Description Note You can only delete a device if it’s in either a Deregistering or Deregiste red status. • Archived – The device is archived. The identifier of the environment to which this device is attached. The compliance status of the device software. There are two status states: • Compliant • Not compliant There are a number of actions you can perform from here. Select any of these to perform the corresponding action. Element Search Refresh View details Actions Description Searches all devices that you manage. Refreshes the device list. Displays Device details. Opens a dropdown list where you can do the following: • Edit device name • Deregister • Archive Device list 32 Amazon WorkSpaces Thin Client Administrator Guide Element Description • Delete • Export device details Order devices Starts the process of ordering devices. Topics • Device details • Editing a device name • Resetting and deregistering a device • Archiving a device • Deleting a device • Exporting device details Device details When you select an device, the WorkSpaces Thin Client console displays the details for that device for you to review. The console also displays the details about the device's network type and connected peripherals. Topics • Summary • Device settings • User Activity Summary The Summary section provides a high-level overview of the key features of the WorkSpaces Thin Client device. The following table lists each element in the summary and how it functions. Device details 33 Amazon WorkSpaces Thin Client Administrator Guide Element Description Device serial number ARN Device name Device type Activity status Environment ID Enrollment status The identification number assigned to an individual device. The unique identifier for the device in Amazon Resource Name (ARN) format. The name that you give to a device. If you have not created a name, you can name it, or it will get a default name. The type of end user device that is linked to the account. The current status of this device. The two status states are: • Active • Inactive The identification number of the environment that the device uses. Confirmation that a device has been set up, is associated with this AWS account, and is part of a specific environment. It can be in one of the following four states: Device details 34 Amazon WorkSpaces Thin Client Administrator Guide Element Description • Registered – This is the default status. • Deregistering – The device is in the Reset and Deregister process. • Deregistered – The device has been successfully deregistered. Note You can only delete the device if it’s in either a Deregistered or Archived status. • Archived – This device has been marked by the administrator as not currently in service. The date the device was activated. The date and time of the most recent login. The date and time of the most recent device check-in. The software version that this device is currently using. Enrolled since Last logged in Last posture checked at Current software version Scheduled for software update The scheduled software version on the device. Software compliance Confirmation that the software set is valid. There are two status states: • Compliant • Not Compliant Device details 35 Amazon WorkSpaces Thin Client User log Administrator Guide Element Last device access Device settings Description The date and time when this device was last used. The parameters for your device are listed for your review. The following table lists each element and how it functions. Note Device settings information is updated only when device is online. If device |
workspaces-thin-client-admin-guide-011 | workspaces-thin-client-admin-guide.pdf | 11 | logged in Last posture checked at Current software version Scheduled for software update The scheduled software version on the device. Software compliance Confirmation that the software set is valid. There are two status states: • Compliant • Not Compliant Device details 35 Amazon WorkSpaces Thin Client User log Administrator Guide Element Last device access Device settings Description The date and time when this device was last used. The parameters for your device are listed for your review. The following table lists each element and how it functions. Note Device settings information is updated only when device is online. If device is offline, some information may be out of date. Heading and Network WorkSpaces Thin Client device details provides an overview of the device's network connections. The following table lists each element and how it functions. Device details 36 Amazon WorkSpaces Thin Client Administrator Guide Element Last synced on Connection type Status Local IP address Gateway address Description The date and time of the most recent device settings sync with console. The type of network connection used by the device. The connection type can either be Ethernet or Wifi. The status of the network. If the device is currently connected, or connected within the past 20 minutes, the status will show up as ‘connected’. If the network has been disconnec ted for more than 20 min, the status will change to show the time passed since the device is last connected to internet, e.g. “last connected 20 minutes ago”. The local IP address of the connected network. The gateway address of the connected network. Bluetooth and peripheral devices WorkSpaces Thin Client device details provide a list of any connected peripherals connect to a device. The following table lists each element and how it functions. Device details 37 Amazon WorkSpaces Thin Client Administrator Guide Element Bluetooth Connected peripheral devices Power and sleep Description The Bluetooth status of the device. The two status states are: • Enabled • Disabled The list of names of the connected periphera ls, such as Logitech mouse, and the type of the connected peripherals, such as Mouse (USB). Each WorkSpaces Thin Client device has a power saving mode. The following table lists the status of this mode. Element Description Turn off display after The period of inactive time after which the device turns off its display. Device details 38 Amazon WorkSpaces Thin Client User Activity Administrator Guide This tab shows the log of a specific device's setup and usage information. The following table lists each element of this log. Element Description Device accessed on The date and time the device is activated. User ID The identification number of the user accessing the device. Virtual desktop service The virtual desktop service the device uses. Virtual desktop service ID IP address Event type Note The virtual desktop service ID number associated with the user. The identification number of the IP accessing the device. Details on how the device is being used. With the exception of WorkSpaces Personal, VDIs only show a Login initiated event. You can use the search bar above the table to find specific information in the table. You can also filter the table results by date and time. You can export the table to a csv file by selecting the Export details button. Device details 39 Amazon WorkSpaces Thin Client Editing a device name Administrator Guide 1. Select the device that you want to edit. You can either browse through the dropdown list or you can search for device by using the search field. Select the Actions button. Select Edit device name from the dropdown list. The Edit device name window appears. Enter the new device name in the Device name confirmation field. Select the Save button. 2. 3. 4. 5. Resetting and deregistering a device 1. 2. 3. 4. 5. Select the device that you want to deregister. You can either browse through the dropdown list or you can search for the device by using the search field. Select the Actions button. Select Deregister from the dropdown list. The Deregister window appears. Enter "deregister" in the confirmation field. Select the Deregister button. Note Deregistering forcibly logs out the user and require a reboot of their WorkSpaces Thin Client device in the middle of a session. Archiving a device 1. Select the device that you want to archive. You can either browse through the dropdown list or you can search for the device by using the search field. Select the Actions button. Select Archive from the dropdown list. The Archive window appears. Enter "reset and archive" in the confirmation field. Select the Reset and archive button. 2. 3. 4. 5. Editing a device name 40 Amazon WorkSpaces Thin Client Administrator Guide Note Archiving a device forcibly logs out the user and require a reboot of their WorkSpaces |
workspaces-thin-client-admin-guide-012 | workspaces-thin-client-admin-guide.pdf | 12 | Thin Client device in the middle of a session. Archiving a device 1. Select the device that you want to archive. You can either browse through the dropdown list or you can search for the device by using the search field. Select the Actions button. Select Archive from the dropdown list. The Archive window appears. Enter "reset and archive" in the confirmation field. Select the Reset and archive button. 2. 3. 4. 5. Editing a device name 40 Amazon WorkSpaces Thin Client Administrator Guide Note Archiving a device forcibly logs out the user and require a reboot of their WorkSpaces Thin Client device in the middle of a session. Deleting a device 1. Select the device that you want to delete. You can either browse through the dropdown list or you can search for the device by using the search field. Select the Actions button. Select Delete from the dropdown list. The Delete window appears. Enter "delete" in the confirmation field. Select the Delete button. 2. 3. 4. 5. Exporting device details 1. Select the device from which you want to export the details. You can either browse through the dropdown list or you can search for the device by using the search field. 2. 3. Select the Actions button. Select Export device details from the dropdown list. The details for the selected device download in a spreadsheet format. Software updates WorkSpaces Thin Client sometimes requires software updates that introduce new functionality and apply security patches. These updates are represented by a versioned Software set. A Software set can contain updates to the software applications or operating system for the WorkSpaces Thin Client device. From this console, you can choose to update the software immediately or you can schedule an automatic update during the maintenance window for the environments. Refer to WorkSpaces Thin Client environment software sets for the list of released Software Sets. Topics Deleting a device 41 Amazon WorkSpaces Thin Client Administrator Guide • Updating environment software • Updating device software • WorkSpaces Thin Client software releases Updating environment software WorkSpaces Thin Client is an AWS End User Computing service that provides users access to virtual desktops. These virtual desktops are periodically updated with new software sets. To update environment software, do the following: 1. 2. 3. 4. 5. Select the software set from the list in Available software updates. For a list of software sets, refer to WorkSpaces Thin Client environment software sets. Select the Install button. Select Environments at the top of the page. Select the environment to update from the list in the Environments section. Select when to update the environment in the Schedule the update by choosing one of the following: • Update software now - Starts the update of the environment software on all registered devices. Note Updating software now may interrupt any active user sessions. • Update software during each environments maintenance window - Updates the environment software during the scheduled maintenance window for the environment. 6. Check the box to authorize the update. This box must be checked for the software to update. 7. Select the Install button. Updating device software WorkSpaces Thin Client is an AWS End User Computing service that provides a thin client device that connects users to dedicated virtual desktops. These devices are periodically updated with new software. To update device software, do the following: Updating environment software 42 Amazon WorkSpaces Thin Client Administrator Guide 1. 2. 3. 4. 5. Select the software set from the list in Available software updates. Select the Install button. Select Device at the top of the page. Select the device or devices to update from the list in the Devices section. For a list of software sets, refer to WorkSpaces Thin Client environment software sets. Select when to update the environment from the Schedule the update options by choosing one of the following: • Update software now - Immediately updates the device software. Note Updating the software now may interrupt any active user sessions. • Update software during each devices maintenance window - Updates the environment software during the scheduled maintenance window for the device. 6. Check the box to authorize the update. This box must be checked for the software to update. 7. Select the Install button. WorkSpaces Thin Client software releases WorkSpaces Thin Client is an AWS End User Computing service that provides users access to virtual desktops on a device. These devices are periodically updated with new software sets. The following table describes all the released software sets. Administrators can use the AWS management console to view available software sets. Software set Release date Changes 2.14.0 2.13.0 4-29-2025 • Usability improvements and bug fixes. 3-31-2025 • End users will see product satisfaction feedback survey as a notification. • Adds prerelease feature support for FIDO2 WorkSpaces Thin Client software |
workspaces-thin-client-admin-guide-013 | workspaces-thin-client-admin-guide.pdf | 13 | to update. 7. Select the Install button. WorkSpaces Thin Client software releases WorkSpaces Thin Client is an AWS End User Computing service that provides users access to virtual desktops on a device. These devices are periodically updated with new software sets. The following table describes all the released software sets. Administrators can use the AWS management console to view available software sets. Software set Release date Changes 2.14.0 2.13.0 4-29-2025 • Usability improvements and bug fixes. 3-31-2025 • End users will see product satisfaction feedback survey as a notification. • Adds prerelease feature support for FIDO2 WorkSpaces Thin Client software releases 43 Amazon WorkSpaces Thin Client Administrator Guide Software set Release date Changes authentication flow. See FIDO2 pre-session details. • The device will not go to sleep if audio/video is playing in the session. • End users see notifications when monitor is connected and disconnected. • Device collects diagnosti c information from the operation system for service improvements. • Fixes an issue where an incorrect date was shown in Settings for software installed date. • Fixes an issue where end user was logged out of session on pressing the back button on mouse. • Fixes an issue where audio was crackling during calls with mouse movements across monitors. 2.12.0 1-30-2025 2.11.2 1-24-2025 2.11.1 12-27-2024 • Fixes dual monitor auto- 2.11.0 12-19-2024 extend issue. • Minor improvements to VoiceView label. • WorkSpaces Thin Client now supports VoiceView and Magnifier. WorkSpaces Thin Client software releases 44 Amazon WorkSpaces Thin Client Administrator Guide Software set Release date Changes 2.10.0 11-22-2024 2.9.0 10-28-2024 2.8.1 09-26-2024 • End users can use a keyboard shortcut to collapse the device toolbar. • Administrators can now view their end users' device settings within AWS console under Device details page of a specific device. • WorkSpaces Thin Client now supports 2K resolution monitor for single screen. • End users can see notificat ions related to network diagnostics on their WorkSpaces Thin Client devices. • End user can now choose to place device toolbar on left or right as per their preference. • Fixed an issue where device did not install software updates during sleep or idle time. • Fixed a critical issue where the second monitor could not be toggled on after the device woke up from sleep. WorkSpaces Thin Client software releases 45 Amazon WorkSpaces Thin Client Administrator Guide Software set Release date Changes 2.8.0 09-06-2024 • Thin Client supports monitors with 4K resolutio n. • Users can connect to the VDI session even if WorkSpaces Thin Client device management services are temporarily unavailable. • Fixed the issue where User activity details section in AWS console showed duplicate entries. • End users can use PrintScre en option while streaming WorkSpaces on WorkSpaces Thin Client. 2.7.1 08-27-2024 • Zero-day fixes for Chromium's CVE-2024- 7971 and CVE-2024-7965 critical security issues. 2.7.0 07-29-2024 • Improvements to performance of second monitor. • Fixed an issue where the toolbar language was unaffected on changing device language. • Device now collects diagnostic information for service improvements. WorkSpaces Thin Client software releases 46 Amazon WorkSpaces Thin Client Administrator Guide Software set Release date Changes 2.6.0 07-09-2024 • Users can defer the incoming software updates so that they can finish their work without interruption. • Device settings allows users to forget saved WiFi networks. • Improvements to performance of audio/vid eo calls in the session. • Some user settings for the VDI sessions persist across device reboot. 2.5.0 06-13-2024 • Fixed the issue where device showed keyboard and mouse setup screen briefly on waking up from sleep before launching the session. • The Home button on the device toolbar renamed to Sign In. • Improvements to performance of audio/vid eo calls in the session. • Zero-day fix for Chromium' s CVE-2024-5274 critical security issue. • Zero-day fix for Chromium' s CVE-2024-4947 critical security issue. 2.4.3 2.4.2 05-29-2024 05-17-2024 WorkSpaces Thin Client software releases 47 Amazon WorkSpaces Thin Client Administrator Guide Software set Release date Changes 2.4.1 05-15-2024 • Zero-day fixes for 2.4.0 05-09-2024 Chromium's CVE-2024- 4671 and CVE-2024-4761 critical security issues. • Fixed the issue that allowed right-clicking on AWS and Privacy links on WorkSpace s sign-in page to open the browser in a stand-alone mode. • Fixed an issue blocking "accounts.google.com" and preventing the use of Google Workspace as the IDP for AppStream 2.0 session. • Device settings toolbar auto-collapses with a click in any area on the screen. WorkSpaces Thin Client software releases 48 Amazon WorkSpaces Thin Client Administrator Guide Software set Release date Changes 2.3.0 04-05-2024 2.2.1 02-16-2024 2.2.0 02-08-2024 • Device settings show up in a collapsed toolbar allowing better utilization of the visible screen. • End users can now configure the duration to wait before the device sleeps on inactivity. • Fixed the issue where "about:blank" URL shows up on the |
workspaces-thin-client-admin-guide-014 | workspaces-thin-client-admin-guide.pdf | 14 | • Fixed an issue blocking "accounts.google.com" and preventing the use of Google Workspace as the IDP for AppStream 2.0 session. • Device settings toolbar auto-collapses with a click in any area on the screen. WorkSpaces Thin Client software releases 48 Amazon WorkSpaces Thin Client Administrator Guide Software set Release date Changes 2.3.0 04-05-2024 2.2.1 02-16-2024 2.2.0 02-08-2024 • Device settings show up in a collapsed toolbar allowing better utilization of the visible screen. • End users can now configure the duration to wait before the device sleeps on inactivity. • Fixed the issue where "about:blank" URL shows up on the second display. • Fixed the issue that resulted in a white screen when extended display is closed. • Volume levels set by end users now persists across device restarts. • Fixed an issue that occurs during the sign-in process that prevented users from logging into WorkSpaces configured with SAML 2.0 authentication. • Added support for ISO keyboards with English (United Kingdom), French, German, Italian, Spanish locales. WorkSpaces Thin Client software releases 49 Amazon WorkSpaces Thin Client Administrator Guide Software set Release date Changes 2.1.2 01-26-2024 • Zero-day fix for Chromium' s CVE-2024-0519 critical security issue. • Improvement to end user latency associated with Lock functionality. • Internal device-facing endpoints are switched over to 'thinclient*' domain. • Zero-day fix for Chromium' s CVE-2023-7024 critical security issue. • Adds a Home button to the device settings and enables support for Meta keys. This allows ends users to invoke the lock screen by pressing Meta+L. • Zero-day fix for Chromium' s CVE-2024-6345 critical security issue. 12-21-2023 12-20-2023 12-06-2023 2.1.1 2.1.0 2.0.1 2.0.0 11-15-2023 • Initial release WorkSpaces Thin Client software releases 50 Amazon WorkSpaces Thin Client Administrator Guide Using tags on WorkSpaces Thin Client resources You can organize and manage the resources for your WorkSpaces Thin Client by assigning your own metadata to each resource as tags. You specify a key and a value for each tag. A key can be a general category, such as "project," "owner," or "environment," with specific associated values. You can use tags as a simple yet powerful way to manage AWS resources and to organize data, including billing data. When you add tags to an existing resource, those tags don't appear in your cost allocation report until the first day of the following month. For example, if you add tags to an existing WorkSpaces Thin Client device on July 15, the tags won't appear in your cost allocation report until August 1. For more information, see Using Cost Allocation Tags in the AWS Billing User Guide. Note To view your WorkSpaces Thin Client resource tags in the Cost Explorer, you must activate the tags that you have applied to your WorkSpaces Thin Client resources by following the instructions in Activating User-Defined Cost Allocation Tags in the AWS Billing User Guide. Tags appear 24 hours after activation, but it can take 4–5 days for values associated with those tags to appear in the Cost Explorer. Additionally, to appear and provide cost data in Cost Explorer, WorkSpaces Thin Client resources that have been tagged must incur charges during that time. Cost Explorer only shows cost data from the time when the tags were activated. No historical data is available at this time. Resources that you can tag: • You can add tags to the following resources when you create them—WorkSpaces Thin Client environments. • You can add tags to existing resources of the following types—WorkSpaces Thin Client environments, devices, and software sets. • You can configure the tags for a device in an environment to be automatically applied when you register a device. Tag restrictions • Maximum number of tags per resource—50 51 Amazon WorkSpaces Thin Client Administrator Guide • Maximum key length—128 Unicode characters • Maximum value length—256 Unicode characters • Tag keys and values are case-sensitive. Allowed characters are letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @. Do not use leading or trailing spaces. • Do not use the aws: prefix in your tag names or values because it is reserved for AWS use. You can't edit or delete tag names or values with this prefix. To manage tags for an existing environment by using the console 1. Open the WorkSpaces Thin Client console. 2. Select the Environment to open its details page 3. Choose Edit. 4. In Tags section, do one or more of the following:. • To add a tag, choose Add new tag and then edit the values of Key and Value. • To update a tag, edit the value of Value. • To delete a tag, choose the Remove next to the tag. 5. When you are finished updating the tags, choose Save. To manage tags for an existing device by |
workspaces-thin-client-admin-guide-015 | workspaces-thin-client-admin-guide.pdf | 15 | prefix. To manage tags for an existing environment by using the console 1. Open the WorkSpaces Thin Client console. 2. Select the Environment to open its details page 3. Choose Edit. 4. In Tags section, do one or more of the following:. • To add a tag, choose Add new tag and then edit the values of Key and Value. • To update a tag, edit the value of Value. • To delete a tag, choose the Remove next to the tag. 5. When you are finished updating the tags, choose Save. To manage tags for an existing device by using the console 1. Open the WorkSpaces Thin Client console. 2. Select the device to open its details page. 3. Choose Tags. 4. Choose Manage tags. 5. Do one or more of the following: • To add a tag, choose Add new tag and then edit the values of Key and Value. • To update a tag, edit the value of Value. • To delete a tag, choose the Remove next to the tag. 6. When you are finished updating the tags, choose Save. 52 Amazon WorkSpaces Thin Client Administrator Guide To manage tags for a new device by using the console 1. Open the WorkSpaces Thin Client console. 2. Select the Environment to open its details page. 3. Choose Edit. 4. In Device creation tags section, do one or more of the following: • To add a tag, choose Add new tag and then edit the values of Key and Value. • To update a tag, edit the value of Value. • To delete a tag, choose the Remove next to the tag. 5. When you are finished updating the tags, choose Save. When a device is created, it is registered with the environment and the device creation tags are applied. This only happens during new device registration. Additionally, the aws:thinclient:environment-id system tag is applied with the environment Id used as value. To manage tags for a software update by using the console 1. Open the WorkSpaces Thin Client console. 2. 3. Select the Software update to open its details page. In Tags section, choose Manage tags. 4. Do one or more of the following: • To add a tag, choose Add new tag and then edit the values of Key and Value. • To update a tag, edit the value of Value. • To delete a tag, choose the Remove next to the tag. 5. When you are finished updating the tags, choose Save. 53 Amazon WorkSpaces Thin Client Administrator Guide Security in Amazon WorkSpaces Thin Client Cloud security at AWS is the highest priority. As an AWS customer, you benefit from data centers and network architectures that are built to meet the requirements of the most security-sensitive organizations. Security is a shared responsibility between AWS and you. The shared responsibility model describes this as security of the cloud and security in the cloud: • Security of the cloud – AWS is responsible for protecting the infrastructure that runs AWS services in the AWS Cloud. AWS also provides you with services that you can use securely. Third-party auditors regularly test and verify the effectiveness of our security as part of the AWS Compliance Programs. To learn about the compliance programs that apply to Amazon WorkSpaces Thin Client, see AWS Services in Scope by Compliance Program. • Security in the cloud – Your responsibility is determined by the AWS service that you use. You are also responsible for other factors including the sensitivity of your data, your company’s requirements, and applicable laws and regulations. This documentation helps you understand how to apply the shared responsibility model when using WorkSpaces Thin Client. The following topics show you how to configure WorkSpaces Thin Client to meet your security and compliance objectives. You can also learn how to use other AWS services that help you to monitor and secure your WorkSpaces Thin Client resources. Topics • Data protection in Amazon WorkSpaces Thin Client • Identity and access management for Amazon WorkSpaces Thin Client • Resilience in Amazon WorkSpaces Thin Client • Vulnerability analysis and management in Amazon WorkSpaces Thin Client Data protection in Amazon WorkSpaces Thin Client The AWS shared responsibility model applies to data protection in Amazon WorkSpaces Thin Client. As described in this model, AWS is responsible for protecting the global infrastructure that runs all of the AWS Cloud. You are responsible for maintaining control over your content that is hosted on this infrastructure. You are also responsible for the security configuration and Data protection 54 Amazon WorkSpaces Thin Client Administrator Guide management tasks for the AWS services that you use. For more information about data privacy, see the Data Privacy FAQ. For information about data protection in Europe, see the AWS Shared Responsibility Model and GDPR blog post on |
workspaces-thin-client-admin-guide-016 | workspaces-thin-client-admin-guide.pdf | 16 | applies to data protection in Amazon WorkSpaces Thin Client. As described in this model, AWS is responsible for protecting the global infrastructure that runs all of the AWS Cloud. You are responsible for maintaining control over your content that is hosted on this infrastructure. You are also responsible for the security configuration and Data protection 54 Amazon WorkSpaces Thin Client Administrator Guide management tasks for the AWS services that you use. For more information about data privacy, see the Data Privacy FAQ. For information about data protection in Europe, see the AWS Shared Responsibility Model and GDPR blog post on the AWS Security Blog. For data protection purposes, we recommend that you protect AWS account credentials and set up individual users with AWS IAM Identity Center or AWS Identity and Access Management (IAM). That way, each user is given only the permissions necessary to fulfill their job duties. We also recommend that you secure your data in the following ways: • Use multi-factor authentication (MFA) with each account. • Use SSL/TLS to communicate with AWS resources. We require TLS 1.2 and recommend TLS 1.3. • Set up API and user activity logging with AWS CloudTrail. For information about using CloudTrail trails to capture AWS activities, see Working with CloudTrail trails in the AWS CloudTrail User Guide. • Use AWS encryption solutions, along with all default security controls within AWS services. • Use advanced managed security services such as Amazon Macie, which assists in discovering and securing sensitive data that is stored in Amazon S3. • If you require FIPS 140-3 validated cryptographic modules when accessing AWS through a command line interface or an API, use a FIPS endpoint. For more information about the available FIPS endpoints, see Federal Information Processing Standard (FIPS) 140-3. We strongly recommend that you never put confidential or sensitive information, such as your customers' email addresses, into tags or free-form text fields such as a Name field. This includes when you work with WorkSpaces Thin Client or other AWS services using the console, API, AWS CLI, or AWS SDKs. Any data that you enter into tags or free-form text fields used for names may be used for billing or diagnostic logs. If you provide a URL to an external server, we strongly recommend that you do not include credentials information in the URL to validate your request to that server. Amazon WorkSpaces Thin Client collects and provide information about user use of WorkSpaces Thin Client devices and their interaction with the virtual desktop services. For example, available memory, network diagnostics, network information, device connectivity, SAML credentials, device identification information, and crash reports. This information is used to provide you the service and may be used to improve ythe user experience with the service. Further, solely to provide you with the service, the information may be transferred outside of the AWS Region where users are using the service. We process this information in accordance with the AWS Privacy Notice. Data protection 55 Amazon WorkSpaces Thin Client Topics • Data encryption • Data encryption at rest for Amazon WorkSpaces Thin Client Administrator Guide • Encryption in transit • Key management • Internet work traffic privacy Data encryption WorkSpaces Thin Client collects environment and device customization data, such as user settings, device identifiers, identity provider information, and streaming desktop identifiers. WorkSpaces Thin Client also collects session timestamps. Collected data is stored in Amazon DynamoDB and Amazon S3. WorkSpaces Thin Client uses AWS Key Management Service (KMS) for encryption. To secure your content, follow these guidelines: • Implement least privilege access and create specific roles to be used for WorkSpaces Thin Client actions. • Protect data end-to-end by providing a customer-managed key, so WorkSpaces Thin Client can encrypt your data at rest with the keys you supply. • Be careful with sharing environment activation codes and user credentials: • Admins are required to log into the WorkSpaces Thin Client console, and users are required to provide activation codes for WorkSpaces Thin Client setup use credentials to log into the streaming desktop. • Anyone with physical access can set up a WorkSpaces Thin Client, but they can't start a session unless they have a valid activation code and user credentials to log in. • Users can explicitly end their sessions by choosing to lock their screen, reboot, or shut down the device by using the device toolbar. This discards the device session and clears session credentials. WorkSpaces Thin Client secures content and metadata by default by encrypting all sensitive data with AWS KMS. If there is an error applying existing settings, a user can't access new sessions and devices cannot apply software updates. Data encryption 56 Amazon WorkSpaces Thin Client Administrator Guide Data encryption at rest for Amazon WorkSpaces Thin Client Amazon WorkSpaces Thin Client provides encryption by default to protect |
workspaces-thin-client-admin-guide-017 | workspaces-thin-client-admin-guide.pdf | 17 | log in. • Users can explicitly end their sessions by choosing to lock their screen, reboot, or shut down the device by using the device toolbar. This discards the device session and clears session credentials. WorkSpaces Thin Client secures content and metadata by default by encrypting all sensitive data with AWS KMS. If there is an error applying existing settings, a user can't access new sessions and devices cannot apply software updates. Data encryption 56 Amazon WorkSpaces Thin Client Administrator Guide Data encryption at rest for Amazon WorkSpaces Thin Client Amazon WorkSpaces Thin Client provides encryption by default to protect sensitive customer data at rest by using AWS owned encryption keys. • AWS owned keys — Amazon WorkSpaces Thin Client uses these keys by default to automatically encrypt personally identifiable data. You cannot view, manage, or use AWS owned keys or audit their use. However, you don't have to take any action or change any programs to protect the keys that encrypt your data. For more information, see AWS owned keys in the AWS Key Management Service Developer Guide. Encryption of data at rest by default helps reduce the operational overhead and complexity involved in protecting sensitive data. At the same time, it enables you to build secure applications that meet strict encryption compliance and regulatory requirements. While you can't disable this layer of encryption or select an alternate encryption type, you can add a second layer of encryption over the existing AWS owned encryption keys by choosing a customer managed key when you create your Thin Client Environment: • Customer managed keys — Amazon WorkSpaces Thin Client supports the use of a symmetric customer managed key that you create, own, and manage to add a second layer of encryption on the existing AWS owned encryption. Because you have full control of this layer of encryption, you can perform such tasks as the following: • Establishing and maintaining key policies • Establishing and maintaining IAM policies • Enabling and disabling key policies • Rotating key cryptographic material • Adding tags • Creating key aliases • Scheduling keys for deletion For more information, see customer managed key in the AWS Key Management Service Developer Guide. The following table summarizes how Amazon WorkSpaces Thin Client encrypts personally identifiable data. Encryption at rest 57 Amazon WorkSpaces Thin Client Administrator Guide Data type AWS owned key encryption Customer managed key encryption (Optional) Environment name Enabled Enabled WorkSpaces Thin Client Environment name Device name Enabled Enabled WorkSpaces Thin Client Device name Device settings Enabled Enabled WorkSpaces Thin Client Device settings Device creation tags Enabled Enabled WorkSpaces Thin Client Environment device creation tags Note Amazon WorkSpaces Thin Client automatically enables encryption at rest by using AWS owned keys to protect personally identifiable data at no charge. However, AWS KMS charges apply for using a customer managed key. For more information about pricing, see the AWS Key Management Service pricing. How Amazon WorkSpaces Thin Client uses AWS KMS Amazon WorkSpaces Thin Client requires a key policy for you to use your customer managed key. Amazon WorkSpaces Thin Client requires the key policy to use your customer managed key for the following internal operations: Encryption at rest 58 Amazon WorkSpaces Thin Client Administrator Guide • Send GenerateDataKey requests to AWS KMS to encrypt the data. • Send Decrypt requests to AWS KMS to decrypt the encrypted data. You can remove the service's access to the customer managed key at any time. If you do, Amazon WorkSpaces Thin Client won't be able to access any of the data encrypted by the customer managed key, which affects operations that are dependent on that data. For example, if you attempt to get environment details that WorkSpaces Thin Client can't access, then the operation returns an AccessDeniedException error. Additionally, the WorkSpaces Thin Client device will not be able to use a WorkSpaces Thin Client Environment. Create a customer managed key You can create a symmetric customer managed key by using the AWS Management Console or the AWS KMS API operations. To create a symmetric customer managed key Follow the steps for Creating symmetric customer managed key in the AWS Key Management Service Developer Guide. Key policy Key policies control access to your customer managed key. Every customer managed key must have exactly one key policy, which contains statements that determine who can use the key and how they can use it. When you create your customer managed key, you can specify a key policy. For more information, see Managing access to customer managed keys in the AWS Key Management Service Developer Guide. To use your customer managed key with your Amazon WorkSpaces Thin Client resources, the following API operations must be permitted in the key policy: • kms:DescribeKey — Provides the customer managed key details so Amazon WorkSpaces Thin Client can validate |
workspaces-thin-client-admin-guide-018 | workspaces-thin-client-admin-guide.pdf | 18 | customer managed key. Every customer managed key must have exactly one key policy, which contains statements that determine who can use the key and how they can use it. When you create your customer managed key, you can specify a key policy. For more information, see Managing access to customer managed keys in the AWS Key Management Service Developer Guide. To use your customer managed key with your Amazon WorkSpaces Thin Client resources, the following API operations must be permitted in the key policy: • kms:DescribeKey — Provides the customer managed key details so Amazon WorkSpaces Thin Client can validate the key. • kms:GenerateDataKey — Allows using the customer managed key to encrypt the data. • kms:Decrypt — Allows using the customer managed key to decrypt the data. The following are policy statement examples you can add for Amazon WorkSpaces Thin Client: { Encryption at rest 59 Amazon WorkSpaces Thin Client "Statement": [ { Administrator Guide "Sid": "Allow access to principals authorized to use Amazon WorkSpaces Thin Client", "Effect": "Allow", "Principal": {"AWS": "*"}, "Action": [ "kms:DescribeKey", "kms:GenerateDataKey", "kms:Decrypt" ], "Resource": "*", "Condition": { "StringEquals": { "kms:ViaService": "thinclient.region.amazonaws.com", "kms:CallerAccount": "111122223333" } } }, { "Sid": "Allow Amazon WorkSpaces Thin Client service to encrypt and decrypt data", "Effect": "Allow", "Principal": {"Service": "thinclient.amazonaws.com"}, "Action": [ "kms:GenerateDataKey", "kms:Decrypt" ], "Resource": "*", "Condition": { "StringLike": { "aws:SourceArn": "arn:aws:thinclient:region:111122223333:*", "kms:EncryptionContext:aws:thinclient:arn": "arn:aws:thinclient:region:111122223333:*" } } }, { "Sid": "Allow access for key administrators", "Effect": "Allow", "Principal": {"AWS": "arn:aws:iam::111122223333:root"}, "Action": ["kms:*"], Encryption at rest 60 Amazon WorkSpaces Thin Client Administrator Guide "Resource": "arn:aws:kms:region:111122223333:key/key_ID" }, { "Sid": "Allow read-only access to key metadata to the account", "Effect": "Allow", "Principal": {"AWS": "arn:aws:iam::111122223333:root"}, "Action": [ "kms:Describe*", "kms:Get*", "kms:List*" ], "Resource": "*" } ] } For more information about specifying permissions in a policy, see the AWS Key Management Service Developer Guide. For more information about troubleshooting key access, see the AWS Key Management Service Developer Guide. Specifying a customer managed key for WorkSpaces Thin Client You can specify a customer managed key as a second layer encryption for the following resources: • WorkSpaces Thin Client Environment When you create an Environment, you can specify the data key by providing a kmsKeyArn, which Amazon WorkSpaces Thin Client uses to encrypt the identifiable personal data. • kmsKeyArn — A key identifier for an AWS KMS customer managed key. Provide a key ARN. When a new WorkSpaces Thin Client device is added to the WorkSpaces Thin Client Environment encrypted with a customer managed key, the WorkSpaces Thin Client Device inherits the customer managed key setting from the WorkSpaces Thin Client Environment. An encryption context is an optional set of key-value pairs that contains additional contextual information about the data. Encryption at rest 61 Amazon WorkSpaces Thin Client Administrator Guide AWS KMS uses the encryption context as additional authenticated data to support authenticated encryption. When you include an encryption context in a request to encrypt data, AWS KMS binds the encryption context to the encrypted data. To decrypt data, include the same encryption context in the request. Amazon WorkSpaces Thin Client encryption context Amazon WorkSpaces Thin Client uses the same encryption context in all AWS KMS cryptographic operations, where the key is aws:thinclient:arn and the value is the Amazon Resource Name (ARN). The following is the Environment encryption context: "encryptionContext": { "aws:thinclient:arn": "arn:aws:thinclient:region:111122223333:environment/ environment_ID" } The following is the Device encryption context: "encryptionContext": { "aws:thinclient:arn": "arn:aws:thinclient:region:111122223333:device/device_ID" } Using encryption context for monitoring When you use a symmetric customer managed key to encrypt your WorkSpaces Thin Client Environment and Device data, you can also use the encryption context in audit records and logs to identify how the customer managed key is being used. The encryption context also appears in logs generated by AWS CloudTrail or Amazon CloudWatch Logs. Using encryption context to control access to your customer managed key You can use the encryption context in key policies and IAM policies as conditions to control access to your symmetric customer managed key. The following are example key policy statements to grant access to a customer managed key for a specific encryption context. The condition in this policy statement requires that the kms:Decrypt call has an encryption context constraint that specifies the encryption context. { "Sid": "Enable Decrypt to access Thin Client Environment", Encryption at rest 62 Amazon WorkSpaces Thin Client "Effect": "Allow", Administrator Guide "Principal": {"AWS": "arn:aws:iam::111122223333:role/ExampleReadOnlyRole"}, "Action": "kms:Decrypt", "Resource": "*", "Condition": { "StringEquals": {"kms:EncryptionContext:aws:thinclient:arn": "arn:aws:thinclient:region:111122223333:environment/environment_ID"} } } Monitoring your encryption keys for Amazon WorkSpaces Thin Client When you use an AWS KMS customer managed key with your Amazon WorkSpaces Thin Client resources, you can use AWS CloudTrail or Amazon CloudWatch Logs to track requests that Amazon WorkSpaces Thin Client sends to AWS KMS. The following examples are AWS CloudTrail events for DescribeKey, GenerateDataKey, Decrypt, to monitor KMS operations called by Amazon WorkSpaces Thin Client to access |
workspaces-thin-client-admin-guide-019 | workspaces-thin-client-admin-guide.pdf | 19 | to access Thin Client Environment", Encryption at rest 62 Amazon WorkSpaces Thin Client "Effect": "Allow", Administrator Guide "Principal": {"AWS": "arn:aws:iam::111122223333:role/ExampleReadOnlyRole"}, "Action": "kms:Decrypt", "Resource": "*", "Condition": { "StringEquals": {"kms:EncryptionContext:aws:thinclient:arn": "arn:aws:thinclient:region:111122223333:environment/environment_ID"} } } Monitoring your encryption keys for Amazon WorkSpaces Thin Client When you use an AWS KMS customer managed key with your Amazon WorkSpaces Thin Client resources, you can use AWS CloudTrail or Amazon CloudWatch Logs to track requests that Amazon WorkSpaces Thin Client sends to AWS KMS. The following examples are AWS CloudTrail events for DescribeKey, GenerateDataKey, Decrypt, to monitor KMS operations called by Amazon WorkSpaces Thin Client to access data encrypted by your customer managed key: In the following examples, you can see encryptionContext for the WorkSpaces Thin Client Environment. Similar CloudTrail events are recorded for the WorkSpaces Thin Client Device. DescribeKey Amazon WorkSpaces Thin Client uses the DescribeKey operation to verify the AWS KMS customer managed key. The following example event records the DescribeKey operation: { "eventVersion": "1.09", "userIdentity": { "type": "AssumedRole", "principalId": "AROAIGDTESTANDEXAMPLE:Sampleuser01", "arn": "arn:aws:sts::111122223333:assumed-role/Admin/Sampleuser01", "accountId": "111122223333", "accessKeyId": "AKIAIOSFODNN7EXAMPLE3", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "AROAIGDTESTANDEXAMPLE:Sampleuser01", "arn": "arn:aws:sts::111122223333:assumed-role/Admin/Sampleuser01", Encryption at rest 63 Amazon WorkSpaces Thin Client Administrator Guide "accountId": "111122223333", "userName": "Admin" }, "attributes": { "creationDate": "2024-04-08T13:43:33Z", "mfaAuthenticated": "false" } }, "invokedBy": "thinclient.amazonaws.com" }, "eventTime": "2024-04-08T13:44:22Z", "eventSource": "kms.amazonaws.com", "eventName": "DescribeKey", "awsRegion": "eu-west-1", "sourceIPAddress": "thinclient.amazonaws.com", "userAgent": "thinclient.amazonaws.com", "requestParameters": {"keyId": "arn:aws:kms:eu- west-1:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE"}, "responseElements": null, "requestID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE", "eventID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE", "readOnly": true, "resources": [ { "accountId": "111122223333", "type": "AWS::KMS::Key", "ARN": "arn:aws:kms:eu- west-1:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE" } ], "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "111122223333", "eventCategory": "Management" } GenerateDataKey Amazon WorkSpaces Thin Client uses the GenerateDataKey operation to encrypt data. The following example event records the GenerateDataKey operation: { "eventVersion": "1.09", Encryption at rest 64 Amazon WorkSpaces Thin Client "userIdentity": { Administrator Guide "type": "AssumedRole", "principalId": "AROAIGDTESTANDEXAMPLE:Sampleuser01", "arn": "arn:aws:sts::111122223333:assumed-role/Admin/Sampleuser01", "accountId": "111122223333", "accessKeyId": "AKIAIOSFODNN7EXAMPLE3", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "AROAIGDTESTANDEXAMPLE:Sampleuser01", "arn": "arn:aws:sts::111122223333:assumed-role/Admin/Sampleuser01", "accountId": "111122223333", "userName": "Admin" }, "attributes": { "creationDate": "2024-04-08T12:21:03Z", "mfaAuthenticated": "false" } }, "invokedBy": "thinclient.amazonaws.com" }, "eventTime": "2024-04-08T13:03:56Z", "eventSource": "kms.amazonaws.com", "eventName": "GenerateDataKey", "awsRegion": "eu-west-1", "sourceIPAddress": "thinclient.amazonaws.com", "userAgent": "thinclient.amazonaws.com", "requestParameters": { "keyId": "arn:aws:kms:eu- west-1:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE", "encryptionContext": { "aws-crypto-public-key": "ABC123def4567890abc12345678/90dE/F123abcDEF +4567890abc123D+ef1==", "aws:thinclient:arn": "arn:aws:thinclient:eu- west-1:111122223333:environment/abcSAMPLE" }, "numberOfBytes": 32 }, "responseElements": null, "requestID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE", "eventID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE", "readOnly": true, "resources": [ { Encryption at rest 65 Amazon WorkSpaces Thin Client Administrator Guide "accountId": "111122223333", "type": "AWS::KMS::Key", "ARN": "arn:aws:kms:eu- west-1:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE" } ], "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "111122223333", "sharedEventID": "1234abcd-12ab-34cd-56ef-123456SAMPLE", "vpcEndpointId": "vpce-1234abcd567SAMPLE", "vpcEndpointAccountId": "thinclient.amazonaws.com", "eventCategory": "Management" } GenerateDataKey (by service) When Amazon WorkSpaces Thin Client uses the GenerateDataKey saves Device information, the GenerateDataKey operation is used to encrypt the data. The GenerateDataKey operation is allowed in KMS key policy statement with Sid "Allow Amazon WorkSpaces Thin Client service to encrypt and decrypt data". The following example event records the GenerateDataKey operation: { "eventVersion": "1.09", "userIdentity": { "type": "AWSService", "invokedBy": "thinclient.amazonaws.com" }, "eventTime": "2024-04-08T13:03:56Z", "eventSource": "kms.amazonaws.com", "eventName": "GenerateDataKey", "awsRegion": "eu-west-1", "sourceIPAddress": "thinclient.amazonaws.com", "userAgent": "thinclient.amazonaws.com", "requestParameters": { "keyId": "arn:aws:kms:eu- west-1:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE", "encryptionContext": { "aws-crypto-public-key": "ABC123def4567890abc12345678/90dE/F123abcDEF +4567890abc123D+ef1==", Encryption at rest 66 Amazon WorkSpaces Thin Client Administrator Guide "aws:thinclient:arn": "arn:aws:thinclient:eu- west-1:111122223333:environment/abcSAMPLE" }, "numberOfBytes": 32 }, "responseElements": null, "requestID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE", "eventID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE", "readOnly": true, "resources": [ { "accountId": "111122223333", "type": "AWS::KMS::Key", "ARN": "arn:aws:kms:eu- west-1:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE" } ], "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "111122223333", "sharedEventID": "1234abcd-12ab-34cd-56ef-123456SAMPLE", "vpcEndpointId": "vpce-1234abcd567SAMPLE", "vpcEndpointAccountId": "thinclient.amazonaws.com", "eventCategory": "Management" } Decrypt Amazon WorkSpaces Thin Client uses the Decrypt operation to decrypt data. The following example event records the Decrypt operation: { "eventVersion": "1.09", "userIdentity": { "type": "AssumedRole", "principalId": "AROAIGDTESTANDEXAMPLE:Sampleuser01", "arn": "arn:aws:sts::111122223333:assumed-role/Admin/Sampleuser01", "accountId": "111122223333", "accessKeyId": "AKIAIOSFODNN7EXAMPLE3", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "AROAIGDTESTANDEXAMPLE:Sampleuser01", Encryption at rest 67 Amazon WorkSpaces Thin Client Administrator Guide "arn": "arn:aws:sts::111122223333:assumed-role/Admin/Sampleuser01", "accountId": "111122223333", "userName": "Admin" }, "attributes": { "creationDate": "2024-04-08T13:43:33Z", "mfaAuthenticated": "false" } }, "invokedBy": "thinclient.amazonaws.com" }, "eventTime": "2024-04-08T13:44:25Z", "eventSource": "kms.amazonaws.com", "eventName": "Decrypt", "awsRegion": "eu-west-1", "sourceIPAddress": "thinclient.amazonaws.com", "userAgent": "thinclient.amazonaws.com", "requestParameters": { "keyId": "arn:aws:kms:eu- west-1:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE", "encryptionContext": { "aws-crypto-public-key": "ABC123def4567890abc12345678/90dE/F123abcDEF +4567890abc123D+ef1==", "aws:thinclient:arn": "arn:aws:thinclient:eu- west-1:111122223333:environment/abcSAMPLE" }, "encryptionAlgorithm": "SYMMETRIC_DEFAULT" }, "responseElements": null, "requestID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE", "eventID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE", "readOnly": true, "resources": [ { "accountId": "111122223333", "type": "AWS::KMS::Key", "ARN": "arn:aws:kms:eu- west-1:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE" } ], "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "111122223333", "sharedEventID": "1234abcd-12ab-34cd-56ef-123456SAMPLE", Encryption at rest 68 Amazon WorkSpaces Thin Client Administrator Guide "vpcEndpointId": "vpce-1234abcd567SAMPLE", "vpcEndpointAccountId": "thinclient.amazonaws.com", "eventCategory": "Management" } Decrypt (by service) When WorkSpaces Thin Client Device accesses Environment or Device information, the Decrypt operation is used to decrypt the data. The Decrypt operation is allowed in KMS key policy statement with Sid "Allow Amazon WorkSpaces Thin Client service to encrypt and decrypt data". The following example event records the Decrypt operation, authorized through a Grant: { "eventVersion": "1.09", "userIdentity": { "type": "AWSService", "invokedBy": "thinclient.amazonaws.com" }, "eventTime": "2024-04-08T13:44:25Z", "eventSource": "kms.amazonaws.com", "eventName": "Decrypt", "awsRegion": "eu-west-1", "sourceIPAddress": "thinclient.amazonaws.com", "userAgent": "thinclient.amazonaws.com", "requestParameters": { "keyId": "arn:aws:kms:eu- west-1:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE", "encryptionContext": { "aws-crypto-public-key": "ABC123def4567890abc12345678/90dE/F123abcDEF +4567890abc123D+ef1==", "aws:thinclient:arn": "arn:aws:thinclient:eu- west-1:111122223333:environment/abcSAMPLE" }, "encryptionAlgorithm": "SYMMETRIC_DEFAULT" }, "responseElements": null, "requestID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE", "eventID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE", "readOnly": true, "resources": [ { "accountId": "111122223333", Encryption at rest 69 Amazon WorkSpaces Thin Client Administrator Guide |
workspaces-thin-client-admin-guide-020 | workspaces-thin-client-admin-guide.pdf | 20 | decrypt the data. The Decrypt operation is allowed in KMS key policy statement with Sid "Allow Amazon WorkSpaces Thin Client service to encrypt and decrypt data". The following example event records the Decrypt operation, authorized through a Grant: { "eventVersion": "1.09", "userIdentity": { "type": "AWSService", "invokedBy": "thinclient.amazonaws.com" }, "eventTime": "2024-04-08T13:44:25Z", "eventSource": "kms.amazonaws.com", "eventName": "Decrypt", "awsRegion": "eu-west-1", "sourceIPAddress": "thinclient.amazonaws.com", "userAgent": "thinclient.amazonaws.com", "requestParameters": { "keyId": "arn:aws:kms:eu- west-1:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE", "encryptionContext": { "aws-crypto-public-key": "ABC123def4567890abc12345678/90dE/F123abcDEF +4567890abc123D+ef1==", "aws:thinclient:arn": "arn:aws:thinclient:eu- west-1:111122223333:environment/abcSAMPLE" }, "encryptionAlgorithm": "SYMMETRIC_DEFAULT" }, "responseElements": null, "requestID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE", "eventID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE", "readOnly": true, "resources": [ { "accountId": "111122223333", Encryption at rest 69 Amazon WorkSpaces Thin Client Administrator Guide "type": "AWS::KMS::Key", "ARN": "arn:aws:kms:eu- west-1:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE" } ], "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "111122223333", "sharedEventID": "1234abcd-12ab-34cd-56ef-123456SAMPLE", "vpcEndpointId": "vpce-1234abcd567SAMPLE", "vpcEndpointAccountId": "thinclient.amazonaws.com", "eventCategory": "Management" } Learn More The following resources provide more information about data encryption at rest: • For more information about AWS Key Management Service basic concepts, see the AWS Key Management Service Developer Guide. • For more information about Security best practices for AWS Key Management Service, see the AWS Key Management Service Developer Guide. Encryption in transit WorkSpaces Thin Client encrypts data in transit over HTTPS and TLS 1.2. You can send a request to WorkSpaces Thin Client by using the console or direct API calls. The request data that is transferred is encrypted by sending it through an HTTPS or TLS connection. Request data can be transferred from the AWS Console, AWS Command Line Interface, or AWS SDK to WorkSpaces Thin Client. This also includes any software updates on the device. Encryption in transit is configured by default, and secure connections (HTTPS, TLS) are configured by default. Key management You can supply your own Customer Managed AWS KMS Key to encrypt your customer information. If you don't supply a key, WorkSpaces Thin Client uses an AWS Owned Key. You can set your key by using the AWS SDK. Encryption in transit 70 Amazon WorkSpaces Thin Client Administrator Guide Internet work traffic privacy Administrators are able to view WorkSpaces Thin Client session events, including start times and pending software update information. These logs are encrypted and securely delivered to customers in the WorkSpaces Thin Client console. User information and further details about individual streaming desktop sessions is recorded by the desktop services. For more information, see Monitor your WorkSpaces, Monitoring and Reporting for AppStream 2.0, or User access logging for WorkSpaces Web. Identity and access management for Amazon WorkSpaces Thin Client AWS Identity and Access Management (IAM) is an AWS service that helps an administrator securely control access to AWS resources. IAM administrators control who can be authenticated (signed in) and authorized (have permissions) to use WorkSpaces Thin Client resources. IAM is an AWS service that you can use with no additional charge. Topics • Audience • Authenticating with identities • Managing access using policies • How Amazon WorkSpaces Thin Client works with IAM • Identity-based policy examples for Amazon WorkSpaces Thin Client • AWS managed policies for Amazon WorkSpaces Thin Client • Troubleshooting Amazon WorkSpaces Thin Client identity and access Audience How you use AWS Identity and Access Management (IAM) differs, depending on the work that you do in WorkSpaces Thin Client. Service user – If you use the WorkSpaces Thin Client service to do your job, then your administrator provides you with the credentials and permissions that you need. As you use more WorkSpaces Thin Client features to do your work, you might need additional permissions. Understanding how access is managed can help you request the right permissions from your Internet work traffic privacy 71 Amazon WorkSpaces Thin Client Administrator Guide administrator. If you cannot access a feature in WorkSpaces Thin Client, see Troubleshooting Amazon WorkSpaces Thin Client identity and access. Service administrator – If you're in charge of WorkSpaces Thin Client resources at your company, you probably have full access to WorkSpaces Thin Client. It's your job to determine which WorkSpaces Thin Client features and resources your service users should access. You must then submit requests to your IAM administrator to change the permissions of your service users. Review the information on this page to understand the basic concepts of IAM. To learn more about how your company can use IAM with WorkSpaces Thin Client, see How Amazon WorkSpaces Thin Client works with IAM. IAM administrator – If you're an IAM administrator, you might want to learn details about how you can write policies to manage access to WorkSpaces Thin Client. To view example WorkSpaces Thin Client identity-based policies that you can use in IAM, see Identity-based policy examples for Amazon WorkSpaces Thin Client. Authenticating with identities Authentication is how you sign in to AWS using your identity credentials. You must be authenticated (signed in to AWS) as the AWS account root user, as an IAM user, or by assuming an IAM role. You can sign |
workspaces-thin-client-admin-guide-021 | workspaces-thin-client-admin-guide.pdf | 21 | How Amazon WorkSpaces Thin Client works with IAM. IAM administrator – If you're an IAM administrator, you might want to learn details about how you can write policies to manage access to WorkSpaces Thin Client. To view example WorkSpaces Thin Client identity-based policies that you can use in IAM, see Identity-based policy examples for Amazon WorkSpaces Thin Client. Authenticating with identities Authentication is how you sign in to AWS using your identity credentials. You must be authenticated (signed in to AWS) as the AWS account root user, as an IAM user, or by assuming an IAM role. You can sign in to AWS as a federated identity by using credentials provided through an identity source. AWS IAM Identity Center (IAM Identity Center) users, your company's single sign-on authentication, and your Google or Facebook credentials are examples of federated identities. When you sign in as a federated identity, your administrator previously set up identity federation using IAM roles. When you access AWS by using federation, you are indirectly assuming a role. Depending on the type of user you are, you can sign in to the AWS Management Console or the AWS access portal. For more information about signing in to AWS, see How to sign in to your AWS account in the AWS Sign-In User Guide. If you access AWS programmatically, AWS provides a software development kit (SDK) and a command line interface (CLI) to cryptographically sign your requests by using your credentials. If you don't use AWS tools, you must sign requests yourself. For more information about using the recommended method to sign requests yourself, see AWS Signature Version 4 for API requests in the IAM User Guide. Regardless of the authentication method that you use, you might be required to provide additional security information. For example, AWS recommends that you use multi-factor authentication Authenticating with identities 72 Amazon WorkSpaces Thin Client Administrator Guide (MFA) to increase the security of your account. To learn more, see Multi-factor authentication in the AWS IAM Identity Center User Guide and AWS Multi-factor authentication in IAM in the IAM User Guide. AWS account root user When you create an AWS account, you begin with one sign-in identity that has complete access to all AWS services and resources in the account. This identity is called the AWS account root user and is accessed by signing in with the email address and password that you used to create the account. We strongly recommend that you don't use the root user for your everyday tasks. Safeguard your root user credentials and use them to perform the tasks that only the root user can perform. For the complete list of tasks that require you to sign in as the root user, see Tasks that require root user credentials in the IAM User Guide. Federated identity As a best practice, require human users, including users that require administrator access, to use federation with an identity provider to access AWS services by using temporary credentials. A federated identity is a user from your enterprise user directory, a web identity provider, the AWS Directory Service, the Identity Center directory, or any user that accesses AWS services by using credentials provided through an identity source. When federated identities access AWS accounts, they assume roles, and the roles provide temporary credentials. For centralized access management, we recommend that you use AWS IAM Identity Center. You can create users and groups in IAM Identity Center, or you can connect and synchronize to a set of users and groups in your own identity source for use across all your AWS accounts and applications. For information about IAM Identity Center, see What is IAM Identity Center? in the AWS IAM Identity Center User Guide. IAM users and groups An IAM user is an identity within your AWS account that has specific permissions for a single person or application. Where possible, we recommend relying on temporary credentials instead of creating IAM users who have long-term credentials such as passwords and access keys. However, if you have specific use cases that require long-term credentials with IAM users, we recommend that you rotate access keys. For more information, see Rotate access keys regularly for use cases that require long- term credentials in the IAM User Guide. Authenticating with identities 73 Amazon WorkSpaces Thin Client Administrator Guide An IAM group is an identity that specifies a collection of IAM users. You can't sign in as a group. You can use groups to specify permissions for multiple users at a time. Groups make permissions easier to manage for large sets of users. For example, you could have a group named IAMAdmins and give that group permissions to administer IAM resources. Users are different from roles. A user is uniquely associated with one person or application, but a role is intended to |
workspaces-thin-client-admin-guide-022 | workspaces-thin-client-admin-guide.pdf | 22 | term credentials in the IAM User Guide. Authenticating with identities 73 Amazon WorkSpaces Thin Client Administrator Guide An IAM group is an identity that specifies a collection of IAM users. You can't sign in as a group. You can use groups to specify permissions for multiple users at a time. Groups make permissions easier to manage for large sets of users. For example, you could have a group named IAMAdmins and give that group permissions to administer IAM resources. Users are different from roles. A user is uniquely associated with one person or application, but a role is intended to be assumable by anyone who needs it. Users have permanent long-term credentials, but roles provide temporary credentials. To learn more, see Use cases for IAM users in the IAM User Guide. IAM roles An IAM role is an identity within your AWS account that has specific permissions. It is similar to an IAM user, but is not associated with a specific person. To temporarily assume an IAM role in the AWS Management Console, you can switch from a user to an IAM role (console). You can assume a role by calling an AWS CLI or AWS API operation or by using a custom URL. For more information about methods for using roles, see Methods to assume a role in the IAM User Guide. IAM roles with temporary credentials are useful in the following situations: • Federated user access – To assign permissions to a federated identity, you create a role and define permissions for the role. When a federated identity authenticates, the identity is associated with the role and is granted the permissions that are defined by the role. For information about roles for federation, see Create a role for a third-party identity provider (federation) in the IAM User Guide. If you use IAM Identity Center, you configure a permission set. To control what your identities can access after they authenticate, IAM Identity Center correlates the permission set to a role in IAM. For information about permissions sets, see Permission sets in the AWS IAM Identity Center User Guide. • Temporary IAM user permissions – An IAM user or role can assume an IAM role to temporarily take on different permissions for a specific task. • Cross-account access – You can use an IAM role to allow someone (a trusted principal) in a different account to access resources in your account. Roles are the primary way to grant cross- account access. However, with some AWS services, you can attach a policy directly to a resource (instead of using a role as a proxy). To learn the difference between roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. • Cross-service access – Some AWS services use features in other AWS services. For example, when you make a call in a service, it's common for that service to run applications in Amazon EC2 or Authenticating with identities 74 Amazon WorkSpaces Thin Client Administrator Guide store objects in Amazon S3. A service might do this using the calling principal's permissions, using a service role, or using a service-linked role. • Forward access sessions (FAS) – When you use an IAM user or role to perform actions in AWS, you are considered a principal. When you use some services, you might perform an action that then initiates another action in a different service. FAS uses the permissions of the principal calling an AWS service, combined with the requesting AWS service to make requests to downstream services. FAS requests are only made when a service receives a request that requires interactions with other AWS services or resources to complete. In this case, you must have permissions to perform both actions. For policy details when making FAS requests, see Forward access sessions. • Service role – A service role is an IAM role that a service assumes to perform actions on your behalf. An IAM administrator can create, modify, and delete a service role from within IAM. For more information, see Create a role to delegate permissions to an AWS service in the IAM User Guide. • Service-linked role – A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. • Applications running on Amazon EC2 – You can use an IAM role to manage temporary credentials for applications that are running on an EC2 instance and making AWS CLI or AWS API requests. This is preferable to storing access keys within the EC2 instance. To assign an AWS role to |
workspaces-thin-client-admin-guide-023 | workspaces-thin-client-admin-guide.pdf | 23 | of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. • Applications running on Amazon EC2 – You can use an IAM role to manage temporary credentials for applications that are running on an EC2 instance and making AWS CLI or AWS API requests. This is preferable to storing access keys within the EC2 instance. To assign an AWS role to an EC2 instance and make it available to all of its applications, you create an instance profile that is attached to the instance. An instance profile contains the role and enables programs that are running on the EC2 instance to get temporary credentials. For more information, see Use an IAM role to grant permissions to applications running on Amazon EC2 instances in the IAM User Guide. Managing access using policies You control access in AWS by creating policies and attaching them to AWS identities or resources. A policy is an object in AWS that, when associated with an identity or resource, defines their permissions. AWS evaluates these policies when a principal (user, root user, or role session) makes a request. Permissions in the policies determine whether the request is allowed or denied. Most policies are stored in AWS as JSON documents. For more information about the structure and contents of JSON policy documents, see Overview of JSON policies in the IAM User Guide. Managing access using policies 75 Amazon WorkSpaces Thin Client Administrator Guide Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. By default, users and roles have no permissions. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. IAM policies define permissions for an action regardless of the method that you use to perform the operation. For example, suppose that you have a policy that allows the iam:GetRole action. A user with that policy can get role information from the AWS Management Console, the AWS CLI, or the AWS API. Identity-based policies Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Define custom IAM permissions with customer managed policies in the IAM User Guide. Identity-based policies can be further categorized as inline policies or managed policies. Inline policies are embedded directly into a single user, group, or role. Managed policies are standalone policies that you can attach to multiple users, groups, and roles in your AWS account. Managed policies include AWS managed policies and customer managed policies. To learn how to choose between a managed policy or an inline policy, see Choose between managed policies and inline policies in the IAM User Guide. Resource-based policies Resource-based policies are JSON policy documents that you attach to a resource. Examples of resource-based policies are IAM role trust policies and Amazon S3 bucket policies. In services that support resource-based policies, service administrators can use them to control access to a specific resource. For the resource where the policy is attached, the policy defines what actions a specified principal can perform on that resource and under what conditions. You must specify a principal in a resource-based policy. Principals can include accounts, users, roles, federated users, or AWS services. Resource-based policies are inline policies that are located in that service. You can't use AWS managed policies from IAM in a resource-based policy. Managing access using policies 76 Amazon WorkSpaces Thin Client Access control lists (ACLs) Administrator Guide Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. Amazon S3, AWS WAF, and Amazon VPC are examples of services that support ACLs. To learn more about ACLs, see Access control list (ACL) overview in the Amazon Simple Storage Service Developer Guide. Other policy types AWS supports additional, less-common policy types. These policy types can set the maximum permissions granted to you by the more common policy types. • Permissions boundaries – A permissions boundary is an advanced feature in which you set the maximum permissions that an identity-based policy can grant to an IAM entity (IAM user or role). You can set a permissions |
workspaces-thin-client-admin-guide-024 | workspaces-thin-client-admin-guide.pdf | 24 | JSON policy document format. Amazon S3, AWS WAF, and Amazon VPC are examples of services that support ACLs. To learn more about ACLs, see Access control list (ACL) overview in the Amazon Simple Storage Service Developer Guide. Other policy types AWS supports additional, less-common policy types. These policy types can set the maximum permissions granted to you by the more common policy types. • Permissions boundaries – A permissions boundary is an advanced feature in which you set the maximum permissions that an identity-based policy can grant to an IAM entity (IAM user or role). You can set a permissions boundary for an entity. The resulting permissions are the intersection of an entity's identity-based policies and its permissions boundaries. Resource-based policies that specify the user or role in the Principal field are not limited by the permissions boundary. An explicit deny in any of these policies overrides the allow. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. • Service control policies (SCPs) – SCPs are JSON policies that specify the maximum permissions for an organization or organizational unit (OU) in AWS Organizations. AWS Organizations is a service for grouping and centrally managing multiple AWS accounts that your business owns. If you enable all features in an organization, then you can apply service control policies (SCPs) to any or all of your accounts. The SCP limits permissions for entities in member accounts, including each AWS account root user. For more information about Organizations and SCPs, see Service control policies in the AWS Organizations User Guide. • Resource control policies (RCPs) – RCPs are JSON policies that you can use to set the maximum available permissions for resources in your accounts without updating the IAM policies attached to each resource that you own. The RCP limits permissions for resources in member accounts and can impact the effective permissions for identities, including the AWS account root user, regardless of whether they belong to your organization. For more information about Organizations and RCPs, including a list of AWS services that support RCPs, see Resource control policies (RCPs) in the AWS Organizations User Guide. • Session policies – Session policies are advanced policies that you pass as a parameter when you programmatically create a temporary session for a role or federated user. The resulting session's Managing access using policies 77 Amazon WorkSpaces Thin Client Administrator Guide permissions are the intersection of the user or role's identity-based policies and the session policies. Permissions can also come from a resource-based policy. An explicit deny in any of these policies overrides the allow. For more information, see Session policies in the IAM User Guide. Multiple policy types When multiple types of policies apply to a request, the resulting permissions are more complicated to understand. To learn how AWS determines whether to allow a request when multiple policy types are involved, see Policy evaluation logic in the IAM User Guide. How Amazon WorkSpaces Thin Client works with IAM Before you use IAM to manage access to WorkSpaces Thin Client, learn what IAM features are available to use with WorkSpaces Thin Client. IAM features you can use with Amazon WorkSpaces Thin Client IAM feature WorkSpaces Thin Client support Identity-based policies Resource-based policies Policy actions Policy resources Policy condition keys ACLs ABAC (tags in policies) Temporary credentials Principal permissions Service roles Service-linked roles Yes No Yes Yes Yes No Yes Yes Yes No No How Amazon WorkSpaces Thin Client works with IAM 78 Amazon WorkSpaces Thin Client Administrator Guide To get a high-level view of how WorkSpaces Thin Client and other AWS services work with most IAM features, see AWS services that work with IAM in the IAM User Guide. Identity-based policies for WorkSpaces Thin Client Supports identity-based policies: Yes Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Define custom IAM permissions with customer managed policies in the IAM User Guide. With IAM identity-based policies, you can specify allowed or denied actions and resources as well as the conditions under which actions are allowed or denied. You can't specify the principal in an identity-based policy because it applies to the user or role to which it is attached. To learn about all of the elements that you can use in a JSON policy, see IAM JSON policy elements reference in the IAM User Guide. Identity-based policy examples for WorkSpaces Thin Client To view examples of WorkSpaces Thin Client identity-based policies, see Identity-based policy examples for Amazon WorkSpaces Thin Client. Resource-based policies within WorkSpaces Thin Client Supports resource-based policies: No Resource-based |
workspaces-thin-client-admin-guide-025 | workspaces-thin-client-admin-guide.pdf | 25 | denied actions and resources as well as the conditions under which actions are allowed or denied. You can't specify the principal in an identity-based policy because it applies to the user or role to which it is attached. To learn about all of the elements that you can use in a JSON policy, see IAM JSON policy elements reference in the IAM User Guide. Identity-based policy examples for WorkSpaces Thin Client To view examples of WorkSpaces Thin Client identity-based policies, see Identity-based policy examples for Amazon WorkSpaces Thin Client. Resource-based policies within WorkSpaces Thin Client Supports resource-based policies: No Resource-based policies are JSON policy documents that you attach to a resource. Examples of resource-based policies are IAM role trust policies and Amazon S3 bucket policies. In services that support resource-based policies, service administrators can use them to control access to a specific resource. For the resource where the policy is attached, the policy defines what actions a specified principal can perform on that resource and under what conditions. You must specify a principal in a resource-based policy. Principals can include accounts, users, roles, federated users, or AWS services. To enable cross-account access, you can specify an entire account or IAM entities in another account as the principal in a resource-based policy. Adding a cross-account principal to a resource- based policy is only half of establishing the trust relationship. When the principal and the resource are in different AWS accounts, an IAM administrator in the trusted account must also grant How Amazon WorkSpaces Thin Client works with IAM 79 Amazon WorkSpaces Thin Client Administrator Guide the principal entity (user or role) permission to access the resource. They grant permission by attaching an identity-based policy to the entity. However, if a resource-based policy grants access to a principal in the same account, no additional identity-based policy is required. For more information, see Cross account resource access in IAM in the IAM User Guide. Policy actions for WorkSpaces Thin Client Supports policy actions: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Action element of a JSON policy describes the actions that you can use to allow or deny access in a policy. Policy actions usually have the same name as the associated AWS API operation. There are some exceptions, such as permission-only actions that don't have a matching API operation. There are also some operations that require multiple actions in a policy. These additional actions are called dependent actions. Include actions in a policy to grant permissions to perform the associated operation. To see a list of WorkSpaces Thin Client actions, see Actions Defined by Amazon WorkSpaces Thin Client in the Service Authorization Reference. Policy actions in WorkSpaces Thin Client use the following prefix before the action: thinclient To specify multiple actions in a single statement, separate them with commas, as shown in the following example: "Action": [ "thinclient:action1", "thinclient:action2" ] To view examples of WorkSpaces Thin Client identity-based policies, see Identity-based policy examples for Amazon WorkSpaces Thin Client. How Amazon WorkSpaces Thin Client works with IAM 80 Amazon WorkSpaces Thin Client Administrator Guide Policy resources for WorkSpaces Thin Client Supports policy resources: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Resource JSON policy element specifies the object or objects to which the action applies. Statements must include either a Resource or a NotResource element. As a best practice, specify a resource using its Amazon Resource Name (ARN). You can do this for actions that support a specific resource type, known as resource-level permissions. For actions that don't support resource-level permissions, such as listing operations, use a wildcard (*) to indicate that the statement applies to all resources. "Resource": "*" To see a list of WorkSpaces Thin Client resource types and their ARNs, see Resources Defined by Amazon WorkSpaces Thin Client in the Service Authorization Reference. To learn with which actions you can specify the ARN of each resource, see Actions Defined by Amazon WorkSpaces Thin Client. To view examples of WorkSpaces Thin Client identity-based policies, see Identity-based policy examples for Amazon WorkSpaces Thin Client. Policy condition keys for WorkSpaces Thin Client Supports service-specific policy condition keys: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Condition element (or Condition block) lets you specify conditions in which a statement is in effect. The Condition element is optional. You can create conditional expressions that use condition operators, such as equals or less than, to match the condition in the policy with values |
workspaces-thin-client-admin-guide-026 | workspaces-thin-client-admin-guide.pdf | 26 | WorkSpaces Thin Client identity-based policies, see Identity-based policy examples for Amazon WorkSpaces Thin Client. Policy condition keys for WorkSpaces Thin Client Supports service-specific policy condition keys: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Condition element (or Condition block) lets you specify conditions in which a statement is in effect. The Condition element is optional. You can create conditional expressions that use condition operators, such as equals or less than, to match the condition in the policy with values in the request. If you specify multiple Condition elements in a statement, or multiple keys in a single Condition element, AWS evaluates them using a logical AND operation. If you specify multiple values for a single condition key, AWS evaluates the condition using a logical OR operation. All of the conditions must be met before the statement's permissions are granted. How Amazon WorkSpaces Thin Client works with IAM 81 Amazon WorkSpaces Thin Client Administrator Guide You can also use placeholder variables when you specify conditions. For example, you can grant an IAM user permission to access a resource only if it is tagged with their IAM user name. For more information, see IAM policy elements: variables and tags in the IAM User Guide. AWS supports global condition keys and service-specific condition keys. To see all AWS global condition keys, see AWS global condition context keys in the IAM User Guide. To see a list of WorkSpaces Thin Client condition keys, see Condition Keys for Amazon WorkSpaces Thin Client in the Service Authorization Reference. To learn with which actions and resources you can use a condition key, see Actions Defined by Amazon WorkSpaces Thin Client. To view examples of WorkSpaces Thin Client identity-based policies, see Identity-based policy examples for Amazon WorkSpaces Thin Client. ACLs in WorkSpaces Thin Client Supports ACLs: No Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. ABAC with WorkSpaces Thin Client Supports ABAC (tags in policies): Yes Attribute-based access control (ABAC) is an authorization strategy that defines permissions based on attributes. In AWS, these attributes are called tags. You can attach tags to IAM entities (users or roles) and to many AWS resources. Tagging entities and resources is the first step of ABAC. Then you design ABAC policies to allow operations when the principal's tag matches the tag on the resource that they are trying to access. ABAC is helpful in environments that are growing rapidly and helps with situations where policy management becomes cumbersome. To control access based on tags, you provide tag information in the condition element of a policy using the aws:ResourceTag/key-name, aws:RequestTag/key-name, or aws:TagKeys condition keys. If a service supports all three condition keys for every resource type, then the value is Yes for the service. If a service supports all three condition keys for only some resource types, then the value is Partial. How Amazon WorkSpaces Thin Client works with IAM 82 Amazon WorkSpaces Thin Client Administrator Guide For more information about ABAC, see Define permissions with ABAC authorization in the IAM User Guide. To view a tutorial with steps for setting up ABAC, see Use attribute-based access control (ABAC) in the IAM User Guide. Using temporary credentials with WorkSpaces Thin Client Supports temporary credentials: Yes Some AWS services don't work when you sign in using temporary credentials. For additional information, including which AWS services work with temporary credentials, see AWS services that work with IAM in the IAM User Guide. You are using temporary credentials if you sign in to the AWS Management Console using any method except a user name and password. For example, when you access AWS using your company's single sign-on (SSO) link, that process automatically creates temporary credentials. You also automatically create temporary credentials when you sign in to the console as a user and then switch roles. For more information about switching roles, see Switch from a user to an IAM role (console) in the IAM User Guide. You can manually create temporary credentials using the AWS CLI or AWS API. You can then use those temporary credentials to access AWS. AWS recommends that you dynamically generate temporary credentials instead of using long-term access keys. For more information, see Temporary security credentials in IAM. Cross-service principal permissions for WorkSpaces Thin Client Supports forward access sessions (FAS): Yes When you use an IAM user or role to perform actions in AWS, you are considered a principal. When you use some services, you might perform an action that then initiates another action in a different service. FAS uses the permissions of the principal |
workspaces-thin-client-admin-guide-027 | workspaces-thin-client-admin-guide.pdf | 27 | create temporary credentials using the AWS CLI or AWS API. You can then use those temporary credentials to access AWS. AWS recommends that you dynamically generate temporary credentials instead of using long-term access keys. For more information, see Temporary security credentials in IAM. Cross-service principal permissions for WorkSpaces Thin Client Supports forward access sessions (FAS): Yes When you use an IAM user or role to perform actions in AWS, you are considered a principal. When you use some services, you might perform an action that then initiates another action in a different service. FAS uses the permissions of the principal calling an AWS service, combined with the requesting AWS service to make requests to downstream services. FAS requests are only made when a service receives a request that requires interactions with other AWS services or resources to complete. In this case, you must have permissions to perform both actions. For policy details when making FAS requests, see Forward access sessions. Service roles for WorkSpaces Thin Client Supports service roles: No How Amazon WorkSpaces Thin Client works with IAM 83 Amazon WorkSpaces Thin Client Administrator Guide A service role is an IAM role that a service assumes to perform actions on your behalf. An IAM administrator can create, modify, and delete a service role from within IAM. For more information, see Create a role to delegate permissions to an AWS service in the IAM User Guide. Warning Changing the permissions for a service role might disrupt WorkSpaces Thin Client functionality. Edit service roles only when WorkSpaces Thin Client provides guidance to do so. Service-linked roles for WorkSpaces Thin Client Supports service-linked roles: No A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. For details about creating or managing service-linked roles, see AWS services that work with IAM. Find a service in the table that includes a Yes in the Service-linked role column. Choose the Yes link to view the service-linked role documentation for that service. Identity-based policy examples for Amazon WorkSpaces Thin Client By default, users and roles don't have permission to create or modify WorkSpaces Thin Client resources. They also can't perform tasks by using the AWS Management Console, AWS Command Line Interface (AWS CLI), or AWS API. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. To learn how to create an IAM identity-based policy by using these example JSON policy documents, see Create IAM policies (console) in the IAM User Guide. For details about actions and resource types defined by WorkSpaces Thin Client, including the format of the ARNs for each of the resource types, see Actions, Resources, and Condition Keys for Amazon WorkSpaces Thin Client in the Service Authorization Reference. Identity-based policy examples 84 Administrator Guide Amazon WorkSpaces Thin Client Topics • Policy best practices • Using the WorkSpaces Thin Client console • Grant read-only access to WorkSpaces Thin Client • Allow users to view their own permissions • Grant full access to WorkSpaces Thin Client Policy best practices Identity-based policies determine whether someone can create, access, or delete WorkSpaces Thin Client resources in your account. These actions can incur costs for your AWS account. When you create or edit identity-based policies, follow these guidelines and recommendations: • Get started with AWS managed policies and move toward least-privilege permissions – To get started granting permissions to your users and workloads, use the AWS managed policies that grant permissions for many common use cases. They are available in your AWS account. We recommend that you reduce permissions further by defining AWS customer managed policies that are specific to your use cases. For more information, see AWS managed policies or AWS managed policies for job functions in the IAM User Guide. • Apply least-privilege permissions – When you set permissions with IAM policies, grant only the permissions required to perform a task. You do this by defining the actions that can be taken on specific resources under specific conditions, also known as least-privilege permissions. For more information about using IAM to apply permissions, see Policies and permissions in IAM in the IAM User Guide. • Use conditions in IAM policies to further restrict access – You can add a condition to your policies to limit access to actions and resources. For example, you can write a policy condition to specify that all requests must be sent using SSL. You can also use conditions to grant access |
workspaces-thin-client-admin-guide-028 | workspaces-thin-client-admin-guide.pdf | 28 | permissions required to perform a task. You do this by defining the actions that can be taken on specific resources under specific conditions, also known as least-privilege permissions. For more information about using IAM to apply permissions, see Policies and permissions in IAM in the IAM User Guide. • Use conditions in IAM policies to further restrict access – You can add a condition to your policies to limit access to actions and resources. For example, you can write a policy condition to specify that all requests must be sent using SSL. You can also use conditions to grant access to service actions if they are used through a specific AWS service, such as AWS CloudFormation. For more information, see IAM JSON policy elements: Condition in the IAM User Guide. • Use IAM Access Analyzer to validate your IAM policies to ensure secure and functional permissions – IAM Access Analyzer validates new and existing policies so that the policies adhere to the IAM policy language (JSON) and IAM best practices. IAM Access Analyzer provides more than 100 policy checks and actionable recommendations to help you author secure and functional policies. For more information, see Validate policies with IAM Access Analyzer in the IAM User Guide. Identity-based policy examples 85 Amazon WorkSpaces Thin Client Administrator Guide • Require multi-factor authentication (MFA) – If you have a scenario that requires IAM users or a root user in your AWS account, turn on MFA for additional security. To require MFA when API operations are called, add MFA conditions to your policies. For more information, see Secure API access with MFA in the IAM User Guide. For more information about best practices in IAM, see Security best practices in IAM in the IAM User Guide. Using the WorkSpaces Thin Client console To access the Amazon WorkSpaces Thin Client console, you must have a minimum set of permissions. These permissions must allow you to list and view details about the WorkSpaces Thin Client resources in your AWS account. If you create an identity-based policy that is more restrictive than the minimum required permissions, the console won't function as intended for entities (users or roles) with that policy. You don't need to allow minimum console permissions for users that are making calls only to the AWS CLI or the AWS API. Instead, allow access to only the actions that match the API operation that they're trying to perform. Grant read-only access to WorkSpaces Thin Client This example shows how you can create a policy that allows IAM users to view a WorkSpaces Thin Client configuration, but not make changes. This policy includes permissions to complete this action on the console or program by using the AWS CLI or AWS API. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "thinclient:GetEnvironment", "thinclient:ListEnvironments", "thinclient:GetDevice", "thinclient:ListDevices", "thinclient:ListDeviceSessions", "thinclient:GetSoftwareSet", "thinclient:ListSoftwareSets", "thinclient:ListTagsForResource" Identity-based policy examples 86 Amazon WorkSpaces Thin Client ], Administrator Guide "Resource": "arn:aws:thinclient:*:*:*" }, { "Effect": "Allow", "Action": ["workspaces:DescribeWorkspaceDirectories"], "Resource": "arn:aws:workspaces:*:*:directory/*" }, { "Effect": "Allow", "Action": ["workspaces-web:GetPortal"], "Resource": ["arn:aws:workspaces-web:*:*:portal/*"] }, { "Effect": "Allow", "Action": ["workspaces-web:GetUserSettings"], "Resource": ["arn:aws:workspaces-web:*:*:userSettings/*"] }, { "Effect": "Allow", "Action": ["appstream:DescribeStacks"], "Resource": ["arn:aws:appstream:*:*:stack/*"] } ] } Allow users to view their own permissions This example shows how you might create a policy that allows IAM users to view the inline and managed policies that are attached to their user identity. This policy includes permissions to complete this action on the console or programmatically using the AWS CLI or AWS API. { "Version": "2012-10-17", "Statement": [ { "Sid": "ViewOwnUserInfo", "Effect": "Allow", "Action": [ "iam:GetUserPolicy", "iam:ListGroupsForUser", "iam:ListAttachedUserPolicies", "iam:ListUserPolicies", Identity-based policy examples 87 Amazon WorkSpaces Thin Client Administrator Guide "iam:GetUser" ], "Resource": ["arn:aws:iam::*:user/${aws:username}"] }, { "Sid": "NavigateInConsole", "Effect": "Allow", "Action": [ "iam:GetGroupPolicy", "iam:GetPolicyVersion", "iam:GetPolicy", "iam:ListAttachedGroupPolicies", "iam:ListGroupPolicies", "iam:ListPolicyVersions", "iam:ListPolicies", "iam:ListUsers" ], "Resource": "*" } ] } Grant full access to WorkSpaces Thin Client This example shows how you can create a policy that grants full access to WorkSpaces Thin Client IAM users. This policy includes permissions to complete all WorkSpaces Thin Client actions on the console or program by using the AWS CLI or AWS API. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": ["thinclient:*"], "Resource": "arn:aws:thinclient:*:*:*" }, { "Effect": "Allow", "Action": ["workspaces:DescribeWorkspaceDirectories"], "Resource": "arn:aws:workspaces:*:*:directory/*" }, { "Effect": "Allow", Identity-based policy examples 88 Amazon WorkSpaces Thin Client Administrator Guide "Action": ["workspaces-web:GetPortal"], "Resource": ["arn:aws:workspaces-web:*:*:portal/*"] }, { "Effect": "Allow", "Action": ["workspaces-web:GetUserSettings"], "Resource": ["arn:aws:workspaces-web:*:*:userSettings/*"] }, { "Effect": "Allow", "Action": ["appstream:DescribeStacks"], "Resource": ["arn:aws:appstream:*:*:stack/*"] } ] } AWS managed policies for Amazon WorkSpaces Thin Client An AWS managed policy is a standalone policy that is created and administered by AWS. AWS managed policies are designed to provide permissions for many common use cases so that you can start assigning permissions to users, groups, and roles. Keep in mind that AWS managed policies might not grant least-privilege permissions for your specific use cases because they're |
workspaces-thin-client-admin-guide-029 | workspaces-thin-client-admin-guide.pdf | 29 | Identity-based policy examples 88 Amazon WorkSpaces Thin Client Administrator Guide "Action": ["workspaces-web:GetPortal"], "Resource": ["arn:aws:workspaces-web:*:*:portal/*"] }, { "Effect": "Allow", "Action": ["workspaces-web:GetUserSettings"], "Resource": ["arn:aws:workspaces-web:*:*:userSettings/*"] }, { "Effect": "Allow", "Action": ["appstream:DescribeStacks"], "Resource": ["arn:aws:appstream:*:*:stack/*"] } ] } AWS managed policies for Amazon WorkSpaces Thin Client An AWS managed policy is a standalone policy that is created and administered by AWS. AWS managed policies are designed to provide permissions for many common use cases so that you can start assigning permissions to users, groups, and roles. Keep in mind that AWS managed policies might not grant least-privilege permissions for your specific use cases because they're available for all AWS customers to use. We recommend that you reduce permissions further by defining customer managed policies that are specific to your use cases. You cannot change the permissions defined in AWS managed policies. If AWS updates the permissions defined in an AWS managed policy, the update affects all principal identities (users, groups, and roles) that the policy is attached to. AWS is most likely to update an AWS managed policy when a new AWS service is launched or new API operations become available for existing services. For more information, see AWS managed policies in the IAM User Guide. AWS managed policy: AmazonWorkSpacesThinClientReadOnlyAccess You can attach the AmazonWorkSpacesThinClientReadOnlyAccess policy to your IAM identities. This policy grants full access permissions to the WorkSpaces Thin AWS managed policies 89 Amazon WorkSpaces Thin Client Administrator Guide Client service and its dependencies. For more information on this managed policy, see AmazonWorkSpacesThinClientReadOnlyAccess in the AWS Managed Policy Reference guide. Permissions details This policy includes the following permissions. • thinclient (WorkSpaces Thin Client) – Allows read-only access to all WorkSpaces Thin Client actions. • workspaces (WorkSpaces) – Allows permissions to describe WorkSpaces directories and connection aliases. This is used to check that your WorkSpaces resources are compatible with WorkSpaces Thin Client. It is also used to show these resources in the WorkSpaces Thin Client AWS console. • workspaces-web (WorkSpaces Secure Browser) – Allows permissions to describe WorkSpaces Secure Browser portals and user settings. This is used to check that your WorkSpaces Secure Browser resources are compatible with WorkSpaces Thin Client. It is also used to show these resources in the WorkSpaces Thin Client AWS console. • appstream (AppStream 2.0) – Allows permissions to describe AppStream 2.0 stacks. This is used to check that your AppStream 2.0 resources are compatible with WorkSpaces Thin Client. It is also used to show these resources in the WorkSpaces Thin Client AWS console. { "Version": "2012-10-17", "Statement": [ { "Sid": "AllowThinClientReadAccess", "Effect": "Allow", "Action": [ "thinclient:GetDevice", "thinclient:GetDeviceDetails", "thinclient:GetEnvironment", "thinclient:GetSoftwareSet", "thinclient:ListDevices", "thinclient:ListDeviceSessions", "thinclient:ListEnvironments", "thinclient:ListSoftwareSets", "thinclient:ListTagsForResource" ], "Resource": "*" AWS managed policies 90 Administrator Guide Amazon WorkSpaces Thin Client }, { "Sid": "AllowWorkSpacesAccess", "Effect": "Allow", "Action": [ "workspaces:DescribeConnectionAliases", "workspaces:DescribeWorkspaceDirectories" ], "Resource": "*" }, { "Sid": "AllowWorkSpacesSecureBrowserAccess", "Effect": "Allow", "Action": [ "workspaces-web:GetPortal", "workspaces-web:GetUserSettings", "workspaces-web:ListPortals" ], "Resource": "*" }, { "Sid": "AllowAppStreamAccess", "Effect": "Allow", "Action": [ "appstream:DescribeStacks" ], "Resource": "*" } ] } } AWS managed policy: AmazonWorkSpacesThinClientFullAccess You can attach the AmazonWorkSpacesThinClientFullAccess policy to your IAM identities. This policy grants full access permissions to the WorkSpaces Thin Client service and its dependencies. For more information on this managed policy, see AmazonWorkSpacesThinClientFullAccess in the AWS Managed Policy Reference Guide. Permissions details This policy includes the following permissions: AWS managed policies 91 Amazon WorkSpaces Thin Client Administrator Guide • thinclient (WorkSpaces Thin Client) – Allows full access to all WorkSpaces Thin Client actions. • workspaces (WorkSpaces) – Allows permissions to describe WorkSpaces directories and connection aliases. This is used to check that your WorkSpaces resources are compatible with WorkSpaces Thin Client. It is also used to show these resources in the WorkSpaces Thin Client AWS console. • workspaces-web (WorkSpaces Secure Browser) – Allows permissions to describe WorkSpaces Secure Browser portals and user settings. This is used to check that your WorkSpaces Secure Browser resources are compatible with WorkSpaces Thin Client. It is also used to show these resources in the WorkSpaces Thin Client AWS console. • appstream (AppStream 2.0) – Allows permissions to describe AppStream 2.0 stacks. This is used to check that your AppStream 2.0 resources are compatible with WorkSpaces Thin Client. It is also used to show these resources in the WorkSpaces Thin Client AWS console. { "Version": "2012-10-17", "Statement": [ { "Sid": "AllowThinClientFullAccess", "Effect": "Allow", "Action": [ "thinclient:*" ], "Resource": "*" }, { "Sid": "AllowWorkSpacesAccess", "Effect": "Allow", "Action": [ "workspaces:DescribeConnectionAliases", "workspaces:DescribeWorkspaceDirectories" ], "Resource": "*" }, { "Sid": "AllowWorkSpacesSecureBrowserAccess", "Effect": "Allow", "Action": [ "workspaces-web:GetPortal", "workspaces-web:GetUserSettings", "workspaces-web:ListPortals" AWS managed policies 92 Administrator Guide Amazon WorkSpaces Thin Client ], "Resource": "*" }, { "Sid": "AllowAppStreamAccess", "Effect": "Allow", "Action": [ "appstream:DescribeStacks" ], "Resource": "*" } ] } } WorkSpaces Thin Client updates to AWS managed policies Change Description Date AmazonWorkSpacesTh inClientReadOnlyAccess – Updated policy January 9th 2025 WorkSpaces Thin Client updated the policy to include |
workspaces-thin-client-admin-guide-030 | workspaces-thin-client-admin-guide.pdf | 30 | Thin Client AWS console. { "Version": "2012-10-17", "Statement": [ { "Sid": "AllowThinClientFullAccess", "Effect": "Allow", "Action": [ "thinclient:*" ], "Resource": "*" }, { "Sid": "AllowWorkSpacesAccess", "Effect": "Allow", "Action": [ "workspaces:DescribeConnectionAliases", "workspaces:DescribeWorkspaceDirectories" ], "Resource": "*" }, { "Sid": "AllowWorkSpacesSecureBrowserAccess", "Effect": "Allow", "Action": [ "workspaces-web:GetPortal", "workspaces-web:GetUserSettings", "workspaces-web:ListPortals" AWS managed policies 92 Administrator Guide Amazon WorkSpaces Thin Client ], "Resource": "*" }, { "Sid": "AllowAppStreamAccess", "Effect": "Allow", "Action": [ "appstream:DescribeStacks" ], "Resource": "*" } ] } } WorkSpaces Thin Client updates to AWS managed policies Change Description Date AmazonWorkSpacesTh inClientReadOnlyAccess – Updated policy January 9th 2025 WorkSpaces Thin Client updated the policy to include limited read permissions for device details and WorkSpace s connection aliases. AmazonWorkSpacesTh inClientFullAccess – Updated WorkSpaces Thin Client updated the policy to include January 9th 2025 policy AmazonWorkSpacesTh inClientReadOnlyAccess – Updated policy limited read permissions for WorkSpaces connection aliases. WorkSpaces Thin Client updated the policy to include limited read permissions for AppStream 2.0, WorkSpaces Web and WorkSpaces. August 9th 2024 AmazonWorkSpacesTh inClientFullAccess – New policy Provides full access to Amazon WorkSpaces Thin Client as well as limited August 9th 2024 AWS managed policies 93 Amazon WorkSpaces Thin Client Administrator Guide Change Description Date access to required related services. AmazonWorkSpacesTh inClientReadOnlyAccess – New policy Provides read-only access to Amazon WorkSpaces Thin Client and its dependencies. July 19th 2024 WorkSpaces Thin Client started tracking changes WorkSpaces Thin Client started tracking changes for its AWS managed policies. July 19th 2024 Troubleshooting Amazon WorkSpaces Thin Client identity and access Use the following information to help you diagnose and fix common issues that you might encounter when working with WorkSpaces Thin Client and IAM. Topics • I am not authorized to perform an action in WorkSpaces Thin Client • I want to view my access keys • I'm an administrator and want to allow others to access WorkSpaces Thin Client • I want to allow people outside of my AWS account to access my WorkSpaces Thin Client resources I am not authorized to perform an action in WorkSpaces Thin Client If the AWS Management Console tells you that you're not authorized to perform an action, then you must contact your administrator for assistance. Your administrator is the person that provided you with your user name and password. The following example error occurs when the mateojackson IAM user tries to use the console to view details about a fictional my-thin-client-device resource but does not have the fictional thinclient:ListDevices permissions. User: arn:aws:iam::123456789012:user/mateojackson is not authorized to perform: thinclient:ListDevices on resource: my-thin-client-device Troubleshooting 94 Amazon WorkSpaces Thin Client Administrator Guide In this case, Mateo asks his administrator to update his policies to allow him to access the my- thin-client-device resource by using the thinclient:ListDevices action. I want to view my access keys After you create your IAM user access keys, you can view your access key ID at any time. However, you can't view your secret access key again. If you lose your secret key, you must create a new access key pair. Access keys consist of two parts: an access key ID (for example, AKIAIOSFODNN7EXAMPLE) and a secret access key (for example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY). Like a user name and password, you must use both the access key ID and secret access key together to authenticate your requests. Manage your access keys as securely as you do your user name and password. Important Do not provide your access keys to a third party, even to help find your canonical user ID. By doing this, you might give someone permanent access to your AWS account. When you create an access key pair, you are prompted to save the access key ID and secret access key in a secure location. The secret access key is available only at the time you create it. If you lose your secret access key, you must add new access keys to your IAM user. You can have a maximum of two access keys. If you already have two, you must delete one key pair before creating a new one. To view instructions, see Managing access keys in the IAM User Guide. I'm an administrator and want to allow others to access WorkSpaces Thin Client To allow others to access WorkSpaces Thin Client, you must grant permission to the people or applications that need access. If you are using AWS IAM Identity Center to manage people and applications, you assign permission sets to users or groups to define their level of access. Permission sets automatically create and assign IAM policies to IAM roles that are associated with the person or application. For more information, see Permission sets in the AWS IAM Identity Center User Guide. If you are not using IAM Identity Center, you must create IAM entities (users or roles) for the people or applications that need access. You must then attach a policy to |
workspaces-thin-client-admin-guide-031 | workspaces-thin-client-admin-guide.pdf | 31 | permission to the people or applications that need access. If you are using AWS IAM Identity Center to manage people and applications, you assign permission sets to users or groups to define their level of access. Permission sets automatically create and assign IAM policies to IAM roles that are associated with the person or application. For more information, see Permission sets in the AWS IAM Identity Center User Guide. If you are not using IAM Identity Center, you must create IAM entities (users or roles) for the people or applications that need access. You must then attach a policy to the entity that grants them the correct permissions in WorkSpaces Thin Client. After the permissions are granted, provide the Troubleshooting 95 Amazon WorkSpaces Thin Client Administrator Guide credentials to the user or application developer. They will use those credentials to access AWS. To learn more about creating IAM users, groups, policies, and permissions, see IAM Identities and Policies and permissions in IAM in the IAM User Guide. For more information, see Grant full access to WorkSpaces Thin Client. I want to allow people outside of my AWS account to access my WorkSpaces Thin Client resources You can create a role that users in other accounts or people outside of your organization can use to access your resources. You can specify who is trusted to assume the role. For services that support resource-based policies or access control lists (ACLs), you can use those policies to grant people access to your resources. To learn more, consult the following: • To learn whether WorkSpaces Thin Client supports these features, see How Amazon WorkSpaces Thin Client works with IAM. • To learn how to provide access to your resources across AWS accounts that you own, see Providing access to an IAM user in another AWS account that you own in the IAM User Guide. • To learn how to provide access to your resources to third-party AWS accounts, see Providing access to AWS accounts owned by third parties in the IAM User Guide. • To learn how to provide access through identity federation, see Providing access to externally authenticated users (identity federation) in the IAM User Guide. • To learn the difference between using roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. Resilience in Amazon WorkSpaces Thin Client The AWS global infrastructure is built around AWS Regions and Availability Zones. AWS Regions provide multiple physically separated and isolated Availability Zones, which are connected with low-latency, high-throughput, and highly redundant networking. With Availability Zones, you can design and operate applications and databases that automatically fail over between Availability Zones without interruption. Availability Zones are more highly available, fault tolerant, and scalable than traditional single or multiple data center infrastructures. For more information about AWS Regions and Availability Zones, see AWS Global Infrastructure. Resilience 96 Amazon WorkSpaces Thin Client Administrator Guide In addition to the AWS global infrastructure, WorkSpaces Thin Client offers several features to help support your data resiliency and backup needs. Vulnerability analysis and management in Amazon WorkSpaces Thin Client Configuration and IT controls are a shared responsibility between AWS and you. For more information, see the AWS shared responsibility model. Amazon WorkSpaces Thin Client cross-integrates with Amazon WorkSpaces, Amazon AppStream 2.0, and WorkSpaces Web. See the following links for more information about update management for each of these services: • Update Management in Amazon AppStream 2.0 • Update management in Amazon WorkSpaces • Configuration and vulnerability analysis in Amazon WorkSpaces Web Vulnerability Analysis and Management 97 Amazon WorkSpaces Thin Client Administrator Guide Monitoring Amazon WorkSpaces Thin Client Monitoring is an important part of maintaining the reliability, availability, and performance of Amazon WorkSpaces Thin Client and your other AWS solutions. AWS provides the following monitoring tools to watch WorkSpaces Thin Client, report when something is wrong, and take automatic actions when appropriate: • AWS CloudTrail captures API calls and related events made by or on behalf of your AWS account and delivers the log files to the Amazon S3 bucket that you specify. You can identify users and accounts that called AWS, the source IP address from which the calls were made, and when the calls occurred. For more information, see the AWS CloudTrail User Guide. Topics • Logging Amazon WorkSpaces Thin Client API calls using AWS CloudTrail Logging Amazon WorkSpaces Thin Client API calls using AWS CloudTrail Amazon WorkSpaces Thin Client is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service. CloudTrail captures all API calls for WorkSpaces Thin Client as events. The calls captured include calls from the WorkSpaces Thin Client console and code calls to the WorkSpaces Thin Client API operations. Using the information collected by CloudTrail, you |
workspaces-thin-client-admin-guide-032 | workspaces-thin-client-admin-guide.pdf | 32 | when the calls occurred. For more information, see the AWS CloudTrail User Guide. Topics • Logging Amazon WorkSpaces Thin Client API calls using AWS CloudTrail Logging Amazon WorkSpaces Thin Client API calls using AWS CloudTrail Amazon WorkSpaces Thin Client is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service. CloudTrail captures all API calls for WorkSpaces Thin Client as events. The calls captured include calls from the WorkSpaces Thin Client console and code calls to the WorkSpaces Thin Client API operations. Using the information collected by CloudTrail, you can determine the request that was made to WorkSpaces Thin Client, the IP address from which the request was made, when it was made, and additional details. All Amazon WorkSpaces Thin Client actions are logged by CloudTrail and are documented in the Amazon WorkSpaces Thin Client API Reference. For example, calls to the CreateEnvironment, DeleteDevice and GetSoftwareSet actions generate entries in the CloudTrail log files. Every event or log entry contains information about who generated the request. The identity information helps you determine the following: • Whether the request was made with root user or user credentials. • Whether the request was made on behalf of an IAM Identity Center user. • Whether the request was made with temporary security credentials for a role or federated user. CloudTrail logs 98 Amazon WorkSpaces Thin Client Administrator Guide • Whether the request was made by another AWS service. CloudTrail is active in your AWS account when you create the account and you automatically have access to the CloudTrail Event history. The CloudTrail Event history provides a viewable, searchable, downloadable, and immutable record of the past 90 days of recorded management events in an AWS Region. For more information, see Working with CloudTrail Event history in the AWS CloudTrail User Guide. There are no CloudTrail charges for viewing the Event history. For an ongoing record of events in your AWS account past 90 days, create a trail or a CloudTrail Lake event data store. CloudTrail trails A trail enables CloudTrail to deliver log files to an Amazon S3 bucket. All trails created using the AWS Management Console are multi-Region. You can create a single-Region or a multi-Region trail by using the AWS CLI. Creating a multi-Region trail is recommended because you capture activity in all AWS Regions in your account. If you create a single-Region trail, you can view only the events logged in the trail's AWS Region. For more information about trails, see Creating a trail for your AWS account and Creating a trail for an organization in the AWS CloudTrail User Guide. You can deliver one copy of your ongoing management events to your Amazon S3 bucket at no charge from CloudTrail by creating a trail, however, there are Amazon S3 storage charges. For more information about CloudTrail pricing, see AWS CloudTrail Pricing. For information about Amazon S3 pricing, see Amazon S3 Pricing. CloudTrail Lake event data stores CloudTrail Lake lets you run SQL-based queries on your events. CloudTrail Lake converts existing events in row-based JSON format to Apache ORC format. ORC is a columnar storage format that is optimized for fast retrieval of data. Events are aggregated into event data stores, which are immutable collections of events based on criteria that you select by applying advanced event selectors. The selectors that you apply to an event data store control which events persist and are available for you to query. For more information about CloudTrail Lake, see Working with AWS CloudTrail Lake in the AWS CloudTrail User Guide. CloudTrail Lake event data stores and queries incur costs. When you create an event data store, you choose the pricing option you want to use for the event data store. The pricing option determines the cost for ingesting and storing events, and the default and maximum CloudTrail logs 99 Amazon WorkSpaces Thin Client Administrator Guide retention period for the event data store. For more information about CloudTrail pricing, see AWS CloudTrail Pricing. WorkSpaces Thin Client data events in CloudTrail Data events provide information about the resource operations performed on or in a resource (for example, registration of a device by an end user). These are also known as data plane operations. Data events are often high-volume activities. By default, CloudTrail doesn’t log data events. The CloudTrail Event history doesn't record data events. Additional charges apply for data events. For more information about CloudTrail pricing, see AWS CloudTrail Pricing. You can log data events for the WorkSpaces Thin Client resource types by using the CloudTrail console, AWS CLI, or CloudTrail API operations. For more information about how to log data events, see Logging data events with the AWS Management Console and Logging data events with the AWS Command Line Interface in the AWS CloudTrail |
workspaces-thin-client-admin-guide-033 | workspaces-thin-client-admin-guide.pdf | 33 | These are also known as data plane operations. Data events are often high-volume activities. By default, CloudTrail doesn’t log data events. The CloudTrail Event history doesn't record data events. Additional charges apply for data events. For more information about CloudTrail pricing, see AWS CloudTrail Pricing. You can log data events for the WorkSpaces Thin Client resource types by using the CloudTrail console, AWS CLI, or CloudTrail API operations. For more information about how to log data events, see Logging data events with the AWS Management Console and Logging data events with the AWS Command Line Interface in the AWS CloudTrail User Guide. The following table lists the WorkSpaces Thin Client resource types for which you can log data events. The Data event type (console) column shows the value to choose from the Data event type list on the CloudTrail console. The resources.type value column shows the resources.type value, which you would specify when configuring advanced event selectors using the AWS CLI or CloudTrail APIs. The Data APIs logged to CloudTrail column shows the API calls logged to CloudTrail for the resource type. Data event type (console) resources.type value Data APIs logged to CloudTrail ThinClientDevice AWS::WorkSpacesThi • RegisterDevice nClient::Device • UpdateDeviceDetails You can configure advanced event selectors to filter on the eventName, readOnly, and resources.ARN fields to log only those events that are important to you. For more information about these fields, see AdvancedFieldSelector in the AWS CloudTrail API Reference. CloudTrail data events 100 Amazon WorkSpaces Thin Client Administrator Guide WorkSpaces Thin Client management events in CloudTrail Management events provide information about management operations that are performed on resources in your AWS account. These are also known as control plane operations. By default, CloudTrail logs management events. Amazon WorkSpaces Thin Client logs all WorkSpaces Thin Client control plane operations as management events. For a list of the Amazon WorkSpaces Thin Client control plane operations that WorkSpaces Thin Client logs to CloudTrail, see the Amazon WorkSpaces Thin Client API Reference. WorkSpaces Thin Client event examples An event represents a single request from any source and includes information about the requested API operation, the date and time of the operation, request parameters, and so on. CloudTrail log files aren't an ordered stack trace of the public API calls, so events don't appear in any specific order. The following example shows a CloudTrail event that demonstrates the RegisterDevice operation. { "eventVersion": "1.10", "userIdentity": { "type": "Unknown", "accountId": "111111111111", "userName": "DSN: G1X11X11111111XX" }, "eventTime": "2024-06-19T17:13:44Z", "eventSource": "thinclient.amazonaws.com", "eventName": "RegisterDevice", "awsRegion": "us-west-2", "sourceIPAddress": "AWS Internal", "userAgent": "AWS Internal", "requestParameters": { "dsn": "G1X11X11111111XX", "activationCode": "xxx1xxx1", "model": "AFTGAZL" }, "responseElements": null, "requestID": "f626fb2b-a841-4b87-9a9b-685a62024058", CloudTrail management events 101 Amazon WorkSpaces Thin Client Administrator Guide "eventID": "214385d7-9249-4f60-af56-b4c951e0491d", "readOnly": false, "resources": [ { "type": "AWS::ThinClient::Device", "ARN": "arn:aws:thinclient:us-west-2:111111111111:device/DEVICE_ID" } ], "eventType": "AwsApiCall", "managementEvent": false, "recipientAccountId": "111111111111", "eventCategory": "Data" } The following example shows a CloudTrail event that demonstrates the UpdateDeviceDetails operation. { "eventVersion": "1.10", "userIdentity": { "type": "Unknown", "accountId": "111111111111", "userName": "DSN: G1X11X11111111XX" }, "eventTime": "2024-10-21T17:46:27Z", "eventSource": "thinclient.amazonaws.com", "eventName": "UpdateDeviceDetails", "awsRegion": "us-west-2", "sourceIPAddress": "AWS Internal", "userAgent": "AWS Internal", "requestParameters": null, "responseElements": null, "requestID": "7d562fcf-a9ce-40da-9e5c-9ef390b8b83c", "eventID": "f294b614-b00c-45ef-b293-cd389121033a", "readOnly": false, "resources": [ { "type": "AWS::ThinClient::Device", "ARN": "arn:aws:thinclient:us-west-2:111111111111:device/DEVICE_ID" } ], "eventType": "AwsServiceEvent", "managementEvent": false, CloudTrail event examples 102 Amazon WorkSpaces Thin Client Administrator Guide "recipientAccountId": "111111111111", "serviceEventDetails": { "settings": { "network": { "ethernet": { "addresses": [ { "gateway": "gateway", "localIp": "localIp", "type": "IPV4" } ], "connectionStatus": "NOT_CONNECTED" }, "networkInterfaceInUse": "ETHERNET", "wifi": { "addresses": [ { "gateway": "gateway", "localIp": "localIp", "type": "IPV4" } ], "connectionStatus": "NOT_CONNECTED" } }, "peripherals": { "bluetooth": { "enabledStatus": "ENABLED" }, "keyboards": [ { "name": "name", "type": "USB" } ], "mice": [ { "name": "name", "type": "BLUETOOTH" } ], "sound": { "microphones": [ CloudTrail event examples 103 Administrator Guide Amazon WorkSpaces Thin Client { "name": "name", "selectionStatus": "SELECTED", "type": "BUILT_IN" } ], "speakers": [ { "name": "name", "selectionStatus": "SELECTED", "type": "BUILT_IN" } ] }, "webcams": [ { "name": "name", "selectionStatus": "SELECTED", "type": "USB" } ] }, "powerAndSleep": { "sleepAfter": "FIFTEEN_MINUTES" } }, "updatedAt": "2024-10-21T17:46:27.624Z" }, "eventCategory": "Data" } For information about CloudTrail record contents, see CloudTrail record contents in the AWS CloudTrail User Guide. CloudTrail event examples 104 Amazon WorkSpaces Thin Client Administrator Guide Creating Amazon WorkSpaces Thin Client resources with AWS CloudFormation Amazon WorkSpaces Thin Client is integrated with AWS CloudFormation, a service that helps you model and set up your AWS resources. This way, you can spend less time creating and managing your resources and infrastructure. You create a template that describes all the AWS resources that you want (such as Environments), and AWS CloudFormation provisions and configures those resources for you. When you use AWS CloudFormation, you can reuse your template to set up your WorkSpaces Thin Client resources consistently and repeatedly. Describe your resources once, and then provision the same resources repeatedly in multiple AWS accounts and Regions. |
workspaces-thin-client-admin-guide-034 | workspaces-thin-client-admin-guide.pdf | 34 | CloudFormation Amazon WorkSpaces Thin Client is integrated with AWS CloudFormation, a service that helps you model and set up your AWS resources. This way, you can spend less time creating and managing your resources and infrastructure. You create a template that describes all the AWS resources that you want (such as Environments), and AWS CloudFormation provisions and configures those resources for you. When you use AWS CloudFormation, you can reuse your template to set up your WorkSpaces Thin Client resources consistently and repeatedly. Describe your resources once, and then provision the same resources repeatedly in multiple AWS accounts and Regions. WorkSpaces Thin Client and AWS CloudFormation templates To provision and configure resources for WorkSpaces Thin Client and related services, you must understand AWS CloudFormation templates. Templates are formatted text files in JSON or YAML format. These templates describe the resources that you want to provision in your AWS CloudFormation stacks. If you're unfamiliar with JSON or YAML formats, you can use AWS CloudFormation Designer to help you get started with AWS CloudFormation templates. For more information, see What is AWS CloudFormation Designer? in the AWS CloudFormation User Guide. WorkSpaces Thin Client supports creating Environments in AWS CloudFormation. For more information, including examples of JSON and YAML templates for Environments, see the Amazon WorkSpaces Thin Client resource type reference in the AWS CloudFormation User Guide. Learn more about AWS CloudFormation To learn more about AWS CloudFormation, see the following resources: • AWS CloudFormation • AWS CloudFormation User Guide • AWS CloudFormation API Reference • AWS CloudFormation Command Line Interface User Guide WorkSpaces Thin Client and AWS CloudFormation templates 105 Amazon WorkSpaces Thin Client Administrator Guide Access Amazon WorkSpaces Thin Client by using an interface endpoint (AWS PrivateLink) You can use AWS PrivateLink to create a private connection between your VPC and Amazon WorkSpaces Thin Client. You can access WorkSpaces Thin Client as a VPC, without the use of an internet gateway, NAT device, VPN connection, or AWS Direct Connect connection. Instances in your VPC don't require public IP addresses to access WorkSpaces Thin Client. You establish this private connection by creating an interface endpoint that's powered by AWS PrivateLink. We create an endpoint network interface in each subnet that you enable for the interface endpoint. These are requester-managed network interfaces that serve as the entry point for traffic destined for WorkSpaces Thin Client. For more information, see Access AWS services through AWS PrivateLink in the AWS PrivateLink Guide. Considerations for WorkSpaces Thin Client Before you set up an interface endpoint for WorkSpaces Thin Client, review Considerations in the AWS PrivateLink Guide. WorkSpaces Thin Client supports making calls to all of its API actions through the interface endpoint. Create an interface endpoint for WorkSpaces Thin Client You can create an interface endpoint for WorkSpaces Thin Client by using either the Amazon VPC console or the AWS Command Line Interface (AWS CLI). For more information, see Create an interface endpoint in the AWS PrivateLink Guide. Create an interface endpoint for WorkSpaces Thin Client by using the following service name: com.amazonaws.region.thinclient.api If you enable private DNS for the interface endpoint, you can make API requests to WorkSpaces Thin Client by using its default Regional DNS name. For example, api.thinclient.us- east-1.amazonaws.com. Considerations 106 Amazon WorkSpaces Thin Client Administrator Guide Create an endpoint policy for your interface endpoint An endpoint policy is an IAM resource that you can attach to an interface endpoint. The default endpoint policy gives you full access to WorkSpaces Thin Client through the interface endpoint. To control the access granted to WorkSpaces Thin Client from your VPC, attach a custom endpoint policy to the interface endpoint. An endpoint policy specifies the following information: • The principals that can perform actions (AWS accounts, IAM users, and IAM roles). • The actions that can be performed. • The resources on which the actions can be performed. For more information, see Control access to services using endpoint policies in the AWS PrivateLink Guide. Example: VPC endpoint policy for WorkSpaces Thin Client actions The following is an example of a custom endpoint policy. When you attach this policy to your interface endpoint, it grants access to the listed WorkSpaces Thin Client actions for all principals on all resources. { "Statement": [ { "Principal": "*", "Effect": "Allow", "Action": [ "thinclient:ListEnvironments", "thinclient:ListDevices", "thinclient:ListSoftwareSets" ], "Resource":"*" } ] } Create an endpoint policy 107 Amazon WorkSpaces Thin Client Administrator Guide Document history for the WorkSpaces Thin Client Administrator Guide The following table describes the documentation history for releases of the WorkSpaces Thin Client Administrator Guide. Change Description Date AWS managed policy: AmazonWorkSpacesTh Amazon WorkSpaces Thin Client added AmazonWor inClientFullAccess kSpacesThinClientFullAccess January 9, 2025 managed policy version 2. AWS managed policy: AmazonWorkSpacesTh Amazon WorkSpaces Thin Client added AmazonWor inClientReadOnlyAccess kSpacesThinClientR January 9, 2025 eadOnlyAccess managed policies version 3. Logging Amazon |
workspaces-thin-client-admin-guide-035 | workspaces-thin-client-admin-guide.pdf | 35 | all resources. { "Statement": [ { "Principal": "*", "Effect": "Allow", "Action": [ "thinclient:ListEnvironments", "thinclient:ListDevices", "thinclient:ListSoftwareSets" ], "Resource":"*" } ] } Create an endpoint policy 107 Amazon WorkSpaces Thin Client Administrator Guide Document history for the WorkSpaces Thin Client Administrator Guide The following table describes the documentation history for releases of the WorkSpaces Thin Client Administrator Guide. Change Description Date AWS managed policy: AmazonWorkSpacesTh Amazon WorkSpaces Thin Client added AmazonWor inClientFullAccess kSpacesThinClientFullAccess January 9, 2025 managed policy version 2. AWS managed policy: AmazonWorkSpacesTh Amazon WorkSpaces Thin Client added AmazonWor inClientReadOnlyAccess kSpacesThinClientR January 9, 2025 eadOnlyAccess managed policies version 3. Logging Amazon WorkSpace s Thin Client API calls using Added new section for data events. October 28, 2024 AWS CloudTrail Added new section for device Device settings settings. Data encryption at rest for Updated the KMS informati Amazon WorkSpaces Thin on in the section for data Client encryption at rest. Business continuity AWS managed policy: AmazonWorkSpacesTh inClientFullAccess Added new section for Business continuity and disaster recovery. Amazon WorkSpaces Thin Client added AmazonWor kSpacesThinClientFullAccess managed policy. September 6, 2024 August 9, 2024 108 Amazon WorkSpaces Thin Client Administrator Guide Change Description Date AWS managed policy: AmazonWorkSpacesTh Amazon WorkSpaces Thin Client added AmazonWor inClientReadOnlyAccess kSpacesThinClientR August 9, 2024 eadOnlyAccess managed policies version 2. Configuring WorkSpaces Personal for WorkSpaces Thin Updated the for new WorkSpaces Personal. August 7, 2024 Client Configuring WorkSpaces Pools for WorkSpaces Thin Client Added new section for new WorkSpaces Pools. August 7, 2024 AWS managed policy: AmazonWorkSpacesTh Amazon WorkSpaces Thin Client added AmazonWor inClientReadOnlyAccess kSpacesThinClientR July 19, 2024 eadOnlyAccess managed policy. AWS managed policies for Amazon WorkSpaces Thin Amazon WorkSpaces Thin Client started tracking July 19, 2024 Client changes. Configuring WorkSpaces for Amazon WorkSpaces Thin Client Configuring AppStream 2.0 for Amazon WorkSpaces Thin Client Updated the operating system list. February 12, 2024 Updated the Identity Provider procedure. February 12, 2024 Initial release Initial release November 26, 2023 109 |
workspaces-thin-client-api-001 | workspaces-thin-client-api.pdf | 1 | API Reference Amazon WorkSpaces Thin Client API Version 2023-08-22 Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon WorkSpaces Thin Client API Reference Amazon WorkSpaces Thin Client: API Reference Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. Amazon WorkSpaces Thin Client Table of Contents API Reference Welcome ........................................................................................................................................... 1 Actions .............................................................................................................................................. 2 CreateEnvironment ....................................................................................................................................... 3 Request Syntax ........................................................................................................................................ 3 URI Request Parameters ........................................................................................................................ 3 Request Body ........................................................................................................................................... 3 Response Syntax ...................................................................................................................................... 7 Response Elements ................................................................................................................................. 7 Errors .......................................................................................................................................................... 8 See Also ..................................................................................................................................................... 9 DeleteDevice ................................................................................................................................................ 10 Request Syntax ...................................................................................................................................... 10 URI Request Parameters ...................................................................................................................... 10 Request Body ......................................................................................................................................... 10 Response Syntax ................................................................................................................................... 11 Response Elements ............................................................................................................................... 11 Errors ....................................................................................................................................................... 11 See Also .................................................................................................................................................. 12 DeleteEnvironment .................................................................................................................................... 13 Request Syntax ...................................................................................................................................... 13 URI Request Parameters ...................................................................................................................... 13 Request Body ......................................................................................................................................... 13 Response Syntax ................................................................................................................................... 14 Response Elements ............................................................................................................................... 14 Errors ....................................................................................................................................................... 14 See Also .................................................................................................................................................. 15 DeregisterDevice ......................................................................................................................................... 16 Request Syntax ...................................................................................................................................... 16 URI Request Parameters ...................................................................................................................... 16 Request Body ......................................................................................................................................... 16 Response Syntax ................................................................................................................................... 17 Response Elements ............................................................................................................................... 17 Errors ....................................................................................................................................................... 17 See Also .................................................................................................................................................. 18 API Version 2023-08-22 iii Amazon WorkSpaces Thin Client API Reference GetDevice ..................................................................................................................................................... 19 Request Syntax ...................................................................................................................................... 19 URI Request Parameters ...................................................................................................................... 19 Request Body ......................................................................................................................................... 19 Response Syntax ................................................................................................................................... 19 Response Elements ............................................................................................................................... 20 Errors ....................................................................................................................................................... 20 See Also .................................................................................................................................................. 21 GetEnvironment .......................................................................................................................................... 22 Request Syntax ...................................................................................................................................... 22 URI Request Parameters ...................................................................................................................... 22 Request Body ......................................................................................................................................... 22 Response Syntax ................................................................................................................................... 22 Response Elements ............................................................................................................................... 23 Errors ....................................................................................................................................................... 23 See Also .................................................................................................................................................. 24 GetSoftwareSet ........................................................................................................................................... 26 Request Syntax ...................................................................................................................................... 26 URI Request Parameters ...................................................................................................................... 26 Request Body ......................................................................................................................................... 26 Response Syntax ................................................................................................................................... 26 Response Elements ............................................................................................................................... 27 Errors ....................................................................................................................................................... 27 See Also .................................................................................................................................................. 28 ListDevices .................................................................................................................................................... 29 Request Syntax ...................................................................................................................................... 29 URI Request Parameters ...................................................................................................................... 29 Request Body ......................................................................................................................................... 29 Response Syntax ................................................................................................................................... 29 Response Elements ............................................................................................................................... 30 Errors ....................................................................................................................................................... 31 See Also .................................................................................................................................................. 31 ListEnvironments ........................................................................................................................................ 33 Request Syntax ...................................................................................................................................... 33 URI Request Parameters ...................................................................................................................... 33 Request Body ......................................................................................................................................... 33 API Version 2023-08-22 iv Amazon WorkSpaces Thin Client API Reference Response Syntax ................................................................................................................................... 33 Response Elements ............................................................................................................................... 34 Errors ....................................................................................................................................................... 35 See Also .................................................................................................................................................. 36 ListSoftwareSets ......................................................................................................................................... 37 Request Syntax ...................................................................................................................................... 37 URI Request Parameters ...................................................................................................................... 37 Request Body ......................................................................................................................................... 37 Response Syntax ................................................................................................................................... 37 Response Elements ............................................................................................................................... 38 Errors ....................................................................................................................................................... 38 See Also .................................................................................................................................................. 39 ListTagsForResource ................................................................................................................................... 40 Request Syntax ...................................................................................................................................... 40 URI Request Parameters ...................................................................................................................... 40 Request Body ......................................................................................................................................... 40 Response Syntax ................................................................................................................................... 40 Response Elements ............................................................................................................................... 40 Errors ....................................................................................................................................................... 41 See Also .................................................................................................................................................. 41 TagResource ................................................................................................................................................. 43 Request Syntax ...................................................................................................................................... 43 URI Request Parameters ...................................................................................................................... 43 Request Body ......................................................................................................................................... 43 Response Syntax ................................................................................................................................... 43 Response Elements ............................................................................................................................... 44 Errors ....................................................................................................................................................... 44 See Also .................................................................................................................................................. 45 UntagResource ............................................................................................................................................ 46 Request Syntax ...................................................................................................................................... 46 URI Request Parameters ...................................................................................................................... 46 Request Body ......................................................................................................................................... 46 Response Syntax ................................................................................................................................... 46 Response Elements ............................................................................................................................... 46 Errors ....................................................................................................................................................... 46 See Also .................................................................................................................................................. 47 API Version 2023-08-22 v Amazon WorkSpaces Thin Client API Reference UpdateDevice .............................................................................................................................................. 49 Request Syntax ...................................................................................................................................... 49 URI Request Parameters ...................................................................................................................... 49 Request Body ......................................................................................................................................... 49 Response Syntax ................................................................................................................................... 50 Response Elements ............................................................................................................................... 51 Errors ....................................................................................................................................................... 51 See Also .................................................................................................................................................. 52 UpdateEnvironment ................................................................................................................................... 53 Request Syntax ...................................................................................................................................... 53 URI Request Parameters ...................................................................................................................... 53 Request Body ......................................................................................................................................... 54 Response Syntax ................................................................................................................................... 56 Response Elements ............................................................................................................................... 56 Errors ....................................................................................................................................................... 57 See Also .................................................................................................................................................. 57 UpdateSoftwareSet .................................................................................................................................... 59 Request Syntax ...................................................................................................................................... 59 URI Request Parameters ...................................................................................................................... 59 Request Body ......................................................................................................................................... 59 Response Syntax ................................................................................................................................... 60 Response Elements ............................................................................................................................... 60 Errors ....................................................................................................................................................... 60 See Also .................................................................................................................................................. 61 Data Types ..................................................................................................................................... 62 Device ............................................................................................................................................................ 63 Contents .................................................................................................................................................. 63 See Also .................................................................................................................................................. 67 DeviceSummary .......................................................................................................................................... 68 Contents .................................................................................................................................................. 68 See Also .................................................................................................................................................. 71 Environment ................................................................................................................................................ 72 Contents .................................................................................................................................................. 72 See Also .................................................................................................................................................. 76 EnvironmentSummary ............................................................................................................................... 77 Contents .................................................................................................................................................. 77 API Version 2023-08-22 vi Amazon WorkSpaces Thin Client API Reference See Also .................................................................................................................................................. 80 MaintenanceWindow ................................................................................................................................. 81 Contents .................................................................................................................................................. 81 See Also .................................................................................................................................................. 82 Software ....................................................................................................................................................... 83 Contents .................................................................................................................................................. 83 See Also .................................................................................................................................................. 83 SoftwareSet ................................................................................................................................................. 84 Contents .................................................................................................................................................. 84 See Also .................................................................................................................................................. 85 SoftwareSetSummary ................................................................................................................................ 86 Contents .................................................................................................................................................. 86 See Also .................................................................................................................................................. 87 ValidationExceptionField ........................................................................................................................... 88 Contents .................................................................................................................................................. 88 See Also .................................................................................................................................................. 88 Common Parameters ..................................................................................................................... 89 Common Errors .............................................................................................................................. 92 API Version 2023-08-22 vii Amazon WorkSpaces Thin Client API Reference Welcome Amazon WorkSpaces Thin Client is an affordable device built to work with AWS End User Computing (EUC) virtual desktops to provide |
workspaces-thin-client-api-002 | workspaces-thin-client-api.pdf | 2 | Amazon WorkSpaces Thin Client API Reference See Also .................................................................................................................................................. 80 MaintenanceWindow ................................................................................................................................. 81 Contents .................................................................................................................................................. 81 See Also .................................................................................................................................................. 82 Software ....................................................................................................................................................... 83 Contents .................................................................................................................................................. 83 See Also .................................................................................................................................................. 83 SoftwareSet ................................................................................................................................................. 84 Contents .................................................................................................................................................. 84 See Also .................................................................................................................................................. 85 SoftwareSetSummary ................................................................................................................................ 86 Contents .................................................................................................................................................. 86 See Also .................................................................................................................................................. 87 ValidationExceptionField ........................................................................................................................... 88 Contents .................................................................................................................................................. 88 See Also .................................................................................................................................................. 88 Common Parameters ..................................................................................................................... 89 Common Errors .............................................................................................................................. 92 API Version 2023-08-22 vii Amazon WorkSpaces Thin Client API Reference Welcome Amazon WorkSpaces Thin Client is an affordable device built to work with AWS End User Computing (EUC) virtual desktops to provide users with a complete cloud desktop solution. WorkSpaces Thin Client is a compact device designed to connect up to two monitors and USB devices like a keyboard, mouse, headset, and webcam. To maximize endpoint security, WorkSpaces Thin Client devices do not allow local data storage or installation of unapproved applications. The WorkSpaces Thin Client device ships preloaded with device management software. You can use these APIs to complete WorkSpaces Thin Client tasks, such as creating environments or viewing devices. For more information about WorkSpaces Thin Client, including the required permissions to use the service, see the Amazon WorkSpaces Thin Client Administrator Guide. For more information about using the AWS Command Line Interface (AWS CLI) to manage your WorkSpaces Thin Client resources, see the WorkSpaces Thin Client section of the AWS CLI Reference. This document was last published on May 21, 2025. API Version 2023-08-22 1 Amazon WorkSpaces Thin Client API Reference Actions The following actions are supported: • CreateEnvironment • DeleteDevice • DeleteEnvironment • DeregisterDevice • GetDevice • GetEnvironment • GetSoftwareSet • ListDevices • ListEnvironments • ListSoftwareSets • ListTagsForResource • TagResource • UntagResource • UpdateDevice • UpdateEnvironment • UpdateSoftwareSet API Version 2023-08-22 2 API Reference Amazon WorkSpaces Thin Client CreateEnvironment Creates an environment for your thin client devices. Request Syntax POST /environments HTTP/1.1 Content-type: application/json { "clientToken": "string", "desiredSoftwareSetId": "string", "desktopArn": "string", "desktopEndpoint": "string", "deviceCreationTags": { "string" : "string" }, "kmsKeyArn": "string", "maintenanceWindow": { "applyTimeOf": "string", "daysOfTheWeek": [ "string" ], "endTimeHour": number, "endTimeMinute": number, "startTimeHour": number, "startTimeMinute": number, "type": "string" }, "name": "string", "softwareSetUpdateMode": "string", "softwareSetUpdateSchedule": "string", "tags": { "string" : "string" } } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. CreateEnvironment API Version 2023-08-22 3 Amazon WorkSpaces Thin Client clientToken API Reference Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value. If you don't provide this value, then AWS generates a random one for you. If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No desiredSoftwareSetId The ID of the software set to apply. Type: String Pattern: [0-9]{1,9} Required: No desktopArn The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or AppStream 2.0. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[0-9]{0,12}:[a-zA- Z0-9\-\/\._]+ Required: Yes Request Body API Version 2023-08-22 4 Amazon WorkSpaces Thin Client desktopEndpoint API Reference The URL for the identity provider login (only for environments that use AppStream 2.0). Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: (https:\/\/)[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,32}(:[0-9] {1,5})?(\/.*)? Required: No deviceCreationTags A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: (?!aws:)[A-Za-z0-9 _=@:.+-/]+ Value Length Constraints: Minimum length of 0. Maximum length of 256. Value Pattern: [A-Za-z0-9 _=@:.+-/]+ Required: No kmsKeyArn The Amazon Resource Name (ARN) of the AWS Key Management Service key to use to encrypt the environment. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[0-9]{0,12}:key\/[a-zA- Z0-9-]+ Required: No Request Body API Version 2023-08-22 5 Amazon WorkSpaces Thin Client maintenanceWindow API Reference A specification for a time window to apply software updates. Type: MaintenanceWindow object Required: No name The name for the environment. Type: String Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: $|^[0-9\p{IsAlphabetic}+:,.@'" -][0-9\p{IsAlphabetic}+=:,.@'" -]* Required: No softwareSetUpdateMode An option to define which software updates to apply. Type: String Valid Values: USE_LATEST | USE_DESIRED Required: No softwareSetUpdateSchedule An option to define if software updates should be applied within a maintenance window. Type: |
workspaces-thin-client-api-003 | workspaces-thin-client-api.pdf | 3 | Minimum length of 20. Maximum length of 2048. Pattern: arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[0-9]{0,12}:key\/[a-zA- Z0-9-]+ Required: No Request Body API Version 2023-08-22 5 Amazon WorkSpaces Thin Client maintenanceWindow API Reference A specification for a time window to apply software updates. Type: MaintenanceWindow object Required: No name The name for the environment. Type: String Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: $|^[0-9\p{IsAlphabetic}+:,.@'" -][0-9\p{IsAlphabetic}+=:,.@'" -]* Required: No softwareSetUpdateMode An option to define which software updates to apply. Type: String Valid Values: USE_LATEST | USE_DESIRED Required: No softwareSetUpdateSchedule An option to define if software updates should be applied within a maintenance window. Type: String Valid Values: USE_MAINTENANCE_WINDOW | APPLY_IMMEDIATELY Required: No tags A map of the key-value pairs of the tag or tags to assign to the resource. Type: String to string map Required: No Request Body API Version 2023-08-22 6 API Reference Amazon WorkSpaces Thin Client Response Syntax HTTP/1.1 201 Content-type: application/json { "environment": { "activationCode": "string", "arn": "string", "createdAt": number, "desiredSoftwareSetId": "string", "desktopArn": "string", "desktopEndpoint": "string", "desktopType": "string", "id": "string", "maintenanceWindow": { "applyTimeOf": "string", "daysOfTheWeek": [ "string" ], "endTimeHour": number, "endTimeMinute": number, "startTimeHour": number, "startTimeMinute": number, "type": "string" }, "name": "string", "pendingSoftwareSetId": "string", "softwareSetUpdateMode": "string", "softwareSetUpdateSchedule": "string", "updatedAt": number } } Response Elements If the action is successful, the service sends back an HTTP 201 response. The following data is returned in JSON format by the service. environment Describes an environment. Type: EnvironmentSummary object Response Syntax API Version 2023-08-22 7 Amazon WorkSpaces Thin Client Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. HTTP Status Code: 409 InternalServerException The server encountered an internal error and is unable to complete the request. HTTP Status Code: 500 ResourceNotFoundException The resource specified in the request was not found. HTTP Status Code: 404 ServiceQuotaExceededException Your request exceeds a service quota. HTTP Status Code: 402 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the specified constraints. HTTP Status Code: 400 Errors API Version 2023-08-22 8 Amazon WorkSpaces Thin Client See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2023-08-22 9 API Reference Amazon WorkSpaces Thin Client DeleteDevice Deletes a thin client device. Request Syntax DELETE /devices/id?clientToken=clientToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. clientToken Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value. If you don't provide this value, then AWS generates a random one for you. If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error. Length Constraints: Minimum length of 1. Maximum length of 512. id The ID of the device to delete. Pattern: [a-zA-Z0-9]{24} Required: Yes Request Body The request does not have a request body. DeleteDevice API Version 2023-08-22 10 Amazon WorkSpaces Thin Client Response Syntax HTTP/1.1 204 Response Elements API Reference If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. HTTP Status Code: 409 InternalServerException The server encountered an internal error and is unable to complete the request. HTTP Status Code: 500 ResourceNotFoundException The resource specified in the request was not found. HTTP Status Code: 404 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the specified constraints. Response Syntax API Version 2023-08-22 11 Amazon WorkSpaces Thin Client HTTP Status Code: 400 See Also API Reference For more information about using this API in |
workspaces-thin-client-api-004 | workspaces-thin-client-api.pdf | 4 | state of a service resource associated with the request. Resolve the conflict before retrying this request. HTTP Status Code: 409 InternalServerException The server encountered an internal error and is unable to complete the request. HTTP Status Code: 500 ResourceNotFoundException The resource specified in the request was not found. HTTP Status Code: 404 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the specified constraints. Response Syntax API Version 2023-08-22 11 Amazon WorkSpaces Thin Client HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2023-08-22 12 API Reference Amazon WorkSpaces Thin Client DeleteEnvironment Deletes an environment. Request Syntax DELETE /environments/id?clientToken=clientToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. clientToken Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value. If you don't provide this value, then AWS generates a random one for you. If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error. Length Constraints: Minimum length of 1. Maximum length of 512. id The ID of the environment to delete. Pattern: [a-z0-9]{9} Required: Yes Request Body The request does not have a request body. DeleteEnvironment API Version 2023-08-22 13 Amazon WorkSpaces Thin Client Response Syntax HTTP/1.1 204 Response Elements API Reference If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. HTTP Status Code: 409 InternalServerException The server encountered an internal error and is unable to complete the request. HTTP Status Code: 500 ResourceNotFoundException The resource specified in the request was not found. HTTP Status Code: 404 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the specified constraints. Response Syntax API Version 2023-08-22 14 Amazon WorkSpaces Thin Client HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2023-08-22 15 API Reference Amazon WorkSpaces Thin Client DeregisterDevice Deregisters a thin client device. Request Syntax POST /deregister-device/id HTTP/1.1 Content-type: application/json { "clientToken": "string", "targetDeviceStatus": "string" } URI Request Parameters The request uses the following URI parameters. id The ID of the device to deregister. Pattern: [a-zA-Z0-9]{24} Required: Yes Request Body The request accepts the following data in JSON format. clientToken Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value. If you don't provide this value, then AWS generates a random one for you. DeregisterDevice API Version 2023-08-22 16 Amazon WorkSpaces Thin Client API Reference If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No targetDeviceStatus The desired new status for the device. Type: String Valid Values: DEREGISTERED | ARCHIVED Required: No Response Syntax HTTP/1.1 202 Response Elements If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body. Errors For information about the |
workspaces-thin-client-api-005 | workspaces-thin-client-api.pdf | 5 | value, then AWS generates a random one for you. DeregisterDevice API Version 2023-08-22 16 Amazon WorkSpaces Thin Client API Reference If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No targetDeviceStatus The desired new status for the device. Type: String Valid Values: DEREGISTERED | ARCHIVED Required: No Response Syntax HTTP/1.1 202 Response Elements If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. HTTP Status Code: 409 Response Syntax API Version 2023-08-22 17 Amazon WorkSpaces Thin Client InternalServerException API Reference The server encountered an internal error and is unable to complete the request. HTTP Status Code: 500 ResourceNotFoundException The resource specified in the request was not found. HTTP Status Code: 404 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the specified constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2023-08-22 18 API Reference Amazon WorkSpaces Thin Client GetDevice Returns information for a thin client device. Request Syntax GET /devices/id HTTP/1.1 URI Request Parameters The request uses the following URI parameters. id The ID of the device for which to return information. Pattern: [a-zA-Z0-9]{24} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "device": { "arn": "string", "createdAt": number, "currentSoftwareSetId": "string", "currentSoftwareSetVersion": "string", "desiredSoftwareSetId": "string", "environmentId": "string", "id": "string", "kmsKeyArn": "string", "lastConnectedAt": number, GetDevice API Version 2023-08-22 19 Amazon WorkSpaces Thin Client API Reference "lastPostureAt": number, "model": "string", "name": "string", "pendingSoftwareSetId": "string", "pendingSoftwareSetVersion": "string", "serialNumber": "string", "softwareSetComplianceStatus": "string", "softwareSetUpdateSchedule": "string", "softwareSetUpdateStatus": "string", "status": "string", "tags": { "string" : "string" }, "updatedAt": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. device Describes an device. Type: Device object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException The server encountered an internal error and is unable to complete the request. Response Elements API Version 2023-08-22 20 API Reference Amazon WorkSpaces Thin Client HTTP Status Code: 500 ResourceNotFoundException The resource specified in the request was not found. HTTP Status Code: 404 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the specified constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2023-08-22 21 API Reference Amazon WorkSpaces Thin Client GetEnvironment Returns information for an environment. Request Syntax GET /environments/id HTTP/1.1 URI Request Parameters The request uses the following URI parameters. id The ID of the environment for which to return information. Pattern: [a-z0-9]{9} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "environment": { "activationCode": "string", "arn": "string", "createdAt": number, "desiredSoftwareSetId": "string", "desktopArn": "string", "desktopEndpoint": "string", "desktopType": "string", "deviceCreationTags": { GetEnvironment API Version 2023-08-22 22 Amazon WorkSpaces Thin Client API Reference "string" : "string" }, "id": "string", "kmsKeyArn": "string", "maintenanceWindow": { "applyTimeOf": "string", "daysOfTheWeek": [ "string" ], "endTimeHour": number, "endTimeMinute": number, "startTimeHour": number, "startTimeMinute": number, "type": "string" }, "name": "string", "pendingSoftwareSetId": "string", "pendingSoftwareSetVersion": "string", "registeredDevicesCount": number, "softwareSetComplianceStatus": "string", "softwareSetUpdateMode": "string", "softwareSetUpdateSchedule": "string", "tags": { "string" : "string" }, "updatedAt": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned |
workspaces-thin-client-api-006 | workspaces-thin-client-api.pdf | 6 | "environment": { "activationCode": "string", "arn": "string", "createdAt": number, "desiredSoftwareSetId": "string", "desktopArn": "string", "desktopEndpoint": "string", "desktopType": "string", "deviceCreationTags": { GetEnvironment API Version 2023-08-22 22 Amazon WorkSpaces Thin Client API Reference "string" : "string" }, "id": "string", "kmsKeyArn": "string", "maintenanceWindow": { "applyTimeOf": "string", "daysOfTheWeek": [ "string" ], "endTimeHour": number, "endTimeMinute": number, "startTimeHour": number, "startTimeMinute": number, "type": "string" }, "name": "string", "pendingSoftwareSetId": "string", "pendingSoftwareSetVersion": "string", "registeredDevicesCount": number, "softwareSetComplianceStatus": "string", "softwareSetUpdateMode": "string", "softwareSetUpdateSchedule": "string", "tags": { "string" : "string" }, "updatedAt": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. environment Describes an environment. Type: Environment object Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2023-08-22 23 Amazon WorkSpaces Thin Client AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException The server encountered an internal error and is unable to complete the request. API Reference HTTP Status Code: 500 ResourceNotFoundException The resource specified in the request was not found. HTTP Status Code: 404 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the specified constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also API Version 2023-08-22 24 Amazon WorkSpaces Thin Client • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2023-08-22 25 API Reference Amazon WorkSpaces Thin Client GetSoftwareSet Returns information for a software set. Request Syntax GET /softwaresets/id HTTP/1.1 URI Request Parameters The request uses the following URI parameters. id The ID of the software set for which to return information. Pattern: [0-9]{1,9} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "softwareSet": { "arn": "string", "id": "string", "releasedAt": number, "software": [ { "name": "string", "version": "string" } ], "supportedUntil": number, GetSoftwareSet API Version 2023-08-22 26 Amazon WorkSpaces Thin Client API Reference "tags": { "string" : "string" }, "validationStatus": "string", "version": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. softwareSet Describes a software set. Type: SoftwareSet object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException The server encountered an internal error and is unable to complete the request. HTTP Status Code: 500 ResourceNotFoundException The resource specified in the request was not found. HTTP Status Code: 404 ThrottlingException The request was denied due to request throttling. Response Elements API Version 2023-08-22 27 Amazon WorkSpaces Thin Client HTTP Status Code: 429 ValidationException The input fails to satisfy the specified constraints. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2023-08-22 28 Amazon WorkSpaces Thin Client ListDevices Returns a list of thin client devices. Request Syntax API Reference GET /devices?maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. maxResults The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum. Valid Range: Minimum value of 1. Maximum value of 50. nextToken If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: \S* Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 ListDevices API Version 2023-08-22 29 Amazon WorkSpaces Thin Client API Reference Content-type: |
workspaces-thin-client-api-007 | workspaces-thin-client-api.pdf | 7 | value of 50. nextToken If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: \S* Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 ListDevices API Version 2023-08-22 29 Amazon WorkSpaces Thin Client API Reference Content-type: application/json { "devices": [ { "arn": "string", "createdAt": number, "currentSoftwareSetId": "string", "desiredSoftwareSetId": "string", "environmentId": "string", "id": "string", "lastConnectedAt": number, "lastPostureAt": number, "model": "string", "name": "string", "pendingSoftwareSetId": "string", "serialNumber": "string", "softwareSetUpdateSchedule": "string", "status": "string", "updatedAt": number } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. devices Describes devices. Type: Array of DeviceSummary objects nextToken If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. Response Elements API Version 2023-08-22 30 Amazon WorkSpaces Thin Client Type: String API Reference Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: \S* Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException The server encountered an internal error and is unable to complete the request. HTTP Status Code: 500 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the specified constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ Errors API Version 2023-08-22 31 Amazon WorkSpaces Thin Client • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2023-08-22 32 Amazon WorkSpaces Thin Client ListEnvironments Returns a list of environments. Request Syntax API Reference GET /environments?maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. maxResults The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum. Valid Range: Minimum value of 1. Maximum value of 50. nextToken If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: \S* Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 ListEnvironments API Version 2023-08-22 33 Amazon WorkSpaces Thin Client API Reference Content-type: application/json { "environments": [ { "activationCode": "string", "arn": "string", "createdAt": number, "desiredSoftwareSetId": "string", "desktopArn": "string", "desktopEndpoint": "string", "desktopType": "string", "id": "string", "maintenanceWindow": { "applyTimeOf": "string", "daysOfTheWeek": [ "string" ], "endTimeHour": number, "endTimeMinute": number, "startTimeHour": number, "startTimeMinute": number, "type": "string" }, "name": "string", "pendingSoftwareSetId": "string", "softwareSetUpdateMode": "string", "softwareSetUpdateSchedule": "string", "updatedAt": number } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. environments Describes environments. Type: Array of EnvironmentSummary objects Response Elements API Version 2023-08-22 34 Amazon WorkSpaces Thin Client nextToken API Reference If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: \S* Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have sufficient access to perform this action. |
workspaces-thin-client-api-008 | workspaces-thin-client-api.pdf | 8 | API Reference If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: \S* Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException The server encountered an internal error and is unable to complete the request. HTTP Status Code: 500 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the specified constraints. HTTP Status Code: 400 Errors API Version 2023-08-22 35 Amazon WorkSpaces Thin Client See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2023-08-22 36 Amazon WorkSpaces Thin Client ListSoftwareSets Returns a list of software sets. Request Syntax API Reference GET /softwaresets?maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. maxResults The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum. Valid Range: Minimum value of 1. Maximum value of 50. nextToken If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: \S* Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json ListSoftwareSets API Version 2023-08-22 37 Amazon WorkSpaces Thin Client API Reference { "nextToken": "string", "softwareSets": [ { "arn": "string", "id": "string", "releasedAt": number, "supportedUntil": number, "validationStatus": "string", "version": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. nextToken If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: \S* softwareSets Describes software sets. Type: Array of SoftwareSetSummary objects Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2023-08-22 38 Amazon WorkSpaces Thin Client AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException The server encountered an internal error and is unable to complete the request. API Reference HTTP Status Code: 500 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the specified constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2023-08-22 39 Amazon WorkSpaces Thin Client API Reference ListTagsForResource Returns a list of tags for a resource. Request Syntax GET /tags/resourceArn HTTP/1.1 URI Request Parameters The request uses the following URI parameters. resourceArn The Amazon Resource Name (ARN) of the resource for which you want to retrieve tags. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "tags": { "string" : "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The |
workspaces-thin-client-api-009 | workspaces-thin-client-api.pdf | 9 | • AWS SDK for Ruby V3 See Also API Version 2023-08-22 39 Amazon WorkSpaces Thin Client API Reference ListTagsForResource Returns a list of tags for a resource. Request Syntax GET /tags/resourceArn HTTP/1.1 URI Request Parameters The request uses the following URI parameters. resourceArn The Amazon Resource Name (ARN) of the resource for which you want to retrieve tags. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "tags": { "string" : "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ListTagsForResource API Version 2023-08-22 40 Amazon WorkSpaces Thin Client tags API Reference A map of the key-value pairs for the tag or tags assigned to the specified resource. Type: String to string map Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException The server encountered an internal error and is unable to complete the request. HTTP Status Code: 500 ResourceNotFoundException The resource specified in the request was not found. HTTP Status Code: 404 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the specified constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: Errors API Version 2023-08-22 41 API Reference Amazon WorkSpaces Thin Client • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2023-08-22 42 Amazon WorkSpaces Thin Client TagResource Assigns one or more tags (key-value pairs) to the specified resource. API Reference Request Syntax POST /tags/resourceArn HTTP/1.1 Content-type: application/json { "tags": { "string" : "string" } } URI Request Parameters The request uses the following URI parameters. resourceArn The Amazon Resource Name (ARN) of the resource that you want to tag. Required: Yes Request Body The request accepts the following data in JSON format. tags A map of the key-value pairs of the tag or tags to assign to the resource. Type: String to string map Required: Yes Response Syntax HTTP/1.1 200 TagResource API Version 2023-08-22 43 Amazon WorkSpaces Thin Client Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. HTTP Status Code: 409 InternalServerException The server encountered an internal error and is unable to complete the request. HTTP Status Code: 500 ResourceNotFoundException The resource specified in the request was not found. HTTP Status Code: 404 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the specified constraints. HTTP Status Code: 400 Response Elements API Version 2023-08-22 44 Amazon WorkSpaces Thin Client See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2023-08-22 45 API Reference Amazon WorkSpaces Thin Client UntagResource Removes a tag or tags from a resource. Request Syntax DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1 URI Request Parameters The request uses the following URI parameters. resourceArn The Amazon Resource Name (ARN) of the resource that you want to untag. Required: Yes tagKeys The keys of the key-value pairs for the tag or tags you want to remove from the specified resource. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. UntagResource API Version 2023-08-22 46 Amazon WorkSpaces Thin Client AccessDeniedException You do not have sufficient access to perform this action. HTTP |
workspaces-thin-client-api-010 | workspaces-thin-client-api.pdf | 10 | resource that you want to untag. Required: Yes tagKeys The keys of the key-value pairs for the tag or tags you want to remove from the specified resource. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. UntagResource API Version 2023-08-22 46 Amazon WorkSpaces Thin Client AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException API Reference The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. HTTP Status Code: 409 InternalServerException The server encountered an internal error and is unable to complete the request. HTTP Status Code: 500 ResourceNotFoundException The resource specified in the request was not found. HTTP Status Code: 404 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the specified constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ See Also API Version 2023-08-22 47 Amazon WorkSpaces Thin Client • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2023-08-22 48 Amazon WorkSpaces Thin Client UpdateDevice Updates a thin client device. Request Syntax PATCH /devices/id HTTP/1.1 Content-type: application/json { "desiredSoftwareSetId": "string", "name": "string", "softwareSetUpdateSchedule": "string" } URI Request Parameters The request uses the following URI parameters. id The ID of the device to update. Pattern: [a-zA-Z0-9]{24} Required: Yes Request Body The request accepts the following data in JSON format. desiredSoftwareSetId The ID of the software set to apply. Type: String Pattern: [0-9]{1,9} Required: No UpdateDevice API Reference API Version 2023-08-22 49 Amazon WorkSpaces Thin Client name The name of the device to update. Type: String API Reference Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: $|^[0-9\p{IsAlphabetic}+:,.@'" -]* Required: No softwareSetUpdateSchedule An option to define if software updates should be applied within a maintenance window. Type: String Valid Values: USE_MAINTENANCE_WINDOW | APPLY_IMMEDIATELY Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "device": { "arn": "string", "createdAt": number, "currentSoftwareSetId": "string", "desiredSoftwareSetId": "string", "environmentId": "string", "id": "string", "lastConnectedAt": number, "lastPostureAt": number, "model": "string", "name": "string", "pendingSoftwareSetId": "string", "serialNumber": "string", "softwareSetUpdateSchedule": "string", "status": "string", Response Syntax API Version 2023-08-22 50 Amazon WorkSpaces Thin Client "updatedAt": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. API Reference device Describes a device. Type: DeviceSummary object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException The server encountered an internal error and is unable to complete the request. HTTP Status Code: 500 ResourceNotFoundException The resource specified in the request was not found. HTTP Status Code: 404 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429 Response Elements API Version 2023-08-22 51 Amazon WorkSpaces Thin Client ValidationException The input fails to satisfy the specified constraints. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2023-08-22 52 Amazon WorkSpaces Thin Client API Reference UpdateEnvironment Updates an environment. Request Syntax PATCH /environments/id HTTP/1.1 Content-type: application/json { "desiredSoftwareSetId": "string", "desktopArn": "string", "desktopEndpoint": "string", "deviceCreationTags": { "string" : "string" }, "maintenanceWindow": { "applyTimeOf": "string", "daysOfTheWeek": [ "string" ], "endTimeHour": number, "endTimeMinute": number, "startTimeHour": number, "startTimeMinute": number, "type": "string" }, "name": "string", "softwareSetUpdateMode": "string", "softwareSetUpdateSchedule": "string" } URI Request Parameters The request uses the following URI parameters. id The ID of the environment to update. Pattern: [a-z0-9]{9} Required: Yes UpdateEnvironment API Version 2023-08-22 53 API Reference Amazon WorkSpaces Thin Client Request Body The request accepts the following data in JSON format. desiredSoftwareSetId The ID of the software set to apply. Type: String Pattern: [0-9]{0,9} |
workspaces-thin-client-api-011 | workspaces-thin-client-api.pdf | 11 | /environments/id HTTP/1.1 Content-type: application/json { "desiredSoftwareSetId": "string", "desktopArn": "string", "desktopEndpoint": "string", "deviceCreationTags": { "string" : "string" }, "maintenanceWindow": { "applyTimeOf": "string", "daysOfTheWeek": [ "string" ], "endTimeHour": number, "endTimeMinute": number, "startTimeHour": number, "startTimeMinute": number, "type": "string" }, "name": "string", "softwareSetUpdateMode": "string", "softwareSetUpdateSchedule": "string" } URI Request Parameters The request uses the following URI parameters. id The ID of the environment to update. Pattern: [a-z0-9]{9} Required: Yes UpdateEnvironment API Version 2023-08-22 53 API Reference Amazon WorkSpaces Thin Client Request Body The request accepts the following data in JSON format. desiredSoftwareSetId The ID of the software set to apply. Type: String Pattern: [0-9]{0,9} Required: No desktopArn The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or AppStream 2.0. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[0-9]{0,12}:[a-zA- Z0-9\-\/\._]+ Required: No desktopEndpoint The URL for the identity provider login (only for environments that use AppStream 2.0). Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: (https:\/\/)[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,32}(:[0-9] {1,5})?(\/.*)? Required: No deviceCreationTags A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment. Request Body API Version 2023-08-22 54 Amazon WorkSpaces Thin Client Type: String to string map API Reference Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: (?!aws:)[A-Za-z0-9 _=@:.+-/]+ Value Length Constraints: Minimum length of 0. Maximum length of 256. Value Pattern: [A-Za-z0-9 _=@:.+-/]+ Required: No maintenanceWindow A specification for a time window to apply software updates. Type: MaintenanceWindow object Required: No name The name of the environment to update. Type: String Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: $|^[0-9\p{IsAlphabetic}+:,.@'" -][0-9\p{IsAlphabetic}+=:,.@'" -]* Required: No softwareSetUpdateMode An option to define which software updates to apply. Type: String Valid Values: USE_LATEST | USE_DESIRED Required: No softwareSetUpdateSchedule An option to define if software updates should be applied within a maintenance window. Request Body API Version 2023-08-22 55 Amazon WorkSpaces Thin Client Type: String API Reference Valid Values: USE_MAINTENANCE_WINDOW | APPLY_IMMEDIATELY Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "environment": { "activationCode": "string", "arn": "string", "createdAt": number, "desiredSoftwareSetId": "string", "desktopArn": "string", "desktopEndpoint": "string", "desktopType": "string", "id": "string", "maintenanceWindow": { "applyTimeOf": "string", "daysOfTheWeek": [ "string" ], "endTimeHour": number, "endTimeMinute": number, "startTimeHour": number, "startTimeMinute": number, "type": "string" }, "name": "string", "pendingSoftwareSetId": "string", "softwareSetUpdateMode": "string", "softwareSetUpdateSchedule": "string", "updatedAt": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. Response Syntax API Version 2023-08-22 56 Amazon WorkSpaces Thin Client API Reference The following data is returned in JSON format by the service. environment Describes an environment. Type: EnvironmentSummary object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException The server encountered an internal error and is unable to complete the request. HTTP Status Code: 500 ResourceNotFoundException The resource specified in the request was not found. HTTP Status Code: 404 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the specified constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: Errors API Version 2023-08-22 57 API Reference Amazon WorkSpaces Thin Client • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2023-08-22 58 API Reference Amazon WorkSpaces Thin Client UpdateSoftwareSet Updates a software set. Request Syntax PATCH /softwaresets/id HTTP/1.1 Content-type: application/json { "validationStatus": "string" } URI Request Parameters The request uses the following URI parameters. id The ID of the software set to update. Pattern: [0-9]{1,9} Required: Yes Request Body The request accepts the following data in JSON format. validationStatus An option to define if the software set has been validated. Type: String Valid Values: VALIDATED | NOT_VALIDATED Required: Yes UpdateSoftwareSet API Version 2023-08-22 59 Amazon WorkSpaces Thin Client Response Syntax HTTP/1.1 204 Response Elements API Reference If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException The server encountered an internal error and is unable to complete the request. HTTP Status Code: 500 ResourceNotFoundException The resource specified in the request was not |
workspaces-thin-client-api-012 | workspaces-thin-client-api.pdf | 12 | String Valid Values: VALIDATED | NOT_VALIDATED Required: Yes UpdateSoftwareSet API Version 2023-08-22 59 Amazon WorkSpaces Thin Client Response Syntax HTTP/1.1 204 Response Elements API Reference If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException The server encountered an internal error and is unable to complete the request. HTTP Status Code: 500 ResourceNotFoundException The resource specified in the request was not found. HTTP Status Code: 404 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the specified constraints. HTTP Status Code: 400 Response Syntax API Version 2023-08-22 60 Amazon WorkSpaces Thin Client See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2023-08-22 61 Amazon WorkSpaces Thin Client API Reference Data Types The Amazon WorkSpaces Thin Client API contains several data types that various actions use. This section describes each data type in detail. Note The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order. The following data types are supported: • Device • DeviceSummary • Environment • EnvironmentSummary • MaintenanceWindow • Software • SoftwareSet • SoftwareSetSummary • ValidationExceptionField API Version 2023-08-22 62 Amazon WorkSpaces Thin Client Device Describes a thin client device. Contents arn API Reference The Amazon Resource Name (ARN) of the device. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[0-9]{0,12}:[a-zA- Z0-9\-\/\._]+ Required: No createdAt The timestamp of when the device was created. Type: Timestamp Required: No currentSoftwareSetId The ID of the software set currently installed on the device. Type: String Pattern: [0-9]{1,9} Required: No currentSoftwareSetVersion The version of the software set currently installed on the device. Type: String Required: No Device API Version 2023-08-22 63 Amazon WorkSpaces Thin Client desiredSoftwareSetId The ID of the software set which the device has been set to. API Reference Type: String Pattern: [0-9]{1,9} Required: No environmentId The ID of the environment the device is associated with. Type: String Pattern: [a-z0-9]{9} Required: No id The ID of the device. Type: String Pattern: [a-zA-Z0-9]{24} Required: No kmsKeyArn The Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the device. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[0-9]{0,12}:key\/[a-zA- Z0-9-]+ Required: No lastConnectedAt The timestamp of the most recent session on the device. Contents API Version 2023-08-22 64 Amazon WorkSpaces Thin Client Type: Timestamp Required: No lastPostureAt The timestamp of the most recent check-in of the device. API Reference Type: Timestamp Required: No model The model number of the device. Type: String Required: No name The name of the device. Type: String Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: $|^[0-9\p{IsAlphabetic}+:,.@'" -]* Required: No pendingSoftwareSetId The ID of the software set that is pending to be installed on the device. Type: String Pattern: [0-9]{1,9} Required: No pendingSoftwareSetVersion The version of the software set that is pending to be installed on the device. Type: String Contents API Version 2023-08-22 65 Amazon WorkSpaces Thin Client Required: No serialNumber The hardware serial number of the device. Type: String Required: No softwareSetComplianceStatus API Reference Describes if the software currently installed on the device is a supported version. Type: String Valid Values: NONE | COMPLIANT | NOT_COMPLIANT Required: No softwareSetUpdateSchedule An option to define if software updates should be applied within a maintenance window. Type: String Valid Values: USE_MAINTENANCE_WINDOW | APPLY_IMMEDIATELY Required: No softwareSetUpdateStatus Describes if the device has a supported version of software installed. Type: String Valid Values: AVAILABLE | IN_PROGRESS | UP_TO_DATE Required: No status The status of the device. Type: String Valid Values: REGISTERED | DEREGISTERING | DEREGISTERED | ARCHIVED Contents API Version 2023-08-22 66 API Reference Amazon WorkSpaces Thin Client Required: No tags The tag keys and optional values for the resource. Type: String to string map Required: No updatedAt The timestamp of when the device was updated. Type: Timestamp Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2023-08-22 67 Amazon WorkSpaces Thin |
workspaces-thin-client-api-013 | workspaces-thin-client-api.pdf | 13 | device. Type: String Valid Values: REGISTERED | DEREGISTERING | DEREGISTERED | ARCHIVED Contents API Version 2023-08-22 66 API Reference Amazon WorkSpaces Thin Client Required: No tags The tag keys and optional values for the resource. Type: String to string map Required: No updatedAt The timestamp of when the device was updated. Type: Timestamp Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2023-08-22 67 Amazon WorkSpaces Thin Client DeviceSummary Describes a thin client device. Contents arn API Reference The Amazon Resource Name (ARN) of the device. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[0-9]{0,12}:[a-zA- Z0-9\-\/\._]+ Required: No createdAt The timestamp of when the device was created. Type: Timestamp Required: No currentSoftwareSetId The ID of the software set currently installed on the device. Type: String Pattern: [0-9]{1,9} Required: No desiredSoftwareSetId The ID of the software set which the device has been set to. Type: String Pattern: [0-9]{1,9} Required: No DeviceSummary API Version 2023-08-22 68 Amazon WorkSpaces Thin Client environmentId The ID of the environment the device is associated with. API Reference Type: String Pattern: [a-z0-9]{9} Required: No id The ID of the device. Type: String Pattern: [a-zA-Z0-9]{24} Required: No lastConnectedAt The timestamp of the most recent session on the device. Type: Timestamp Required: No lastPostureAt The timestamp of the most recent check-in of the device. Type: Timestamp Required: No model The model number of the device. Type: String Required: No name The name of the device. Contents API Version 2023-08-22 69 Amazon WorkSpaces Thin Client Type: String API Reference Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: $|^[0-9\p{IsAlphabetic}+:,.@'" -]* Required: No pendingSoftwareSetId The ID of the software set that is pending to be installed on the device. Type: String Pattern: [0-9]{1,9} Required: No serialNumber The hardware serial number of the device. Type: String Required: No softwareSetUpdateSchedule An option to define if software updates should be applied within a maintenance window. Type: String Valid Values: USE_MAINTENANCE_WINDOW | APPLY_IMMEDIATELY Required: No status The status of the device. Type: String Valid Values: REGISTERED | DEREGISTERING | DEREGISTERED | ARCHIVED Required: No Contents API Version 2023-08-22 70 Amazon WorkSpaces Thin Client updatedAt The timestamp of when the device was updated. API Reference Type: Timestamp Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2023-08-22 71 Amazon WorkSpaces Thin Client Environment Describes an environment. Contents activationCode API Reference The activation code to register a device to the environment. Type: String Pattern: [a-z]{2}[a-z0-9]{6} Required: No arn The Amazon Resource Name (ARN) of the environment. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[0-9]{0,12}:[a-zA- Z0-9\-\/\._]+ Required: No createdAt The timestamp of when the environment was created. Type: Timestamp Required: No desiredSoftwareSetId The ID of the software set to apply. Type: String Pattern: [0-9]{1,9} Environment API Version 2023-08-22 72 Amazon WorkSpaces Thin Client Required: No desktopArn API Reference The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or AppStream 2.0. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[0-9]{0,12}:[a-zA- Z0-9\-\/\._]+ Required: No desktopEndpoint The URL for the identity provider login (only for environments that use AppStream 2.0). Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: (https:\/\/)[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,32}(:[0-9] {1,5})?(\/.*)? Required: No desktopType The type of streaming desktop for the environment. Type: String Valid Values: workspaces | appstream | workspaces-web Required: No deviceCreationTags The tag keys and optional values for the newly created devices for this environment. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Contents API Version 2023-08-22 73 Amazon WorkSpaces Thin Client API Reference Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: (?!aws:)[A-Za-z0-9 _=@:.+-/]+ Value Length Constraints: Minimum length of 0. Maximum length of 256. Value Pattern: [A-Za-z0-9 _=@:.+-/]+ Required: No id The ID of the environment. Type: String Pattern: [a-z0-9]{9} Required: No kmsKeyArn The Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the environment. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[0-9]{0,12}:key\/[a-zA- Z0-9-]+ Required: No maintenanceWindow A specification for a time window to apply software updates. Type: MaintenanceWindow object Required: No name The name of the environment. Type: String Contents API Version 2023-08-22 74 Amazon WorkSpaces Thin Client API Reference Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: $|^[0-9\p{IsAlphabetic}+:,.@'" -][0-9\p{IsAlphabetic}+=:,.@'" -]* Required: No |
workspaces-thin-client-api-014 | workspaces-thin-client-api.pdf | 14 | Required: No id The ID of the environment. Type: String Pattern: [a-z0-9]{9} Required: No kmsKeyArn The Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the environment. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[0-9]{0,12}:key\/[a-zA- Z0-9-]+ Required: No maintenanceWindow A specification for a time window to apply software updates. Type: MaintenanceWindow object Required: No name The name of the environment. Type: String Contents API Version 2023-08-22 74 Amazon WorkSpaces Thin Client API Reference Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: $|^[0-9\p{IsAlphabetic}+:,.@'" -][0-9\p{IsAlphabetic}+=:,.@'" -]* Required: No pendingSoftwareSetId The ID of the software set that is pending to be installed. Type: String Pattern: [0-9]{1,9} Required: No pendingSoftwareSetVersion The version of the software set that is pending to be installed. Type: String Required: No registeredDevicesCount The number of devices registered to the environment. Type: Integer Required: No softwareSetComplianceStatus Describes if the software currently installed on all devices in the environment is a supported version. Type: String Valid Values: NO_REGISTERED_DEVICES | COMPLIANT | NOT_COMPLIANT Required: No softwareSetUpdateMode An option to define which software updates to apply. Contents API Version 2023-08-22 75 Amazon WorkSpaces Thin Client Type: String Valid Values: USE_LATEST | USE_DESIRED Required: No softwareSetUpdateSchedule API Reference An option to define if software updates should be applied within a maintenance window. Type: String Valid Values: USE_MAINTENANCE_WINDOW | APPLY_IMMEDIATELY Required: No tags The tag keys and optional values for the resource. Type: String to string map Required: No updatedAt The timestamp of when the device was updated. Type: Timestamp Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2023-08-22 76 Amazon WorkSpaces Thin Client API Reference EnvironmentSummary Describes an environment. Contents activationCode The activation code to register a device to the environment. Type: String Pattern: [a-z]{2}[a-z0-9]{6} Required: No arn The Amazon Resource Name (ARN) of the environment. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[0-9]{0,12}:[a-zA- Z0-9\-\/\._]+ Required: No createdAt The timestamp of when the environment was created. Type: Timestamp Required: No desiredSoftwareSetId The ID of the software set to apply. Type: String Pattern: [0-9]{1,9} EnvironmentSummary API Version 2023-08-22 77 Amazon WorkSpaces Thin Client Required: No desktopArn API Reference The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or AppStream 2.0. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[0-9]{0,12}:[a-zA- Z0-9\-\/\._]+ Required: No desktopEndpoint The URL for the identity provider login (only for environments that use AppStream 2.0). Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: (https:\/\/)[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,32}(:[0-9] {1,5})?(\/.*)? Required: No desktopType The type of streaming desktop for the environment. Type: String Valid Values: workspaces | appstream | workspaces-web Required: No id The ID of the environment. Type: String Pattern: [a-z0-9]{9} Contents API Version 2023-08-22 78 Amazon WorkSpaces Thin Client Required: No maintenanceWindow A specification for a time window to apply software updates. API Reference Type: MaintenanceWindow object Required: No name The name of the environment. Type: String Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: $|^[0-9\p{IsAlphabetic}+:,.@'" -][0-9\p{IsAlphabetic}+=:,.@'" -]* Required: No pendingSoftwareSetId The ID of the software set that is pending to be installed. Type: String Pattern: [0-9]{1,9} Required: No softwareSetUpdateMode An option to define which software updates to apply. Type: String Valid Values: USE_LATEST | USE_DESIRED Required: No softwareSetUpdateSchedule An option to define if software updates should be applied within a maintenance window. Type: String Contents API Version 2023-08-22 79 Amazon WorkSpaces Thin Client API Reference Valid Values: USE_MAINTENANCE_WINDOW | APPLY_IMMEDIATELY Required: No updatedAt The timestamp of when the device was updated. Type: Timestamp Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2023-08-22 80 Amazon WorkSpaces Thin Client API Reference MaintenanceWindow Describes the maintenance window for a thin client device. Contents type An option to select the default or custom maintenance window. Type: String Valid Values: SYSTEM | CUSTOM Required: Yes applyTimeOf The option to set the maintenance window during the device local time or Universal Coordinated Time (UTC). Type: String Valid Values: UTC | DEVICE Required: No daysOfTheWeek The days of the week during which the maintenance window is open. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 7 items. Valid Values: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY Required: No endTimeHour The hour for the maintenance window end (00-23). Type: Integer MaintenanceWindow API Version |
workspaces-thin-client-api-015 | workspaces-thin-client-api.pdf | 15 | or custom maintenance window. Type: String Valid Values: SYSTEM | CUSTOM Required: Yes applyTimeOf The option to set the maintenance window during the device local time or Universal Coordinated Time (UTC). Type: String Valid Values: UTC | DEVICE Required: No daysOfTheWeek The days of the week during which the maintenance window is open. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 7 items. Valid Values: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY Required: No endTimeHour The hour for the maintenance window end (00-23). Type: Integer MaintenanceWindow API Version 2023-08-22 81 Amazon WorkSpaces Thin Client API Reference Valid Range: Minimum value of 0. Maximum value of 23. Required: No endTimeMinute The minutes for the maintenance window end (00-59). Type: Integer Valid Range: Minimum value of 0. Maximum value of 59. Required: No startTimeHour The hour for the maintenance window start (00-23). Type: Integer Valid Range: Minimum value of 0. Maximum value of 23. Required: No startTimeMinute The minutes past the hour for the maintenance window start (00-59). Type: Integer Valid Range: Minimum value of 0. Maximum value of 59. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2023-08-22 82 API Reference Amazon WorkSpaces Thin Client Software Describes software. Contents name The name of the software component. Type: String Required: No version The version of the software component. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Software API Version 2023-08-22 83 Amazon WorkSpaces Thin Client SoftwareSet Describes a software set. Contents arn API Reference The Amazon Resource Name (ARN) of the software set. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[0-9]{0,12}:[a-zA- Z0-9\-\/\._]+ Required: No id The ID of the software set. Type: String Pattern: [0-9]{1,9} Required: No releasedAt The timestamp of when the software set was released. Type: Timestamp Required: No software A list of the software components in the software set. Type: Array of Software objects Required: No SoftwareSet API Version 2023-08-22 84 Amazon WorkSpaces Thin Client supportedUntil The timestamp of the end of support for the software set. API Reference Type: Timestamp Required: No tags The tag keys and optional values for the resource. Type: String to string map Required: No validationStatus An option to define if the software set has been validated. Type: String Valid Values: VALIDATED | NOT_VALIDATED Required: No version The version of the software set. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2023-08-22 85 Amazon WorkSpaces Thin Client API Reference SoftwareSetSummary Describes a software set. Contents arn The Amazon Resource Name (ARN) of the software set. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[0-9]{0,12}:[a-zA- Z0-9\-\/\._]+ Required: No id The ID of the software set. Type: String Pattern: [0-9]{1,9} Required: No releasedAt The timestamp of when the software set was released. Type: Timestamp Required: No supportedUntil The timestamp of the end of support for the software set. Type: Timestamp Required: No SoftwareSetSummary API Version 2023-08-22 86 Amazon WorkSpaces Thin Client validationStatus API Reference An option to define if the software set has been validated. Type: String Valid Values: VALIDATED | NOT_VALIDATED Required: No version The version of the software set. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2023-08-22 87 Amazon WorkSpaces Thin Client API Reference ValidationExceptionField Describes a validation exception. Contents message A message that describes the reason for the exception. Type: String Required: Yes name The name of the exception. Type: String Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ValidationExceptionField API Version 2023-08-22 88 Amazon WorkSpaces Thin Client API Reference Common Parameters The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-specific parameters are listed in the topic for that action. For more information about Signature Version 4, see |
workspaces-thin-client-api-016 | workspaces-thin-client-api.pdf | 16 | Required: Yes name The name of the exception. Type: String Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ValidationExceptionField API Version 2023-08-22 88 Amazon WorkSpaces Thin Client API Reference Common Parameters The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-specific parameters are listed in the topic for that action. For more information about Signature Version 4, see Signing AWS API requests in the IAM User Guide. Action The action to be performed. Type: string Required: Yes Version The API version that the request is written for, expressed in the format YYYY-MM-DD. Type: string Required: Yes X-Amz-Algorithm The hash algorithm that you used to create the request signature. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Valid Values: AWS4-HMAC-SHA256 Required: Conditional X-Amz-Credential The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4_request"). The value is expressed in the following format: access_key/YYYYMMDD/region/service/ aws4_request. API Version 2023-08-22 89 Amazon WorkSpaces Thin Client API Reference For more information, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional X-Amz-Date The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: 20120325T120000Z. Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see Elements of an AWS API request signature in the IAM User Guide. Type: string Required: Conditional X-Amz-Security-Token The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS STS, see AWS services that work with IAM in the IAM User Guide. Condition: If you're using temporary security credentials from AWS STS, you must include the security token. Type: string Required: Conditional X-Amz-Signature Specifies the hex-encoded signature that was calculated from the string to sign and the derived signing key. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. API Version 2023-08-22 90 Amazon WorkSpaces Thin Client Type: string Required: Conditional X-Amz-SignedHeaders API Reference Specifies all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional API Version 2023-08-22 91 Amazon WorkSpaces Thin Client API Reference Common Errors This section lists the errors common to the API actions of all AWS services. For errors specific to an API action for this service, see the topic for that API action. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403 ExpiredTokenException The security token included in the request is expired HTTP Status Code: 403 IncompleteSignature The request signature does not conform to AWS standards. HTTP Status Code: 403 InternalFailure The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 MalformedHttpRequestException Problems with the request at the HTTP level, e.g. we can't decompress the body according to the decompression algorithm specified by the content-encoding. HTTP Status Code: 400 NotAuthorized You do not have permission to perform this action. HTTP Status Code: 401 OptInRequired The AWS access key ID needs a subscription for the service. API Version 2023-08-22 92 Amazon WorkSpaces Thin Client HTTP Status Code: 403 RequestAbortedException API Reference Convenient exception that can be used when a request is aborted before a reply is sent back (e.g. client closed connection). HTTP Status Code: 400 RequestEntityTooLargeException Problems with the request at the HTTP level. The request entity is too large. HTTP Status Code: 413 RequestExpired The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes |
workspaces-thin-client-api-017 | workspaces-thin-client-api.pdf | 17 | 92 Amazon WorkSpaces Thin Client HTTP Status Code: 403 RequestAbortedException API Reference Convenient exception that can be used when a request is aborted before a reply is sent back (e.g. client closed connection). HTTP Status Code: 400 RequestEntityTooLargeException Problems with the request at the HTTP level. The request entity is too large. HTTP Status Code: 413 RequestExpired The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future. HTTP Status Code: 400 RequestTimeoutException Problems with the request at the HTTP level. Reading the Request timed out. HTTP Status Code: 408 ServiceUnavailable The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 UnrecognizedClientException The X.509 certificate or AWS access key ID provided does not exist in our records. HTTP Status Code: 403 API Version 2023-08-22 93 Amazon WorkSpaces Thin Client UnknownOperationException API Reference The action or operation requested is invalid. Verify that the action is typed correctly. HTTP Status Code: 404 ValidationError The input fails to satisfy the constraints specified by an AWS service. HTTP Status Code: 400 API Version 2023-08-22 94 |
workspaces-thin-client-user-guide-001 | workspaces-thin-client-user-guide.pdf | 1 | User Guide Amazon WorkSpaces Thin Client Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon WorkSpaces Thin Client User Guide Amazon WorkSpaces Thin Client: User Guide Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. Amazon WorkSpaces Thin Client Table of Contents User Guide What is Amazon WorkSpaces Thin Client? .................................................................................... 1 Are you a first-time WorkSpaces Thin Client user? ............................................................................... 1 Accessing Amazon End User Computing (EUC) services through WorkSpaces Thin Client ............ 1 Getting to know your WorkSpaces Thin Client ............................................................................. 2 Here is everything that you need for your WorkSpaces Thin Client device ...................................... 2 Meet your WorkSpaces Thin Client device .............................................................................................. 4 Front of the WorkSpaces Thin Client device ..................................................................................... 5 Back of the WorkSpaces Thin Client device ...................................................................................... 5 USB hub .................................................................................................................................................... 6 Connect your WorkSpaces Thin Client device ........................................................................................ 6 Connect optional WorkSpaces Thin Client devices ................................................................................ 9 Your WorkSpaces Thin Client device is ready ...................................................................................... 10 Setting up your Amazon WorkSpaces Thin Client service .......................................................... 12 Select your language ................................................................................................................................. 12 Identify keyboard type .............................................................................................................................. 13 Keyboard layouts .................................................................................................................................. 16 Connect to your network ......................................................................................................................... 19 Enter activation code ................................................................................................................................ 20 Sign in to your AWS End User Computing service .............................................................................. 22 Using the device ............................................................................................................................ 23 Using the toolbar ....................................................................................................................................... 23 Accessing your toolbar ......................................................................................................................... 23 Positioning your toolbar ...................................................................................................................... 25 Toolbar functions .................................................................................................................................. 26 Using shortcuts on Windows keyboards ............................................................................................... 28 Using the virtual service provider interface ......................................................................................... 29 Enabling the microphone and webcam ................................................................................................. 29 Enabling permissions for microphone and webcam in the VDI .................................................. 30 Enabling permissions in the web browser ....................................................................................... 35 Changing the Sound settings on the WorkSpaces Thin Client ......................................................... 37 Setting the volume level from your virtual desktop ..................................................................... 37 Changing the default volume of the WorkSpaces Thin Client .................................................... 38 Using Mute on WorkSpaces Thin Client ........................................................................................... 42 Managing the display resolution ............................................................................................................ 42 iii Amazon WorkSpaces Thin Client User Guide Connecting a 2K or 4K monitor ........................................................................................................ 43 Changing the display resolution ........................................................................................................ 45 Resetting the display resolution ........................................................................................................ 47 Performing a screen capture ................................................................................................................... 47 Using the PrintScreen button ............................................................................................................ 47 Rebooting the WorkSpaces Thin Client device .................................................................................... 48 Rebooting by using the toolbar ........................................................................................................ 48 Rebooting manually ............................................................................................................................. 48 Setting the Sleep mode ............................................................................................................................ 48 Managing networks ................................................................................................................................... 49 Viewing network details ...................................................................................................................... 50 Disconnecting a network ..................................................................................................................... 51 Forgetting a network ........................................................................................................................... 51 Showing available networks ............................................................................................................... 52 Adding a new network ........................................................................................................................ 53 Deferring software updates ..................................................................................................................... 54 System and network alerts ...................................................................................................................... 57 Enabling system alerts ........................................................................................................................ 58 Enabling network alerts ...................................................................................................................... 58 Providing feedback .................................................................................................................................... 59 Using accessibility ......................................................................................................................... 60 Using VoiceView ......................................................................................................................................... 60 Setting up WorkSpaces Thin Client VoiceView ............................................................................... 60 Enabling VoiceView on WorkSpaces Thin Client ............................................................................ 60 Controlling VoiceView .......................................................................................................................... 61 Enabling Windows Narrator ............................................................................................................... 63 Using Screen Magnifier ............................................................................................................................. 63 Enabling the Screen Magnifier ........................................................................................................... 63 Controlling the Screen Magnifier ...................................................................................................... 64 Enabling Windows Magnifier .............................................................................................................. 64 Device specifications ..................................................................................................................... 66 WorkSpaces Thin Client device specifications ...................................................................................... 66 USB hub specifications .............................................................................................................................. 67 Supported peripherals .............................................................................................................................. 67 Troubleshooting ............................................................................................................................. 71 Troubleshooting your WorkSpaces Thin Client device ....................................................................... 71 iv Amazon WorkSpaces Thin Client User Guide Peripherals are not recognized .......................................................................................................... 71 Unable to access WorkSpaces Thin Client workspace ................................................................... 71 Volume on headset is very low or not audible .............................................................................. 72 Audio crackles or has disturbances during audio-video conference calls .................................. 72 Known issues for the WorkSpaces Thin Client ..................................................................................... 73 If you select any link on the VDI login screen, you must return to the login screen. .............. 73 Using keyboard shortcuts may cause unexpected behavior. ....................................................... 28 Some peripherals may not be recognized when the device is running. ..................................... 71 You cannot view the IP address of the Ethernet network from settings. .................................. 73 Some menu options in the VDI toolbar are displayed but not working. ................................... 74 You cannot find a supported keyboard layout in the OOBE or settings. ................................... 74 You can select a supported keyboard layout in device settings, but you cannot enter the specific keys within the virtual session. ........................................................................................... 74 Toolbar does not expand or collapse when you select it for the first time. .............................. 75 On waking up from sleep, WorkSpaces Thin Client device shows the keyboard and mouse setup screen for a few seconds before launching the session. ................................................... 75 On the restart of a WorkSpaces Thin |
workspaces-thin-client-user-guide-002 | workspaces-thin-client-user-guide.pdf | 2 | Some menu options in the VDI toolbar are displayed but not working. ................................... 74 You cannot find a supported keyboard layout in the OOBE or settings. ................................... 74 You can select a supported keyboard layout in device settings, but you cannot enter the specific keys within the virtual session. ........................................................................................... 74 Toolbar does not expand or collapse when you select it for the first time. .............................. 75 On waking up from sleep, WorkSpaces Thin Client device shows the keyboard and mouse setup screen for a few seconds before launching the session. ................................................... 75 On the restart of a WorkSpaces Thin Client device, end users will see repeated Getting Ready and Checking for updates transition screens before launching the session. ............... 75 Updates for the WorkSpaces Thin Client device are not taking effect. ..................................... 75 The webcam is not enabled in WorkSpaces and its icon in the top toolbar remains gray. ..... 75 4K monitor not at full resolution ...................................................................................................... 76 WorkSpaces Thin Client Packet Loss notification. ......................................................................... 76 Keyboard power operation is not correct in device settings ........................................................ 76 Headset volume change not reflected in device settings ............................................................. 76 Screen shows multiple updating screen fragments after reset ................................................... 76 Network icon opening Accessibility settings ................................................................................... 77 Server error code 1001 during setup ............................................................................................... 77 FIDO2 pre-session details ................................................................................................................... 77 Disconnected from your AppStream 2.0 session ........................................................................... 78 Troubleshooting the virtual desktop interface .................................................................................... 78 Document history .......................................................................................................................... 79 v Amazon WorkSpaces Thin Client User Guide What is Amazon WorkSpaces Thin Client? WorkSpaces Thin Client is a cost-effective thin client device that is built to work with AWS End User Computing (EUC) virtual desktops to provide you with a complete cloud desktop solution. WorkSpaces Thin Client is a compact device designed to connect two monitors and multiple USB devices, such as a keyboard, mouse, headset, and webcam. To maximize endpoint security, WorkSpaces Thin Client devices do not allow local data storage or installation of unapproved applications. The WorkSpaces Thin Client device ships to you preloaded with device management software. Topics • Are you a first-time WorkSpaces Thin Client user? • Accessing Amazon End User Computing (EUC) services through WorkSpaces Thin Client Are you a first-time WorkSpaces Thin Client user? If you are a first-time user of WorkSpaces Thin Client, we recommend that you begin by reading the following sections: • Getting to know your WorkSpaces Thin Client • Setting up your Amazon WorkSpaces Thin Client service • Device specifications Accessing Amazon End User Computing (EUC) services through WorkSpaces Thin Client You can access your choice of Amazon WorkSpaces, Amazon WorkSpaces Secure Browser, or AppStream 2.0 through the WorkSpaces Thin Client, and you can keep applications and data in the cloud for increased security and centralized administration. Are you a first-time WorkSpaces Thin Client user? 1 Amazon WorkSpaces Thin Client User Guide Getting to know your WorkSpaces Thin Client device WorkSpaces Thin Client gives you instant and secure access to your relevant applications and data through AWS End User Computing virtual desktops. To get started using your WorkSpaces Thin Client device, set it up with a keyboard, mouse, and monitor, and connect it to your network. Let's get started! Topics • Here is everything that you need for your WorkSpaces Thin Client device • Meet your WorkSpaces Thin Client device • Connect your WorkSpaces Thin Client device • Connect optional WorkSpaces Thin Client devices • Your WorkSpaces Thin Client device is ready Here is everything that you need for your WorkSpaces Thin Client device To use WorkSpaces Thin Client, you will need the following: You should have received this equipment. If you are missing anything on this list, contact your administrator. Equipment provided • WorkSpaces Thin Client device equipped with one USB-A port, one HDMI-Out port, and one Ethernet port Here is everything that you need for your WorkSpaces Thin Client device 2 Amazon WorkSpaces Thin Client User Guide Here is everything that you need for your WorkSpaces Thin Client device 3 Amazon WorkSpaces Thin Client User Guide Required equipment (may not be provided) • USB hub that supports USB-A input - connects into the device • Keyboard - connects into the USB hub • Mouse - connects into the USB hub • Monitor - connects into the HDMI-Out port on the WorkSpaces Thin Client device Optional equipment (not provided) • Second Monitor - connects into the HDMI-Out port on the USB hub • Webcam - connects into the USB hub • Headset - that connects into the USB hub Meet your WorkSpaces Thin Client device Hello! This is your WorkSpaces Thin Client device and its USB hub. Meet your WorkSpaces Thin Client device 4 Amazon WorkSpaces Thin Client User Guide Front of the WorkSpaces Thin Client device Back of the WorkSpaces Thin Client device Front of the WorkSpaces Thin Client device |
workspaces-thin-client-user-guide-003 | workspaces-thin-client-user-guide.pdf | 3 | • Monitor - connects into the HDMI-Out port on the WorkSpaces Thin Client device Optional equipment (not provided) • Second Monitor - connects into the HDMI-Out port on the USB hub • Webcam - connects into the USB hub • Headset - that connects into the USB hub Meet your WorkSpaces Thin Client device Hello! This is your WorkSpaces Thin Client device and its USB hub. Meet your WorkSpaces Thin Client device 4 Amazon WorkSpaces Thin Client User Guide Front of the WorkSpaces Thin Client device Back of the WorkSpaces Thin Client device Front of the WorkSpaces Thin Client device 5 Amazon WorkSpaces Thin Client User Guide Later, you will use these ports to connect your other peripherals. USB hub Later, you will use these ports to connect your other peripherals. Connect your WorkSpaces Thin Client device To use your WorkSpaces Thin Client device, you must have a keyboard, mouse, and monitor. USB hub 6 Amazon WorkSpaces Thin Client User Guide Number Device Instruction 1 2 Connect your mouse to a USB-A port on your hub. Connect your keyboard to a USB-A port on your hub. Connect your WorkSpaces Thin Client device 7 Amazon WorkSpaces Thin Client User Guide Number Device Instruction 3 4 5 6 Connect your hub power adapter to the power port on your hub. Connect the HDMI port on your monitor to the HDMI- Out port on your WorkSpace s Thin Client with an HDMI cable (not included). Connect your hub’s USB-A plug to the USB port on your WorkSpaces Thin Client. Connect your WorkSpaces Thin Client power adapter to the power port on your WorkSpaces Thin Client. Connect your WorkSpaces Thin Client device 8 Amazon WorkSpaces Thin Client User Guide Number 7 Device Instruction (Optional) Connect an Ethernet cable. Note A network connectio n is required. If you prefer a wired Ethernet connectio n instead of Wi-Fi, connect the Ethernet cable (not included) to the network port. Connect optional WorkSpaces Thin Client devices You can also connect your WorkSpaces Thin Client device to a headset, camera, or second monitor. Note Do not connect or disconnect any of the accessories while the WorkSpaces Thin Client device is on. The WorkSpaces Thin Client device will not recognize the accessory. If you disconnect an accessory while the WorkSpaces Thin Client device is on, turn off the device, reconnect the accessory, and then turn the device back on. Connect optional WorkSpaces Thin Client devices 9 Amazon WorkSpaces Thin Client User Guide Number Device Instruction 1 2 3 Connect your headset to a USB-A port your hub. Connect your webcam to a USB-A port your hub. Connect a second monitor to the HDMI port at the end of the USB hub. Connect the HDMI port on your second monitor to the HDMI port at the end of your hub with an HDMI cable (not included). Your WorkSpaces Thin Client device is ready After you connect all of your peripherals, your WorkSpaces Thin Client is ready to be turned on. 1. Plug in your hub power adapter to a power outlet. 2. Plug in your WorkSpaces Thin Client power adapter to a power outlet. Your WorkSpaces Thin Client device is ready 10 Amazon WorkSpaces Thin Client User Guide Note Have your password ready if you use Wi-Fi to connect to your network. You are now ready to set up your WorkSpaces Thin Client service. Go to Setting up your Amazon WorkSpaces Thin Client service. Note If you set up two monitors, the primary monitor must be placed on the left side and the secondary monitor on the right side. Your WorkSpaces Thin Client device is ready 11 Amazon WorkSpaces Thin Client User Guide Setting up your Amazon WorkSpaces Thin Client service Your WorkSpaces Thin Client device is ready. You can now turn it on for the first time. Because this is the first time you're turning on your WorkSpaces Thin Client device, you can follow a basic process to connect your new device to the service. Your WorkSpaces Thin Client device guides you through this process. Topics • Select your language • Identify keyboard type • Connect to your network • Enter activation code • Sign in to your AWS End User Computing service Select your language Select the language that you want your WorkSpaces Thin Client device to use. Select your language 12 Amazon WorkSpaces Thin Client User Guide You can use your mouse to select a language. Identify keyboard type Next, you tell the WorkSpaces Thin Client device to identify your keyboard. Begin by pressing and holding the key to the immediate RIGHT of the Shift key on the LEFT side of the keyboard. Identify keyboard type 13 Amazon WorkSpaces Thin Client User Guide Next, press and hold the key to the immediate LEFT of the Shift key on |
workspaces-thin-client-user-guide-004 | workspaces-thin-client-user-guide.pdf | 4 | User Computing service Select your language Select the language that you want your WorkSpaces Thin Client device to use. Select your language 12 Amazon WorkSpaces Thin Client User Guide You can use your mouse to select a language. Identify keyboard type Next, you tell the WorkSpaces Thin Client device to identify your keyboard. Begin by pressing and holding the key to the immediate RIGHT of the Shift key on the LEFT side of the keyboard. Identify keyboard type 13 Amazon WorkSpaces Thin Client User Guide Next, press and hold the key to the immediate LEFT of the Shift key on the RIGHT side of the keyboard. Identify keyboard type 14 Amazon WorkSpaces Thin Client User Guide Great! The keyboard is now identified. You now tell the WorkSpaces Thin Client device what type of keyboard you are using. Select your keyboard layout. To verify your keyboard layout, see examples of each compatible keyboard in Keyboard layouts. Identify keyboard type 15 Amazon WorkSpaces Thin Client User Guide Keyboard layouts WorkSpaces Thin Client supports the following keyboard layouts: English (United States), English (United Kingdom), French, German, Spanish, and Italian. WorkSpaces Thin Client supports AltGr and dead key keyboard layouts in English (United Kingdom), French, German, Spanish, and Italian. English (United States) keyboard layout Keyboard layouts 16 Amazon WorkSpaces Thin Client User Guide English (United Kingdom) keyboard layout French keyboard layout German keyboard layout Keyboard layouts 17 Amazon WorkSpaces Thin Client User Guide Spanish keyboard layout Italian keyboard layout Keyboard layouts 18 Amazon WorkSpaces Thin Client User Guide Connect to your network You can now connect your WorkSpaces Thin Client device to your network. If you are using an Ethernet connection, then the WorkSpaces Thin Client device automatically connects to your network. No further action is required. If your WorkSpaces Thin Client device is not connected through Ethernet, then your device will scan for available wireless networks and display them in the Network dropdown list. Select your network from this dropdown list. Note Only one network connection type can be active. If you are using an Ethernet connection, then the wireless network connection cannot be used. Enter your network password in the Password field. Connect to your network 19 Amazon WorkSpaces Thin Client User Guide Enter activation code Your WorkSpaces Thin Client device is now connected to your network. Now, you can connect your device to the AWS End User Computing service that your administrator set up for you. Enter activation code 20 Amazon WorkSpaces Thin Client User Guide Enter the activation code provided by your administrator. Enter activation code 21 Amazon WorkSpaces Thin Client User Guide Note The activation code is generated when your administrator creates a dedicated environment for your device. For more information, see Creating an environment in the WorkSpaces Thin Client administrator guide. Sign in to your AWS End User Computing service Sign in to the AWS End User Computing service established for you by your administrator. Note The image shows WorkSpaces (web access). The service could be WorkSpaces (web access), AppStream 2.0, or WorkSpaces Secure Browser. Sign in to your AWS End User Computing service 22 Amazon WorkSpaces Thin Client User Guide Using your WorkSpaces Thin Client device After you have set up and registered your WorkSpaces Thin Client device, you are ready to use it. Amazon WorkSpaces Thin Client is built to work with AWS End User Computing (EUC) virtual desktops and is compatible with a number of peripherals. Topics • Using the toolbar • Using shortcuts on Windows keyboards • Using the virtual service provider interface • Enabling the microphone and webcam • Changing the Sound settings on the WorkSpaces Thin Client • Managing the display resolution • Performing a screen capture • Rebooting the WorkSpaces Thin Client device • Setting the Sleep mode • Managing networks • Deferring software updates • System and network alerts • How we use your data Using the toolbar You can access all of WorkSpaces Thin Client device functions through a toolbar on your display. From this toolbar, you are able to control the basic settings of your WorkSpaces Thin Client device. The toolbar, in its collapsed form, is located on the right side of your display represented as a dark bar. Accessing your toolbar To access the toolbar functions, you need to expand it. Once expanded, the available functions will appear. The toolbar collapses once you are finished using it. Using the toolbar 23 Amazon WorkSpaces Thin Client User Guide 1. Select the dark bar on the right of your display. 2. 3. Select the function you want to use. For a list of functions, see Toolbar functions. Select any area on the primary display to collapse the toolbar. Accessing your toolbar 24 Amazon WorkSpaces Thin Client User Guide 4. If you want to use your keyboard, press CTRL+ALT+SHIFT+T to |
workspaces-thin-client-user-guide-005 | workspaces-thin-client-user-guide.pdf | 5 | bar. Accessing your toolbar To access the toolbar functions, you need to expand it. Once expanded, the available functions will appear. The toolbar collapses once you are finished using it. Using the toolbar 23 Amazon WorkSpaces Thin Client User Guide 1. Select the dark bar on the right of your display. 2. 3. Select the function you want to use. For a list of functions, see Toolbar functions. Select any area on the primary display to collapse the toolbar. Accessing your toolbar 24 Amazon WorkSpaces Thin Client User Guide 4. If you want to use your keyboard, press CTRL+ALT+SHIFT+T to expand or collapse the toolbar. Positioning your toolbar The toolbar is located on the side of your WorkSpaces Thin Client display. It is located along the right edge of the screen on your primary monitor by default. You can change the position of your toolbar. Changing your toolbar position 1. Go to Settings then About. 2. Go to the Toolbar position on the screen section. 3. Click on the switch to select either Right or Left. The toolbar will show up along the edge of the screen on your primary monitor on the side your have selected. Positioning your toolbar 25 Amazon WorkSpaces Thin Client User Guide Toolbar functions When the toolbar is expanded, a list of functions is available for you to use. These are the basic settings of your WorkSpaces Thin Client device. Button Function Description Sign in/Disconnect Selecting Sign In takes you to your virtual desktop session sign in page. You need to enter your virtual desktop session username and password to start a session. If you are using WorkSpace s, this function changes to Disconnect. Selecting Disconnect will sign you Toolbar functions 26 Amazon WorkSpaces Thin Client User Guide Button Function Description out of your virtual desktop session. If you are using AppStream 2.0 or WorkSpaces Secure Browser, this function is removed from the toolbar. Use the Disconnect function within the virtual desktop to sign out of your session Accesses the settings for your device. These settings include: • About • Languages • Network • Notifications • Peripheral devices • Power and sleep • Time zone Accesses the network settings of your device. For more information, see Managing networks. Puts the device into Sleep mode. For more information, see Setting the Sleep mode. Settings Network Sleep Toolbar functions 27 Amazon WorkSpaces Thin Client User Guide Button Function Lock Restart Shutdown Notifications Description Ends the current session and takes you to the lock page. Once locked, you can select Unlock to access your Sign In page. Restarts the device. For more information, see Rebooting by using the toolbar. Logs you out of the session and shuts down the device. Accesses the Notifications for your device. Using shortcuts on Windows keyboards WorkSpaces Thin Client has the capability to use keyboard shortcuts for some of its functions. The following table shows the enabled shortcuts and their associated functions. Note This features is available for Windows sessions only. Keyboard shortcut Device function Windows logo key + Shift + S Create part of the screen screenshot. Windows logo key + Ctrl + Enter Turn Windows Narrator on and off. Windows logo key + Plus(+) Zoom in using the Magnifier. Windows logo key + Left arrow Snap app or window left. Using shortcuts on Windows keyboards 28 Amazon WorkSpaces Thin Client User Guide Keyboard shortcut Device function Windows logo key + Right arrow Snap app or window right. Windows logo key + Up arrow Maximize app windows. Windows logo key + Down Minimize app windows. Windows logo key + D Display and hide the desktop. Using the virtual service provider interface WorkSpaces Thin Client is powered by the Amazon DCV web client, which runs inside a web browser, so no installation is required. For more information about Amazon DCV, see Using Amazon DCV. Amazon WorkSpaces Thin Client works with a number of virtual desktops to provide you with a complete cloud desktop solution. Each VDI has its own interface or toolbar that you will use. For more information on each of these interfaces, please see the following: • For Amazon WorkSpaces see WorkSpaces Web Access • For AppStream 2.0 see Web Browser Access • For Amazon WorkSpaces Secure Browser see Use the toolbar Enabling the microphone and webcam Your WorkSpaces Thin Client device can connect to your audio and visual devices. To use your microphone and webcam within a virtual desktop session, you will need to enable permissions in your Windows Settings, on the virtual desktop toolbar, and your browser settings. WorkSpaces Thin Client is compatible with the webcams and headsets listed in the Peripherals section. Confirm your webcam and microphone are properly connected to your WorkSpaces Thin Client. 1. Go to Settings. Using the virtual service provider interface 29 Amazon WorkSpaces |
workspaces-thin-client-user-guide-006 | workspaces-thin-client-user-guide.pdf | 6 | Access • For Amazon WorkSpaces Secure Browser see Use the toolbar Enabling the microphone and webcam Your WorkSpaces Thin Client device can connect to your audio and visual devices. To use your microphone and webcam within a virtual desktop session, you will need to enable permissions in your Windows Settings, on the virtual desktop toolbar, and your browser settings. WorkSpaces Thin Client is compatible with the webcams and headsets listed in the Peripherals section. Confirm your webcam and microphone are properly connected to your WorkSpaces Thin Client. 1. Go to Settings. Using the virtual service provider interface 29 Amazon WorkSpaces Thin Client 2. Select Peripheral Devices. 3. Verify that your webcam and microphone are listed. User Guide 4. Verify that your microphone and webcam are enabled on your VDI. Depending on what VDI you are using, do one of the following: • For Windows, use Enabling permissions in Windows. • For Amazon WorkSpaces, use Enabling permissions in Amazon WorkSpaces. • For AppStream 2.0 or Amazon WorkSpaces Secure Browser, use Enabling permissions in AppStream 2.0 and Amazon WorkSpaces Secure Browser. Enabling permissions for microphone and webcam in the VDI Enabling permissions in Windows 1. 2. Select the Settings icon. Select the Privacy icon from the Settings menu. Enabling permissions for microphone and webcam in the VDI 30 Amazon WorkSpaces Thin Client User Guide 3. Do one of the following: • Select Camera from the list on the left, and change Allow apps to access your camera to On. Enabling permissions for microphone and webcam in the VDI 31 Amazon WorkSpaces Thin Client User Guide • Select Microphone from the list on the left, and change Allow apps to access your camera to On. Enabling permissions for microphone and webcam in the VDI 32 Amazon WorkSpaces Thin Client User Guide After you have enabled permissions in Windows, you will need to enable them from your web browser. See Enabling permissions in the web browser. Enabling permissions in Amazon WorkSpaces Permissions for webcam and microphone are automatically enabled for use with WorkSpaces Thin Client. The virtual desktop toolbar will display the status of you microphone and webcam. WorkSpaces Thin Client is compatible with the webcams and headsets listed in the Peripherals section. Confirm your webcam and microphone are properly connected to your WorkSpaces Thin Client. Enabling permissions for microphone and webcam in the VDI 33 Amazon WorkSpaces Thin Client User Guide The icons for Microphone and Webcam will indicate their status. Icon Status Camera is not on. Camera is on but not streaming. Camera is on and streaming. Microphone is not on. Enabling permissions for microphone and webcam in the VDI 34 Amazon WorkSpaces Thin Client User Guide Icon Status Microphone is on. After you have confirmed that your peripheral is enabled in Amazon WorkSpaces, you will need to enable them from your web browser. See Enabling permissions in the web browser Enabling permissions in AppStream 2.0 and Amazon WorkSpaces Secure Browser Your WorkSpaces Thin Client device can connect to your audio and visual devices. To use your microphone and webcam within a virtual desktop session, you will need to enable permissions in your Windows Settings, on the virtual desktop toolbar, and your browser settings. Confirm your webcam and microphone are properly connected to your WorkSpaces Thin Client. 1. Go to Settings. 2. Select Peripheral Devices. 3. Verify that your webcam and microphone are listed. After you have confirmed that your peripheral is enabled in either AppStream 2.0 or Amazon WorkSpaces Secure Browser, you will need to enable them from your web browser. See Enabling permissions in the web browser. Enabling permissions in the web browser 1. A pop-up window will appear asking for Microphone and Webcam permissions. If you do not see the pop-up, you can select the icon next to the address bar. Enabling permissions in the web browser 35 Amazon WorkSpaces Thin Client User Guide 2. 3. Select Allow in the pop up window. Select the Settings icon on the browser search bar and make sure Microphone and Webcam are enabled. Enabling permissions in the web browser 36 Amazon WorkSpaces Thin Client User Guide Note You may need to repeat the above step every time you want to use your webcam and microphone in a website. Changing the Sound settings on the WorkSpaces Thin Client WorkSpaces Thin Client has a couple of sound settings that you can configure including volume and microphone muting. Setting the volume level from your virtual desktop After you set up your peripheral, you can control your volume settings through the VDI toolbar or on the device. For more information, see Changing the Sound settings on the WorkSpaces Thin Client. For more information on your VDI toolbar, refer to the following: • For Amazon WorkSpaces Secure Borwser see WorkSpaces Secure Browser Access Changing the Sound settings |
workspaces-thin-client-user-guide-007 | workspaces-thin-client-user-guide.pdf | 7 | webcam and microphone in a website. Changing the Sound settings on the WorkSpaces Thin Client WorkSpaces Thin Client has a couple of sound settings that you can configure including volume and microphone muting. Setting the volume level from your virtual desktop After you set up your peripheral, you can control your volume settings through the VDI toolbar or on the device. For more information, see Changing the Sound settings on the WorkSpaces Thin Client. For more information on your VDI toolbar, refer to the following: • For Amazon WorkSpaces Secure Borwser see WorkSpaces Secure Browser Access Changing the Sound settings on the WorkSpaces Thin Client 37 Amazon WorkSpaces Thin Client User Guide • For AppStream 2.0 see Web Browser Access • For Amazon WorkSpaces Web see Use the toolbar After you set the volume it stays at that level, even if you restart your Amazon WorkSpaces Thin Client. Changing the default volume of the WorkSpaces Thin Client Your WorkSpaces Thin Client device has two default volume settings depending on the peripheral. • Default volume for the WorkSpaces Thin Client device is 73. • Default volume for a connected headset is 40. You can change these defaults. Changing the default volume (Output) of the device speaker 1. Disconnect any headset from the device. 2. Change the volume by doing one of the following: • Go to Settings, Peripheral Devices, Sound, and change the Output-Speaker by using the + and − icons. Changing the default volume of the WorkSpaces Thin Client 38 Amazon WorkSpaces Thin Client User Guide Note Your built-in speaker volume stays the same even if you restart the device or change the volume of the headset. • Press the + and − volume buttons on the top of the device to raise or lower the volume. Changing the default volume of the WorkSpaces Thin Client 39 Amazon WorkSpaces Thin Client User Guide Changing the default volume (Output) of the headset 1. Connect a headset to the device. 2. Change the volume by doing the following: • Go to Settings, Peripheral Devices, Sound, and change the Output-Speaker by using the + and − icons. Changing the default volume of the WorkSpaces Thin Client 40 Amazon WorkSpaces Thin Client User Guide • Press the + and − volume buttons on the top of the device to raise or lower the volume. • If your headset has volume buttons attached to it, you can use them. Changing the default volume of the WorkSpaces Thin Client 41 Amazon WorkSpaces Thin Client User Guide Using Mute on WorkSpaces Thin Client You can use the Mute function by doing one of the following: • If you want to mute all connected and built-in microphones on your WorkSpaces Thin Client, use the Mute button on the top of the device. The icon on the button will glow red when Mute is activated. • If you want to mute just the device microphone, connect a headset with microphone to the device. The device microphone is automatically muted. Managing the display resolution WorkSpaces Thin Client supports a maximum of two displays - the primary monitor and the extended monitor. If you have a second monitor connected, your display automatically extends to the second monitor on the launch of a desktop session and the online remote desktop toolbar shows a Multiscreen button. You can use this button to switch from using a single screen to using two screens. For more information, see the Web browser client section of Extending full-screen across all monitors in the Amazon DCV User Guide. Using Mute on WorkSpaces Thin Client 42 Amazon WorkSpaces Thin Client User Guide Your device determines the best resolution to use with each of your displays when you start your device. The maximum supported resolution depends on the number of displays you have connected, as shown in the following table. Displays Maximum Resolution 1 (Primary monitor only) • Regular 1080p monitor – 1920x1080 (aspect ratio of 16:9) • 2K monitor – 2560x1440 (aspect ratio of 16:9) • 2K ultra-wide (UWD) monitor – 3440x1440 (aspect ratio of 21:9) • 4K monitor – 3840x2160 (aspect ratio of 16:9) 1920x1080 2 (Extended monitor) Note While primary 4K monitors and 4K ultra-wide monitors are capable of the maximum resolution listed, some virtual desktop interfaces will have a lower resolution. See 4K monitor not at full resolution. Connecting a 2K or 4K monitor 2K and 4K resolution is only available through the primary monitor HDMI port located on your WorkSpaces Thin Client device. Connecting a 2K or 4K monitor 43 Amazon WorkSpaces Thin Client User Guide WorkSpaces Thin Client automatically recognizes ultra-high definition (2K or 4k) monitors when they are connected to the primary monitor HDMI port. For a list of supported 2K and 4K monitors, see Supported peripherals. Note You cannot use an extended |
workspaces-thin-client-user-guide-008 | workspaces-thin-client-user-guide.pdf | 8 | capable of the maximum resolution listed, some virtual desktop interfaces will have a lower resolution. See 4K monitor not at full resolution. Connecting a 2K or 4K monitor 2K and 4K resolution is only available through the primary monitor HDMI port located on your WorkSpaces Thin Client device. Connecting a 2K or 4K monitor 43 Amazon WorkSpaces Thin Client User Guide WorkSpaces Thin Client automatically recognizes ultra-high definition (2K or 4k) monitors when they are connected to the primary monitor HDMI port. For a list of supported 2K and 4K monitors, see Supported peripherals. Note You cannot use an extended monitor if you configure your primary monitor for 2K, 2K ultra wide, or 4K resolution. Using 4K resolution on WorkSpaces Thin Client 1. Connect a 2K or 4k monitor to the HDMI OUT port located on the WorkSpaces Thin Client device. 2. Turn on the device. The device should recognize the high density display and set the resolution automatically. Connecting a 2K or 4K monitor 44 Amazon WorkSpaces Thin Client User Guide Changing the display resolution You can change the resolution of your WorkSpaces Thin Client device display. If needed, you can lower your resolution setting on your 4K monitor. If you lower your 2K or 4K display to a standard resolution, WorkSpaces Thin Client will remember this preference and start up in 1080p mode for that display. If this setting is not changed, 4K displays will continue to use 4K resolution automatically. This preference can be removed by resetting the resolution. For more information, see Resetting the display resolution. Note The WorkSpaces Thin Client device must be shut down before connecting a new display or switching between displays. Once the new display is connected, power up the device and set your resolution. Changing the display resolution 1. 2. Select Settings from the toolbar on the primary monitor. Select Peripheral Devices. 3. Go to Display Resolution. 4. Select Primary Monitor to open the drop down menu. Changing the display resolution 45 Amazon WorkSpaces Thin Client User Guide 5. Select one of the following: • 3840x2160 – 4K resolution when using a single monitor that supports ultra-high definition. • 1920x1080 – Standard resolution when using any two monitors. 6. Select Scaling and select the desired setting from the drop down list. 7. Restart your device by selecting Yes in the pop-up window. Changing the display resolution 46 Amazon WorkSpaces Thin Client User Guide Resetting the display resolution You can choose to reset the display preferences of your WorkSpaces Thin Client device. This deletes any preferences set for all connected displays. The device resets the setting back to the highest supported resolution for that display. Resetting the display resolution 1. 2. Select Settings from the toolbar on the primary monitor. Select Peripheral Devices. 3. Go to Display Resolution. 4. 5. Select Clear display resolution preferences. Select Restart in the pop up window. Performing a screen capture The WorkSpaces Thin Client is able to perform a screen capture or save an image of the contents of your display. Using the PrintScreen button If you are using Windows 10 or Windows 11, you can use the PRINT SCREEN button located in the upper right of your keyboard. Depending on your keyboard, the button may be labeled PrintScreen or PrtScn. You can do a screen capture on a selected active window in your display or the entire display. To use the Print Screen key, you need to enable the Print Screen keyboard shortcut in your Windows settings. Resetting the display resolution 47 Amazon WorkSpaces Thin Client User Guide Capturing an image on the display 1. Press PRINT SCREEN. 2. Press CRTL+V to paste the image into another application. Rebooting the WorkSpaces Thin Client device When you must reboot or restart your WorkSpaces Thin Client, you can do this in two ways. Rebooting by using the toolbar 1. Select the circular arrow icon or select Restart device in the toolbar. 2. Select Yes in the Restart Device window. Rebooting manually 1. Unplug the power cable on the back of your WorkSpaces Thin Client. 2. Wait ten seconds and plug the power cable back into your WorkSpaces Thin Client. Setting the Sleep mode Amazon WorkSpaces Thin Client has a Sleep mode that turns off its display if it remains inactive for a specified period of time. This reduces energy consumption when idle. The default period of time for Sleep mode is 15 minutes of inactivity. Any movement of the mouse or pressing of any key on the keyboard will reset the Sleep mode. You can change the Sleep mode setting by doing the following: Rebooting the WorkSpaces Thin Client device 48 Amazon WorkSpaces Thin Client 1. Go to Settings. User Guide 2. 3. Select Power and Sleep. Select a value from the drop-down menu. You can change |
workspaces-thin-client-user-guide-009 | workspaces-thin-client-user-guide.pdf | 9 | has a Sleep mode that turns off its display if it remains inactive for a specified period of time. This reduces energy consumption when idle. The default period of time for Sleep mode is 15 minutes of inactivity. Any movement of the mouse or pressing of any key on the keyboard will reset the Sleep mode. You can change the Sleep mode setting by doing the following: Rebooting the WorkSpaces Thin Client device 48 Amazon WorkSpaces Thin Client 1. Go to Settings. User Guide 2. 3. Select Power and Sleep. Select a value from the drop-down menu. You can change it to one of the following: • 5 minutes • 15 minutes • 30 minutes • 45 minutes • 1 hour • 2 hours • Never Managing networks Your WorkSpaces Thin Client device needs to be connected to a Wi-Fi network in order to access your virtual desktop. You can manage your Wi-Fi networks from your WorkSpaces Thin Client Managing networks 49 Amazon WorkSpaces Thin Client User Guide device. Once you connect to a network, your device will automatically sign in to that network when you turn it on. Notifications about your network are available should you want them. For more information on network notifications, see the section called “Enabling network alerts”. Topics • Viewing network details • Disconnecting a network • Forgetting a network • Showing available networks • Adding a new network Viewing network details Each network will have addresses associated with it. 1. Go to Settings, Network, Known Networks. 2. Select the horizontal ellipsis icon (...). A list with the address information will appear as shown in the image below. Viewing network details 50 Amazon WorkSpaces Thin Client User Guide Disconnecting a network You can disconnect from a network that is currently in use. 1. Go to Settings, Network, Known Networks. 2. Select Disconnect from the network you are using. Your WorkSpaces Thin Client device will then sign on to the next available network listed. To reconnect, double-click the network form the Known Networks list. Forgetting a network Your WorkSpaces Thin Client will automatically sign on to your set Wi-Fi network. If you're currently using or you have joined a network that you no longer use, your device can forget this network. Your device can only forget known Wi-Fi networks. If your device has never joined a Wi-Fi network, you don't have the option to forget that network. Your device can not forget Ethernet connected networks. Disconnecting a network 51 Amazon WorkSpaces Thin Client User Guide 1. Go to Settings, Network, Known Networks. 2. Select Forget from the desired network. The network is removed from the Known Networks list. If you want to join this network again, please use Show Available Networks or Add New Network to connect to the network again. Showing available networks Your WorkSpaces Thin Client device scans the area for any Wi-Fi networks in the area. You can sign on to any available networks once the device lists them. Showing available networks 52 Amazon WorkSpaces Thin Client User Guide 1. Go to Settings, Network, Show Available Networks. Once you select it, the WorkSpaces Thin Client device will scan the area for available networks. 2. After the scan is done, select a network from the list of available networks. 3. 4. Enter the password for the network in the Password field. Select Connect. Your device will connect to the selected network and add it to the Known Networks list. Adding a new network If you have a specific Wi-Fi network that you would like to use, you can connect it to your WorkSpaces Thin Client device. Adding a new network 53 Amazon WorkSpaces Thin Client User Guide 1. Go to Settings, Network, Add New Network. 2. 3. 4. 5. Enter the name of your network in the Network Name field. Select the security protocol from the list in Security. Enter the password for your network in the Password field. Select Join. Your device will connect to the selected network and add it to the Known Networks list. Deferring software updates Your WorkSpaces Thin Client device requires periodic updates. These updates are managed by your IT administrator. When an update is ready, the administrator will release it to your device. If you need to, you can defer, or postpone, these updates. When you receive the update, your screen will show a pop-up notification, like the image below. You have three options. • Install now Deferring software updates 54 Amazon WorkSpaces Thin Client User Guide If you choose Install now, your device will install the update immediately. This disconnects you from your current session and you will need to log in again after the update. We recommend that you restart your device after an update. • Install in one hour If you choose Install in one |
workspaces-thin-client-user-guide-010 | workspaces-thin-client-user-guide.pdf | 10 | release it to your device. If you need to, you can defer, or postpone, these updates. When you receive the update, your screen will show a pop-up notification, like the image below. You have three options. • Install now Deferring software updates 54 Amazon WorkSpaces Thin Client User Guide If you choose Install now, your device will install the update immediately. This disconnects you from your current session and you will need to log in again after the update. We recommend that you restart your device after an update. • Install in one hour If you choose Install in one hour, the update will be deferred for one hour. After that, you will receive the pop-up notification again. If you restart your device before then, the updates will install at that time. You will not see the pop-up notification again. • Install during your maintenance window If you choose Install during next maintenance window, the update will be deferred until the next scheduled maintenance window. Maintenance window times are managed by your administrator. For more information, please contact your IT administrator. For example, your IT administrator sets up a maintenance window time of 10:00 pm on Sunday night of each week. You defer your update to install during the maintenance window. So, on 10:00 pm that next Sunday night, your device will receive the pop-up notification again. Or, if your administrator sets up maintenance windows on Monday, Wednesday, and Friday of each week. You defer the update on Monday. On Wednesday, your device will receive the pop-up notification again. In either case, if you do not defer again, the update will install after five minutes. If you restart your device before then, the updates will install at that time. You will not see the pop-up notification again. Note If you do not make any selection within five minutes, your device will automatically begin to install the update. Deferring software updates 55 Amazon WorkSpaces Thin Client User Guide If you selected Install in one hour or Install during next maintenance window, a notification related to the update will appear in the Notifications section of Settings. For an example of this, refer to the image below. The notification will tell you the name of the updated software, the version number, and when you will receive the pop-up notification again. If you want to install the update immediately, select Install now. Deferring software updates 56 Amazon WorkSpaces Thin Client User Guide You can continue deferring updates. After a certain point, however, your device will be considered behind schedule. If this happens, the updates will install automatically. System and network alerts WorkSpaces Thin Client uses alerts to inform you of system and network issues that may affect your device. Some of these notifications contain a button to restart the device when it is updated or modified. These notifications are, by default, disabled. If desired, they can be enabled. Note This feature should only be enabled for troubleshooting issues. It is not intended for daily use. System and network alerts 57 Amazon WorkSpaces Thin Client Enabling system alerts User Guide As part of the operating system of your WorkSpaces Thin Client device, you will receive notifications regarding your system. These notifications alert you if you experience any change to you device or connected peripheral. Some of them include: • Monitor added • Monitor removed If needed, you can turn on these notifications. By default, notifications are set to Off. Turning network notifications on and off 1. Open the toolbar on the side of your display. 2. 3. Select Settings, About, SYSTEMS ALERT. Select the switch to On to enable the notifications. Enabling network alerts As part of the operating system of your WorkSpaces Thin Client device, you will receive notifications regarding your network. These notifications alert you if you experience any degraded network conditions. Some of them include: Enabling system alerts 58 Amazon WorkSpaces Thin Client User Guide • Ethernet or WiFi Network disruptions • Wifi signal strength • Packet loss or data lost in transmission If needed, you can turn on these notifications. By default, notifications are set to Off. Turning network notifications on and off 1. Open the toolbar on the side of your display. 2. 3. Select Settings, About, NETWORK CONDITIONS ALERT. Select the switch to On to enable the notifications. How we use your data To help us improve our products and services, we may ask you to provide feedback about your experience using WorkSpaces Thin Client. Providing feedback is not required but is appreciated. We use this feedback solely for internal purposes only. Along with your feedback, we may collect your device serial number. This information is handled in accordance with the AWS Privacy Notice. Providing feedback 59 Amazon WorkSpaces Thin Client User Guide Using WorkSpaces Thin Client accessibility features |
workspaces-thin-client-user-guide-011 | workspaces-thin-client-user-guide.pdf | 11 | your display. 2. 3. Select Settings, About, NETWORK CONDITIONS ALERT. Select the switch to On to enable the notifications. How we use your data To help us improve our products and services, we may ask you to provide feedback about your experience using WorkSpaces Thin Client. Providing feedback is not required but is appreciated. We use this feedback solely for internal purposes only. Along with your feedback, we may collect your device serial number. This information is handled in accordance with the AWS Privacy Notice. Providing feedback 59 Amazon WorkSpaces Thin Client User Guide Using WorkSpaces Thin Client accessibility features Amazon WorkSpaces Thin Client provides accessibility features designed to help you use your device. With VoiceView, you can navigate your WorkSpaces Thin Client using text-to-speech functionality, while Screen Magnifier allows for custom zoom levels to enlarge on-screen content. These features seamlessly integrate with the WorkSpaces Thin Client. Topics • Using VoiceView • Using Screen Magnifier Using VoiceView VoiceView is a built-in screen reader that speaks on-screen text out loud as you go through menu options and settings. You can use it to set up your device and navigate the controls. VoiceView is available in English, French, German, Spanish, and Italian, and supports these keyboard layouts. Setting up WorkSpaces Thin Client VoiceView To set up VoiceView on your WorkSpaces Thin Client, use the following procedure: 1. Connect your WorkSpaces Thin Client device. See Connect your WorkSpaces Thin Client device. 2. Hold Ctrl+Alt+Shift+V for 2 seconds. 3. Hold for about 5 seconds until you hear "VoiceView ready." VoiceView is now ready for you to use. Enabling VoiceView on WorkSpaces Thin Client To enable VoiceView to be used on WorkSpaces Thin Client use the following method: Enabling VoiceView 1. Go to Settings on your WorkSpaces Thin Client. Using VoiceView 60 Amazon WorkSpaces Thin Client User Guide 2. 3. 4. Select Accessibility. Select VoiceView. Select VoiceView again to turn it on. Your WorkSpaces Thin Client device says "VoiceView ready" when the feature is enabled. When you turn the feature off, it will say "VoiceView exiting". Controlling VoiceView VoiceView controls and navigation You can use your keyboard to control VoiceView. The following tables guide you through some of the functions you can perform and how to navigate using VoiceView. VoiceView Controls Keys Action Hold Ctrl+Alt+Shift+V Turn VoiceView on or off Press F2 Stop speech Hold F2 and press Left or Right arrow key Cycle through Speech Rate or Speech Volume settings Hold F2 and press Up or Down arrow key Increase/decrease speech volume or speed VoiceView Navigation Keys Tab Shift+tab Enter Up Action Move forward Move backward Confirm selection Move up within a group Controlling VoiceView 61 Amazon WorkSpaces Thin Client User Guide Keys Down Left Right Action Move down within a group Move left within a group Move right within a group VoiceView settings To view and manage VoiceView preferences: 1. Go to Settings on your WorkSpaces Thin Client. 2. 3. Select Accessibility. Select VoiceView. From here you can manage the parameters of VoiceView. The following table shows the parameters you can set. Parameter VoiceView Reading Speed Speech Volume Sounds Volume Key Echo Action Turn VoiceView on or off. Adjust the rate of speech speed for the VoiceView voice. Set a volume level for the VoiceView voice. Speech Volume defaults to 40% of device volume. Set the volume level for the feedback sounds that VoiceView uses. Sounds Volume defaults to 40% of device volume. Determine how text characters are echoed back to you while you enter them with the on- screen keyboard. By default, characters are echoed as they are typed to confirm entry. You Controlling VoiceView 62 Amazon WorkSpaces Thin Client User Guide Parameter Action can change this setting to None, Characters, Words, or both Characters and Words. Control which punctuation marks VoiceView reads aloud. Punctuation Level Enabling Windows Narrator If you are using a Windows virtual desktop session, please use Windows Narrator or your screenreader of choice to read content within your virtual desktop session. • Press and hold the Windows logo#key+CTRL+Enter to turn Narrator on or off. Using Screen Magnifier Screen Magnifier enlarges the display on the screen up to 10 times. This feature is compatible with keyboard only. Enabling the Screen Magnifier You can enable the Screen Magnifier using one these methods: Using the keyboard shortcut (Sessions other than Windows) • Press and hold CTRL+ALT+SHIFT+M. Using Accessibility settings 1. Go to Settings. 2. 3. Select Accessibility. Select Screen Magnifier toggle ON. Once Screen Magnifier is turned on, a tutorial will appear with tips and details on keyboard combinations to use this feature. Enabling Windows Narrator 63 Amazon WorkSpaces Thin Client User Guide Controlling the Screen Magnifier You use your keyboard to navigate with the magnifier. The following table shows the keys used to control navigation. Keys Action Hold Ctrl+Alt+SHIFT+M Enables |
workspaces-thin-client-user-guide-012 | workspaces-thin-client-user-guide.pdf | 12 | Screen Magnifier You can enable the Screen Magnifier using one these methods: Using the keyboard shortcut (Sessions other than Windows) • Press and hold CTRL+ALT+SHIFT+M. Using Accessibility settings 1. Go to Settings. 2. 3. Select Accessibility. Select Screen Magnifier toggle ON. Once Screen Magnifier is turned on, a tutorial will appear with tips and details on keyboard combinations to use this feature. Enabling Windows Narrator 63 Amazon WorkSpaces Thin Client User Guide Controlling the Screen Magnifier You use your keyboard to navigate with the magnifier. The following table shows the keys used to control navigation. Keys Action Hold Ctrl+Alt+SHIFT+M Enables and disables Screen Magnifier Hold Ctrl+Alt+SHIFT+? Press F7 + F2 Hold F7 + F4/F5 Hold F7 + Up/Down/Left/Right to Pan Up/ Down/Left/Right Tab Shift+Tab Enables and disables Screen Magnifier (French keyboard layout only) Enables and disables zoom Zooms In and Out Moves around the image Move Forward Move Backward Ctrl+Alt+Shift+T Expands or Collapses the toolbar As you navigate with Screen Magnifier, each newly selected element will appear on the center of the screen. Note When using the French keyboard layout, press and hold CTRL+ALT+SHIFT + ? to enable and disable the Screen Magnifier. Enabling Windows Magnifier If you are using a Windows virtual desktop session, please use Windows Magnifier to make part or all of your display larger. Controlling the Screen Magnifier 64 Amazon WorkSpaces Thin Client User Guide • Press and hold the Windows logo#key+the Plus#key (+) to turn Magnifier on or off. Enabling Windows Magnifier 65 Amazon WorkSpaces Thin Client User Guide WorkSpaces Thin Client specifications Topics • WorkSpaces Thin Client device specifications • USB hub specifications • Supported peripherals WorkSpaces Thin Client device specifications Size Weight 3.38” x 3.38” x 2.99” (86 mm x 86 mm x 77 mm) 513 g (1.13 lbs) Processor Octa-core 4x 2.2 GHz 4x 2.0GHz GPU Storage Memory Wi-Fi 800 MHz 16 GB internal 2 GB internal Wi-Fi 6E Tri-band. Also supports 802.11a/b/g/n/ac/ax Wi-Fi networks. For Wi-Fi 6E support, WorkSpaces Thin Client must be connected to the 6 GHz band of a Wi-Fi 6E network by using WPA3 encryption. Ethernet Supported Ports HDMI 2.1 Output, Power, USB-A 2.0, Ethernet port 10/100 Mbps Note The HDMI 2.1 Input port and IR Extender port are not supported. Output display resolution 1080p WorkSpaces Thin Client device specifications 66 Amazon WorkSpaces Thin Client User Guide Data connection requirements High-speed internet connection through Wi-Fi or built-in Ethernet port and a power outlet. High-speed HDMI cable rated at 18 Gbps or higher. Wi-Fi 6E router required for Wi-Fi 6E support. USB hub specifications Display Port 1 x HDMI port (support up to 4K @ 30 Hz, mirror or extended display) USB Port 4 x USB 3.0 ports Power 1 x DC jack (support 5 V @ 3 A, O.D. 3.5 mm x I.D. 1.35 mm barrel connector) Support OS Android Supported peripherals You can use WorkSpaces Thin Client with different peripherals. Refer to the following to see if a specific peripheral is compatible with your WorkSpaces Thin Client. Note These devices have been verified to work with Amazon WorkSpaces Thin Client. Other peripherals can be used, but they may not be supported. Keyboard The layouts for all keyboards supported by WorkSpaces Thin Client are listed in Keyboard Layouts. • Amazon Basics Low-Profile Wired USB Keyboard with US Layout • Cherry DW 9100 SLIM Keyboard and Mouse Combo, US Layout • Hyundai HY-MA75 wired USB interface mouse and keyboard set, US Layout • Dell Keyboard-KB212, US Layout • Dell Keyboard-KB216, US Layout USB hub specifications 67 Amazon WorkSpaces Thin Client User Guide • Logitech MK120 Wired Keyboard and Mouse Combo, US Layout • Logitech K120 Wired Keyboard, US Layout • Logitech K120 Keyboard, French Layout • Logitech K120 Keyboard, Spanish Layout • Logitech K120 Keyboard, UK Layout • Logitech K280e Pro Wired Business Keyboard, QWERTZ German Layout • Logitech K580 Wireless Keyboard, US Layout • Logitech MK320 Wireless Keyboard and Mouse Combo, US Layout • Logitech MK330 Wireless Keyboard and Mouse Combo, QWERTY Italian Layout • Logitech MK270 Wireless Keyboard and Mouse Combo, US Layout • Logitech MK270 Wireless Keyboard and Mouse Combo for Windows, QWERTZ German Layout • Logitech Signature K650 Wireless Keyboard, US Layout • HP Black KU-1156, US Layout • HP CS10 Wireless Keyboard Mouse Combo, US Layout • HP Wired Desktop 320MK Mouse and Keyboard Note Multimedia keys are not supported. Mouse • Logitech B120 Wired Mouse • Logitech B100 Wired Mouse • Logitech M90 Wired Mouse • HP 200 Wireless Optical Mouse Monitor • Acer LCD Monitor KA2 series/KA272 • Lenovo ThinkVision 27 inch Monitor - P27h-20 Supported peripherals 68 Amazon WorkSpaces Thin Client User Guide • Lenovo ThinkVision 31.5 inch Monitor - P32p-20 • Samsung ViewFinity S6 S34A654UBN - S65UA Series - LED monitor - curved - 34" - HDR • ViewSonic VA2447-MH |
workspaces-thin-client-user-guide-013 | workspaces-thin-client-user-guide.pdf | 13 | KU-1156, US Layout • HP CS10 Wireless Keyboard Mouse Combo, US Layout • HP Wired Desktop 320MK Mouse and Keyboard Note Multimedia keys are not supported. Mouse • Logitech B120 Wired Mouse • Logitech B100 Wired Mouse • Logitech M90 Wired Mouse • HP 200 Wireless Optical Mouse Monitor • Acer LCD Monitor KA2 series/KA272 • Lenovo ThinkVision 27 inch Monitor - P27h-20 Supported peripherals 68 Amazon WorkSpaces Thin Client User Guide • Lenovo ThinkVision 31.5 inch Monitor - P32p-20 • Samsung ViewFinity S6 S34A654UBN - S65UA Series - LED monitor - curved - 34" - HDR • ViewSonic VA2447-MH 24" 1080p Monitor • ViewSonic VG3456A Webcam • Logitech C270 HD Webcam • Logitech C505E HD 720p Webcam • AUSDOM Autofocus 1080P Webcam with Privacy Cover • eMeet C950 1080P Webcam • Cisco Desk Camera CD-DSKCAM-C-US Headset • Jabra Evolve 20 UC Wired Headset • Jabra Evolve 30 Wired Headset • Logitech H390 Wired Headset • Poly EncorePro 520 Headset - Requires Adapter • Poly DA80 Adapter (Volume Control) • Poly DA85 Adapter (Volume Control) • Poly EncorePro 525 Headset • Sennheiser EPOS Impact 60 Wired Headset • Cisco Headset 322 HS-W-322-C-USB • Cisco Headset 532 CP-HS-W-532-USBA • Cisco Wireless Headset 562 with Standard Base CP-HS-WL-562-M-US Note For all headsets, only the volume buttons are supported. Any additional media buttons are not supported. Supported peripherals 69 User Guide Amazon WorkSpaces Thin Client USB hub • Zhenyou EVT hub (USB-A) - ZYHB03 Supports keyboard, mouse, webcam, headset, and dual screen extension. • Anker 4-Port USB 3.0 Hub Supports keyboard, mouse, and either a webcam or headset. • Sabrent 4-Port USB Hub Supports keyboard and mouse only. Supported peripherals 70 Amazon WorkSpaces Thin Client User Guide Troubleshooting Topics • Troubleshooting your WorkSpaces Thin Client device • Known issues for the WorkSpaces Thin Client • Troubleshooting the virtual desktop interface Troubleshooting your WorkSpaces Thin Client device If you are having issues with your WorkSpaces Thin Client device, check the following procedures for help. Peripherals are not recognized If your WorkSpaces Thin Client device is not recognizing the peripherals that you are using, first, verify that they are compatible with WorkSpaces Thin Client. See Supported devices for a list of compatible peripheral devices. If your peripheral device is compatible with WorkSpaces Thin Client and is still not recognized by the device, do the following: 1. Turn off the WorkSpaces Thin Client device. 2. Disconnect the peripheral device. 3. Reconnect the peripheral device. 4. Check that the USB hub is connected to a power supply with the included hub power adapter. 5. Check that the USB hub is plugged into the WorkSpaces Thin Client device. 6. 7. Turn on your WorkSpaces Thin Client device. Select the Settings gear icon on the toolbar, navigate to Peripheral devices, and verify the peripheral names. Unable to access WorkSpaces Thin Client workspace If your WorkSpaces Thin Client device cannot access your virtual WorkSpace, do the following: Troubleshooting your WorkSpaces Thin Client device 71 Amazon WorkSpaces Thin Client User Guide 1. Go to the network settings on your device. 2. Check that the device is connected to your Wi-Fi network. 3. Refer to the network troubleshooting section of your virtual service interface: • For WorkSpaces, go to Troubleshoot WorkSpaces issues • For WorkSpaces Secure Browser, go to Troubleshooting • For AppStream 2.0, go to Troubleshooting Volume on headset is very low or not audible If you are experiencing volume issues with your headset, do the following: 1. 2. Select the toolbar located on the right side of the screen. Go to Settings → Peripheral devices. Scroll down to the Audio section and adjust the output volume. Note After a system restart, WorkSpaces Thin Client resets the volume level for connected USB headsets. Audio crackles or has disturbances during audio-video conference calls If you're experiencing audio issues with your WorkSpaces Thin Client, try one of the following procedures: Check your WorkSpaces Thin Client device 1. Check that the audio USB headset is connected to the USB hub and that the USB hub is turned ON. 2. Check for supported peripheral devices to ensure that your device is supported. If you are on the login screen of a VDI session 1. 2. Select Settings at the top right of the screen. Locate the device ID. Volume on headset is very low or not audible 72 Amazon WorkSpaces Thin Client User Guide 3. Run a diagnostic check and ensure that the device and advanced logging are both enabled. If you are currently in a VDI session 1. Go to the toolbar on the right side of the screen. 2. Select Settings → Peripheral Devices → Audio. 3. Check that your USB headset is listed and that the volume is set to your desired level. 4. Check that the device is connected to Wi-Fi |
workspaces-thin-client-user-guide-014 | workspaces-thin-client-user-guide.pdf | 14 | Select Settings at the top right of the screen. Locate the device ID. Volume on headset is very low or not audible 72 Amazon WorkSpaces Thin Client User Guide 3. Run a diagnostic check and ensure that the device and advanced logging are both enabled. If you are currently in a VDI session 1. Go to the toolbar on the right side of the screen. 2. Select Settings → Peripheral Devices → Audio. 3. Check that your USB headset is listed and that the volume is set to your desired level. 4. Check that the device is connected to Wi-Fi or Ethernet and that there is no issue with the connection to WorkSpaces. If you are not currently in a VDI session 1. On the WorkSpaces login page, select Settings at the top right of the screen. 2. Locate the device ID. 3. Check that diagnostics and advanced logging are enabled. Known issues for the WorkSpaces Thin Client The WorkSpaces Thin Client has the following known issues. If you select any link on the VDI login screen, you must return to the login screen. Workaround: Select the Lock/Unlock button. This returns you to the VDI login, and a second monitor will mirror the primary monitor. Using keyboard shortcuts may cause unexpected behavior. Workaround: There is no workaround for this issue. Some peripherals may not be recognized when the device is running. Workaround: Unplug the device and then plug it back in or reboot the device. You cannot view the IP address of the Ethernet network from settings. Workaround: There is no workaround for this issue. Known issues for the WorkSpaces Thin Client 73 Amazon WorkSpaces Thin Client User Guide Some menu options in the VDI toolbar are displayed but not working. Workaround: These features are not enabled in this release. You cannot find a supported keyboard layout in the OOBE or settings. Workaround: Check that you are using software set 2.2.0 or higher. Check for the most current software set in WorkSpaces Thin Client software releases. You can also use an Ethernet connection if you cannot enter your Wi-Fi password without keyboard layout support. You can select a supported keyboard layout in device settings, but you cannot enter the specific keys within the virtual session. Workaround: Check that the input method within the session is set to the corresponding language. For example, if you want to use an Italian layout keyboard, set the input method to Italian within the session. See the following figure. Some menu options in the VDI toolbar are displayed but not working. 74 Amazon WorkSpaces Thin Client User Guide Toolbar does not expand or collapse when you select it for the first time. Workaround: Make sure the mouse pointer is on the primary monitor and try expanding or collapsing the toolbar again. To expand the toolbar, select the dark area over the collapsed toolbar. To collapse the toolbar, select any area on the primary monitor. On waking up from sleep, WorkSpaces Thin Client device shows the keyboard and mouse setup screen for a few seconds before launching the session. Workaround: The keyboard and mouse setup screen should automatically go away. If the screen remains after a few seconds, unplug the device and then plug it back in or reboot the device. On the restart of a WorkSpaces Thin Client device, end users will see repeated Getting Ready and Checking for updates transition screens before launching the session. Workaround: None Updates for the WorkSpaces Thin Client device are not taking effect. Workaround: Restart the device after every system update. The webcam is not enabled in WorkSpaces and its icon in the top toolbar remains gray. Workaround: 1. Confirm your webcam is properly connected to your WorkSpaces Thin Client device. 2. Wait 30 seconds after your WorkSpaces session starts. 3. Check to see if your webcam is automatically enabled. 4. If it is still not enabled, restart your WorkSpaces Thin Client device and check again. Toolbar does not expand or collapse when you select it for the first time. 75 Amazon WorkSpaces Thin Client User Guide 4K monitor not at full resolution WorkSpaces Thin Client supports up to 3840x2160 (4K) resolution on the primary monitor. With the scaling factor, you can stream 4K in WorkSpaces. However, WorkSpaces Secure Browser might not support 4k yet. Workaround: None. WorkSpaces Thin Client Packet Loss notification. Workaround: The system may show no Packet Loss even if packet loss is occurring, please ignore the no packet loss message. Keyboard power operation is not correct in device settings If a keyboard is turned on/off using its native power switch, the status may not reflect accurately in the device settings. Workaround: None. Headset volume change not reflected in device settings For headsets with its own amplifier, pressing the volume button on the headset may not |
workspaces-thin-client-user-guide-015 | workspaces-thin-client-user-guide.pdf | 15 | factor, you can stream 4K in WorkSpaces. However, WorkSpaces Secure Browser might not support 4k yet. Workaround: None. WorkSpaces Thin Client Packet Loss notification. Workaround: The system may show no Packet Loss even if packet loss is occurring, please ignore the no packet loss message. Keyboard power operation is not correct in device settings If a keyboard is turned on/off using its native power switch, the status may not reflect accurately in the device settings. Workaround: None. Headset volume change not reflected in device settings For headsets with its own amplifier, pressing the volume button on the headset may not change the volume level shown in device settings. Workaround: None. Screen shows multiple updating screen fragments after reset On monitors with 2560 x 1440 resolution and after you reset the WorkSpaces Thin Client device, the monitors display the AWS updating screen tiled across them. Workaround: None. The device reset works as expected and the screen will return to normal. 4K monitor not at full resolution 76 Amazon WorkSpaces Thin Client User Guide Network icon opening Accessibility settings Selecting the Network Icon on activation code screen may direct users to accessibility settings instead of network settings. Workaround: Enter your activation code to complete setup. The issue will resolve after the device updates to the latest software version. Server error code 1001 during setup Device encounters server error (code 1001) at the end of setup. Workaround: The device needs to be reset and set up again. 1. 2. 3. 4. Select the network icon to open Settings. Select About. Select Reset device. Set up your device. See Setting up your Amazon WorkSpaces Thin Client service. FIDO2 pre-session details The FIDO2 feature is in a prerelease state and has some limitations to its use. Limitations: • Only Yubico YubiKey 5 series USB security keys are supported with FIDO2/WebAuthn supported. • Yubico YubiKey bio-metric keys are not supported. • Registration flow requiring new PIN creation (i.e. userVerification set to required) is not supported. However if a PIN was previously set on the USB security key then it is supported. • Cross-origin WebAuthn credential creation is not supported. • Related Origin Requests are not supported. • Origin must use https scheme. Origin with ports are not supported (e.g: https// example.com:8443). Network icon opening Accessibility settings 77 Amazon WorkSpaces Thin Client User Guide • Only one USB security key can be connected at a time to the Amazon WorkSpaces Thin Client. Multiple USB security keys connected simultaneously is not supported. Disconnected from your AppStream 2.0 session When Disconnect on the toolbar is selected, you'll see a sign out page. This could be the regular AppStream 2.0 sign out page or a custom page your administrator set up. After signing out, the Sign In button is missing from both the toolbar and the sign out page. Workaround: Do one of the following: • Restart the WorkSpaces Thin Client device. • Unlock the AppStream 2.0 session by doing the following: 1. 2. 3. Select the Lock button on the AppStream 2.0 toolbar. The Lock page appears. Select Unlock. The sign on page appears. Sign in to start the session again. Troubleshooting the virtual desktop interface For information on resolving issues with your virtual desktop interface, refer to your VDI provider's documentation. • For WorkSpaces, go to Troubleshoot WorkSpaces issues. • For WorkSpaces Secure Browser, go to Troubleshooting. • For AppStream 2.0, go to Troubleshooting. Disconnected from your AppStream 2.0 session 78 Amazon WorkSpaces Thin Client User Guide Document history for the WorkSpaces Thin Client User Guide The following table describes the documentation releases for the WorkSpaces Thin Client User Guide. Change Description Date • Enabling network alerts • Added a new section about October 28, 2024 • Managing the display network alerts. resolution • Updated section covering • Positioning your toolbar display resolution. • Added a new section covering toolbar position. • Using the toolbar • Added a new section about September 6, 2024 • Managing the display using the toolbar. resolution • Added a new section • Performing a screen capture covering display resolution. • Added a new section covering screen capture. • Managing networks • Deferring software updates • Added new section for details on networks July 8, 2024 • Using your WorkSpaces Thin Client device April 5, 2024 • Added new procedure for deferring software updates • Device settings show up in a collapsed toolbar allowing better utilization of the visible screen • End users can now configure the duration to wait before the device sleeps on inactivity 79 Amazon WorkSpaces Thin Client User Guide Change Description Date • Volume levels set by end users now persists across device restarts • Keyboard layouts • Added keyboard layout February 12, 2024 • Supported peripherals section • Added European supported keyboards and updated supported monitors Initial release |
workspaces-thin-client-user-guide-016 | workspaces-thin-client-user-guide.pdf | 16 | July 8, 2024 • Using your WorkSpaces Thin Client device April 5, 2024 • Added new procedure for deferring software updates • Device settings show up in a collapsed toolbar allowing better utilization of the visible screen • End users can now configure the duration to wait before the device sleeps on inactivity 79 Amazon WorkSpaces Thin Client User Guide Change Description Date • Volume levels set by end users now persists across device restarts • Keyboard layouts • Added keyboard layout February 12, 2024 • Supported peripherals section • Added European supported keyboards and updated supported monitors Initial release Initial release November 26, 2023 80 |
workspaces-ug-001 | workspaces-ug.pdf | 1 | User Guide Amazon WorkSpaces Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon WorkSpaces User Guide Amazon WorkSpaces: User Guide Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. Amazon WorkSpaces Table of Contents User Guide Getting started ................................................................................................................................ 1 Complete your user profile ........................................................................................................................ 1 Choose a client ............................................................................................................................................. 2 Determine your client version ................................................................................................................... 2 Determine your streaming protocol ......................................................................................................... 3 Verify networking requirements ................................................................................................................ 3 Save your credentials ................................................................................................................................... 4 (Optional) Change your password ............................................................................................................ 4 Supported features by protocol type ............................................................................................. 6 Supported DCV features for WorkSpaces ............................................................................................... 6 Supported PCoIP features for WorkSpaces .......................................................................................... 10 Clients ............................................................................................................................................. 13 Android/Chromebook ................................................................................................................................ 13 Requirements ......................................................................................................................................... 14 Setup and installation ......................................................................................................................... 15 Connect to your WorkSpace ............................................................................................................... 16 Gestures .................................................................................................................................................. 17 Sidebar menu ......................................................................................................................................... 17 Keyboard ................................................................................................................................................. 19 Trackpad mode ...................................................................................................................................... 19 Display support ..................................................................................................................................... 20 Disconnect .............................................................................................................................................. 21 Clipboard support ................................................................................................................................. 21 Release notes ......................................................................................................................................... 21 iPad ................................................................................................................................................................ 28 Requirements ......................................................................................................................................... 29 Setup and installation ......................................................................................................................... 30 Connect to your WorkSpace ............................................................................................................... 30 Gestures .................................................................................................................................................. 31 Radial menu ........................................................................................................................................... 31 Keyboard and command shortcuts ................................................................................................... 33 Mouse modes ......................................................................................................................................... 33 Swiftpoint GT, ProPoint, or PadPoint mouse .................................................................................. 34 Disconnect .............................................................................................................................................. 35 iii Amazon WorkSpaces User Guide Clipboard support ................................................................................................................................. 35 Release notes ......................................................................................................................................... 35 Linux .............................................................................................................................................................. 40 Requirements ......................................................................................................................................... 41 Setup and installation ......................................................................................................................... 41 Connecting to your WorkSpace ......................................................................................................... 42 Manage your login information ......................................................................................................... 43 Client views ............................................................................................................................................ 44 Client language ..................................................................................................................................... 44 Display support ..................................................................................................................................... 45 Proxy servers .......................................................................................................................................... 47 Command shortcuts ............................................................................................................................. 48 Clipboard redirection ............................................................................................................................ 48 Disconnect .............................................................................................................................................. 48 Release notes ......................................................................................................................................... 50 macOS ........................................................................................................................................................... 56 Requirements ......................................................................................................................................... 57 Setup and installation ......................................................................................................................... 57 Determine your client version ............................................................................................................ 58 Connect to your WorkSpace ............................................................................................................... 58 Manage your login information (3.0+ clients only) ....................................................................... 59 Client views ............................................................................................................................................ 59 Client language ..................................................................................................................................... 60 Display support ..................................................................................................................................... 60 Proxy servers .......................................................................................................................................... 62 Command shortcuts ............................................................................................................................. 63 Remap the Windows logo key or the Command key .................................................................... 63 Disconnect .............................................................................................................................................. 64 Clipboard support ................................................................................................................................. 65 Diagnostic log upload .......................................................................................................................... 65 Release notes ......................................................................................................................................... 66 WorkSpaces PCoIP zero client ................................................................................................................. 80 Requirements ......................................................................................................................................... 80 Connect to your WorkSpace ............................................................................................................... 80 Disconnect from the zero client ........................................................................................................ 81 Web Access .................................................................................................................................................. 81 iv Amazon WorkSpaces User Guide Website .................................................................................................................................................... 82 Requirements ......................................................................................................................................... 82 Client views ............................................................................................................................................ 83 Proxy servers .......................................................................................................................................... 83 Features for WorkSpaces configured for DCV ................................................................................ 84 Enabling diagnostic log uploads ....................................................................................................... 85 Windows ....................................................................................................................................................... 86 Requirements ......................................................................................................................................... 87 Setup and installation ......................................................................................................................... 87 Determine your client version ............................................................................................................ 90 Connect to your WorkSpace ............................................................................................................... 90 Manage your login information (3.0+ clients only) ....................................................................... 91 Client views ............................................................................................................................................ 91 Client language ..................................................................................................................................... 92 Display support ..................................................................................................................................... 92 Proxy servers .......................................................................................................................................... 94 Command shortcuts ............................................................................................................................. 95 Disconnect .............................................................................................................................................. 96 Clipboard support ................................................................................................................................. 96 Manage hardware acceleration .......................................................................................................... 97 Diagnostic log upload ........................................................................................................................ 101 Release notes ....................................................................................................................................... 101 Restarting a WorkSpace .............................................................................................................. 122 Rebuilding a WorkSpace ............................................................................................................. 123 Increasing WorkSpace disk size .................................................................................................. 124 Changing compute type .............................................................................................................. 126 Switching running mode ............................................................................................................. 127 Peripheral device support ........................................................................................................... 128 Monitors ..................................................................................................................................................... 128 Keyboards and mice ................................................................................................................................ 129 Audio headsets ......................................................................................................................................... 129 Printers ....................................................................................................................................................... 129 Scanners, USB drives, and other storage devices ............................................................................. 130 Webcams and other video devices ....................................................................................................... 130 Smart cards ............................................................................................................................................... 131 Hardware security keys ........................................................................................................................... 131 v Amazon WorkSpaces User Guide To redirect YubiKey to a WorkSpace for U2F authentication .................................................... 131 WebAuthn authenticators ...................................................................................................................... 132 Using file transfer ........................................................................................................................ 133 Enabling high DPI display .......................................................................................................... 134 Overview .................................................................................................................................................... 134 Limitations ................................................................................................................................................. 135 Enabling high DPI mode for Android .................................................................................................. 135 Enabling high DPI mode for Windows, macOS, or Linux ................................................................ 136 Adjusting the scaling settings on a Windows WorkSpace ............................................................... 137 Adjusting the scaling settings on a Linux WorkSpace ...................................................................... 138 Authentication ............................................................................................................................. 139 Smart card authentication ..................................................................................................................... 139 Use a smart card to log in to your WorkSpace ............................................................................ 140 Use a smart card with Chrome or Firefox on Windows WorkSpaces (in-session) ................... 141 Use a smart card with Chrome or Firefox on Linux WorkSpaces (in-session) ......................... 141 WebAuthn authentication ...................................................................................................................... 142 Amazon Connect audio optimization ......................................................................................... 144 Log in to your WorkSpace and Amazon Connect Contact Control Panel (CCP) ........................... 144 Language and keyboard settings ............................................................................................... 146 WorkSpaces using the PCoIP protocol ................................................................................................ 146 WorkSpaces using the DCV protocol ................................................................................................... 147 USB redirection ............................................................................................................................ 152 Requirements ............................................................................................................................................ 152 Supported USB devices .......................................................................................................................... 152 |
workspaces-ug-002 | workspaces-ug.pdf | 2 | card authentication ..................................................................................................................... 139 Use a smart card to log in to your WorkSpace ............................................................................ 140 Use a smart card with Chrome or Firefox on Windows WorkSpaces (in-session) ................... 141 Use a smart card with Chrome or Firefox on Linux WorkSpaces (in-session) ......................... 141 WebAuthn authentication ...................................................................................................................... 142 Amazon Connect audio optimization ......................................................................................... 144 Log in to your WorkSpace and Amazon Connect Contact Control Panel (CCP) ........................... 144 Language and keyboard settings ............................................................................................... 146 WorkSpaces using the PCoIP protocol ................................................................................................ 146 WorkSpaces using the DCV protocol ................................................................................................... 147 USB redirection ............................................................................................................................ 152 Requirements ............................................................................................................................................ 152 Supported USB devices .......................................................................................................................... 152 Supported USB devices .......................................................................................................................... 153 Connecting your USB device to your WorkSpace ............................................................................. 153 Disconnecting your USB device from your WorkSpace .................................................................... 154 Reinstalling or upgrading your USB redirection drivers .................................................................. 154 Printing ......................................................................................................................................... 156 Local printers ............................................................................................................................................ 156 Other printing methods ......................................................................................................................... 157 Troubleshooting ........................................................................................................................... 158 I didn't receive an email with my Amazon WorkSpaces registration code ................................... 159 After logging in, the Windows client application displays only a white page and I cannot connect to my WorkSpace ..................................................................................................................... 159 vi Amazon WorkSpaces User Guide My WorkSpaces client gives me a network error, but I am able to use other network-enabled apps on my device ................................................................................................................................... 160 It sometimes takes several minutes to log in to my Windows WorkSpace .................................. 161 When I try to log in, the Amazon WorkSpaces Windows client gets stuck on the "Preparing your login page" screen .......................................................................................................................... 161 When I try to log in, I get the error message: "No network. Network connection lost. Check your network connection or contact your administrator for help." ............................................... 161 The Amazon WorkSpaces Windows client application login page is very tiny ............................ 162 I see the following error message: "WorkSpace Status: Unhealthy. We were unable to connect you to your WorkSpace. Please try again in a few minutes." ......................................................... 162 Sometimes I am logged off of my Windows WorkSpace, even though I closed the session, but did not log off .......................................................................................................................................... 162 I forgot my password and tried to reset it, but I didn’t receive an email with a reset link ........ 162 I can't connect to the internet from my WorkSpace ........................................................................ 163 I installed a third-party security software package and now I can't connect to my WorkSpace ................................................................................................................................................. 163 I am getting a "network connection is slow" warning when connected to my WorkSpace ....... 163 I got an "invalid certificate" error on the client application. What does that mean? .................. 163 I'm having trouble when I try to connect to my Windows WorkSpace using Web Access ......... 164 I see the following error message: "Device can't connect to the registration service. Check your network settings." .......................................................................................................................... 164 I skipped an update to my client application and am having trouble updating my client to the latest version ............................................................................................................................................ 165 My headset doesn't work in my WorkSpace ...................................................................................... 165 I am unable to install the Android client application on my Chromebook .................................. 166 I'm getting the wrong characters when I type; for example, I get \ and | when I try to type quotation marks (' and ") ....................................................................................................................... 166 The WorkSpaces client application won't run on my Mac ............................................................... 166 I'm having trouble using the Windows logo key in Windows WorkSpaces when working on a Mac .............................................................................................................................................................. 167 My WorkSpace looks blurry on my Mac ............................................................................................. 167 I'm having trouble copying and pasting ............................................................................................. 167 My screen is flickering or not updating properly, or my mouse isn't clicking in the right place ............................................................................................................................................................ 168 The WorkSpaces client for Windows prompts to update to a version that is already installed ...................................................................................................................................................... 168 vii Amazon WorkSpaces User Guide I don't see video-in devices listed under Devices on my WorkSpaces Windows client ............... 170 viii Amazon WorkSpaces User Guide Getting started with your WorkSpace After your administrator creates your WorkSpace, you receive an invitation email. Complete the following tasks to start using your WorkSpace. Tasks • Complete your user profile • Choose a client • Determine your client version • Determine your streaming protocol • Verify networking requirements • Save your credentials • (Optional) Change your password Complete your user profile After your administrator creates your WorkSpace, you must complete your user profile within seven days; otherwise, your invitation expires. If your invitation expires, ask your administrator for another invitation. To complete your user profile 1. Open the link in the invitation email. 2. Enter your password. Passwords are case-sensitive and must be between 8 and 64 characters in length, inclusive. Passwords must contain at least one character from each of the following categories: • Lowercase characters (a-z) • Uppercase characters (A-Z) • Numbers (0-9) • Non-alphanumeric characters (~!@#$%^&*_-+=`|\(){}[]:;"'<>,.?/) 3. Choose Update User. Complete your user profile 1 Amazon WorkSpaces User Guide You can change your WorkSpaces password anytime. For |
workspaces-ug-003 | workspaces-ug.pdf | 3 | your user profile within seven days; otherwise, your invitation expires. If your invitation expires, ask your administrator for another invitation. To complete your user profile 1. Open the link in the invitation email. 2. Enter your password. Passwords are case-sensitive and must be between 8 and 64 characters in length, inclusive. Passwords must contain at least one character from each of the following categories: • Lowercase characters (a-z) • Uppercase characters (A-Z) • Numbers (0-9) • Non-alphanumeric characters (~!@#$%^&*_-+=`|\(){}[]:;"'<>,.?/) 3. Choose Update User. Complete your user profile 1 Amazon WorkSpaces User Guide You can change your WorkSpaces password anytime. For more information, see (Optional) Change your password. Choose a client You can connect to your WorkSpace using the client application for a supported device or a web browser. To run the WorkSpaces client application, you must have a Windows or Linux PC, Mac, iPad, Kindle, Chromebook, or Android tablet or phone. To run WorkSpaces Web Access, you must have a Windows PC or a Mac running a Chrome or Firefox web browser, or a Linux PC running a Firefox browser. Note Ubuntu, Rocky Linux, and Red Hat Enterprise Linux WorkSpaces currently supports Windows client application and Web Access. For information about connecting to your WorkSpace, see the following client documentation. • Android Client Application • iPad Client Application • Linux Client Application • macOS Client Application • PCoIP Zero Client • Web Access • Windows Client Application Determine your client version To see which version of the WorkSpaces client you have, choose Amazon WorkSpaces, About Amazon WorkSpaces, or click the gear icon in the upper-right corner and choose About Amazon WorkSpaces. Choose a client 2 Amazon WorkSpaces User Guide Determine your streaming protocol Device or feature support might differ depending on which streaming protocol your WorkSpace is using, either PCoIP or DCV. In the 3.0+ versions of the macOS and Windows client applications, you can see which protocol your WorkSpace is using by choosing Support, About My WorkSpace. The iPad, Android, and Linux client applications currently support only the PCoIP protocol. Verify networking requirements To ensure a good experience with your WorkSpace, verify that your client device meets the networking requirements. To verify networking requirements for 3.0+ clients 1. Open your WorkSpaces client. If this is the first time you have opened the client, you are prompted to enter the registration code that you received in the invitation email. 2. Depending on which client you're using, do one of the following. If you're using... Do this Windows or Linux clients In the upper-right corner of the client application, select the Network icon macOS client Choose Connections, Network. The client application tests the network connection, ports, and round-trip time, and reports the results of these tests. 3. Close the Network dialog box to return to the sign-in page. To verify networking requirements for 1.0+ and 2.0+ clients 1. Open your WorkSpaces client. If this is the first time you have opened the client, you are prompted to enter the registration code that you received in the invitation email. Determine your streaming protocol . 3 Amazon WorkSpaces User Guide 2. Choose Network in the lower-right corner of the client application. The client application tests the network connection, ports, and round-trip time, and reports the results of these tests. 3. Choose Dismiss to return to the sign-in page. Save your credentials You can choose whether to save your sign-in credentials securely so that you can reconnect to your WorkSpace without re-entering your credentials while the client application remains running. Your credentials are securely cached in RAM only. You can disable this feature and enable it again at any time. To save your credentials for 3.0+ clients 1. Open your WorkSpaces client. 2. On the client login screen, select or clear the Keep me logged in check box to enable or disable this option as required. To save your credentials for 1.0+ and 2.0+ clients 1. Open your WorkSpaces client. 2. On the client login screen, choose the gear icon (Windows) or the Option menu (macOS), and choose Advanced Settings. 3. Select or clear the Remember Me check box to enable or disable this option as required. (Optional) Change your password You can change your WorkSpaces login password at any time. To change your password 1. Open your WorkSpaces client. 2. On the client login screen, choose Forgot Password? under the Sign In button. Save your credentials 4 Amazon WorkSpaces Note User Guide If Forgot password? isn't available on your login screen, contact your WorkSpaces administrator for assistance with resetting your password. Forgot Password? is not available in the AWS GovCloud (US-West) Region. 3. Enter your user name, and then enter the characters you see in the image. 4. Choose Recover Password. 5. You will receive an email with a password-reset link. Follow the |
workspaces-ug-004 | workspaces-ug.pdf | 4 | your WorkSpaces login password at any time. To change your password 1. Open your WorkSpaces client. 2. On the client login screen, choose Forgot Password? under the Sign In button. Save your credentials 4 Amazon WorkSpaces Note User Guide If Forgot password? isn't available on your login screen, contact your WorkSpaces administrator for assistance with resetting your password. Forgot Password? is not available in the AWS GovCloud (US-West) Region. 3. Enter your user name, and then enter the characters you see in the image. 4. Choose Recover Password. 5. You will receive an email with a password-reset link. Follow the instructions in the email to change your password. Passwords are case-sensitive and must be between 8 and 64 characters in length, inclusive. Passwords must contain at least one character from each of the following categories: • Lowercase characters (a-z) • Uppercase characters (A-Z) • Numbers (0-9) • Non-alphanumeric characters (~!@#$%^&*_-+=`|\(){}[]:;"'<>,.?/) Ensure you don't include non-printable unicode characters, such as white spaces, carriage reture tabs, line breaks, and null characters. Note If you receive an error, contact your AWS Managed Microsoft AD administrator. (Optional) Change your password 5 Amazon WorkSpaces User Guide Supported features by protocol type for WorkSpaces WorkSpaces is supported by the DCV and PCoIP protocols. Each protocol supports different WorkSpaces features and clients. Android and iPad clients aren't supported by DCV WorkSpaces. Contents • Supported DCV features for WorkSpaces • Supported PCoIP features for WorkSpaces Supported DCV features for WorkSpaces The following table compares the features that are supported by the DCV WorkSpaces clients. Note Android and iPad clients aren't currently supported by DCV WorkSpaces. Feature Windows client MacOS client Linux client Web access Notes WorkSpace s Pool support Client access restriction USB redirection Audio input ✓ ✓ ✗ ✓ ✓ ✓ ✗ ✓ ✗ ✓ ✗ ✓ ✓ ✓ ✗ ✓ On client version 5.20.0 or greater. Control device access Not supported on Amazon Linux DCV WorkSpaces but supported on Ubuntu Supported DCV features for WorkSpaces 6 Amazon WorkSpaces User Guide Feature Windows client MacOS client Linux client Web access Notes WorkSpaces. See Manage your Ubuntu WorkSpaces, Manage your Rocky Linux WorkSpaces, and Manage your Red Hat Enterprise Linux WorkSpaces for more information. Not supported on Amazon Linux 2 DCV WorkSpaces and Red Hat Enterpris e Linux WorkSpace s but supported on Ubuntu and Rocky Linux WorkSpaces. See Manage your Ubuntu WorkSpaces and Manage your Rocky Linux WorkSpaces for more information. Print from a WorkSpaces Copy and paste on iPad and Android supports text and HTML content only. Video input ✓ ✓ ✓ ✓ Storage redirection Local printer redirection Clipboard redirection ✗ ✓ ✓ ✗ ✓ ✓ ✗ ✓ ✓ ✗ ✗ ✓ Supported DCV features for WorkSpaces 7 Amazon WorkSpaces User Guide Feature Windows client MacOS client Linux client Web access Notes HIPAA/PCI complianc e Active directory authentic ation SAML 2.0 Certifica te-based Authentic ation Multi- factor authentic ation (MFA) Smart card (CAC and PIV readers) Certificate for access control Encryption at rest ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✗ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✗ ✗ ✓ Compliance and Security FAQ Manage directories for WorkSpaces Compliance and Security FAQ WorkSpaces client smart card support Configure the restriction Encryption FAQ Supported DCV features for WorkSpaces 8 Amazon WorkSpaces User Guide Feature Windows client MacOS client Linux client Web access Notes ✓ Client customiza tion available WebAuthn support ✓ ✓ ✓ ✓ ✓ ✓ ✗ Windows display support macOS display support Linux display support Web access client views ✓ ✗ ✓ ✓ Monitor support File transfer support ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ Idle disconnect timeout AWS Global Accelerat or (AGA) support Customize WorkSpaces branding WebAuthn authentic ation for WorkSpaces client File transfer support in the WorkSpaces client applications Only available for personal and Windows WorkSpaces. Unavailab le for pooled and Linux WorkSpaces. Configure idle disconnect timeout for DCV Not supported on Linux WorkSpaces. On Windows and Mac client version 5.23.0 or greater. On Linux client version 2024.7 or greater. Supported DCV features for WorkSpaces 9 Amazon WorkSpaces User Guide Supported PCoIP features for WorkSpaces The following table compares the features that are supported by the PCoIP WorkSpaces clients. Feature Windows client MacOS client Linux client iPad client Web access Android Notes ✓ ✓ ✓ ✓ ✓ ✓ Client access restricti on USB redirecti Available with ✗ on exception ✗ N/A ✗ N/A s ✓ ✗ Audio input Video input Storage redirecti ✗ on ✓ ✗ ✗ ✓ ✗ ✗ ✓ ✗ ✗ ✗ ✗ ✗ ✓ ✗ ✗ Control device access WorkSpaces only supports YubiKey redirecti on for Windows clients. For a list of supported devices, see WorkSpaces client periphera l device support. For more informati on |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.